Chapter

Bentley HAMMER V8i 1

Getting Started in Bentley HAMMER V8i

Quick Start Lessons

Understanding the Workspace

Creating Models

Using ModelBuilder to Transfer Existing Data

Applying Elevation Data with TRex

Allocating Demands using LoadBuilder

Reducing Model Complexity with Skelebrator

Scenarios and Alternatives

Modeling Capabilities

Presenting Your Results

Importing and Exporting Data

Technical Reference

Bentley HAMMER V8i Theory and Practice

Menus

Element Properties Reference

Technical Information Resources

Glossary

Bentley HAMMER V8i Edition User’s Guide 1-1

1-2 Bentley HAMMER V8i Edition User’s Guide
 Contents

Chapter 1: Bentley HAMMER V8i 1

Chapter 1: Getting Started in Bentley HAMMER V8i 1

What’s New in Bentley HAMMER?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-1
What is Bentley HAMMER? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-2
Capabilities of Bentley HAMMER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-2
Municipal License Administrator Auto-Configuration. . . . . . . . . . . . . . . . . . . .1-3
Starting Bentley HAMMER V8i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3
Working with Bentley HAMMER Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-4
Exiting Bentley HAMMER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-6
Using Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-6
Software Updates via the Web and Bentley SELECT. . . . . . . . . . . . . . . . . . . .1-10
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-10
Checking Your Current Registration Status . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Application Window Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
Standard Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-12
Edit Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-14
Analysis Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-15
Scenarios Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-16
Compute Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-17
View Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-19
Help Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-20
Layout Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-21
Tools Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-25
Zoom Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-28
Customizing Bentley HAMMER Toolbars and Buttons . . . . . . . . . . . . . . . . . .1-31
Bentley HAMMER Dynamic Manager Display . . . . . . . . . . . . . . . . . . . . . . . .1-32
WaterObjects Help for Model Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-37

Chapter 2: Quick Start Lessons 43

Lesson 1: Pipeline Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-44
Part 1—Creating or Importing a Steady-State Model . . . . . . . . . . . . . . . . . . .2-45
CREATING A MODEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-45

Bentley HAMMER V8i Edition User’s Guide Table of Contents-i

 Part 2—Selecting the Transient Events to Model . . . . . . . . . . . . . . . . . . . . . 2-52
Part 3—Configuring the Bentley HAMMER Project . . . . . . . . . . . . . . . . . . . . 2-53
Part 4—Performing a Transient Analysis. . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-56
ANALYSIS WITHOUT SURGE PROTECTION EQUIPMENT . . . . . . . . . . . . . . . . . 2-57
Reviewing your Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-59
ANALYSIS WITH SURGE-PROTECTION EQUIPMENT . . . . . . . . . . . . . . . . . . . . 2-60
Part 5—Animating Transient Results at Points and along Profiles . . . . . . . . 2-62
Part 6—Viewing Time History Graphs in Bentley HAMMER . . . . . . . . . . . . . 2-63
Lesson 2: Network Risk Reduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-66
Part 1—Importing and Verifying the Initial Steady-States . . . . . . . . . . . . . . . 2-66
Part 2—Selecting the Key Transient Events to Model . . . . . . . . . . . . . . . . . . 2-70
Part 3—Performing a Transient Analysis. . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-70
ANALYSIS WITHOUT SURGE PROTECTION . . . . . . . . . . . . . . . . . . . . . . . . . . 2-70
ANALYSIS WITH SURGE-PROTECTION EQUIPMENT . . . . . . . . . . . . . . . . . . . . 2-74
Part 4—Color-Coding Maps, Profiles, and Point Histories. . . . . . . . . . . . . . . 2-80

Chapter 3: Understanding the Workspace 87

Stand-Alone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-87
The Drawing View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-87
PANNING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-87
ZOOMING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-88
Zoom Dependent Visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-91
DRAWING STYLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-93
Using Aerial View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-94
Using Background Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-95
IMAGE PROPERTIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-102
SHAPEFILE PROPERTIES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-104
DXF PROPERTIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-105
Show Flow Arrows (Stand-Alone) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106
MicroStation Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106
Getting Started in the MicroStation environment . . . . . . . . . . . . . . . . . . . . . 3-107
The MicroStation Environment Graphical Layout . . . . . . . . . . . . . . . . . . . . 3-109
MicroStation Project Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-111
SAVING YOUR PROJECT IN MICROSTATION . . . . . . . . . . . . . . . . . . . . . . . . .3-111
Bentley HAMMER V8i Element Properties . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
ELEMENT PROPERTIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
ELEMENT LEVELS DIALOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-113
TEXT STYLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-113
View Associations (MicroStation Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-113
Working with Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-115
EDIT ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-115
DELETING ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-116
MODIFYING ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-116
CONTEXT MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-116
Working with Elements Using MicroStation Commands . . . . . . . . . . . . . . . 3-116
BENTLEY HAMMER V8I CUSTOM MICROSTATION ENTITIES . . . . . . . . . . . 3-116
MICROSTATION COMMANDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-117

Table of Contents-ii Bentley HAMMER V8i Edition User’s Guide

 MOVING ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-117
MOVING ELEMENT LABELS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-117
SNAP MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-118
BACKGROUND FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-118
IMPORT BENTLEY HAMMER V8I . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-118
ANNOTATION DISPLAY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-118
MULTIPLE MODELS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-118
Native Format Contours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-119
Working in AutoCAD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-119
The AutoCAD Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-120
AUTOCAD INTEGRATION WITH BENTLEY HAMMER . . . . . . . . . . . . . . . . . .3-120
GETTING STARTED WITHIN AUTOCAD . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-121
MENUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-121
DRAWING SETUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-122
SYMBOL VISIBILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-122
AUTOCAD PROJECT FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-122
DRAWING SYNCHRONIZATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-123
SAVING THE DRAWING AS DRAWING*.DWG . . . . . . . . . . . . . . . . . . . . . . . . .3-124
Working with Elements Using AutoCAD Commands . . . . . . . . . . . . . . . . . .3-124
BENTLEY HAMMER CUSTOM AUTOCAD ENTITIES . . . . . . . . . . . . . . . . . .3-125
EXPLODE ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-125
MOVING ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-126
MOVING ELEMENT LABELS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-126
SNAP MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-126
POLYGON ELEMENT VISIBILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-126
UNDO/REDO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-126
CONTOUR LABELING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-127
Working in ArcGIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-128
ArcGIS Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-129
ARCGIS INTEGRATION WITH BENTLEY HAMMER V8I . . . . . . . . . . . . . . . . .3-130
Registering and Unregistering Bentley HAMMER V8i with ArcGIS. . . . . . . .3-130
ArcGIS Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-130
Using ArcCatalog with a Bentley HAMMER V8i Database . . . . . . . . . . . . . .3-131
ARCCATALOG GEODATABASE COMPONENTS . . . . . . . . . . . . . . . . . . . . . . .3-131
The Bentley HAMMER V8i ArcMap Client . . . . . . . . . . . . . . . . . . . . . . . . . .3-131
GETTING STARTED WITH THE ARCMAP CLIENT . . . . . . . . . . . . . . . . . . . . . .3-131
MANAGING PROJECTS IN ARCMAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-132
ATTACH GEODATABASE DIALOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-134
LAYING OUT A MODEL IN THE ARCMAP CLIENT . . . . . . . . . . . . . . . . . . . . . .3-135
USING GEOTABLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-135
BENTLEY HAMMER RENDERER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-136
SHOW FLOW ARROWS (ARCGIS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-136
LAYER SYMBOLOGY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-137
Multiple Client Access to Bentley HAMMER Projects . . . . . . . . . . . . . . . . . .3-137
Synchronizing the GEMS Datastore and the Geodatabase . . . . . . . . . . . . .3-137
Rollbacks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-138
Adding New Bentley HAMMER V8i Nodes To An Existing Model In ArcMAP. . .3-
138

Bentley HAMMER V8i Edition User’s Guide Table of Contents-iii

 Adding New Bentley HAMMER V8i Pipes To An Existing Model In ArcMAP 3-139
Creating Backups of Your ArcGIS Bentley HAMMER Project . . . . . . . . . . . 3-140
Google Earth Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-140
Google Earth Export from the MicroStation Platform . . . . . . . . . . . . . . . . . . 3-141
Google Earth Export from ArcGIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-143
Using a Google Earth View as a Background Layer to Draw a Model. . . . . 3-145

Chapter 4: Creating Models 151

Starting a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-151
Bentley HAMMER V8i Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-152
Database Format Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-153
Setting Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-154
Setting Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-155
OPTIONS DIALOG BOX - GLOBAL TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-156
Stored Prompt Responses Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-160
OPTIONS DIALOG BOX - PROJECT TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-161
OPTIONS DIALOG BOX - DRAWING TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-163
OPTIONS DIALOG BOX - UNITS TAB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-165
OPTIONS DIALOG BOX - LABELING TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-168
OPTIONS DIALOG BOX - PROJECTWISE TAB . . . . . . . . . . . . . . . . . . . . . . . 4-169
Working with ProjectWise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-170
SETTING UP PROJECTWISE INTEGRATION . . . . . . . . . . . . . . . . . . . . . . . . . 4-176
ABOUT PROJECTWISE GEOSPATIAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-177
Maintaining Project Geometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-178
Setting the Project Spatial Reference System . . . . . . . . . . . . . . . . . . . . . . . 4-178
Interaction with ProjectWise Explorer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-179
Elements and Element Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-181
Pipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-182
MINOR LOSSES DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-184
MINOR LOSS COEFFICIENTS DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . 4-186
WAVE SPEED CALCULATOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-188
Junctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-193
DEMAND COLLECTION DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-194
UNIT DEMAND COLLECTION DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . 4-194
EXPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-195
Hydrants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-196
HYDRANT LATERAL LOSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-196
Tanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-196
Reservoirs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-200
Pumps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-201
PUMP DEFINITIONS DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-202
Efficiency Points Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-211
PUMP CURVE DIALOG BOX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-211
FLOW-EFFICIENCY CURVE DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . 4-212
SPEED-EFFICIENCY CURVE DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . 4-213
PUMP AND MOTOR INERTIA CALCULATOR . . . . . . . . . . . . . . . . . . . . . . . . . 4-213
POSITIVE DISPLACEMENT PUMPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-214

Table of Contents-iv Bentley HAMMER V8i Edition User’s Guide

 PUMP FUNDAMENTALS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-215
Pump Inertia. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-217
Specific Speed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-218
First-Quadrant and Four-Quadrant Representations . . . . . . . . . . . . . . . . . . 4-220
Variable-Speed Pumps (VSP or VFD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-221
PUMP CURVE DISPLAY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-222
Variable Speed Pump Battery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-225
Pump Stations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-226
PUMPS DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-228
POLYGON VERTICES DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-229
Valves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-229
DEFINING VALVE CHARACTERISTICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-234
Valve Characteristics Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-234
Valve Characteristic Curve Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-236
GENERAL NOTE ABOUT LOSS COEFFICIENTS ON VALVES . . . . . . . . . . . . . .4-237
MODULATING CONTROL VALVE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-238
Spot Elevations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-239
Turbines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-239
IMPULSE TURBINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-241
REACTION TURBINES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-242
MODELING HYDRAULIC TRANSIENTS IN HYDROPOWER PLANTS . . . . . . . . . .4-244
TURBINE PARAMETERS IN HAMMER . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-248
TURBINE CURVE DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-249
Periodic Head-Flow Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-250
PERIODIC HEAD-FLOW PATTERN DIALOG BOX . . . . . . . . . . . . . . . . . . . . . .4-251
Air Valves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-251
DETERMINING THE TYPE OF AIR VALVE TO USE . . . . . . . . . . . . . . . . . . . . .4-254
AIR FLOW CURVES DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-257
AIR FLOW-PRESSURE CURVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-258
Hydropneumatic Tanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-259
INITIAL CONDITIONS ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-264
GAS LAW VS. CONSTANT AREA APPROXIMATION . . . . . . . . . . . . . . . . . . . .4-266
TRANSIENT SIMULATION ATTRIBUTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-266
TRACKING THE AIR-LIQUID INTERFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-270
VARIABLE ELEVATION CURVE DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . .4-271
Surge Valves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-272
Check Valves. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-273
Rupture Disks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-274
Discharge to Atmosphere Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-274
Orifice Between Pipes Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-276
Valve with Linear Area Change Elements . . . . . . . . . . . . . . . . . . . . . . . . . . .4-277
Surge Tanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-277
Protective Equipment Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-282
Other Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-284
BORDER TOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-285
TEXT TOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-285
LINE TOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-286
Pump and Turbine Characteristics in Bentley HAMMER . . . . . . . . . . . . . . .4-286

Bentley HAMMER V8i Edition User’s Guide Table of Contents-v

 How The Pressure Engine Loads Bentley HAMMER Elements . . . . . . . . . 4-299
Adding Elements to Your Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-300
Manipulating Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-301
Select, Move, and Delete Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-302
Splitting Pipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-304
Reconnect Pipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-305
Modeling Curved Pipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-305
POLYLINE VERTICES DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-306
Assign Isolation Valves to Pipes Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . 4-306
Batch Pipe Split Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-308
BATCH PIPE SPLIT WORKFLOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-309
Batch Morph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-310
Merge Nodes in Close Proximity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-311
Select Adjacent Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-312
Editing Element Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-312
Property Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-312
LABELING ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-315
RELABELING ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-315
SET FIELD OPTIONS DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-315
Date/Time Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-316
Using Named Views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-317
Using Selection Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-319
Selection Sets Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-320
Group-Level Operations on Selection Sets . . . . . . . . . . . . . . . . . . . . . . . . . 4-325
Using the Network Navigator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-326
Using the Duplicate Labels Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-332
Using the Pressure Zone Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-333
Pressure Zone Export Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-343
Pressure Zone Flow Balance Tool Dialog Box. . . . . . . . . . . . . . . . . . . . . . . 4-344
Using Prototypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-345
Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-349
Engineering Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-351
Transient Valve Curve Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-355
Transient Pump Curve Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-356
Transient Turbine Curve Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-357
Valve Relative Closure Curve Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-358
Hyperlinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-358
Using Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-366
Queries Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-366
QUERY PARAMETERS DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-369
Creating Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-370
USING THE LIKE OPERATOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-376
User Data Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-376
User Data Extensions Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-379

Table of Contents-vi Bentley HAMMER V8i Edition User’s Guide

 Sharing User Data Extensions Among Element Types . . . . . . . . . . . . . . . . .4-383
Shared Field Specification Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-384
Enumeration Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-385
User Data Extensions Import Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . .4-386
Formula Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-386
Property Grid Customizations Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-388
Customization Editor Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-389
Tooltip Customization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-390
Tooltip Customization Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-391
i-Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-391
Publishing an i-model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-392
Viewing an i-model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-395

Chapter 5: Using ModelBuilder to Transfer Existing Data

399
Preparing to Use ModelBuilder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-399
ModelBuilder Connections Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-402
Specify Datasource Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-406
Microsoft Access Database Engine Version . . . . . . . . . . . . . . . . . . . . . . . . .5-406
ModelBuilder Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-407
Step 1—Specify Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-408
Step 2—Specify Spatial Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-410
Step 3 - Specify Element Create/Remove/Update Options . . . . . . . . . . . . . .5-412
Step 4—Additional Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-414
Step 5—Specify Field mappings for each Table/Feature Class . . . . . . . . . .5-417
Step 6—Build operation Confirmation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-421
Reviewing Your Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-422
Multi-select Data Source Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-422
ModelBuilder Warnings and Error Messages. . . . . . . . . . . . . . . . . . . . . . . . .5-423
ModelBuilder Warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-423
ModelBuilder Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-424
ESRI ArcGIS Geodatabase Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-425
Geodatabase Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-425
Geometric Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-426
ArcGIS Geodatabase Features versus ArcGIS Geometric Network . . . . . . .5-426
Subtypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-427
SDE (Spatial Database Engine) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-427
Specifying Network Connectivity in ModelBuilder . . . . . . . . . . . . . . . . . . . .5-427
Sample Spreadsheet Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-429
The GIS-ID Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-430

Bentley HAMMER V8i Edition User’s Guide Table of Contents-vii

 GIS-ID Collection Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-431
Specifying a SQL WHERE clause in ModelBuilder. . . . . . . . . . . . . . . . . . . . 5-432
Modelbuilder Import Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-432
Importing Pump Definitions Using ModelBuilder . . . . . . . . . . . . . . . . . . . . . 5-433
Using ModelBuilder to Import Pump Curves . . . . . . . . . . . . . . . . . . . . . . . . 5-438
Using ModelBuilder to Import Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-442
Using ModelBuilder to Import Time Series Data . . . . . . . . . . . . . . . . . . . . . 5-446
Oracle as a Data Source for ModelBuilder . . . . . . . . . . . . . . . . . . . . . . . . . . 5-452
Oracle/ArcSDE Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-453

Chapter 6: Applying Elevation Data with TRex 455

The Importance of Accurate Elevation Data . . . . . . . . . . . . . . . . . . . . . . . . . 6-455
Numerical Value of Elevation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-456
Accuracy and Precision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-457
Obtaining Elevation Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-457
Record Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-459
Calibration Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-460
TRex Terrain Extractor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-460
TRex Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-462
TRex Supported Terrain Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-467

Chapter 7: Allocating Demands using LoadBuilder 469

Using GIS for Demand Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-469
Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-470
Billing Meter Aggregation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-472
Distribution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-473
Projection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-475
Using LoadBuilder to Assign Loading Data . . . . . . . . . . . . . . . . . . . . . . . . . 7-476
LoadBuilder Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-476
LoadBuilder Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-477
LoadBuilder Run Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-489
Unit Line Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-489
Generating Thiessen Polygons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-491
Thiessen Polygon Creator Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-494
Creating Boundary Polygon Feature Classes . . . . . . . . . . . . . . . . . . . . . . . 7-496
Demand Control Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-497
Apply Demand and Pattern to Selection Dialog Box . . . . . . . . . . . . . . . . . . 7-500
Unit Demands Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-502
Unit Demand Control Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-505
Pressure Dependent Demands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-507

Table of Contents-viii Bentley HAMMER V8i Edition User’s Guide

 Piecewise Linear Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-513

Chapter 8: Reducing Model Complexity with Skelebrator

515
Skeletonization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-516
Skeletonization Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-517
Common Automated Skeletonization Techniques. . . . . . . . . . . . . . . . . . . . .8-519
Generic—Data Scrubbing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-519
Generic—Branch Trimming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-519
Generic—Series Pipe Removal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-520
Skeletonization Using Skelebrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-521
Skelebrator—Smart Pipe Removal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-521
Skelebrator—Branch Collapsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-522
Skelebrator—Series Pipe Merging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-523
Skelebrator—Parallel Pipe Merging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-525
Skelebrator—Inline Isolation Valve Replacement . . . . . . . . . . . . . . . . . . . . .8-526
Skelebrator—Other Skelebrator Features. . . . . . . . . . . . . . . . . . . . . . . . . . .8-527
Skelebrator—Conclusion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-528
Using the Skelebrator Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-529
Skeletonizer Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-530
BATCH RUN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-534
PROTECTED ELEMENTS MANAGER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-536
Selecting Elements from Skelebrator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-536
Manual Skeletonization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-539
Branch Collapsing Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-542
Parallel Pipe Merging Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-544
Series Pipe Merging Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-546
Smart Pipe Removal Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-550
Inline Isolating Valve Replacement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-552
Conditions and Tolerances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-553
PIPE CONDITIONS AND TOLERANCES . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-554
JUNCTION CONDITIONS AND TOLERANCES . . . . . . . . . . . . . . . . . . . . . . . . .8-555
Skelebrator Progress Summary Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . .8-556
Backing Up Your Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-556
Skeletonization and Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-557
Importing/Exporting Skelebrator Settings . . . . . . . . . . . . . . . . . . . . . . . . . . .8-558
Skeletonization and Active Topology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-559

Chapter 9: Scenarios and Alternatives 561

Understanding Scenarios and Alternatives . . . . . . . . . . . . . . . . . . . . . . . . . .9-561
. . . . . . . . . . . . . . . . . . . Advantages of Automated Scenario Management9-561
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A History of What-If Analyses9-562
Distributed Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-562
Self-Contained Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-563

Bentley HAMMER V8i Edition User’s Guide Table of Contents-ix

 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .The Scenario Cycle9-564
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scenario Attributes and Alternatives9-565
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A Familiar Parallel9-565
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Inheritance9-566
OVERRIDING INHERITANCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-567
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DYNAMIC INHERITANCE9-567
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Local and Inherited Values9-568
. . . . . . . . . . . . . . . . . . . . . . . Minimizing Effort through Attribute Inheritance9-568
. . . . . . . . . . . . . . . . . . . . . . .Minimizing Effort through Scenario Inheritance9-569
Scenario Example - A Water Distribution System . . . . . . . . . . . . . . . . . . . . 9-570
. . . . . . . . . . . . . . . . . . . . . . . Building the Model (Average Day Conditions)9-570
. . . . . . . . . . . . . . Analyzing Different Demands (Maximum Day Conditions)9-571
. . . . . . . . . . . . . . . . . . . . Another Set of Demands (Peak Hour Conditions)9-572
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Correcting an Error9-572
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Analyzing Improvement Suggestions9-573
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Finalizing the Project9-573
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scenarios9-574
Scenarios Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-575
Base and Child Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-577
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Scenarios9-577
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EDITING SCENARIOS9-578
Alternatives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-579
Alternatives Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-580
Alternative Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-582
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Base and Child Alternatives9-583
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Creating Alternatives9-584
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing Alternatives9-584

Active Topology Alternative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-586

Physical Alternative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-590
Demand Alternatives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-594
Initial Settings Alternative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-595
Operational Alternatives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-599
Age Alternatives. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-602
Constituent Alternatives. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-605
CONSTITUENTS MANAGER DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . 9-609
Trace Alternative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-610
Fire Flow Alternative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-613
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FILTER DIALOG BOX9-618
Energy Cost Alternative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-619
Pressure Dependent Demand Alternative . . . . . . . . . . . . . . . . . . . . . . . . . . 9-622
Transient Alternative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-625
Failure History Alternative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-629
User Data Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-630
Scenario Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-633
Scenario Comparison Options Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . 9-636
Scenario Comparison Collection Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . 9-636

Table of Contents-x Bentley HAMMER V8i Edition User’s Guide

Chapter 10: Modeling Capabilities 637
Model and Optimize a Distribution System . . . . . . . . . . . . . . . . . . . . . . . . .10-637
Steady-State/Extended Period Simulation . . . . . . . . . . . . . . . . . . . . . . . . . .10-638
Steady-State Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-639
Extended Period Simulation (EPS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-639
Hydraulic Transient Pressure Analysis. . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-640
Rigid-Column Simulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-641
Data Requirements and Boundary Conditions . . . . . . . . . . . . . . . . . . . . . .10-642
Analysis of Transient Forces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-643
Infrastructure and Risk Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-645
Water Column Separation and Vapor Pockets . . . . . . . . . . . . . . . . . . . . . .10-645
GLOBAL ADJUSTMENT TO VAPOR PRESSURE . . . . . . . . . . . . . . . . . . . . . .10-646
GLOBAL ADJUSTMENT TO WAVE SPEED . . . . . . . . . . . . . . . . . . . . . . . . . .10-646
WAVE SPEED REDUCTION FACTOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-647
AUTOMATIC OR DIRECT SELECTION OF THE TIME STEP . . . . . . . . . . . . . . .10-649
Validate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-649
Orifice Demand and Intrusion Potential. . . . . . . . . . . . . . . . . . . . . . . . . . . .10-650
Numerical Model Calibration and Validation . . . . . . . . . . . . . . . . . . . . . . . .10-651
GATHERING FIELD MEASUREMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-653
TIMING AND SHAPE OF TRANSIENT PRESSURE PULSES . . . . . . . . . . . . . . .10-653
Application of HAMMER to Typical Problems - Overview . . . . . . . . . . . . . .10-654
How Valve Discharge Coefficient Values are Exported to the HAMMER Engine .
10-656
Calculate Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-657
Copy Initial Conditions Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-659
Selection of the Time Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-660
Using a User-Defined Time Step. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-661
Transient Time Step Options Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-662
Global Demand and Roughness Adjustments . . . . . . . . . . . . . . . . . . . . . . .10-663
Check Data/Validate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-665
User Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-666
User Notification Details Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-670
Post Calculation Processor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-671
Flow Emitters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-672
Parallel VSPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-673
Calculation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-674
Controlling Results Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-681
Flow Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-683
Determining the Transient Run Duration . . . . . . . . . . . . . . . . . . . . . . . . . . .10-684
Vapor Pressure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-685
Selecting the Transient Friction Method . . . . . . . . . . . . . . . . . . . . . . . . . . .10-686
Engine Compatibility Calculation Option . . . . . . . . . . . . . . . . . . . . . . . . . . .10-687
Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10-691

Bentley HAMMER V8i Edition User’s Guide Table of Contents-xi

 Pattern Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-692
Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-696
Controls Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-698
Conditions Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-702
Actions Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-709
Control Sets Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-713
LOGICAL CONTROL SETS DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . 10-714
Control Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-715
Active Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-716
Active Topology Selection Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-717
External Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-719
Modeling Tips. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-721
Modeling a Pumped Groundwater Well . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-721
Modeling Parallel Pipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-722
Modeling Pumps in Parallel and Series . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-723
Modeling Hydraulically Close Tanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-724
Modeling Fire Hydrants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-724
Modeling a Connection to an Existing Water Main . . . . . . . . . . . . . . . . . . 10-724
Top Feed/Bottom Gravity Discharge Tank . . . . . . . . . . . . . . . . . . . . . . . . . 10-726
Estimating Hydrant Discharge Using Flow Emitters . . . . . . . . . . . . . . . . . 10-727
Modeling Variable Speed Pumps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-729
TYPES OF VARIABLE SPEED PUMPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-730
PATTERN BASED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-730
FIXED HEAD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-730
CONTROLS WITH FIXED HEAD OPERATION . . . . . . . . . . . . . . . . . . . . . . . 10-731
PARALLEL VSPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-732
VSP CONTROLLED BY DISCHARGE SIDE TANK . . . . . . . . . . . . . . . . . . . . 10-732
VSP CONTROLLED BY SUCTION SIDE TANK . . . . . . . . . . . . . . . . . . . . . . 10-733
FIXED FLOW VSP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-734

Chapter 11: Presenting Your Results 735

Transient Results Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-735
Using the Java Transient Results Viewer . . . . . . . . . . . . . . . . . . . . . . . . . 11-737
Format Graph Shortcut Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-738
Transients Results Viewer Dialog (New) . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-741
Profiles Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-741
TRANSIENT PROFILE VIEWER DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . 11-742
Transient Profile Viewer Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . 11-744
Time Histories Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-745
TRANSIENT RESULTS GRAPH VIEWER DIALOG BOX . . . . . . . . . . . . . . . . . 11-746
Annotating Your Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-747
Using Folders in the Element Symbology Manager. . . . . . . . . . . . . . . . . . 11-751
Annotation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-754
FREE FORM ANNOTATION DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . 11-755

Table of Contents-xii Bentley HAMMER V8i Edition User’s Guide

 SYMBOLOGY DEFINITIONS MANAGER . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-756
Color Coding A Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11-757
Color Coding Legends. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-761
Contours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-762
Contour Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-764
Contour Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-767
Contour Browser Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-767
Enhanced Pressure Contours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-768
Using Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-768
Profile Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-770
Profile Series Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-774
Profile Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-775
Viewing and Editing Data in FlexTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-783
FlexTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-784
Working with FlexTable Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-788
FlexTable Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-789
Opening FlexTables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-791
Creating a New FlexTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-791
Deleting FlexTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-792
Naming and Renaming FlexTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-792
Editing FlexTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-793
Sorting and Filtering FlexTable Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-796
CUSTOM SORT DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-799
Customizing Your FlexTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-800
Element Relabeling Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-801
FlexTable Setup Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-802
Copying, Exporting, and Printing FlexTable Data . . . . . . . . . . . . . . . . . . . . 11-804
Statistics Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-806
Using Sparklines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-806
SPARKLINE SETTINGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-807
Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-807
Using Standard Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-808
REPORTS FOR INDIVIDUAL ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-808
CREATING A SCENARIO SUMMARY REPORT . . . . . . . . . . . . . . . . . . . . . . . 11-808
CREATING A PROJECT INVENTORY REPORT . . . . . . . . . . . . . . . . . . . . . . . 11-808
CREATING A PRESSURE PIPE INVENTORY REPORT . . . . . . . . . . . . . . . . . . 11-808
REPORT OPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-808
Results Table Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-810
Graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-811
Graph Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-811
ADD TO GRAPH DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-813
Printing a Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-813
Working with Graph Data: Viewing and Copying. . . . . . . . . . . . . . . . . . . . . 11-813
Graph Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-814
GRAPH SERIES OPTIONS DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-819
OBSERVED DATA DIALOG BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-820

Bentley HAMMER V8i Edition User’s Guide Table of Contents-xiii

 Sample Observed Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-821
Chart Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-823
Chart Options Dialog Box - Chart Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-824
SERIES TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-824
PANEL TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-825
AXES TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-828
GENERAL TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-834
TITLES TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-835
WALLS TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-840
PAGING TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-841
LEGEND TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-842
3D TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-848
Chart Options Dialog Box - Series Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-849
FORMAT TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-849
POINT TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-850
GENERAL TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-851
DATA SOURCE TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-852
MARKS TAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-853
Chart Options Dialog Box - Tools Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-857
Chart Options Dialog Box - Export Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-858
Chart Options Dialog Box - Print Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-860
Border Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-861
Gradient Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-862
Color Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-863
Color Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-863
Hatch Brush Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-864
HATCH BRUSH EDITOR DIALOG BOX - SOLID TAB . . . . . . . . . . . . . . . . . . 11-864
HATCH BRUSH EDITOR DIALOG BOX - HATCH TAB . . . . . . . . . . . . . . . . . 11-865
HATCH BRUSH EDITOR DIALOG BOX - GRADIENT TAB . . . . . . . . . . . . . . . 11-865
HATCH BRUSH EDITOR DIALOG BOX - IMAGE TAB . . . . . . . . . . . . . . . . . . 11-866
Pointer Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-867
Change Series Title Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-868
Chart Tools Gallery Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-868
CHART TOOLS GALLERY DIALOG BOX - SERIES TAB . . . . . . . . . . . . . . . . 11-868
CHART TOOLS GALLERY DIALOG BOX - AXIS TAB . . . . . . . . . . . . . . . . . . 11-872
CHART TOOLS GALLERY DIALOG BOX - OTHER TAB . . . . . . . . . . . . . . . . 11-875
TeeChart Gallery Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-880
SERIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-880
FUNCTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-881
Customizing a Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-881
Time Series Field Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-886
SELECT ASSOCIATED MODELING ATTRIBUTE DIALOG BOX . . . . . . . . . . . . 11-889
Calculation Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-890
Calculation Summary Graph Series Options Dialog Box. . . . . . . . . . . . . . 11-891
Transient Calculation Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-892
Summary Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-893
Initial Conditions Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-893

Table of Contents-xiv Bentley HAMMER V8i Edition User’s Guide

 Extreme Pressure and Heads Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-893
RResults Table Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-894
Print Preview Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-894
Transient Thematic Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-897
Print Preparation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-898

Chapter 12: Importing and Exporting Data 901

Moving Data and Images between Model(s) and other Files . . . . . . . . . . .12-901
Importing a Bentley HAMMER Database. . . . . . . . . . . . . . . . . . . . . . . . . . . .12-903
Exporting a HAMMER v7 Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-903
Importing and Exporting EPANET Files . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-904
Importing and Exporting Submodel Files. . . . . . . . . . . . . . . . . . . . . . . . . . .12-904
Exporting a Submodel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-905
Exporting a DXF File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-907
File Upgrade Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-908
Export to Shapefile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12-908

Chapter 13: Technical Reference 911

Pressure Network Hydraulics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-911
Network Hydraulics Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-911
The Energy Principle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-912
The Energy Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-913
Hydraulic and Energy Grades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-914
Conservation of Mass and Energy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-915
The Gradient Algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-916
Derivation of the Gradient Algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-916
The Linear System Equation Solver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-919
Pump Theory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-920
Valve Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-923
CHECK VALVES (CVS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-923
FLOW CONTROL VALVES (FCVS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-924
PRESSURE REDUCING VALVES (PRVS) . . . . . . . . . . . . . . . . . . . . . . . . . .13-924
PRESSURE SUSTAINING VALVES (PSVS) . . . . . . . . . . . . . . . . . . . . . . . . .13-924
PRESSURE BREAKER VALVES (PBVS) . . . . . . . . . . . . . . . . . . . . . . . . . . .13-924
THROTTLE CONTROL VALVES (TCVS) . . . . . . . . . . . . . . . . . . . . . . . . . . .13-924
GENERAL PURPOSE VALVES (GPVS) . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-924
Friction and Minor Loss Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-925
Chezy’s Equation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-925
Colebrook-White Equation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-925
Hazen-Williams Equation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-926
Darcy-Weisbach Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-927
Swamee and Jain Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13-928

Bentley HAMMER V8i Edition User’s Guide Table of Contents-xv

 Manning’s Equation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-928
Minor Losses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-929
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-930
Engineer’s Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-930
Roughness Values—Manning’s Equation . . . . . . . . . . . . . . . . . . . . . . . . . 13-930
Roughness Values—Darcy-Weisbach Equation (Colebrook-White) . . . . . 13-931
Roughness Values—Hazen-Williams Equation . . . . . . . . . . . . . . . . . . . . . 13-932
Typical Roughness Values for Pressure Pipes . . . . . . . . . . . . . . . . . . . . . 13-933
Fitting Loss Coefficients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-934
Variable Speed Pump Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-935
VSP Interactions with Simple and Logical Controls . . . . . . . . . . . . . . . . . . 13-938
Performing Advanced Analyses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-939
Hydraulic Equivalency Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-939
Principles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-940
HAZEN-WILLIAMS EQUATION. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-940
MANNING’S EQUATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-941
DARCY-WEISBACH EQUATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-942
CHECK VALVES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-944
MINOR LOSSES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-944
NUMERICAL CHECK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-945
Thiessen Polygon Generation Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-946
Naïve Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-946
Plane Sweep Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-947
Method for Modeling Pressure Dependent Demand . . . . . . . . . . . . . . . . . 13-948
Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-949
Supply Level Evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-950
Pressure Dependent Demand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-950
Demand Deficit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-951
Solution Methodology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-952
Modified GGA Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-953
Direct GGA Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-953
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-954
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-958

Chapter 14: Bentley HAMMER V8i Theory and Practice 959

Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-960
Overview of Hydraulic Transients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-961
History of Solution Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-962
Causes of Transient Initiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-964
Impacts of Transients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-967
Design of Protective Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-970
Hydraulic Transient Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-970
Conservation of Energy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-971
Governing Equations for Steady-State Flow . . . . . . . . . . . . . . . . . . . . . . . 14-972

Table of Contents-xvi Bentley HAMMER V8i Edition User’s Guide

 CONSERVATION OF MASS AT STEADY STATE . . . . . . . . . . . . . . . . . . . . . .14-974
CONSERVATION OF ENERGY AT STEADY STATE . . . . . . . . . . . . . . . . . . . .14-974
Governing Equations for Unsteady (or Transient) Flow . . . . . . . . . . . . . . .14-975
CONTINUITY EQUATION FOR UNSTEADY FLOW . . . . . . . . . . . . . . . . . . . . .14-975
MOMENTUM EQUATION FOR UNSTEADY FLOW . . . . . . . . . . . . . . . . . . . . .14-976
METHOD OF CHARACTERISTICS (MOC) . . . . . . . . . . . . . . . . . . . . . . . . . .14-977
Rigid Column Theory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-980
Rigid Column versus Elastic Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-982
Elastic Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-984
Water System Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-985
Celerity and Pipe Elasticity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-985
Wave Propagation and Characteristic Time . . . . . . . . . . . . . . . . . . . . . . . .14-989
Wave Reflection and Transmission in Pipelines . . . . . . . . . . . . . . . . . . . . .14-990
Type of Networks and Pumping Systems . . . . . . . . . . . . . . . . . . . . . . . . . .14-992
Putting It All Together . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-994
Pump Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-995
Pump Characteristics and Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-996
SPECIFIC SPEED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-999
Variable-Speed Pumps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1000
Constant-Horsepower Pumps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1001
Valve Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1002
Valve Selection and Sizing Considerations . . . . . . . . . . . . . . . . . . . . . . . .14-1003
Typical Valve Bodies and Pistons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1005
Closing Characteristics of Valves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1006
Flow-Decreasing Characteristics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1009
Air Valve Theory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1009
Extended CAV Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1013
Friction and Minor Losses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1016
Steady State / Extended Period Simulation Friction Methods . . . . . . . . . .14-1016
HAZEN-WILLIAMS EQUATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1017
DARCY-WEISBACH EQUATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1017
MANNING’S EQUATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1019
Transient Analysis Friction Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1020
STEADY FRICTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1020
QUASI-STEADY FRICTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1021
UNSTEADY OR TRANSIENT FRICTION . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1022
Minor Losses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1025
Cavitation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1026
Time Step and Computational Reach Length . . . . . . . . . . . . . . . . . . . . . . .14-1029
TURBINE SIMULATION IN HAMMER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1031
Four-quadrant Characteristics of Turbomachinery . . . . . . . . . . . . . . . . . .14-1031
Numerical Representation of Hydroelectric Turbines . . . . . . . . . . . . . . . .14-1032
Transient Forces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1034
Developing a Surge-Control Strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1037
Piping System Design and Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14-1039

Bentley HAMMER V8i Edition User’s Guide Table of Contents-xvii

 Protection Devices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1040
Approaches to Surge Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1042
SYSTEM-IMPROVEMENT METHOD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1045
FLOW-SUPPLEMENT APPROACH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1045
TWO-WAY SURGE TANK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1046
ONE-WAY SURGE TANK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1049
GAS VESSEL OR AIR CHAMBER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1049
INCREASE OF INERTIA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1052
Pump Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1052
CHECK VALVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1053
BOOSTER PUMP BYPASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1053
Surge-Relief Valves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1055
Operation and Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1062
Engineer’s Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1064
Roughness Values—Manning’s Equation . . . . . . . . . . . . . . . . . . . . . . . . 14-1065
Roughness Values—Darcy-Weisbach Equation (Colebrook-White) . . . . 14-1066
Roughness Values—Hazen-Williams Equation . . . . . . . . . . . . . . . . . . . . 14-1067
Typical Roughness Values for Pressure Pipes . . . . . . . . . . . . . . . . . . . . 14-1068
Fitting Loss Coefficients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1069
Properties of Common Liquids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1070
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1072

Chapter 15: Menus 1079

File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1079
Edit Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1082
Analysis Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1082
Components Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1084
View Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1085
Tools Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1087
Report Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1090
Help Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1090
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1091

Table of Contents-xviii Bentley HAMMER V8i Edition User’s Guide

Chapter 16: Element Properties Reference 1093
Edit Element Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16-1094
Pipe Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16-1094
Junction Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1100
Hydrant Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1105
Tank Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1109
Reservoir Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1113
Periodic Head-Flow Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1115
Pump Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1117
Pump Station Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1121
Variable Speed Pump Battery Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1123
Turbine Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1128
Valve Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1130
Pressure Reducing Valve (PRV) Attributes . . . . . . . . . . . . . . . . . . . . . . . . 16-1130
Pressure Breaker Valve (PBV) Attributes . . . . . . . . . . . . . . . . . . . . . . . . . 16-1136
Flow Control Vale (FCV) Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1138
Throttle Control Valve (TCV) Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1141
General Purpose Valve (GPV) Attributes . . . . . . . . . . . . . . . . . . . . . . . . . 16-1144
Valve With Linear Area Change Attributes . . . . . . . . . . . . . . . . . . . . . . . . . 16-1146
Check Valve Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1147
Orifice Between Pipes Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1149
Discharge To Atmosphere Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1151
Surge Tank Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1152
Hydropneumatic Tank Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1156
Air Valve Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1160
Surge Valve Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16-1162
Rupture Disk Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1164
Isolation Valve Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1165
Spot Elevation Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-1166

Bentley HAMMER V8i Edition User’s Guide Table of Contents-xix

Chapter 17: Technical Information Resources 1169
docs.bentley.com. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1170
Bentley Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1171
Bentley Discussion Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1172
Bentley on the Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1172
TechNotes/Frequently Asked Questions. . . . . . . . . . . . . . . . . . . . . . . . . . 17-1172
BE Magazine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1172
BE Newsletter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1173
Client Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1173
BE Careers Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1173
Contact Bentley Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17-1173

Chapter 18: Glossary 1177

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1177
A ....................................................... 18-1177
B ....................................................... 18-1177
C ....................................................... 18-1178
D ....................................................... 18-1179
E ....................................................... 18-1180
F. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1180
G ....................................................... 18-1181
H ....................................................... 18-1182
I ........................................................ 18-1182
L. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1183
M ....................................................... 18-1183
N ....................................................... 18-1185
O ....................................................... 18-1185
P ....................................................... 18-1186
R ....................................................... 18-1187
S ....................................................... 18-1187
T. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18-1189
V ....................................................... 18-1189
W....................................................... 18-1190
X ....................................................... 18-1191

Index 1193

Table of Contents-xx Bentley HAMMER V8i Edition User’s Guide

Bentley HAMMER V8i Edition User’s Guide Table of Contents-xxi
Table of Contents-xxii Bentley HAMMER V8i Edition User’s Guide
 Getting Started in
Bentley HAMMER V8i 1
What is Bentley HAMMER?

Municipal License Administrator Auto-Configuration

Starting Bentley HAMMER V8i

Working with Bentley HAMMER Files

Exiting Bentley HAMMER

Using Online Help

Software Updates via the Web and Bentley SELECT

Troubleshooting

Checking Your Current Registration Status

Application Window Layout

What’s New in Bentley HAMMER?

New and upgraded features in Bentley HAMMER SELECTseries 4 include:

• New database file format as .sqlite replacing .sqlite

• Sparkline display of EPS results

• Batch morph

• Filtering on property grid

• Numerous other enhancements

Bentley HAMMER V8i Edition User’s Guide 1-1

What is Bentley HAMMER?

Note: Bentley HAMMER can open and import files from earlier
versions but files created with this version are not backward
compatible to earlier versions.

What is Bentley HAMMER?

Bentley HAMMER 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, Bentley HAMMER's name is due to the loud "water hammer" knocking
sound that can be heard when sudden hydraulic transients occur. Bentley HAMMER
helps engineers understand their pumping and piping networks better, enabling them
to design safe and economical surge-control systems.

Bentley HAMMER is based on technology originally created by GENIVAR (formerly

Environmental Hydraulics Group Inc.), the water Bentley HAMMER specialists, and
backed by a long-term collaboration between GENIVAR and Bentley. Bentley and
GENIVAR are committed to continuously improving Bentley HAMMER.

Capabilities of Bentley HAMMER

Bentley HAMMER's graphical interface makes it easy to quickly lay out a complex
network of pipes, tanks, pumps, and surge control equipment. You can also use
FlexTables or preset libraries to rapidly copy model parameters. If you already have a
steady-state model of your system in WaterCAD or WaterGEMS, Bentley HAMMER
can use that model file directly - saving you time and eliminating transcription errors.

You can use Bentley HAMMER to:

• Reduce the risk of transient-related damage to maximize operator safety and

reduce the frequency of service interruptions to customers.
• Reduce daily wear and tear on pumping and piping systems to maximize the
useful life of infrastructure.
• Reduce the risk of water contamination during subatmospheric transient pres-
sures, during which groundwater and pollutants could be sucked into the pipe.

1-2 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

• Reduce the number and severity of transient forces resulting from transient pres-
sure shocks, where applicable. Transient forces and pressures can loosen joints or
grow cracks, increasing leaks and non-revenue water.
• Analyze hydropower systems complete with characteristic turbine representations
to simulate load rejection, acceptance and variation cases.
• Prepare operation checklists for use in emergencies such as power failures, pipe
breaks, and component (valve, pump) and/or control failures.
• Develop standards to ensure major water users do not damage the water system.
Information can be provided to industries to avoid sudden water takings or load
rejection. Safe speeds to open or close fire hydrants can be provided to the fire and
waterworks department.
• Provide additional information (with respect to steady-state models) to help select
pumps, locate elevated tanks, and size air valves.

Tip: Usually, hydraulic systems operate at a steady state of dynamic

equilibrium and changes in flow take minutes to hours. "Normal"
hydraulic transients may occur several times a day as pumps
start or stop. "Emergency" transients may only occur once every
month, year, or decade when power fails or pipes break.
Hydraulic transients and surge-protection needs must be
considered in the context of a water utility's risk management
and environmental protection plan.

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 config-
urations are available for Bentley HAMMER...” 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 Adminis-
trator. (You only need to repeat this step if you decide to make a different configura-
tion the default in the future.)

Starting Bentley HAMMER V8i

After you have finished installing Bentley HAMMER, restart your system before
starting Bentley HAMMER for the first time.

Bentley HAMMER V8i Edition User’s Guide 1-3

Working with Bentley HAMMER Files

To start Bentley HAMMER

1. Double-click on the Bentley HAMMER icon on your desktop.

or
2. Click Start > All Programs > Bentley > Bentley HAMMER > Bentley HAMMER.

Working with Bentley HAMMER Files

Bentley HAMMER 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

1-4 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

• .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 spec-
ified 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 doesn’t 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 Direc-
tory) 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.

Bentley HAMMER V8i Edition User’s Guide 1-5

Exiting Bentley HAMMER

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 Bentley HAMMER

To exit Bentley HAMMER

1. Click the application window's Close icon.

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

Using Online Help

Bentley HAMMER Help menu and Help window are used to access Bentley
HAMMER extensive online help.

Context-sensitive online help is available. Hypertext links, which appear in

color and are underlined when you pass the pointer over them, allow you to
move easily between related topics.

Note: Certain Windows DLLs must be present on your computer in order to

use Online Help. Make sure you have Microsoft Internet Explorer
(Version 5.5 or greater) installed. You do not need to change your
default browser as long as Internet Explorer is installed.

To open the Help window

1. From the Help menu, choose Bentley HAMMER Help.

The Help window opens, and the Table of Contents displays.

The Help window consists of two panes - the navigation pane on the left and the
topic pane on the right.
2. To get help on a dialog box control or a selected element:
Press <F1> and the Help window opens (unless it is already open) and shows the
information about the selected element.

1-6 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

Subtopics within a help topic are collapsed by default. While a subtopic is

collapsed only its heading is visible. To make visible a subtopic's body text and
graphics you must expand the subtopic.

To expand a subtopic

Click the expand (+) icon to the left of the subtopic heading or the heading
itself.

Bentley HAMMER V8i Edition User’s Guide 1-7

Using Online Help

To collapse a subtopic

Click the collapse (-) icon to the left of the subtopic heading or the heading
itself.

The navigation pane has the following tabs:

• Contents - used for browsing topics.

• Index - index of help content.
• Search - used for full-text searching of the help content.
• Favorites - customizable list of your favorite topics
To browse topics using the Contents tab

1. On the Contents tab, click the folder symbol next to any book folder (such
as Getting Started, Using Scenarios and Alternatives) to expand its
contents.
2. Continue expanding folders until you reach the desired topic.
3. Select a topic to display its content in the topic pane.
To display the next or previous topic according to the topic order shown in the
Contents tab

To display the next topic, click the right arrow or to display the previous topic, click
the left.

To use the index of help content

1. Click the Index tab.

2. In the search field, type the word you are searching for.
or
Scroll through the index using the scroll bar to find a specific entry.
3. Select the desired entry and click the Display button.
or
Double-click the desired entry.
The content that the selected index entry is referencing displays in the topic pane.

1-8 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

Note: If you select an entry that has subtopics, a dialog box opens
from which you can select the desired subtopic. In this case,
select the subtopic and click the Display button.

To search for text in the help content

1. Click the Search tab.

2. In the search field, type the word or phrase for which you are searching.
3. Click the List Topics button.
Results of the search display in the list box below the search field.
4. Select the desired topic and click the Display button.
or
Double-click the desired topic.
Search results vary based on the quality of the search criteria entered in the Search
field. The more specific the search criteria, the more narrow the search results. You
can improve your search results by improving the search criteria. For example, a word
is considered to be a group of contiguous alphanumeric characters. A phrase is a
group of words and their punctuation. A search string is a word or phrase on which
you search.

A search string finds any topic that contains all of the words in the string. You
can improve the search by enclosing the search string in quotation marks. This
type of search finds only topics that contain the exact string in the quotation
marks.

To add a help topic to a list of “favorite” help topics

1. In the Contents, Index, or Search tabs, select the desired help topic.
2. Click the Favorites tab.
The selected help topic automatically displays in the “Current topic” field
at the bottom of the tab.
3. Click the Add button.
To display a topic from your Favorites list

1. Click the Favorites tab.

2. In the list box, select the desired topic and click the Display button.
or
Double-click the desired topic.
The selected topic's content displays in the topic pane.

Bentley HAMMER V8i Edition User’s Guide 1-9

Software Updates via the Web and Bentley SELECT

Online help is periodically updated and posted on Bentley's Documentation

Web site, http://docs.bentley.com/ for downloading. On this site you can also
browse the current help content for this product and other Bentley products.

Software Updates via the Web and Bentley SELECT

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. It’s 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 Bentley HAMMER 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.

Troubleshooting
Due to the multitasking capabilities of Windows, you may have applications running
in the background that make it difficult for software setup and installations to deter-
mine the configuration of your current system.

Try these steps before contacting our technical support staff

1. Shut down and restart your computer.

2. Verify that there are no other programs running. You can see applications
currently in use by pressing Ctrl+Shift+Esc in Windows 2000 and Windows XP.
Exit any applications that are running.
3. Disable any antivirus software that you are running.

Caution: After you install Bentley HAMMER V8i, make certain that you
restart any antivirus software you have disabled. Failure to
restart your antivirus software leaves you exposed to
potentially destructive computer viruses.

4. Try running the installation or uninstallation again (without running any other
program first).

If these steps fail to successfully install or uninstall the product, contact Technical
Support.

1-10 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

Checking Your Current Registration Status

After you have registered the software, you can check your current registration status
by opening the About... box from within the software itself.

To view your registration information

1. Select Help > About Bentley HAMMER V8i.

2. The version and build number for Bentley HAMMER V8i display in the lower-
left corner of the About Bentley HAMMER V8i dialog box.
The current registration status is also displayed, including: user name and
company, serial number, license type and check-in status, feature level, expiration
date, and SELECT Server information.

Application Window Layout

The Bentley HAMMER application window contains toolbars that provide access to
frequently used menu commands and are organized by the type of functionality
offered.

Standard Toolbar

Edit Toolbar

Analysis Toolbar

Scenarios Toolbar

Compute Toolbar

View Toolbar

Help Toolbar

Layout Toolbar

Tools Toolbar

Zoom Toolbar

Customizing Bentley HAMMER Toolbars and Buttons

Bentley HAMMER Dynamic Manager Display

Bentley HAMMER V8i Edition User’s Guide 1-11

Application Window Layout

Standard Toolbar

The Standard toolbar contains controls for opening, closing, saving, and printing
Bentley HAMMER projects.

1-12 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

The Standard toolbar is arranged as follows:

To Use

Create a new Bentley HAMMER V8i project. New

When you select this command, the Select
File to Create dialog box opens, allowing you
to define a name and directory location for the
new project.

Open an existing Bentley HAMMER V8i Open

project. When this command is initialized, the
Select Bentley HAMMER V8i Project to Open
dialog box opens, allowing you to browse to
the project to be opened.

Closes the currently open project. Close

Close all the projects that are opened. Close All

Bentley HAMMER V8i Edition User’s Guide 1-13

Application Window Layout

Save the current project. Save

Save all the projects that are opened. Save All

Open the Print Preview window, displaying Print

the current view of the network as it will be Preview
printed. 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 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 Print

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 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 Bentley HAMMER.

1-14 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

The Edit toolbar is arranged as follows:

To Use

Cancel your most recent action. Undo

Redo the last canceled action. Redo

Delete the currently selected element(s) from the Delete

network.

Removes the highlighting that can be applied Clear

using the Network Navigator. Highlight

Find a specific element by choosing it from a Find Element

menu containing all elements in the current
model.

Analysis Toolbar

The Analysis toolbar contains controls for analyzing Bentley HAMMER projects.

Bentley HAMMER V8i Edition User’s Guide 1-15

Application Window Layout

The Analysis toolbar is arranged as follows:

To Use

Opens the Post Calculation Processor, which Post

allows you to perform statistical analysis for an Calculation
element or elements on various results obtained Processor
during an extended period simulation calculation.

Opens the Transient Results Viewer dialog, Transient

which allows you to view profile and time-series Results Viewer
graph results from transient simulations.

Opens the Transient Time Step Options dialog, Transient

which shows the time step suggested by Time Step
HAMMER and the adjustments to lengths or Options
wavespeeds it requires.

Opens the Transient Thematic Viewer, which Transient

allows you to apply colored highlighting to the Thematic
pipes and nodes in the model according to their Viewer
calculated values for a specified attribute.

Scenarios Toolbar

The Scenarios toolbar contains controls for creating scenarios in Bentley HAMMER
projects.

1-16 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

The Scenarios toolbar is arranged as follows:

To Use

Change the current scenario. Scenario List

Box

Open the Scenario manager, where you can Scenarios

create, view, and manage project scenarios.

Open the Alternative manager, where you can Alternatives

create, view, and manage project alternatives.

Open the Calculation Options manager, where Calculation

you can create different profiles for different Options
calculation settings.

Compute Toolbar

The Compute toolbar contains controls for computing Bentley HAMMER projects.

Bentley HAMMER V8i Edition User’s Guide 1-17

Application Window Layout

The Compute toolbar contains the following:

To Use

Run a diagnostic check on the network data to Validate

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 Bentley
HAMMER 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 Compute

the transient simulation. Initial
Conditions

Calculate the network. Before calculating, an Compute

automatic validation routine is triggered, which
checks the model for network connectivity
errors and performs other validation.

Open the Calculation Summary dialog box. Calculation

Summary

Open the Transient Calculation Summary dialog Transient

box. Calculation
Summary

Open the User Notifications Manager, allowing User

you to view warnings and errors uncovered by Notifications
the validation process. This button does not
appear in the toolbar by default but can be added

1-18 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

View Toolbar

The View toolbar contains controls for viewing Bentley HAMMER projects.

The View toolbar contains the following:

To Use

Open the Element Symbology manager, Element

allowing you to create, view, and manage the Symbology
element symbol settings for the project.

Open the Background Layers manager, allowing Background

you to create, view, and manage the background Layers
layers associated with the project.

Open the Network Navigator dialog box. Network

Navigator

Open the Selection Sets Manager, allowing you Selection Sets

to create, view, and modify the selection sets
associated with the project.

Opens the Query Manager. Queries

Opens the Prototypes Manager. Prototypes

Open the FlexTables manager, allowing you to FlexTables

create, view, and manage the tabular reports for
the project.

Bentley HAMMER V8i Edition User’s Guide 1-19

Application Window Layout

Open the Graph manager, allowing you to Graphs

create, view, and manage the graphs for the
project.

Open the Profile manager, allowing you to Profiles

create, view, and manage the profiles for the
project.

Open the Contour Manager where you can Contours

create, view, and manage contours.

Open the Named Views manager where you can Named Views
create, view, and manage named views.

Open the Aerial View manager where you can Aerial View
zoom to different elements in the project.

Opens the Property Editor. Properties

Opens the Property Grid Customizations Property Grid

manager. Customizations

Help Toolbar

The Help toolbar provides quick access to the some of the commands that are avail-
able in the Help menu.

1-20 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

The Help toolbar contains the following:

To Use

Open your Web browser to the SELECTservices Check for

page on the Bentley Web site. SELECT
Updates

Open the Bentley Institute page on the Bentley Bentley

Web site. Institute
Training

Open your Web browser to the SELECTservices Bentley

page on the Bentley Web site. SELECT
Support

Opens your web browser to the Bentley.com Bentley.com

Web site’s main page.

Opens the Bentley HAMMER V8i online help. Help

Layout Toolbar

The Layout toolbar is used to lay out a model in the Bentley HAMMER drawing pane.

Bentley HAMMER V8i Edition User’s Guide 1-21

Application Window Layout

The Layout toolbar contains the following:

To Use

Change your mouse cursor into a selection tool. Select

The selection tool behavior varies depending
on the direction in which the mouse is dragged
after defining the first corner of the selection
box, as follows:
• If the selection is made from left-to-right, all
elements that fall completely within the
selection box that is defined will be
selected.
• If the selection is made from right-to-left, all
elements that fall completely within the
selection box and that cross one or more of
the lines of the selection box will be
selected.

Change your mouse cursor into a pipe tool. Pipe

Change your mouse cursor into a junction tool. Junction

When this tool is active, click in the drawing
pane to place the element.

Change your mouse cursor into a hydrant tool. Hydrant

When this tool is active, click in the drawing
pane to place the element.

Change your mouse cursor into a tank element Tank

symbol. When this tool is active, click in the
drawing pane to place the element.

Change your mouse cursor into a reservoir Reservoir

element symbol. When this tool is active, click
in the drawing pane to place the element.

Change your mouse cursor into a pump Pump

element symbol. Clicking the left mouse button
while this tool is active causes a pump element
to be placed at the location of the mouse cursor.

1-22 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

Change your mouse cursor into a pump station Variable Speed

element symbol. Clicking the left mouse button Pump Battery
while this tool is active causes a pump station
element to be placed at the location of the
mouse cursor.

Change your mouse cursor into a valve tool. Valves

Click the down arrow to select the type of valve
you want to place in your model:
• Pressure Reducing Valve
• Pressure Sustaining Valve
• Pressure Breaker Valve
• Flow Control Valve
• Throttle Control Valve
• General Purpose Valve

Change your mouse cursor into an isolation Isolation Valve

valve symbol. When this tool is active, click in
the drawing pane to place the element.

Change your mouse cursor into a spot elevation Spot Elevation

symbol. When this tool is active, click in the
drawing pane to place the element.

Change your mouse cursor into a turbine Turbine

symbol. When this tool is active, click in the
drawing pane to place the element..

Change your mouse cursor into a periodic Periodic Head-

head-flow symbol. When this tool is active, Flow
click in the drawing pane to place the element.

Change your mouse cursor into an air valve Air Valve

symbol. When this tool is active, click in the
drawing pane to place the element.

Bentley HAMMER V8i Edition User’s Guide 1-23

Application Window Layout

Change your mouse cursor into a Hydropneumatic

hydropneumatic tank symbol. When this tool is Tank
active, click in the drawing pane to place the
element.

Change your mouse cursor into a surge valve Surge Valve

symbol. When this tool is active, click in the
drawing pane to place the element.

Change your mouse cursor into a check valve Check Valve

symbol. When this tool is active, click in the
drawing pane to place the element.

Change your mouse cursor into a rupture disk Rupture Disk

symbol. When this tool is active, click in the
drawing pane to place the element.

Change your mouse cursor into a discharge to Discharge to

atmosphere symbol. When this tool is active, Atmosphere
click in the drawing pane to place the element.

Change your mouse cursor into an orifice Orifice Between

between pipes symbol. When this tool is active, Pipes
click in the drawing pane to place the element.

Change your mouse cursor into a valve with Valve with

linear area change symbol. When this tool is Linear Area
active, click in the drawing pane to place the Change
element.

1-24 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

Change your mouse cursor into a surge tank Surge Tank

symbol. When this tool is active, click in the
drawing pane to place the element.

Change your mouse cursor into a border Border

symbol. When the border tool is active, you can
draw a simple box in the drawing pane using
the mouse. For example, you might want to
draw a border around the entire model.

Change your mouse cursor into a text symbol. Text

When the text tool is active, you can add
simple text to your model. Click anywhere in
the drawing pane to display the Text Editor
dialog box, where you can enter text to be
displayed in your model.

Change your mouse cursor into a line symbol. Line

When this tool is active, you can draw lines and
polygons in your model using the mouse.

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:

Bentley HAMMER V8i Edition User’s Guide 1-25

Application Window Layout

To Use

Open a Select dialog to select areas in the drawing. Active Topology

Selection

Open the ModelBuilder Connections Manager, where ModelBuilder

you can create, edit, and manage ModelBuilder
connections to be used in the model-building/model-
synchronizing process.

Open the TRex wizard where you can select the data Trex
source type, set the elevation dataset, choose the model
and features.

Open the SCADAConnect manager where you can add or SCADAConnect

edit signals.

Open the Skelebrator manager to define how to Skelebrator

skeletonize your network. Skeletonizer

Open the LoadBuilder manager where you can create and Load Builder
manage Load Build templates.

Open the Wizard used to create a Thiessen polygon. Thiessen Polygon

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

1-26 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

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

Opens the Scenario Coparison window, which enables Scenario

you to compare input values between any two scenarios Comparison
to identify differences quickly.

Associate external files, such as pictures or movie files, Hyperlinks

with elements.

Open the User Data Extension dialog box, which allows User Data
you to add and define custom data fields. For example, Extensions
you can add new fields such as the pipe installation date.

Compact the database, which eliminates the empty data Compact

records, thereby defragmenting the datastore and Database
improving the performance of the file.

Synchronize the current model drawing with the project Synchronize

database. Drawing

Ensures consistency between the database and the model Update Database
by recalculating and updating certain cached information. Cache
Normally this operation is not required to be used.

This command copies the model result files (if any) from Update Results
the project directory (the directory where the project from Project
.sqlite file is saved) to the working temp location for Directory
Bentley HAMMER (%temp%\Bentley\HAMMER). 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.

Bentley HAMMER V8i Edition User’s Guide 1-27

Application Window Layout

This command copies the result files that are currently Copy Results to
being used by the model to the project directory (where Project Directory
the project .sqlite is stored).

Open a Batch Assign Isolation Valves window where you Assign Isolation
can find the nearest pipe for each selected isolation and Valves to Pipes
assign the valve to that pipe.

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 Options
Global settings, Drawing, Units, Labeling, and
ProjectWise.

Zoom Toolbar

The Zoom toolbar provides access to the zooming and panning tools.

1-28 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

The Zoom toolbar contains the following:

To Use

Set the view so that the entire model is visible in Zoom Extents
the drawing pane.

Activate the manual zoom tool, where you can Zoom Window
specify a portion of the drawing to enlarge.

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 Zoom

to zoom in and out by moving the mouse while Realtime
the left mouse button is depressed.

Open up the Zoom Center dialog box where you Zoom Center
can set X and Y coordinates and the percentage of
Zoom.

Enable you to zoom to specific elements in the Zoom

drawing. You must select the elements to zoom to Selection
before you select the tool.

Bentley HAMMER V8i Edition User’s Guide 1-29

Application Window Layout

Return the zoom level to the most recent previous Zoom Previous
setting.

Reset the zoom level to the setting that was active Zoom Next
before a Zoom Previous command was executed.
This button also does not appear in the Zoom
toolbar by default.

Activate the Pan tool, which allows you to move Pan

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.

Update the main window view according to the Refresh

latest information contained in the Bentley Drawing
HAMMER V8i datastore.

1-30 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

Customizing Bentley HAMMER Toolbars and Buttons

Toolbar buttons represent Bentley HAMMER V8i menu commands. Toolbars can be
controlled in Bentley HAMMER 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.

Bentley HAMMER V8i Edition User’s Guide 1-31

Application Window Layout

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, then 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.

Bentley HAMMER Dynamic Manager Display

Most of the features in Bentley HAMMER V8i is accessed through a system of

dynamic windows called managers. For example, the look of the elements is
controlled in the Element Symbology manager.

1-32 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

The following table lists all the Bentley HAMMER V8i managers, their toolbar
buttons, and keyboard shortcuts.

Toolbar Keyboard
Button Manager Shortcut

Scenarios—build a model run from <Alt+1>

alternatives.

Alternatives—create and manage <Alt+2>

alternatives.

Calculation Options—set parameters for <Alt+3>

the numerical engine.

Totalizing Flow Meters—create and <Alt+4>

manage flow meters.

Hydrant Flow Curves—create and <Alt+5>

manage hydrant flow curves.

Element Symbology—control how <Ctrl+1>

elements look and what attributes are
displayed.

Background Layers—control the display <Ctrl+2>

of background layers.

Network Navigator—helps you find nodes <Ctrl+3>

in your model.

Selection Sets—create and manage <Ctrl+4>

selection sets.

Queries—create SQL expressions for use <Ctrl+5>

with selection sets and FlexTables.

Prototypes—create and manage <Ctrl+6>

prototypes.

Bentley HAMMER V8i Edition User’s Guide 1-33

Application Window Layout

Toolbar Keyboard
Button Manager Shortcut

FlexTables—display and edit tables of <Ctrl+7>

elements.

Graphs—create and manage graphs. <Ctrl+8>

Profiles —draw profiles of parts of your <Ctrl+9>

network.

Contours—create and manage contours. <Ctrl+0>

Properties—display properties of <F4>

individual elements or managers.

Refresh—Update the main window view <F5>

according to the latest information
contained in the Bentley HAMMER V8i
datastore.

User Notifications—presents error and <F8>

warning messages resulting from a
calculation.

Compute. <F9>

When you first start Bentley HAMMER V8i, only two managers are displayed: the
Element Symbology and Background Layers managers. This is the default workspace.
You can display as many managers as you want and move them to any location in the
Bentley HAMMER V8i workspace.

1-34 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

To return to the default workspace

Click View > Reset Workspace.

• If you return to the default workspace, the next time you start Bentley HAMMER
V8i, you will lose any customizations you might have made to the dynamic
manager display.

To open a manager

1. Do one of the following:

– Select the desired manager from the View menu.
– Click a manager’s button on one of the toolbars.
– Press the keyboard shortcut for the desired manager.

2. If the manager is not already docked, you can drag it to the top, left- or right-side,
or bottom of the Bentley HAMMER window to dock it. For more information on
docking managers, see Customizing Managers.

Customizing Managers
When you first start Bentley HAMMER V8i, you will see the default workspace in
which a limited set of dock-able managers are visible. You can decide which managers
will be displayed at any time and where they will be displayed. You can also return to
the default workspace any time.

There are four states for each manager:

Floating—A floating manager sits above the Bentley HAMMER V8i workspace like
a dialog box. You can drag a floating manager anywhere and continue to work.

You can also:

• Resize a floating manager by dragging its edges.

• Close a floating manager by clicking on the x in the top right-hand corner of the
title bar.
• Change the properties of the manager by right-clicking on the title bar.
• Switch between multiple floating managers in the same location by clicking the
manager’s tab.
• Dock the manager by double-clicking the title bar.

Bentley HAMMER V8i Edition User’s Guide 1-35

Application Window Layout

Docked static—A docked static manager attaches to any of the four sides of the
Bentley HAMMER V8i window. If you drag a floating manager to any of the four
sides of the Bentley HAMMER V8i window, the manager will attach or dock itself to
that side of the window. The manager will stay in that location unless you close it or
make it dynamic. A vertical pushpin in the manager’s title bar indicates its static state;
click the pushpin to change the manager’s state to dynamic. When the push pin is
pointing downward (vertical push pin), the manager is docked.

You can also:

• Close a docked manager by left clicking on the x in the upper right corner of the
title bar.
• Change a docked manager into a floating manager by double-clicking the title bar,
or by dragging the manager to the desired location (for example, away from the
side of the Bentley HAMMER V8i window).
• Change a static docked manager into a dynamically docked manager by clicking
the push pin in the title bar.
• Switch between multiple docked managers in the same location by clicking the
manager’s tab.

Docked dynamic—A docked dynamic manager also docks to any of the four sides of
the Bentley HAMMER V8i window, but remains hidden except for a single tab. Show
a docked dynamic manager by moving the mouse over the tab, or by clicking the tab.
When the manager is showing (not hidden), a horizontal pushpin in its title bar indi-
cates its dynamic state.

You can also:

• Close a docked manager by left-clicking on the x in the upper right corner of the
title bar.
• Change a docked dynamic manager into a docked static manager by clicking the
push pin (converting it from vertical to horizontal).
• Switch between multiple docked managers in the same location by moving the
mouse over the manager’s tab or by clicking the manager’s tab.

Closed—When a manager is closed, you cannot view it. Close a manager by clicking
the x in the right corner of the manager’s title bar. Open a manager by selecting the
manager from the View menu (for example, View > Element Symbology), or by
selecting the button for that manager on the appropriate toolbar.

1-36 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

WaterObjects Help for Model Users

Q. What is WaterObjects?

WaterObjects is a set of application and business logic upon which WaterCAD, Water-
GEMS and HAMMER are built. You may think of WaterObjects as the foundation or
core workings of the WaterCAD, WaterGEMS and HAMMER applications. Given
that WaterObjects is essentially invisible to any user running WaterCAD, WaterGEMS
and HAMMER, you might wonder why we decided to give it a special name! The
reason is that the application and business logic embodied by WaterObjects is generi-
cally re-usable by external parties (and that means you too) in order to create your
own custom application extensions or features. So in the most general sense WaterOb-
jects is something that allows 3rd parties to extend the functionality of WaterCAD,
WaterGEMS and HAMMER, without having to request the functionality from
Bentley and then wait for it to be released in a future version of the software. While
the feature is called "WaterObjects", a large majority of the feature is also applicable
to Bentley storm and sewer products too. Time you invest in customizing WaterCAD
or WaterGEMS for example, will have re-use potential for other Bentley Municipal
Products applications.

Q. What can I do with WaterObjects?

As mentioned above WaterObjects provides the ability to write custom features to

extend the existing WaterCAD, WaterGEMS and HAMMER functionality. For
example, you may have some special calculation and report that you currently create
in Excel since your supervisor/client prefers to see it in that format. With WaterOb-
jects you could automate the calculation and generation of the report in Excel. In fact
if you need any special additional behavior that you can't do in WaterCAD, Water-
GEMS, or HAMMER with the existing functionality (make sure you looked at
queries, user data extensions and the post calculation processor features) chances are
that you'll able to achieve it with WaterObjects.

Q. What can't I do with WaterObjects?

As mentioned above WaterObjects represents the core workings of WaterCAD, Water-

GEMS and HAMMER. As such it includes functionality to be able to read and write
model data, to be able to deal with scenarios and alternatives, to be able to run compu-
tations and access results. It does not, however, provide ready access to application
specific logic at least in a way that can be broken down into its constituent compo-
nents. This means that you can't use WaterObjects to modify existing calculations
(although you could add the calculation of additional results or a completely new
computation) and you can't add new menus or buttons to the existing user interface.
For example, you couldn't add a new type of graph to the graphing feature or you
couldn't add a new right-click menu to the map display.

Bentley HAMMER V8i Edition User’s Guide 1-37

WaterObjects Help for Model Users

Q. How do I use WaterObjects?

The answer to this question depends on whether you are a programmer or not. If you
are a programmer and are familiar with the terms API, .Net, Interface, Namespace and
also with a .Net compliant language such as VB.Net, C#.Net or C++.Net you may be
able to pick up WaterObjects pretty quickly, but if you are not a programmer you may
need to work with one to do the programming for you.

If you need to hire a programmer (Bentley Professional Services may be able to

provide you with one) then you'll need to understand some terminology to allow you
to communicate with them more easily.

1. .NET: Microsoft's .NET Framework which comprises the Common Language

Runtime, CLR, (provides an abstraction layer over the operating system), Base
class libraries (pre-built code for low level programming tasks) and development
frameworks and technologies (re-usable, customizable solutions for larger
programming tasks). The CLR is an implementation of the CLI (Common
Language Infrastructure). You or your programmer must write .NET compatible
code.
2. Interface: A contract in software that defines the nature of the public (or external)
makeup of the programming component. The analogy in hardware would be a
specific kind of plug (such as DVI video) that can only connect to another plug
that supports the same interface. This defines how your custom code interacts
with the existing Bentley code.
An example might be INumericalEngine which defines an interface for dealing
with components that support some kind of computational engine or solver.
3. Classes: In object oriented programming, a class is a bite sized piece of encapsu-
lated functionality. The class name typically identifies the core function or nature
of the class (e.g., PressurePipe might represent a pressure pipe that has a Material
property, a Diameter property and so on). An instance of the class represents an
actual PressurePipe where as the PressurePipe class is the template or prototype
that defines all PressurePipes. If we like we could take out all the uniquely Pres-
surePipe bits of the PressurePipe class and use them to define an IPressurePipe
interface.
4. Namespace: In .NET this is a way of providing scope to a set of programming
objects that all belong in the same collective group.
For example consider the PressurePipe class from above. Without a namespace
we don't know who owns the PressurePipe, but with a namespace such as
Bentley.Domain.Water.PressurePipe we know we are talking about a specific kind
of PressurePipe. We won't confuse that PressurePipe with HomeHard-
ware.DIY.PressurePipe. We'll also likely find other similar objects in the same
location. e.g., Bentley.Domain.Water.PressureValve.

1-38 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

5. API: Application Programming Interface. A set of interfaces that provide access

to some logical grouping of functionality. WaterObjects is a specific example of
an API. You will interact with the WaterObjects API when you write your custom
code.
6. Framework: In the context of WaterObjects the framework (or the Municipal
Development Framework) is itself a sub-set of WaterObjects, providing access to
the most generic features such as unit conversions, database access, scenarios and
alternatives, graphing, and re-usable user interface components such as tables and
lists. An example of a framework component is the FlexGridControl that lives in
the Haestad.Framework.Windows.Forms.Syncfusion.Components namespace.
This control (or component) is the underlying control for all the tabular based user
interfaces in the Bentley Municipal Products applications.
7. Domain: A sub-set of the Municipal Development Framework that deals prima-
rily with database operations and core business logic. This logic lives under the
Haestad.Domain namespace. Some examples of Haestad.Domain constructs are
the IDataSource interface (allowing file open/close access on model files), and the
IDomainDataSet interface (allowing access to the model data set and access to
managers such as the AlternativeManager (for accessing alternatives), Scenari-
oManager (for accessing scenarios), the DomainElementManager (for accessing
domain elements), and the SupportElementManager (for accessing support
elements)).
8. Domain Element: An element used for modeling purposes. E.g., a pipe, tank,
hydrant, valve etc.
9. Support Element: An element used in support of modeling and usually refer-
enced as additional state or information by a domain element. E.g., a pump defini-
tion (pump curve and efficiency curve), a valve headloss curve etc.

More information about the technical details of WaterObjects can be found in docu-
mentation that accompanies WaterObjects.

Q. How do I get WaterObjects?

WaterObjects is available for licensed users of WaterCAD, WaterGEMS and

HAMMER from the Bentley Developer Network, BDN.

http://www.bentley.com/en-US/Corporate/Bentley+Partner+Program/Tech-
nology+Partners/Developers.htm

Support for WaterObjects.NET is available through the Bentley Developer Network.

See the Member Guide for support options:

http://ftp2.bentley.com/dist/collateral/Web/BPP/BDNMemberGuide.pdf

For more details about getting started with WaterObjects see

Bentley HAMMER V8i Edition User’s Guide 1-39

WaterObjects Help for Model Users

http://www.bentley.com/en-US/Products/WaterGEMS/WaterObjects.NET-
Bentley.htm

Q. What programming languages can I use with WaterObjects?

WaterObjects is primarily written in Microsoft.NET and therefore requires a .NET

compliant language in order to be able to interoperate with WaterObjects. Your
choices include:

1. VB.NET (Visual Basic for .NET)

2. C#.NET (Microsoft C#)
3. C++.NET (Microsoft C++)
In addition to these any other CLI (Common Language Infrastructure) language
should be able to be used such as:

4. J# (Microsoft J#- A Java like programming language)

5. Fortran.NET
6. #Smalltalk

And many others.

For more potential examples visit http://en.wikipedia.org/wiki/

List_of_CLI_languages

It should be noted that internally the Bentley Municipal Products development group
predominantly use C# and C++ to develop with WaterObjects. WaterObjects itself is
also predominantly written in these two languages. We do not have any direct experi-
ence with many of the other possible languages that may be used.

Typically you would choose a language that you or your programmer is most familiar
with in order to maximize productivity. If possible, and all other things being equal,
you'll find that Bentley will be able to support you more easily if you stick to one of
the languages Bentley uses and is familiar with such as VB.NET, C# or C++.Net.

Q. How do write a WaterObjects Program that works in Microsoft

Office?

Those familiar with macros and programming Microsoft Office will typically be used
to using VBA (Visual Basic for Applications) to customize those applications. Since
WaterObjects, however, is a .NET API, it cannot be used with VBA. To solve the
problem of Microsoft Office leveraging application logic and APIs written in .NET,
Microsoft introduced a technology called VSTO. The latest version of this at the time
of writing is VSTO2005SE and this allows users to write add-ins for the Microsoft

1-40 Bentley HAMMER V8i Edition User’s Guide

 Getting Started in Bentley HAMMER V8i

Office suite that can use either VB.NET or C# as the programming language. The
documentation that comes with WaterObjects includes more description on VSTO and
how to use it. Note that this is a step up in complexity from regular WaterObjects.NET
development.

Q. How do I design a WaterObjects Program?

Whether or not you are doing the programming yourself you'll need to base your
design on what you are trying to achieve with the program. First it will be necessary to
document the goals of the application. In the software development industry this is
typically done from the user's point of view and is called creating "user stories". To
that end, put yourself into the shoes of the end-users for your program and document
the workflows that the user would expect to encounter. This can be as detailed as it
needs to be including how the user would start the program, and what they do when
the program is running.

Options for starting a WaterObjects program will depend on the nature of the program
developed, but may include:

1. Starting from the External Tools Menu from within WaterCAD/GEMS/

HAMMER,
2. Starting from a desktop shortcut to a stand alone executable,
3. Starting some 3rd party application (such as Excel) and accessing add-in menus.

In addition to starting the program you'll need to define the inputs and the expected
outputs. Inputs may include human entered input or file based input (such as a Water
model, or tabular data) and output may include things like raw data, reports, graphs
and tables in desired formats (e.g. an Excel spreadsheet, Oracle database or a Notepad
file). In arriving at the outputs the details of any specific calculations will need to be
documented. Finally, you'll need to determine where you want to store the output from
your calculations. Choices for storing output may include:

1. Custom results file (binary, XML, text or other format),

2. Within a 3rd party application (such as MS Access or Excel),
3. Within WaterCAD/GEMS/HAMMER using User Data Extensions.

The above process sounds like it may be tricky, particularly when some of the answers
potentially require some advance knowledge of how things are going to turn out. This
is precisely why in software development an iterative development approach is
commonly adopted. In an iterative approach a the overall program requirements are
kept initially to a minimum and then staged in bite sized pieces with the progress of
the development being demonstrated by the programmer to the stakeholders at regular
intervals. This process is sometime called "Agile" software development. More can be
found out about Agile development by searching on-line.

Bentley HAMMER V8i Edition User’s Guide 1-41

WaterObjects Help for Model Users

1-42 Bentley HAMMER V8i Edition User’s Guide

 Chapter

Quick Start Lessons 2

Note: You should copy the lesson files contained in the
Bentley\HAMMER8\Lessons directory to a working folder before
working with or modifying them. This will preserve the integrity
of the original files and circumvent potential problems with
administrative write permissions in the product directories.

Bentley HAMMER is a very efficient and powerful tool for simulating hydraulic tran-
sients in pipelines and networks. The quick-start lessons give you hands-on experi-
ence with many of Bentley HAMMER's features and capabilities. These detailed
lessons will help you to explore and understand the following topics:

1. Pipeline Protection using Bentley HAMMER—by assembling a pipeline using the

graphical editor and performing two hydraulic transient analyses; without protec-
tion and with protection.
2. Network Risk Reduction using Bentley HAMMER—by opening a water distribu-
tion network model created in Bentley WaterGEMS and performing a hydraulic
transient analysis using advanced surge protection and presentation methods.

Bentley HAMMER V8i Edition User’s Guide 2-43

Lesson 1: Pipeline Protection

Another way to become acquainted with Bentley HAMMER is to run and experiment
with the sample files, located in the \Bentley\HAMMER8\Samples folder. Remember,
you can press the F1 key to access the context-sensitive help at any time.

Lesson 1: Pipeline Protection

In this lesson, you will use Bentley HAMMER to perform a numerical simulation of
hydraulic transients in a water transmission main and, based on the results of your
analysis, recommend suitable surge-protection equipment to protect this system from
damage. You can do this in three steps:

1. You need to analyze the system as it was designed (without any surge-protection
equipment) to determine its vulnerability to transient events.
2. You can select and model different surge-protection equipment to control transient
pressures and predict the time required for friction to attenuate the transient
energy.
3. You can present your results graphically to explain your surge-control strategy
and recommendations for detailed design.

2-44 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

Part 1—Creating or Importing a Steady-State Model

You can create an initial steady-state model of your system within Bentley HAMMER
directly, using the advanced Bentley HAMMER Modeler interface, or import one
from an existing steady-state model created using other software. In this lesson, you
will assemble a hydraulic transient model using both methods to learn their respective
advantages and note the similarities between them.

Creating a Model
Bentley HAMMER is an extremely efficient tool for laying out a water-transmission
pipeline or even an entire distribution network. It is easy to prepare a schematic model
and let Bentley HAMMER take care of the link-node connectivity and element labels,
which are assigned automatically. For a schematic model only pipe lengths must be
entered manually to complete the layout. You may need to input additional data for
some hydraulic elements prior to a run.

Note: Regardless of the screen coordinates entered or displayed in the

element editor, if the “Has User Defined Length?” property is set
to True, Bentley HAMMER analyzes the system using the pipe
lengths entered.

The water system is described as follows: a water-pumping station draws water from a
nearby reservoir (383 m normal water level) and conveys 468 L/s along a dedicated
transmission pipeline to a reservoir (456 m normal water level) for a total static lift of
456 – 383 = 73 m. The elevation of the constant-speed pump is 363 m and its speed is
1760 rpm. Transmission main data are given in tables Nodes and Elevations and
Link (Pipe) Properties and Steady State HGL. Other data will be discussed below,
as you add or modify each hydraulic element in this system.

To create a hydraulic model using the Bentley HAMMER Modeler interface:

1. Click File > New to start a new project. This starts Bentley HAMMER's graphical
element editor, so you can draw the system by inserting hydraulic elements.
2. Click the Tools menu and select Options. Go to the Drawing tab and change the

Bentley HAMMER V8i Edition User’s Guide 2-45

Lesson 1: Pipeline Protection

Drawing Mode to Schematic.

2-46 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

3. Go to the Units tab, click the Reset Defaults button and change the Default unit
system for this project to System International.

Click OK.

Bentley HAMMER V8i Edition User’s Guide 2-47

Lesson 1: Pipeline Protection

4. Add a Reservoir element.

a. Click the Reservoir button on the Layout toolbar.

b. Move the cursor over the drawing pane and click to place the reservoir.
Bentley HAMMER automatically names this element R-1.
c. Double-click the reservoir to open the Properties editor. Rename the reservoir
by entering Res1 in the Label field of the Properties editor dialog. Change the
Elevation value to 383.00m and the Elevation (Inlet/Outlet Invert) value to
380.00m.

5. Add a Junction element to the right of Res1 and rename it PJ1. Change the
Elevation to 363.00m.

6. Add a Pump element to the right of PJ1 and rename it PMP1. Change the
Elevation to 363.00m.
7. Add 7 more Junction elements in a line to the right of PMP1. Rename them and
set their elevations according to the data in the table below:
Nodes and Elevations

Default Label Rename to Elevation (m)

J-2 PJ2 363.00

J-3 J1 408.00

J-4 J2 395.00

J-5 J3 395.00

J-6 J4 386.00

J-7 J5 380.00

J-8 J6 420.00

8. Add a Reservoir element to the right of J6. Rename it Res2 and change the Eleva-
tion to 456.00m and the Elevation (Inlet/Outlet Invert) to 453.00m.

2-48 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

Note: Transient Tip: Elevations are extremely important in hydraulic

transient modeling. This is because slopes determine how fast
water columns will slow down (or speed up) as their momentum
changes during a transient event. Therefore, defining the profile
of a pipeline is a key requirement prior to undertaking any
hydraulic transient analysis using Bentley HAMMER.

9. Add pipes connecting each of the node elements. Click the Pipe button on
the Layout toolbar.
a. Click Res1.
b. Click PJ1.
c. Click PMP1.
d. Continue clicking each node in turn from left to right.
e. After you've clicked Res2, right-click and select Done to finish laying out the
pipe.

10. When editing data for a large number of elements, it can be more convenient to do
so using FlexTables. Click the View menu and select the FlexTables command. In
the FlexTables Manager, double-click Pipe Table.

Bentley HAMMER V8i Edition User’s Guide 2-49

Lesson 1: Pipeline Protection

11. In the FlexTable, you can edit white fields only; yellow fields are read-only. When
all of the elements in the table should have the same value for an attribute, you can
globally edit them to set them all at once. Right-click the Diameter column and
select Global Edit. Leave the Operation at Set and enter 600.00 as the value. Click
OK.

12. Right-click the Has User Defined Length? column and select Global Edit. Leave
the Operation at Set and place a check in the Value box, then click OK.
13. Enter data for each of the pipes using the data in the table below. You can use the
Global Edit function to enter the Wave Speed.
Link (Pipe) Properties and Steady State HGL

Length (User Diameter Wave Speed

Default Label Rename To
Defined) (m) (mm) (m/s)

P-1 PS1 50 600 1200.00

P-2 PMP1S 40 600 1200.00

P-3 PMP1D 10 600 1200.00

P-4 P1 20 600 1200.00

P-5 P2 380 600 1200.00

P-6 P3 300 600 1200.00

2-50 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

Link (Pipe) Properties and Steady State HGL

Length (User Diameter Wave Speed

Default Label Rename To
Defined) (m) (mm) (m/s)

P-7 P4 250 600 1200.00

P-8 P5 400 600 1200.00

P-9 P6 250 600 1200.00

P-10 P7 175 600 1200.00

14. After you have finished editing the data, close the FlexTable. The final piece of
element data we need to define is the pump definition. Click the Components
menu and select Pump Definitions.
15. Click the New button to create a new pump definition. Under Pump Definition
Type select Design Point (1 Point). Enter a value of 468 L/s for the Design Flow
and 81.30m for the Design Head. Click the Close button.

16. Highlight pump PMP1. In the Properties Editor click the Pump Definition field
and select Pump Definition - 1 from the list.

Bentley HAMMER V8i Edition User’s Guide 2-51

Lesson 1: Pipeline Protection

17. In the drawing view, some of the elements and element labels may overlap,
obscuring one another. You can reposition element labels. Zoom in on an element
label and click on it. If done correctly, only the label will be highlighted; if the
element and label are highlighted, try clicking again. When the element label is
highlighted, a dot will appear near the highlighted label; this is called the label's
grip.

18. Click on the grip, hold down the mouse button, and move it to the desired loca-
tion, then let go of the mouse button. Reposition the labels so that all of them are
visible. When you are finished the model should look like this:

19. We can now calculate the steady-state initial conditions of the model. Click the
Compute Initial Conditions button.
20. Close the Calculation Summary window and the User Notifications window.
21. Click File > Save As to select a directory and save your file with a name such as
Lesson1.wtg.

Part 2—Selecting the Transient Events to Model

Any change in flow or pressure, at any point in the system, can trigger hydraulic tran-
sients. If the change is gradual, the resulting transient pressures may not be severe.
However, if the change of flow is rapid or sudden, the resulting transient pressure can
cause surges or water hammer. Since each system has a different characteristic time,
the qualitative adjectives gradual and rapid correspond to different quantitative time
intervals for each system.

There are many possible causes for rapid or sudden changes in a pipe system,
including power failures, pipe breaks, or a rapid valve opening or closure. These can
result from natural causes, equipment malfunction, or even operator error. It is there-
fore important to consider the several ways in which hydraulic transients can occur in
a system and to model them using Bentley HAMMER.

2-52 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

Note: Transient Tip: If identifying, modeling, and protecting against

several possible hydraulic transient events seems to take a lot of
time and resources, remember that it is far safer and less
expensive to learn about your system's vulnerabilities by
"breaking pipes" in a computer model—and far easier to clean
up—than from expensive service interruptions and field repairs.

In this lesson, you will simulate the impact of a power failure lasting several minutes.
It is assumed that power was interrupted suddenly and without warning (i.e., you did
not have time to start any diesel generators or pumps, if any, prior to the power
failure). The purpose of this type of transient analysis is to ensure the system and its
components can withstand the resulting transient pressures and determine how long
you must wait for the transient energy to dissipate.

For many systems, starting backup pumps before the transient energy has decayed
sufficiently can cause worse surge pressures than those caused by the initial power
failure. Conversely, relying on rapid backup systems to prevent transient pressures
may not be realistic given that most transient events occur within seconds of the
power failure while isolating the electrical load, bringing the generator on-line, and re-
starting pumps (if they have not timed out) can take several minutes. (See Part 3—
Configuring the Bentley HAMMER Project.)

Part 3—Configuring the Bentley HAMMER Project

Before running the Bentley HAMMER model you have created in Part 1, you need to
set certain run-time parameters such as the fluid properties, piping system properties,
run duration, and output requirements.

1. Click the Analysis menu and select Calculation Options.

2. In the Calculation Options manager, double-click Base Calculation Options under
Transient Solver.
3. The Properties editor will now display the Calculation Options attributes for the
highlighted calculation options profile. Change the Report Points attribute value
to Selected Points.
4. Click the ellipsis button (...) in the Report Points Collection field.

Bentley HAMMER V8i Edition User’s Guide 2-53

Lesson 1: Pipeline Protection

5. In the Report Points Collection dialog, double-click P1 / J1, P2 / J1, PMP1S/

PMP1, and PMP1D/PMP1 in the Available Items list to add them to the Selected
Items list. Click OK.

This will output the transient history (or temporal variation of flow, head, and air
or vapor volumes) at the pump and nearby nodes (you can also add other points of
interest, such as P7 / Res2).
6. Change the Run Duration Type to Time.
7. Enter a Run Duration (Time) value of 140 seconds.
8. Change the Pressure Wave Speed to 1250 m/s.

Note: Transient Tip: Wave speed is a key parameter in transient

analysis. Assigning pressure wave speeds to individual pipes
will override the wave speed set as a global parameter in the
System tab. When the pipe's wave speed is blank (or 0.0), then
the global wave speed is used for that pipe.

9. Leave the Vapor Pressure value at the default value of -97.9 kPa.
10. Change the Generate Animation Data field to True.
11. Close the Calculation Options manager.
12. Report Paths are created through the Profile Manager. Click the View menu and
select Profiles.
13. In the Profiles manager, click the New button.
14. In the Profile Setup dialog click the Select From Drawing button.

2-54 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

15. You will be returned to the drawing view; click PMP1 and then Res2 - all the
intermediate points should be selected automatically. Then right-click and select
Done (or click the checkmark button in the Select toolbar).
16. In the Profile Setup dialog, click the Open Profile button.

17. In the Profile Series Options dialog that appears, click OK to accept the default
profile settings.

Bentley HAMMER V8i Edition User’s Guide 2-55

Lesson 1: Pipeline Protection

18. Check that the profile looks like the one below, then close the Profile.

19. In the Profiles manager, highlight the newly created profile Profile - 1 and click
the Rename button. Enter the name Main Path. The hammer symbol in the upper
right of the profile icon indicates that this profile is a Transient Report Path,
meaning that during a transient analysis results will be saved for this profile.
20. Close the Profiles manager.

21. Save the file with the same name (Lesson1.wtg) using File > Save. You are now
ready to run a transient analysis. (See Part 4—Performing a Transient Analysis.)

Part 4—Performing a Transient Analysis

In this section, you will first simulate transient pressures in the system due to an emer-
gency power failure without any protective equipment in service. After a careful
examination of your results, you will select protective equipment and simulate the
system again using Bentley HAMMER to assess the effectiveness of the devices you
selected to control transient pressures. See Analysis with Surge-Protection Equipment.

2-56 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

Analysis Without Surge Protection Equipment

To perform a hydraulic transient analysis of the system after a sudden power failure
without surge protection (other than the pump's check valve):

1. Double-click PMP1. In the Properties editor change the Pump Type (Transient)
value to Shut Down After Time Delay.
2. Set the other pump parameters:
a. Diameter (Pump Valve): Set the inside diameter of the pump's discharge
flange to 600 mm.
b. Time (Delay Until Shutdown): Set this to 5 seconds. For convenience, it is
assumed that the power failure occurs after 5 seconds, so that point histories
will show the initial steady state during this period.
c. Pump Valve Type: set to default (Check Valve). The power failure is assumed
to be instantaneous and the check valve is allowed to close without any delay
(zero) to protect the pump from damage.

3. Click the Pump Definition field and select Edit Pump Definitions.
4. In the Pump Definitions dialog, click the Efficiency tab. Change the Pump Effi-
ciency type to Constant Efficiency, and the Pump Efficiency value to 85 %.
5. Click the Transient tab. Set the following parameters:
a. Inertia (Pump and motor): This is the combined pump, shaft, and motor
inertia: set it to 17.2 kg - m2. This value can be obtained from the manufac-
turer or estimated from its power rating
b. Speed (Full): Set this to 1760 rpm.
c. Specific Speed: Select SI=25, US=1280.
d. Reverse Spin Allowed?: Uncheck this box. Not allowing reverse spin assumes
there is a check valve on the discharge side of the pump or that the pump has a
nonreverse ratchet mechanism.

Bentley HAMMER V8i Edition User’s Guide 2-57

Lesson 1: Pipeline Protection

6. Close the Pump Definitions dialog.

7. Click the Compute button to start the transient analysis..

2-58 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

8. When the run is completed, the Transient Calculation Summary opens automati-
cally, displaying calculation options used during the run, initial conditions, and
extreme pressure and head values.

9. Click the Close button in the Transient Calculation Summary.

10. Close the User Notifications window.

Reviewing your Results

By default, Bentley HAMMER does not generate output for every location or every
time step, since this would result in very large file sizes (tens or hundreds of mega-
bytes). For the specific report points or paths (e.g., profiles) you specified prior to the
run, you can generate several types of graphs or animations to visualize the results:

1. HGL Profile: Bentley HAMMER can plot the steady-state hydraulic grade line
(HGL) as well as the maximum and minimum transient head envelopes along the
Main path.
2. Time History: Bentley HAMMER can plot the time-dependent changes in tran-
sient flow, and head and display the volume of vapor or air at any point of interest.
3. Animations: You can animate to visualize how system variables change over time
after the power failure. Every path and history on the screen is synchronized and
animated simultaneously. Note how transient pressures stabilize after a while.

Bentley HAMMER V8i Edition User’s Guide 2-59

Lesson 1: Pipeline Protection

It is important to take the time to carefully review the results of each Bentley
HAMMER run to check for errors and, if none are found, learn something about the
dynamic nature of the water system.

Click the Analysis menu and open the Transient Results Viewer . If prompted
for the version of the viewer to use you can select either version.

Profile the Main Path and plot the various time history graphs. Depending on your

viewer version, animate the results by pressing the Play button.

• The graph for the Main path shows that a significant vapor cavity forms at the
local high point at the knee of the pipeline (i.e., the location where the steep pipe
section leaving the pumps turns about 90 degrees to the horizontal in the pump
station).
• Viewing the animation a few times shows that a vapor pocket grows at node J1 (as
the water column separates) and subsequently collapses due to return flow from
the receiving reservoir Res2. The resulting transient pressures are very sudden and
they propagate away from this impact zone, sending a shock wave throughout the
pipeline.
• The time history at the pump shows that the check valve closes before these pres-
sure waves reach the pump (zero flow), effectively isolating it from the system
and protecting it against damage.

Analysis with Surge-Protection Equipment

Certain protective equipment such as a hydropneumatic tank (also known as a gas
vessel or air chamber), combination air valve or CAV (also known as a vacuum-
breaker and air-release valve), or a one-way surge tank can be installed at local high
points to control hydraulic transients.

2-60 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

Note: Adding surge-control equipment or modifying the operating

procedures may significantly change the dynamic behavior of
the water system, possibly even its characteristic time. Selecting
appropriate protection equipment requires a good
understanding of its effect, for which Bentley HAMMER is a great
tool, as well as the good judgment and experience you supply.

It is clear that high pressures are caused by the sudden collapse of a vapor pocket at
node J1. You could install a Hydropneumatic Tank at junction J1 to supply flow into
the pipeline upon the power failure, keeping the upstream water column moving and
minimizing the size of the vapor pocket at the high point (or even preventing it from
forming). You can test this theory by simulating the system again using Bentley
HAMMER and comparing the results with those of the unprotected run:

1. Click the Hydropneumatic Tank button on the Layout toolbar.

2. Click on J1. A prompt will appear, asking if you'd like to morph J1 into a Hydrop-
neumatic Tank element. Click Yes.
3. Set the Hydropneumatic Tank element properties in the Properties editor:
a. Make sure the Elevation (Base) and the Elevation are set to 408.000 m.
b. Set the Operating Range Type to Elevation.
c. Set the HGL (Initial) to 465 m.
d. Set the Liquid Volume (Initial) to 14200 L.
e. Set the Minor Loss Coefficient (Outflow) to 1.0.
f. Set the Tank Calculation Model to Gas Law Model.
g. Set the Volume (Tank) to 20000 L.
h. Set the Treat as Junction? field to True. This means that the hydropneumatic
tank is not included in the calculations of initial conditions. Instead the HGL
in the hydropneumatic tank is assumed to be the same as if there was a junc-
tion at the tank location.
i. Set the Diameter (Tank Inlet Orifice) to 450 mm.
j. Set the Ratio of Losses to 2.5.
k. Set the Gas Law Exponent to 1.2.
l. Set the Has Bladder? field to True.
m. Set the Pressure (Gas-Preset) to 0.0.

4. Now we must update our report points and report path to reflect the replacement
of J1 with HT-1. Click Analysis > Calculation Options and double-click the Base
Calculation Options under the Transient Solver.
5. Click the ellipsis button in the Report Points Collection field.

Bentley HAMMER V8i Edition User’s Guide 2-61

Lesson 1: Pipeline Protection

6. Add P1 / HT-1 and P2 / HT-1 to the Selected Items list. Click OK.
7. Click View > Profiles and Edit the Main Path Profile. Click Yes when prompted to
auto-repair the profile. The profile will open and will now include the hydropneu-
matic tank. Close the Profile and the Profiles manager.
8. Select File > Save As and save the file with a new name: Lesson1_Protection.wtg.

Note: Rather than editing the original model and saving it as a new file,
a better way is to create a new scenario in the original model for
the transient protection simulation. We will investigate
scenarios in Lesson 2.

9. Click the Compute Initial Conditions button. Close the Calculation Summary and
the User Notifications dialog.
10. Click the Compute button. Close the Transient Calculation Summary and the User
Notifications dialog.
11. Click the Analysis menu and select Transient Results Viewer.
12. Click the Profile button on the Profiles tab.
As you can see, installing a Hydropneumatic Tank at node J1 has significantly reduced
transient pressures in the entire pipeline system. Due to this protection equipment, no
significant vapor pocket forms at the local high point. However, it is possible that a
smaller tank could provide similar protection.

It is also possible that other protection equipment could control transient heads and
perhaps be more cost-effective as well. Before undertaking additional Bentley
HAMMER simulations, it is worthwhile to compare and contrast the results with or
without the Hydropneumatic Tank.

See Part 5—Animating Transient Results at Points and along Profiles.

Part 5—Animating Transient Results at Points and along Profiles

Bentley HAMMER provides many ways to visualize the simulated results using a
variety of graphs and animation layouts. You must specify which points and paths
(profiles) are of interest, as well as the frequency to output prior to a run, or Bentley
HAMMER will not generate this output to avoid creating excessively large output
files. For small systems, you can specify each point and every time step, but this is not
advisable for large water networks.

For the same reason, Bentley HAMMER only generates the Animation Data (for on-
screen animations) if you select this option in the transient calculation options.

2-62 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

Note: To achieve shorter run times and conserve disk space, try to
avoid generating voluminous output, such as Animation Data or
Output Databases, at an early stage of your hydraulic transient
analysis. Fast turnaround makes your evaluation of different
alternatives more interactive and challenges you to apply good
judgement as you compare your mental model of the system
with Bentley HAMMER's results—a good habit which is like
estimating an answer in your head when using a calculator.

While you are still evaluating many different types or sizes of surge-protection equip-
ment, you can often compare their effectiveness just by plotting the maximum tran-
sient head envelopes for most of your Bentley HAMMER runs. At any time, or once
you feel you are close to a definitive surge-control solution, you can use Bentley
HAMMER to generate the animation data files by setting Generate Animation Data to
True in the Transient Calculation Options. After the run, you can open the Transient
Results Viewer from the Analysis menu.

Note: Once you have generated the animation data files, you will be
able to display animations without running the HAMMER V8i
simulation again. This saves a lot of time when comparing the
results of several surge-control alternatives.

1. In the Transient Results Viewer, on the Profiles tab, select:

– Profile: Main
– Graph Type: Hydraulic Grade and Air/Vapor Volume

2. Click the Animate button. This loads the animation data and Animation Control.
3. On the Animation Controller, click the play button to start the animation.

Part 6—Viewing Time History Graphs in Bentley HAMMER

Using the Bentley HAMMER Transient Results Viewer, you can plot a transient
history at any point in the system to display the temporal variation of selected parame-
ters (such as pressures and flow).

1. Click the Analysis menu and select Transient Results Viewer.

2. In the Time Histories tab, select:
– Time History: P1:HT-1
– Graph Type: Hydraulic Grade, Flow, and Air/Vapor Volume

Bentley HAMMER V8i Edition User’s Guide 2-63

Lesson 1: Pipeline Protection

3. Click Plot to display this transient history.

2-64 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

4. To view numerical data for the time history, click the Data tab. From here, you can
sort the data by right-clicking on the column header and choosing Sort. You can
also change the units and precision for the results by right-clicking on the column
header and choosing Units and Formatting.

Click OK to save these settings and leave the FlexUnits Manager. From now on, Head
will be displayed in ft. and Flow will be displayed in l/s.

Bentley HAMMER V8i Edition User’s Guide 2-65

Lesson 2: Network Risk Reduction

Lesson 2: Network Risk Reduction

In Lesson 1, you learned how to create and run a simple pipeline model and explored
its different characteristics using Bentley HAMMER. In this lesson, you will import a
simple water-distribution network connected to the same pipeline introduced in
Lesson 1. You will then perform a more advanced hydraulic transient analysis, again
in three steps:

1. Import the steady-state WaterCAD model into Bentley HAMMER and verify it.
2. Select a transient event to analyze and run the Bentley HAMMER model.
3. Annotate and color-code the resulting map, profiles, and time histories using
Bentley HAMMER's powerful, built-in visualization capabilities.

Part 1—Importing and Verifying the Initial Steady-States

Follow these steps to open the Bentley HAMMER model:

1. Click File > Open. Browse to the C:\Program Files

(x86)\Bentley\HAMMER8\Lessons folder and open the file
Lesson2_WaterGEMS.wtg. HAMMER uses the same file format as WaterCAD
and WaterGEMS, so it is possible to open a WaterCAD or WaterGEMS file
directly in HAMMER.
2. Click the Compute Initial Conditions button. Close the User Notifications
window.

Inspecting the steady-state model results using Bentley HAMMER reveals that
the water transmission main now carries only 210 L/s of water from the pumping
station to reservoir Res2 at elevation 456 m. A local main takes water from the
transmission main at a tee located about 400 m from the pumping station, distrib-
uting 265 L/s to a nearby subdivision. The part of the subdivision close to the

2-66 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

pumping station has lower ground (and therefore water main) elevations, while
the far end has higher ground elevations. Your goal is to identify transient issues
for this system and recommend surge protection alternatives.
3. Prior to running the transient analysis of this system, you need to select some
profiles and points of interest.
4. Click Analysis > Calculation Options. Double-click on Base Calculation Options
under Transient Solver. Click the ellipsis button in the Report Points Collection
field. Add nodes PMP1D:PMP1, P1:J1, P2:J1, P2:J2, P8:J2, P27:J19, P28:J19,
P47:J34, and P50:J37 to the Selected Items list (you learned how to do this in
Lesson 1).

Click OK.

Note: Bentley HAMMER plots time histories at a pipe's end points,

defined as the point on a pipe closest to a node and labeled
Pipe_End_Point:Node. To obtain a complete picture of what is
occurring at any given node, you must inspect every end point
connected to that node (e.g., in this example, plot histories at
end points P1:J1 and P2:J1 for node J1).

5. Change the Run Duration value to 160 seconds.

6. Set the Specify Initial Conditions field to False. This means that the initial condi-
tions for the transient simulation (flows, head, etc.) will be computed by the soft-
ware, not entered manually by the user. Close the Calculation Options window.
7. Click the View menu and select Profiles.
8. Create three new profiles as follows:

Bentley HAMMER V8i Edition User’s Guide 2-67

Lesson 2: Network Risk Reduction

– Create a profile named Path1 and add pipes PMP1D, P1, P2, P3, P4, P5, P6,
and P7 to it.
– Create a profile named Path2 and add pipes PMP1D, P1, P2, P8, VLV1U,
VLV1D, P9, P10, P14, P48, P49, and P50 to it.
– Create a profile named Path3 and add pipes PMP1D, P1, P2, P8, VLV1U,
VLV1D, P9, P15, P22, P24, P28, P30, P46, and P47 to it.

9. Close the Profiles manager.

10. Click the Compute Initial Conditions button. Close the Calculation Summary.

Note: You can set HAMMER to always compute the initial conditions
prior to computing a transient simulation. To do this click the
Analysis menu and then click Always Compute Initial
Conditions.

11. Click the Compute button. Close the Transient Calculation Summary.

2-68 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

12. Click the Analysis menu and select Transient Results Viewer. To view a plot of
the maximum and minimum head envelopes along Path1, Path2, and Path 3,
choose the profile from the pulldown and select Profile. The envelopes along
Path1 should look like the following figure.

13. To generate a plot of the hydraulic transient history at the pumping station, select
the Time History tab in the Transient Results Viewer. To see hydraulic grade and
flow results, choose Time History: PMP1D:PMP1 and Graph Type: Hydraulic
Grade, Flow and Air/Vapor Volume. There should be no significant change in the
steady-state conditions with time.

Results from the Bentley HAMMER run you have just completed do not show any
change in the steady-state heads and flows throughout the water network as time
passes. This indicates the calculated initial conditions can be considered as valid. You
are now ready to proceed with the hydraulic transient analysis for this network.

If the solution tolerance of a steady-state model is too coarse, Bentley HAMMER's

highly accurate model engine may report transients at time zero in the Transient Anal-
ysis Output Log file (found under Report > Transient Analysis Reports). This can
usually be handled by running the steady-state model again with a smaller error toler-
ance (set under Analysis > Calculation Options > Steady State / EPS Solver > Base
Calculation Options > Accuracy).

Bentley HAMMER V8i Edition User’s Guide 2-69

Lesson 2: Network Risk Reduction

Part 2—Selecting the Key Transient Events to Model

In Lesson 1, you simulated the transient pressures resulting from a sudden power
failure. In this lesson you will learn how to simulate transient pressures in a water
distribution network triggered by an emergency pump shutdown and restart. Although
a power failure often results in the worst-case conditions, restarting before friction has
dissipated the transient energy can cause higher extreme pressures than the initial
power failure.

Part 3—Performing a Transient Analysis

In order to generate transient events for a rapid but controlled emergency pump shut-
down and restart, you need to set appropriate pump characteristics to control the speed
at which this pump can shut down and restart. One of the ways to do this is to use a
variable-frequency drive (VFD), also known as a variable-speed pump.

Analysis without Surge Protection

1. Double-click PMP1. In the Properties Editor, under Transient (Operational) prop-
erties, change the Pump Type (Transient) value to Variable Speed/Torque.
2. You can use either Speed or Torque to control the VFD pump ramp times. In this
lesson, you will learn how to control the pump using Speed (i.e., Control Variable
set to Speed).
3. Under Transient (Operational) properties, click the Operating Rule drop-down list
and select <Edit...>. The Patterns manager opens.
4. Highlight the Operational (Transient, Pump) folder and click the New button. In
the Pattern tab on the right side of the dialog, click the New button to add a new
row to the pattern table. Enter a value of 1 for Multiplier at 5.0 seconds Time from
Start. Fill in the rest of the table as indicated. This pattern will slow the pump
linearly from full speed at 5 seconds into the simulation to zero speed at 10

2-70 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

seconds into the simulation. Then at 25 seconds into the simulation the pump will
start to speed up linearly from zero to reach full speed at 30 seconds. Close to
leave the Patterns manager.

5. In the Pump Properties, under Transient (Operational), click the Operating Rule
drop-down list and select Operational (Transient, Pump) - Pattern 1.
6. Click Analysis > Calculation Options. Double-click Base Calculation Options
under Transient Solver. Change the Generate Animation Data field value to True.
You will need the animation data later to animate the results on screen. Close the
Calculation Options manager.
7. Click the Compute button. Close the Transient Calculation Summary and User
Notifications windows.
8. Click the Analysis menu and select Transient Results Viewer.
9. Plot the Time History for Hydraulic Grade, Flow, and Air/Vapor Volume at end
point PMP1D:PMP1 (i.e., the discharge side of the pump). It should look like the
following figure and have these characteristics:

Bentley HAMMER V8i Edition User’s Guide 2-71

Lesson 2: Network Risk Reduction

– After the emergency pump shutdown, pressure and flow drop rapidly,
followed by a large upsurge pressure (at about 15 s) after flow returning to the
pumping station collapses the vapor pockets at the high points. The check
valve on the discharge side of the pump keeps the flow at zero during the
initial and subsequent pressure oscillations (until the pump restarts).
– The maximum transient head resulting from the pump restart does not exceed
the maximum head reached about ten seconds after the initial power failure.
This is because flow supplied by the pump prevents vapor pockets from
reforming and collapsing again.
– The system approaches a new steady state after 50 seconds and it has essen-
tially stabilized to a new steady state by 90 seconds.
– As expected, the final steady state is similar to the initial steady state.

2-72 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

10. Plot the Hydaulic Grade and Air/Vapor Volume to see the maximum and
minimum transient head envelopes along Path1, Path2, and Path3. The Path3
envelopes should look like the following figure:

In these figures,
– Subatmospheric transient pressures occur in almost half of the pipeline. Full
vacuum pressure (–10 m) occurs at the knee of the pipeline (near the pump
station) and at the local high point in the distribution network.
– Maximum transient pressure heads are of the order of 100% above steady-
state pressures along the majority of Path3. This is likely very significant
compared to the pipes' surge-tolerance limit, especially if the network
contains older pipes. It would be useful to show the pipe's working pressure
and surge-tolerance limit on the paths to assess whether it can withstand these
high pressures.

11. Experiment to learn the sensitivity of this system to an automatic, emergency

shutdown and restart:
– Set different shutdown and restart ramp times for the pump. For example, try
10 s ramp times for the pump. How fast does the flow decrease to zero? Why?
– Select different time delays between the pump shutdown and restart. What
happens if you try to restart the pump when pressure is rising, or at its lowest,
or highest point?

Bentley HAMMER V8i Edition User’s Guide 2-73

Lesson 2: Network Risk Reduction

12. Identify the fastest ramp times and shortest time delay which do not result in unac-
ceptable transient pressures anywhere in the system. Since the maximum transient
envelopes depend on these two variables, several valid solutions are possible. You
can document your solution in the operations manuals for the pumping station and
verify its accuracy upon commissioning.

Note: The volume of vapor or air reported at a node is the sum of the
volumes at every end point of all connected nodes. Since a pipe
may have volumes elsewhere than at its end point, node and
pipe volumes may not match. If more than two pipes connect to
a node, the volume reported on a path (or profile) plot may not
match the volume reported for that node's history, or in the
Drawing Pane, because a path can only include two of the pipes
connecting to that node.

13. The results indicate that significant pressures occur in the system. After viewing
the animations, it becomes even more clear that:

– High pressures result from the collapse of significant vapor pockets at local
high points. Inspection of the transient histories at end-points P2:J1 and
P27:J19 confirms that vapor pockets collapse at around these times.
– The pump restarts at 25 s or 20 s after the start of the emergency pump shut-
down, just as the high-pressure pulse from the collapse of a vapor pocket at
node J1 is reaching the pump station. This pulse closes the check valve
against the pump for a while, until it reaches its full speed and power at
around 30 s.
– Transient pressure waves travel throughout the system, reflecting at reser-
voirs, dead-ends, and tanks. This results in complex but essentially periodic
disturbances to the pump as it attempts to re-establish a steady state.
– As expected, the final steady-state head and flow are similar to the initial
steady state.

Analysis with Surge-Protection Equipment

You can select from an array of protective equipment to control high and low transient
pressures in the pipeline (Path1) and distribution network (Path2 and Path3). Using
Bentley HAMMER, you can assess the efficiency of alternative protection equipment,
noting how protection for the pipeline affects conditions in the network and vice
versa. In this example you will try to protect this entire system with two surge-control
devices:

• A Hydropneumatic Tank at node J1 similar to the protection used in Lesson 1.

• A simple flow-through surge tank or standpipe at the node J19. A combination air
valve could also be considered for this location if freezing or land-acquisition
costs are a concern.

2-74 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

The model has already been set up to use the new protection equipment using the
Active Topology Alternative. In the drawing, you'll notice grey pipes and nodes adja-
cent to the J1 and J19 areas.

Active Topology is a way to model multiple network layouts in the same model. You
can mark elements as Inactive for certain scenarios, but Active in others.

Bentley HAMMER V8i Edition User’s Guide 2-75

Lesson 2: Network Risk Reduction

We will create a new Active Topology Alternative in which the new Hydropneumatic
Tank and Surge Tank (and their adjoining pipes) are Active and the elements they are
replacing (J1 and J19 and their adjoining pipes) are Inactive.

1. Click the Analysis menu and select Alternatives.

2. In the Alternatives manager, expand the Active Topology node, right-click the
Base Active Topology alternative and select New > Child Alternative. Rename the
new alternative With Protection.

3. Close the Alternatives manager. Click the Analysis menu and select Scenarios.
Click the New button and select Child Scenario. Name the new scenario With
Protection.

2-76 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

4. Double-click the new scenario to open the Properties editor and change the Active
Topology Alternative to With Protection. In the Scenarios manager, make sure the
With Protection scenario is highlighted, and then click the Make Current button.
With the new scenario active, any edits made to the active topology will only
affect the new With Protection scenario (and by extension the With protection
Active Topology alternative).
5. Click the Tools menu and select Active Topology Selection. The Active Topology
Selection toolbar appears.

6. The Add button makes elements Inactive.

7. The Remove button makes elements Active.
8. With the Add button toggled on, click on the following elements to make them
Inactive in the drawing pane: J1 and J19.
9. Click the Remove button and click on the following elements to make them
Active in the drawing pane: P1-1, HT-1, P2-1, ST-1, P25-1, P24-1, P26-1, P27-1,
and P28-1.

Bentley HAMMER V8i Edition User’s Guide 2-77

Lesson 2: Network Risk Reduction

10. The network should now look like this:

11. Click the Done button in the Active Topology Selection toolbar.
12. Since we are using different elements we need to update our report points and
report paths (profiles).
a. In the Transient Solver Base Calculation Options, under the Report Points
Collection, add P1-1:HT-1 and P2-1:HT-1. P1:J1 and P2:J1 are now inactive
so there will be no results to show for those node, however you can leave
them on the list in case you recomputed the Base scenario again.
b. The existing profiles now contain inactive elements, so no results will be
shown for them under the With Protection scenario. Therefore create three
new profiles as follows:
- Create a profile named Path 1- Protection and add pipes PMP1D, P1-1,
P2-1, P3, P4, P5, P6, and P7 to it.

2-78 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

- Create a profile named Path 2 - Protection and add pipes PMP1D, P1-1,
P2-1, P8, VLV1U, VLV1D, P9, P10, P14, P48, P49, and P50 to it.
- Create a profile named Path 3 - Protection and add pipes PMP1D, P1-1,
P2-1, P8, VLV1U, VLV1D, P9, P15, P22, P24-1, P28-1, P30, P46, and
P47 to it.

c. Close the Profiles manager.

13. Click the Compute Initial Conditions button. Close the Calculation Summary.
14. Click the Compute button. Close the Transient Calculation Summary and User
Notifications windows.
15. Once the run completes click the Analysis menu and select Transient Results
Viewer. Use the Profile button to generate graphs of the transient head envelopes
for Path 1 - Protection, Path 2 - Protection, and Path 3 - Protection. The envelope
along Path 3 - Protection should look like the following figure:

– No subatmospheric pressures occur anywhere in the distribution network

(along Path 3 - Protection).
– High transient pressures are comparable to the steady-state pressures for the
downstream half of Path 3 - Protection. Keeping transient water pressures
within a narrow band reduces complaints and it could be important for certain
industries.

Bentley HAMMER V8i Edition User’s Guide 2-79

Lesson 2: Network Risk Reduction

16. Compare the transient head envelopes and transient histories for Bentley
HAMMER runs with different parameters, without and with protection:
– You may be able to reduce the size (and cost) of the Hydropneumatic Tank
and Surge Tank by changing their parameters until surge pressures are unac-
ceptable (for example, try a Hydropneumatic Tank with a volume of 5000 L).
– Instead of the Hydropneumatic Tank and Surge Tank, you can also try
installing a two-way or "combination" Air Valve at nodes J1 and J19.

17. Before recommending a surge-protection strategy for this system, you need to
perform a transient analysis of an emergency power failure and other possible
transient events.

Part 4—Color-Coding Maps, Profiles, and Point Histories

In the design of a surge-control strategy for a water distribution network, the extreme
states are usually of the greatest interest. Bentley HAMMER has built-in capabilities
to visualize maximum and minimum simulated flows, heads, pressures, and volumes
(vapor or air) throughout the pipe system. You can color-code nodes and pipes
according to these different parameters.

In this part of the lesson, you will learn how to use Bentley HAMMER's color-coding
features to make your presentation more intuitive and compelling to your audiences.

1. In Bentley HAMMER, click File > Open and open the file
Lesson2_WaterGEMS_Finished.wtg.
2. Click the Compute Initial Conditions button. Close the Calculation Summary.
3. Click the Compute button. Close the Transient Calculation Summary and User
Notifications windows.
4. Click the Analysis menu and select Transient Thematic Viewer. By default,
Bentley HAMMER uses Maximum Head results for both the pipes and nodes for
color-coding.
5. On the Pipes tab click the Calculate Range button and select Full Range. This
automatically populates the Minimum and Maximum values for the currently
selected Field Name.
6. In the right side of the window click the Initialize button. Initialize automatically
breaks the range between the maximum and minimum values into the number of
specified steps and assigns a color to each.
7. Click the Ramp button. Ramp chooses colors to make a gradient between the first
and last colors used. Click the third color box and select yellow. Click the 4th
color box and select orange.

2-80 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

8. Click the Use Gradient checkbox in the lower left. When this option is selected,
HAMMER will color code segments within pipes individually, rather than using a
single color for each pipe. Your Pipe tab should now look like this.

Bentley HAMMER V8i Edition User’s Guide 2-81

Lesson 2: Network Risk Reduction

9. Click the Apply button and minimize the Transient Thematic Viewer. Your
network should now look like this:

10. In the Transient Thematic Viewer click the Nodes tab. Change the Field Name to
Pressure (Maximum Transient).
Click OK.
11. Click the Calculate Range button and select Full Range.

2-82 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

12. Click the Initialize button. Click the color box in the first row and select a light
blue color. Click the color box in the last row and select a dark blue. Click the
Ramp button. The dialog should now look like this:

Bentley HAMMER V8i Edition User’s Guide 2-83

Lesson 2: Network Risk Reduction

13. Click the Apply button. You can minimize the Transient Thematic Viewer, but
don't close it; it must remain open for as long as you want the network elements to
be color coded. Your model should now look like this:

14. Try different variables at pipes and nodes to try to make your presentation more
descriptive. For example, you could try the following:

– You can change the values that are used in each range. Making the first two
steps encompass a larger portion of the value range will cause more of the
pipes to be colored green, indicating normal to high heads in this system.
– For pipes, set the percentage corresponding to the dark blue color so that
subatmospheric pressures are displayed in this color, alerting you to potential
pathogen intrusion and heavy pipe or joint pressure cycling.
– For nodes, experiment with the percentages corresponding to yellow and
orange until they correspond to the pipe's working pressure or surge-tolerance
limit.

Color-coding a map for selected variables provides an overview of extreme conditions

in the entire system. This map can be compared with profiles and histories (or their
corresponding animations).

2-84 Bentley HAMMER V8i Edition User’s Guide

 Quick Start Lessons

Some parts in the subdivision also experience high pressures. For example, the color-
coded map and the Results section of the Element Editor indicate that the point with
the highest elevation in the subdivision, node J34, experiences the lowest minimum
transient pressure, while the lowest point in the network, node J37, experiences the
largest maximum transient pressure.

Bentley HAMMER V8i Edition User’s Guide 2-85

Lesson 2: Network Risk Reduction

2-86 Bentley HAMMER V8i Edition User’s Guide

 Understanding the
Workspace 3
Stand-Alone

MicroStation Environment

Working in AutoCADWorking in ArcGIS

Google Earth Export

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 Bentley HAMMER V8i
interface. The Bentley HAMMER 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

Zooming

Drawing Style

Panning
You can change the position of your model in the drawing pane by using the Pan tool.

Bentley HAMMER V8i Edition User’s Guide 3-87

Stand-Alone

To use the Pan tool

1. Click the Pan button on the Zoom toolbar.

The mouse cursor changes to the Pan icon.
2. 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

Zooming
You can enlarge or reduce your model in the drawing pane using one of the following
zoom tools:

The current zoom level is displayed in the lower right hand corner of the interface,
next to the coordinate display.

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 Zoom Extents on the Zoom toolbar. The entire model is
displayed in the drawing pane.

or

Select View > Zoom > Zoom Extents.

3-88 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

Zoom Window

The Zoom Window command is used to zoom in on an area of your model defined by
a window that you draw in the drawing pane.

To use Zoom Window, click the Zoom Window button on the Zoom toolbar, 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.

or

Select View > Zoom > Zoom Window, then draw the zoom window in the drawing
pane.

Zoom In and Out

The Zoom In and Zoom Out commands allow you to increase or decrease, respec-
tively, the zoom level of the current view by one step per mouse click.

To use Zoom In or Zoom Out, click either one on the Zoom 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 Realtime

The Zoom Realtime command is used to 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 Center

Bentley HAMMER V8i Edition User’s Guide 3-89

Stand-Alone

The Zoom Center command is used to enter drawing coordinates that will be centered
in the drawing pane.

1. Choose View > Zoom > Zoom Center or click the Zoom Center icon on the Zoom
toolbar.. The Zoom Center dialog box opens.

2. The Zoom Center dialog box contains the following:

X Defines the X coordinate of the point at which the

drawing view will be centered.

Y Defines the Y coordinate of the point at which the

drawing view will be centered.

Zoom Defines the zoom level that will be applied

when the zoom center command is initiated.
Available zoom levels are listed in percentages
of 25, 50, 75, 100, 125, 150, 200 and 400.

3. Enter the X and Y coordinates.

4. Select the percentage of zoom from the Zoom drop-down menu.
5. Click OK.
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 and Zoom Next

3-90 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

Zoom Previous returns the zoom level to the most recent previous setting. To use
Zoom Previous, click View > Zoom > Zoom Previous or click the Zoom Previous icon
from the Zoom toolbar.

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 or click the Zoom Next icon from the Zoom toolbar.

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, deco-
rations, 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.

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:

Bentley HAMMER V8i Edition User’s Guide 3-91

Stand-Alone

Enabled Set to true to enable and set to false to disable

Zoom Dependent Visibility.

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.

3-92 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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.

Under GIS style, the size of element symbols in the drawing pane will remain the
same (relative to the screen) regardless of zoom level. Under CAD style, element
symbols will appear larger or smaller (relative to the drawing) depending on zoom
level.

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.

Bentley HAMMER V8i Edition User’s Guide 3-93

Stand-Alone

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 Navi-
gation 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 explana-
tion.

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 Extents—Display the entire drawing in the Aerial View window.

Zoom In—Decrease the area displayed in the Aerial View window.

Zoom Out—Increase the area displayed in the Aerial View window.

Help—Opens the online help.

3-94 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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 in order to 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. The
Background Layers manager is only available in the Stand-Alone version of Bentley
HAMMER. The MicroStation, ArcGIS, and AutoCAD versions each provide varying
degrees of native support for inserting raster and vector files.

You can add multiple pictures to your project for use as background layers, and turn
them off and on. Additionally, you can create groups of pictures in folders, so you can
hide or show an entire folder or group of pictures at once.

When adding a background layer, it is possible to cause an "out of memory" error if

the file is too large. This depends on the size of the background file and the computer.
If this type of error occurs, the best solution is to reduce the size of the background file
using GIS or CAD tools (e.g. Bentley's Raster manager). It is usually possible to trim
or reduce the resolution of the backround without affecting its usefulness. In some
instances, it may be possible to run Bentley HAMMER V8iin a CAD or GIS platform
which is better able to handle these very large background files.

To add or delete background layers, open the Background Layers manager choose
View > Background Layers.

Bentley HAMMER V8i Edition User’s Guide 3-95

Stand-Alone

You can use shapefiles, AutoCAD DXF files, and raster (also called bitmap) pictures
as background images for your model. The following raster image formats are
supported: bmp, jpg, jpeg, jpe, jfif, gif, tif, tiff, png, and sid.

Note: MrSID background files are not supported in x64 version.

Using the Background Layer manager you can add, edit, delete, and manage the back-
ground layers that are associated with the project. The dialog box contains a list pane
that displays each of the layers currently contained within the project, along with a
number of button controls.

When a background layer is added, it opens in the Background Layers list pane, along
with an associated check box that is used to control that layer’s visibility. Selecting the
check box next to a layer causes that layer to become visible in the main drawing
pane; clearing it causes it to become invisible. If the layers in the list pane are
contained within one or more folders, clearing the check box next to a folder causes all
of the layers within that folder to become invisible.

Note: When multiple background layers are overlaid, priority is given

to the first one on the list.

You can copy/paste background layers and folders by right-clicking them and
selecting Copy/Paste. When a folder is copied in this way all of the contents of that
folder are also copied.

3-96 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

The toolbar consists of the following buttons:

New Opens a menu containing the following

commands:
• New File—Opens a Select Background
dialog box where you can choose the
file to use as a background layer.
• New Folder—Creates a folder in the
Background Layers list pane.

Delete Removes the currently selected background

layer.

Rename Rrenames the currently selected layer.

Edit Opens a Properties dialog box that

corresponds with the selected background
layer.

Shift Up Moves the currently highlighted object up in

the list pane.

Bentley HAMMER V8i Edition User’s Guide 3-97

Stand-Alone

Shift Moves the currently highlighted object

Down down in the list pane.

Expand Expands all of the branches in the hierarchy

All displayed in the list pane.

Collapse Collapses all of the branches in the

All hierarchy displayed in the list pane.

Help Displays online help for the Background

Layer Manager.

To add a background layer folder

You can create folders in Background Layers to organize your background layers and
create a group of background layers that can be turned off together. You can also
create folders within folders. When you start a new project, an empty folder is
displayed in the Background Layers manager called Background Layers. New back-
ground layer files and folders are added to the Background Layers folder by default.

1. Choose View > Background Layers to open the Background Layers manager.
2. In the Background Layers manager, click the New button, then click New Folder
from the shortcut menu.
Or select the default Background Layers folder, then right-click and select New >
Folder from the shortcut menu.
– If you are creating a new folder within an existing folder, select the folder,
then click New > New Folder. Or right-click, then select New > Folder from
the shortcut menu.
3. Right-click the new folder and select Rename from the shortcut menu.
4. Type the name of the folder, then press <Enter>.

3-98 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

To delete a background layer folder

1. Click View > Background Layers to open the Background Layers manager.
2. In the Background Layers managers, select the folder you want to delete, then
click the Delete button.
– You can also right-click a folder to delete, then select Delete from the shortcut
menu.

To rename a background layer folder

1. Click View > Background Layers to open the Background Layers manager.
2. In the Background Layers managers, select the folder you want to rename, then
click the Rename button.
– You can also right-click a folder to rename, then select Rename from the
shortcut menu.
3. Type the new name of the folder, then press <Enter>.
– You can also rename a background layer folder by selecting the folder, then
modifying its label in the Properties Editor.

To add a background layer

In order to add background layers to projects use the Background Layers manager.
When you start a new project, an empty folder in the Background Layers manager
called Background Layers is displayed. New background layer files and folders are
added to the Background Layers folder by default.

1. Click View > Background Layers to open the Background Layers manager.
2. In the Background Layers managers, click the New button, then click New File
from the shortcut menu.
Or right-click on the default Background Layers folder and select New > File
from the shortcut menu.
– To add a new background layer file to an existing folder in the Background
Layer manager, select the folder, then click New > New File. Or right-click,
then select New > File from the shortcut menu.
3. Navigate to the file you want to add as a background layer and select it.
– If you select a .dxf file, the DXF Properties dialog box opens.

Bentley HAMMER V8i Edition User’s Guide 3-99

Stand-Alone

– If you select a .shp the ShapeFile Properties dialog box opens.

– If you select a .bmp, .jpg, .jpeg, .jpe, .jfif, .gif, .tif, .tiff, .png, or .sid file, the
Image Properties dialog box opens.

4. After you add the background layer, you might have to use the Pan button to move
the layer within the drawing area; Zoom Extents does not center a background
image.

To copy a background layer

1. Right click on the background layer you wish to copy.

2. Right click on the folder you want the background layer copied to and click Paste.

You can also copy an entire folder; the contents of the folder will also be copied.

To delete a background layer

• Select the background layer you want to delete, then click the Delete button.
• Or, right-click the background layer, then select Delete from the shortcut
menu.
To edit the properties of a background layer

You can edit a background layer in two ways: you can edit its properties or its position
in a list of background layers displayed in the Background Layers manager.

1. Select the background layer you want to edit.

2. Click the Edit button. A Properties dialog box opens.
– You can also right-click the background layer, then select Edit from the
shortcut menu.

To change the position of a background layer in the list of background layers

The order of a background layer determines its Z level and what displays if you use
more than one background layer. Background layers at the top of the list display on
top of the other background layers in the drawing pane; so, background layers that are
lower than the top one in the list might be hidden or partially hidden by layers above
them in the list.

Select the background layer whose position you want to change in the list of Back-
ground Layers manager, then click the Shift Up or Shift Down buttons to move the
selected background layer up or down in the list.

To rename a background layer

3-100 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

Select the background layer you want to rename, then click the Rename button.

Or, right-click the background layer that you want to rename, then select Rename
from the shortcut menu.

Bentley HAMMER V8i Edition User’s Guide 3-101

Stand-Alone

Turn background layers on or off

Turn your background layers on or off by using the check box next to the background
layer file or folder than contains it in the Background Layers manager.

Image Properties
This dialog box opens when you are adding or editing a background-layer image other
than a .dxf or .shp.

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.

3-102 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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.

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
computer’s video card. Not all
video cards support this
feature. If you check this option
but your computer’s 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 posi-
tion 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 rela-
tive 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 Bentley HAMMER V8i drawing.

Bentley HAMMER V8i Edition User’s Guide 3-103

Stand-Alone

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.

Use the following controls to define the properties of the background layer:

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.

Label Identifies the background layer.

Unit Select the unit of measurement associated with the

spatial data from the menu.

Transparency Specify the transparency level of the background

layer, where 0 has the least and 100 has the most
transparency.

Line Color Sets the color of the layer elements. Click the
Ellipsis (...) button to open a Color palette
containing more color choices.

Line Width Sets the thickness of the outline of the layer

elements.

Fill Color Select the fill color.

Fill Figure Check to fill.

3-104 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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.

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.

Bentley HAMMER V8i Edition User’s Guide 3-105

MicroStation Environment

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

MicroStation Environment
In the MicroStation environment you can create and model your network directly
within your primary drafting environment. This gives you access to all of MicroSta-
tion’s powerful drafting and presentation tools, while still enabling you to perform
Bentley HAMMER V8i modeling tasks like editing, solving, and data management.
This relationship between Bentley HAMMER V8i and MicroStation enables
extremely detailed and accurate mapping of model features, and provides the full
array of output and presentation features available in MicroStation. This facility
provides the most flexibility and the highest degree of compatibility with other CAD-
based applications and drawing data maintained at your organization.

Bentley HAMMER V8i features support for MicroStation integration. You run
Bentley HAMMER V8i in both MicroStation and stand-alone environment.

The MicroStation functionality has been implemented in a way that is the same as the
Bentley HAMMER V8i base product. Once you become familiar with the stand-alone
environment, you will not have any difficulty using the product in the MicroStation
environment.

In the MicroStation environment, you will have access to the full range of function-
ality available in the MicroStation design and drafting environment. The standard
environment is extended and enhanced by using MicroStation’s MDL (MicroStation
Development Language) client layer that lets you create, view, and edit the native
Bentley HAMMER V8i network model while in MicroStation.

MDL is a complete development environment that lets applications take full advan-
tage of the power of MicroStation and MicroStation-based vertical applications. MDL
can be used to develop simple utilities, customized commands or sophisticated
commercial applications for vertical markets.

3-106 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

Some of the advantages of working in the MicroStation environment include:

• Lay out network links and structures in fully-scaled environment in the same
design and drafting environment that you use to develop your engineering plans.
• Have access to any other third party applications that you currently use, along
with any custom MDL applications.
• Use native MicroStation insertion snaps to precisely position Bentley HAMMER
V8i elements with respect to other entities in the MicroStation drawing.
• Use native MicroStation commands on Bentley HAMMER V8i model entities
with automatic update and synchronization with the model database.
• Control destination levels for model elements and associated label text and anno-
tation, giving you control over styles, line types, and visibility of model elements.

Note: Bentley MicroStation V8i is the only MicroStation environment

supported by Bentley HAMMER.

Additional features of the MicroStation version includes:

• MicroStation Project Files on page 3-111

• Bentley HAMMER V8i Element Properties on page 3-112
• Working with Elements on page 3-115
• MicroStation Commands on page 3-117
• Import Bentley HAMMER V8i on page 3-118

Getting Started in the MicroStation environment

A Bentley MicroStation Bentley HAMMER project 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 Bentley
HAMMER, 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 model’s .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 model’s .sqlite file.

Bentley HAMMER V8i Edition User’s Guide 3-107

MicroStation Environment

When you start Bentley Bentley HAMMER for MicroStation, you will see the dialog
below. You must identify a new or existing MicroStation dgn drawing file to be asso-
ciated with the model before you can open a Bentley Bentley HAMMER model.

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 Bentley HAMMER Project drop down menu
to create a new Bentley HAMMER 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 scratch—You can create a model in MicroStation. You'll

first need to create a new MicroStation .dgn (refer to your MicroStation documen-
tation to learn how to create a new .dgn). Start Bentley HAMMER for MicroSta-
tion. 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 Bentley HAMMER
Project menu (Project > New). This will create a new Bentley HAMMER project
file and attach it to the Bentley MicroStation .dgn file. Once the file is created you
can start creating Bentley HAMMER elements that exist in both the Bentley
HAMMER database and in the .dgn drawing. See Working with Elements and
Working with Elements Using MicroStation Commands for more details.
• Open a previously created Bentley HAMMER project—You can open a previ-
ously created Bentley HAMMER model and attach it to a .dgn file. To do this,
start Bentley HAMMER 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 Bentley HAMMER toolbar and click on the

3-108 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

Project > "Attach Existing…" command, then select an existing Bentley

HAMMER.wtg file. The model will now be attached to the .dgn file and you can
edit, delete, and modify the Bentley HAMMER elements in the model. All
MicroStation commands can be used on Bentley HAMMER elements.
• Import a model that was created in another modeling application—There are
four types of files that can be imported into Bentley HAMMER:
– WaterGEMS / WaterCAD / HAMMER Database—this can either be a
HAMMER V8i or V8, WaterGEMS V8i or V3, or WaterCAD V8i or V7 data-
base. The model will be processed and imported into the active MicroStation
.dgn drawing. See Exporting a HAMMER v7 Model for more details.
– EPANET—You can import EPANET input (.inp) files. The file will be
processed and the proper elements will be created and added to the MicroSta-
tion drawing. See Importing and Exporting EPANET Files for more details.
– Submodel—You can import a Bentley HAMMER V8 subenvironmentl into
the MicroStation drawing file. See Importing and Exporting Submodel Files
for more details.
Bentley Water model—You can import Bentley Water model data into your Bentley
HAMMER model in MicroStation. See Importing a Bentley Water Model 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.

The MicroStation Environment 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 func-
tionality 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 Bentley
HAMMER in MicroStation:

1. MicroStation menu (File Edit Element Settings …) which contains MicroStation

commands. The MicroStation menu contains commands which affect the drawing.
2. Bentley HAMMER menu (Project Edit Analysis …) which contains Bentley
HAMMER commands. The Bentley HAMMER menu contains commands which
affect the hydraulic analysis.

It is important to be aware of which menu you are using.

Bentley HAMMER V8i Edition User’s Guide 3-109

MicroStation Environment

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 Bentley HAMMER .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 Bentley HAMMER 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.

Bentley HAMMER 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 tool-
bars but they can be docked wherever the user chooses.

3-110 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

Note: Any MicroStation tool that deletes the target element (such as
Trim and IntelliTrim) will also remove the connection of that
element to Bentley HAMMER. After the Bentley HAMMER
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

When using Bentley HAMMER V8i in the MicroStation environment, there are three
files that fundamentally define a Bentley HAMMER V8i model project:

• 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 Bentley
HAMMER, 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 model’s .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 model’s .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 repro-
duce the model. You must also preserve the associated .wtg and .sqlite files.

Saving Your Project in MicroStation

The Bentley HAMMER project data is synchronized with the current MicroStation
.dgn. Bentley HAMMER 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 Bentley HAMMER project
is saved, turn off MicroStation's AutoSave feature; then you will be prompted for the
.dgn.

Bentley HAMMER V8i Edition User’s Guide 3-111

MicroStation Environment

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 corre-
lation. They can be named the same, but they don't have to be.

Bentley HAMMER V8i Element Properties

Bentley HAMMER V8i element properties includes:

• Element Properties
• Element Levels Dialog
• Text Styles

Element Properties
When working in the MicroStation environment, this feature will display a dialog box
containing fields for the currently selected element’s associated properties. To modify
an attribute, click each associated grid cell. To open the property grid, pick
View>Properties from the Bentley HAMMER 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 Informa-
tion 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
Bentley HAMMER color coding conflicts with MicroStation element symbology, the
Bentley HAMMER 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 Bentley HAMMER 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.

You can create new Levels in the Level Manager. To access the Level Manager, click
the Settings menu and select the Level > Manager command.

3-112 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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 annota-
tions 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 element’s associated annotation.

You cannot create new levels from this dialog; to create new levels use the MicroSta-
tion 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 Assocations.

Bentley HAMMER V8i Edition User’s Guide 3-113

MicroStation Environment

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.

The View Associations window allows you to see (and change) the Symbology Defi-
nition 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.

3-114 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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

Symbology Definitions Manager

Scenarios Manager

Working with Elements

Working with elements includes:

• Edit Elements
• Deleting Elements
• Modifying Elements

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 Bentley
HAMMER View menu and select the Properties command. For more information
about the Properties Editor dialog, see Property Editor.

FlexTables: To access the FlexTables dialog, click the Bentley HAMMER View
menu and select the FlexTables command. For more information about the FlexTables
dialog, see Viewing and Editing Data in FlexTables.

Bentley HAMMER V8i Edition User’s Guide 3-115

MicroStation Environment

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
keyboard’s Delete key.

Note: Any MicroStation tool that deletes the target element (such as
Trim and IntelliTrim) will also remove the connection of that
element to Bentley HAMMER. After the Bentley HAMMER
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 HAMMER V8i Custom MicroStation Entities on page 3-116

MicroStation Commands on page 3-117

Moving Elements on page 3-117

Moving Element Labels on page 3-117

Snap Menu on page 3-118

Bentley HAMMER V8i Custom MicroStation Entities

The primary MicroStation-based Bentley HAMMER 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 Bentley
HAMMER objects.

This means that you can perform standard MicroStation commands (see MicroStation
Commands on page 3-117) as you normally would, and the model database will be
updated automatically to reflect these changes.

3-116 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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

MicroStation Commands
When running in the MicroStation environment, Bentley HAMMER 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.

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.

Bentley HAMMER V8i Edition User’s Guide 3-117

MicroStation Environment

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 Bentley HAMMER V8i

When running Bentley HAMMER in the MicroStation environment, this command
(Project>Import>Bentley HAMMER database) imports a selected Bentley HAMMER
data (.wtg) file for use in the current drawing (.dgn). You will be prompted for the
Bentley HAMMER filename to save. The new project file will now correspond to the
drawing name, such as, CurrentDrawingName.wtg. Whenever you save changes to the
network model through Bentley HAMMER the associated .wtg data file is updated
and can be loaded into Bentley HAMMER or higher.

Warning! A Bentley HAMMER Project can only be imported to a new,

empty MicroStation design model (.dgn file).

Annotation Display
Some fonts do not correctly display the full range of characters used by Bentley
HAMMER’s annotation feature because of a limited character set. If you are having
problems with certain characters displaying improperly or not at all, try using another
font.

Multiple models
You can have two or more Bentley HAMMER 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.

3-118 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

Native Format Contours

Bentley HAMMER 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 don’t 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 refer-
enced 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 manipula-
tions can be done directly in the main drawing.

Note: This feature is only available to users of MicroStation SS3 and

higher.

Working in AutoCAD
The AutoCAD environment lets you create and model your network directly within
your primary drafting environment. This gives you access to all of AutoCAD’s
drafting and presentation tools, while still enabling you to perform Bentley
HAMMER V8i modeling tasks like editing, solving, and data management. This rela-
tionship between Bentley HAMMER V8i and AutoCAD enables extremely detailed
and accurate mapping of model features, and provides the full array of output and
presentation features available in AutoCAD. This facility provides the most flexibility
and the highest degree of compatibility with other CAD-based applications and
drawing data maintained at your organization.

Bentley HAMMER V8i features support for AutoCAD integration. You can determine
if you have purchased AutoCAD functionality for your license of Bentley HAMMER
V8i by using the Help > About menu option. Click the Registration button to view
the feature options that have been purchased with your application license. If
AutoCAD support is enabled, then you will be able to run your Bentley HAMMER
V8i application in both AutoCAD and stand-alone environment.

The AutoCAD functionality has been implemented in a way that is the same as the
Bentley HAMMER base product. Once you become familiar with the stand-alone
environment, you will not have any difficulty using the product in the AutoCAD envi-
ronment.

Some of the advantages of working in the AutoCAD environment include:

Bentley HAMMER V8i Edition User’s Guide 3-119

Working in AutoCAD

• Layout network links and structures in fully-scaled environment 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 Bentley HAMMER
V8i elements with respect to other entities in the AutoCAD drawing.
• Use native AutoCAD commands such as ERASE, MOVE, and ROTATE on
Bentley HAMMER V8i model entities with automatic update and synchronization
with the model database.
• Control destination layers for model elements and associated label text and anno-
tation, giving you control over styles, line types, and visibility of model elements.

Note: Bentley WaterGEMSV8i supports the 32-bit and 64-bit versions

of AutoCAD 2012 and 2013 only.

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 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 environ-
ment is extended and enhanced by an AutoCAD ObjectARX Bentley HAMMER V8i
client layer that lets you create, view, and edit the native Bentley HAMMER V8i
network model while in AutoCAD.

AutoCAD Integration with Bentley HAMMER

When you install Bentley HAMMER after you install AutoCAD, integration between
the two is automatically configured.

3-120 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

If you install AutoCAD after you install Bentley HAMMER, you must manually inte-
grate the two by selecting Start > All Programs > Bentley >Bentley HAMMER >
Integrate Bentley HAMMER with ArcGIS-AutoCAD-MicroStation. The integra-
tion utility runs automatically. You can then run Bentley HAMMER in the AutoCAD
environment.

The Integrate Bentley HAMMER with AutoCAD-ArcGIS command can also be used
to fix problems with the AutoCAD configuration file. For example, if you have Civil-
Storm installed on the same system as Bentley HAMMER 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 Bentley
HAMMER 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 scratch—You can create a model in AutoCAD. Upon

opening AutoCAD a Drawing1.dwg file is created and opened. Likewise an unti-
tled new Bentley HAMMER project is also created and opened if Bentley
HAMMER has been loaded. Bentley HAMMER has been loaded if the Bentley
HAMMER menus and docking windows are visible. Bentley HAMMER can be
loaded in two ways: automatically by using the “Bentley HAMMER for
AutoCAD” shortcut, or by starting AutoCAD and then using the command:
Bentley HAMMERRun. Once loaded, you can immediately begin laying out your
network and creating your model using the Bentley HAMMER V8imenus and the
Bentley HAMMER file menu (See Menus). Upon saving and titling your
AutoCAD file for the first time, your Bentley HAMMER project files will also
acquire the same name and file location.
• Open a previously created Bentley HAMMER V8i project—You can open a
previously created Bentley HAMMER V8i model. If the model was created in the
Stand Alone version, you must import your Bentley HAMMER project while a
.dwg file is open. From the Bentley HAMMER menu select Project -> Import ->
Bentley HAMMER Database. Alternatively you can use the command:
_wtgImportProject. You will have the choice to import your Bentley HAMMER
database file (.sqlite) or your Bentley HAMMER project file (.wtg).
• Import a model that was created in another modeling application—You 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 AutoCAD’s menus, the following
Bentley HAMMER V8i menus are available:

• Project

Bentley HAMMER V8i Edition User’s Guide 3-121

Working in AutoCAD

• Edit
• Analysis
• Components
• View
• Tools
• Report
• Help

The Bentley HAMMER V8i menu commands work the same way in AutoCAD and
the Stand-Alone Editor. For complete descriptions of Bentley HAMMER V8i menu
commands, see Menus.

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, Bentley HAMMER 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 Bentley HAMMER V8i in the AutoCAD environment, there are three
files that fundamentally define a Bentley HAMMER V8i model project:

• Drawing File (.dwg)—The AutoCAD drawing file contains the custom entities
that define the model, in addition to the planimetric base drawing information that
serves as the model background.

3-122 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

• Model File (.wtg)—The native Bentley HAMMER V8i model database file that
contains all the element properties, along with other important model data.
Bentley HAMMER V8i .etc files can be loaded and run using the Stand-Alone
Editor. These files may be copied and sent to other Bentley HAMMER V8i users
who are interested in running your project. This is the most important file for the
Bentley HAMMER V8i model.
• wtg Exchange Database (.wtg.sqlite)—The intermediate format for wtg project
files. When you import a wtg file into Bentley HAMMER V8i, you first export it
from wtg into this format, then import the .wtg.sqlite file into Bentley HAMMER
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 Bentley HAMMER V8i program compares file dates, and automatically
use the built-in AutoCAD synchronization routine.

Click one of the following links to learn more about AutoCAD project files and
Bentley HAMMER V8i:

• Drawing Synchronization on page 3-123

• Saving the Drawing as Drawing*.dwg on page 3-124

Drawing Synchronization
Whenever you open a Bentley HAMMER V8i-based drawing file in AutoCAD, the
Bentley HAMMER V8i model server will start. The first thing that the application
will do is load the associated Bentley HAMMER V8i model (.wtg) file. If the time
stamps of the drawing and model file are different, Bentley HAMMER V8i will auto-
matically perform a synchronization. This protects against corruption that might
otherwise occur from separately editing the Bentley HAMMER V8i model file in
stand-alone environment, or editing proxy elements at an AutoCAD station where the
Bentley HAMMER V8i application is not loaded.

Bentley HAMMER V8i Edition User’s Guide 3-123

Working in AutoCAD

The synchronization check will occur in two stages:

• First, Bentley HAMMER V8i will compare the drawing model elements with
those in the server model. Any differences will be listed. Bentley HAMMER V8i
enforces network topological consistency between the server and the drawing
state. If model elements have been deleted or added in the .wtg file during a
Bentley HAMMER session, or if proxy elements have been deleted, Bentley
HAMMER V8i 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, Bentley HAMMER V8i will
compare other model and drawing states such as location, labels, and flow direc-
tions.

You can run the Synchronization check at any time using the following command:

HAMRSynchronize

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:

• Bentley HAMMER Custom AutoCAD Entities

• Explode Elements

3-124 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

• Moving Elements
• Moving Element Labels
• Snap Menu
• Polygon Element Visibility
• Undo/Redo
• Contour Labeling

Bentley HAMMER Custom AutoCAD Entities

The primary AutoCAD-based Bentley HAMMER element entities—pipes, 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 data-
base 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.

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 trans-
form 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.

Bentley HAMMER V8i Edition User’s Guide 3-125

Working in AutoCAD

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.

Undo/Redo
The menu-based undo and redo commands operate exclusively on Bentley HAMMER
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.

3-126 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

Whenever you use a native AutoCAD undo, the server model will be notified when
any Bentley HAMMER V8i entities are affected by the operation. Bentley HAMMER
V8i will then synchronize the model to the drawing state. Wherever possible, the
model will seek to map the undo/redo onto the model server’s managed command
history. If the drawing’s state is not consistent with any pending undo or redo transac-
tions held by the server, Bentley HAMMER 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 Bentley HAMMER V8i undo/redo is faster than the
native AutoCAD undo/redo. If you are rolling back Bentley
HAMMER V8i model edits, it is recommended that you use the
menu-based Bentley HAMMER V8i undo/redo.

If you undo using the AutoCAD undo/redo and you restore

Bentley HAMMER 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 Bentley HAMMER 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:

• End—Allows 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.
• Interior—This 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.

Bentley HAMMER V8i Edition User’s Guide 3-127

Working in ArcGIS

• Group End—Choosing 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 Incre-
ment that was selected.
• Group Interior—Choosing 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 Settings—Allows you to change the Style, Display Precision, and Font
Height of the contour labels.
• Delete Label—Prompts to select the contour from which labels will be deleted,
then prompts to select the labels to be removed.
• Delete All Labels—Prompts 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
Bentley HAMMER V8i provides three environments in which to work: Bentley
HAMMER V8i Stand-Alone Mode, AutoCAD Integrated Mode, and ArcMap Inte-
grated Mode. Each mode provides access to differing functionality—certain capabili-
ties that are available within Bentley HAMMER 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 Bentley HAMMER 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

3-128 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

A firm grasp of GIS basics will give you a clearer understanding of how Bentley
HAMMER V8i interacts with GIS software. Click one the following links to learn
more:

• ArcGIS Integration
• ArcGIS Applications

ArcGIS Integration

Bentley HAMMER V8i features full integration with ESRI’s ArcGIS software,
including ArcView, ArcEdit, and ArcInfo. The following is a description of the func-
tionality available with each of these packages:

• ArcView—ArcView 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 relation-
ships can not be edited with ArcView.
• ArcEdit—ArcEdit provides all of the capabilities available with ArcView in addi-
tion to the following:
– Coverage and geodatabase editing

ArcEdit can edit shapefiles, coverages, personal geodatabases, and multi-user

geodatabases.
• ArcInfo—ArcInfo provides all of the capabilities available with ArcEdit in addi-
tion to the following:
– Advanced geoprocessing
– Data conversion
– ArcInfo Workstation

ArcInfo can edit shapefiles, coverages, personal geodatabases, and multi-user

geodatabases.

Bentley HAMMER V8i Edition User’s Guide 3-129

Working in ArcGIS

ArcGIS Integration with Bentley HAMMER V8i

When you install Bentley HAMMER V8i after you install ArcGIS, integration
between the two is automatically configured when you install Bentley HAMMER
V8i.

If you install ArcGIS after you install Bentley HAMMER V8i, you must manually
integrate the two by selecting Run > All Programs > Bentley >Bentley HAMMER >
Integrate Bentley HAMMER V8i with AutoCAD-ArcGIS. The integration utility runs
automatically. You can then run Bentley HAMMER V8i in ArcGIS mode.

Registering and Unregistering Bentley HAMMER V8i with ArcGIS

Under certain circumstances, you may wish to unregister Bentley HAMMER V8i
from ArcGIS. These circumstances can include the following:

• To avoid using a license of Bentley HAMMER V8i when you are just using
ArcMap for other reasons.
• If Bentley HAMMER V8i and another 3rd party application are in conflict with
one another.

To Unregister Bentley HAMMER V8i with ArcGIS:

Run ArcGISUnregistrationTool.exe to remove the integration. If you do this, you will

be required to run ArcGISRegistrationTool.exe before using Bentley HAMMER.

Both of these applications are located in the main product directory.

To Re-Register Bentley HAMMER V8i 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.

• ArcCatalog—ArcCatalog is used to manage spatial data, database design,

and to view and record metadata.

3-130 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

• ArcMap—ArcMap is used for mapping, editing, and map analysis. ArcMap

can also be used to view, edit, and calculate your Bentley HAMMER V8i
model.

Using ArcCatalog with a Bentley HAMMER V8i Database

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

ArcCatalog Geodatabase Components

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

The Bentley HAMMER V8i ArcMap Client

The Bentley HAMMER V8i ArcMap client refers to the environment in which
Bentley HAMMER V8i is run. As the ArcMap client, Bentley HAMMER V8i runs
within ESRI’s ArcMap interface, allowing the full functionality of both programs to
be utilized simultaneously.

Getting Started with the ArcMap Client

An ArcMap Bentley HAMMER V8i project consists of:

Bentley HAMMER V8i Edition User’s Guide 3-131

Working in ArcGIS

• A Bentley HAMMER V8i .sqlite file—this file contains all modeling data, and
includes everything needed to perform a calculation.
• A Bentley HAMMER V8i .wtg file—this file contains data such as annotation and
color-coding definitions.
• A geodatabase association—a project must be linked to a new or existing geoda-
tabase.

Note: You must be in an edit session (Click the ArcMap Editor button
and select the Start Editing command) to access the various
Bentley HAMMER V8i 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 scratch—You can create a model in ArcMap. You’ll first
need to create a new project and attach it to a new or existing geodatabase. See
Managing Projects In ArcMap and Attach Geodatabase Dialog for further details.
You can then lay out your network using the Bentley HAMMER V8i toolbar. See
Laying out a Model in the ArcMap Client.
• Open a previously created Bentley HAMMER V8i project—You can open a
previously created Bentley HAMMER V8i 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 and Attach Geodatabase Dialog for further
details.
• Import a model that was created in another modeling application—You can
import a model that was created in EPANET. See Importing Data From Other
Models for further details.

Warning! You cannot use a Bentley HAMMER V8i .sqlite file as a

geodatabase. Make sure that you do not attempt to use the
same file name for both the Bentley HAMMER V8i database
(wtg.sqlite) and the geodatabase .sqlite.

Managing Projects In ArcMap

The Bentley HAMMER V8i 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:

• Add—Clicking the Add button opens a submenu containing the following

commands:

3-132 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

– Add New Project—Opens 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 Project—Opens an Open dialog, allowing you to browse to the
Bentley HAMMER V8i project to be added. If the Bentley HAMMER V8i
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 Project—Opens 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 Project—Saves 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 Project—Closes 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 Project—Removes 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 Current—Makes 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.
• Help—Opens the online help.
To add a new project

1. From the Project Manager, click the Add button and select the Add New Project
command. Or, from the Bentley HAMMER V8i menu, click the Project menu and
select the Add New Project command.
2. In the Save As dialog that opens, specify a name and directory location for the
new project, then click the Save button.
3. In the Attach Geodatabase dialog that opens, 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.

Bentley HAMMER V8i Edition User’s Guide 3-133

Working in ArcGIS

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 opens.
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 Bentley HAMMER V8i menu, click the Project
menu and select the Add Existing Project command.
2. In the Open dialog that opens, browse to the location of the project, highlight it,
then click the Open button.
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 geodata-
base 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 Bentley HAMMER 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 Field—This field displays the path and file name of the geodata-
base that was selected to be associated with the project.
• Geodatabase Button—This button opens an Import To or Create New Geodata-
base dialog, where you specify an existing geodatabase or enter a name and direc-
tory for a new one.
• Dataset Name—Allows you to enter a name for the dataset.
• Spatial Reference Pane—Displays the spatial reference currently assigned to the
geodatabase.
• Spatial Data Coordinates Unit—Choose the unit system that are used by the
spatial data coordinates.
• Change Button—Opens the Spatial Reference Properties dialog, allowing you to
change the spatial reference for the geodatabase.

3-134 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

Laying out a Model in the ArcMap Client

The Bentley HAMMER 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 Bentley HAMMER for use in the
ArcMap environment. Initially, Bentley HAMMER creates a geodatabase and a
representative set of feature classes for each domain element type (i.e. Junction, Pipe,
etc.) These feature class definitions are quite simple, consisting of geometry, the
Bentley HAMMER ID and the Bentley HAMMER feature type. These feature classes
are then linked to the GeoTable definition through the use of an ArcMap Join. This
allows for any Bentley HAMMER data defined in the GeoTable definition, to be used
natively by any ArcMap function. To view this data in a tabular manner, right-click on
a Bentley HAMMER feature class in the ArcMap table of contents and Open Attribute
Table. You will then see the original feature class fields are now joined to the fields
defined in the GeoTable.

The data underneath the GeoTable definition is dynamic. That is, it will change based
upon the current scenario and timestep. By managing our data in this context, Bentley
HAMMER 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\Haestad\Bentley\HAMMER\1 folder) for
these display settings to work on another computer.

Using GeoTables, you can:

• Apply ArcMap symbology definitions to map elements based on Bentley

HAMMER data.
• Use the ArcMap Select By Attributes command to select map elements based on
Bentley HAMMER data.
• Generate ArcMap reports and graphs that include Bentley HAMMER data.

Bentley HAMMER V8i Edition User’s Guide 3-135

Working in ArcGIS

To Edit a GeoTable

1. In the FlexTable Manager list pane, expand the GeoTables node if necessary.
2. Double-click the GeoTable for the desired element type.
3. By default, only the ID, Label, and Notes data is included in the GeoTable. To add
attributes, click the Edit button.
4. In the Table setup dialog that opens, 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 high-
lighted attribute to the other list; a double arrow moves all of them).
5. When all of the desired attributes have been moved to the selected columns, click
OK.

Bentley HAMMER Renderer

The Bentley HAMMER Renderer can be activated/deactivated by choosing the
Bentley Bentley HAMMER V8 > View > Apply Bentley HAMMER Renderer menu
item.

When the Bentley HAMMER Renderer is activated, inactive topology (that is,
Bentley HAMMER elements whose Is Active? property is set to false) will display
differently and flow arrows will become visible in the map (if applicable). The inac-
tive 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 Bentley HAMMER projects with a large number of elements,
there can be a performance impact when the Bentley HAMMER Renderer is acti-
vated.

Show Flow Arrows (ArcGIS)

The Show Flow Arrows menu item can be activated/deactivated by choosing the
Bentley HAMMER V8 > View > Show Flow Arrows menu item.

When Show Flow Arrows is activated, it allows the Bentley HAMMER 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 Bentley
HAMMER Renderer is activated. See Bentley HAMMER Renderer for more details.

3-136 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

When working with Bentley HAMMER projects with a large number of elements,
there can be a performance impact when the Show Flow Arrows menu item is acti-
vated.

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

Multiple Client Access to Bentley HAMMER Projects

Since the Bentley HAMMER datastore is an open database format, multiple applica-
tion clients can open, view, and edit a Bentley HAMMER project simultaneously. This
means that a single project can be open in Bentley HAMMER 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

Bentley HAMMER 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\Synchronize…GEMS 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, Bentley HAMMER cannot “see” that changes
have been made, so a manual synchronization must be initiated as outlined above.

Bentley HAMMER V8i Edition User’s Guide 3-137

Working in ArcGIS

Rollbacks

Bentley HAMMER 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 GEMS data-
base. 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 Bentley HAMMER Stand-
Alone, it is not practical to discard project database changes because each application
holds a database lock. Bentley HAMMER automatically adapts to these situations and
will not rollback when the Stand-Alone session is ended without a prior save. When
this happens, Bentley HAMMER 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. Bentley HAMMER will then ignore all
changes, and revert to the original saved data.

If you elect not to perform the rollback, Bentley HAMMER automatically synchro-
nizes to reflect the current project database state, the very next time it is opened and no
project data is lost. To close Bentley HAMMER without performing a rollback,
simply click No in the Multiple Locks dialog box. Bentley HAMMER will then exit
without saving changes. Note that the changes made outside of Bentley HAMMER
will still be applied to the geodatabase, and Bentley HAMMER will synchronize the
model with the geodatabase when the project is again opened inside Bentley
HAMMER. Therefore, even though the changes were not saved inside Bentley
HAMMER, they will still be applied to the GEMS datastore the next time the
project is opened.

Project data is never discarded by Bentley HAMMER without first giving you an
opportunity to save.

Adding New Bentley HAMMER V8i Nodes To An Existing Model In

ArcMAP

If you already have an .mxd file for the model:

1. Click Open
2. Browse to it in the Open dialog and then click Open.

3-138 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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

In the Add Data dialog that opens, browse to your model’s .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.

Bentley HAMMER V8i Edition User’s Guide 3-139

Google Earth Export

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 Bentley HAMMER Project

Because ArcGIS lacks a Save As command and because changing the name of your
Bentley HAMMER 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 “WaterGEM-
SProjectMap”, and edit the value in the “ProjectPath” column to point to the new
copy of the wtg file. (e.g. “.\Model.wtg”).

Google Earth Export

Google Earth export allows a Bentley HAMMER user to display Bentley HAMMER
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.

Bentley HAMMER 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 Bentley HAMMER users in a portable open
format,

3-140 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

• 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 Bentley HAMMER 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 Bentley HAMMER stand
alone interface is in scaled drawing mode (Tools --> Options --> Drawing Tab -->
Drawing Mode: Scaled).

Preparing to Export to Google Earth from Microstation

In order to describe how to export Bentley HAMMER 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 Bentley HAMMER model.

Q1: Do you already have a *.dgn (Microstation drawing file)? If yes go to Q2, else
follow steps 1 to 6.

1. Open Bentley HAMMER 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 Bentley HAMMER menu, select Project --> Attach Existing…
5. Select the *.wtg model file and click Open.

Bentley HAMMER V8i Edition User’s Guide 3-141

Google Earth Export

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 Coordi-
nate System from a library or from an existing *.dgn. Select the projected coordi-
nate 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.

3-142 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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 step 1
below.

1. Use the Bentley HAMMER 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
Bentley HAMMER or Microstation model.

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 Bentley HAMMER 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 Bentley HAMMER 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 Bentley HAMMER 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 Bentley HAMMER toolbar, choose Bentley HAMMER --> 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.

Bentley HAMMER V8i Edition User’s Guide 3-143

Google Earth Export

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.

Note: 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 Exporting to a KML File from ArcGIS, 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.
4. Change the Primary Display Field to Label. (If this field is not available, you need
to make sure the Bentley HAMMER 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."

3-144 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

7. Click "Verify" to see the fields. (These can be customized by editing your Bentley
HAMMER 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.

Bentley HAMMER V8i Edition User’s Guide 3-145

Google Earth Export

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:

2. Save the image using File > Save > Save Image and assign the image a file name.
3. Open Bentley HAMMER and create a new project.

3-146 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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.

Bentley HAMMER V8i Edition User’s Guide 3-147

Google Earth Export

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 right-
most (image) columns by the scale factor determined in step 6 to obtain the values

3-148 Bentley HAMMER V8i Edition User’s Guide

 Understanding the Workspace

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.

Bentley HAMMER V8i Edition User’s Guide 3-149

Google Earth Export

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.

3-150 Bentley HAMMER V8i Edition User’s Guide

 Creating Models
4
Starting a Project

Elements and Element Attributes

Adding Elements to Your Model

Manipulating Elements

Editing Element Attributes

Using Named Views

Using Selection Sets

Using the Network Navigator

Using Prototypes

Zones

Engineering Libraries

Hyperlinks

Using Queries

User Data Extensions

Starting a Project
When you first start Bentley HAMMER V8i, the Welcome dialog box opens.

The Welcome dialog box contains the following controls:

Bentley HAMMER V8i Edition User’s Guide 4-151

Starting a Project

Quick Start Lessons Opens the online help to the Quick Start Lessons
Overview topic.

Create New Project Creates a new Bentley HAMMER project. When

you click this button, an untitled Bentley HAMMER
V8i project is created.

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 Bentley HAMMER, you are
prompted to log into a ProjectWise datasource if
you are not already logged in.

Show This Dialog at When selected, the Welcome dialog box opens
Start whenever you start Bentley HAMMER V8i. Turn
off this box if you do not want the Welcome dialog
box to open whenever you start Bentley HAMMER
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 the box labeled Show This Dialog at Start.

Bentley HAMMER V8i Projects

All data for a model are stored in Bentley HAMMER as a project. Bentley HAMMER
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 Bentley HAMMER 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

4-152 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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:

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.

Bentley HAMMER V8i Edition User’s Guide 4-153

Starting a Project

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 “Untitledx.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.

4-154 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Setting Options

You can change global settings for Bentley HAMMER 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

• Options Dialog Box - Project Tab
• Options Dialog Box - Drawing Tab

Bentley HAMMER V8i Edition User’s Guide 4-155

Starting a Project

• Options Dialog Box - Units Tab

• Options Dialog Box - Labeling Tab
• Options Dialog Box - ProjectWise Tab

Options Dialog Box - Global Tab

The Global tab changes general program settings for the Bentley HAMMER stand-
alone editor, including whether or not to display the status pane, as well as window
color and layout settings.

The Global tab contains the following controls:

General Settings

4-156 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 When selected, activates the recently opened

Used Files 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.

Show Status Pane When turned on, activates the Status Pane
display at the bottom of the Bentley HAMMER
stand-alone editor. This check box is turned
on by default.

Show Welcome When turned on, activates the Welcome

Page on Startup dialog that opens when you first start Bentley
HAMMER. This check box is turned on by
default.

Zoom Extents On When turned on, a Zoom Extents is performed

Open automatically in the drawing pane.

Use accelerated Some video cards use "triple buffering", which

redraw 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

Bentley HAMMER V8i Edition User’s Guide 4-157

Starting a Project

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 Displays the color that is currently assigned to

Background Color read-only data field backgrounds. You can
change the color by clicking the ellipsis (...) to
open the Color dialog box.

Read Only Displays the color that is currently assigned to

Foreground Color 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

Display Inactive When turned on, activates the display of

Topology 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 Displays the color currently assigned to

Line Color 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
Bentley HAMMER datastore. This check box
is turned off by default.

4-158 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 When this box is checked, polygon elements

Edge (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 Specifies, in pixels, the size of the handles

Size In Pixels that appear on selected elements. Enter a
number from 1 to 10.

Selection Line Increases or decreases the line width of

Width Multiplier 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 Allows you to select GIS or CAD drawing

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

Bentley HAMMER V8i Edition User’s Guide 4-159

Starting a Project

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.

4-160 Bentley HAMMER V8i Edition User’s Guide

 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.

The Project tab contains the following controls:

Geospatial Options

Bentley HAMMER V8i Edition User’s Guide 4-161

Starting a Project

Spatial Reference Used for integration with Projectwise. Can leave

the field blank if there is no spatial information.

Element Identifier Options

Element Identifier Specifies the format in which reference fields are

Format used. Reference fields are fields that link to
another element or support object (pump
definitions, patterns, controls, zones, etc.).

Result Files

Specify Custom When checked, allows you to edit the results file
Results File Path? 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 The program will round to the nearest unit
Nearest specified in this field when calculating scaled pipe
length

4-162 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Calculate Pipe Lengths When checked, includes differences in Z

Using Node Elevations (elevation) between pipe ends when calculating
(3D Length) 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.

The Drawing tab contains the following controls:

Drawing Scale

Bentley HAMMER V8i Edition User’s Guide 4-163

Starting a Project

Drawing Mode Selects either Scaled or Schematic mode for

models in the drawing pane.

Horizontal Scale Controls the scale of the plan view.

Factor 1 in. =:

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.

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 When this box is checked, color coding settings

Annotations are applied to the element annotation.

4-164 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Options Dialog Box - Units Tab

The Units tab modifies the unit settings for the current project.

Bentley HAMMER V8i Edition User’s Guide 4-165

Starting a Project

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.

Reset Defaults - US Resets the unit and formatting settings to the original
factory defaults for the Imperial (U.S.) system.

Default Unit System Specifies the unit system that is used globally across
for New Project the project. Note that you can locally change any
number of attributes to the unit system other than the
ones specified here.

4-166 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 indi-
cate 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 preci-
sion 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 nega-
tive. Thousand separators are inserted
between each group of three digits to the left
of the decimal point.

Bentley HAMMER V8i Edition User’s Guide 4-167

Starting a Project

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.

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.

4-168 Bentley HAMMER V8i Edition User’s Guide

 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. Bentley HAMMER 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 Bentley HAMMER with ProjectWise.

Bentley HAMMER V8i Edition User’s Guide 4-169

Starting a Project

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.

Update server on Save When this is turned on, any time you save your
Bentley HAMMER 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 topic.

Working with ProjectWise

Bentley ProjectWise provides managed access to Bentley HAMMER 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 Bentley HAMMER project is stored
using ProjectWise, project files can be accessed quickly, checked out for use, and
checked back in directly from within Bentley HAMMER. 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, Bentley HAMMER automati-

cally installs all the components necessary for you to use ProjectWise to store and
share your Bentley HAMMER projects. A Bentley HAMMER 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.

4-170 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

ProjectWise and Bentley HAMMER V8i

Follow these guidelines when using Bentley HAMMER with ProjectWise:

• ProjectWise integration must be enabled before Bentley HAMMER 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 opera-
tion, for example, will first show the ProjectWise file browser, where you can
open a project 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 Bentley
HAMMER 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 Bentley HAMMER 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 Bentley HAMMER 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 Bentley HAMMER 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 In—Updates the project files in ProjectWise with your latest changes
and unlocks the project so other ProjectWise users can edit it.
– Unlock—Unlocks 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.

Bentley HAMMER V8i Edition User’s Guide 4-171

Starting a Project

– Leave Out—Leaves 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 HAMMER
V8i but continue working on the project later. The project files may be
synchronized when the files are checked in later.

• In the Bentley HAMMER 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 Bentley HAMMER 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 Project-
Wise 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 Bentley HAMMER, 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.

4-172 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

• Bentley HAMMER 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 Bentley HAMMER

You can quickly tell whether or not the current Bentley HAMMER project is in
ProjectWise or not by looking at the title bar and the status bar of the Bentley
HAMMER 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 below.

If you have enabled ProjectWise integration, you can perform the following Project-
Wise operations from within Bentley HAMMER:

To save an open Bentley HAMMER project to ProjectWise

1. In Bentley HAMMER, select File > Save As.

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:
a. Click Change next to the Folder field, then select a folder in the current
ProjectWise datasource in which to store your project.
b. Type the name of your Bentley HAMMER project in the Name field. It is best
to keep the ProjectWise name the same as or as close to the Bentley
HAMMER project name as possible.

Bentley HAMMER V8i Edition User’s Guide 4-173

Starting a Project

c. Keep the default entries for the rest of the fields in the dialog box.
d. Click OK. There will be two new files in ProjectWise; a *.wtg and a
*.wtg.sqlite.

To open a Bentley HAMMER project from a ProjectWise datasource from within

Bentley HAMMER

1. Select File > Open.

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 Select Document dialog box, perform these steps:
a. From the Folder drop-down menu, select a folder that contains Bentley
HAMMER projects.
b. In the Document list box, select a Bentley HAMMER project.

4-174 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

c. Keep the default entries for the rest of the fields in the dialog box.
d. Click Open.

To open a Bentley HAMMER project from ProjectWise, it is also possible to double

click on the project in ProjectWise.

To copy an open Bentley HAMMER 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 Bentley HAMMER project stored in a ProjectWise

datasource

1. Select File > Open.

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.

Bentley HAMMER V8i Edition User’s Guide 4-175

Starting a Project

3. Select File > Save As.

At the ProjectWise save prompt click Cancel.

4. Save the Bentley HAMMER project to a folder on your local computer.

To change the default ProjectWise datasource

1. Start Bentley HAMMER.

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 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 Bentley HAMMER appli-
cation, 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 inte-
gration the file prompts in the application will not allow interaction with ProjectWise
datasources.

4-176 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

For the Standalone platform, you must edit the ProjectWiseIntegrationLocalOp-

tions.xml file using a text editor. The file is located in the All User documents direc-
tory:

In Windows XP: C:\Documents and Settings\All Users\Application

Data\Bentley\HAMMER\8

In Windows Vista/Windows 7/Windows 8: C:\ProgramData\Bentley\HAMMER\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 Project-
Wise 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.

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 inte-
grated 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, associ-
ation 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 docu-
ments and folders.

Bentley HAMMER V8i Edition User’s Guide 4-177

Starting a Project

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 auto-
matically 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.

Each document is indexed to a universal coordinate system or SRS, however, the orig-
inating 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 Refer-

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

4-178 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 coordi-
nates 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 geom-
etries 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 Project-
Wise 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 coordi-
nate system dictionary in the ProjectWise administrator tool (under the Coordinate
Systems node of the datasource), and add the desired coordinate system to the data-
source. 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 adminis-
trator.

If the project's SRS is left blank, then ProjectWise will simply not be updated with a
spatial location for that project.

If the project's SRS is not recognized, an error message will be shown, and Project-
Wise 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 Project-
Wise 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.

Bentley HAMMER V8i Edition User’s Guide 4-179

Starting a Project

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.

4-180 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Elements and Element Attributes

Pipes

Junctions

Hydrants

Tanks

Reservoirs

Pumps

Variable Speed Pump Battery

Valves

Spot Elevations

Turbines

Periodic Head-Flow Elements

Air Valves

Hydropneumatic Tanks

Surge Valves

Check Valves

Rupture Disks

Discharge to Atmosphere Elements

Orifice Between Pipes Elements

Valve with Linear Area Change Elements

Surge Tanks

Other Tools

Bentley HAMMER V8i Edition User’s Guide 4-181

Elements and Element Attributes

Pipes

Pipes are link elements that connect junction nodes, pumps, valves, tanks, and reser-
voirs. Each pipe element must terminate in two end node elements.

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

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 mate-
rial 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.

4-182 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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. Bentley HAMMER 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:

Bentley HAMMER V8i Edition User’s Guide 4-183

Elements and Element Attributes

a. 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.
b. 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 Prop-
erty Editor.
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.

4-184 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

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.

Bentley HAMMER V8i Edition User’s Guide 4-185

Elements and Element Attributes

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:

New Creates a new Minor Loss Coefficient.

Duplicate Creates a copy of the currently highlighted

minor loss coefficient.

4-186 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Delete Deletes the minor loss coefficient that is

currently highlighted in the list pane.

Rename Renames the minor loss coefficient that is

currently highlighted in the list pane.

Report Opens a report of the data associated with

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

Synchronization Browses the Engineering Library,

Options synchronizes to or from the library, imports
from the library or exports to the library.

The tab section is used to define the settings for the minor loss that is currently high-
lighted in the minor loss list pane. The following controls are available:

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.

Bentley HAMMER V8i Edition User’s Guide 4-187

Elements and Element Attributes

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.

4-188 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

The dialog consists of the following controls:

Bulk Modulus of The bulk modulus of elasticity of the liquid.

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

Young’s Modulus The Young’s 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 Poisson’s Ratio field with the values
for the chosen material.

Poisson’s Ratio The Poisson’s 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 Young’s
Modulus field with the values for the chosen
material.

Wall Thickness The thickness of the pipe wall.

Bentley HAMMER V8i Edition User’s Guide 4-189

Elements and Element Attributes

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.

Virtual Links

A user can specify that a user defined conduit or pressure pipe has a section type of
"Virtual" by setting the section type to "Virtual" in the property grid for conduits or "Is
virtual" property to True in the property grid for pressure pipes. The behavior of a
virtual link depends on the active solver and whether the link is a conduit or pressure
pipe. Gutters and channels cannot be virtual.

Virtual links pass the flow from the upstream node to the downstream nodes but do
not always calculate hydraulic properties such as velocity and head loss. Virtual links
usually have length but this is only to assist in plotting the link in a profile drawing.
Depending on the solver, the rise of the virtual link may not be shown in the profile. In
some solvers (e.g. GVF-convex), the "Is virtual = True" setting is ignored and

4-190 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

hydraulic properties are calculated. The behavior of different virtual links is

summarized in the table below.

Virtual links enable the same model file to be used with different solvers even though
the solvers have very different ways of representing different physical facilities. The
explicit solver internally represents pumps as links with essentially no length while
the GVF solver represents pumps as points which must be connected to non-virtual
pipes at each end. To make these two solvers compatible, in a model (e.g.
SewerGEMS, SewerCAD, CivilStorm or StormCAD) which represents pumps as
points, virtual links must be inserted on the suction and discharge side of pump nodes.

Bentley HAMMER V8i Edition User’s Guide 4-191

Elements and Element Attributes

These virtual pipes and the pump node are combined into a single effective link when
the model is run in the explicit solver and the results are later applied to model
elements.

Similarly, control structures (e.g. weirs, orifices) are represented as links in the
explicit solvers but are properties of links in the implicit and GVF solvers. The control
structures need to be associated with virtual links to work with the explicit solver.

For details on using virtual links as conduits or pressure pipes, see help topics Virtual
Conduits and Virtual Links.

Virtual Conduits

User defined conduits can be treated as virtual conduits by setting the Section Type to
Virtual. Virtual conduits are not available in the Conduit Catalog.

In the implicit and explicit solvers, the virtual conduits have length but no diameter/
rise and span. In these solvers, the virtual conduit must have a control structure (e.g.
weir, orifice) assigned to it. If a control structure link is imported from an EPA-
SWMM model, a virtual conduit is created with the control structure.

For the GVF solver, virtual conduits can only be used for diversion links. If a control
structure is placed on a diversion link, it will be ignored since the diversion is
controlled with the diversion rating table or cutoff value.

When switching between the solvers, it is best to set up two physical alternatives when
flow splits are involved. The one associated with the implicit or explicit solvers will
have a control structure while the one with the GVF solvers with be a diversion link.
Both of them can be virtual. It is best to make these links short so that they look like
point structures in profiles.

Virtual Pressure Pipes

The Bentley storm and sanitary sewer models treat pumps as nodes connected to
suction and discharge piping. However, not all solvers were set up with that represen-
tation and not all pumps have suction lines (e.g. submersible pumps).

In the GVF solvers, there is no benefit from using virtual pressure pipes. For the GVF-
convex solver, they are treated as not virtual even if they were set up as virtual in
another solver (with the diameter and length taken from prototype properties). In the
GVF-rational solver, no head loss is calculated for the virtual pressure pipes. When
moving between solvers, the user should remember that head loss is calculated in the
GVF-convex solver so the results may not agree between solvers.

4-192 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

In the implicit solver, pressure pipes connected to pups may or may not be virtual.
When implicit pressure pipes are virtual, no head loss is calculated and the flow is
simply moved from the upstream to the downstream nodes on the pipe. For example, a
virtual suction pipe can be used to represent a submersible pump which has no suction
pipe but is shown with a suction pipe in the drawing.

In the explicit solver, no head loss is calculated for virtual pressure pipes. When a
SWMM model is imported into a Bentley model, a virtual pressure pipe is placed on
both the suction and discharge side of the pump and the explicit solver is set as the
default.

In general, the most accurate calculation of pump flows result if virtual pipes are not
used. If they must be used, then they should be kept short in the drawing. For example,
in SWMM, it is possible to have the discharge side of a pump connected to a node
thousands of feet away with no consideration of the interconnecting force main. This
should be avoided if accuracy in pump behavior is important.

When moving a model between solvers, where virtual pipes are used in the implicit
and explicit solvers, it is advisable to set up a different physical alternative for the
solvers.

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 chem-
ical 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
doesn’t 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 doesn’t vary over time).

Bentley HAMMER V8i Edition User’s Guide 4-193

Elements and Element Attributes

Applying a Zone to a Junction

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

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.

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.

4-194 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 =  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 magni-
tude. 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.

Bentley HAMMER V8i Edition User’s Guide 4-195

Elements and Element Attributes

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 chem-
ical constituents can enter the network.

Applying a Zone to a Hydrant

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

To Apply a Previously Created Zone to a Hydrant

1. Select the hydrant in the Drawing View.

2. In the Properties window, click the menu in the Zone field and select the zone
you want.

Also, see Hydrant Lateral Loss.

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

4-196 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 4-349.

To Apply a Previously Created Zone to a Tank

1. Select the tank in the Drawing View.

2. In the Properties window, click the menu in the Zone field and select the zone
you want.

Active Topology
By default a tank is active in a model. A tank can be made inactive (not used in calcu-
lations) 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.

Bentley HAMMER V8i Edition User’s Guide 4-197

Elements and Element Attributes

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

4-198 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 Constit-
uent Alternatives 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. Bentley
HAMMER 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 instanta-
neously 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

Bentley HAMMER V8i Edition User’s Guide 4-199

Elements and Element Attributes

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 simu-
lating 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.

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

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 Zones on page 4-349.

To Apply a Previously Created Zone to a Reservoir

1. Select the reservoir in the Drawing View.

2. In the Properties window, click the menu in the Zone field and select the zone
you want.

4-200 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 repre-
sents 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.

Pumps

Pumps are node elements that add head to the system as water passes through.

Applying a Zone to a Pump

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 Zones on page 4-349.

To Apply a Previously Created Zone to a Pump

1. Select the pump in the Drawing View.

2. In the Properties window, click the menu in the Zone field and select the zone
you want.

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.

Bentley HAMMER V8i Edition User’s Guide 4-201

Elements and Element Attributes

4. For each definition in the list, perform these steps:

a. Type a unique label for the pump definition.
b. 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.

For more information about pump definitions, see the following topics:

Pump Definitions Dialog Box

Pump Curve Dialog Box

Flow-Efficiency Curve Dialog Box

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.

4-202 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 clicking on items in the list to
select multiple entries at once.

Rename Renames the currently highlighted entry in

the pump definition Pane.

Report Generates a pre-formatted report that contains

the input data associated with the currently
highlighted entry in the pump definition Pane.

Synchronization Clicking this button opens a submenu

Options containing the following commands:
• Browse Engineering Library—Opens
the Engineering Library manager dialog,
allowing you to browse the Pump Defini-
tion Libraries.
• Synchronize From Library—Updates a
set of pump definition entries previously
imported from a Pump Definition Engi-
neering 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.

Bentley HAMMER V8i Edition User’s Guide 4-203

Elements and Element Attributes

The tab section includes the following controls:

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.

4-204 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Pump Definition A pump is an element that adds head to the system as water passes
Type 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 effi-
ciency, the actual power consumed (brake horse-
power) 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 calcu-
lated 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 unpredict-
ably, 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 unpredict-
ably, or its performance may decline rapidly.

Bentley HAMMER V8i Edition User’s Guide 4-205

Elements and Element Attributes

Pump Definition • Standard Extended—When selecting a Standard

Extended pump, the following flow vs. head points must
Type (cont’d)
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 unpredict-
ably, 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 unpredict-
ably, 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.

4-206 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Efficiency Tab This tab allows you to specify efficiency settings for
the pump that is being edited.

Bentley HAMMER V8i Edition User’s Guide 4-207

Elements and Element Attributes

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 main-
tains 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 Effi-
ciency 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.

4-208 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Motor Tab This tab allows you to define the pump's motor
efficiency settings. It contains the following controls:

Motor The Motor Efficiency value is representative of the

Efficiency ability of the motor to transform electrical energy to
rotary mechanical energy.

Is Variable This check box allows you to specify whether or not

Speed Drive? the pump is a Variable Speed Pump. Toggling this
check box On allows you to input points on the
Efficiency Points table.

Efficiency This table allows you to enter efficiency points for

Points Table 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 Bentley
HAMMER-specific transient settings. It contains the
following controls:

Inertia (Pump Inertia is proportional to the amount of stored

and Motor) 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 thenumber 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 Indicates whether the pump is equipped with a ratchet

Allowed? or other device to prevent the pump impeller from
spinning in reverse.

Bentley HAMMER V8i Edition User’s Guide 4-209

Elements and Element Attributes

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.

Notes Tab This tab contains a text field that is used to type
descriptive notes that will be associated with the pump
that is currently highlighted in the Pump Curves
Definition Pane.

To create a pump definition

1. Select Components > Pump Definitions.

2. Click New to create a new pump definition.
3. For each pump definition, perform these steps:
a. Select the type of pump definition in the Pump Definition Type menu.
b. 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.
c. 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.
d. Define efficiency and motor settings in the Efficiency and Motor tabs.

4. You can save your new pump definition in Bentley HAMMER’ Engineering
Libraries for future use. To do this, perform these steps:

a. Click the Synchronization Options button, then select Export to Library.

The Engineering Libraries dialog box opens.
b. 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.
c. Click Close to close the Engineering Libraries dialog box.

5. Perform the following optional steps:

– To delete a pump definition, select the curve label then click Delete.

4-210 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

– To rename a pump definition, select the label of the pump definition you want
to rename, click Rename, then type the new name.
– To view a report on a pump definition, select the label for the pump definition,
then click Report.

6. 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 vari-
able speed drive used. The graph below shows the efficiency vs. speed curves for a
typical VFD: Square D (Schneider Electric) model ATV61:

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.

Bentley HAMMER V8i Edition User’s Guide 4-211

Elements and Element Attributes

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.

For more information about Engineering Libraries, see Engineering Libraries.

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. Effi-
ciency table. Click the New button to add a new row and click the Delete button to
delete the currently highlighted row.

4-212 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

For more information about Engineering Libraries, see Engineering Libraries.

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.

For more information about Engineering Libraries, see Engineering Libraries.

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 pump’s
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 Bentley HAMMER tab of the
Pump Definition dialog.

Bentley HAMMER V8i Edition User’s Guide 4-213

Elements and Element Attributes

The calculator uses the following empirical relation developed by Thorley

1.48 2
I motor = 118   P  N  kgm

7 3 0.9556 2
: I pump = 1.5  10   P  N  kgm

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.

Positive Displacement Pumps

The pump element in HAMMER can be used to represent centrifugal, axial-flow
(single and double-suction) or multistage (including vertical turbines) pumps,
however it is not applicable for modeling positive displacement type pumps.

An approximation of a positive displacement pump can be made by replacing the

pump with two Periodic Head-Flow elements - one for the suction side of the pump,
and the other for the discharge side of the pump, as shown below.

4-214 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

The 'Export ' property should be set to 'Flow', the 'Sinusoidal' property should be set to
'False' and a flow pattern should be set up to represent the pump flow throughout the
simulation. The element representing the suction side of the pump should have posi-
tive flow values (representing flow leaving the system), while the element repre-
senting the discharge side of the pump should have positive flow values (representing
inflow to the system). HAMMER will then compute the appropriate suction and
discharge head values. An example of possible flow patterns is given below for a
pump slowing from 250 gpm to 0 gpm over 30 seconds:

Table 4-1: Suction Side

Time (sec) Flow (gpm)

0.0 250

30.0 0

Table 4-2: Discharge Side

Time (sec) Flow (gpm)

0.0 -250

30.0 0

However it should be noted that this approximation does not take into account impor-
tant pump parameters like inertia and rotational speed or the behavior of the pump in
each of the four quadrants of operation. Therefore it is up to the engineer to determine
whether this approximation is suitable for each particular use-case.

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
fluid’s energy head at the pump’s suction flange.

Bentley HAMMER V8i automatically imports pump information from WaterCAD or

WaterGEMS using WaterObjects technology. You may need to enter additional data to
model dynamic effects. Bentley HAMMER V8i can represent virtually any pump
using one of these five hydraulic elements:

• Shut Down After Time Delay—four-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 Curves—no pump curve: A simplified constant-speed
pump element between two pipe segments.

Bentley HAMMER V8i Edition User’s Guide 4-215

Elements and Element Attributes

• Constant Speed - Pump Curve: constant-speed pump between two pipes, which
supports user-defined pump curves.
• 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.
• Pump Start - Variable Speed/Torque— four-quadrant pump curve built in: A vari-
able-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 pump’s hydraulic characteristics depends on the type
selected, but the following are common parameters:

• Duty or Design Point—Point 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 4-220.
• Shutoff and Runout—Shutoff 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. Bentley HAMMER V8i will not automatically shut down a
pump if it reaches shutoff head or runout flow; therefore, this information is not
required for a Bentley HAMMER V8i run.
• Elevation—The pump elevation is required to calculate suction or discharge pres-
sures and to display the pump at the correct location on profile plots.
• Efficiency—Efficiency 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.
• Speed—Rotational speed in revolutions per minute (rpm) of the impeller. This is
commonly the same as the motor’s 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.

4-216 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

• Inertia—Pump inertia is the resistance of the pump assembly to acceleration or

deceleration. Bentley HAMMER 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 informa-
tion, see Pump Inertia on page 4-217.
• Specific Speed—A pump’s specific speed is a function of its rotational speed,
Nominal Flow, and Nominal Head. For more information, see Specific Speed on
page 15-867.

Pump Inertia

If a pump’s speed will be controlled (i.e., ramped up or down, started or shut down
during the simulation period) you need to enter the pump’s 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.

Transient Tip: 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 HAMMER 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 inertia—typically available from motor manufacturers directly, since this

parameter is used to design the motor. The pump vendor can also provide this
information.
• Pump impeller inertia—typically available from the pump manufacturers’ sales
or engineering group, since inertia is used to design the pump.
• Shaft inertia—the shaft’s 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 inertia—some 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.

Bentley HAMMER V8i Edition User’s Guide 4-217

Elements and Element Attributes

• Transmission inertia—some 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:

7 3 0.9556 2
I pump = 1.5  10   P  N  kgm

1.48
I motor = 118· (P / N ) kgm 2
(4.1)

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 pump’s specific speed. According to affinity laws, impellers with similar
geometry and streamlines tends to have similar specific speeds.

Transient Tip: 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 HAMMER V8i will output
physically meaningful results provided you select the
correct four-quadrant curve based on your pump’s
specific speed. The results can help you decide whether
or not additional detail is critical or even required.

4-218 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

To select an appropriate four-quadrant pump curve in Bentley HAMMER V8i, simply

calculate the specific speed and select the closest available setting in the Specific
Speed field of the pump’s Element Editor. You can calculate your pump’s specific
speed, Ns, using the following equation:

“Table 4-3: Specific Speeds for Typical Pump Categories in both Unit Systems”on
page 4-220 shows typical values of specific speed for which an exact four-quadrant
representation is built into Bentley HAMMER V8i. Centrifugal pumps tend to have
lower specific speeds than axial-flow or multi-stage pumps. Few four-quadrant char-
acteristic 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 HAMMER V8i has a built-in check valve immedi-
ately downstream of the pump.

Bentley HAMMER V8i Edition User’s Guide 4-219

Elements and Element Attributes

Note: If you need a four-quadrant pump curve but your pump’s

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.

Table 4-3: Specific Speeds for Typical Pump Categories in both Unit
Systems

Unit System Specific Speed, Ns

Centrifugal pumps Axial-Flow Pumps

Multistage pumps
(radial-vane or (mixed-flow or
(axial or mixed-flow)
flange-screw types) flange-screw types)

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 pump’s 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 repre-
sent this pump configuration during a transient analysis.

If you have the multipoint pump curve, you can enter it directly in HAMMER or
import it from another model or datasource. The pump curve is used by HAMMER 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 HAMMER may result in

significant prediction errors. These rated values may differ
significantly from the pump’s 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 4-220, then select the Constant Speed
- No Pump Curve option under Pump Type (Transient). You can also use one of these

4-220 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 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
possible—but safely. Bentley HAMMER V8i helps you estimate safe ramp times to
make the most of your pump’s capabilities.

In Bentley HAMMER 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.

Bentley HAMMER V8i does not currently model loop-back controllers, which can
modify the VFD’s 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 opera-
tions.

Bentley HAMMER V8i Edition User’s Guide 4-221

Elements and Element Attributes

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.

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.

4-222 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

Bentley HAMMER V8i Edition User’s Guide 4-223

Elements and Element Attributes

If the pump is a constant speed pump, then a single head and efficiency curve are
shown with multiple points showing each selected time.

4-224 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

If a variable speed pump is selected, then a separate head and efficiency curve are
generated for each time step.

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.

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.

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.

Bentley HAMMER V8i Edition User’s Guide 4-225

Elements and Element Attributes

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.

4-226 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

A pump station is a polygon element which displays which pumps are in the station by
dashed lines connecting the pumps with the station polygon centroid. A pump does
not need to be inside the polygon to be a pump assigned to the station and pumps
inside the polygon still need to be assigned to the station. The only information saved
with a pump station is the geometry of the station and the list of pumps assigned to the
station.

A pump station element is useful in calculating and displaying an analysis of pump

combinations (see Pump Curve Combinations).

Bentley HAMMER V8i Edition User’s Guide 4-227

Elements and Element Attributes

Usually the pumps and associated piping are laid out before the station is drawn.
However, the station polygon can be drawn first. The station element is created by

picking the pump station element icon from the layout menu and drawing a
polygon around the extents of the station. When the polygon is complete, the user
right clicks and selects "Done".

Individual pump elements are assigned to a station by selecting the pump element and
in the Pump Station property, picking the pump station which the pump is associated.
A dashed line is drawn from the pump to the station. This also can be done in the
physical alternative for pumps. To assign several pumps at once, a global edit can be
used provided that at least one pump has already been assigned to that station.

Sometimes a pump station structure can house pumps pumping to more than one pres-
sure zone (e.g. medium service and high service). For the purposes of Bentley
HAMMER, 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.

4-228 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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:

New—Creates a new row in the table.

Delete—Deletes the currently highlighted row from the table.

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 Bentley HAMMER V8i:

Valve Type Description

Pressure Reducing PRVs throttle to prevent the downstream hydraulic

Valve (PRV) 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 A Pressure Sustaining Valve (PSV) is used to

Valve (PSV) 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 PBVs are used to force a specified pressure (head)

Valve (PBV) 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.

Bentley HAMMER V8i Edition User’s Guide 4-229

Elements and Element Attributes

Valve Type Description

Flow Control Valve FCVs are used to limit the maximum flow rate
(FCV) 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).

Throttle Control Valve TCVs are used as controlled minor losses. A TCV
(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 don’t 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 GPVs are used to model situations and devices
(GPV) 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
pipe’s 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.

4-230 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Applying a Zone to a Valve

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 Zones on page 4-349.

To Apply a Previously Created Zone to a Valve:

1. Select the valve in the Drawing View.

2. In the Properties window, click the menu in the Zone field and select the zone
you want.

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.

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:

Bentley HAMMER V8i Edition User’s Guide 4-231

Elements and Element Attributes

a. 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.
b. 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 Prop-
erty Editor.
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.

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.

4-232 Bentley HAMMER V8i Edition User’s Guide

 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 head-
loss 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

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.

Bentley HAMMER V8i Edition User’s Guide 4-233

Elements and Element Attributes

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 Bentley HAMMER 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 Charateristics 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:

4-234 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

New Creates a new valve characteristic

definition.

Duplicate Creates a copy of the currently highlighted

valve characteristic definition.

Delete Deletes the valve characteristic definition

that is currently highlighted in the list pane.
You can hold down the Ctrl key while
clicking on items in the list to select multiple
entries at once.

Rename Renames the valve characteristic definition

that is currently highlighted in the list pane.

Report Opens a report of the data associated with

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

Synchronization Browses the Engineering Library,

Options synchronizes to or from the library, imports
from the library or exports to the library.

The tab section is used to define the settings for the minor loss that is currently high-
lighted in the valve characteristic list pane. The following controls are available:

Valve Characteristic This tab consists of input data fields that allow you
Tab 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 The discharge coefficient of the valve relative to

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

Bentley HAMMER V8i Edition User’s Guide 4-235

Elements and Element Attributes

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
details will display the message Orphan (local),
indicating that the valve characteristic 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
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).
• 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 coeffi-
cient) and 0% represents a discharge coefficient of zero (fully closed).

4-236 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Click New to add a new row to the table. Click Delete to remove the currently high-
lighted row from the table. You can hold down the Ctrl key while clicking on items in
the list to select multiple entries at once.

Setting the Initial Relative Closure of a TCV

You can specify the relative closure of a TCV (Throttle Control Valve) at the start of a
transient simulation. The relative closure is defined by the percentage entered in the
Relative Closure (Initial Transient) field. A relative closure of 0% means that the
valve is 0% closed, or fully open. A relative closure of 100% means the valve is 100%
closed, or 0% open. This field will not be available if the Specify Initial Conditions?
Transient Solver Calculation Option is set to False.

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 Bentley HAMMER 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.

Bentley HAMMER V8i Edition User’s Guide 4-237

Elements and Element Attributes

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 Tran-
sient" 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 reason-
able initial estimate may be on the order of 0.1.

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 insta-
bility in HAMMER.

4-238 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 prop-
erty "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.Last-
Name\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 "Oper-
ating 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

In a hydroelectric power plant, turbines convert the moving water’s 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 diam-
eter decreases) as it approaches the turbine. Most of the turbine's rotational energy

Bentley HAMMER V8i Edition User’s Guide 4-239

Elements and Element Attributes

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.

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 catego-
ries: a) impulse turbine, and b) reaction turbine.

4-240 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 defini-
tion of an impulse turbine is that there is no change in pressure across the runner.

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.

Bentley HAMMER V8i Edition User’s Guide 4-241

Elements and Element Attributes

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 varia-
tions on the generator and opens or closes the wicket gates to stabilize the system (by
matching electrical output to grid load).

Transient Tip: 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.

The runner must always be full to keep losses to a minimum, in contrast to an impulse
turbine where only a few of the runner blades are in use at any moment. Therefore,
reaction turbines can handle a larger flow for a given runner size. The number of
runner blades varies with the hydraulic head–the higher the head the more blades.

Reaction turbines are classified according to the direction of flow through the runner.
In a radial-flow turbine, the flow path is mainly in the plane of rotation: water enters
the rotator at one radius and leaves at a different radius–the Francis turbine being an
example of this type. In an axial-flow turbine, the main flow direction is parallel to the
axis of rotation – the Kaplan turbine being an example of this type. The term: mixed
flow turbine is used when flow is partly radial and partly axial.

4-242 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Each of these categories corresponds to a range of specific speeds that can be calcu-
lated 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
N = Rotational speed
I = Rotational Inertia
w = Wicket gate position (% open)
M = Electrical load or torque

Bentley HAMMER V8i Edition User’s Guide 4-243

Elements and Element Attributes

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.

4-244 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

Table 4-4: Load and Wicket Gate Changes for Load Rejection

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

Bentley HAMMER V8i Edition User’s Guide 4-245

Elements and Element Attributes

During instant load rejection, the generation of electrical power by the turbine-gener-
ator 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..

Table 4-5: 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 elec-
trical 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. .

Table 4-6: Wicket Gate Changes for Full Load Acceptance

Time (s) Wicket Gate Position (%)

0 0

1 50

2 100

4-246 Bentley HAMMER V8i Edition User’s Guide

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

Table 4-7: Wicket Gate Changes for General Load Variation

Time (s) Wicket Gate Position (%)

0 100

5 85

10 70

15 57

20 43

30 30

35 35

42 42

Bentley HAMMER V8i Edition User’s Guide 4-247

Elements and Element Attributes

Table 4-7: Wicket Gate Changes for General Load Variation

Time (s) Wicket Gate Position (%)

55 57

65 70

80 85

90 100

Turbine Parameters in HAMMER

Note: These attributes are used by HAMMER only.

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 fluid’s
energy head. Bentley HAMMER V8i provides a single but very powerful turbine
representation:

• Turbine between 2 Pipes—A 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 Bentley HAMMER 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: instan-
taneous 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.

4-248 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

– 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). You can enter your
own four-quadrant data in the XML library (Appendix B).
The equation to estimate specific speed for a turbine is as follows:
5---
0.5 4
ns = n  p H
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 asso-
ciated with the turbine curve for the associated turbine element. The turbine curve
represents the head-discharge relationship of the turbine at its rated speed.

Bentley HAMMER V8i Edition User’s Guide 4-249

Elements and Element Attributes

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.

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 simu-
lation.

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.

4-250 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 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 Time vs. Flow (or Head) data points for the Periodic Head-Flow curve.

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 subatmo-
spheric 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.

Bentley HAMMER V8i Edition User’s Guide 4-251

Elements and Element Attributes

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 down-
stream 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 Calculation Options for details - then manually
typing in values for the fields grouped under Transient Initial in
the Property Editor.

The following attributes describe the air valve behavior:

Note: The following are HAMMER attributes.

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

4-252 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

• Double Acting Air Valve Type:

– Air Volume (Initial): Volume of air near the valve at the start of the simula-
tion. 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 infi-
nite (i.e. there is no restriction to air inflow).
– Diameter (Air Outflow Orifice): Diameter of the air outflow orifice (the
orifice through which air is expelled from the pipeline). By default, this diam-
eter is considered infinite.

• Triple Acting Air Valve Type:

– Air Volume (Initial): Volume of air near the valve at the start of the simula-
tion. The default is zero. If volume is nonzero, the pressure must be zero.
– 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 pres-
sures. 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.

Bentley HAMMER V8i Edition User’s Guide 4-253

Elements and Element Attributes

– Diameter (Large Air Outflow Orifice): Refers to the discharge of air when
the local air volume is greater than or equal to the transition volume (TV), or
the air pressure is less than or equal to the transition pressure (TP) (depending
on which trigger is used to switch the outflow orifice size). This diameter is
typically large enough that there is little or no restriction to air outflow.
Generally air flows out the large air outflow orifice for some time before
switching to the small air outflow orifice for the final stages or air release.
– Diameter (Air Inflow Orifice): Diameter of the air inflow orifice (the orifice
through which air enters the pipeline when the pipe internal pressure is less
than atmospheric pressure). This diameter should be large enough to allow the
free entry of air into the pipeline. By default, this diameter is considered infi-
nite (i.e. there is no restriction to air inflow).

• Vacuum Breaker Air Valve Type:

– 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 infi-
nite (i.e. there is no restriction to air 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:

4-254 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

• 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 perfo-
rations 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 colli-
sion 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.

Here are some examples of when the Triple Acting air valve type would be used:

Bentley HAMMER V8i Edition User’s Guide 4-255

Elements and Element Attributes

• An air valve similar to the one seen in the above diagram, consisting of two open-
ings and a float. When the volume of air in the system becomes less than the "tran-
sition 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).

4-256 Bentley HAMMER V8i Edition User’s Guide

 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:

New Creates a new air flow curve.

Delete Deletes the air flow curve that is currently

highlighted in the list pane. You can hold
down the Ctrl key while clicking on items in
the list to select multiple entries at once.

Duplicate Creates a copy of the currently highlighted

air flow curve.

Rename Renames the air flow curve that is currently

highlighted in the list pane.

Report Opens a report of the data associated with

the air flow curve that is currently
highlighted in the list pane.

Synchronization Browses the Engineering Library,

Options synchronizes to or from the library, imports
from the library or exports to the library.

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.

Bentley HAMMER V8i Edition User’s Guide 4-257

Elements and Element Attributes

Pressure (Line) The pressure at the air flow curve point. Note that
only gauge pressure values are supported, not
absolute pressure.

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
details will display the message Orphan (local),
indicating that the curve 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
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:

4-258 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

• 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

A pressure vessel connected to the system and containing fluid in its lower portion and
a pressurized gas, usually air, in the top portion. A flexible and expandable bladder is
sometimes used to keep the gas and fluid separate. When the tank is being filled
(usually from a pump), the water volume increases and the air is compressed. When
the pump is turned off, the compressed air maintains pressure in the system until the
water drains and the pressure drops.

In Bentley HAMMER there are two ways of modeling water fluctuations in hydrop-
neumatic tanks during Steady State / EPS (initial conditions) simulations:

1. As an equivalent constant cross section area tank (Constant Area Approximation)

2. Using the ideal gas law (Gas Law Model)

The data requirements for each method differ. Both methods require:

1. Total tank volume

2. Initial HGL
3. Initial water volume
4. Controls set up for any pumps controlled by the tank HGL

The Constant area tank method also requires:

1. Effective tank volume

2. HGL on level
3. HGL off level

Bentley HAMMER V8i Edition User’s Guide 4-259

Elements and Element Attributes

The Gas law method requires

1. Atmospheric pressure (if differs from default)

When using the Constant Area Approximation method, you will need to know the
effective volume of the tank (usually between 30 and 50% of the total volume), and
the hydraulic grade line elevation corresponding to the maximum and minimum water
volumes. The values are referred to as the HGL on and HGL off values because the
feed pump turns off when the maximum effective volume is reached and turns on
when the minimum effective volume is reached. The effective cross sectional area of
an equivalent tank is given by

Area = Effective volume/(HGLoff - HGLon)

Note: Specifying these on and off HGL levels does not mean that
logical controls have been established. You must still set up
logical controls for the pumps feeding the tank and these control
levels should not be significantly different from the HGL on and
off levels.

The results from a steady state run are the flows in and out of the tanks. These results
should be the same for both the constant area and gas law tanks. The results of an EPS
run are the flow plus the HGL and pressure in the tank over time. These results will be
slightly different for each type of tank especially at very high and very low pressures,
provided that the effective volume is close to the actual effective volume that is physi-
cally possible given the control settings, gas volume and tank volume.

When using the Gas Law method, the tank is modeled using a form of the ideal gas
law for an isothermal fluid:

(P + Patm) Vair = K

Where:

P = gauge pressure
Patm = atmospheric pressure
Vair = volume of air in tank.
When using this method, you must specify the volume of liquid in the tank, the total
volume of the tanks and the initial pressure (or HGL). You can also override the
default atmospheric pressure of 32 ft.

Over the narrow range of pressures normally found in hydropneumatic tanks, the
constant area tank approximation and the gas law model give comparable results
although the gas law model is more theoretically correct. As the range of pressures
increases, the gas law model diverges from the constant area tank at high pressures.

4-260 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Note: Hydropneumatic tanks have a very short cycle time compared

with large tanks. Therefore, when hydropneumatic tanks are
used in a model, a very short hydraulic time step may be needed
or the tank may overshoot its on and off levels. If this occurs, the
hydraulic time step in the calculation options should be
reduced.

During a transient simulation there are two basic types of tank: (a) direct interface
between the liquid and gas, and (b) gas contained in a bladder. Both utilize the expan-
sion/contraction of a gas according to the gas law: P Vk = constant, where P is the
absolute pressure, V is the volume and the exponent k lies between 1.0 and 1.2. In the
case of (b), the initial volume is determined from the isothermal gas law, PV =
constant, for given values of preset pressure, tank volume and initial (gauge) pipe
pressure. At the mouth of the vessel, there is a differential orifice with head loss  H =
Hl - Hg = b d Q2 / (2g Aor2), where the subscripts l, g and or refer to the liquid, gas 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 asserts that head losses are di times greater for
inflow than for outflow - typical value of di is 2.5.

With respect to a bladder vessel, the pre-set pressure can range from zero gauge
(atmospheric pressure) to some higher pressure. Prior to and during a transient compu-
tation:

• HAMMER assumes the bladder is at the pre-set pressure but isolated from the
system.
• HAMMER assumes a (virtual) isolation valve is opened, such that the (typically
higher) system pressure is now felt by the bladder. HAMMER computes the new
(typically smaller) volume of the air inside the bladder.
• When the transient occurs, HAMMER expands or contracts the volume inside the
bladder accordingly.
• After the simulation is complete, you can look in the .RPT and/or .OUT text file(s)
to see what the preset pressure, pre-transient volume (at system pressure) and
subsequent variations in pressure and volume have occurred.
The tank type with a direct interface between the liquid and gas can be classified as
one of three different types: 'sealed', 'vented' or 'dipping tube'

A sealed hydropneumatic tank is simply a closed pressure vessel.

A vented hydropneumatic tank is effectively a sealed tank with the addition of an air
valve at the top. This allows air at atmospheric pressure to enter the tank during a
downsurge so that the device behaves like a one-way surge tank. During an upsurge,
the air valve typically throttles the air outflow so that the gas within the tank is

Bentley HAMMER V8i Edition User’s Guide 4-261

Elements and Element Attributes

compressed and acts as a 'cushion' against transients (just like a sealed hydropneu-
matic tank). This device offers several practical benefits - for example since the tank
typically has no gas inside, there is no need for compressors or a bladder to ensure a
required gas volume is maintained.

A dipping tube hydropneumatic tank has a dipping (or ventilation) tube inside with an
air valve at the top. During normal operation the air valve is closed, the water level is
above the bottom of the dipping tube, and gas is compressed in the 'compression
chamber'. If the hydraulic grade line drops (e.g. after a pump stop) the dipping tube
tank acts like a regular (sealed) hydropneumatic tank until the water surface drops
below the bottom of the dipping tube, after which the air valve opens and allows air to
enter at atmospheric pressure. At this point the tank is acting like a surge tank that is

4-262 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

open to atmosphere. If the hydraulic grade line increases again (e.g. if pumps come
on), air will be expelled until the hydraulic grade line rise enough to close the air
valve. At this point the water surface will be above the bottom of the dipping tube and
the tank will act like a regular sealed hydropneumatic tank once again.

Figure 4-1: Sealed Hydropneumatic Tank

Figure 4-2: Vented Hydropneumatic Tank

Bentley HAMMER V8i Edition User’s Guide 4-263

Elements and Element Attributes

Figure 4-3: Dipping Tube Hydropneumatic Tank

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.

4-264 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

• 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") during a tran-
sient simulation. When using a bladder tank, Bentley HAMMER 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.

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.

• 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. Corre-
sponding 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.

Bentley HAMMER V8i Edition User’s Guide 4-265

Elements and Element Attributes

Gas Law vs. Constant Area Approximation

For the initial conditions, you must select either "gas law" or "constant area approxi-
mation" 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 tran-
sient 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.

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.

4-266 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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

1.

Bentley HAMMER V8i Edition User’s Guide 4-267

Elements and Element Attributes

• Elevation (Bottom of Dipping Tube) - The elevation of the bottom of the

dipping tube.
Figure 4-4: Dipping Tube Hydropneumatic Tank Parameters

• 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.
• Ratio of Losses - This is the ratio of inflow to outflow headloss. For flows into
the tank (inflows), the "minor loss coefficient" is multiplied by this value and the
losses are computed using that. For flows out of the tank, HAMMER only uses the
"Minor Loss coefficient". So, if you enter a minor loss coefficient of 1.5 and a
ratio of losses of 2.5, the headloss coefficient used when the tank is filling would
be 1.5 X 2.5 = 3.75.
• Gas Law Exponent - refers to the exponent to be used in the gas law equation.
(the 'k' in PVk = constant) The usual range is 1.0 to 1.4. The default is 1.2.
• Volume of Gas (Initial) - When not using a bladder, the initial volume of gas is an
important attribute. This is a required input field, representing the volume of gas
inside the tank at the steady state pressure (initial conditions hydraulic grade
minus tank physical elevation). During the transient simulation, this gas volume
expands or compresses, depending on the transient pressures in the system. For

4-268 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

example, consider a 500 L tank with base elevation of 20 m and initial hydraulic
grade of 70 m. This means that the pressure head is ~50 m. So, the user needs to
decide how much space (volume) the entrapped gas pocket would take up, at this
pressure.

Note: If you are not specifying initial conditions and not treating the
tank as a junction, then the initial gas volume is not required and
the field will not show up. This is because it is either computed
from the initial conditions gas volume (which is the full tank
volume minus the initial liquid volume for a steady state) or
based on the preset pressure (if using the bladder option)

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", Bentley 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.

Bentley HAMMER V8i Edition User’s Guide 4-269

Elements and Element Attributes

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.

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 calcula-
tions 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 geom-
etry spanning the range from the pipe connection at the bottom to the top of the tank.

4-270 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

The variable level hydropneumatic tank type is for users who have detailed informa-
tion 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 rela-
tively 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 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 Liquid Elevation vs. Diameter (Equivalent) data points for the current
elevation curve.

Acces this dialog by setting the hydropneumatic tank’s Elevation Type to Variable
Elevation and by clicking the ellipsis button in the Variable Elelvation Curve field.

Bentley HAMMER V8i Edition User’s Guide 4-271

Elements and Element Attributes

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

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 acceler-
ation 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.

4-272 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 char-
acteristics (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 experi-
ence 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 down-
stream 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.

Bentley HAMMER V8i Edition User’s Guide 4-273

Elements and Element Attributes

Rupture Disks

A rupture disk node is located between two pipes. It is designed to fail when a speci-
fied 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.

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 infi-
nite for air. In this case, the air pocket respectively expands or contracts accord-
ingly 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 pres-
sure. 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 posi-
tive, 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

4-274 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 custom-
izable 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.

Bentley HAMMER V8i Edition User’s Guide 4-275

Elements and Element Attributes

Orifice Between Pipes Elements

This element represents a fixed-diameter orifice which breaks pressure, useful for
representing choke stations on high-head pipelines.

4-276 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 transforma-
tion.

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.

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
2
loss H = H – H T = bdQ   2gA 2  , where the subscripts T and or
or

Bentley HAMMER V8i Edition User’s Guide 4-277

Elements and Element Attributes

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.

4-278 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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

Bentley HAMMER V8i Edition User’s Guide 4-279

Elements and Element Attributes

no facility for a check valve to preclude inflow to the tank.

4-280 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Differential Surge Tanks

Bentley HAMMER V8i Edition User’s Guide 4-281

Elements and Element Attributes

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 over-
flow into the tank to complement the orifice flow.

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.

4-282 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

– 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 diam-
eter 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 Pipes—allows 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.
– Diameter is the size of the valve opening for inflow and outflow.

• SAV/SRV at End of 1 Pipe—represents 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:

Bentley HAMMER V8i Edition User’s Guide 4-283

Elements and Element Attributes

- 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 corre-
sponds 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 Pipes—operates 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 Bentley
HAMMER. Instead, this condition is modeled by not adding
negative inflows, but retaining the negative flow that is
predicted.

Other Tools

Although Bentley HAMMER 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. Bentley
HAMMER V8i itself (including Stand-Alone) provides the following graphical anno-
tation tools:

• Border tool
• Text tool
• Line tool.

4-284 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

You can add, move, and delete graphical annotations as you would with any network
element (see Manipulating Elements on page 4-301).

Border Tool
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

1. Click the Select tool in the Layout toolbox.

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.

Bentley HAMMER V8i Edition User’s Guide 4-285

Elements and Element Attributes

Line Tool
The Line tool is used to add lines and polylines (multi segmented lines) to the drawing
pane. Bentley HAMMER V8i can calculate the area inside a closed polyline. Exam-
ples 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

1. Click the Select tool in the Layout toolbox.

2. Right-click the polyline and select the Close command.

To Calculate the Area of a Closed Polyline

1. Click the Select tool in the Layout toolbox.

2. Right-click the polyline and select the Enclosed Area command.

To Add a Bend to an Existing Line or Polyline

1. Click the Select tool in the Layout toolbox.

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

1. Click the Select tool in the Layout toolbox.

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 Bentley HAMMER

The pump and turbine characteristics used in Bentley HAMMER are defined in the
following files:

4-286 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

• C:\Program Files\Bentley\<Product Name>8\QuadrantCurvesPredefined.txt

• C:\Program Files\Bentley\<roduct Name>8\QuadrantCurves.txt

The 'QuadrantCurvesPredefined.txt' file contains predefined pump and turbine charac-

teristics, 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 HAMMER 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:

*** HAMMER 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. HAMMER can then use these curves to calculate the
values of head and torque for any values of Q and N using homologous relations.

The data file format is given below - fields in italics need to be replaced with appro-
priate values:

SPECIFIC SPEED (US/SI): [Specific speed, US units] /

[Specific speed, SI units]

CURVE FORMAT: CircularFormat

Bentley HAMMER V8i Edition User’s Guide 4-287

Elements and Element Attributes

HEAD: NHD

QH,1 NH,1

QH,2 NH,2

. .

. .

QHNHD NH,NHD

TORQUE: NMD

QM,1 NM,1

QM,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 HAMMER 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.

4-288 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

An example of pump characteristics using this format is presented in the figure below:

Bentley HAMMER V8i Edition User’s Guide 4-289

Elements and Element Attributes

4-290 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Suter Format

An alternative file format uses a method attributed to Suter, described in Fluid Tran-
sients (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:

Where h v   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: SuterFormat

HEAD: NHD

x1 WH1

x2 WH2

. .

. .

xNHD WHNHD

TORQUE: NMD

x1 WB1

x2 WB2

Bentley HAMMER V8i Edition User’s Guide 4-291

Elements and Element Attributes

. .

. .

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 HAMMER
engine, WH(x) and WB(x) can approach, but should never equal, zero (minimum
values of 0.0001 are suggested for both functions).

4-292 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

An example of pump characteristics entered using this format is given in the figure

Bentley HAMMER V8i Edition User’s Guide 4-293

Elements and Element Attributes

below:

4-294 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Bentley HAMMER V8i Edition User’s Guide 4-295

Elements and Element Attributes

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 HAMMER 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: NG

GATE: WG1 ND1

H1,1 Q1,1 P1,1

H1,2 Q1,2 P1,2

. . .

. . .

H1,ND1 Q1,ND1 P1,ND1

. . .

. . .

GATE: WGNG NDNG

HNG,1 QNG,1 PNG,1

HNG,2 QNG,2 PNG,2

. . .

. . .

HNG,NDNG QNG,NDNG PNG,NDNG

4-296 Bentley HAMMER V8i Edition User’s Guide

 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,
HAMMER currently assumes a linear decrease in flow until the time the gate opening
equals 0%.

Bentley HAMMER V8i Edition User’s Guide 4-297

Elements and Element Attributes

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

4-298 Bentley HAMMER V8i Edition User’s Guide

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

2. Browse to C:\Program Files\Bentley\HAMMER8 and open the Quadrant-
Curves.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 HAMMER, 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, HAMMER 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). HAMMER
will now use the user-defined turbine characteristics in the calculations.

How The Pressure Engine Loads Bentley HAMMER Elements

The pressure engine models the various HAMMER 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" prop-
erty is set to False, the air valve is loaded such that it opens the system to atmo-
sphere. 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.

Bentley HAMMER V8i Edition User’s Guide 4-299

Adding Elements to Your Model

• 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 coeffi-
cient 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.

Adding Elements to Your Model

Bentley HAMMER 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

4-300 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

Layout Tool

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 elements—Manually 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.
• Move elements—Move elements in the drawing pane. See Select, Move, and
Delete Elements.
• Delete elements—Remove elements from the model. See Select, Move, and
Delete Elements.
• Split pipes—Split an existing pipe into two new pipes by adding a new node
element along the existing pipe. See Splitting Pipes.
• Reconnect pipes—Disconnect an exisiting pipe from an existing node element
and attach it to another existing node element. See Reconnect Pipes.
• Model curved pipes—You can lay out curved pipes. See Modeling Curved Pipes.

Bentley HAMMER V8i Edition User’s Guide 4-301

Manipulating Elements

• Assign isolation valves to pipes—This 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.
• Batch split pipes—This tool allows you to split pipes with neighboring nodes that
are found within the specified tolerance. See Batch Pipe Split Dialog Box.
• Batch morph nodes—This tool allows you to morph a selected node type into
another type of node element as a batch operation. See Batch Morph.
• Merge nodes in close proximity—allows you to merge together nodes that fall
within a specified tolerance of one another. See Merge Nodes in Close Proximity.
• Select links adjacent to one or more nodes—This command lets you select all link
elements attached to one or more nodes. See Select Adjacent Links.

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

4-302 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

Bentley HAMMER V8i Edition User’s Guide 4-303

Manipulating Elements

To clear selected elements

Select Tool

Click the Select tool then click any blank space in the drawing pane.

or

Click Edit > Clear Selection.

or

Press the Esc key.

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.

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-304 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

– 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).
– 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, 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).

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.

Modeling Curved Pipes

You can model curved pipes in Bentley HAMMER by using the Bend command,
which is available by right-clicking in the Drawing Pane when placing a link element.

Bentley HAMMER 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.

Bentley HAMMER V8i Edition User’s Guide 4-305

Manipulating Elements

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.

Polyline Vertices Dialog Box

This dialog box contains the X vs. Y table that allows you to define any number of
points that plot the shape of the polyline representing the selected link element. 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.

Assign Isolation Valves to Pipes Dialog Box

The Assign Isolation Valves to Pipes tool finds the nearest pipe for each of the speci-
fied isolation valves and assigns the valve to that pipe.

4-306 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Choose Features to Allows you to specify which isolation valves to

Process include in the assignment operation. The
following options are available:
• All: All isolation valves within the model 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.

Also process isolation When this box is checked, the assign operation
valves that already will also assign to the nearest pipe those valves
have an associated pipe that are already assigned to a pipe.

Allow assignment to When this box is checked, pipes that are marked
inactive pipes 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:

Bentley HAMMER V8i Edition User’s Guide 4-307

Manipulating Elements

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.

Choose Features to Allows you to specify which pipes to include in

Process the split operation. The following options are
available:
• All: All pipes in the model that have a neigh-
boring 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 speci-
fied 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 When this box is checked, nodes that are marked
inactive nodes 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 Navigator’s “Network Review >
Pipe Split Candidates” query to verify that the tolerance you intend to use for the
Batch Split operation will not include nodes that you do not want involved in the pipe
split operation.

4-308 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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

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.
a. 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 appro-
priate tolerance (feel free to run the query multiple times to settle on a toler-
ance 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 opera-
tion).
b. 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.

Bentley HAMMER V8i Edition User’s Guide 4-309

Manipulating Elements

c. After reviewing the entire list, use the network navigator "select in drawing"
tool to select the elements you would like to process.
d. 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.

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 speci-
fied 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.

4-310 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

To access the dialog, right-click one of the nodes to be merged and select the Merge
nodes in close proximity command.

The dialog consists of the following controls:

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 avail-
able 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.

Bentley HAMMER V8i Edition User’s Guide 4-311

Editing Element Attributes

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

This command allows you to select all link elements attached to one or more nodes.

To find all links adjacent to a single node, right-click the node and click the Select
Adjacent Links command.

You can also find all links adjacent to a group of selected nodes; with multiple nodes
selected in the drawing view, right-click one of them and click the Select Adjacent
Links command.

Editing Element Attributes

You edit element properties in the Property Editor, one of the dock-able managers in
Bentley HAMMER.

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.

4-312 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Attributes displayed in the Property Editor are grouped into categories. An expanded
category can be collapsed by clicking the minus (-) button next to the category
heading. A collapsed category can be expanded by clicking the plus (+) button next to
the category heading.

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 is used to:

• 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 char-
acter. For example, if you want to find all of the pipes in your model, you type co*
(this is not case-sensitive) then click the Find button. The drawing pane centers
around and highlights the first instance of a pipe in your model, and lists all pipes
in your model in the Element menu. For more information about using wildcards,
see Using the Like Operator.
• * and # are wildcard characters. If the element(s) you are looking for contains one
or more of those characters, you will need to enclose the search term in brackets: [
and ].
• If Find returns multiple results then Network Navigator automatically opens.

Bentley HAMMER V8i Edition User’s Guide 4-313

Editing Element Attributes

The following controls are included:

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.

4-314 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Property Search
You can search for a specific attribute by typing the name of the attribute into the

search box and clicking the Search button .

When you have entered one or more search terms, only those properties containing the
search term will be displayed in the property editor.

When the box contains search terms the Search button turns to a Clear button .
Click this button to clear the terms from the search box.

To match multiple items, enter the desired list of terms separated by semicolon
without spaces in between.

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.

Bentley HAMMER V8i Edition User’s Guide 4-315

Editing Element Attributes

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.

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 preci-
sion 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 nega-
tive. 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.

4-316 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

• 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

The Named View dialog box is where you can store the current views X and Y coordi-
nates. 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.

Bentley HAMMER V8i Edition User’s Guide 4-317

Using Named Views

The toolbar contains the following controls:

New Contains the following commands:

• Named View—Opens a Named View
Properties box to create a new named
view.
• Folder—Opens a Named Views Folder
Properties box to enter a label for the
new folder.

Delete Deletes the named view or folder that is

currently selected.

Rename Rename the currently selected named view

or folder.

Go to View Centers the drawing pane on the named

view.

Update Named Updates the currently highlighted view

View using the current view in the drawing pane.

Shift Up and Shift Moves the selected named view or folder up

Down or down.

Expand All or Expands or collapses the named views and

Collapse All folders.

Help Displays online help for Named Views.

4-318 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

Bentley HAMMER contains powerful features that let you view or analyze subsets of
your entire model. You can find these elements using the Network Navigator (see
Using the Network Navigator). The Network Navigator is used to 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 Query 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.

You can perform the following operations with selection sets:

• To view elements in a Selection Set on page 4-322

• To Create a Selection Set from a Selection on page 4-323
• To create a Selection Set from a Query on page 4-323
• To add elements to a Selection Set on page 4-324
• To remove elements from a Selection Set on page 4-325

Bentley HAMMER V8i Edition User’s Guide 4-319

Using Selection Sets

Selection Sets Manager

The Selection Sets Manager is used 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.

To open Selection Sets, click the View menu and select the Selection Sets command,

press <Ctrl+4>, or click the Selection Sets button on the View toolbar.

4-320 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 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. You can hold down the
Ctrl key while clicking on items in the list to
select multiple entries at once.

Duplicate Copies the Selection Set that is selected.

Bentley HAMMER V8i Edition User’s Guide 4-321

Using Selection Sets

Edit • When a selection-based selection set is

highlighted and you click this button, it
opens the Selection Set Element
Removal dialog box, which edits 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 and you click this button, it
opens the Selection By Query dialog
box, which adds or removes queries
from the selection set. This command is
also available from the short-cut menu,
which you can access by right-clicking
an item in the list pane.

Rename Renames 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 Selects all the elements in the drawing pane

that are part of the currently selected
selection sets. 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.

4-322 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Tip: 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 selec-
tion 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 selec-
tion set.
4. Alternatively, you can open the Selection Set manager and click the New button
and select Create from Selection. Bentley HAMMER V8i 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.

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.

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:

Bentley HAMMER V8i Edition User’s Guide 4-323

Using Selection Sets

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 Select or clear queries to be used in the selection

Buttons set:
• [ > ] Adds the selected items from the Avail-
able 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.

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.

4-324 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.
3. In the Add to Selection Set dialog box, select the selection set to which you want
to add the element.
4. Click OK to close the dialog box and add the element to the selected selection set.
Click Cancel to close the dialog box without creating the selection set.

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.

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.

Bentley HAMMER V8i Edition User’s Guide 4-325

Using the Network Navigator

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.

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.

4-326 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

To open the Network Navigator, click the View menu and select the Network Navi-

gator command, press <Ctrl+3>, or click the Network Navigator button on the
View toolbar.

The following controls are included in Network Navigator:

Query Selection Choose the element sets to use in the query.

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

Execute Click to run the selected query.

Previous Zooms the drawing pane view to the

selected element at the magnification level
specified in the Zoom Level menu.

Zoom To Chooses the element below the currently

selected one in the list.

Bentley HAMMER V8i Edition User’s Guide 4-327

Using the Network Navigator

Next Specifies the magnification level at which

elements are displayed in the drawing pane
when the Zoom To command is initiated.

Copy Copies the elements to the Windows

clipboard.

Remove Removes the selected element from the list.

Select In Drawing Selects the listed elements in the drawing

pane and performs a zoom extent based on
the selection.

Highlight When this toggle button is on, elements

returned by a query will be highlighted in
the drawing pane to increase their visibility.

Refresh Drawing Refreshes the current selection.

Help Opens Bentley HAMMER 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

Network queries include “All Elements” queries for each element type, allowing you
to display all elements of any type in the Network Navigator.

4-328 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 down-
stream of the selected element or elements.
• Find Adjacent Links - Locates all link elements connected upstream or down-
stream 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.

Bentley HAMMER V8i Edition User’s Guide 4-329

Using the Network Navigator

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

4-330 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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

Bentley HAMMER V8i Edition User’s Guide 4-331

Using the Network Navigator

Using the Duplicate Labels Query

Bentley HAMMER 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.

This opens the following dialog where the user can control the behavior of the query:

4-332 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 pres-
sure zone and assigning that zone to every node element in the pressure zone. Zones
are further described here: Zones)

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

Bentley HAMMER V8i Edition User’s Guide 4-333

Using the Pressure Zone Manager

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 ground-
water 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.

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

4-334 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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

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.

Bentley HAMMER V8i Edition User’s Guide 4-335

Using the Pressure Zone Manager

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.

4-336 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Upon picking the green check mark, the Zone Scope dialog opens again, displaying
the elements selected.

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

Bentley HAMMER V8i Edition User’s Guide 4-337

Using the Pressure Zone Manager

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

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

4-338 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 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 and nodes 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 pres-
sure zones based on representative elements.

The options at the bottom of the dialog control whether the Zone assignments that will
be made will overwrite existing Zone assignments.

Bentley HAMMER V8i Edition User’s Guide 4-339

Using the Pressure Zone Manager

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 tanks and reser-
voirs 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

4-340 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

Color Coding by Pressure Zone

Bentley HAMMER V8i Edition User’s Guide 4-341

Using the Pressure Zone Manager

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.

Other Pressure Zone Results

Other buttons such as Report, Refresh, Export to Selection Set, Zoom to and Copy
behave as they do for other Bentley HAMMER features.

The results of a pressure zone analysis as stored in a .pzs file.

4-342 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Pressure Zone Export Dialog Box

This dialog allows you to associate pressure zones with zones using representative
elements.

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. Addi-
tionally, 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 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).

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.

Bentley HAMMER V8i Edition User’s Guide 4-343

Using the Pressure Zone Manager

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.

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 containg all of the
data displayed in the tabels.

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.

4-344 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 12-inch pipes, use the Prototype
manager to set the Pipe Diameter field to 12 inches. When you create a new pipe in
your model, its diameter attribute will default to 12 inches.

You can create prototypes in either of the following ways:

• From the Prototypes manager: The Prototypes manager consists of a toolbar and a
list pane, which displays all of the elements available in Bentley HAMMER.
• From the Drawing Pane: Right-click an element to use the settings and attributes
of that element as the current prototype.

Bentley HAMMER V8i Edition User’s Guide 4-345

Using Prototypes

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.

To open the Prototypes manager

Choose View > Prototypes

or

Press <Ctrl+6>

or

Click the Prototypes icon from the View toolbar.

The Prototypes manager opens.

4-346 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

The list of elements in the Prototypes manager list pane is expandable and collapsible,
once you’ve created additional prototypes. Click on the Plus sign to expand an
element and see its associated prototypes. Click on the Minus sign to collapse the
element.

Each element in the list pane contains a default prototype; you cannot edit this default
prototype. The default prototypes contain common values for each element type; if
you add elements to your model without creating new prototypes, the data values in
the default prototypes appear in the Property Editor for that element type.

The toolbar contains the following icons:

New Creates a new prototype of the selected

element.

Delete Deletes the prototype that is currently

selected in the list pane.

Rename Renames the prototype that is currently

selected in the list pane.

Make Current Makes the prototype that is currently

highlighted in the list pane the default for
that element type. When you make the
current prototype the default, every new
element of that type that you add to your
model in the current project will contain the
same common data as the prototype.

Bentley HAMMER V8i Edition User’s Guide 4-347

Using Prototypes

Report Opens a report of the data associated with

the prototype that is currently highlighted in
the list pane.

Expand All Opens all the Prototypes.

Collapse All Closes all the Prototypes.

Help Displays online help for the Prototypes

Manager.

To create Prototypes in the Prototypes Manager

1. Open your Bentley HAMMER project or start a new project.

2. Choose View > Prototypes or press <Ctrl+6>.
The Prototypes Manager opens.

3. Select the element type for which you want to create a prototype, then click New.

4-348 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

The list expands to display all the prototypes that exist for that element type.
Each element type contains a default prototype, which is not editable, and any
prototypes that you have created. The current set of default values for each
element type is identified by the Make Current icon.

4. Double-click the prototype you just created. The Property Editor for the element
type opens.
5. Edit the attribute values in the Property Editor as required.
6. To make the new prototype the default, click the Make Current button in the
Prototypes Manager.
The icon next to the prototype changes to indicate that the values in the prototype
will be applied to all new elements of that type that you add to your current
project.
7. Perform the following optional steps:
– To rename a prototype, select the prototype in the list and click the Rename
button.
– To delete a prototype, select the prototype in the list and click the Delete
button.
– To view a report of the default values in the prototype, select the prototype in
the list and click the Report button.

To create a Prototype from the Drawing View

1. Right-click the element you want to act as the current proptotype for newly
created elements of that type.
2. Select Create Prototype from the context menu.
3. Enter a name for the new prototype in the Create New Prototype dialog that
appears.
4. Click OK.

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

Bentley HAMMER V8i Edition User’s Guide 4-349

Zones

or

Click the Zones icon from the Components toolbar.

The Zones manager opens.

The toolbar contains the following icons:

New—Adds a new zone to the zone list.

Duplicate—Creates a copy of an existing zone.

Delete—Deletes 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.

4-350 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Engineering Libraries
Engineering Libraries are powerful and flexible tools that you use to manage specifi-
cations of common materials, objects, or components that are shared across projects.
Some examples of objects that are specified through engineering libraries include
constituents, pipe materials, patterns, and pump definitions.

You can modify engineering libraries and the items they contain by using the Engi-
neering Libraries command in the Components menu.

You work with engineering libraries and the items they contain in the Engineering
Libraries dialog box, which contains all of the project’s engineering libraries. Indi-
vidual libraries are compilations of library entries along with their attributes.

By default, each project you create in Bentley HAMMER 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 synchro-
nized based on their label. If the label is the same, then the item’s values will be made
the same.

Bentley HAMMER V8i Edition User’s Guide 4-351

Engineering Libraries

The default libraries that are installed with Bentley HAMMER 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.

Note: The data for each engineering library is stored in an XML file in
your Bentley HAMMER V8i program directory. We strongly
recommend that you edit these files only using the built-in tools
available by selecting Tools > Engineering Libraries.

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.

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 Adds an existing engineering library that has been
stored on your hard drive as an .xml file to the
current project.

ProjectWise Add Adds an existing engineering library that is being

Existing Library managed by ProjectWise.

4-352 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Working with Categories

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 Saves the currently highlighted category as an

.xml file that can then be used in future projects.

ProjectWise Save As Saves the currently highlighted category to

ProjectWise.

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 Renames 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 Renames the currently highlighted entry.

Delete Deletes the currently highlighted entry from the

library.

Bentley HAMMER V8i Edition User’s Guide 4-353

Engineering Libraries

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 icons above the explorer tree
view pane:

New Opens a submenu containing the following

commands:
• Create Library—Creates a new engi-
neering library.
• Add Existing Library—Adds an
existing engineering library that has
been stored on your hard drive as an
.xml file to the current project.
• ProjectWise Add Existing Library—
Adds an existing engineering library that
is being managed by ProjectWise.

Delete Removes the currently highlighted

engineering library from the current project.

Rename Renames the currently highlighted

engineering library.

Sharing Engineering Libraries On a Network

You can share engineering libraries with other Bentley HAMMER users in your orga-
nization by storing the engineering libraries on a network drive. All users who will
have access to the shared engineering library should have read-write access to the
network folder in which the library is located.

To share an engineering library on a network, open the Engineering Libraries in

Bentley HAMMER and create a new library in a network folder to which all users
have read-write access.

4-354 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Transient Valve Curve Editor

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:

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

Bentley HAMMER V8i Edition User’s Guide 4-355

Engineering Libraries

Transient Pump Curve Editor

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:

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

4-356 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Transient Turbine Curve Editor

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.

• Relative Gate Opening—The percentage compared to fully open for the turbine
gate opening at the associated time step point.

Bentley HAMMER V8i Edition User’s Guide 4-357

Hyperlinks

Valve Relative Closure Curve Editor

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:

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

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, choose Tools > Hyperlinks. The Hyperlinks dialog box opens. The
dialog box contains a toolbar and a tabular view of all your hyperlinks.

4-358 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

The toolbar contains the following icons:

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.

Bentley HAMMER V8i Edition User’s Guide 4-359

Hyperlinks

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.

Add Hyperlink Dialog Box

New hyperlinks are created in this dialog box.

The Add Hyperlinks dialog box has 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.

4-360 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 Dialog Box

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.

Bentley HAMMER V8i Edition User’s Guide 4-361

Hyperlinks

To Add a Hyperlink

1. Choose 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.

4-362 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

Bentley HAMMER V8i Edition User’s Guide 4-363

Hyperlinks

To Edit a Hyperlink

1. Choose 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

4-364 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

Bentley HAMMER V8i Edition User’s Guide 4-365

Using Queries

Note: Click to open the Add or Edit dialog boxes and click Launch to
open from there.

Using Queries
A query in Bentley HAMMER 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 queries—Queries you define that are available only in the Bentley
HAMMER V8i project in which you define them.
• Shared queries—Queries you define that are available in all Bentley HAMMER
V8i projects you create. You can edit shared queries.
• Predefined queries—Factory-defined queries included with Bentley HAMMER
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. For more informa-
tion, see To create a Selection Set from a Query.
• Filter the data in a FlexTable using a query. For more information, see Sorting and
Filtering FlexTable Data.
• You can use predefined queries in the Network Navigator. See Using the Network
Navigator for more details.

For more information on how to construct queries, see Creating Queries.

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.

4-366 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

The Queries manager consists of a toolbar and a tree view, which displays all of the
queries that are associated with the current project.

Bentley HAMMER V8i Edition User’s Guide 4-367

Using Queries

The toolbar contains the following icons:

New Contains the following commands:

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

Delete Deletes the currently-highlighted query or

folder from the tree view. When you delete a
folder, you also delete all of the queries it
contains.

Rename Renames the query or folder that is currently

highlighted in the tree view.

Edit Opens the Query Builder dialog box,

allowing you to edit the SQL expression that
makes up the currently-highlighted query.

4-368 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Expand Opens all the Queries within all of the

All folders.

Collapse Closes all the Query folders.

All

Select in Opens a submenu containing the following

Drawing options:
• Select in Drawing—Selects the
element or elements that satisfy 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.

Help Displays online help for the Query Manager.

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 Toler-
ance parameter to be defined.

Bentley HAMMER V8i Edition User’s Guide 4-369

Using Queries

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 Query Manager. You also use queries to filter
FlexTables and as the basis for a selection set.

To create a query from the Query manager

1. Choose View > Queries or click the Queries icon on the View toolbar, or press
<CTRL+5>.
2. Perform one of the following steps:
– To create a new project query, highlight Queries - Project in the list pane,
then click the New button and select Query.
– To create a new shared query, highlight Queries - Shared in the list pane,
then click the New button and select Query.

Note: You can also right-click an existing item or folder in the list pane
and select New > Query from the shortcut menu.

3. In the Select Element Type dialog box, select the desired element type from the
drop-down menu. 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:
a. Double-click the field you wish to include in your query. The database
column name of the selected field appears in the preview pane.
b. Click the desired operator or keyword button. The SQL operator or keyword
is added to the SQL expression in the preview pane.
c. 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).
d. Double-click the unique value you want to add to the query. The value is
added to the SQL expression in the preview pane.

Note: You can also manually edit the expression in the preview pane.

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

4-370 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

f. Click the Apply button above the preview pane to execute the query. If you
didn’t validate the expression, the Apply button validates it before executing
it.
g. Click OK.

5. Perform these optional steps in the Query Manager:

– 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.
– 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).
– To rename an existing query or folder, click the Rename button, then type a
new name.
– 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 opens.
– To quickly select all the elements in the drawing pane that are part of the
currently highlighted query, click the Select in Drawing button.

Example Query

To create a query that finds all pipes with a diameter greater than 8 inches and less
than or equal to 12 inches you would do the following:

1. In the Queries dialog, click the New button and select Query.
2. In the Queries - Select Element Type dialog, select Pipe and click OK.
3. In the Query Builder dialog, click the () (Parentheses) button.
4. Double-click Diameter in the Fields list.
5. Click the > (Greater Than) button.
6. Click the Refresh button above the Unique Values list. Double-click the value 8.
7. In the Preview Pane, click to the right of the closing parenthesis.
8. Click the And button.
9. Click the () (Parentheses) button.
10. Double-click Diameter in the Fields list.
11. Click the <= (Less Than or Equal To) button.
12. Double-click the value 12 in the Unique Values list.

Bentley HAMMER V8i Edition User’s Guide 4-371

Using Queries

The final query will look like this:

(Physical_PipeDiameter > 8) AND (Physical_PipeDiameter <= 12)

See Using the Like Operator for more examples of query usage and syntax.

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 Query 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, an
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.

See Using the Like Operator for some examples of query usage and syntax.

4-372 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

Unique Values When you click the Refresh button, this

list displays all the available unique
values for the 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.

Bentley HAMMER V8i Edition User’s Guide 4-373

Using Queries

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.

4-374 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Validate on OK Turn on to validate the SQL expression in

the preview pane. If the expression is not
valid, a message appears. When you turn
on 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 the 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/or keywords, and
values to it.

Action Allows you to select the operation to be

performed on the elements returned by the
query defined in the Preview pane. The
following choices are available:
• Create New Selection—Creates a
new selection containing the elements
returned by the query.
• Add to Current Selection—Adds the
elements returned by the query to the
current selection.
• Remove from Current Selection—
Removes the elements returned by
the query from the current selection.
• Select Within Current Selection—
Selects the element or elements that
both satisfy the current query and are
already selected in the Drawing Pane.
This control is only available when the
Query Builder is accessed from the
command Edit > Select By Attribute.

Bentley HAMMER V8i Edition User’s Guide 4-375

User Data Extensions

Note: If you receive a Query Syntax Error message notifying you that
the query has too few parameters, check the field name you
entered for typos. This message is triggered when the field name
is not recognized.

Using the Like Operator

The LIKE operator does a pattern matching comparison. The operand to the right of
the LIKE operator contains the pattern and the left hand operand contains the string to
match against the pattern. A percent symbol ("%") in the LIKE pattern matches any
sequence of zero or more characters in the string. An underscore ("_") in the LIKE
pattern matches any single character in the string. Any other character matches itself
or its lower/upper case equivalent (i.e. case-insensitive matching).

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.

4-376 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 properties pane on the right, enter the following:
– 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.
– 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.
– 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.
– 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.
– 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.
– 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.
– Select a data type from the drop-down menu in the Data Type field.
- If you select Enumerated, an Ellipses (...) button appears in the Default
Value field. Enumerated user data extensions are fields that present
multiple choices.
– 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.

5. Perform the following optional steps:

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

Bentley HAMMER V8i Edition User’s Guide 4-377

User Data Extensions

– 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. For more information, see Sharing User Data Extensions Among
Element Types on page 4-383.
– 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.
– To rename 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.
– To expand the list of elements and view all user data extensions, click the
Expand All button.
– To collapse the list of elements so that no user data extensions are displayed,
click the Collapse All button.
6. 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.

4-378 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 Bentley HAMMER element types, and a property editor.

Bentley HAMMER V8i Edition User’s Guide 4-379

User Data Extensions

The toolbar contains the following controls:

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 4-
383.

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.

4-380 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

The property editor section of the dialog contains following fields, which define your
new user data extension:

Attribute Description

General

Name The unique identifier for the field. The name field in the
Property Editor is the name of the column in the data source.

Label The label that will appear next to the field for the user data
extension in the Property Editor for the selected element type.
This is also the column heading if the data extension is
selected to appear in a FlexTable.

Category The section in the Property Editor for the selected element
type in which the new field will appear. You can create a new
category or use an existing category. For example, you can
create a new field for junctions and display it in the Physical
section of that element’s Property Editor.

Field Order The display order of fields within a particular category in the
Index 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 The description of the field. This description will appear at the
Description 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 Displays all the element types that are using the field. For
By 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".

Bentley HAMMER V8i Edition User’s Guide 4-381

User Data Extensions

Attribute Description

Units

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 4-385.

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 Selects a number format for the field. Click the drop-down
Formatter 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.

4-382 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Sharing User Data Extensions Among Element Types

You can share user data extensions across multiple element types in Bentley
HAMMER. 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:

• 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 you do not want to share the field 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 tank and pipe 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.

Bentley HAMMER V8i Edition User’s Guide 4-383

User Data Extensions

To share a user data extension

1. Open the User Data Extensions dialog box by selecting Tools > User Data Exten-
sions.
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.

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.

4-384 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

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:

• New—Adds a new row to the table. Each row in the table represents a unique
enumerated member of the current user data extension.
• Delete—Deletes the current row from the table. The enumerated member defined
in that row is deleted from the user data extension.

Bentley HAMMER V8i Edition User’s Guide 4-385

User Data Extensions

Define enumerated members in the table, which contains the following columns:

• Enumeration Member Display Label—The label of the member. This is the

label you will see in Bentley HAMMER wherever the user data extension appears
(Property Editor, FlexTables, etc.).
• Enumeration Value—A unique integer index associated with the member label.
Bentley HAMMER 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.

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 in the following table.

4-386 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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 fomula.
Click the appropriate button to add the
operator to the end of your formula ,
which is displayed in the preview pane.
Besides the common options for options
for adding, subtracting, multiplying and
dividing values , there are also ( ) which
allows for more complex formulas, and
the caret (^) which is used for raising a
value to the power of a value

Available Math Lists mathematical functions that can be

Functions used in the formula. If you hover over a
function it will describe the number of
requied 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 formula.

Preview Pane Displays the formula as you add fields,

operators, and functions to it.

Bentley HAMMER V8i Edition User’s Guide 4-387

Property Grid Customizations Manager

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 containing the

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

Delete This button deletes the currently highlighted

folder or customization profile.

Rename This button allows you to rename the

currently highlighted folder or customization
profile.

Duplicate This button allows you to 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.

4-388 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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.

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.

Bentley HAMMER V8i Edition User’s Guide 4-389

Tooltip Customization

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:

New This button opens a submenu containing the

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

Delete This button deletes the currently highlighted

folder or customization profile.

Rename This button allows you to rename the

currently highlighted folder or customization
profile.

Duplicate This button allows you to make a copy of the

highlighted customization profile.

Make Active This button allows you to make the currently

highlighted customization profile the active
one.

Edit Opens the Tooltip Customization Editor

dialog allowing you to edit the currently
highlighted customization profile.

Help Opens the online help.

See Tooltip Customization Editor for information on defining tooltip customizations.

4-390 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

Tooltip Customization Editor

This dialog allows you to define the tooltip customizations on a per-element basis.

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 vari-
ables. 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.

Bentley HAMMER V8i Edition User’s Guide 4-391

i-Models

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
Bentley HAMMER 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.

For details on publishing and viewing i-models, see Publishing an i-model and
Viewing an i-model.

Publishing an i-model

To create an i-model, select File > Export > Publish i-model once the desired scenario
and time-steps have been selected.

4-392 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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/Prop-
erties column reflects the selections on the right side of the dialog in terms of which
elements and properties are included.

The bottom left portion of the dialog is used to identify which elements are to be
included in the i-model. This can be specified individually for each element type.

If the "Publish a subset of elements based on the Flex Table filters" box is checked,
only those elements that are in the filtered flex table will be included in the i-model.

If the "Exclude topologically inactive elements" box is checked, only active elements
(Is active? = True) are included in the i-model.

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 prop-
erties and select that flex table from the drop down list. Because it is possible to have

Bentley HAMMER V8i Edition User’s Guide 4-393

i-Models

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 prod-
ucts, but it is included with pressure-based applications as well. The basic function-
ality 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.

4-394 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

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

Viewing an i-model

It is anticipated that numerous applications will be able to view and use i-models.
Initially, i-models can be view using

• Bentley View
• ProjectWise Navigator
• Microstation

In all of these applications, it is possible to open an i-model by browsing to the i-

model when the application starts and opening the file.

Bentley HAMMER V8i Edition User’s Guide 4-395

i-Models

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.

The user can collapse or expand any category in the window.

4-396 Bentley HAMMER V8i Edition User’s Guide

 Creating Models

In Microstation and Navigator, it is also possible to view tabular element data for each
element type by selecting File > Item browser. This opens the Items browser for
element types as shown below:

Double clicking on one of the element types or picking the "Show Details" button
from the top of the dialog, opens a table for that element type.

Bentley HAMMER V8i Edition User’s Guide 4-397

i-Models

If the tree is expanded before selecting Show Details and an individual element is
selected, the user will see properties for the selected element.

4-398 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to
Transfer Existing Data 5
ModelBuilder lets you use your existing GIS asset to construct a new Bentley
HAMMER model or update an existing Bentley HAMMER 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), 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 Bentley HAMMER model. The result is that a
Bentley HAMMER model is created. ModelBuilder can be used in any of the Bentley
HAMMER 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 Bentley HAMMER 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

• Reviewing Your Results

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.

Bentley HAMMER V8i Edition User’s Guide 5-399

Preparing to Use ModelBuilder

• Get familiar with your data—ModelBuilder supports several data source types,
including tabular and geometric. Tabular data sources include spreadsheets, data-
bases, and other data sources without geometric information. Some supported
tabular data source types include Microsoft Excel, and Microsoft Access files.
Geometric data sources, while also internally organized by tables, include
geometric characteristics such as shape type, size, and location. Some supported
geometric data source types include the major CAD and GIS file types
If you obtained your model data from an outside source, you should take the time
to get acquainted with it in its native platform. For example, 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.
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 associ-
ated with fields containing numeric data.
Ideally, there will be one source data table for each Bentley HAMMER element
type. This isn’t always the case, and there are two other possible scenarios:
Many tables for one element type—In this case, there may be several tables in
the datasource corresponding to a single GEMS modeling element, component, or
collection. In this case each data source table must be individually mapped to the
Bentley HAMMER table type, or the tables must be combined into a single table
from within its native platform before running ModelBuilder.
One table containing many element types—In this case, there may be entries
that correspond to several Bentley HAMMER table types in one datasource 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 sepa-
rate tables when setting up mappings. See Subtypes for more information.

Note: If you are working with an ArcGIS data source, note that
ModelBuilder can only use geodatabases, geometric networks,
and coverages in ArcGIS mode. See ESRI ArcGIS Geodatabase
Support for additional information.

• All mappings should be contained in a single ModelBuilder connection—

ModelBuilder will ensure that data is synchronized into the model in the correct
order using this technique. If multiple connections are to be used instead, then the
user should run the individual ModelBuilder connections to get the following data
synchronization order: Components, Nodes, Pipes, polygon data (if any), Directed
Nodes (i.e. node types with a Downstream Pipe field), and finally collection data.
If pipes are brought in first it could create node elements which may not be
desired and could result in model run errors.

5-400 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

• Preparing your data—When using ModelBuilder to get data from your data
source into your model, you will be associating rows in your data source to
elements in Bentley HAMMER. 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 inter-
pret the first row of data in the table as the column labels. Be sure data is in a
format suited for use in ModelBuilder. Where applicable, 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
Bentley HAMMER ID. After creating these items in your Bentley
HAMMER model, you can obtain the assigned ID values directly
from your Bentley HAMMER modeling file. Before synchronizing
your model, get these Bentley HAMMER IDs into your data
source table (e.g., by performing a database join).

• Preparing your CAD Data—In previous versions of Bentley HAMMER, the

Polyline-to-Pipe feature was used to import CAD data into a Bentley HAMMER
model. In v8, CAD data is imported using ModelBuilder. When using Model-
Builder to import data from your CAD file into your model, you will be associ-
ating cells in your CAD drawing with elements in Bentley HAMMER.
Different CAD cells will be recognized as different element types and presented
as tables existing in your CAD data source. It is recommended that you natively
export your AutoCAD .dwg or MicroStation .dgn files first as a .dxf file, then
select this .dxf as the data source in ModelBuilder. Your data source will most
likely not contain a Key/Label field that can be used to uniquely identify every
element in your model, so ModelBuilder will automatically generate one for you
using the default "<label>". This "<label>" field is a combination of an element's
cell type label, its shape type, and a numeric ID that represents the order in which
it was created.
• Build first, Synchronize later—ModelBuilder allows you to construct a new
model or synchronize to an existing model. This gives you the ability to develop
your model in multiple passes. On the first pass, use a simple connection to build
your model. Then, on a subsequent pass, use a connection to load additional data
into your model, such as supporting pattern or collection data.

Bentley HAMMER V8i Edition User’s Guide 5-401

ModelBuilder Connections Manager

Note: Upon completion of your ModelBuilder run, it is suggested you

use the Network Navigator to identify any connectivity or
topological problems in your new model. For instance, Pipe Split
Candidates can be identified and then automatically modified
with the Batch Split Pipe Tool (see Batch Pipe Split Dialog Box).
See Using the Network Navigator for more information.

• Going Beyond ModelBuilder—Keep in mind that there are additional ways to

get data into your model. ModelBuilder can import loads if you have already
assigned a load to each node. If, however, this information is not available from
the GIS data, or if your loading data is in a format unrecognized by ModelBuilder
(meter data, etc.), use LoadBuilder; this module is a specialized tool for getting
this data into your model. In addition, with its open database format, Bentley
HAMMER gives you unprecedented access to your modeling data.
One area of difficulty in building a model from external data sources is the fact
that unless the source 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 data sources to include every service line and hydrant lateral. Such infor-
mation is not needed for most modeling applications and should be removed to
improve model run time, reduce file size, and save costs.
• Importing Collections—When you are importing a collection, values will always
override existing collection items in the model. In order to preserve existing items,
they need to be combined with the new values and import them together.
For example importing "Junction, Demand Collection", incoming demand rows
will override the existing demand collection, not append to it.
If you want to keep the existing demands, you should first export those values
(copy-paste is usually easiest) to your data source (e.g. spreadsheet, shapefile) and
make those demands part of the data you are importing. In this way ModelBuilder
will import both the original and new demands.

ModelBuilder Connections Manager

ModelBuilder can be used in any of the Bentley HAMMER 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 .

5-402 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

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

Windows Vista: C:\Users\<username>\AppData\Roaming\Bentley\<product-

name>\<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.

Bentley HAMMER V8i Edition User’s Guide 5-403

ModelBuilder Connections Manager

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.

5-404 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

Delete Permanently Remove the selected connection.

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.

Help Displays online help.

Bentley HAMMER V8i Edition User’s Guide 5-405

ModelBuilder Connections Manager

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 Bentley Bentley HAMMER 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 MSOf-
fice 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/enus/
download/details.aspx?id=13255 or alternatively, use the 32 bit version of the soft-
ware, which can be accessed from C:\Program Files
(x86)\Bentley\HAMMER\Hammer.exe, which supports these formats without
requiring additional components.

5-406 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

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.

Tip: 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:

• Step 1—Specify Data Source

• Step 2—Specify Spatial Options
• Step 3 - Specify Element Create/Remove/Update Options
• Step 4—Additional Options
• Step 5—Specify Field mappings for each Table/Feature Class
• Step 6—Build operation Confirmation

Bentley HAMMER V8i Edition User’s Guide 5-407

ModelBuilder Wizard

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.

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.

Note: 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 inter-
actively select your data source.

5-408 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

Note: 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.

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

Tip: 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.

ModelBuilder has built in support for ArcGIS Subtypes. For more

information, see ESRI ArcGIS Geodatabase Support.

• 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) —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 Pane—A tabular preview of the highlighted table is displayed in this
pane when the Show Preview check box is enabled.

Bentley HAMMER V8i Edition User’s Guide 5-409

ModelBuilder Wizard

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.

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.

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

5-410 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

• 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) doesn’t 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.
• 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.
• 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.

Note: 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.

Bentley HAMMER V8i Edition User’s Guide 5-411

ModelBuilder Wizard

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 Model-
Builder.

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).
– Prompt before adding objects (check box)-When this box is checked,
ModelBuilder will pause during the synchronization process to present a
confirmation message box to the user each time an element is about to be
created in the model or data-source.

5-412 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

• 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.
– Prompt before removing objects (check box)-When this box is checked,
ModelBuilder will pause during the synchronization process to present a
confirmation message box to the user each time an element is about to be
deleted from the model.
• 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.
– Prompt before updating objects (check box)-When this box is checked,
ModelBuilder will pause during the synchronization process to present a
confirmation message box to the user each time an element is about to be
updated.
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.
– Prompt before creating referenced elements (check box)-When this box is
checked, ModelBuilder will pause during model generation to present a
confirmation message box to the user each time a specified referenced
element could not be found, and is about to be created for the model.
"Referenced elements" refers to any support or domain element that is refer-
enced by another element. For example, Pumps can refer to Pump Definition
support-elements, Junctions can refer to Zone support-elements, and Pumps
can refer to a downstream Pipe domain-element. Node domain-elements that
get created as a result of being referenced during the ModelBuilder process
will use a default coordinate of 0, 0.

Bentley HAMMER V8i Edition User’s Guide 5-413

ModelBuilder Wizard

Note: These options listed above apply to elements (pipes and nodes)
as well as support elements (such as Zones or Controls).

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.

5-414 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

Note: 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 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:
– Label - The element "Label" will be used as the key for associating model
elements with data source records. Label is a good choice if the identifier
field in your data-source is unique and represents the identifier you commonly
use to refer to the record in your GIS.
– <custom> - Any editable text field in your model can be used as the key for
associating model elements with data source records. This is a good choice if
you perhaps don't use labels on every element, or if perhaps there are dupli-
cate labels in your data source.
– GIS-ID - The element "GIS-ID" field will be used as the key for associating
model elements with data source elements. The GIS-ID field offers a number
of advanced capabilities, and is the preferred choice for models that you plan
to keep in sync with your GIS over a period of time.
Refer to the section The GIS-ID Property for more information.

The following options only apply when using the advanced GIS-ID key field option.

• If several elements share the same GIS-ID, then apply updates to all of them?
(check box) - When using the GIS-ID option, ModelBuilder allows you to main-
tain 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 Bentley
HAMMER layout tools to split the pipe with a node; the newly created pipe
segment will be assigned the same GIS-ID 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).
– Prompt before cascading updates (check box) - When this box is checked,
ModelBuilder will pause during model generation to present a confirmation
message box to the user each time a cascading update is about to be applied.

Bentley HAMMER V8i Edition User’s Guide 5-415

ModelBuilder Wizard

• How would you like to handle add/removes of elements with GIS-ID

mappings on subsequent imports? - These options are useful for keeping your
GIS and Model synchronized, while maintaining established differences.
– Recreate elements associated with a GIS-ID that was previously deleted
from the model (check box) - By default, ModelBuilder will not recreate
elements you remove from your model that are associated with a records
(with GIS-ID mappings) that are still in your GIS. This behavior is useful
when you want to perform GIS to model synchronizations, but have elements
that exist in your GIS that you do not want in your model.
For example, after creating your model from GIS, you may find redundant
nodes when performing a Network Navigator, "Nodes in Close Proximity"
network review query. You may choose to use the "Merge Nodes in Close
Proximity" feature to make the correction in your model (deleting the redun-
dant nodes from your model). Normally, when you later synchronize from
your GIS to your model, missing elements would be recreated and your
correction would be lost. However, Bentley HAMMER now maintains the
history of elements (with GIS-ID's) that were removed from your model; this
option allows you to control whether or not those elements get recreated.
– When removing objects from destination if missing from source, only
remove objects that have a GIS-ID. (check box) - This option is useful
when you have elements that are missing from your GIS that you want to keep
in your model (or vice-versa).
For example, if you build your model from your GIS (using the GIS-ID
option, a GIS-ID will be assigned to newly created elements in your model. If
you later add elements to your model (they will not be assigned a GIS-ID); on
subsequent synchronizations, this option (if checked) will allow you to you
retain those model specific elements that do not exist in your GIS. For
example, you may have a proposed land development project in your model
that does not exist in the GIS. These elements will not have a GIS-ID because
they were not imported from the GIS. If this box is checked, the new elements
will not be removed on subsequent runs of ModelBuilder.

5-416 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

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.

Note: 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).

Bentley HAMMER V8i Edition User’s Guide 5-417

ModelBuilder Wizard

– Copy Mappings (button)-This button copies the mappings (associated with

the currently selected table) to the clipboard.
– Paste Mappings (button)-This button applies the copied mappings to the
currently selected table.

• 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:
– Table Type (drop-down list)-This field, which contains a list of all of the
Bentley HAMMER/Hammer element types, allows you to specify the target
modeling element type that the source table/feature class represents. For
example, a source table that contains pipe data should be associated with the
Pressure Pipe element type.
There are three categories of Table Types: Element Types, Components, and
Collections. For geometric data sources, only Element Types are available.
However with tabular data sources all table types can be used. The catego-
rized menu accessed by the [>] button assists in quicker selection of the
desired table type.
- Element Types-This category of Table Type includes geometric elements
represented in the drawing view such as pipes, junctions, tanks, 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.
- 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 Fields - This pair of key fields allows you to control how records in your
data source are associated with elements in the model. The Key Fields
element mapping consists of two parts, a data-source part and a model part:
- Key Field (Data Source) (drop-down list)-Choose the field in your data
source that contains the unique identifier for each record.

5-418 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

Note: 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-ID' 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.

Note: 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.

The following optional fields are available for Pipe element types:
- 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.

Note: 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).

These fields are available for Node element types:

- X/Y Field - These fields are used to specify the node X and Y coordinate
data. This field only applies to point table types.

Bentley HAMMER V8i Edition User’s Guide 5-419

ModelBuilder Wizard

Note: 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).

These optional fields are available for Pump element types:

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

The bottom section of the Settings tab allows you to specify additional data
mappings for each field in the source.
- 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 Bentley
HAMMER property. Use the Property drop-down list to map the high-
lighted 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 high-
lighted source data table when the Show Preview check box is checked.

To map a field in your table to a particular Bentley Bentley HAMMER 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 Bentley HAMMER
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:

1. Select the field you would like to update.

2. In the Property drop-down list, select <none>.

5-420 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

Step 6—Build 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 geom-
etry were modified during the ModelBuilder, check the box next to "Create selec-
tion set with elements modified."

Bentley HAMMER V8i Edition User’s Guide 5-421

Reviewing Your Results

Only show a subset of messages when synchronizing: Depending on the Model-

Builder 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 to determine the nature of any messages that were
reported.

Refer to the Using the Network Navigator and Manipulating Elements 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 1—Specify Data Source), multiple items can be selected for inclusion in your
ModelBuilder connection.

After clicking the Browse button to interactively specify your data source, use stan-
dard 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

• Shape files
• DBase and HTML Export.

5-422 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

ModelBuilder Warnings and Error Messages

Errors and warnings that are encountered during the ModelBuilder process will be
reported in the ModelBuilder Summary.

For more information, see:

• ModelBuilder Warnings
• ModelBuilder Error Messages

ModelBuilder 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 deter-
mine 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 Speci-
fying Network Connectivity in ModelBuilder.
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 refer-
enced label could not be found.

5. Directed Node <element> direction is ambiguous.

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

Bentley HAMMER V8i Edition User’s Guide 5-423

ModelBuilder Warnings and Error Messages

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:

1. Unable to assign <attribute> for element <element>.

Be sure that the data in your source table is compatible with the expected Bentley
HAMMER format. For more information, see Preparing to Use ModelBuilder.
2. Unable to create <element type> <element>.
This message indicates that an unexpected error occurred when attempting to
create a node element.
3. 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.
4. Unable to update pipe <element> topology; possibly due to start element connec-
tivity constraints.
This error occurs when synchronizing. For more information, see error message
#3 (above).
5. Operation terminated by user.
You pressed the Cancel button during the ModelBuilder process.

6. 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.
7. 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.
8. Unable to update the downstream edge for <element>.
An unexpected error occurred attempting to set the downstream edge for this
pump or valve.
9. Nothing to do. Some previously referenced tables may be missing from your data
source.

5-424 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

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.
10. One or more input features fall outside of the XYDomain.

This error occurs when model elements have been imported into a new geodata-
base 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.

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
• Geometric Networks
• ArcGIS Geodatabase Features versus ArcGIS Geometric Network
• Subtypes
• SDE (Spatial Database Engine)

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

Bentley HAMMER V8i Edition User’s Guide 5-425

ESRI ArcGIS Geodatabase Support

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 type—that 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 Pressur-
eRating.

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 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
model—if 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.

5-426 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

Subtypes

Tip: 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 Bentley HAMMER 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 3 -
Specify Element Create/Remove/Update Options).
• 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).

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):

Bentley HAMMER V8i Edition User’s Guide 5-427

Specifying Network Connectivity in ModelBuilder

• 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, Model-
Builder 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 connectivity
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 node’s 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. . Subsequent pipe ends could then
connect to any newly added nodes if they fall within the specified tolerance.

Another situation of interest occurs when two pipes cross but aren’t 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.

Refer to the Using the Network Navigator and Manipulating Elements topics for
information about reviewing and correcting model connectivity issues.

5-428 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

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 Model-
Builder.

Table 5-1: Correct Data Format for 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

Table 5-2: Data Format Needs Editing for ModelBuilder

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 Data Format Needs Editing for ModelBuilder, no column labels have been speci-
fied. 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.

Correct Data Format for ModelBuilder is also superior to Data Format Needs Editing
for ModelBuilder 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.

Bentley HAMMER V8i Edition User’s Guide 5-429

The GIS-ID Property

Finally, Data Format Needs Editing for ModelBuilder 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.

The GIS-ID Property

All elements in Bentley HAMMER have an editable GIS-ID 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-ID property, and has advanced logic for
keeping your model and GIS source file synchronized across the various model to GIS
associations.

The GIS-ID is a unique field in the source file which the user selects when Model-
Builder 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-ID 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, Bentley HAMMER will intelligently maintain GIS-ID 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-IDs is deleted, ModelBuilder will not
recreate it the next time a synchronization from your GIS occurs if the "Recreate
elements associated with a GIS-ID that was previously deleted from the model"
option is left unchecked.
• When an element with one or more GIS-IDs is morphed, the new element will
preserve those GIS-IDs. The original element will be considered as "deleted with
GIS-IDs", 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-IDs 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 ModelBuilder - additional options).
• When nodes in close proximity are merged, the resulting node will preserve the
GIS-IDs 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-ID 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 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
ModelBuilder - additional options).

5-430 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

To support these relationship (specifically one to many), GIS-ID 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-ID 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-ID, meaning multiple
records on the model are associated with a single record in the GIS.

Note: You can also manually edit the GIS-ID property to review or
modify the element to

GIS association(s).

GIS-ID Collection Dialog Box

This dialog box allows you to assign one or more GIS-IDs to the currently selected
element.

See The GIS-ID Property for more information on using GIS-IDs.

Bentley HAMMER V8i Edition User’s Guide 5-431

Specifying a SQL WHERE clause in ModelBuilder

Specifying a SQL WHERE clause in ModelBuilder

The simplest form of a WHERE clause consists of "Column name - comparison oper-
ator - 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'

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

• Using ModelBuilder to Import Pump Curves
• Using ModelBuilder to Import Patterns
• Using ModelBuilder to Import Time Series Data

5-432 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

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 Defi-
nition Table Type. However, to import multipoint head, efficiency or speed vs. effi-
ciency 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
• Shutoff Head
• User Defined BEP Max Flow

Bentley HAMMER V8i Edition User’s Guide 5-433

Modelbuilder Import Procedures

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 ques-
tion 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 head-
ings 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.

5-434 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

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.

Table 5-3: Format of Pump Definition Import Data

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.

Bentley HAMMER V8i Edition User’s Guide 5-435

Modelbuilder Import Procedures

Table 5-4: Excel Data Source Format

Label Type Motor Desig Desig Shutof Max Q H@ BEP BEP Eff Variab
Eff nQ nH f Head Max Q Eff Q Type le
Speed

Red Stand 95 200 120 180 400 40 70 200 Best FALS

ard (3 Efficie E
Point) ncy
Point

Green Stand 95 200 120 200 400 0 69 200 Best FALS

ard (3 Efficie E
Point) ncy
Point

Blue Stand 95 200 120 160 400 20 65 200 Best FALS

ard (3 Efficie E
Point) ncy
Point

The data source step in ModelBuilder wizard looks like this:

5-436 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

The field mappings should look like the screen below:

Bentley HAMMER V8i Edition User’s Guide 5-437

Modelbuilder Import Procedures

After the import, the three pumps are listed in the Pump Definitions. The curve for the
"Red" pump is shown below:

Using ModelBuilder to Import Pump Curves

While most pump definition information can be imported using the Pump Definition
Table Type, tabular data including

1. Multipoint pump-head curves,

2. Multipoint pump-efficiency curves and
3. 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.

5-438 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

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:

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.

Bentley HAMMER V8i Edition User’s Guide 5-439

Modelbuilder Import Procedures

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.

Table 5-5: Pump Curve Import Data Format

Label Flow (gpm) Head (ft)

M5 0 350

M5 5000 348

M5 10000 344

M5 15000 323

M5 20000 288

M5 25000 250

M5 30000 200

H2 0 312

H2 2000 304

5-440 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

Table 5-5: Pump Curve Import Data Format

H2 4000 294

H2 6000 280

H2 8000 262

H2 10000 241

H2 12000 211

H2 14000 172

Small 0 293

Small 1000 291

Small 2000 288

Small 3000 276

Small 4000 259

Small 5000 235

Small 6000 206

Bentley HAMMER V8i Edition User’s Guide 5-441

Modelbuilder Import Procedures

Upon running ModelBuilder to import the table above, three pump definitions would
be created. The one called "Small" is shown below.

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 docu-
mentation. 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,…]

5-442 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

• DAY [Sunday, Monday,…]

• Pattern category type (Label) [Hydraulic, Reservoir…]
• 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.

Bentley HAMMER V8i Edition User’s Guide 5-443

Modelbuilder Import Procedures

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.

And the actual Pattern Curve in the Pattern Curve table type.

5-444 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

The tables below show the pattern definition data and the pattern curve for two step-
wise 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.)

Table 5-6: Pattern Definition Import Data Format

Label Category Format StartTime StartMult

Residential Hydraulic Stepwise 12:00 PM 0.7

Commercial Hydraulic Stepwise 12:00 PM 0.8

Table 5-7: Pattern Curve Import Data Format

PatternLabel TimeFromStart Multiplier

Residential 3 0.65

Residential 6 0.8

Residential 9 1.3

Residential 12 1.6

Residential 15 1.4

Residential 18 1.2

Residential 21 0.9

Residential 24 0.7

Commercial 3 0.8

Commercial 6 0.85

Commercial 9 1.4

Commercial 12 1.6

Commercial 15 1.3

Commercial 18 0.9

Commercial 21 0.8

Commercial 24 0.8

Bentley HAMMER V8i Edition User’s Guide 5-445

Modelbuilder Import Procedures

One of the resulting patterns from this import is shown below:

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 Bentley HAMMER to Excel.

5-446 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

First, create a sample Pipe Flow time series in Bentley HAMMER as shown above.

Next, create a new Excel .xls file. We'll need two "sheets" to receive the data (the
default "Sheet1" and "Sheet2" will do).

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. You
mentioned Excel in your post (and I didn't encounter any data-
type problems), so I'll go with that here.

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 connec-
tion and get to the "Specify Field Mappings" step (you won't be saving this connec-
tion, 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:

Bentley HAMMER V8i Edition User’s Guide 5-447

Modelbuilder Import Procedures

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). It should
look something like this:

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 deter-
mine the columns to define.

Click on the Sheet2 tab in Excel and define the necessary columns for the "Time
Series Collection" table. It should look something like this:

Save and close your spreadsheet.

Define the ModelBuilder Connection

Now we're ready to create the ModelBuilder connection to this spreadsheet.

Open ModelBuilder and create a new Connection.

5-448 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

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

Navigate through the next few steps, just use the defaults there.

Bentley HAMMER V8i Edition User’s Guide 5-449

Modelbuilder Import Procedures

When you reach the Mapping Step, set things up for Sheet1 and Sheet2 as shown
below:

5-450 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

Navigate to the end of the Wizard.

On the last step, click "No" for the "Would you like to build a model now?" prompt
and click [Finish].

Synchronize Out from ModelBuilder

Choose the connection you just defined (be sure to close the Excel spreadsheet you
just defined), and click the Sync Out toolbar button.

The sample time series data from Bentley HAMMER will now be available in the
Excel spreadsheet you created.

Bentley HAMMER V8i Edition User’s Guide 5-451

Oracle as a Data Source for ModelBuilder

Using that as a go-by, you should be able to enter the data in the appropriate format to
import in to Bentley HAMMER.

Oracle as a Data Source for ModelBuilder

Bentley HAMMER 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 Bentley HAMMER 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 Bentley
HAMMER.

It is possible to connect to an Oracle database from Bentley HAMMER using any

supported CAD/GIS platform. Start ModelBuilder the same as with any other data
source (see ModelBuilder Connections Manager). However, when the user browses
for a data source some additional information is required.

5-452 Bentley HAMMER V8i Edition User’s Guide

 Using ModelBuilder to Transfer Existing Data

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 informa-
tion, 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.

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.

Bentley HAMMER V8i Edition User’s Guide 5-453

Oracle as a Data Source for ModelBuilder

5-454 Bentley HAMMER V8i Edition User’s Guide

 Applying Elevation
Data with TRex 6
The Importance of Accurate Elevation Data

Numerical Value of Elevation

Record Types

Calibration Nodes

TRex Terrain Extractor

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 model’s 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:

p =  HGL - z g

Where: p = pressure (lb./ft.2, N/m2)

Bentley HAMMER V8i Edition User’s Guide 6-455

Numerical Value of Elevation

HGL = hydraulic grade line (ft., m)

z = node elevation (ft., m)
 = density of water (slugs/ft.3, kg/m3)
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 speci-
fied (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 pres-
sure can vary as shown. Usually modelers use ground elevation as the elevation for the
node.

6-456 Bentley HAMMER V8i Edition User’s Guide

 Applying Elevation Data with TRex

Accuracy and Precision

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 repre-
sented by a uniform grid of cells of a specified resolution (typically 100 ft.). The accu-
racy of points interpolated from the grid depends on the distance from known

Bentley HAMMER V8i Edition User’s Guide 6-457

Obtaining Elevation Data

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 corre-
sponding 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 hori-
zontal 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 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 avail-
able.

6-458 Bentley HAMMER V8i Edition User’s Guide

 Applying Elevation Data with TRex

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 corre-
sponding accuracy standard. Accuracy is measured as the root mean square error
(RMSE) of linearly interpolated elevations from the DEM compared to known eleva-
tions. 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.

Bentley HAMMER V8i Edition User’s Guide 6-459

Calibration Nodes

Calibration Nodes
An elevation accuracy of 5 ft. is adequate for most nodes; therefore, a USGS topo-
graphic map is typically acceptable. However, for nodes to be used for model calibra-
tion, 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 pres-
sure of 60.1 psi while the gage would read 57.5 psi even though the model is correct.

800 ft.

HGL

667.1 ft. Field Pressure = 58 psi

661.2 ft.
Model Pressure = 60 psi

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.

6-460 Bentley HAMMER V8i Edition User’s Guide

 Applying Elevation Data with TRex

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 Eleva-
tion 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 eleva-
tion 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 coordi-
nate 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 model or DEM must be converted so that the two are in the same coor-
dinate 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.

Bentley HAMMER V8i Edition User’s Guide 6-461

TRex Wizard

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 Seam-
less Server. The vertical accuracy may only be +/- 7 to 15 m.

6-462 Bentley HAMMER V8i Edition User’s Guide

 Applying Elevation Data with TRex

Step 1: File Selection

The elevation data source and features to which elevations will be assigned are speci-
fied 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 deter-
mine whether to build the elevation map based on either elevation point data or eleva-
tion 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 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 inter-
polate 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.

Bentley HAMMER V8i Edition User’s Guide 6-463

TRex Wizard

• Data Source Type—This menu allows you to choose the type of file that contains
the input data you will use.
• File—This 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 Field—Select the elevation unit.
• X-Y Units—This menu allows the selection of the measurement unit type associ-
ated with the X and Y coordinates of the elevation data file.
• Z Units—This menu allows the selection of the measurement unit type associated
with the Z coordinates of the elevation data file.
• Clip Dataset to Model—In some cases, the data source contains elevation data
for an area that exceeds the dimensions of the area being modeled. When this box
is checked, TRex will calculate the model’s bounding box, find the larger dimen-
sion (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.

6-464 Bentley HAMMER V8i Edition User’s Guide

 Applying Elevation Data with TRex

Then any data point that falls outside of the new bounding box will not be used to
generate the elevation mesh. If this box isn’t checked, all the source data points
are used to generate the elevation mesh. Checking this box should result in faster
calculation speed and use less memory.
• Buffering Percentage—This field is only active when the Clip Dataset to Model
box is checked. The percentage entered here is the percentage of the larger dimen-
sion (width or height) of the model’s bounding box that will be added to both the
bounding box width and height to find the area within which the source data
points will be used to build the elevation mesh.
• Spatial Reference (ArcGIS Mode Only)—Click the Ellipsis (...) next to this
field to open the Spatial Reference Properties dialog box, allowing you to specify
the spatial reference being used by the Bentley HAMMER model file.
• Also update inactive elements—Check this box to include inactive elements in
the elevation assignment operation. When this box is unchecked, elements that are
marked Inactive will be ignored by TRex.
• All—When this button is selected, TRex will attempt to assign elevations to all
nodes within the Bentley HAMMER model.
• Selection—When this button is selected, TRex will attempt to assign elevations to
all currently highlighted nodes.
• Selection Set—When this is selected, the Selection Set menu is activated. When
the Selection Set button is selected, TRex will assign elevations to all nodes
within the selection set that is specified in this menu.

Note: If the Bentley HAMMER model (which may or may not have a
spatial reference explicitly associated with it) is in a different
spatial reference than the DEM/DTM (which does have a spatial
reference explicitly associated with it), then the features of the
model will be projected from the model’s spatial reference to the
spatial reference used by the DEM/DTM.

Bentley HAMMER V8i Edition User’s Guide 6-465

TRex Wizard

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.

• Results Preview Pane—This tabular pane displays the elevations that were
calculated by TRex. The table can be sorted by label by clicking the Label column
heading and by elevation by clicking the Elevation column heading. You can filter
the table by right-clicking a column in the table and selecting the Filter...Custom
command. You can also right-click any of the values in the elevation column to
change the display options.
• Use Existing Alternative—When this is selected, the results will be applied to
the physical alternative that is selected in the Use Existing Alternative menu. This
menu allows the selection of the physical alternative to which the results will be
applied.
• New Alternative —When this is selected, the results will be applied to a new
physical alternative. First, the currently active physical alternative will be dupli-
cated, 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 Alter-
native text field.

6-466 Bentley HAMMER V8i Edition User’s Guide

 Applying Elevation Data with TRex

• Parent Alternative—Select an alternative to duplicate from the menu, or select

<None> to create a new Base alternative.
• Export Results—This exports the results generated by TRex to a tab or comma-
delimited text file (.TXT). These files can then be re-used by Bentley HAMMER
or imported into other programs.

• Click Finish when complete, or Cancel to close without making any changes.

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

Bentley HAMMER V8i Edition User’s Guide 6-467

TRex Wizard

6-468 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands
using LoadBuilder 7
Using GIS for Demand Allocation

Using LoadBuilder to Assign Loading Data

Generating Thiessen Polygons

Demand Control Center

Unit Demand Control Center

Pressure Dependent Demands

Using GIS for Demand Allocation

The consumption of water is the driving force behind the hydraulic dynamics occur-
ring 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 diffi-
culties 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 distri-
bution 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.

Bentley HAMMER V8i Edition User’s Guide 7-469

Using GIS for Demand Allocation

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.

Allocation

This uses the spatial analysis capabilities of GIS to assign geocoded (possessing coor-
dinate 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

7-470 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

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.

Bentley HAMMER V8i Edition User’s Guide 7-471

Using GIS for Demand Allocation

Note: In LoadBuilder, the Nearest Node and Nearest Pipe strategies

are also in the Allocation loading method.

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.

7-472 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

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 distribu-
tion 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 meter data from pump stations, treat-
ment 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 propor-
tional 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 repre-
sents 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 asso-
ciated 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

Bentley HAMMER V8i Edition User’s Guide 7-473

Using GIS for Demand Allocation

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

Point Demand Assignment

7-474 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

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 (gener-
ally 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 inter-
sect 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 conver-
sion 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 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.

Bentley HAMMER V8i Edition User’s Guide 7-475

Using LoadBuilder to Assign Loading Data

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.

Go to Tools > Loadbuilder or click .

7-476 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

The following are available from this dialog box:

New Opens the LoadBuilder Wizard.

Delete Deletes an existing LoadBuilder template.

Rename Renames an existing LoadBuilder template.

Edit Opens the LoadBuilder Wizard with the

settings associated with the currently
highlighted definition loaded.

Help Opens the context-sensitive online 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.

Bentley HAMMER V8i Edition User’s Guide 7-477

Using LoadBuilder to Assign Loading Data

Step 1: Available LoadBuilder Methods

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:

Point Load Data

• Billing Meter Aggregation—This loading method assigns all meters within a

service polygon to the specified demand node for that service polygon.

7-478 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

• Nearest Node—This loading method assigns customer meter demands to the

closest demand junction.

• Nearest Pipe—This loading method assigns customer meter demands to the

closest pipe, then distributes demands using user-defined criteria.

Area Load Data

• Equal Flow Distribution—This 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.

• Proportional Distribution by Area—This load method proportionally distrib-

utes a lump-sum flow among a number of demand nodes based upon the ratio of
total service area to the area of the node’s corresponding service polygon.

Bentley HAMMER V8i Edition User’s Guide 7-479

Using LoadBuilder to Assign Loading Data

• Proportional Distribution by Population—This load method proportionally

distributes a lump-sum demand among a number of demand nodes based upon the
ratio of total population contained within the node’s corresponding service
polygon.

• Unit Line—This load method divides the total demand in the system (or in a
section of the system) into 2 parts: known demand (metered) and unknown
demand (leakage and unmeasured user demand).

See Unit Line Method for more details.

Population/Land Use Data

• Projection by Land Use—This method allocates demand based upon the density
per land use type of each service polygon.

• Load Estimation by Population—This method allocates demand based upon

user-defined relationships between demand per capita and population data.

7-480 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

Step 2: Input Data

The available controls in this step will vary according to the load method type that was
specified as follows:

• Billing Meter Aggregation—Input Data—The following fields require data to be

specified:
– Service Area Layer—Specify the polygon feature class or shapefile that
defines the service area for each demand node.
– Node ID Field—Specify the source database field that contains identifying
label data.

Note: ElementID is the preferred Junction ID value because it is always

unique to any given element.

– Billing Meter Layer—Specify the point feature class or shapefile that

contains the geocoded billing meter data.
– Load Type Field—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 Field—Specify the source database field that contains usage data. The
usage field in the source database must contain flow data. Also, use to select
the unit associated with the usage field value.
• Nearest Node—Input Data—The following fields require data to be specified:

– Node Layer—Specify the feature class or shapefile that contains the nodes
that the loads will be assigned to.
– Node ID Field—Specify the feature class database field that contains the
unique identifying label data.

Note: ElementID is the preferred node ID value because it is always

unique to any given element.

– Billing Meter Layer—Specify the feature class or shapefile that contains the
geocoded billing meter data.

Bentley HAMMER V8i Edition User’s Guide 7-481

Using LoadBuilder to Assign Loading Data

– Load Type Field—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 Field—Specify the source database field that contains usage data. The
usage field in the source database must contain flow data. Also, use to select
the unit associated with the usage field value.
– Use Previous Run—LoadBuilder’s most time-consuming calculations when
using the Nearest Node strategy are 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 Pipe—Input Data—The following fields require data to be specified:
– Pipe Layer—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 Field—Specify the source database field that contains the unique
identifying label data.

Note: ElementID is the preferred Pipe ID value because it is always

unique to any given element.

– Load Assignment—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:
- Equal Distribution—This method assigns an equal portion of the total
load assigned to a pipe to each of the pipe’s end nodes.
- Distance Weighted—This 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 Node—This method assigns the entire total load assigned to the
pipe end node that is closest to the meter.
- Farthest Node—This method assigns the entire total load assigned to the
pipe end node that is farthest from the meter.
– Node Layer—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.

7-482 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

– Node ID Field—Specify the source database field that contains the unique
identifying label data.

Note: ElementID is the preferred Junction ID value because it is always

unique to any given element.

– Use Previous Run—LoadBuilder’s most time-consuming calculations when

using the Nearest Pipe strategy are 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 run are used, thereby increasing the overall
calculation performance.
– Billing Meter Layer—Specify the point or polyline feature class or shapefile
that contains the geocoded billing meter data.
– Billing Meter ID Field—Billing 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.
– Load Type Field—This 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.
– Polyline Distribution—When 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 Distribution—This option will distribute the load equally among
the pipes associated with (overlapping) the meter.
- Proportional Distribution—This option will divide the load proportion-
ally according to the ratio of the length of pipe that is associated with
(overlapping) the meter to the total length of the meter.

– Usage Field—Specify the source database field that contains usage data. The
usage field in the source database must contain flow data. Also, use to select
the unit associated with the usage field value.

Bentley HAMMER V8i Edition User’s Guide 7-483

Using LoadBuilder to Assign Loading Data

• Equal Flow Distribution—Input Data—The following fields require data to be

specified:
– Node Layer—Specify the point feature class or shapefile that contains the
nodes that the flow will be assigned to.
– Node ID Field—Specify the source database field that contains identifying
label data.

Note: ElementID is the preferred Node ID value because it is always

unique to any given element.

– Flow Boundary Layer—Specify the polygon feature class that contains the
flow monitoring meter data.
– Flow Field—Specify the source database field that contains usage data. The
usage field in the source database must contain flow data. Also, use to select
the unit associated with the usage field value.
• Proportional Distribution by Area—Input Data—The following fields require
data to be specified:
– Service Area Layer—Specify the polygon feature class or shapefile that
defines the service area for each node.
– Node ID Field—Specify the source database field that contains the unique
identifying label data.

Note: ElementID is the preferred Junction ID value because it is always

unique to any given element.

– Flow Boundary Layer—Specify the polygon feature class or shapefile that

contains the flow boundary data.
– Boundary Field—Specify the source database field that contains the
boundary label.
– Flow Field—Specify the source database field that contains usage data. The
usage field in the source database must contain flow data. Also, use to select
the unit associated with the usage field value.
• Proportional Distribution by Population—Input Data—The following fields
require data to be specified:
– Service Area Layer—Specify the polygon feature class or shapefile that
defines the service area for each node.
– Node ID Field—Specify the source database field that contains the unique
identifying label data.

7-484 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

Note: ElementID is the preferred Junction ID value because it is always

unique to any given element.

– Flow Boundary Layer—Specify the polygon feature class or shapefile that

contains the flow boundary data.
– Boundary Field—Specify the source database field that contains the
boundary label.
– Flow Field—Specify the source database field that contains usage data. The
usage field in the source database must contain flow data. Also, use to select
the unit associated with the usage field value.
– Population Layer—Specify the polygon feature class or shapefile that
contains population data.
– Population Count Field—Specify the source database field that contains
population data.
– Land Type Field—Specify the source database field that contains land use
type.

• Unit Line—Input Data—The following fields require data to be specified:

– Include known demands in results—When this box is checked the Demand
Alternative field is activated, allowing you to specify a demand alternative
whose demands will be included in the results.
– Demand Alternative—Select a demand alternative to use when the Include
known demands in results box is checked.
– K Factor Field—Specify the user-defined attribute field that contains K-
Factor data. You can add the user-defined field to the project by clicking the
ellipsis button and specifying a default K-Factor.
– Include—Check the box next to each element type (junctions, tanks, and
hydrants) you want included in the calculation.
– Unaccounted-for Demand by Selection Set Table—This table allows you to
assign unaccounted-for demands by selection set. Click the new button to add
a row to the table, then choose a selection set (or Entire Network to include all
applicable elements) and specify an unaccounted-for demand value. Highlight
a row and click the Delete button to remove it.

• Projection by Land Use—Input Data—The following fields require data to be

specified:
– Service Area Layer—Specify the polygon feature class or shapefile that
defines the service area for each node.
– Node ID Field—Specify the source database field that contains the unique
identifying label data.

Bentley HAMMER V8i Edition User’s Guide 7-485

Using LoadBuilder to Assign Loading Data

Note: ElementID is the preferred Junction ID value because it is always

unique to any given element.

– Land Use Layer—Specify the polygon feature class or shapefile that

contains the land use data.
– Land Type Field—Specify the source database field that contains land use
type.
– Load Type and Load Density—Use this table to assign load density values
to the various load types contained within your land use layer.

• Load Estimation by Population—Input Data—The following fields require data

to be specified:
– Service Area Layer—Specify the polygon feature class or shapefile that
defines the service area for each node.
– Node ID Field—Specify the source database field that contains identifying
label data.

Note: ElementID is the preferred Junction ID value because it is always

unique to any given element.

– Population Layer—Specify the polygon feature class or shapefile that

contains the population data.
– Population Density Type Field—Specify the source database field that
contains the population density type data.
– Population Density Field—Specify the source database field that contains
population density data.
– Load Type and Load Density—Use this table to assign load density values
to the various load types contained within your population density layer.
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.

Note: Different types of shapefiles may need to be created based on

the loadbuilder method selected.

The Results Summary pane contains the following columns:

• Load Type—This column contains an entry for each load type contained within
the database column specified in step one. (Examples include Residential,
Commercial, Industrial, etc.)

7-486 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

• Consumption—This column displays the total load associated with each load
type entry.
• Multiplier—This 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 can be edited.
• Pattern—This 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 Multiplier—This field allows you to apply a multiplier to all of the

entries contained within the Results Summary Pane. Any changes are automati-
cally 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 Load—This 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:

• Node ID—The unique identifying label assigned to all geodatabase elements by

the GIS.
• Label—The unique identifying label assigned by Bentley HAMMER V8i
Modeler.
• Load Type—An optional classification that can be used to assign different behav-
iors, 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.
• Pattern—The type of pattern assigned to the node. The source database must
include a column that contains this data.

Bentley HAMMER V8i Edition User’s Guide 7-487

Using LoadBuilder to Assign Loading Data

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:

• Label—This field allows a unique label to be assigned to the load build template.
• Override an Existing Alternative—Choosing this option will cause the calcu-
lated loads to overwrite the loads contained within the existing load alternative
that is selected.
• Append to an Existing Alternative—Choosing this option will cause the calcu-
lated loads to be appended to the loads contained within the existing load alterna-
tive 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 be added to them.
• New Alternative—Choosing this option will cause the calculated loads to be
applied to a new load alternative. Enter your text into this field. The Parent Alter-
native field will only be active when this option is selected.

7-488 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

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

The Unit Line Flow Method divides the total demand in the system (or in a section of
the system) into 2 parts: known demand (metered) and unknown demand (leakage and
unmeasured user demand).

The following diagram shows a sample pipe. The known (metered) demands at nodes
a and b are qa and qb respectively. The unknown demand is computed by considering
if there are users on none, one, or both sides of the pipe. This is accounted for using
the coefficient, K.

Bentley HAMMER V8i Edition User’s Guide 7-489

Using LoadBuilder to Assign Loading Data

Where

li = length of Pipei
Ki = coefficient indicating the capability of Pipei to consume water
If there are no users on either side of the pipe (the pipe is only used to transfer water to
another part of the system), then K is 0. If there are users along only one side of the
pipe (for example, pipes along a river), K is 0.5. If both sides of the pipe supply water
to users, K is 1.

The equations below are used to determine the total demands at nodes a and b:

m
1 Q totalunknown
a 2  n 

Q a = q + ---  -----------------------------------  Ki  li
 K j  l j

i=1
 
j = 1 

m
1 Q totalunknown
b 2  n 

Q b = q + ---  -----------------------------------  Ki  li
 K j  l j

i=1
 
j = 1 

Where

Qa = the total demand at node a

Qb = the total demand at node b
qa = The known demand at node a
qb = The known demand at node b
Qtotal unknown = Total real demand minus total known demand(for the network or
selection set)
n = number of pipes in network (or selection set)
m = the number of pipes connected to node a or b

7-490 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

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 polygon’s 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 devel-
oped 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 manu-
ally. 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.

Bentley HAMMER V8i Edition User’s Guide 7-491

Generating Thiessen Polygons

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 inter-
join.

7-492 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

In the final diagram, the network is overlaid with the polygons that are created by
connecting the bisector lines.

Bentley HAMMER V8i Edition User’s Guide 7-493

Generating Thiessen Polygons

Thiessen Polygon Creator 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 strate-
gies:

• Billing Meter Aggregation

• Proportional Distribution By Area
• Proportional Distribution By Population
• Projection by Land Use
• Load Estimation by Population.

7-494 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

The Thiessen Polygon Creator dialog box consists of the following controls:

• Node Data Source—Select the data source to use.

– Node Layer—This lists the valid point feature classes and shapefiles that
Thiessen Polygon Creator can use.
– Current Selection—Click if the current feature data set contains a previously
created selection set.
– Include active elements only—Click to activate.
– Selection—This 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.
• Buffering Percentage—This 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 Layer—Select the boundary polygon feature class or shape-
file, if one has already been created. A boundary is specified so that the outermost
polygons do not extend to infinity.
• Output File—Specify the name of the shapefile that will be created.

Bentley HAMMER V8i Edition User’s Guide 7-495

Generating Thiessen Polygons

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 Creator 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 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 Bentley HAMMER V8i model that
has had at least one scenario published as an ESRI feature data set. Then, follow these
steps:

1. In the directory structure pane of ArcCatalog, right-click the Bentley HAMMER

V8i feature data set 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 Bentley
HAMMER 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 junctions) 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.

7-496 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

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.

Bentley HAMMER V8i Edition User’s Guide 7-497

Demand Control Center

7-498 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

The Demand Control Center toolbar includes the following:

New Clicking this button opens a submenu

containing the following commands:
• Add Demand to Element—Adds a 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 Junc-
tion 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.

Delete Deletes an existing demand.

Report Generates a demand report based on the

contents of the table.

Create or Creates a new selection set containing the

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

Bentley HAMMER V8i Edition User’s Guide 7-499

Demand Control Center

Zoom Zooms to a specific element.

Find Opens the Domain Element Search editor.

Options Provides access to global sort and filter

capabilities.

Query Opens a submenu allowing you to filter the

table 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 informa-
tion about these queries, see Using the
Network Navigator.

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

7-500 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

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.

Bentley HAMMER V8i Edition User’s Guide 7-501

Unit Demands Dialog Box

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.

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.

7-502 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

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:

New Creates a new unit demand. When you click the new
button, a submenu opens containing the following choices:
• Area—Creates a new Area-based unit demand.
• Count—Creates a new Count-based unit demand.
• Population—Creates a new Population-based unit
demand.

Duplicate Copies the currently selected unit demand.

Delete Deletes the currently highlighted unit demand. You can

hold down the Ctrl key while clicking on items in the list
to select multiple entries at once.

Rename Renames the currently highlighted unit demand.

Report Generates a detailed report on the selected unit demand.

Synchronization Browses the Engineering Library, synchronizes to or from

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 high-
lighted in the unit demands list pane.

Bentley HAMMER V8i Edition User’s Guide 7-503

Unit Demands Dialog Box

The following controls are available:

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 • Unit Demand—Lets you specify the amount

Demand 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 popula-
tion 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 popula-
tion 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.

7-504 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

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.

Notes Tab This tab contains a text field that is used to type
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.

Bentley HAMMER V8i Edition User’s Guide 7-505

Unit Demand Control Center

The Unit Demand Control Center toolbar includes the following:

New Add Demands opens the Domain Element

Search dialog box, allowing you to search
for the element to include. Once you’ve
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.

Delete Deletes an existing unit demand.

Report Generates a unit demand report based on the

contents of the table.

Create or Creates a new selection set containing the

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

7-506 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

Zoom Zooms to a specific element.

Find Opens the Domain Element Search editor.

Options Provides access to global sort and filter

capabilities.

Query Opens a submenu allowing you to filter the

elements displayed based on a number of
predefined queries. For more information
about the .available queries, see Using the
Network Navigator.

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.

Bentley HAMMER V8i Edition User’s Guide 7-507

Pressure Dependent Demands

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.

7-508 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

New Creates a a new pressure dependent demand function.

Duplicate Copies the currently selected demand.

Delete Deletes an existing demand. You can hold down the Ctrl key
while clicking on items in the list to select multiple entries at
once.

Rename Renames an existing pressure dependent demand function.

Report Generates a pressure dependent demand report based on the

selected demand.

Synchroniza Browses the Engineering Library, synchronizes to or from the

tion Options library, imports from the library or exports to the library.

Bentley HAMMER V8i Edition User’s Guide 7-509

Pressure Dependent Demands

Properties tab

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 relation-
ship 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.

7-510 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

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 refer-

ence pressure.

Percent of Reference Demand - defines the percentage of a nodal demand to reference

demand.

Bentley HAMMER V8i Edition User’s Guide 7-511

Pressure Dependent Demands

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 pres-
sure 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 pres-
sure 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 refer-
ence 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.

7-512 Bentley HAMMER V8i Edition User’s Guide

 Allocating Demands using LoadBuilder

Piecewise Linear Dialog Box

This dialog allows you define engineering library entries for Piecewise Linear Curves.

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:

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

Bentley HAMMER V8i Edition User’s Guide 7-513

Pressure Dependent Demands

7-514 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model
Complexity with 8

Skelebrator

Skeletonization

Skeletonization Example

Common Automated Skeletonization Techniques

Skeletonization Using Skelebrator

Using the Skelebrator Software

Backing Up Your Model

Bentley HAMMER V8i Edition User’s Guide 8-515

Skeletonization

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 distri-
bution 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 neces-
sary 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 incorpo-
rating 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 neces-
sity, 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.

8-516 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

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 skeletoniza-
tion 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 junc-
tion. The only information that has been lost is the data at the service connections that
were removed.

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 junc-
tion (as determined by following the service pipe). In the following diagram, these
service areas are marked with a dotted line.

Bentley HAMMER V8i Edition User’s Guide 8-517

Skeletonization

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.

8-518 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

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.

Generic—Data 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 combi-
nations 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 isola-
tion valves. Removing these elements generally has a negligible impact on the accu-
racy 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 pipe’s
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.)

Generic—Branch 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 impor-
tant element of this skeletonization type is the reallocation of demands that are associ-
ated 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-ends—if 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.

Bentley HAMMER V8i Edition User’s Guide 8-519

Common Automated Skeletonization Techniques

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 skele-
tonization), 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, infor-
mation on these trimmed elements may be desired but unavailable. Having multiple
models utilizing various levels of skeletonization is the solution to this potential issue.

Generic—Series Pipe Removal

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 adja-
cent 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 skeletoniza-
tion that is possible.

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.

8-520 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

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 scrub-
bing 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 model’s 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
Skelebrator’s advanced network traversal algorithm.

Bentley HAMMER V8i Edition User’s Guide 8-521

Skeletonization Using Skelebrator

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 flex-
ibility, efficiency, and usability. The branch trimming method utilized by other auto-
mated 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.

Before Branch Collapsing

After One Branch Collapsing Iteration

8-522 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

After Two Branch Collapsing Iterations (Branch is Completely Removed)

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 accept-
able level of hydraulic parity.

To overcome this limitation, Skelebrator provides a greater range of demand realloca-

tion 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 Domi-
nant 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 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.

Bentley HAMMER V8i Edition User’s Guide 8-523

Skeletonization Using Skelebrator

J1 J2 J3
P1 P2

Length: 250 ft. Length: 350 ft.

Diameter: 8 in. Diameter: 8 in.

Roughness: 120 Roughness: 120

Before Series Pipe Merging (Exact Match Pipes)

J1 J3
P1

Length: 600 ft.

Diameter: 8 in.

Roughness: 120

After Series Pipe Merging (Exact Match Pipes)

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 skeleton-
ization) 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.

8-524 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

J1 J2 J3
P1 P2

Length: 350 ft. Length: 250 ft.

Diameter: 8 in. Diameter: 6 in.

Roughness: 120 Roughness: 120

Before Series Pipe Merging (Different Diameters)

J1 J3
P1

Length: 600 ft. Length: 600 ft.

OR
Diameter: 8 in. Diameter: 6 in.

Roughness: 77 Roughness: 163

After Series Pipe Merging (Using Skelebrator’s Hydraulic Equivalency

feature)

Tip: 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.

Bentley HAMMER V8i Edition User’s Guide 8-525

Skeletonization Using Skelebrator

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.

Before Parallel Pipe Merging

After Parallel Pipe Merging

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

8-526 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

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.

See Inline Isolating Valve Replacement 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.

Bentley HAMMER V8i Edition User’s Guide 8-527

Skeletonization Using Skelebrator

Before skeletonization is begun or between steps, you can use Skelebrator’s 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 flex-
ibility 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 skele-
tonization. You can save this process and choices you made and reuse them in an auto-
matic skeletonization of the same model.

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 accommo-
date a wide variety of conditions.

Skelebrator provides an unmatched level of flexibility, providing numerous demand

reallocation and element removal strategies. It alone, amongst automated skeleton-
izers, 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.

8-528 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

These features, and others such as the Skeletonization Preview and Manual Skeleton-
ization, 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, 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 eliminate all scenarios other than the one to
be skeletonized from a model prior to skeletonization.
• Skelebrator reduces a Bentley HAMMER model and applies its changes to the
model’s Bentley HAMMER 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 Bentley HAMMER datastore from the GIS data.
• To use Skelebrator with a CAD drawing, you must firstuse ModelBuilder to create
a Bentley HAMMER datastore from the CAD file.

Bentley HAMMER V8i Edition User’s Guide 8-529

Using the Skelebrator Software

Skeletonizer Manager

Use Skelebrator’s skeletonization manager to define how you are going to skeletonize
your network. The basic unit in Skelebrator is an operation. An operation defines and

encapsulates the settings required to be defined in order to perform some reduction

process on your hydraulic network. Skelebrator provides these types of operations that
may be used to reduce the size of your model:

• Branch Collapsing
• Parallel Pipe Merging
• Series Pipe Merging
• Smart Pipe Removal
• Inline Isolating Valve Replacement

8-530 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

New Click New to add a skeletonization operation. This adds an oper-

ation for the option that is currently selected: Smart Pipe
Removal, Branch Collapsing, Series Pipe Merging, or Parallel
Pipe Merging. Skelebrator performs a single operation at a time.
An operation consists of the strategy to use (Smart Pipe
Removal, Branch Collapsing, etc.) and the settings and condi-
tions specific to that operation.

Rename Click Rename to rename the currently selected operation.

Duplicate Click Duplicate to create a copy of the currently selected opera-

tion. You can rename and edit the copy as needed.

Delete Click Delete to remove the currently selected operations from

the list.

Automatic To run automatic skeletonization and apply your skeletonization

operations to your model. The run is executed using the selected
operations. More than one operation can be selected.

Manual Click to manually run the skeletonization operation. Manual

skeletonization allows you to conduct skeletonizations in a
concise and controlled manner while viewing the pipes that will
be removed and gives you the opportunity to protect some of
those pipes on a real-time basis.

Print Preview the results of your skeletonization.

Preview

Bentley HAMMER V8i Edition User’s Guide 8-531

Using the Skelebrator Software

To use Skeletonizer Manager

1. Click the skeletonization technique you want to use: Branch Collapsing, Parallel
Pipe Merging, Series Pipe Merging, Smart Pipe Removal.
2. Click New and select from the menu.

3. Type a new name or keep the default name.

4. Choose your Settings, Conditions, and add Notes.
5. Click on Default Skelebrator Group (the first in the list and it can be renamed).
6. Tabs for Batch Run, Protected Elements, Preview Options open:

Batch Run - Choose which of your defined skeletonization operations to run and
in what order to run them. Use Batch Run if you want to run skeletonization oper-
ations for more than one option, for example, a combination of Smart Pipe
Removal, Branch Collapsing, Series Pipe Merging, or Parallel Pipe Merging oper-
ations and where the order of applied operations is important.

Protected Elements - Saved as references to the originally skeletonized model.

Using the Skelebrator protected element settings with a different model is likely to
result in different (and unintended) elements being protected from skeletonization.
If you wish to re-run previously saved skeletonizations on the original model,
save your Skelebrator setup with the original model or in a place with a name that
shows that the export file belongs to that particular model.

8-532 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

Preview Options - Review the effects of a skeletonization on your model without

making any changes to or deletions from your model. Click the Ellipsis button to
select a color from the color palette.

7. Click Close to exit the window.

Bentley HAMMER V8i Edition User’s Guide 8-533

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.

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.

8-534 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

5. The following message opens:

Click Yes to continue.

6. Results of the batch run show in the drawing pane.

Bentley HAMMER V8i Edition User’s Guide 8-535

Using the Skelebrator Software

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
Bentley HAMMER 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.)

Selecting Elements from Skelebrator

This section describes how to use the selection tools to create Skelebrator-specific
selection sets.

8-536 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

In order to select elements from the Skelebrator user interface

1. Open the Example1 model which is included with Bentley HAMMER.

2. Go to Tools > Skelebrator Skeletonizer.
3. Click on the Protected Elements tab and click Select. The Skelebrator window
closes and a Select toolbar opens:

Done Used when you are finished with the element

selection process.

Add Used to process elements that are being added. As

the elements are selected they change to the default
color.

Remove Used to remove elements, not to delete them.

When the remove button is selected, anytime you

select a selection set menu item (see below) or
execute a query (see below), the results will be
removed from the selection. For example, if you
were to have the remove button selected and
created a custom query for pipes (see below for
details) and had no definition (clicking OK in the
Query Builder without any SQL statement
defined), it would remove all pipes from the
selection.

Bentley HAMMER V8i Edition User’s Guide 8-537

Using the Skelebrator Software

Select By Allows you to draw a polygon. All elements within

Polygon the polygon will be selected.

Query Opens a submenu containing various query

options.

Find Used for a Domain Element Search to run the

query.

Clear Used to clear the entire selection. You will be

prompted to verify if you want to clear the entire
selection.

4. Click Query and the following menu opens:

The first item listed is a selection set which is automatically created by Skele-
brator. When you select a selection set menu item, the IDs are retrieved and
applied to the selection. Only valid elements are selected.

The Custom Queries menu will contain menu items that allow you to create
custom, non-persisting queries for the valid elements.

8-538 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

Since this menu only contains custom queries for valid elements, any results
passed back from the query execution will be applied to the selection. In this
example only junctions and pipes can be selected so you can only create custom
queries for junctions and pipes.

The next set of menus are for the available queries. The queries are processed in
the following order: Project, Shared, and Predefined. Each menu item for the
queries represents the equivalent folder in the query manager View > Queries.

5. Click FIND to open the Domain Element Search window. Click to get
results for pipes and junctions. You can only select one row at a time. In order to
make your selection, select the row and click OK. If the element is not already
selected, it will be selected.

Note: In order to cancel the selection, click on the x.

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

Bentley HAMMER V8i Edition User’s Guide 8-539

Using the Skelebrator Software

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.

• Go To—Select an element in the element window and click Go To to jump to the

element in Bentley HAMMER. Bentley HAMMER displays the element at the
level of zoom you selected in the Zoom drop-down list.
• Next—Click Next to preview the next element in the Manual Skeletonization
Review dialog box.
• Previous—Click Previous to preview the previous element to the one you have
selected in the Manual Skeletonization Review dialog box.
• Protect—Click 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 skeleton-
ized during this skeletonization level; however, it is not precluded from subse-
quent skeletonization levels unless it also is protected.
• Execute—Click 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 speci-
fied. Additionally, for branch collapsing, one junction will be removed. For Series
Pipe Merging, two pipes and one junction will be removed, associated loads redis-
tributed 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 equiva-
lency.

8-540 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

• 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.
• Close—Click Close to exit the Manual Skeletonization Review dialog box. Any
remaining actions listed will not be executed.
• Zoom—Select a Zoom at which you want to display elements you preview using
Go To, Previous, and Next.

Bentley HAMMER V8i Edition User’s Guide 8-541

Using the Skelebrator Software

Branch Collapsing Operations

When you add or edit a Branch Collapsing operation, the Branch Collapsing Opera-
tion Editor dialog box opens. Branch Collapsing operations have two sets of parame-
ters, Settings and Conditions.

1. Click the Settings tab to edit settings.

– Maximum Number of Trimming Levels—Set 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 Strategy—Select 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.

8-542 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

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 skel-
etonizing 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.

Bentley HAMMER V8i Edition User’s Guide 8-543

Using the Skelebrator Software

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.

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.

8-544 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

Maximum Number of Removal Levels—Set 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 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 Criteria—Select the criteria by which Skelebrator determines the

dominant pipe. The dominant pipe is the pipe whose properties are retained as appro-
priate. 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 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 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 diam-
eter 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 rough-
ness 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 Strategy—If 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.

Bentley HAMMER V8i Edition User’s Guide 8-545

Using the Skelebrator Software

Maximum Minor Loss—If 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 Oper-
ation Editor dialog box opens. Operations have two sets of parameters, Settings and
Conditions.

1. Click the Settings tab to edit settings.

8-546 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

– Maximum Number of Removal Levels—Select 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 Criteria—Select the criteria by which Skelebrator deter-
mines 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 diam-
eter 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 the merged pipe properties as such to attain equivalent hydraulics as
the two merged pipes.
– Equivalent Pipe Method—Select whether you wish to modify the dominant
pipe roughness or the dominant pipe diameter for the equivalent pipe calcula-
tions.
- 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.

– Load Distribution Strategy—Select 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.
- 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.

Bentley HAMMER V8i Edition User’s Guide 8-547

Using the Skelebrator Software

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 Proportion—Set 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 Losses—Select Apply Minor Losses if you wish for Skele-
brator 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.

Tip: 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 TCVs—Activate this option by checking the box to allow

Skelebrator to remove TCVs during the Series Pipe Merging operation.
2. Click Conditions to edit or create conditions.

8-548 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

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 spec-
ified 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).

Bentley HAMMER V8i Edition User’s Guide 8-549

Using the Skelebrator Software

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 eval-
uate 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.

8-550 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

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.

1. Click the Settings tab to edit settings.

– Preserve Network Integrity—Select 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 Nodes—Select 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 physi-
cally connected to the hydraulic network, which will result in warning
messages when you run your model.
– Loop Retaining Sensitivity—Adjust 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 Skele-
brator’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.
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.

Bentley HAMMER V8i Edition User’s Guide 8-551

Using the Skelebrator Software

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.

8-552 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

• 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 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 diameter for the equivalent pipe calculations.
• 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 diam-
eter 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 doesn’t 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:

Bentley HAMMER V8i Edition User’s Guide 8-553

Using the Skelebrator Software

• Be valid in terms of the network topology with respect to the particular skeleton-
ization 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.

Attribute—Select the Attribute that you want to use to determine which pipes to skel-
etonize. These include:

• Bulk Reaction Rate

• Diameter
• Has Check Valve
• Installation Year
• Length
• Material
• Minor Loss Coefficient
• Roughness
• Wall Reaction Rate.

Operator—Select 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.

Value—The label, units, and appropriate value range depend on the attribute you
select.

8-554 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

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.

Attribute—Select the Attribute that you want to use to determine which junctions to
trim. These include:

• Base Flow
• Elevation
• Emitter Coefficient.

Operator—Select 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.

Value—The 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 toler-
ance 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 skele-
tonization.

Bentley HAMMER V8i Edition User’s Guide 8-555

Backing Up Your Model

Skelebrator Progress Summary Dialog Box

This dialog box opens following the successful completion of an automatic skeleton-
ization 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.

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 Bentley HAMMER, 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.

8-556 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

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, skele-

brator 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 skele-
tonization only works on the data in the alternatives referenced by the currently active
scenario.

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 recommenda-
tion 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 refer-
ences a child alternative of the Base scenario demand alternative, with local records at

Bentley HAMMER V8i Edition User’s Guide 8-557

Backing Up Your Model

junctions A-90 and A-100 which are to model the additional flow at the fire flow junc-
tions. 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/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 sepa-
rate to the original model and thus be able to be shared between users, is that the situ-
ation 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.

8-558 Bentley HAMMER V8i Edition User’s Guide

 Reducing Model Complexity with Skelebrator

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 informa-
tion 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 tempo-
rarily 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 condi-
tions 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)

Bentley HAMMER V8i Edition User’s Guide 8-559

Backing Up Your Model

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

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.

8-560 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and
Alternatives 9
Understanding Scenarios and Alternatives

Scenario Example - A Water Distribution System

Scenarios

Alternatives

Understanding Scenarios and Alternatives

Scenarios and alternatives allow you to create, analyze, and recall an unlimited
number of variations of your model. In Bentley HAMMER 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 inherit-

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

Bentley HAMMER V8i Edition User’s Guide 9-561

Understanding Scenarios and Alternatives

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.

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.

9-562 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

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

Bentley HAMMER V8i Edition User’s Guide 9-563

Understanding Scenarios and Alternatives

• Minimize the amount of data that needs to be duplicated to consider conditions

that have a lot in common.
The scenario management feature in Bentley HAMMER 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.

The 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 allows you to cycle through any number of changes to
the model, without fear of overwriting critical data or duplicating important informa-
tion. 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 under-
standing a group of master plan updates.

Figure 9-1: Manual Scenarios

9-564 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Scenario Attributes and Alternatives

• Attribute—An 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.
• Alternative—An 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.
• Scenario—A scenario has a list of referenced alternatives (which hold the
attributes) and combines these alternatives to form an overall set of system condi-
tions 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 data—the refer-
enced 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 entrée,
and a dessert. Each course has its own attributes. For example, the entrée 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 (combina-
tion of courses) that could be ordered. They can just assemble any meal based on what
the customer orders for each alternative course. Salad 1, Entrée 1, and Dessert 2 might
then be combined to define a complete meal.

Bentley HAMMER V8i Edition User’s Guide 9-565

Understanding Scenarios and Alternatives

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 alterna-
tives may have different numbers and types of attributes, and any category can have
an unlimited number of alternatives to choose from.

Generic Scenario Anatomy

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 dupli-
cated, 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.

9-566 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Overriding Inheritance
A child can override inherited characteristics by specifying a new value for that char-
acteristic. These overriding values do not affect the parent and are therefore consid-
ered 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.

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.

Bentley HAMMER V8i Edition User’s Guide 9-567

Understanding Scenarios and Alternatives

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

9-568 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Note: If the vegetable of the day changes (from green beans to peas),
only Entrée 1 needs to be updated, and the other entrées will
automatically inherit the vegetable attribute of "Peas" instead of
"Green Beans."

• "Entrée 2 is just like Entrée 1, except for the meat and the starch."
• "Entrée 3 is just like Entrée 2, except for the meat."

Note: Dessert 3 has nothing in common with the other desserts, so it

can be created as a "root" or base alternative. It does not inherit
its attribute data from any other alternative.

• "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 the phrase
“just like x except for y”, but on a larger scale.

Using the meal example, consider a situation where you go out to dinner with three
friends. The first friend orders a meal and the second friend orders the same meal with
a different dessert. The third friend orders a different meal and you order the same
meal with a different 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 entrée alterna-
tives are inherited from Meal 1.
• "Meal 3 is nothing like Meal 1 or Meal 2." A new base or root is created.

Bentley HAMMER V8i Edition User’s Guide 9-569

Scenario Example - A Water Distribution System

• "Meal 4 is just like Meal 3, except for the salad." The entrée and dessert alterna-
tives 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

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 hierar-
chies look like the following (showing only the items of interest):

9-570 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

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-
2’s demand from Average Day while the other two demands are overridden.

Now we can create a child scenario from Average Day that inherits the physical alter-
native 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.

Bentley HAMMER V8i Edition User’s Guide 9-571

Scenario Example - A Water Distribution System

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 indus-
trial 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 gpm—it is 1,500 gpm. However, due to the inheritance
within the demand alternatives, only the Average Day demand for J-2 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.

9-572 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

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-1’s, which is overridden.
• Slightly larger diameters are proposed for all pipes. Since there are no commonal-
ities 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 to be modeled is
already present in the alternatives.

Bentley HAMMER V8i Edition User’s Guide 9-573

Scenarios

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). 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 the same.

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 results—all with a few mouse clicks.

9-574 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Scenarios Manager

The Scenario Manager allows you to create, edit, and manage an unlimited number of
scenarios. There is one built-in default scenario—the 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.

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.

Bentley HAMMER V8i Edition User’s Guide 9-575

Scenarios

New Scenario Opens a submenu containing the following

commands:
• Child Scenario—creates a new Child
scenario from the currently selected Base
scenario.
• Base Scenario—creates a new Base
scenario.

Delete Removes the currently selected scenario, greyed

out on the menu bar when Base Scenario is
active.

Rename Renames the currently selected scenario.

Compute Opens a submenu containing the following

Scenario command:
• Scenario—calculates the currently selected
scenario.

Make Current Causes the currently selected scenario to

become the active one and displays it in the
drawing pane.

Expand All Opens all scenarios within all folders in the list.

Collapse All Closes all of the folders in the list.

Help Displays online help for the Scenario Manager.

9-576 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

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 Scenarios—Contain 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 Scenarios—Inherit 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.

Note: The calculation options are not inherited between scenarios but
are duplicated when the scenario is first created. The
alternatives and data records, however, are inherited. There is a
permanent, dynamic link from a child back to its parent.

Creating Scenarios

You create new scenarios in the Scenario Manager. A new scenario can be a Base
scenario or a Child scenario.

Bentley HAMMER V8i Edition User’s Guide 9-577

Scenarios

To create a new scenario

1. Select Analysis > Scenarios to open the Scenario Manager, or click .

2. Click New and select whether you want to create a Base Scenario or a Child
Scenario. When creating a Child scenario, you must first select 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.

4. Close when finished.

Editing Scenarios
Scenarios can be edited in two places:

• The Scenario Manager lists all of the project’s 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 selected 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.

9-578 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

To edit a scenario

1. Select Analysis > Scenarios to open the Scenario Manager, or click .

2. Double-click the scenario you want to edit to display its properties in the Proper-
ties Editor.
3. You can then edit the Scenario Label, Notes, Alternatives, and Calculation
Options.
4. When finished, close the editor.

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. Alterna-
tives 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 alterna-
tive.

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.

Bentley HAMMER V8i Edition User’s Guide 9-579

Alternatives

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 alterna-
tives for that type and a toolbar.

9-580 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

The toolbar consists of the following

New Creates a new Alternative.

Delete Deletes the currently selected alternative.

Duplicate Creates a copy of the currently selected

alternative.

Open Opens the Alternative Editor dialog box for

the currently selected alternative.

Merge Alternative Moves all records from one alternative to

another.

Rename Renames the currently selected alternative.

Report Generates a report of the currently selected

alternative.

Expand All Displays the full alternative hierarchy.

Collapse All Collapses the alternative hierarchy so that

only the top-level nodes are visible.

Help Displays online help for the Alternative

Manager.

Bentley HAMMER V8i Edition User’s Guide 9-581

Alternatives

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.

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 alter-
native.

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.

9-582 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

When the editor has tabs for various element types, you can determine whether the
alternative contains data for that element type by the icon next to the element type ; if
it is highlighted , the alternative contains data for that element type. If the element
type is not used in the current model the tab is marked with an icon .

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.

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.

Bentley HAMMER V8i Edition User’s Guide 9-583

Alternatives

Creating Alternatives

New alternatives are created in the Alternative Manager dialog box. A new alternative
can be a Base scenario or a Child scenario. Each alternative type contains a Base alter-
native in the Alternative Manager tree view.

To create a new Alternative

1. Select Analysis > Alternatives to open the Alternative Manager, or click .

2. To create a new Base alternative, select 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 menu.
4. Double-click the new alternative to edit its properties.

5. Click Close when finished.

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.

9-584 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

• 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 alternative’s parent.

To edit an existing alternative, you can use one of two methods:

• Double-click the alternative to be edited in the Alternative Manager or

• Select the alternative to be edited in the Alternative Manager and click Edit

In either case, the Alternative Editor dialog box for the specified alternative opens,
allowing you to view and define settings as desired.

Bentley HAMMER V8i Edition User’s Guide 9-585

Alternatives

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.

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 alterna-
tive.

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.

9-586 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

The following buttons are available:

Bentley HAMMER V8i Edition User’s Guide 9-587

Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

9-588 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

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 Bentley HAMMER 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.

Bentley HAMMER V8i Edition User’s Guide 9-589

Alternatives

Note: If you add new elements in the base scenario, they will show up
in the child scenario.

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.

9-590 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

The Physical Alternative editor for each element type is used to create various data
sets for the physical characteristics of those elements.

Bentley HAMMER V8i Edition User’s Guide 9-591

Alternatives

The following buttons are available:

9-592 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

Bentley HAMMER V8i Edition User’s Guide 9-593

Alternatives

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.

9-594 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Initial Settings Alternative

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.

Bentley HAMMER V8i Edition User’s Guide 9-595

Alternatives

The following buttons are available:

9-596 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

Bentley HAMMER V8i Edition User’s Guide 9-597

Alternatives

9-598 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Operational Alternatives

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

The Operational Controls alternative allows you to create, modify and manage both
logical controls and logical control sets.

Bentley HAMMER V8i Edition User’s Guide 9-599

Alternatives

The following buttons are available:

9-600 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

Bentley HAMMER V8i Edition User’s Guide 9-601

Alternatives

Age Alternatives

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.

9-602 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

The following buttons are available:

Bentley HAMMER V8i Edition User’s Guide 9-603

Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

9-604 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Constituent Alternatives

The Constituent Alternative contains the water quality data used to model a constit-
uent 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 main-
taining 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 constit-
uent source type is set to "Mass Rate".

Bentley HAMMER V8i Edition User’s Guide 9-605

Alternatives

• Constituent Source Type - there are four ways in which you can specify a
constituent entering a system:
– 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).

9-606 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

The following buttons are available:

Bentley HAMMER V8i Edition User’s Guide 9-607

Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

9-608 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

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.

Bentley HAMMER V8i Edition User’s Guide 9-609

Alternatives

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 Alter-
native data includes a Trace Node, which is the node from which all tracing is
computed.

9-610 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

The following buttons are available:

Bentley HAMMER V8i Edition User’s Guide 9-611

Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

9-612 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Fire Flow Alternative

The Fire Flow Alternative contains the input data required to perform a fire flow anal-
ysis. 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.

The Fire Flow Alternative window is divided into sections which contain
different fields to create the fire flow.

Use Velocity If set to true, then a velocity constraint can be

Constraint? specified for the node.

Bentley HAMMER V8i Edition User’s Guide 9-613

Alternatives

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 Maximum allowable fire flow that can occur at a
Limit) 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.

9-614 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Pressure (Residual Minimum residual pressure to occur at the junction

Lower Limit) 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 Minimum pressure to occur at all junction nodes

Limit) 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 System Check whether a minimum pressure is to be

Pressure Constraint? maintained throughout the entire pipe system.

Pressure System Minimum pressure allowed at any junction in the

Lower Limit 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.

Bentley HAMMER V8i Edition User’s Guide 9-615

Alternatives

Fire Flow Auxiliary This setting controls whether the fire flow analysis
Results Type 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 Defines whether to include in the stored fire flow

Auxiliary Output by auxiliary results, results for nodes that fall below a
Node Pressure Less defined pressure value. Such nodes might
Than? indicate low pressure problems under the fire flow
conditions.

Node Pressure Less Specifies the number.

Than?

Use Pipe Velocity Defines whether to include in the stored fire flow
Greater Than? 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 Specifies the number.

Than?

Auxiliary Output This selection set is used to force any particular

Selection Set 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.

9-616 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Fire Flow System Data

Each fire flow alternative has a set of default parameters that are applied to each junc-
tion 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.

Column Description

ID Displays the unique identifier for each element in

the alternative.

Label Displays the label for each element in the

alternative.

Specify Local Fire Select this check box to allow input different from
Flow Constraints? 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.

Bentley HAMMER V8i Edition User’s Guide 9-617

Alternatives

Column Description

Pressure (Residual Minimum residual pressure to occur at the

Lower Limit) 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 Minimum pressure to occur at all junction nodes

Limit) 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 Minimum pressure to occur at all junction nodes

Lower Limit) 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:

• Column—The attribute to filter.

• Operator—The operator to use when comparing the filter value against the data
in the specific column (operators include: =, >, >=, <, <=, < >).
• Value—The 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.

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.

9-618 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Energy Cost Alternative

The Energy Cost Alternative allows you to specify which tanks, pumps, and variable
speed pump batteries will be included in the Energy Cost calculations. For pumps, you
can also select which energy pricing pattern will be used or create a new one. You can
also run a report.

Bentley HAMMER V8i Edition User’s Guide 9-619

Alternatives

The following buttons are available:

9-620 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

Bentley HAMMER V8i Edition User’s Guide 9-621

Alternatives

Pressure Dependent Demand Alternative

The Pressure Dependent Demand Alternative allows a pressure dependent demand

function to be used.

9-622 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

The following buttons are available:

Bentley HAMMER V8i Edition User’s Guide 9-623

Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

9-624 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Transient Alternative

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

Bentley HAMMER V8i Edition User’s Guide 9-625

Alternatives

The following buttons are available:

9-626 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

Bentley HAMMER V8i Edition User’s Guide 9-627

Alternatives

Flushing Alternative

The flushing alternative allows you to define flushing events and the conditions of a
flushing analysis.

The alternative consists of the following controls:

Target Shear Stress:

9-628 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

Failure History Alternative

The Failure History alternative allows you to edit data associated with pipe break
analysis.

Failure History Alternative Properties

Column Description

ID Displays the unique identifier for each element in the

alternative.

Label Displays the label for each element in the alternative.

Use Local When this box is checked the value entered in the
Duration of Pipe corresponding Duration of Pipe Failure History
Failure History? column will override the duration set in the Length of
Pipe Break History field.

Bentley HAMMER V8i Edition User’s Guide 9-629

Alternatives

Failure History Alternative Properties

Column Description

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 The local duration of the pipe failure history. This
Failure History column becomes editable for pipes that have the Use
Local Duration of Pipe Failure History? box checked.

User Data Extensions

The User Data Alternative allows you to edit the data defined in the User Data Exten-
sion 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.

9-630 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

The following buttons are available:

Bentley HAMMER V8i Edition User’s Guide 9-631

Alternatives

Selection Opens a submenu containing the following

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

Select in Opens a submenu containing the following

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

Report Generates a report containing the data

within the current alternative.

Help Opens the online help.

9-632 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

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 Bentley HAMMER Toolbars and Buttons).

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

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.

Bentley HAMMER V8i Edition User’s Guide 9-633

Scenario Comparison

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.

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

9-634 Bentley HAMMER V8i Edition User’s Guide

 Scenarios and Alternatives

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.

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.

Bentley HAMMER V8i Edition User’s Guide 9-635

Scenario Comparison

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.

9-636 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities
10
Model and Optimize a Distribution System

Steady-State/Extended Period Simulation

Global Demand and Roughness Adjustments

Check Data/Validate

Calculate Network

Flow Emitters

Parallel VSPs

Calculation Options

Patterns

Controls

Active Topology

External Tools

Model and Optimize a Distribution System

Bentley HAMMER V8i provides modeling capabilities, so that you can model and
optimize practically any distribution system aspect, including the following opera-
tions:

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

Bentley HAMMER V8i Edition User’s Guide 10-637

Steady-State/Extended Period Simulation

– Use any common friction method: Hazen-Williams, Darcy-Weisbach, or

Manning’s 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.

Modeling capabilities include:

• Steady-State/Extended Period Simulation

• Global Demand and Roughness Adjustments
• Check Data/Validate
• Calculate Network
• Flow Emitters
• Parallel VSPs
• Calculation Options
• Patterns
• Controls
• Active Topology

Steady-State/Extended Period Simulation

Bentley HAMMER V8i can compute the initial conditions for your transient simula-
tion, 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.

10-638 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Steady-State Simulation

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.
See Calculate Network for details.

Extended Period Simulation (EPS)

Note: Do not confuse the below referenced EPS simulation with the
transient simulation. An EPS simulation can be used in
HAMMER to establish the initial conditions for the transient
simulation (Analysis > Compute Initial Conditions). When
computing the transient simulation (Analysis > Compute) the
hydraulic conditions at the time selected from the "Initialize
Transient Run at Time" calculation option are used as the initial
conditions for the transient simulation. See Calculate Network for
details.

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 tanks filling and
draining, regulating valves opening and closing, and pressures and flow rates
changing throughout the system in response to varying demand conditions and auto-
matic control strategies formulated by the Bentley HAMMER.

While a steady-state model may tell whether the system has the capability to meet a
certain average demand, 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. Extended period simulations (EPSes) can also be used for energy consump-
tion and cost studies, as well as water quality modeling.

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 water usage Patterns, more detailed tank information, and operational rules
for pumps and valves.

Bentley HAMMER V8i Edition User’s Guide 10-639

Hydraulic Transient Pressure Analysis

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 Time—Select the clock time at which the simulation begins.

• Duration—Specify the total duration of an extended period simulation.
• Hydraulic Time Step—Select the length of the calculation time step.
• Override Reporting Time Step?—Set to true if you want the Reporting Time
Step to differ from the Hydraulic Time Step.
• Reporting Time Step—Data will be presented at every reporting time step. The
reporting time step should be a multiple of the hydraulic time step.

Note: If you run an Extended Period Simulation, you can generate

graphs of the 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.

Hydraulic Transient Pressure Analysis

Steady-state hydraulic models, such as Bentley HAMMER, simulate systems in
which a dynamic equilibrium has been achieved and where changes in head or flow
take minutes to hours. Bentley HAMMER can also solve such systems using a steady
state run. In contrast, Bentley HAMMER also simulates hydraulic systems whose
balance has been upset by rapid control-valve operation or other emergencies—all
occurring in seconds or fractions of a second.

10-640 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

With Bentley 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, Bentley HAMMER
automatically adjusts its solution method to minimize execution time, while delivering
detailed and accurate solutions. Bentley HAMMER uses one or both of these algo-
rithms:

Method of Characteristics (MOC) solution of the full continuity and momentum equa-
tions 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.

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

Note: All demands are pressure dependent during a Transient

analysis.

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 phenom-
enon, where gradual changes in momentum occur without significant or sharp pres-
sure 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 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 Transient Solver Calculation Options, set Run Extended CAV to True.
Bentley HAMMER will track the extent of the air pocket and the resulting mass-oscil-
lation and water column accelerations. Bentley 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

Bentley HAMMER V8i Edition User’s Guide 10-641

Hydraulic Transient Pressure Analysis

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 pressur-
ized 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.

Bentley 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 exper-
iments, where transient data were measured and used to validate numerical simu-
lation 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. Bentley HAMMER is
such a model. It is the result of decades of experience and innovation by GENIVAR's
(EHG) 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 repre-
sentation 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:

10-642 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

• 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.
You can use simple methods to estimate each of the above parameters, as described
elsewhere in this documentation and in the Bentley 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.

Bentley HAMMER V8i Edition User’s Guide 10-643

Hydraulic Transient Pressure Analysis

• 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, espe-
cially 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 Bentley 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 Bentley HAMMER: revisit pipe class and/or add protec-
tive 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.
• 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.
Bentley 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.

10-644 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Infrastructure and Risk Management

Bentley 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 opti-
mizing 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 direc-
tion as flows and pressures oscillate and dampen to the new steady-state.
• Predict overflows at outfalls or spills to the environment more accurately.
• Manage the risk of contamination during subatmospheric transient pressures,
which can suck air, dirt, and contaminants into your system.

Water Column Separation and Vapor Pockets

During a hydraulic transient event, the hydraulic-grade line (HGL), or head, at some
locations may drop low enough to reach the pipe’s elevation, resulting in sub-atmo-
spheric 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 V8i makes a number of assumptions with respect to the formation
of air or vapor pockets and the resulting water column separation:

• Bentley HAMMER V8i 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.

Bentley HAMMER V8i Edition User’s Guide 10-645

Hydraulic Transient Pressure Analysis

• Bentley HAMMER V8i 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, Bentley HAMMER V8i 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.
• Bentley HAMMER V8i 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
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 Bentley HAMMER V8i’s results
provide conservative predictions of extreme transient pressures.

Global Adjustment to Vapor Pressure

If system pressure drops to the fluid’s vapor pressure, the fluid flashes into vapor,
resulting in a separation of the liquid columns. Consequently, vapor pressure is a
fundamental parameter for hydraulic transient modeling. Vapor pressure changes
significantly at high temperature, operating pressure, or altitude. Fortunately, it
remains close to Bentley HAMMER V8i’s default value for a wide range of these
variables for typical water pipelines and networks.

If your system is at high altitude or if it is an industrial system operating at high

temperatures or pressures, consult a steam table or vapor-pressure curve for the liquid.
Consider a few extra model runs to assess the sensitivity of the hydraulic transient
simulation results to global changes in vapor pressure—you can change it in the Tran-
sient Solver Calculation Options Properties > Vapor Pressure field..

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 in the Transient Solver Calculation Options Properties >
Pressure Wave Speed field.

10-646 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Wave Speed Reduction Factor

In any liquid there is a certain amount of absorbed gas with which it has been in
contact through a free surface. When the pressure in a pipeline drops to a sufficiently
low level, the dissolved gas comes out of solution. Due to the presence of entrained air
or free gas, the celerity of pressure waves is reduced, thereby mitigating the subse-
quent upsurges when vapor cavities collapse. In contrast to vapor release which typi-
cally occurs within milliseconds, the time for gas release and (re)absorption is of the
order of seconds. In traditional computer models of hydraulic transients, the occur-
rence of gas release at low pressure in the liquid is ignored to yield conservative
results which may overestimate the peak pressures in the piping system resulting from
the collapse of discrete vapor cavities. Bentley HAMMER provides a way to account
for the impact of gas release without delving into the complex multi-fluid and
multiphase physical phenomena.

The Wave Speed Reduction Factor calculation option allows you to model the reduc-
tion in celerity that occurs at low pressure. Entering a value below 1.0 will result in
the following behavior:

1. At the start of a simulation, the wave speed equals the user entered value.
2. If the pressure at any pipe segment drops below the pipe elevation (i.e. negative
pressure), then the wave speed will be reduced. The (linear) rate at which it is
reduced is equal to: (original wave speed - [Wave Speed Reduction Factor *orig-
inal wave speed]) / Decrease Time).
3. If the pressure becomes positive again before the wave speed has been adjusted
down to its fully reduced value (Wave Speed Reduction Factor *original wave
speed), then the wave speed will start to increase back up to the original value.
The (linear) rate at which it is increased is equal to: (original wave speed - [Wave
Speed Reduction Factor *original wave speed]) / Increase Time).
4. Alternatively, if the pressure stays negative for long enough, the wave speed will
be adjusted all the way down to: (Wave speed reduction factor *original wave
speed). It will be held at this value until the pressure in the pipe segment is posi-
tive again, at which point it will start to be increased. The rate will be as described
in #3 above.

Bentley HAMMER V8i Edition User’s Guide 10-647

Hydraulic Transient Pressure Analysis

Consider the below graph of wave speed for a pipe segment over time:

[0] indicates that the wave speed is at its original value.

[-1] indicates a reduction in wave speed due to pressure falling below zero.

[1] indicates an increase in wave speed due to pressure becoming positive again

[2] indicates that the wave speed has been fully reduced (to the wave speed reduction
factor * the original wave speed)

Therefore, the graph indicates that the pressure first dropped below zero, but became
positive shortly after, before the wave speed was fully reduced. It then dropped again
and remained negative long enough for the wave speed to fully reduce. Next, the pres-
sure became positive again but fell back below zero shortly after, before the wave
speed returned to the original value.

10-648 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Automatic or Direct Selection of the Time Step

Bentley HAMMER V8i selects the time step used in its calculations automatically,
based on the wave speed and the length of each pipe in the system, so that a sharp
pressure-wave front can travel the length of one of the pipe’s interior segments in one
time step. Encoding long pipeline systems with very short pipes, such as discharge-
header piping inside the pump station, may significantly decrease the time step and
increase the time required to complete a run.

Warning! Using very short pipes (in a pump station) and very long
pipes (transmission lines) in the same Bentley HAMMER V8i
model could require excessive adjustments to the wave
speed. If this happens, Bentley HAMMER V8i prompts you to
subdivide longer pipes to avoid resulting inaccuracies.

A smaller time step may cause Bentley HAMMER V8i to track the formation and
collapse of very fine vapor pockets, each of which may result in pressure spikes with
low magnitudes but high frequencies. If your Bentley HAMMER model includes
excessively short pipes (perhaps introduced on import) that result in a small time step,
it may be possible to merge them automatically using Tools > Skelebrator Skeleton-
izer, enabling faster solutions without sacrificing accuracy. See Using the Skelebrator
Software for more information on the Skelebrator Skeletonizer tool.

You can also select the time step from the Analysis > Transient Time Step Options
dialog.

Validate

This feature allows you to validate your model against typical data entry errors, hard
to detect topology problems, and modeling problems.You can validate the model
before detailed calculations are begun by clicking the Analysis menu and selecting the
Validate command. 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:

• Network Topology—Checks that the network contains at least one boundary

node, one pipe, and one junction, the minimum network requirements. It also
checks for fully connected pumps and valves and that every node is reachable
from a boundary node through open links.
• Element Validation—Checks that every element in the network is valid for the
calculation. For example, this validation ensures that all pipes have nonzero
length, nonzero diameter, etc. Each type of element has its own checklist. This
same validation is performed when you edit an element in a dialog box.

Bentley HAMMER V8i Edition User’s Guide 10-649

Hydraulic Transient Pressure Analysis

The validation process generates two types of messages. A warning message means
that a particular part of the model (e.g., a pipe’s roughness) does not conform to the
expected value or is not within the expected range of values. This type of warning is
useful but not fatal. Therefore, no corrective action is required to proceed with a
calculation. Warning messages are often generated as a result of a topographical or
data-entry error and should be corrected.

Note: If your model will not run due to error messages and you do not
know how to proceed, please contact Bentley Systems’ support
staff (see Contacting Bentley Systems About Haestad Methods
Products).

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

Orifice Demand and Intrusion Potential

In Bentley HAMMER, flow emitters are devices associated with junctions that model
the flow through a nozzle or orifice (i.e., orifice demand). The demand or 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 (or L/s at a 1 m pressure drop).

Emitters are used to model flow through sprinkler systems and irrigation networks.
They can also simulate leakage in a pipe connected to the junction (if a discharge coef-
ficient and pressure exponent for the leaking crack or joint can be estimated) or to
compute a fire flow at the junction.

In Bentley HAMMER V8i, any demand at a node is called a consumption node and
is treated as an orifice discharging to atmosphere that cannot allow air back into the
system during periods of subatmospheric pressure. This is because the majority of
water demands entered into hydraulic models are really the sum of several houses or
demand points, each located at a significant distance from the point where their aggre-
gate demand is being modeled. By default, Bentley HAMMER V8i assumes that any
air allowed into the system at the individual demand points cannot reach the aggregate
demand location. If this is not the case, use one of the following hydraulic elements:

10-650 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

• Discharge to Atmosphere—Models a demand point located a hydraulically short

distance from its node coordinates (based on the wave speeds of the pipes
connected to it). The initial pressure and flow are used to automatically calculate a
flow emitter coefficient, which will be used during the simulation to calculate
transient outflows. If pressure in the system becomes subatmospheric during the
simulation, this element allows air into the system. You can also specify a volume
of air at time zero to use this element to simulate an inrush transient.
• Orifice between two pipes—Models a demand point in a manner similar to the
element Orifice to Atmosphere. You can enter the orifice’s elevation and distance
away from the node’s coordinates to simulate fire hoses or sprinkler systems.

Table 10-1: Bentley HAMMER V8i Consumption Node Table

System Pressure
Hydraulic
Elements
Positive Negative

Pressure
Consumption No flow
dependent

Orifice to Pressure
Air intrusion
Atmosphere dependent

Numerical Model Calibration and Validation

As part of its expert witness and break-investigation service, GENIVAR has calibrated
and validated Bentley HAMMER V8i’s numerical simulations for different fluids and
systems for clients in the civil (water and wastewater), mining (slurry), and hydro-
power 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 assump-
tions. 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 cali-
brated 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 compar-
isons require threshold and span calibration of all sensor groups, multiple simulta-
neous datum and time base checks and careful test planning and interpretation.
Sound calibrations match multiple sensor records and reproduce both peak timing
and secondary signals—all measured every second or fraction of a second.

Bentley HAMMER V8i Edition User’s Guide 10-651

Hydraulic Transient Pressure Analysis

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 diffi-
cult, 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.
• 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 impos-
sible. 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 pres-
sures are simulated with enough accuracy to support definitive conclusions.

Consequently, Bentley HAMMER V8i is a powerful and essential tool to design and
operate hydraulic systems provided the results are interpreted carefully and scruti-
nized as follows:

10-652 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

• 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 config-
urations, 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
Bentley HAMMER V8i 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 pres-
sure 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 loca-
tions 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 operations. This requires field measurements to quantify your system’s
pressure-wave speed and friction, with the following considerations:

Bentley HAMMER V8i Edition User’s Guide 10-653

Hydraulic Transient Pressure Analysis

• Field measurements can clearly indicate the evolution of the transient. The
pressure-wave speed for a pipe with typical material and bedding can be deter-
mined if the period of the transient (4 L/a) and the length (L) between measure-
ment 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 shut-
down 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.

Application of HAMMER to Typical Problems - Overview

Transients occur whenever the momentum of a fluid changes. HAMMER is a generic

transient analysis tool which can be used for a wide variety of such problems. There
are some typical problems in water and wastewater systems for which HAMMER is
often applied. The typical use-cases are described below in an overview of the steps to
use HAMMER.

1. Create model. While it is possible to build a model from scratch in HAMMER, it

is usually easiest to simply open a WaterCAD/WaterGEMS model in HAMMER.
Other options include importing an EPANET model or building a model from
CAD, data base or GIS with ModelBuilder.
2. Simplify model. Once the model is built and open, it is helpful to clean it up to
make it run more efficiently. In particular, very short pipes (relative to the average
pipe length) can slow down the model, so it can be beneficial to merge them with
adjacent pipes. Skelebrator is the easiest way to do this using the Series Pipe
Merging feature. In general, a model with fewer pipes will run faster.
3. Typical applications. There are several standard problems which HAMMER can
solve: Transient specific behaviors are saved in the Transient Alternative not the
Physical Alternative. For example, pump characteristics are stored in the Physical
alternative but pump shut down times during a transient analysis are stored in the
Transient Alternative.
a. Pump shut down or start up. First go into Components > Pump Definition >
Transient tab, where you set pump inertia and specific speed properties for the
pumps that will cause transients. Then go to the individual pump element and
set the "Pump Type (Transient)" property to "Shut down after time delay" to
initiate a pump shut down. Then indicate the time until the shut down begins
(Time (Delay until shut down)) and the time taken for the built in control

10-654 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

valve to close (Time (For Valve to Close)). (Note: a value of zero for the time
for the valve to close indicates that the valve will close instantaneously once it
senses reverse flow). HAMMER will compute the time it takes for the pump
to shut down based on the pump's inertia and speed. If the pump operates
outside of the normal quadrant of operation (i.e. either the pump speed, flow
or both becomes negative), HAMMER will compute the pump operation
using built in four-quadrant pump curves. The four-quadrant curves used for
each pump are specified by selecting the appropriate specific speed for the
pump.
To model the effect of ramping up and down of variable speed pumps, or
starting a pump up can be simulated by setting the "Pump Type (Transient) to
"Variable Speed" and then specifying an Operation Transient Pump Pattern
under Components > Patterns.
b. Operating hydrant or other discharge. Opening of a hydrant, blowoff, sprin-
kler or other discharge can be modeled in two ways - Discharge to Atmo-
sphere or Periodic Head Flow Element.
For discharge to atmosphere, select Valve as the Discharge Element type and
specify the initial status. If the valve is initially closed at the start of the tran-
sient simulation, it will open and vice versa. Set the time to start operating and
the time to be fully open; the valve opening increases linearly. Set the emitter
value for the element by specifying the pressure drop at some flow rate. For
example, a standard 2.5 in. (100 mm) hydrant outlet would have a pressure
drop of roughly 10 psi at 500 gpm.
c. To use a periodic head flow element, the user should specify that the operation
is not sinusoidal (False) and then select whether they will specify the flow or
head. For most devices, the user knows the flow. Then the user creates the
flow (head) vs. time pattern by clicking the ellipsis button next to Collection.
d. Operating in-line valves. Operating in-line valves such as butterfly, gate or
globe valves is simulated using a Throttling Control Valve (TCV) element
(although a Valve with linear area can sometimes also be used). With the
throttling control valve, the user must specify the Operational rule which is
created in the Components > Patterns > Operational (Transient Valves) and
select one of those patterns as the Operating Rule for the valve.

4. Calculation options. The user must then set up the calculation options under
Calculation options > Transient Solver. Among the minimum items that must be
specified are the Run Duration (which can be based on time or number of time
steps) and global Pressure Wave Speed. The user can also override the wave speed
for individual pipes in the Transient alternative > Pipes (in which case they should
set the global Pressure Wave Speed to zero). If the user wishes to view anima-
tions, it is necessary to change the Generate Animation Data property to True.

Bentley HAMMER V8i Edition User’s Guide 10-655

Hydraulic Transient Pressure Analysis

5. Set up scenario. The user then creates the scenario just as in WaterGEMS being
sure to include the correct Transient alternative and Transient Solver Calculation
options. It is best to run a steady state solution first as a check and then run the
transient problem.
6. Viewing Results. While summary transient results (e.g. maximum pressure,
minimum velocity, etc) can be viewed in FlexTables, Graphs and Profiles (under
the Tools menu) the time varying transient results are viewed using the Transient
Results Viewer under the Analysis menu. The user can view profiles along the
pre-selected profile paths or plots of head, pressure, flow and vapor pocket
volume.
Elements in the plan view may be color coded based on the summary transient
results by using the Element Symbology tools under the View menu. However,
additional detail can be seen by using the Transient Thematic Viewer to color code
elements, since the Transient Thematic Viewer individually color codes the inte-
rior segments of each pipe.

How Valve Discharge Coefficient Values are Exported to the

HAMMER Engine

During Transient Calculations or when exporting to HAMMER v7 format, valve

discharge coefficient values are determined as follows:

1. If the Specify Initial Conditions calculation option is True, then the discharge
coefficient is taken from the valve's Discharge Coefficient (Initial) input field.
Otherwise the initial conditions for the Transient calculation are taken from the
pressure engine.
2. If the valve is a TCV, then the discharge coefficient is copied from the Initial
Settings fields. Depending on the Coefficient Type field, the discharge coefficient
will be taken from either Discharge Coefficient (Initial), or calculated based on
Headloss Coefficient Setting (Initial).
3. If the valve calculated status is Active, then the discharge coefficient is calculated
from the flow and headloss result values.
4. If the valve is Inactive or Closed, then the minor loss coefficient is used to calcu-
late the discharge coefficient.
5. If the minor loss equals zero, then a very large discharge coefficient is used.

10-656 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Calculate Network
There are two main types of calculations in HAMMER:

1. Steady State / EPS analysis (for computing the initial conditions for a transient
analysis)
2. Transient analysis

Every transient analysis needs a set of 'initial conditions' - i.e. flows, pressures, tank
levels, etc. at the start of the transient analysis. You can specify the initial conditions
manually (by setting the Specify Initial Conditions? Transient Solver calculation
option to True - see Calculation Options for details - then manually typing in values
for the fields grouped under Transient Initial in the Property Editor), but it is generally
more efficient to have HAMMER compute them via a Steady State or EPS run.

The Steady State / EPS calculations in HAMMER are the same as Steady State / EPS
runs in Bentley WaterCAD and Bentley WaterGEMS. So, if you already have a
WaterCAD or WaterGEMS model, you can open that in HAMMER and use it to
compute the initial conditions. If you are starting from a new model, the process for
setting up and running a Steady State / EPS analysis is as follows:

1. Click the Analysis toolbar and select Calculation Options.

2. In the Calculation Options dialog, double-click Base Calculation Options under
the Steady State / EPS Solver folder, or create a new set of Calculations Options
and double-click it. This will open the Property Editor.
3. In the Property Editor, set the Time Analysis Type to Steady-State or EPS
(Extended Period Simulation). If EPS is selected, then specify the starting time,
the duration, and the time step to be used. (Note: the EPS capability does not
consider momentum, and is therefore incapable of analyzing hydraulic transients.
Generally an EPS analysis is used to model a system up to a significant system
change, like a pump shutting down, and then a transient analysis can begin from
there).
4. 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 spec-
ified, 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 Steady State or EPS field data.

Bentley HAMMER V8i Edition User’s Guide 10-657

Calculate Network

5. Optionally, verify and/or adjust the settings in Hydraulics section to change the
general algorithm parameters used to perform Steady State / EPS calculations.
6. Click Compute Initial Conditions to start the Steady State / EPS calculations, or
alternatively set up a transient analysis as described below and compute the initial
conditions and transient analysis simultaneously.

Once the initial conditions are established a transient analysis can be performed by
following these steps:

1. Set up an event to initiate the transient - for example specify a pump that will shut
down, or a valve that will close. This is generally done by setting appropriate
values in the Transient (Operational) group of properties in the Property Editor.
(For more information refer to the documentation on the specific model.)
2. Click the Analysis toolbar and select Calculation Options.
3. In the Calculation Options dialog, double-click Base Calculation Options under
the Transient Solver folder, or create a new set of Calculations Options and
double-click it. This will open the Property Editor.
4. In the Property Editor, set the Run Duration Type to Time or Time Steps, and then
set the Run Duration. (Note: a transient analysis typically uses a very small time
step, and the transient events are generally over quickly, so a typical Run Duration
might be 1 or 2 minutes.)
5. If you used an EPS simulation to compute the initial conditions, specify the EPS
result timestep that represents the transient analysis initial conditions by setting
the Initialize Transient Run as Time property to the appropriate value. (Note:
the value you enter should be in hours from the start of the EPS run. HAMMER
will use the closest available EPS result timestep to the value you enter here).
6. Optionally, specify the Report Points that you wish to save calculation results for,
as well as the Report Times when you want to save results. The choices are: Peri-
odically - periodically save results according to the Report Period; At Specific
Times - as specified in the Report Times Collection; At All Times; and At No
Times. (Note: a transient analysis can produce a large amount of result data.
Using the Periodically option can reduce output file sizes and improve calcula-
tion performance.)
7. Optionally, choose to save animation data by setting Generate Animation Data
to True. This will enable you to display animations of the results in the Transient
Result Viewer after the transient analysis is complete.
8. Optionally, verify and/or adjust the general algorithm parameters used to perform
the Transient Analysis. For more information refer to Calculation Options.
9. Click Compute to start the transient analysis. If you have not yet computed the
initial conditions you should confirm that the Always Compute Initial Condi-
tions menu item is checked on (click Analysis > Always Compute Initial Condi-

10-658 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

tions to toggle this option on and off). If the initial conditions do not change from
one transient analysis to another you can save (a typically small amount of) time
by leaving Always Compute Initial Conditions off.
10. If the model is not set up correctly you will receive a warning message. Check the
User Notifications for information, or perform a full validation (click Analysis >
Validate) for more details.
11. Once the calculation is complete the Transient Calculation Summary will appear.
Here you can review a summary of results.
12. You can now open the Transient Results Viewer to view graphs and profiles
showing the results of the Transient Analysis.

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)
• Rated Flow (Turbine)
• Rated Pressure (Turbine)
• Pipe Flow (Pipe)
• Start HGL (Pipe)

Bentley HAMMER V8i Edition User’s Guide 10-659

Selection of the Time Step

• Stop HGL (Pipe)

• Friction Coefficient (Pipe) (only if friction method is Darcy Weisbach)

The dialog consists of the following controls:

Time—Allows you to choose the time step. The values at this time step will be used
as the initial conditions for the HAMMER transient calculations.

All—When this button is selected, initial conditions will be applied to all elements in
the model.

Selection—When this button is selected, initial conditions will be applied only to

elements that are currently selected in the drawing pane.

Selection Set—When this button is selected, initial conditions will be applied only to
the elements contained within the specified selection set.

Selection of the Time Step

In the Method of Characteristics, the pipes in the network are broken into segments so
that a sharp pressure-wave front can travel the length of one of the pipe's interior
segments in one time step. However in systems with a mix of very long and short
pipes, it is not always practical to use very small time steps since this can significantly
increase the time it takes to complete a simulation. Therefore, it is possible to adjust
either the length or wave speed parameters for each pipe so that a larger time step can
be used while still satisfying the requirement that a sharp pressure-wave front can
travel the length of one of the pipe's interior segments in one time step.

For example, if a pipe has a length of 10 ft and the wave speed is 1000 ft/s, then the
time step required to simulate this pipe without adjustment is 0.01 seconds (= 1 ft /
1000 ft/s). However, if the time step was set to 0.02 seconds, the pipe length would
need to be adjusted to 20 ft (= 0.02 s x 1000 ft/s), or the wave speed would need to be
reduced to 500 ft/s (= 10 ft / 0.02 s) to satisfy the requirement that a sharp pressure-
wave front can travel the length of one of the pipe's interior segments in one time step.

In general, a smaller calculation time step will produce a more accurate solution but
will take longer to compute. However, using a larger time step (and adjusting pipe
lengths or wave speeds) can produce accurate simulation results with much shorter
simulation times, so this is generally recommended.

10-660 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

The calculation time step used in Bentley HAMMER can be defined by the user, or
the user can elect to have Bentley HAMMER automatically select a time step for
them. If Bentley HAMMER 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 Bentley HAMMER generally requires some
adjustment to the pipe lengths or wave speeds. The adjustments are done automati-
cally by Bentley HAMMER, 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, Bentley
HAMMER 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 Bentley HAMMER model could
require excessive adjustments to the length or wave speed. If
this happens, Bentley HAMMER 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 Bentley HAMMER to select a
smaller time step - increasing the time taken to compute a simulation. (Note: it may be
possible to remove short pipes from the model using the Skelebrator tool.)

Regardless of whether a user-defined, or automatic time step is used, users are advised
to conduct a sensitivity analysis using a run with a very small user-defined time step to
satisfy themselves that the time step they are using produces satisfactory results. (The
appropriate time step to use for this will depend on the model, but a value like 0.01 s is
suggested.) If the run using a very small time step produces results that correlate well
with results obtained using a larger time step, then it should be valid to adopt the
larger time step.

Likewise, there is no hard and fast rule which determines the maximum amount of
adjustment that can be applied to pipe lengths of wave speeds without adversely
affecting the results, so users should investigate the sensitivity of results to different
levels of adjustment. However, users should keep in mind that, if the mean pipe length
adjustment is significant, this means that the mass of liquid analyzed in the model is
significantly different to the mass of liquid in the real system.

Using a User-Defined Time Step

There are two ways for a user to indicate that they want to use their own time step:

1. In the Calculation Options for the Transient Solver, set 'Is User Defined Time
Step' equal to True. Or;
2. In the Transient Time Step Options, check the 'Use Custom Time Step' box.

Bentley HAMMER V8i Edition User’s Guide 10-661

Selection of the Time Step

Transient Time Step Options Dialog

This dialog shows the time step suggested by HAMMER and the adjustments to
lengths or wavespeeds it requires. You can also choose to define a custom time step.

The dialog consists of the following controls:

• Time Step: The calculated time step.

• Max Adjustment: The maximum adjustment to wave speed or length for the time
step.
• Mean Adjustment: The meanadjustment to wave speed or length for the time
step.
• RMS Adjustment: The RMS (root-mean-square) adjustment to wave speed or
length for the time step.
• Use Custom Time Step?: When this box is checked, the custom Time Step field
becomes available for you to edit. Enter the desired time step here.
• Adjust: Select one or the other as indicated by your modeling objectives. Length
is the default method. Wave speed may result in faster but accurate simulations of
mass oscillation (slow transients).
• Adjustment Type: Select Absolute (e.g. length or wave speed) or relative (e.g.
percentage) reporting method. HAMMER will use this setting to display the
adjustments that correspond to the selected time step.
• Max Adjustment: Enter the maximum adjustment to wave speed or length.

10-662 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Note: If you receive the following warning: “The wavespeed or length

approximation deviates excessively from the entered values.
Lengthen short pipes and/or subdivide longer pipes.”, you can
lengthen the short pipes/subdivide longer pipes or you can
modify the Max Adjustment value in the Transient Time Step
Options dialog.

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 Adjust-
ments, Unit Demand Adjustments, or Roughness Adjustments are set to Active in the
Calculation Option properties and adjustments have been specified, the active adjust-
ments 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).

The Adjustments dialog is divided into three tabs, each containing a table of adjust-
ments and controls to control the data within the table. These controls are as follows:

Bentley HAMMER V8i Edition User’s Guide 10-663

Global Demand and Roughness Adjustments

• New—Adds a new adjustment to the table.

• Delete—Removes the currently highlighted adjustment from the table.
• Shift Up—Adjustments are executed in the order they appear in the table. This
button shifts the currently highlighted adjustment up in the table.
• Shift Down—Adjustments 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:

• Demands—Use 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:
– Scope—Use 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 Pattern—Use this field to specify the demands to which the adjust-
ment 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.
– Operation—Choose the operation to be performed in the adjustment using
the value specified in the Value column.
– Value—Type the value for the adjustment.

• Unit Demands—Use 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.
– Scope—Use this field to specify the elements that the adjustment will be
applied. Choose <Entire Network> to 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.
– Unit Demand—Use 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.
– Operation—Choose the operation to be performed in the adjustment using
the value specified in the Value column.
– Value—Type the value for the adjustment.

10-664 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

• Roughnesses—Use 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.
– Scope—Use this field to specify the elements that the adjustment will be
applied. Choose <Entire Network> to apply the adjustment to every pipe, or
choose a subset of pipes by selecting one of the previously created selection
sets from the list.
– Operation—Choose the operation to be performed in the adjustment using
the value specified in the Value column.
– Value—Type the value for the adjustment.

Check Data/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.

Bentley HAMMER V8i Edition User’s Guide 10-665

User Notifications

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 Topology—Checks 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 reach-
able from a boundary node through open links.
• Element Validation—Checks that every element in the network is valid for the
calculation. For example, this validation ensures that all pipes have 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 Bentley HAMMER V8i from solving your model.

The User Notifications dialog box displays warnings and error messages that are
turned up by Bentley HAMMER V8i’s validation routines. If the notification refer-
ences a particular element, you can zoom to that element by either double-clicking the
notification, or right-clicking it and selecting the Zoom To command.

• Informational messages are denoted by a blue icon.

• Warnings are denoted by an orange icon and do not prevent the model from calcu-
lating successfully.
• Errors are denoted by a red icon, and the model will not successfully calculate if
errors are found.

10-666 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

The User Notifications dialog box consists of a toolbar and a tabular view containing a
list of warnings and error messages.

Bentley HAMMER V8i Edition User’s Guide 10-667

User Notifications

The toolbar consists of the following buttons:

Details Displays the User Notification Details

dialog box, which includes information
about any warning or error messages.

Save Saves the user notifications as a comma-

delimited .csv file. You can open the .csv
file in Microsoft Excel or Notepad.

Report Displays a User Notification Report.

Copy Copies the currently highlighted warning or

error message to the Windows clipboard.

Zoom To If the warning or error message is related to

a specific element in your model, click this
button to center the element in question in
the drawing pane.

Help Displays online help for User Notifications.

User Notifications displays warnings and error messages in a tabular view. The table
includes the following columns:

Message ID The message ID associated with the corresponding

message.

Scenario The scenario associated with the corresponding

message. This column will display “Base” unless
you ran a different scenario.

Element Type The element type associated with the

corresponding message.

10-668 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Element ID The element ID associated with the corresponding

message.

Label If the notification is caused by a specific element,

this column displays the label of the element
associated with the corresponding message.

Message The description associated with the corresponding

message.

Time (hours) If the user notification occurred during a specific

time step, it is displayed. Otherwise, this column
is left blank.

Source The validation routine that triggered the

corresponding message.

To view user notifications

1. Compute your model. If there are any.

2. If needed, open the User Notification manager by going to Analysis > User Noti-
fications <F8>.
3. Or, if the calculation fails to compute because of an input error, when your model
is finished computing, Bentley HAMMER V8i prompts you to view user notifica-
tions to validate the input data.
You must fix any errors identified by red circles before Bentley HAMMER V8i
can compute a result.
Errors identified by orange circles are warnings that do not prevent the computa-
tion of the model.
4. 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.
5. Use the element label to identify the element that generates the error and use the
user notification message to edit the element’s properties to resolve the error.

Bentley HAMMER V8i Edition User’s Guide 10-669

User Notifications

User Notification Details Dialog Box

This dialog lists the elements that are referred to by a time-sensitive user notification
message. In the User Notification dialog, there is a time column that displays the time-
step during which time-sensitive messages occur. These messages will say “during
this time-step” or “for this time-step”, and do not display information about the refer-
enced element or elements. Double-clicking one of these messages in the User Notifi-
cations dialog opens the User Notification Details dialog, which does provide
information about the referenced element(s).

You can double-click messages in the User Notification Details dialog to zoom the
drawing pane view to the referenced element.

6.

10-670 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

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 Pricessor analysis are then displayed in a previ-
ously 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.

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.

Bentley HAMMER V8i Edition User’s Guide 10-671

Flow Emitters

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 sprin-
kler 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 esti-
mated) 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 junction’s
elevation to include the equivalent head of the pressure target.

When both an emitter and a normal demand are specified for a junction, the demand
that Bentley HAMMER 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:

n
Q = kP
Where

10-672 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

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 modeled in parallel. This allows you to model
multiple VSPs operated at the same speed at one pump station. To model this, a 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.

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

Bentley HAMMER V8i Edition User’s Guide 10-673

Calculation Options

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

Choose Analysis > Calculation Options, Alt+3, or click the button to open the
Calculations Options dialog box.

The following controls are available from the Calculation Options dialog box.

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.

10-674 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

To view the Steady State/EPS Solver properties of the Base Calculation Options

Select Base Calculation Options under Steady State/EPS Solver and double click to
open the Properties dialog box.

The following calculation option parameters are available for user configuration:

• Friction Method—Set the global friction method.

• Output Selection Set—Select whether to generate output for All Elements (the
default setting) or only the elements contained within the chosen selection set.
• Calculation Type—Select the type of analysis to perform with this calculation
options set.
• Demand Adjustments—Specify whether or not to apply adjustment factors to
standard demands.
• Active Demand Adjustments—The collection of demand adjustments that are
applied during the analysis.
• Unit Demand Adjustments—Specify whether or not to apply adjustment factors
to unit demands.

Bentley HAMMER V8i Edition User’s Guide 10-675

Calculation Options

• Active Unit Demand Adjustments—The collection of unit demand adjustments

that are applied during the analysis.
• Roughness Adjustments—Specify whether or not to apply adjustment factors to
roughnesses.
• Active Roughness Adjustments—The collection of roughness adjustments that
are applied during the analysis.
• Display Status Messages?—If set to true, element status messages will be stored
in the output and reported.
• Display Calculation Flags?—If set to true, calculation flags will be stored in the
output and reported.
• Display Time Step Convergence Info?—If set to true, convergence/iteration
data for each time step will be stored in the output file and displayed in the calcu-
lation summary.
• Enable EPANET Compatible Results?—Setting this option to true will ensure
consistent results with previous versions of Bentley HAMMER and with Epanet 2
by disabling computational enhancements made to the hydraulic simulation
engine.
• Base Date—Select the calendar date on which the simulation begins.
• Time Analysis Type—Select whether the analysis is extended period or steady-
state.
• Start Time—Select the clock time at which the simulation begins.
• Duration—Specify the total duration of an extended period simulation.
• Hydraulic Time Step—Select the length of the calculation time step.
• Override Reporting Time Step?—Specify if you want the Reporting Time Step
to differ from the Hydraulic Time Step.
• Reporting Time Step—Data will be presented at every reporting time step. The
reporting time step should be a multiple of the hydraulic time step.
• 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 inter-
polation.
• Trials—Unitless number that defines the maximum number of iterations to be
performed for each hydraulic solution. The default value is 40.
• Accuracy—Unitless number that defines the convergence criteria for the iterative
solution of the network hydraulic equations. When the sum of the absolute flow
changes between successive iterations in all links is divided by the sum of the
absolute flows in all links and is less than the Accuracy, the solution is said to
have converged. The default value is 0.001 and the minimum allowed value for
Accuracy is 1.0e-5.

10-676 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

• Emitter Exponent—Emitters are devices associated with junctions that model

the flow through a nozzle or orifice. In these situations, the demand (i.e., the flow
rate through the emitter) varies in proportion to the pressure at the junction raised
to some power. The constant of proportionality is termed the discharge coefficient.
For nozzles and sprinkler heads the exponent on pressure is 0.5 and the manufac-
turer usually states the value of the discharge coefficient as the flow rate in gpm
through the device at a 1 psi pressure drop.
• Liquid Label—Label that describes the type of liquid used in the simulation.
• Liquid Kinematic Viscosity—Ratio of the liquid’s dynamic, or absolute
viscosity to its mass density.
• Liquid Specific Gravity—Ratio of the specific weight of the liquid to the
specific weight of water at 4 degrees C or 39 degrees F.
• Use Pressure Dependent Demand?—If set to true the flows at junctions and
hydrants will be based on pressure constraints.
To view the Base properties of the Transient Solver Calculation Options

Select Transient Solver Base Calculation Options and double click to open the Proper-
ties dialog box.

Bentley HAMMER V8i Edition User’s Guide 10-677

Calculation Options

The following calculation option parameters are available for user configuration:

• Initial Flow Consistency—Flow changes that exceed the specified value are
listed in the output log as a location at which water hammer occurs as soon as
simulation begins. The default value is 0.02 cfs.
• Initial Head Consistency—Head changes that exceed the specified value are
listed in the output log as a location at which water hammer occurs as soon as
simulation begins. The default value is 0.1 ft.
• Friction Coefficient Criterion—For pipes whose Darcy-Weisbach friction coef-
ficient exceeds this criterion, an asterisk appears beside the coefficient in the pipe
information table in the output log. The default value is 0.02.
• Report History After—Set the time at which reporting begins. The default value
is 0.02.
• Show Extreme Heads After—Sets the time to start output of the maximum and
minimum heads for a run. You can set these to show beginning at time = 0 (right
away), after the first maximum or minimum, or after a specified time delay.
• Transient Friction Method—Select Steady, Quasi-Steady, or Unsteady friction
method to be used for transient calculations.
• Generate Extended Output Log?—When this value is set to true, the output log
includes additional information for every node, such as the flow, head, and vapor/
air volumes at the first, second and last timesteps.
• Show Pocket Opening/Closing—Toggles whether the list of vapor pockets open
and close times will be appended to the output text file.
• Enable Text 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 Points—Choose the report points type from the following:
– No Points—No report points are defined.
– All Points—All nodes in the model are report points.
– Selected Points—Selecting this option makes the Report Points Collection
field active, allowing you to define the report points.

• Report Points Collection—Clicking the ellipsis button in this field opens the
Report Points Collection dialog, allowing you to choose the report points from the
list of available points, or select them in the drawing.
• Report Times—Choose whether to report Periodically, At Specific Times, At No
Times, or At All Times.

10-678 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

• Report Period—Specify the equal intervals of time (default) at which reports are
generated. This option is only available when the Report Times property is set to
Periodically.
• Report Times Collection—Opens the Report Times Collection dialog, allowing
you to specify the times step to be reported. This option is only available when the
Report Period property is set to At Specific Times.

• Is User Defined Time Step?—Selcts whether the time step is user-defined or

automatically estimated.
• Time Step Interval— This option is only available when the Is User Defined
Time Step? property is set to True.
• Run Duration Type—Selects whether the run duration is measured in time or
time steps.
• Run Duration—Period of time simulated by the model.
• Pressure Wave Speed—Speed for the liquid being conveyed, the pipe material
selected and its dimension ratio (DR), bedding, and other factors.
• Vapor Pressure—Pressure below which a liquid changes phase and become a gas
(steam for water), at a given temperature and elevation.
• Wave Speed Reduction Factor—The low pressure wave speed reduction factor.
The default value is 1.0. If subatmospheric pressure conditions occur, the adjacent
pipe wave speed begins to reduce toward a value equal to the original wave speed
multiplied by this factor. For more information, see Wave Speed Reduction
Factor.
• Decrease Time—The time for the wave speed to decrease from its normal value
to the reduced value at subatmospheric pressure. The default value is 0.1 second.
If pressure becomes positive again before this time has lapsed, the linear reduction
will be interrupted and the wave speed will begin to increase back to the original
value.
• Increase Time—The time for wave speed to increase from its reduced value at
subatmospheric pressure to its normal value. The default value is 3.0 seconds. If
pressure becomes negative again before this time has lapsed, the wave speed will
begin to decrease back toward the reduced value.
• Generate Animation Data—Set this property to True to generate animation data
for selected report paths and points.
• Calculate Transient Force—Set this property to True to calculate transient
forces.
• Run Extended CAV—Toggles the standard or extended Combination Air Valve
(CAV) sub-model. The vacuum breaker component of CAV admit air into the
pipeline during low transient pressures that is subsequently expelled at the outlet
orifice(s). The extended model tracks momentum more accurately.

Bentley HAMMER V8i Edition User’s Guide 10-679

Calculation Options

• Flow Tolerance—Flows below this value are assumed to be zero when running
the transient calculations. This option is generally used to filter out insignificant
flows that could otherwise cause numerical problems during the calculation. See
Flow Tolerance for more details.
• Round Pipe Head Values?—Specifies whether pipe head values should be
rounded or not. This option is generally used to filer out insignificant differences
that could otherwise cause numerical probelms during the calculation.
• Initialize Transient Run at Time—If the “Specify Initial Condition” field is set
to True, the transient simulation is initialized using results from a steady-state or
extended period simulation. Enter a time here to initialize the transient simulation
using results from the corresponding EPS time step.
• Specify Initial Conditions?—If set to True, you can manually specify the initial
conditions for a transient simulation.
To create a new calculation option

1. Choose Analysis > Calculation Options and the Calculation Options dialog box
opens.
2. Choose New.
3. Double-click on the newly created calculation option to open the Calculation
Options Properties dialog box.

10-680 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

4. Set the fields for this calculation.

5. Close the properties box.

6. Close the Calculations Options box.

Controlling Results Output

There are two ways that you can limit the output data that is written to the result file
from the water engine: by time step and by element. 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.

One way is to limit the reported time steps:

By default, the Overide Reporting Time Step calculation option is set to <All>. Under
this setting, all results for all time steps are written to the results file.

Bentley HAMMER V8i Edition User’s Guide 10-681

Calculation Options

To limit the output results to a specific interval (such as every 2 hours, every 4 hours,
etc) set the Overide Reporting Time Step 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 Overide Reporting Time Step
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.

The other way is to limit the reported elements:

By default, the Output Selection Set calculation option is set to <All>. Under this
setting, all results for all elements are written to the results file.

By choosing a previously created selection set in this field, you can limit the output
data written to the results file to only include data for the elements that are contained
within the specified selection set.

Reporting Time Steps Dialog Box

This dialog allows you to specify whether the output results for different time steps
during an extended period simulaton will or will not be written to the results file.

You do this by specifying ranges of time during which:

• All of the time steps are reported on and written to the results file.
• None of the time steps are reported on and written to the results file.
• Time steps that fall within the specificed constant interval are reported on and
written to the results file.

The first row in this dialog will always be 0.00 hours, which is the beginning of the
first time range. To specify the first range of time, enter the end time step in the second
row, for example 24 hours. Specify the type in the first row, for example <All>. In this
example, all time steps between hour 0 (the start of the simulation) and hour 24 will be
written to the results file. To specify further ranges of time, add new rows with the
New button. Remove rows with the Delete button. The last range in the dialog will
start at the time specified in the last row and end at the end of the simulation.

Report Points Collection Dialog Box

This dialog allows you to specify which of the available points in the model will be
report points.

Click the [>] button to add a highlighted point from the Available Items list to the
Selected Items list.

10-682 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Click the [>>] button to add all Available Items to the Selected Items list.

Click the [<] button to remove a highlighted point from the Selected Items list,
returning it to the Available Items list.

Click the [<<] button to remove all report points from the Selected Items list,
returning them to the Available Items list.

Click the Select From Drawing button to choose points from the drawing pane.

Report Times Collection

This dialog allows you to specify which of the available time steps in the model will
be report times.

Click the [>] button to add a highlighted time step from the Available Items list to the
Selected Items list.

Click the [>>] button to add all Available time steps to the Selected Items list.

Click the [<] button to remove a highlighted time step from the Selected Items list,
returning it to the Available Items list.

Click the [<<] button to remove all time steps from the Selected Items list, returning
them to the Available Items list.

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 rough-
ness parameter entered for the pipe. However, if the Flow Tolerance is adjusted, it is
suggested that the 'Round Pipe Head Values?' parameter is set to 'True' and the pipe
heads are rounded to a similar level of accuracy as the flows. This helps ensure that
the head at either end of a pipe with zero initial flow is the same.

Note however, that in the majority of cases it is suggested that the default value is used
for these parameters.

Bentley HAMMER V8i Edition User’s Guide 10-683

Calculation Options

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 pres-
sure 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 appro-
priate run duration:

1. First run HAMMER for only a few time steps to identify the sources of transients
(remember to output every time step in the Report Times setting of the Transient
Solver Calculation Options). You can also check for input errors by clicking
Compute. 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).
2. 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. 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 oscilla-
tions in the system.
3. 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.

10-684 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

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.

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.

Transient Tip: 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.

Transient Tip: 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.

Bentley HAMMER V8i Edition User’s Guide 10-685

Calculation Options

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 deter-
mines the friction factor based on this information:

• If a pipe has zero flow at the initial steady-state, HAMMER use the Friction Coef-
ficient 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 calcu-
lated value in the transient simulation.

Note: HAMMER always uses the Darcy-Weisbach friction method in

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

Quasi-Steady Friction Method

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

Transient Tip: 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.

10-686 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

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

Transient Tip: 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 2.00.12
2. WaterGEMS 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.

Bentley HAMMER V8i Edition User’s Guide 10-687

Calculation Options

The intent of each of the compatibility modes is as follows:

1. WaterGEMS 2.00.12 - Computation engine based on EPANET 2.00.12 with

Bentley's own enhancements and features.
2. WaterGEMS 2.00.10- Computation engine based on EPANET 2.00.10 with
Bentley's own enhancements and features.
3. EPANET 2.00.12 - Computational engine based on EPANET 2.00.12 including
any Bentley enhancements and features that do not change hydraulic results
compared to EPANET, for models that are able to be completely represented in
EPANET.
4. EPANET 2.00.10 - Computational engine based on EPANET 2.00.12 including
any Bentley enhancements and features that do not change hydraulic results
compared to EPANET, for models that are able to be completely represented in
EPANET.

10-688 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

For those interested in what each engine compatibility mode means in more detail we
provide the following compatibility matrix.

Bentley HAMMER V8i Edition User’s Guide 10-689

Calculation Options

10-690 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Patterns
The extended period analysis is actually a series of Steady State analyses run against
time-variable loads such as sewer inflows, demands, or chemical constituents.
Patterns allow you to apply automatic time-variable changes within the system. The
most common application of patterns is for residential or industrial 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.

Typical Diurnal Curve

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 step-
wise 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.

Bentley HAMMER V8i Edition User’s Guide 10-691

Patterns

Because of the finite time steps used for calculations, this software converts contin-
uous 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.
Patterns include:

• Pattern Manager

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 multi-
plier from the pattern corresponding to that time. If the duration of the simulation is
longer than the pattern, the pattern is repeated. The selected multiplier is applied to
any baseline load that is associated with the pattern. You can also define daily and
monthly multipliers for any pattern.

10-692 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Patterns provide an effective means of applying time-variable system demands to the

distribution model. The Pattern Manager allows you to create the following types of
patterns:

• Hydraulic—This type of pattern can be applied to Junctions or Tanks. Use this

pattern type to describe demand or inflow patterns over time.
• Constituent—This type of pattern can be applied to Reservoirs, Tanks, or Junc-
tions. Use this pattern type to describe changes in Constituent Baseline Loads
over time.
• Pump—This type of pattern can be applied to Variable Speed Pumps only. Use
this pattern type to describe changes in the pump’s Relative Speed Factor. In the
Property dialog box for the pump, Is Variable Speed Pump needs to be set to True
and the VSP type needs to be Pattern Based.

• Reservoir—This type of pattern can be applied to Reservoirs. Use this pattern

type to describe changes in HGL over time, such as that caused by tidal activity or
when the reservoir represents a connection to another system where the pressure
changes over time.
• Valve Settings—This type of pattern can be applied to PRVs, PSVs, PBVs, FCVs,
and TCVs. Use this pattern type to describe changes to the valve settings over
time.
• Valve Relative Closure—This type of pattern can be applied to TCVs that are
using the Valve Characteristics Curve Coefficient Type. Use this pattern type to
describe how the valve opens and closes 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 a pump
with its 'Pump Type (Transient)' property set to 'Variable Speed / Torque'. If the
pump Control Variable is 'Speed' this pattern will adjust the pump speed during
the course of the transient simulation, and the pattern multiplier will be applied to
the pump's 'Speed (Full)' property (as specified on the Transient tab of the Pump
Definitions dialog). If the pump Control Variable is 'Torque' this pattern will
adjust the pump torque during the course of the transient simulation, and the
pattern multiplier will be applied to the pump's 'Torque (Nominal)' property.
• 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.

Bentley HAMMER V8i Edition User’s Guide 10-693

Patterns

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.

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 Browse the Engineering Library,

Options synchronize to or from the library, import
from the library or export to the library.

Tip: 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 Time—The first time step in the pattern. The start time format is a standard
24-hour clock. The format is Hour:Minute:Second AM or PM (e.g., 12:45:30
PM).
• Starting Multiplier—The multiplier value of the first time step point in your
pattern. Any real number can be used for this multiplier (it does not have to be
1.0).
• Pattern Format—The following pattern formats are available:

10-694 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

– Stepwise—The multiplier values are considered to be the average value for

the interval between the specified time and the next time. Patterns using this
format will have a staircase appearance. Multipliers are set at the specified
time and held constant until the next point in the pattern.
– Continuous—The multipliers are considered to be the instantaneous values at
a particular time. Patterns using this format will have a curvilinear appear-
ance. 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.

• Time From Start—The amount of time from the Start Time of the pattern to the
time step point being defined.
• Multiplier—The multiplier value associated with the time step point.
• Relative Closure—The percentage of full flow that the valve allows at the associ-
ated time step point. This attribute is only available for Operational (Transient,
Valve) pattern types.
• Relative Speed Multiplier—The percentage of full speed that the pump is
running at during the associated time step point. This attribute is only available for
Operational (Transient, Pump) pattern types.
• Gate Opening Percent —The percentage compared to fully open for the turbine
gate opening at the associated time step point. This attribute is only available for
Operational (Transient, Turbine) pattern types.

Daily and Monthly factors are defined in the same way as hourly ones, the difference
being that rather than defining time steps you enter multipliers for each day of the
week (for Daily patterns) or for each month of the year (for monthly patterns).

A graph of the currently selected pattern is displayed in the lower right corner of the
dialog.

Bentley HAMMER V8i Edition User’s Guide 10-695

Controls

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.

Pump patterns and valve patterns take precedence over any

controls (simple or logical) that are associated with the pump or
valve. Patterns should not be set for elements that you would
prefer to control using logical or simple controls.

Controls
Controls give you a way to specify the status and setting 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.

10-696 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

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:

• Controls—Manage all controls defined in the system.

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

• Control Sets—Assign groups of controls to Control Sets.

Bentley HAMMER V8i Edition User’s Guide 10-697

Controls

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 condi-
tion, a THEN action, and an optional ELSE action, and can be assigned a priority for
resolving potential conflicts between logical controls.

Controls, Conditions, and Actions are assigned a non-editable application-provided

ID (e.g., LC01).

The Controls tab is divided into sections:

•The pane in the center of the dialog box is the Controls List. This list displays a list of
all Logical Controls defined in the system.
• Located above the Controls List is a toolbar with the following buttons:
– New—Creates a new control.
– Delete—Deletes the highlighted control.
– Refresh—Refreshes the highlighted control
– Report—Generates a summary of the selected control, listing the ID, condi-
tions, actions, and elements incorporated into the control.

10-698 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

• Below the toolbar is a set of filters that allow you to only display controls that
meet criteria defined by the filter settings. The following filters are available:
– Type—When a Type filter other than <All> is specified, only controls of that
type will be displayed in the Controls list.
– Priority—When a Priority filter other than <All> is specified, only controls
of that priority will be displayed in the Controls list.
– Condition Element—When a Condition filter other than <All> is specified,
only controls containing the selected Condition element will be displayed in
the Controls list.
– Action Element—When an Action filter other than <All> is specified, only
controls containing the selected Action element will be displayed in the
Controls list.
You can 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 Control—Turn on in order to evaluate the condition as a

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

Bentley HAMMER V8i Edition User’s Guide 10-699

Controls

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.

Pump patterns and valve patterns take precedence over any

controls (simple or logical) that are associated with the pump or
valve. Patterns should not be set for elements that you would
prefer to control using logical or simple controls.

Hovering the mouse cursor over a control in the list will open a
tooltip which displays the conditions and actions that make up
that control.

When creating a new condition or action for a new control, the

condition and action input fields will be initialized with the data
used in the last condition or action that was created.

Once created, the Logical Control will be assigned an

application generated ID (e.g., LC04).

• Description—This area is preset with a default description. There is an option to

change the default description. To do so, turn on to activate the description field,
and enter your description in the text box.
• Summary—This area of the dialog box displays a description of the control.

• Status Pane—When one or more filters are active, the lower left corner of the
dialog will show the number of controls currently displayed out of the number of
total controls. Additionally, a FILTERED flag is displayed in the lower right
corner.
Logical, or rule-based controls allow far more flexibility and control over the behavior
of your network elements than is possible with simple controls. This is accomplished
by allowing you to specify one or more conditions and then link these to one or more
Actions by using logical IF, AND, THEN, OR, and ELSE statements.

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:

IF: Condition 1 AND condition 2 OR condition 3 AND

condition 4, etc., where condition X is a a condition
clause.

10-700 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

THEN: Action 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 demands, element hydraulic grade or pressure, system demand, clock time,
time from start, tank level, or time to fill or drain a tank.

You can also create composite conditions and actions. You can cause actions to be
performed when multiple conditions are met simultaneously, or when one or the other
conditions are met. You can also activate multiple actions when a single condition is
met.

EXAMPLE:

To create a logical control in which a pump (PMP-1) is turned on when the level in a
tank (T-1) falls below a specified value (5 ft.) or when the system demands exceed a
certain level (5000 gpm):

• Conditions—Because this control needs to be triggered by multiple condi-

tions, 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—{T-1 Level < 5 ft.}
OR condition—{System Demand > 5000 gpm}
• Actions—Because this control has a single desired outcome if one of the
conditions is met, a simple action is chosen. The first action in a logical
control is always linked to the conditions by a logical THEN statement. In this
instance, an ELSE action will also be used, to keep the pump off if neither of
the conditions is true.
THEN action—{PMP-1 Status = On}
ELSE action—{PMP-1 Status = Off}

The finished logical control looks like this:

IF {T-1 Level < 5 ft.} OR {System Demand > 5000 gpm} THEN {PMP-1 Status
= On} ELSE {PMP-1 Status = Off}

Bentley HAMMER V8i Edition User’s Guide 10-701

Controls

This example illustrates the power of using logical controls. To achieve the same func-
tionality using simple controls, you would need to create four separate controls—one
to turn the pump on if the tank level is below the specified value, one to turn the pump
off if the tank level is above a specified value, one to turn the pump on if the system
demand is greater than the specified value, and one to turn the pump off if the system
demand is less than the specified value.

Tip: 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
Tank 1 is less than 5 ft., Then turn Pump 1 On,” use an ELSE
action to turn the pump off if the tank level is above 5 ft.

Note: Logical Controls are not executed during Steady State analyses.

When defining a logical control, you have the option to share

conditions and/or actions. In other words, more than one control
can reference the same condition or action. Keep in mind that
when you change an underlying condition or action, it will affect
all controls that reference that condition or action.

Conditions Tab

Conditions allow you to define the condition that must be met prior to taking an
action. The Conditions tab provides a list of all conditions defined in the system.
There are two types of conditions: simple conditions and composite conditions.

10-702 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

The Conditions tab is divided into sections:

• The pane in the middle of the dialog box is the Conditions List. The Conditions
List displays a list of all logical conditions defined in the system. The list contains
four columns: ID (the application defined id, e.g., C01 for simple, CC01 for
composite), Type (simple or composite), description, and references (logical
control references).
• Located above the Conditions List is a toolbar with the following buttons:
– New—Create a simple or composite condition.
– Duplicate—Copy the selected condition.
– Delete—Deletes the selected condition.
– Refresh—Refreshes the selected condition.
– Report—Generates a summary of the selected condition.

• Below the toolbar is a set of filters that allow you to only display controls that
meet criteria defined by the filter settings. The following filters are available:
– Control Set—When a control set is specifed, only conditions that are a
component of that control set are displayed in the Conditions list.

Bentley HAMMER V8i Edition User’s Guide 10-703

Controls

– Type—When a Type filter other than <All> is specified, only conditions of

that type will be displayed in the Conditions list.
– Condition Element—When a Condition filter other than <All> is specified,
only conditions containing the selected Condition element will be displayed
in the Conditions list.
• The controls used to create or edit a condition vary depending on whether the
condition is simple or composite:

Simple Conditions
The input fields for a simple condition change depending on the condition type that is
selected in the condition Type field. The Simple Condition Types and the corre-
sponding input data are as follows:

Element—This will create a condition based on specified attributes at a selected

element. The fields available when this condition type is selected are as follows:

• Element—The Element field allows you to specify which element the condition
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 dialog box, and the
Select From Drawing button, which allows you to select the element using the
graphical Drawing view.
Attribute—This field displays the available attributes for the element type currently
specified in the Element field.

• Pressure Junctions—The following attributes are available for use when a Junc-
tion is chosen in the Element field:
– Demand—This attribute is used to create a condition based on a specified
demand at the corresponding junction (e.g., If J-1 has a demand…).
– Hydraulic Grade—This attribute is used to create a condition based on a
specified hydraulic grade at the corresponding junction (e.g., If J-1 has a
hydraulic grade of…).
– Pressure—This attribute is used to create a condition based on a specified
pressure at the corresponding junction (e.g., If J-1 has a pressure of…).

• Pumps—The following attributes are available for use when a Pump is chosen in
the Element field:
– Discharge—This attribute is used to create a condition based on a specified
rate of discharge at the corresponding pump (e.g., If PMP-1 has a discharge
of…).

10-704 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

– Setting—This attribute is used to create a condition based on the Relative

Speed Factor of the corresponding pump (e.g., If PMP-1 has a relative speed
factor of 1.5…).
– Status—This attribute is used to create a condition based on the status (On or
Off) of the corresponding pump (e.g., If PMP-1 is On…).

Note: Relative Speed Pump patterns take precedence over any

controls (Simple or Logical) that are associated with the pump.

If using logical (as opposed to simple) controls to control the

speed of a pump and if the pump is initially off, ensure that the
initial relative speed setting is 0.0.

• Tanks—The following attributes are available for use when a Tank is chosen in
the Element field:
– Demand—This attribute is used to create a condition based on a specified
demand at the corresponding tank. For tanks, this demand can represent an
inflow or outflow (e.g., If T-1 has a demand…).
– Hydraulic Grade—This attribute is used to create a condition based on a
specified hydraulic grade at the corresponding tank (e.g., If T-1 has a
hydraulic grade of…).
– Pressure—This attribute is used to create a condition based on a specified
pressure at the corresponding tank (e.g., If T-1 has a pressure of…).
– Level—This attribute is used to create a condition based on a specified water
level at the corresponding tank (e.g., If the water in T-1 is at a level of…).
– Time to Drain—This attribute is to create a condition based on the amount of
time required for the tank to drain (e.g., If T-1 drains in X hours…).
– Time to Fill—This attribute is to create a condition based on the amount of
time required for the tank to fill (e.g., If T-1 fills in X hours…).

• Reservoirs—The following attributes are available for use when a Reservoir is

chosen in the Element field:
– Demand—This attribute is used to create a condition based on a specified
demand at the corresponding reservoir. For reservoirs, this demand can repre-
sent an inflow or outflow (e.g., If R-1 has a demand…).
– Hydraulic Grade—This attribute is used to create a condition based on a
specified hydraulic grade at the corresponding reservoir (e.g., If R-1 has a
hydraulic grade of…).
– Pressure—This attribute is used to create a condition based on a specified
pressure at the corresponding reservoir (e.g., If R-1 has a pressure of…).

Bentley HAMMER V8i Edition User’s Guide 10-705

Controls

• Pipes—The following attributes are available for use when a Pipe is chosen in the
Element field:
– Discharge—This attribute is used to create a condition based on a specified
rate of discharge at the corresponding pipe (e.g., If P-1 has a discharge of…).
– Status—This attribute is used to create a condition based on the status (Open
or Closed) of the corresponding pipe (e.g., If P-1 is Open…).

• Valves—The following attributes are available for use when a valve is chosen in
the Element field:
– Discharge—This attribute is used to create a condition based on a specified
rate of discharge at the corresponding valve (e.g., If PRV-1 has a discharge
of…).

Note: The Setting attribute is not available when a GPV is selected in

the Element field.

• Setting—This attribute is used to create a condition based on the setting of the

corresponding valve. The type of setting will change depending on the type of
valve that is chosen. The valves and their associated setting types are as follows:
– PRV—Choosing the Setting attribute in conjunction with a PRV will create a
condition based on a specified pressure at the PRV (e.g., If PRV-1 has a pres-
sure of…).
– PSV—Choosing the Setting attribute in conjunction with a PRV will create a
condition based on a specified pressure at the PRV (e.g., If PSV-1 has a pres-
sure of…).
– PBV—Choosing the Setting attribute in conjunction with a PRV will create a
condition based on a specified pressure at the PRV (e.g., If PBV-1 has a pres-
sure of…).
– FCV—Choosing the Setting attribute in conjunction with a PRV will create a
condition based on a specified rate of discharge at the PRV (e.g., If FCV-1 has
a discharge of…).
– TCV—Choosing the Setting attribute in conjunction with a PRV will create a
condition based on a specified headloss coefficient at the PRV (e.g., If TCV-1
has a headloss of…).

• Status—This attribute is used to create a condition based on the status (Closed or

Inactive) of the corresponding valve (e.g., If PRV-1 is Inactive…).

System Demand—This will create a condition based on the demands for the entire
system. The fields available when this condition type is selected are:

10-706 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

• Operator—This field allows you to specify the relationship between the Attribute
and the target value for that attribute. The choices include Greater Than (>),
Greater Than Or Equal To (>=), Less Than (<), Less Than Or Equal To (<=),
Equal To (=), or Not Equal To (<>).
• System Demand—This field lets you set a system-wide demand.

Clock Time—This will create a condition based on the clock time during an extended
period simulation. If the extended period simulation is for a period longer than 24
hours, this condition will be triggered every day at the specified time.

• Operator—This field allows you to specify the relationship between the Attribute
and the target value for that attribute. The choices include Greater Than (>),
Greater Than Or Equal To (>=), Less Than (<), Less Than Or Equal To (<=),
Equal To (=), or Not Equal To (<>).

Time From Start—This will create a condition based on the amount of time that has
passed since the beginning of an extended period simulation. The following fields are
available when this condition type is selected:

• Operator—This field allows you to specify the relationship between the Attribute
and the target value for that attribute. The choices include Greater Than (>),
Greater Than Or Equal To (>=), Less Than (<), Less Than Or Equal To (<=),
Equal To (=), or Not Equal To (<>).

Target Value—This field’s label will change depending on the attribute that is
chosen. The value entered here is used in conjunction with the operator that is chosen
to determine if the condition has been met.

Description—This area of the dialog box is preset with a default description. There is
an option to change the default description. To do so, click the check box to activate
the description field, and enter your description in the text box. Additionally, the
description field supports the following expandable masks:

%# ID

%e Element

%a Attribute

%o Operator

%v Value

%u Unit

Bentley HAMMER V8i Edition User’s Guide 10-707

Controls

Note: Click the description list box to select one of the predefined
masks.

Aside from reducing the amount of data input, using these masks provides the addi-
tional benefit of automatically updating the corresponding information when changes
are made to the various condition components.

Summary— This area of the dialog box displays an automatically updated preview of
the expanded description.

Composite Conditions

When a Composite Condition is being defined or edited, the lower part of the dialog
box is comprised of a two column table and two buttons. The buttons are as follows:

• Insert—Adds a new row to the Condition list.

• Delete—Deletes the highlighted row from the Condition list.
• Refresh—Updates the referenced conditions.
The table contains two columns, as follows:

• Operator—This column allows you to choose the way in which the related
Condition logic will be evaluated. The available choices are If, And, and Or.

Note: The first condition in the list will use the If operator. Any
additional conditions will allow you to choose between AND and
OR.

Any combination of AND and OR clauses can be used in a rule.

When mixing AND and OR clauses, the OR operator has higher
precedence than AND. Therefore, “IF A or B and C” is equivalent
to “IF (A or B) and C”. If the interpretation was meant to be IF A
or (B and C), this can be expressed using two Logical Controls:
Logical Control 1: “IF A THEN...” and Logical Control 2: “IF B
AND C THEN...”

• Condition—The drop-down list allows you to choose a condition that was

already created beforehand.
Description—This area of the dialog box is preset with a default description. There is
an option to change the default description. To do so, click the check box to activate
the description field, and enter your description in the text box. Additionally, the
description field supports the following expandable masks:

%# ID

%v Value

10-708 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Aside from reducing the amount of data input, using these masks provides the addi-
tional benefit of automatically updating the corresponding information when changes
are made to the various condition components.

Note: Click the description list box to select one of the predefined
masks.

Summary—This area of the dialog box displays an automatically updated preview of

the expanded description.

Actions Tab

Actions allow you to define what should be done to an element in the system in
response to an associated control condition. The Actions tab provides a list of all
actions defined in the system. There are two types of actions: simple actions and
composite actions. Actions have an application-provided non-editable ID (e.g., A01
for simple, AA01 for composite).

The Actions tab is divided into sections:

Bentley HAMMER V8i Edition User’s Guide 10-709

Controls

• The Actions List displays a list of all logical actions defined in the system. The list
contains four columns: ID (the application defined ID, e.g., A01 for simple, AA01
for composite), Type (simple or composite), description, and references (logical
control references).
• Located above the Conditions List is a toolbar with the following buttons:
- New—Opens the New Logical Action dialog box, where you can create a
new logical action.
- Edit—Depending on whether a simple or composite action is highlighted,
this button opens the Simple Logical Action or Composite Logical Action
dialog box, which allows you to edit the highlighted action.
- Delete—Deletes the highlighted action. You will be prompted to confirm
this action.
- Find—Opens the Find Logical Action dialog box, which allows you to
find a particular action based on a variety of criteria.
- Report—Generates a summary of the highlighted action.
– Below the toolbar is a set of filters that allow you to only display controls that
meet criteria defined by the filter settings. The following filters are available:
- Control Set—When a control set is specifed, only actions that are a
component of that control set are displayed in the Actions list.
- Type—When a Type filter other than <All> is specified, only actions of
that type will be displayed in the Actions list.
- Action Element—When an Action Element filter other than <All> is
specified, only actions containing the selected Element will be displayed
in the Actions list.
• The controls used to create or edit an action vary depending on whether the action
is simple or composite:

Simple Actions

The following controls are used to define or edit Simple Actions:

• Element—The Element field allows you to specify which element the action will
be based upon and provides three methods of choosing this element. The drop-
down list displays elements that have been used in other logical controls, the
Ellipsis (…) button, which opens the Single Element Selection box, and the Select
From Drawing button, which allows you to select the element using the graphical
Drawing view.
• Attribute—This field displays the available attributes for the element type speci-
fied in the Element field. Not all attributes are available for all element types. The
available attributes include:

10-710 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

– Status – This attribute is used to change the status of a pipe, pump, or valve
when the related conditions are met. The available choices are dependant on
the element type.
– Setting—This attribute is used to change the settings of a pump or valve
when the related conditions are met. The setting type varies depending on the
type of element.

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 upon—the status choices are
Inactive or Closed. After a control sets a valve to Inactive or
Closed, to reactivate the valve another control must be created
with a Setting attribute. This is because a valve cannot be set to
Active, but must have specific input data to work with.

For GPVs, there is no Inactive setting. GPVs can only be set to

Active or Closed. If the GPV is not closed, the valve will always
produce the headlosses associated with it through the Head-
Discharge Points table.

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

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

Note: Pipes can be set to Open or Closed, Pumps can be set to On, Off,
or have their relative speed factors increase or decrease. GPVs
can be set to Active or Closed. All other valves can be set to
Inactive, Closed, or have their respective settings changed,
depending on the Valve type.

Description—This area of the dialog box is preset with a default description. There is
an option to change the default description. To do so, click the check box to activate
the description field, and enter your description in the text box. Additionally, the
description field supports the following expandable masks:

%# ID

Bentley HAMMER V8i Edition User’s Guide 10-711

Controls

%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 addi-
tional benefit of automatically updating the corresponding information when changes
are made to the various control components.

Note: Click the description list box to select one of the predefined
masks.

Summary—This area of the dialog displays an automatically updated preview of the

expanded description.

Composite Actions

When a Composite Action is being defined or edited, the lower section of the dialog
box is comprised of a single column table and two buttons. The Table contains a list of
the Actions to be used. Each row is a drop-down list that allows you to choose an
action that was already created beforehand.

• Insert—Adds a new row to the Action list

• Delete—Deletes the highlighted row from the Action list.
Description—This area of the dialog box is preset with a default description. There is
an option to change the default description. To do so, click the check box to activate
the description field, and enter your description in the text box. Additionally, the
description field supports the following expandable masks:

%# ID

%v Value

Aside from reducing the amount of data input, using these masks provides the addi-
tional benefit of automatically updating the corresponding information when changes
are made to the various control components.

10-712 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Note: Click the description list box to select one of the predefined
masks.

Composite logical actions consist of multiple simple logical

actions. These actions are linked with an AND statement.

Summary—This area of the dialog box displays an automatically updated preview of

the expanded description.

Control 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:

Bentley HAMMER V8i Edition User’s Guide 10-713

Controls

• New—Opens the Logical Control Set editor dialog box. From this window, you
can add previously created logical controls to the new control set.
• Edit—Opens the Logical Control Set editor dialog box, which allows you to edit
the highlighted control set.
• Duplicate—Prompts for a name, then opens the Logical Control Set editor to
allow you to add or remove controls from the control set.
• Delete—Deletes the highlighted control set. You will be prompted to confirm this
action.
• Rename—Allows you to rename the highlighted control set.
• Report—Generates a summary of the highlighted control set, listing the ID,
conditions, actions, and elements for all of the logical controls contained within
the control set.

Logical Control Sets Dialog Box

The Logical Control Set Editor is divided into two panes.

The left pane, labeled Available Items, contains a list of all of the logical controls that
have been created in the current project. To add controls to the Selected Items pane on
the right, highlight the desired controls and click the [>] button under Add. To add all
of the controls to your Logical Control set, click the [>>] button under Add. To
remove a control from the Selected Items pane, highlight it and click the [<] button
under Remove. To remove all controls from the Selected Items pane, click the [<<]
button under Remove.

10-714 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Note: Priority is based upon the order that the controls appear in this
dialog box. The first control in the control set has the highest
priority, and so on. Any control with a set priority will overrule
any control with no set priority.

Control Wizard

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

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.

Bentley HAMMER V8i Edition User’s Guide 10-715

Active Topology

Click the New button above the table to add a new row; click the Delete button to
remove the currently selected row.

Active Topology
The Active Topology functionality allows you to make elements inactive (and to
change them back to active again), so as to either be excluded (when inactive) or
included (when active) from the network and its calculations. This lets you create
before and after scenarios and alternatives for proposed construction projects and to
test the redundancy, if any, in existing networks.

The following conditions apply to all inactive elements:

• They are not evaluated in any network calculations or hydraulic equations.

• They are not included when generating project inventory reports, element details
reports, or element results reports.
• They are not evaluated when generating contour plots, and are not available for
inclusion in profiles
• They will not appear in the corresponding tabular reports, unless the “Include
Inactive Topology option is turned on. By default, tabular reports do not include
inactive elements.
• 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.
• Inactive elements are still available for inclusion in selection sets.
• Any changes made to the Active Topology through the drawing pane or the Prop-
erty grid are applied to the Active Topology Alternative associated with the
current scenario.
• It is possible to create an unlimited number of active topology alternatives, e.g one
for the present year, another for year 2010 additions, another for year 2020, and so
on. The various alternatives can then be associated with corresponding scenarios.

10-716 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

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 alternative 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 under Tools > Active Topology Selection.

When you select the Active Topology Selection command, a Select tool opens.
Selecting elements at this time 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.

Bentley HAMMER V8i Edition User’s Guide 10-717

Active Topology

The Select tool consists of the following controls:

Done Select Done when you

are finished selecting
elements to bring you
back to the Active
Topology Selection
dialog box.

Add This option is the default

mode when you click
the Select From
Drawing button.
Clicking elements while
in this mode selects
(highlights) elements,
making 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 elements
deselects them, making
them Active. Clicking
on active elements has
no effect.

Clear Removes all elements

from the inactive
elements pane, thereby
causing all elements to
become active in the
current scenario.

The Done, Add, and Remove commands are also available from the right-click
context menu while the Select tool is active.

10-718 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

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
Use the External Tool Manager to manage custom menu commands, which are then
located in the Tools menu for quick accessibility.

Click Tools>External Tools to create a custom menu command from any executable
file. Executable file types include:

• .exe
• .com
• .pif
• .bat
• .cmd

The External Tool Manager consists of the following elements:

• External Tool List Pane—This pane lists the external tools that have been
created. All of the tools listed in this pane will be displayed in the Tools >
External Tools menu.
• New—Creates a new external tool in the list pane.
• Delete—Deletes the currently highlighted tool.
• Rename—Allows you to rename the currently highlighted tool.
• Command—This field allows you to enter the full path to the executable file that
the tool will initiate. Click the ellipsis button to open a Windows Open dialog to
allow you to browse to the executable.
• Arguments—This optional field allows you to enter command line variables that
are passed to the tool or command when it is activated. Click the > button to open
a submenu containing predefined arguments. Arguments containing spaces must
be enclosed in quotes. The available arguments are:
– Project Directory—This argument passes the current project directory to the
executable upon activation of the tool. The argument string is %(ProjDir).

Bentley HAMMER V8i Edition User’s Guide 10-719

External Tools

– Project File Name—This argument passes the current project file name to the
executable upon activation of the tool. The argument string is %(ProjFile-
Name).
– Project Store File Name—This argument passes the current project datastore
file name to the executable upon activation of the tool. The argument string is
%(ProjStoreFileName).
– Working Directory—This argument passes the current working directory to
the executable upon activation of the tool. The argument string is %(Proj-
WorkDir).

• Initial Directory—Specifies the initial or working directory of the tool or

command. Click the > button to open a submenu containing predefined directory
variables. The available variables are:
– Project Directory—This variable specifies the current project directory as
the Initial Directory. The variable string is %(ProjDir).
– Working Directory—This variable specifies the current working directory as
the Initial Directory. The variable string is %(ProjWorkDir).

• Test—This button executes the external tool using the specified settings.

10-720 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Modeling Tips
The paragraph presents some FAQs related to modeling water distribution networks
with Bentley HAMMER 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 Pumped Groundwater Well

• Modeling Parallel Pipes
• Modeling Pumps in Parallel and Series
• Modeling Hydraulically Close Tanks
• Modeling Fire Hydrants
• Modeling a Connection to an Existing Water Main
• Top Feed/Bottom Gravity Discharge Tank

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.

Figure 10-1: Pump Curve Accounting for Drawdown

Bentley HAMMER V8i Edition User’s Guide 10-721

Modeling Tips

EXAMPLE:

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

Head (ft.) Discharge (gpm)

1260 0

1180 8300

1030 12400

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

Drawdown (ft.) Discharge (gpm)

40 8300

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 manufac-
turers 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.

10-722 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Figure 10-2: 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:

Figure 10-3: Pumps in Parallel and Series

If the pumps are identical, the system may also be modeled as a single, composite
pump that has a characteristic curve equivalent to the two individual pumps. For
pumps in parallel, the discharge is multiplied by the number of pumps, and used
against the same head value. Two pumps in series result in an effective pump with
twice the head at the same discharge.

For example, two pumps that can individually operate at 150 gpm at a head of 80 feet
connected in parallel will have a combined discharge of 2•150 = 300 gpm at 80 feet.
The same two pumps in series would pump 150 gpm at 2•80 = 160 feet of head. This
is illustrated as follows:

Bentley HAMMER V8i Edition User’s Guide 10-723

Modeling Tips

Figure 10-4: Pumps Curves of Pumps in Series and Parallel

Modeling Hydraulically Close Tanks

If tanks are hydraulically close, as in the case of several tanks adjacent to each other, it
is better to model these tanks as one composite tank with the equivalent total surface
area of the individual tanks.

This process can help to avoid fluctuation that may occur in cases where the tanks are
modeled individually. This fluctuation is caused by small differences in flow rates to
or from the adjacent tanks, which offset the water surface elevations enough over time
to become a significant fluctuation. This results in inaccurate hydraulic grades.

Modeling Fire Hydrants

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

Modeling a Connection to an Existing Water Main

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

Figure 10-5: Approximating a Connection to a Water Main with a Pump

and a Reservoir

10-724 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

The reservoir simulates the supply of water from the system. The Elevation of the
reservoir should be equal to the elevation at the connection point.

The pump and the pump curve will simulate the pressure drops and the available flow
from the existing water system. The points for the pump curve are generated using a
mathematical formula (given below), and data from a fire flow test. The pipe should
be smooth, short and wide. For example, a Roughness of 140, length of 1 foot, and
diameter of 48 inches are appropriate numbers.

Please note that it is ALWAYS best to model the entire system back to the source. This
method is only an approximation, and may not represent the water system under all
flow conditions.

Qr = Qf * [(Hr/Hf)^.54]

Qr = Flow available at the desired fire flow residual

Where:
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)

EXAMPLE: DETERMINING THE THREE-POINT PUMP CURVE

1. The first point is generated by measuring the static pressure at the hydrant
when the flow (Q) is equal to zero.
Q = 0 gpm
H = 90psi or 207.9 feet of head (90 * 2.31)
(2.31 is the conversion factor used to convert psi to feet of head).
2. The engineer chooses a pressure for the second point, and the flow is calcu-
lated using the Formula below. The value for Q should lie somewhere
between the data collected from the test.
Q=?
H = 55 psi or 127.05 feet (55 * 2.31) (chosen value)
Formula:
Qr = Qf * (Hr/Hf)^.54
Qr = 800 * [((90 - 55) / (90 - 22))^.54]
Qr = 800 * [(35 / 68)^.54]
Qr = 800 * [.514^.54]
Qr = 800 * .69
Qr = 558

Bentley HAMMER V8i Edition User’s Guide 10-725

Modeling Tips

Therefore,
Q = 558 gpm
3. The third point is generated by measuring the flow (Q) at the residual pressure
of the hydrant.
Q = 800 gpm
H = 22 psi or 50.82 ft. of head (22 * 2.31)
Pump curve values for this example:

Discharge
Head (ft.)
(gpm)

207.9 0

127.05 558

50.82 800

Top Feed/Bottom Gravity Discharge Tank

A tank element in Bentley HAMMER 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.

Figure 10-6: Top Feed/Bottom Gravity Tank

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.

10-726 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

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 eleva-
tions.

The outlet of the tank can then proceed to the distribution system.

Figure 10-7: Example Layout

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:

Q  KP n

Where: Q = flow through hydrant (gpm, l/s)

K = overall emitter coefficient (gpm/psin, l/s/mn)
P = pressure upstream of hydrant (psi, m)
n = pressure exponent (0.5 for hydrant outlets)

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.

Bentley HAMMER V8i Edition User’s Guide 10-727

Modeling Tips

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:

1
K 1
 1 1 1 1  2
 2
( 4  4 )  2 
 2 gC F c F DO DP k 

Where: v = velocity (ft./sec., m/s)

CF = unit conversion factor (2.31 for pressure in psi,
1 for pressure in m)
cF = unit conversion factor (2.44 for flow in gpm,
diameter in inches, 0.0785 for flow in l/s,
diameter in mm)
g = gravitation acceleration (ft./sec.2, m/s2)
k = pressure drop coefficient for hydrant
K = overall emitter coefficient
Do = diameter of orifice

Dp = diameter of pipe

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.

10-728 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

Table 10-2: Emitter K Values for Hydrants

K
Outlet k k K
gpm/psin,
Nominal (in.) gpm, psi l/s, m l/s, m
l/s/mn

2.5 250-600 18-45 150-180 11-14

2-2.5 350-700 26-52 167-185 13-15

4.5 447-720 33-54 380-510 30-40

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

With Bentley HAMMER 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 pump’s actual speed to some reference speed. The reference
speed generally used is the full speed of the motor. For example, if the pump speed is
1558 rpm while the motor is a 1750-rpm motor, the relative speed is 0.89. This rela-
tive 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.

Modeling variable speed pumps includes:

• Types of Variable Speed Pumps on page 10-730

• Pattern Based on page 10-730
• Fixed Head on page 10-730
• Controls with Fixed Head Operation on page 10-731

Bentley HAMMER V8i Edition User’s Guide 10-729

Modeling Tips

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 pres-
sure 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, change the Is Variable Speed Pump?
attribute in the Properties dialog to True. This will enable the VSP Type attribute,
allowing you to specify the VSP type.

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.

Fixed Head
Fixed head control is achieved by selecting Fixed Head from the VSP Type? menu.
Once Fixed Head is selected, you must describe how the control is implemented.

You must identify a node that controls the pump. This is the node where some type of
pressure or water level sensor is located. This can be done by:

• Using the menu and picking the node from the list

10-730 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

• Clicking the Ellipsis (…) button and using the Select Element dialog box.
• Clicking the Select From Drawing button and picking the node from the drawing.

In selecting the control node, you must choose a node that is actually controlled by the
VSP. For example, the selected node must be in the same pressure zone (i.e., one that
is not separated from the pump by another pump or PRV) and should not have a tank
directly between the node and the pump.

You must then select the head to be maintained at that node. If the node selected for
control is a tank, then the Target Head is set as the initial head in the tank. If a junction
node is selected, the head must be a feasible head. If a physically infeasible head is
given, the problem may not be solved or some unrealistic flow may be forced to meet
this head (e.g., backward flow through pump).

You also have the option of setting the maximum relative speed of the pump, which
would usually correspond to the rated speed of the motor. The default value for this is
1.0. You can have the model ignore this limit by placing a large value in the field for
maximum speed.

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)

Bentley HAMMER V8i Edition User’s Guide 10-731

Modeling Tips

Parallel VSPs
Variable speed pumps can also be modeled in parallel. If you use the Fixed Head
pump type, both parallel VSPs must be set to the same target node. The program
will attempt to meet the fixed head requirements you set using only one of the
pumps. If the fixed head cannot be met with only one of the pumps, the second
pump will be turned on, and the relative speed settings of the pumps will be
adjusted to compensate.

Variable speed pumps (VSPs) can be modeled in parallel. This allows you to model
multiple VSPs operated at the same speed at one pump station. To model this, a 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.

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

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

10-732 Bentley HAMMER V8i Edition User’s Guide

 Modeling Capabilities

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 down-
stream side of a wet well to pump the flow out of the well and also to maintain a fixed
wet well water level, Bentley HAMMER 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.

Bentley HAMMER V8i Edition User’s Guide 10-733

Modeling Tips

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

Fixed Flow VSP

Fixed flow VSP enables the user to model a pump that is controlled to deliver a
desired amount of flow. This can be a typical control case when a pump is supplying
water to an "open" system where a tank is located in the downstream distribution
system. It is unlikely that a pump is expected to supply the fixed flow to a "closed"
system where no tank is located at the downstream of a pump.

Bentley HAMMER facilitates the fixed flow VSP modeling. It automatically calcu-
lates 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 as 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.

10-734 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your
Results 11
Transient Results Viewer

Annotating Your Model

Color Coding A Model

Contours

Using Profiles

Viewing and Editing Data in FlexTables

Reporting

Graphs

Calculation Summary

Print Preview Window

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 Tran-
sient 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, Tran-
sient).
• Profiles don't show any results for the intermediate points along a pipe.

The dialog consists of the following controls:

Bentley HAMMER V8i Edition User’s Guide 11-735

Transient Results Viewer

• 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
toggled 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 section.
– Graph Type: Select the attribute(s) that will be displayed on the plot/anima-
tion.
– 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 of the profile path.

11-736 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

• Time Histories: Select the Report Point.

– Graph Type: Select the attribute(s) that will be displayed on the plot/anima-
tion.
– Plot: Click this 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.
Looking from left to right, the Transient Results Viewer allows you to select the loca-
tions (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 on the Viewer but only showing applicable commands.
• Time Value: Shows the time step or frame 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.
• Sliders: 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 Tran-
sient Results Viewer:

Open the “TransientResultViewerOptions.xml” file located in the C:\Program-

Data\Bentley\HAMMER\8\ directory.

Bentley HAMMER V8i Edition User’s Guide 11-737

Transient Results Viewer

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.

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 clip-
board.
• Paste Settings: Modifies the current graph using the settings previously copied to
the Windows clipboard.

11-738 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

• 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 avail-
able 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 Tran-
sient 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.

Bentley HAMMER V8i Edition User’s Guide 11-739

Transient Results Viewer

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 visu-
alize 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.
• 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 orien-
tation, 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 contents. Useful for comparing
the results of two similar HAMMER projects.
• Close (Ctrl + F4): Closes the current graph window without saving its contents.

11-740 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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 Tran-
sient 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, Tran-
sient).
• 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 two tabs:

• Profiles Tab
• Time Histories TabTime Histories Tab

Profiles Tab

This tab allows you to view profile results from transient simulations.

It consists of the following controls:

Bentley HAMMER V8i Edition User’s Guide 11-741

Transients Results Viewer Dialog (New)

• 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 section.
• Graph Type: Select the attribute(s) that will be displayed on the plot/animation.
• Profile Button: Opens the Transient Profile Viewer Dialog Box.

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.

Maximum Volume

Maximum Head

Initial Head

Minimum Head

Elevation

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 Calcula-
tion Options for more information).

11-742 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

The dialog consists of the following controls:

• Profile Options: Clicking this button opens the Transient Profile Viewer
Options Dialog Box, 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.

• 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.
To zoom back out, click and hold the mouse button, drag the mouse in the oppo-
site direction (right to left), and release the mouse button.

• Zoom In: Increases the magnification of the area that is clicked when this
tool is active.

• Zoom Out: Decreases the magnificatyion of the profile view.

• Go to Start: Sets the currently displayed time step to the beginning of the
simulation.

Bentley HAMMER V8i Edition User’s Guide 11-743

Transients Results Viewer Dialog (New)

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

11-744 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

• 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 Auto-
matic Scaling box is unchecked.
– 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 seelct 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.

Bentley HAMMER V8i Edition User’s Guide 11-745

Transients Results Viewer Dialog (New)

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

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 Calcula-
tion Options for more information).

The dialog consists of the following controls:

• Chart Settings: Clicking this button opens the Chart Options Dialog Box,
allowing you to specify the graph display options. Clicking on the arrow on the
right side of the button opens a submenu containing the following commands:
– Title: Toggles on/off the graph title.
– Legend: Toggles on/off the graph legend.
– Save As Default Profile Settings: Choose this command to set the current
graph options as your new defaults.
– Apply Default Settings: Choose this command to apply your previously
saved default settings to the current graph.
– 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.

11-746 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

• 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 oppo-
site direction (right to left), and release the mouse button.

• Go to Start: Sets the currently displayed time step to the beginning of the
simulation.

• Pause/Stop: Stops the animation at the current time step.

• Play: Animates the profile view.

• Time Display: Shows the current time step that is displayed in the profile.
• 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.

Annotating Your Model

You can annotate any of the element types in Bentley HAMMER V8i using the
Element Symbology manager.

Bentley HAMMER V8i Edition User’s Guide 11-747

Annotating Your Model

To work with annotations, open the Element Symbology manager. ChooseView >
Element Symbology or press <Ctrl+1> to open.

Use the Element Symbology manager to control the way that elements and their asso-
ciated labels are displayed.

11-748 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Note that element types that are not used in the current model are marked with an icon
.

The dialog box contains a pane that lists each element type along with the following
icons:
;

Symbology The menu lists all of the available element

Definition symbology definitions. Click the ellipsis (...)
button to open the Symbology Definitions
Manager.

New Opens a submenu containing the following

commands:
• New Annotation—Opens the Annota-
tion Properties dialog box, allowing you
to define annotation settings for the
highlighted element type.
• New Color Coding—Opens the Color
Coding Properties dialog box, allowing
you to define annotation settings for the
highlighted element type.
• Add Folder—Creates a folder under the
currently highlighted element type,
allowing you to manage the various
color coding and annotation settings
that are associated with an element.
You can turn off all of the symbology
settings contained within a folder by
clearing the check box next to the folder.
When a folder is deleted, all of the
symbology settings contained within it
are also deleted.

Delete Deletes the currently highlighted Color

Coding or Annotation Definition or folder.

Rename Renames the currently highlighted object.

Edit Opens a Properties dialog box that

corresponds with the selected background
layer.

Bentley HAMMER V8i Edition User’s Guide 11-749

Annotating Your Model

Refresh Opens a shortcut menu containing the

Element following options:
Symbology • Refresh Element Symbology - This
can be useful if your color-coding and/or
annotations are applied to a subset of
elements using a query-based selection
set. For performance reasons, query-
based selection sets are treated as
static selection sets by default. Use this
option to refresh the query based selec-
tion set while refreshing element
symbology.
• Refresh Annotation - If you change an
annotation's prefix or suffix in the Prop-
erty Editor, or directly in the database,
selecting this command refreshes the
annotation.
• Update Annotation Offset - If you have
adjusted the Initial X or Y offsets,
selecting this command resets all anno-
tation X or Y offsets to the currently
specified "initial offset" location.
• Update Annotation Height - If you've
adjusted the height multiplier, selecting
this command resets all annotation
heights multipliers to the currently speci-
fied initial height multiplier

Shift Up Moves the currently highlighted object up in

the list pane.

11-750 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Shift Down Moves the currently highlighted object

down in the list pane.

Drawing Opens a menu containing the following

Style commands:
• CAD Style—Displays currently high-
lighted element in CAD Style. Objects
displayed in CAD style will appear
smaller when zoomed out and larger
when zoomed in.
• GIS Style—Displays currently high-
lighted element in GIS style. Objects
displayed in GIS style will appear to
remain the same size regardless of
zoom level.
This button is only available in the Stand-
Alone version (not in MicroStation,
AutoCAD, or ArcGIS versions).

Tree Opens a menu containing the following

commands:
• Expand All—Expands each branch in
the tree view pane.
• Collapse All—Collapses each branch in
the tree view pane.

Help Displays online help for the Element

Symbology Manager.

The Element Symbology manager supports Copy/Paste functionality as well as Undo/

Redo capability. You can copy/paste annotations, color coding definitions, and folders
by right-clicking them and selecting Copy/Paste. When a folder is copied in this way
all of the contents of that folder are also copied.

Using Folders in the Element Symbology Manager

Use folders in the Element Symbology manager to create a collection of color coding
and/or annotation that can be turned on or off at the same time.

Bentley HAMMER V8i Edition User’s Guide 11-751

Annotating Your Model

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.
Or, select the element to which you want to add the folder, click the New button,
then select New Folder.
3. Name the folder.
4. 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.
5. Use the folder to collectively turn on and off the annotations and color coding
within the folder.

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.

To add an annotation

1. Click View > Element Symbology.

2. In the Element Symbology manager, right-click an element and select New >
Annotation.
Or, select the element where you want to add the annotation, click the New button,
and select New Annotation.
3. The Annotation Properties dialog box opens. Select the annotation you want in the
Field Name menu.
4. If needed, set a Prefix or Suffix. Anything you type as a prefix is added directly to
the beginning of the label and anything you type as a suffix is added to the end
(you may want to include spaces as part of your prefix and suffix).

11-752 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

5. Select the initial X- and Y- offset for the annotation. Offset is measured from the
center of the node or polygon or midpoint of the polyline.
6. If needed, set an initial height multiplier. Use a number greater than 1 to make the
annotation larger and a number between 0 and 1 to make the annotation smaller. If
you use a negative number, the annotation is flipped (rotated 180 degrees).
7. If you have created selection sets, you can apply your annotation only to a partic-
ular selection set by selecting that set from the Selection Set menu. If you have not
created any selection sets, then the annotation is applied to all elements of the type
you are using.
8. After you finish defining your annotation, click Apply and then OK to close the
Annotation Properties dialog box and create your annotation. In order to close the
dialog box without creating an annotation click Cancel.

To delete an annotation

Click View > Element Symbology. In the Element Symbology manager, right-click
an annotation you want to delete, then select Delete.

Or, select the annotation you want to delete, then click the Delete button.

To edit an annotation

Click View > Element Symbology. In the Element Symbology manager, right-click
the annotation you want to edit, then select Edit.

Or, select the annotation you want to edit, then click the Edit button and the Annota-
tion Properties dialog box will open where you can make changes.

Rename an annotation

Click View > Element Symbology. In the Element Symbology manager, right-click
the annotation you want to rename, then select Rename.

Or, select the annotation you want to rename, then click the Rename button.

To copy an annotation

1. Click View > Element Symbology. In the Element Symbology manager, right-
click the annotation you want to copy, then select Copy.
2. Right-click on the element type and folder (if applicable) under which you want
the annotation to be copied and select Paste.

Bentley HAMMER V8i Edition User’s Guide 11-753

Annotating Your 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.

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.

11-754 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Initial X Offset Displays the initial X-axis offset of the

annotation in feet. Sets the initial horizontal
offset for an annotation. Set this at the time you
create the annotation. Clicking OK will cause
the new value to be used for all subsequent
elements that you place. Clicking Apply will
cause the new value to be applied to all
elements.

Initial Y Offset Displays the initial Y-axis offset of the

annotation in feet. Sets the initial vertical offset
for an annotation. Set this at the time you create
the annotation. Clicking OK will cause the new
value to be used for all subsequent elements that
you place. Clicking Apply will cause the new
value to be applied to all elements.

Initial Multiplier When this box is checked, changes made to the

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

Free Form Annotation Dialog Box

The Free Form Annotation dialog box allows you to type custom annotations for an
element type.

Bentley HAMMER V8i Edition User’s Guide 11-755

Annotating Your Model

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.

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:

11-756 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

Rename Lets you rename the currently highlighted

symbology definition.

Help Displays online help for the Symbology

Definitions manager.

When you create a new definition, all of the annotation and color settings will be
turned off. To change the settings for a definition, change the current symbology defi-
nition 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 A Model

Use color coding to help you quickly see what's going on in your model or 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, go to View > Element Symbology > New Color Coding to
open the Color Coding Properties dialog box.

Bentley HAMMER V8i Edition User’s Guide 11-757

Color Coding A Model

The dialog box consists of the following controls:

Properties

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.

Color Map

11-758 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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 high-
lighted 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 Bentley HAMMER 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.

Bentley HAMMER V8i Edition User’s Guide 11-759

Color Coding A Model

Or, select the element you want to add the color coding, click the New button, and
select New Color Coding.
3. The Color Coding Properties dialog box opens. Select the properties you want to
color code from the Field Name and Selection Set menus. Once you’ve selected
the Field Name, more information opens.
4. In the Color Maps Options menu, select whether you want to apply color, size, or
both to the elements you are coding.
a. Click Calculate Range. This automatically sets the maximum and minimum
values for your coding. These values can be set manually.
b. Click Initialize. This automatically creates values and colors in the Color
Map. These values can be set manually.

5. After you finish defining your color coding, click Apply and then OK to close the
Color Coding Properties dialog box and create your color coding, or Cancel to
close the dialog box without creating a color coding.
6. Click Compute to compute your network.
c.

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.

11-760 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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

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.

Bentley HAMMER V8i Edition User’s Guide 11-761

Contours

Contours
Using Bentley HAMMER 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 clicking
on items in the list to select multiple entries
at once.

Rename Renames the currently selected contour.

Edit Opens the Contour Definition dialog box,

where you can modify the settings of the
currently selected contour.

11-762 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Export Clicking this button opens a submenu

containing the following commands:
• Export to Shapefile - Exports the
contour to a shapefile, opening the
Export to File Manager to select the
shapefile.
• Export to DXF - Exports the contour as
a .dxf drawing.
• Export to Native Format - Opens the
DXF Properties dialog box, allowing you
to add it to the Background Layers
Manager.

View Opens the Contour Browser dialog,

Contour allowing you to display detailed contour
Browser results for points in the drawing view.

Refresh Regenerates the contour.

Shift Up Moves the currently selected contour up in

the list pane.

Shift Moves the currently selected contour down

Down in the list pane.

Help Displays online help for the Contours.

Bentley HAMMER V8i Edition User’s Guide 11-763

Contours

Contour Definition

The Contour Definition dialog box contains the information required to generate
contours for a calculated network.

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.

11-764 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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

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 When contours are created, there are labels (text)
Multiplier 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.

Bentley HAMMER V8i Edition User’s Guide 11-765

Contours

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.

Tip: 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.

11-766 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Contour Plot

The Contour Plot window displays the results of a contour map specification as accu-
rate, straight-line contours.

The plot can be printed or exported as a .DXF file. Choose File > Export > DXF to
export the plot.

Tip: Although the straight-line contours generated by this program

are accurate, smooth contours are often more desirable for
presentation purposes. You can smooth the contours by clicking
Options and selecting Smooth Contours.

Note: Contour line index labels can be manually repositioned in this

view before sending the plot to the printer. The Contour Plot
Status pane displays the Z coordinate at the mouse cursor.

Contour Browser Dialog Box

The Contour Browser dialog box displays the X and Y coordinates and the calculated
value for the contour attribute at the location of the mouse cursor in the drawing view.

Bentley HAMMER V8i Edition User’s Guide 11-767

Using Profiles

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.

11-768 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

New Opens the Profile Setup dialog box, where

you can select the elements to be included in
the new profile from the drawing view.

Delete Deletes the currently selected profile. You

can hold down the Ctrl key while clicking
on items in the list to select multiple entries
at once.

Rename Renames the currently selected profile.

Edit Opens the Profile Setup dialog box, where

you can modify the settings of the currently
selected profile.

View Opens the Profile viewer, allowing you to

Profile view the currently selected profile.

Highlight When this toggle button is on, elements

Profile contained within the currently highlighted
profile will be highlighted in the drawing
pane to increase their visibility.

Help Displays online help for Profiles.

By default, all profiles are created as Transient Report Paths. A Transient Report Path
is denoted by a small hammer icon.

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.

Bentley HAMMER V8i Edition User’s Guide 11-769

Using Profiles

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:

ID The element ID of the corresponding profile

element.

Label The label of the corresponding profile element.

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.

11-770 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

You can edit your list of profile elements at any time and compute your network with
the Profile Viewer dialog box open, but you must click Refresh to update the display
of that dialog box if you do make changes.

Note that certain changes made to the network (morphing one element into another,
reconnecting pipes) can break existing profiles that include the modified element(s). If
this happens, delete the last node before the break (where the modified element is) in
the profile setup dialog and edit it accordingly to add the modified elements.

Bentley HAMMER V8i Edition User’s Guide 11-771

Using Profiles

Note: In AutoCAD mode, you cannot use the shortcut menu, you must
re-open the Profile Setup dialog box.

Profile Selection with Inactive Elements

Normally, Bentley HAMMER will select the shortest path between two elements
when setting up a profile, as shown below:

The user has selected R-220 and J-40; the profile is the shortest
path between the selected elements

11-772 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

If one or more elements along the shortest path is Inactive, Bentley HAMMER will
select the shortest path that avoids the inactive elements, as shown below:

The user has again selected R-220 and J-40 but J-30 is Inactive.
The profile is the shortest path around the inactive element
You can include inactive elements in a profile; to do so, create a profile along the
desired path up to the first inactive element. Then click on each inactive pipe that you
wish to include in the profile until the profile path is complete, or your path returns to
the active elements again.

Bentley HAMMER V8i Edition User’s Guide 11-773

Using Profiles

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.

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 avail-
able fields grouped categorically.

11-774 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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

When you complete setting up your profile a Profile viewer will open which contains
the profile in graph or data format.

It consists of the profile display pane and the following controls:

Profile Series Setting Opens the Profile Series Options box.

Bentley HAMMER V8i Edition User’s Guide 11-775

Using Profiles

Chart Settings Opens the Chart Options dialog box to view and
modify the display settings for the current profile
plot.

Note: 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.

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.

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

Zoom Extents Magnifies the profile so that the entire graph is

displayed.

11-776 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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

Animation Controls

• Go to start—Sets the currently displayed time

step to the beginning of the simulation.
• Pause/Stop—Stops the animation. Restarts it
again with another click.
• Play—Advances the currently displayed time
step from beginning to end.
• Time—Shows the current time step that is
displayed in the drawing pane.
• Time Slider—Manually move the slider repre-
senting the currently displayed time step along
the bar, which represents the full length of
time that the scenario encompasses.

To create a new profile

1. Choose View > Profiles or click the Profiles Manager icon on the View toolbar to
open the Profiles manager.

2. Click New .

Bentley HAMMER V8i Edition User’s Guide 11-777

Using Profiles

3. The Profile Setup dialog box opens.

4. Select the Elements you want to use:

a. Click Select from Drawing. The Select dialog box opens:

To create a profile, the user can select the beginning and ending element of the
profile and then pick the green check. The shortest path between those
elements will be used to draw the profile. If the user wants to create a profile
along a path other than the shortest path, the user should initially draw the
path through the first element that the profile will be forced through and then
add elements as described below. The profile will display in the drawing in
red and the node elements that the user selected along the profile will be in
purple.

b. To add elements to the profile, click elements in the drawing pane. (By

default, the Add button is active in the Select dialog box.) You can only
add elements to either end of your selection.

11-778 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

When the Add button is toggled on, you can select elements to add to the
profile; elements that you successfully select are highlighted in red.

c. To remove elements from the profile, click the Remove button in the
Select dialog box. Thereafter, elements you select in the drawing pane are
removed from the profile. You can only remove elements from either end of
your selection.

When the Remove button is toggled on, you can remove elements from the
profile; unselected elements are not highlighted.

d. When you are finished adding elements to your profile, click the Done
button in the Select dialog box.

5. The Profile Setup dialog box opens and displays a list of the elements you
selected.

6. Click Open Profile to close the Profile Setup dialog box and open the Profile
Series Options box.

Bentley HAMMER V8i Edition User’s Guide 11-779

Using Profiles

Note: If you want to close the Profile Setup box without saving your
changes, click Cancel or close the dialog.

7. Select the Scenarios, Elements, and Fields to be included in the Profile. Then
click OK. By default the Elevation and Hydraulic Grade fields are selected for the
current scenario.

8. The Profile viewer opens.

9. Once you have created a profile you can open it by double clicking on the name of
the profile or by right clicking and selecting Open from the menu.
To edit a profile

You can edit a profile to change the elements that it uses or the order in which those
elements are used.

1. Choose View > Profiles to open the Profiles manager.

2. In the Profiles manager, right-click the profile you want to edit, then select Edit

.
Or, select the profile you want to edit, then click Edit .
3. The Profile Setup dialog box opens. Modify the profile as needed and click Open
Profile to save your changes or Cancel to exit without saving your changes.

To delete a profile

11-780 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Click View > Profiles to open the Profiles manager. In the Profiles manager, right-

click the profile you want to delete, then select Delete .

Or, select the profile you want to delete, then click Delete.

To rename a profile

Click View > Profiles to open the Profiles manager. In the Profiles manager, right-

click the profile you want to rename, then select Rename .

Or, select the profile you want to rename, then click Rename.

To highlight the profile path in the drawing

Click View > Profile to open the Profiles Manager, the click the Highlight button

Or, select the profile, then right click the Highlight command.

There is an additional right click option, "Transient Report Path". This is used when a
WaterGEMS/CAD model is imported into HAMMER for transient analysis. A report
on transients is prepared for any path for which this option is checked.

To view a profile

1. Click Compute to calculate flows.

2. Click View > Profiles to open the Profile manager.
3. In the Profile manager, select the profile you want to view, and right click Open or
double-click the profile to be viewed.

Bentley HAMMER V8i Edition User’s Guide 11-781

Using Profiles

Note: You can edit your list of profile elements at any time and
compute your network with the Profile Viewer dialog box open,
but you must click Refresh to update the display of that dialog
box if you do make changes.

4. The Profile dialog box opens.

5. In order to change the look of the profile click Chart Settings .

6. If you want to print you can use Print Preview to see what it will look like and
then Print.

To animate a profile

1. Click Compute to calculate flows.

2. Click View > Profiles to open the Profiles manager.
3. In the Profiles manager, select the profile you want to view and click the Profile
button to open the profile in Profile Viewer.
4. In the Profile dialog box, move the Time slider or click one of the animation
controls and watch the profile change over time in the Profile Viewer. As needed,
click the Pause button in the Scenario Animation dialog box to study the profile at
a given time.

11-782 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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 custom-
ized 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.

Bentley HAMMER V8i Edition User’s Guide 11-783

Viewing and Editing Data in FlexTables

FlexTables

Using the FlexTables manager you can create, manage, and delete custom tabular
reports. The dialog box contains a list pane that displays all of the custom FlexTables
currently contained within the project, along with a toolbar.

11-784 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Note that element types that are not used in the current model are marked with an icon
.

Bentley HAMMER V8i Edition User’s Guide 11-785

Viewing and Editing Data in FlexTables

11-786 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

The toolbar contains the following icons:

New Opens a menu containing the following

commands:
• FlexTable—Creates a new tabular
report and opens the FlexTable Setup
dialog box, where you can 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
in order to group custom FlexTables.

Delete Deletes the currently selected FlexTable.

Rename Renames the currently selected FlexTable.

Edit Opens the FlexTable Setup dialog box,

allowing you to make changes to the format
of the currently selected table.

Open Opens a menu containing the following

commands:
• Open-Opens the currently selected
FlexTable.
• Open On Selection-Opens the FlexTable
for the element that is highlighted in the
drawing.

Reset to When a Predefined table is highlighted in

Factory the list, this button allows you to reset the
Defaults highlighted table to the factory default.

Help Displays online help for the FlexTable

manager.

Bentley HAMMER V8i Edition User’s Guide 11-787

Viewing and Editing Data in FlexTables

Working with FlexTable Folders

You can add, delete, and rename folders in the FlexTable manager to organize your
FlexTables into groups that can be turned off as one entity. You can also create folders
within folders. When you start a new project, Bentley HAMMER V8i displays two
items in the FlexTable manager: Tables - Project (for project-level FlexTables) and
Tables - Shared (for FlexTables shared by more than one Bentley HAMMER V8i
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 or to open the FlexTables manager.

2. In the FlexTable manager, select either Tables - Project or Tables - Shared, then
click the New button.
– If you are creating a new folder within an existing folder, select the folder,
then click the New button.
3. Click New Folder from the menu.

4. Right-click the new folder and click Rename or click .

5. Type the name of the folder, then press <Enter>.

To delete a FlexTable folder

1. Click View > FlexTables to open the FlexTables manager.

2. In the FlexTables manager, select the folder you want to delete, then click the
Delete button.
– You can also right-click a folder to delete, then select Delete from the shortcut
menu.
To rename a FlexTable folder

1. Click View > FlexTables to open the FlexTables manager.

2. In the FlexTables manager, select the folder you want to rename, then click the
Rename button.
– You can also right-click a folder to rename, then select Rename from the
shortcut menu.
3. Type the new name of the folder, then press Enter.
– You can also rename a FlexTable folder by selecting the folder, then modi-
fying its label in the Properties Editor.

11-788 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

FlexTable Dialog Box

FlexTables are displayed in the FlexTable dialog box. The dialog box contains a
toolbar, the rows and columns of data in the FlexTable, and a status bar.

The toolbar contains the following buttons:

Export Export to a Tab Delimited file .txt or a

Comma Delimited File .csv.

Copy 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 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, so

you can make changes to the format of the
currently selected table.

Bentley HAMMER V8i Edition User’s Guide 11-789

Viewing and Editing Data in FlexTables

Zoom To Centers the drawing view on the element

that is currently highlighted in the table.

Report Report Current Time Step, Report All Time

Steps, or Report in XML.

Selection Opens a submenu containing the following

Set commands:
• Create Selection Set—Creates a new
static selection set (a selection set
based on selection) containing the
currently selected elements in the
FlexTable.
• Add to Selection Set—Adds the
currently selected elements in the
FlexTable to an existing selection set.
• Remove from Selection Set—Removes
the currently selected element in the
FlexTable from an existing Selection
Set.
• Relabel-Opens an Element Relabeling
box where you can Replace, Append, or
Renumber.

11-790 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Select in Opens a submenu containing the following

Drawing commands:
• Select In Drawing—Selects the
currently highlighted element(s) in the
drawing pane.
• Add to Current Selection —Adds the
currently selected elements to the group
of elements currently selected in the
drawing pane.
• Remove from Current Selection —
Removes the currently selected
elements from the group of elements
currently selected in the drawing pane.
• Select Within Current Selection—
Selects the element or elements that are
both currently highlighted in the
FlexTable and are already selected in
the Drawing Pane.

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.
2. Perform one of the following steps:
– Right-click the FlexTable you want to open, then select Open.
– Select the FlexTable you want to open, then click the Open button.
– Double-click the FlexTable you want to open.

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

To create a new FlexTable

Bentley HAMMER V8i Edition User’s Guide 11-791

Viewing and Editing Data in FlexTables

Project-level and shared FlexTables are created the same way:

1. Click View > FlexTables or click the FlexTables button on the View toolbar to
open the FlexTables manager.
2. In the FlexTables manager, right-click Tables - Project or Tables - Shared, then
select New > FlexTable.
Or, select Tables - Project or Tables - Shared, click the New button, then select
FlexTable.
3. The Table Setup dialog box opens.
4. Select the Table Type to be created.
5. Filter the table by element type.
6. Select the items to be included by double-clicking on the item or select the item
and click the Add arrow to move to the Selected Columns pane.
7. Click OK.
8. The table displays in the FlexTables manager; you can type to rename the table or
accept the default name.

Deleting FlexTables

Click View > FlexTables to open the FlexTables manager. In the FlexTables manager,
right-click the FlexTable you want to delete, then select Delete.

Or, select the FlexTable you want to delete, then click the Delete button. You cannot
delete predefined FlexTables.

Note: You cannot delete predefined FlexTables.

Naming and Renaming FlexTables

You name and rename FlexTables in the FlexTable manager.

To rename FlexTables

1. Click View > FlexTables or click the FlexTables button on the View toolbar to
open the FlexTables manager.
2. Perform one of the following steps:
– Right-click the FlexTable you want to rename, then select Rename.
– Select the FlexTable you want to rename, then click the Rename button.
– Click the FlexTable you want to rename, to select it, then click the name of
the FlexTable.

11-792 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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, such as in a Property Editor
or managers.
If you make a change that affects a FlexTable outside
the FlexTable, the FlexTable is updated automatically
to reflect the change.
Non-editable columns: Columns 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, for example a Property Editor or 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:
– Right-click the FlexTable, then select Edit.
– Double-click the FlexTable to open it, then click Edit.
– Click the FlexTable to select it, then click the Edit button.

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.

Bentley HAMMER V8i Edition User’s Guide 11-793

Viewing and Editing Data in FlexTables

Editing Column-Heading Text

To change the text of a column heading:

1. Click View > FlexTables to open the FlexTables manager.

2. In the FlexTables manager, open the FlexTable you want to edit.
3. Right-click the column heading and select Edit Column Label.
4. Type the new name for the label and click OK to save those changes and close the
dialog box or Cancel to exit without making any changes.

Changing Units, Format, and Precision in FlexTables

To change the units, format, or precision in a column of a FlexTable:

1. Click View > FlexTables to open the FlexTables manager.

1. In the FlexTables manager, open the FlexTable you want to edit.
2. Right-click the column heading and select Units.
3. Make the changes you want and click OK to save those changes or Cancel to exit
without making any changes.

Navigating in Tables

The arrow keys, <Ctrl+End>, <Page Up>, <Page Down>, and <Ctrl+arrow> keys
navigate to different cells in a table.

11-794 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

Operation Select the type of edit to perform:

• Set: Changes each of the entries in the
column to the value in the Value box.
• Add: Adds the value in the Value box to each
of the entries in the column.
• Divide: Divides each of the entries in the
column by the value in the Value box.
• Multiply: Multiplies each of the entries in the
column by the value in the Value box.
• Subtract: Subtracts the value in the Value box
from each of the entries in the column.

Value Type the value that will be used in the chosen

Operation to edit the entries of the column.

Where When the Table has an active filter, the SQL

Query used by the filter is displayed in this pane.

To globally edit the values in a FlexTable column

1. Click View > FlexTables to open the FlexTables manager.

2. In the FlexTables manager, open the FlexTable you want to edit and find the
column of data you want to change.

Bentley HAMMER V8i Edition User’s Guide 11-795

Viewing and Editing Data in FlexTables

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.
3. Right-click the column heading and select Global Edit.
4. In the Operation field, select what you want to do to data in the column: Add,
Divide, Multiply, Set, or Subtract.

Note: The Operation field is only available for numeric data.

5. In the Global Edit field, type or select the value.

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; 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 to be edited.

2. Right-click a column heading to rank the contents of the column.
3. Select Sort then choose.
– Sort Ascending—Sorts alphabetically from A to Z, from top to bottom. Sorts
numerically from negative to positive, from top to bottom. Sorts selected
check boxes to the top and cleared ones to the bottom.
– Sort Descending—Sorts alphabetically from Z to A, from top to bottom.
Sorts numerically from positive to negative, from top to bottom. Sorts cleared
check boxes to the top and selected ones to the bottom.

– Custom—Select one or more sort keys

– Reset—Back to the original sorting order

11-796 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

To filter a FlexTable

Filter a FlexTable by creating a query.

1. Open the FlexTable to be filtered.

2. Right-click the column heading to filter and select Filter.
Select Custom to open the Query Builder dialog box.
3. 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:
a. Double-click the field to include in your query. The database column name of
the selected field appears in the preview pane.
b. Click the desired operator or keyword button. The SQL operator or keyword
is added to the SQL expression in the preview pane.
c. 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 becomes
disabled after you use it for a particular field.
d. Double-click the unique value you want to add to the query. The value is
added to the SQL expression in the preview pane.

e. Click Apply above the preview pane to validate your SQL expression. If
the expression is valid, the window “Query Successful" opens. Click OK. The
word VALIDATED will be at the bottom of the window.

Bentley HAMMER V8i Edition User’s Guide 11-797

Viewing and Editing Data in FlexTables

f. Click
OK.
Double-click the Click the desired operator Click the Refresh
desired field to add it or keyword button to add it button to display the
to the preview pane to the SQL expression in list of available
the preview pane unique values

Double-
click the
desired
unique
value to
add it to
the SQL
expression
in the
preview
pane

Apply
button

The FlexTable displays columns of data for all elements returned by the query and
the word “FILTERED” is displayed in the FlexTable status bar.

The status pane at the bottom of the Table window always shows the number of rows
displayed and the total number of rows available (for example, 10 of 20 elements
displayed).

If you change the values for an attribute that is being sorted or filtered, the sort or filter
operation needs to be reapplied. To do this, use the Apply Sort/Filter command acces-
sible from the right-click context menu.

To reset a filter

1. Right-click the column heading you want to filter.

2. Select Filter.

11-798 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

3. Click Reset.
4. Click Yes to reset the active filter.

To reapply a sort or filter operation

1. Right-click the column heading for the sort or filter operation you want reapplied.
2. Select Apply Sort/Filter.

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:

Discharge
Slope (ft./ Depth (cfs)
ft.) (ft.)

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

Bentley HAMMER V8i Edition User’s Guide 11-799

Viewing and Editing Data in FlexTables

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:

Discharge
Slope (ft./ Depth (cfs)
ft.) (ft.)

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:

• Changing the Report Title—When you print a table, the table name is used as
the title for the printed report. You can change the title that appears on your
printed report by renaming the table.
• Adding/Removing Columns—You can add, remove, and change the order of
columns from the Table Setup dialog box.
• Drag/Drop Column Placement—With the Table window open, select the
column heading of the column that you would like to move and drag the column
to its new location.
• Resizing Columns—With the Table open, click the vertical separator line
between column headings. Notice that the cursor changes shape to indicate that
you can resize the column. Drag the column separator to the left or right to stretch
the column to its new size.
• Changing Column Headings—With the Table window open, right-click the
column heading that you wish to change and select Edit Column Label.

11-800 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

• Replace—This operation allows you to replace all instances of a character or

series of characters in the selected element labels with another piece of text. For
instance, if you selected elements with labels P-1, P-2, P-12, and J-5, you could
replace all the Ps with the word Pipe by entering P in the Find field, Pipe in the
Replace With field, and clicking the Apply button. The resulting labels are Pipe-1,
Pipe-2, Pipe-12, and J-5. You can also use this operation to delete portions of a
label. Suppose you now want to go back to the original labels. You can enter Pipe
in the Find field and leave the Replace With field blank to reproduce the labels P-
1, P-2, P-12, and J-5. There is also the option to match the case of the characters
when searching for the characters to replace. This option can be activated by
checking the box next to the Match Case field.
• Renumber—This operation allows you to generate a new label, including suffix,
prefix, and ID number for each selected element. For example, if you had the
labels P-1, P-4, P-10, and Pipe-12, you could use this feature to renumber the
elements in increments of five, starting at five, with a minimum number of two
digits for the ID number field. You could specify a prefix P- and a suffix -Z1 in the
Prefix and Suffix fields, respectively. The prefix and suffix are appended to the
front and back of the automatically generated ID number. The value of the new ID

Bentley HAMMER V8i Edition User’s Guide 11-801

Viewing and Editing Data in FlexTables

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.
• Append—This operation allows you to append a prefix, suffix, or both to the
selected element labels. Suppose that you have selected the labels 5, 10, 15, and
20, and you wish to signify that these elements are actually pipes in Zone 1 of
your system. You can use the append operation to add an appropriate prefix and
suffix, such as P- and -Z1, by specifying these values in the Prefix and Suffix
fields and clicking the Apply button. Performing this operation yields the labels P-
5-Z1, P-10-Z1, P-15-Z1 and P-20-Z1. You can append only a prefix or suffix by
leaving the other entry field empty. However, for the operation to be valid, one of
the entry fields must be filled in.

The Preview field displays an example of the new label using the currently defined
settings.

FlexTable Setup Dialog Box

The Table Setup dialog box is where you can customize tables through the following
options:

Table Type Specifies the type of elements that appear in the

table. It also provides a filter for the attributes that
appear in the Available Columns list. When you
choose a table type, the available list only contains
attributes that can be used for that table type. For
example, only manhole attributes are available for
a manhole table.

11-802 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Available Columns Contains all the attributes that are available for
your table design. The Available Columns list is
located on the left side of the Table Setup dialog
box. This list contains all of the attributes that are
available for the type of table you are creating.
The attributes displayed in yellow represent non-
editable attributes, while those displayed in white
represent editable attributes.
Click the Arrow button [>] to open a submenu that
contains all of the available fields grouped
categorically.

Selected Columns Contains attributes that appear in your custom

designed FlexTable. When you open the table, the
selected attributes appear as columns in the table
in the same order that they appear in the list. You
can drag and drop or use the up and down buttons
to change the order of the attributes in the table.
The Selected Columns list is located on the right-
hand side of the Table Setup dialog box. To add
columns to the Selected Columns list, select one
or more attributes in the Available Columns list,
then click the Add button [>].

Add and Remove Select or clear columns to be used in the table and
Buttons 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 Avail-
able 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 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 .

Bentley HAMMER V8i Edition User’s Guide 11-803

Viewing and Editing Data in FlexTables

Copying, Exporting, and Printing FlexTable Data

You can output your FlexTable several ways:

• Copy FlexTable data using the clipboard

• Export FlexTable data as a text file
• Create a FlexTable report.

11-804 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

To copy FlexTable data using the clipboard

You can copy your FlexTable data using 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.

Caution: 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.

4. Paste <Ctrl+v> the data into other Windows software, such as your word-
processing application.

To export FlexTable data as a text file

You can export the data in a FlexTable as tab- or comma-delimited ASCII text for use
in other applications, such as Notepad, spreadsheet, or word processing software.

1. Click View > FlexTables to open the FlexTables manager.

2. In the FlexTables manager, open the FlexTable you want to use.

3. Click Export to File .

4. Select either Tab Delimited or Comma Delimited.
5. When prompted, set the path and name of the .txt file you want to create.

To create a FlexTable report

Create a FlexTable Report if you want to print a copy of your FlexTable and its values.

1. Click View > FlexTables to open the FlexTables manager.

2. In the FlexTables manager, open the FlexTable you want to use.

Note: Instead of Print Preview, you can click Print to print the report
without previewing it.

3. Click Report and select one of the options. A print preview of the report displays
to show what your report will look like.

Bentley HAMMER V8i Edition User’s Guide 11-805

Viewing and Editing Data in FlexTables

Note: You cannot edit the format of the report.

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

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.

To turn Sparklines off, right click the attribute heading and select Hide Sparklines.

11-806 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Sparkline Settings
This dialog alloows 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 calcu-
late 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 speci-
fied 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.

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

Bentley HAMMER V8i Edition User’s Guide 11-807

Reporting

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.

Report Options
The Report Options dialog box offers control over how a report is displayed.

11-808 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Load factory default settings to current view . Click to restore the default
settings to the current view.

Load global default settings to current view . Click to view the stored global
settings as local settings.

Save current view settings to global settings . Click to set the current report
options as the global default.

The header and footer can be fully customized and you can edit text to be displayed in
the cells or select a pre-defined dynamic variable from the cell’s menu.

• %(Company) - The name specified in the 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.
• % (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.

Bentley HAMMER V8i Edition User’s Guide 11-809

Reporting

• % (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

This dialog is accessed by right-clicking any element in the drawing pane and
selecting the Results Table command. It displays a summary of a standard selection of
results related to that element type.

Click the Report button to generate a preformatted report containing the data in the
table.

11-810 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Graphs
Use graphs to visualize your model or parts of your model, such as element properties
or results. The model needs to be computed before you can create graphs. After you

set up your elements and their properties, click the Compute button.

After the model has been calculated, you can graph elements directly from the
drawing view.

To graph a single element

Right-click an element in the drawing view and select the Graph command.

To graph a group of elements

1. Select a group of elements by drawing a selection box around them or by holding

down the Ctrl key and then clicking a series of elements.
2. Right-click one of the selected elements and select the Graph command.

To Graph the elements contained in a selection set

1. Click the View menu and choose the Selection Sets command.
2. In the Selection Sets dialog, highlight the selection set to be graphed and click the
Select In Drawing button.
3. Right-click one of the selected elements and select the Graph command.

Graph Manager

The Graph manager contains any graph you have created and saved in the current
session or in a previous session. Graphs listed in the Graph manager retain any
customizations you have applied. You can graph computed values, such as flow and
velocity.

To use the Graph Manager

1. Compute your model and resolve any errors.

2. Open the Graph manager, click View > Graphs.
3. To Create a Graph select the elements that you want included from the drawing.
Once you have selected the element you can either Right-click an element and
select Graph or select the type of graph from the New button menu.

Bentley HAMMER V8i Edition User’s Guide 11-811

Graphs

4. The Graph manager contains a toolbar with the following icons:

New Select a line-series, bar chart, or scatter plot

graph using the currently selected elements
in your model. If no elements are selected,
you are prompted to select one or more
elements to graph.

Delete Deletes the currently highlighted graph. You

can hold down the Ctrl key while clicking
on items in the list to select multiple entries
at once.

Rename Renames the currently highlighted graph.

View Opens the Graph dialog box to view the

currently highlighted graph.

Add to Opens the Select toolbar, allowing you to

Graph add or remove elements to the currently
highlighted graph.

Help Displays online help for the Graph manager.

5. Bentley HAMMER V8i assumes initial flow—flow at time 0—in all networks to
be 0; thus, graphs of flow begin at 0 for time 0.
6. If needed, click Chart Settings to change the display of the graph.

Tip: If you want your graph to display over more time (for example, it
displays a 24-hour time period and you want to display a 72-hour
period), click Analysis > Calculation Options and change Total
Simulation Time in the Property Editor.

7. 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:
– Delete it

11-812 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

– Rename the graph’s label

– Open it, by selecting Properties.

Note: Graphs are not saved in Graph manager after you close the
program.

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

You can 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 soft-
ware.

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.

Bentley HAMMER V8i Edition User’s Guide 11-813

Graphs

Graph Dialog Box

Using the Graph dialog box you can view and modify graph settings. After you create
a graph, you view it in the Graph dialog box.

11-814 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

The following controls are available:

Graph Tab

Add to Saves the Graph to the Graph manager. When you

Graph click this button, the graph options (i.e., attributes to
Manager 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. 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 Bentley HAMMER V8i.

Add to Adds new elements to the graph using the current

Graph graph series options. Clicking this button returns you
to the drawing view and opens a Select toolbar,
allowing you to change which elements are included
in the graph.

Graph Selects Graph Series Options to control what the graph

Series displays.
Options Select Observed Data to
display user-defined attribute values alongside
calculated results in the graph display dialog.

Chart Opens a submenu containing the following

Settings commands:
• Chart Options— Change graph display settings.
• Detailed Labels—Click to view more information
on the graph.
• Legend-Click to view a legend for the graph.
• Save Chart Options As Default—Saves the
current chart options as the new default settings
for future graphs.
• Apply Default Chart Options—Applies the default
chart options to the current graph.
• Restore Factory Default Chart Options—Deletes
the currently saved default chart options and
replaces them with the default settings that were
originally installed with Bentley HAMMER.

Bentley HAMMER V8i Edition User’s Guide 11-815

Graphs

Print Prints the current view in the graph display pane.

Print Opens the Print Preview dialog box to view the current
Preview image and change the print information.

Copy Copies the current view in the graph display pane to

the Windows Clipboard.

Zoom Zooms out so that the entire graph is displayed.

Extents

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

11-816 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Time (VCR) Evaluate plots over time.

Controls • 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 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—Set a specific time for the graph. A
vertical line moves in the graph display and inter-
sects your plots to show the value of the plot at a
specific time. Use the slider to set a specific time
value.

Graph Displays the graph.

Display
Pane

Data Tab

Data Table 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.

Bentley HAMMER V8i Edition User’s Guide 11-817

Graphs

The Data tab is shown below.

Saving Graph Settings

You can use the Chart Options > Save Chart Options as Default command to save
the current graph settings as the template that will be applied to new graphs in this and
future projects.

Graph settings are saved to the DefaultGraphOptions.xml.bin file and is stored in

the in C:\Users\<user>\AppData\Roaming\Bentley\WaterGEMS\8 directory (in
Windows Vista and Windows 7).

For Windows XP the location is C:\Documents and Settings\User.Name\Applica-

tion Data\Bentley\WaterGEMS\8.

Note: These settings are on a per-user basis.

To reset the options to the factory default , click Chart Options > Restore Factory
Default Chart Options, then use the Chart Options > Save Chart Options as
Default command.

11-818 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

The Scenarios pane lists all of the available scenarios. Check the box next to a
scenario to display the data for that scenario in the graph. The Expand All button
opens all of the folders so that all scenarios are visible; the Collapse button closes the
folders.

The Elements pane lists all of the elements that will be displayed in the graph. The
Expand All button expands the list tree so that all elements are visible; the Collapse
button collapses the tree.

The Fields pane lists all of the available input and output fields. Check the box next to
a field to display the data for that field type in the graph. The Expand All button opens
all of the folders so that all fields are visible; the Collapse button closes the folders.
The Filter by Field Type button allows you to display only Input or Output fields in
the list. Clicking the [>] button opens a submenu that contains all of the available
fields grouped categorically.

Bentley HAMMER V8i Edition User’s Guide 11-819

Graphs

Normal graphs don't show any time varying results from transient simulation - all you
can see are the extreme results like Pressure (Maximum, Transient). To see these time-
varying results you will need to use the Transient Results Viewer.

The Show this dialog on profile creation check box is enabled by default; uncheck this
box to skip this dialog when a new profile is created.

For any given element, the most commonly used fields are displayed underneath a
Common folder, colored blue (see screenshot above). To graph all of these attributes
you can simply check the Common box.

Observed Data Dialog Box

Use this feature to display user-supplied time variant data values alongside calculated
results in the graph display dialog. Model competency can sometimes be determined
by a quick side by side visual comparison of calculated results with those observed
and collection in the field.

• 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 topic for an example of the observed data source
file format.
• Specifying the characteristics of your data - The following charecteristics must
be defined:
– Time from Start - An offset of the start time for an EPS scenario.
– Y Dimension - Unit class for the observed data point(s).
– Numeric Formatter - Group of units that correspond to the selected value.
– Y Unit - A preview of the current displayed unit for the selected format.

11-820 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Note: Go to Tools > Options > Units for a complete list of formats.

Caution: Observed data can only be saved if the graph is saved.

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

Note: Note that the when importing data, the times in the data file must
be valid time-of-day values, like 9:00 or 23:00. They cannot span
multiple days. Therefore values greater than 24 hours, like 25:00,
are invalid.

4. Click Graph to view the Observed data.

5. Click Close.

Sample Observed Data Source

Below is an example of an Observed Data source for import and graph comparison.
The following table contains a flow meter data collection retreived in the field for a
given pipe. We will bring this observed data into the model for a quick visual inspec-
tion against our model's calculated pipe flows.

Table 11-1: Observed Flow Meter Data (Time in Hours)

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

Bentley HAMMER V8i Edition User’s Guide 11-821

Graphs

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.

Table 11-2: Observed Flow Meter Data (24-Hr Clock)

Time (24-hr Flow (gpm)

clock)

00:00 125

00:36 120

03:00 110

09:00 130

13:45 100

18:12 125

21:51 110

Below is a sample of what a comma-delimited (*.csv) file would look like:

0:00,125

0:36,120

3:00,110

9:00,130

13:45,100

18:12,125

21:51,110

11-822 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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 on page 11-824

• Chart Options Dialog Box - Series Tab on page 11-849
• Chart Options Dialog Box - Tools Tab on page 11-857
• Chart Options Dialog Box - Export Tab on page 11-858
• Chart Options Dialog Box - Print Tab on page 11-860
• Border Editor Dialog Box on page 11-861
• Gradient Editor Dialog Box on page 11-862
• Color Editor Dialog Box on page 11-863
• Color Dialog Box on page 11-863
• Hatch Brush Editor Dialog Box on page 11-864
• Pointer Dialog Box on page 11-867
• Change Series Title Dialog Box on page 11-868

Bentley HAMMER V8i Edition User’s Guide 11-823

Chart Options Dialog Box

• Chart Tools Gallery Dialog Box on page 11-868

• TeeChart Gallery Dialog Box on page 11-880

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:

• Series Tab
• Panel Tab
• Axes Tab
• General Tab
• Titles Tab
• Walls Tab
• Paging Tab
• Legend Tab
• 3D Tab

Series Tab
Use the Series tab to display the series that are associated with the current graph. To
show a series, select the check box next to the series’ name. To hide a series, clear its
check box. The Series tab contains the following controls:

Up/Down arrows Lets you select the printer you want to use.

Add Adds a new series to the current graph. The

TeeChart Gallery opens, see TeeChart Gallery
Dialog Box.

Delete Lets you remove the currently selected series.

Title Lets you rename the currently selected series.

Clone Creates a duplicate of the currently selected series.

Change Lets you edit the currently selected series. The

TeeChart Gallery opens, see TeeChart Gallery
Dialog Box.

11-824 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

Bevel Outer Lets you set a raised or lowered bevel effect, or no

bevel effect, for the outside of the chart border.

Color Lets you set the color for the bevel effect that you
use; inner and outer bevels can use different color
values.

Bevel Inner Lets you set a raised or lowered bevel effect, or no

bevel effect, for the inside of the chart border.

Size Lets you set a thickness for the bevel effect that
you use; inner and outer bevels use the same size
value.

Background Tab

Use the Background tab to set a color or image background for your graph. The Back-
ground 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.

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.

Bentley HAMMER V8i Edition User’s Guide 11-825

Chart Options Dialog Box

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 back-
ground of the graph.
• Center—Puts the background image in the
horizontal and vertical center of the graph.
• Normal—Puts the background image in the
top-left corner of the graph.

Gradient Tab

Use the Gradient tab to create a gradient color background for your graph. The
Gradient tab contains the following subtabs and controls:

Format Tab

Visible Determines whether a gradient displays or not.

Select this check box to display a gradient you
have set up, clear this check box to hide the
gradient.

Direction Sets the direction of the gradient. Vertical causes

the gradient to display from top to bottom,
Horizontal displays a gradient from right to left,
and Backward/Forward diagonal display gradients
from the left and right bottom corners to the
opposite corner.

Angle Lets you customize the direction of the gradient

beyond the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient.
Opens the Color Editor dialog box.

11-826 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Middle Lets you select a middle color for your gradient.

The Color Editor opens. Select the No Middle
Color check box if you want a two-color gradient.
Opens the Color Editor dialog box.

End Lets you select the final color for your gradient.
Opens the Color Editor dialog box.

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear
this check box to change the brightness of the
background on-screen. This does not affect printed
output.

Transparency Lets you set transparency for your gradient, where

100 is completely transparent and 0 is completely
opaque.

Options Tab

Sigma Lets you set the location on the chart background

of the gradient’s end color.

Sigma Focus Lets you use the options controls. Select this
check box to use the controls in the Options tab.

Sigma Scale Lets you control how much of the gradient’s end
color is used by the gradient background.

Shadow Tab

Use the Shadow tab to create a shadow for your graph. The Shadow tab contains the
following controls:

Visible Lets you display a shadow for your graph. Select

this check box to display the shadow, clear this
check box to turn off the shadow effect.

Size Set the size of the shadow by increasing or

decreasing the numbers for Horizontal and/or
Vertical Size.

Color Lets you set a color for the shadow of your graph.
You might set this to gray but can set it to any
other color.

Bentley HAMMER V8i Edition User’s Guide 11-827

Chart Options Dialog Box

Pattern Lets you set a pattern for the shadow of your

graph. The Hatch Brush Editor opens, see Hatch
Brush Editor Dialog Box.

Transparency Lets you set transparency for your shadow, where

100 is completely transparent and 0 is completely
opaque.

Axes Tab
Use the Axes tab set how your axes display. It includes the following controls and
subtabs:

Visible When checked, displays all of your graph’s axes;

clear it to hide all of the graph’s axes.

Behind When checked, displays all of your graph’s axes

behind the series display; clear it to display the
axes in front of the series display.

Axes Select the axis you want to edit. The Scales,

Labels, Ticks, Title, Minor, and Position tabs and
their controls pertain only to the selected axis.

Caution: Do not delete the axes called Custom 0 and Custom 1, as

these are reserved axes that are needed by Bentley
HAMMER V8i.

Scales Tab

Use the Scales tab to define your axes scales. The Scales tab contains the following
controls:

Automatic Lets you automatically or manually set the

minimum and maximum axis values. Select this
check box if you want TeeChart to automatically
set both minimum and maximum, or clear this
check box if you want to manually set either or
both.

Visible Displays the axis if selected, hides the axis if

cleared.

11-828 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Inverted Reverses the order in which the axis scale

increments. If the minimum value is at the origin,
then selecting Inverted puts the maximum value at
the origin.

Change Lets you change the increment of the axis.

Increment Displays the increment value you set for the axis.

Logarithmic Lets you use a logarithmic scale for the axis.

Log Base If you select a logarithmic scale, set the base you
want to use in the text box.

Minimum Tab

Auto Lets you automatically or manually set the

minimum axis value.

Change Lets you enter a value for the axis minimum.

Offset Lets you adjust the axis scale to change the

location of the minimum or maximum axis value
with respect to the origin.

Maximum Tab

Auto Lets you automatically or manually set the

maximum axis value.

Change Lets you enter a value for the axis maximum.

Offset Lets you adjust the axis scale to change the

location of the minimum or maximum axis value
with respect to the origin.

Labels Tab

Use the Labels tab to define your axes text. The Labels tab contains the following
subtabs and controls:

Style Tab

Visible Lets you show or hide the axis text.

Bentley HAMMER V8i Edition User’s Guide 11-829

Chart Options Dialog Box

Multi-line Lets you split labels or values into more than one
line if the text contains a space. Select this check
box to enable multi-line text.

Round first Controls whether axis labels are automatically

rounded to the nearest magnitude.

Label on axis Controls whether Labels just at Axis Minimum

and Maximum positions are shown. This applies
only if the maximum value for the axis matches
the label for extreme value on the chart.

Size Determines distance between the margin of the

graph and the placement of the labels.

Angle Sets the angle of the axis labels. In addition to

using the up and down arrows to set the angle in
90° increments, you can type an angle you want to
use.

Min. Separation % Sets the minimum distance between axis labels.

Style Lets you set the label style.

• Auto—Lets TeeChart automatically set the
label style.
• Value—Sets axis labeling based on minimum
and maximum axis values.
• Text—Uses text for labels. Since Bentley
HAMMER V8i uses numeric values, this is not
implemented; don’t use it.
• None—Turns off axis labels.
• Mark—Uses SeriesMarks style for labels.
Since Bentley HAMMER V8i uses numeric
values, this is not implemented; don’t use it.

Format Tab

Exponential Displays the axis label using an exponent, if

appropriate.

Values Format Lets you set the numbering format for the axis
labels.

Default Alignment Lets you select and clear the default TeeChart
alignment for the right or left axes only.

11-830 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Text Tab

Font Lets you set the font properties for axis labels.
This opens the Windows Font dialog box.

Color Lets you select the color for the axis label font.
Double-click the colored square between Font and
Fill to open the Color Editor dialog box (see Color
Editor Dialog Box).

Fill Lets you set a pattern the axis label font. The
Hatch Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Shadow —Lets you set a shadow for the axis labels.

• Visible—Lets you display a shadow for the
axis labels. 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 trans-
parent and 0 is completely opaque.

Ticks Tab

Use the Ticks tab to define the major ticks and their grid lines. The Ticks tab contains
the following controls:

Axis Lets you set the properties of the selected axis.

Opens the Border Editor dialog box.

Grid Lets you set the properties of the graph’s grid lines
that intersect the selected axis. Opens the Border
Editor dialog box.

Bentley HAMMER V8i Edition User’s Guide 11-831

Chart Options Dialog Box

Ticks Lets you set the properties of the tick marks that
are next to the labels on the label-side of the
selected axis. Opens the Border Editor dialog box.

Len Sets the length of the Ticks or Inner ticks.

Inner Lets you set the properties of the tick marks that
are next to the labels on the graph-side of the
selected axis. Opens the Border Editor dialog box.

Centered Lets you align between the grid labels the graph’s
grid lines that intersect the selected axis.

At Labels Only Sets the axis ticks and axis grid to be drawn at
labels only. Otherwise, they are drawn at all axis
increment positions.

Title Tab

Use the Title tab to set the axis titles. The Title tab contains the following subtabs and
controls:

Style Tab

Title Lets you type a new axis title.

Angle Sets the angle of the axis title. In addition to using

the up and down arrows to set the angle in 90°
increments, you can type an angle you want to use.

Size Determines distance between the margin of the

graph and the placement of the labels.

Visible Check box that lets you display or hide the axis
title.

Text Tab

Font Lets you set the font properties for axis title. This
opens the Windows Font dialog box.

Color Lets you select the color for the axis title font.
Double-click the colored square between Font and
Fill to open the Color Editor dialog box (see Color
Editor Dialog Box).

11-832 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Fill Lets you set a pattern the axis title font. The Hatch
Brush Editor opens, see Hatch Brush Editor
Dialog Box

Shadow Lets you set a shadow for the axis title.

• Visible—Lets you display a shadow for the
axis title. 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 trans-
parent and 0 is completely opaque.

Minor Tab

Use the Minor tab to define those graph ticks that are neither major ticks. The Minor
tab contains the following controls and tabs:

Ticks Lets you set the properties of the minor tick

marks. The Border Editor opens, see Border
Editor Dialog Box.

Length Sets the length of the minor tick marks.

Grid Lets you set the properties of grid lines that align
with the minor ticks. The Border Editor opens, see
Border Editor Dialog Box.

Count Sets the number of minor tick marks.

Position Tab

Use the Position tab to set the axes position for your graph. The Position tab contains
the following controls:

Position % Sets the position of the axis on the graph in pixels

or as a percentage of the graph’s dimensions.

Bentley HAMMER V8i Edition User’s Guide 11-833

Chart Options Dialog Box

Start % Sets the start of the axis as percentage of width

(horizontal axis) and height (vertical axis) of the
graph. The original axis scale is fitted to new axis
height/width.

End % Sets the end of the axis as percentage of width

(horizontal axis) and height (vertical axis) of the
graph. The original axis scale is fitted to new axis
height/width.

Units Lets you select pixels or percentage as the unit for

the axis position.

Z% Sets the Z dimension as a percentage of the

graph’s dimensions. This is unused by Bentley
HAMMER V8i.

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

11-834 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

Pattern The Hatch Brush Editor opens, see Hatch Brush

Editor Dialog Box.

Minimum pixels Lets you set the number of pixels that you have to
click and drag before the zoom feature is
activated.

Direction Lets you zoom in the vertical or horizontal planes

only, as well as both planes.

Mouse Button Lets you set the mouse button that you use to click
and drag when activating the zoom feature.

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.

Titles Tab
The Titles tab lets you define titles to use for your graph. It includes the following
controls and tabs:

Bentley HAMMER V8i Edition User’s Guide 11-835

Chart Options Dialog Box

Title Lets you set the location of the titles you want to
use. The Titles sub tabs apply to the Title that is
currently selected in the Title drop-down list.

Style Tab

Use the Style tab to display and create a selected title. Type the text of the title in the
text box on the Style tab. The Style tab contains the following controls:

Visible Lets you display the selected title.

Adjust Frame Lets you wrap the frame behind the selected title
to the size of the title text.
Each title can have a frame behind it (see Format
Tab). By default, this frame is transparent. If you
turn off transparency to see the frame, the frame
can be sized to the width of the graph or set to
snap to the width of the title text.
Select the Adjust Frame check box to set the
width of the frame to the width of the title text;
clear this check box to set the width of the frame
to the width of the graph.

Alignment Lets you set the alignment of the selected title.

Position Tab

Use the Position tab to set the placement of the selected title. The Position tab contains
the following controls:

Custom Lets you set a custom position for the selected

title. Select this check box to set a custom
position.

Left/Top Lets you set the location of the selected title

relative to the left and top of the graph. If you
select the Custom check box, use these settings to
position the selected title.

Format Tab

Use the Format tab to set and format a background shape behind the selected title. The
Format tab contains the following controls:

11-836 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Color Lets you set a color for the fill of the shape you
create behind the selected title. The Color Editor
opens, see Color Editor Dialog Box.

Frame Lets you define the outline of the shape you create
behind the selected title. The Border Editor opens,
see Border Editor Dialog Box.

Pattern Lets you set a pattern for the fill of the shape you
create behind the selected title. The Hatch Brush
Editor opens, see Hatch Brush Editor Dialog Box.

Round Frame Lets you round the corners of the rectangular

shape you create behind the selected title. Select
this check box to round the corners of the shape.

Transparent Lets you set the fill of the shape you create behind
the selected title 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 shape, where 100
is completely transparent and 0 is completely
opaque.

Text Tab

Use the Text tab to format the text used in the selected title. 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).

Fill Lets you set a pattern for the text. The Hatch
Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Bentley HAMMER V8i Edition User’s Guide 11-837

Chart Options 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 trans-
parent and 0 is completely opaque.

Gradient Tab

Note: To use the Gradient tab, clear the Transparent check box in the
Chart > Titles > Format tab.

Use the Gradient tab to create a gradient color background for your axis title. The
Gradient tab contains the following controls:

Format Tab

Visible Sets whether a gradient displays or not. Select this

check box to display a gradient you have set up,
clear this check box to hide the gradient.

Direction Sets the direction of the gradient. Vertical causes

the gradient to display from top to bottom,
Horizontal displays a gradient from right to left,
and Backward/Forward diagonal display gradients
from the left and right bottom corners to the
opposite corner.

Angle Lets you customize the direction of the gradient

beyond the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient.

11-838 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Middle Lets you select a middle color for your gradient.

The Color Editor opens. Select the No Middle
Color check box if you want a two-color gradient.

End Lets you select the final color for your gradient.

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear
this check box to change the brightness of the
background on-screen. This does not affect printed
output.

Transparency Lets you set transparency for your gradient, where

100 is completely transparent and 0 is completely
opaque.

Options Tab

Sigma Lets you use the options controls. Select this

check box to use the controls in the Options tab.

Sigma Focus Lets you set the location on the chart background
of the gradient’s end color.

Sigma Scale Lets you control how much of the gradient’s end
color is used by the gradient background.

Shadow Tab

Use the Shadow tab to create a shadow for the background for the selected title. The
Shadow tab contains the following controls:

Visible Lets you display a shadow. Select this check box

to display the shadow, clear this check box to turn
off the shadow effect.

Size Set the size of the shadow by increasing or

decreasing the numbers for Horizontal and/or
Vertical Size.

Color Lets you set a color for the shadow. You might set
this to gray but can set it to any other color. The
Color Editor opens, see Color Editor Dialog Box.

Bentley HAMMER V8i Edition User’s Guide 11-839

Chart Options Dialog Box

Pattern Lets you set a pattern for the shadow. The Hatch
Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Transparency Lets you set transparency for your shadow, where

100 is completely transparent and 0 is completely
opaque.

Bevels Tab

Note: To use the Gradient tab, clear the Transparent check box in the
Chart > Titles > Format tab.

Use the Bevels tab to create rounded effects for the background for the selected title.
The Bevels tab contains the following controls:

Bevel Outer Lets you set a raised or lowered bevel effect, or no

bevel effect, for the background for the selected
title.

Color Lets you set the color for the bevel effect that you
use; inner and outer bevels can use different color
values.

Bevel Inner Lets you set a raised or lowered bevel effect, or no

bevel effect, for the inside of the background for
the selected title.

Size Lets you set a thickness for the bevel effect that
you use; inner and outer bevels use the same size
value.

Walls Tab
Use the Walls tab to set and format the edges of your graph. The Walls tab contains the
following subtabs:

Left/Right/Back/Bottom Tabs
Use the Left, Right, Back, and Bottom tabs to select the walls that you want to edit.
You might have to turn off the axes lines to see the effects (see Axes Tab on page 11-
828) for the back wall and turn on 3D display to see the effects for the left, right, and
bottom walls (see 3D Tab on page 11-848).

The Left, Right, Back, and Bottom tabs contain the following controls:

11-840 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Color The Color Editor opens, see Color Editor Dialog

Box.

Border The Border Editor opens, see Border Editor

Dialog Box.

Pattern The Hatch Brush Editor opens, see Hatch Brush

Editor Dialog Box.

Gradient Lets you set a color gradient for your walls. The
Gradient Editor opens, see Gradient Editor Dialog
Box.

Visible Lets you display the walls you set up.

Dark 3D Lets you automatically darken the depth

dimension for visual effect. Select a Size 3D larger
than 0 to enable this check box.

Size 3D Lets you increase the size of the wall in the

direction perpendicular to it’s length (the graph
resizes automatically as a result).

Transparent Lets you set transparency for your background,

where 100 is completely transparent and 0 is
completely opaque.

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.

Bentley HAMMER V8i Edition User’s Guide 11-841

Chart Options Dialog Box

Arrows Lets you navigate through a multi-page graph.

Click the single arrows to navigate one page at a
time. Click the double arrows to navigate directly
to the last or first pages of the graph.

Legend Tab
Use the Legend tab to display and format a legend for your graph. The Legend tab
includes the following controls:

Style Tab

Use the Style tab to set up and display a legend for your graph. The Style tab contains
the following controls:

Visible Lets you show or hide the legend for your graph.

Inverted Lets you draw legend items in the reverse

direction. Legend strings are displayed starting at
top for Left and Right Alignment and starting at
left for Top and Bottom Legend orientations.

Check boxes Activates/deactivates check boxes associated with

each series in the Legend. When these boxes are
unchecked in the legend, the associated series are
invisible.

Font Series Color Sets text in the legend to the same color as the
graph element to which it applies.

Legend Style Lets you select what appears in the legend.

Text Style Lets you select how the text in the legend is
aligned and what data it contains.

Vert. Spacing Controls the space between rows in the legend.

Dividing Lines Lets you use and define lines that separate
columns in the legend. The Border Editor opens,
see Border Editor Dialog Box.

Position Tab

Use the Position tab to control the placement of the legend. The Position tab contains
the following controls:

11-842 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

Left/Top Lets you enter a value for custom placement of the

legend.

Symbols Tab

Use the Symbols tab to add to the legend symbols that represent the series in the
graph. The Symbols tab contains the following controls:

Visible Lets you display the series symbol next to the text
in the legend.

Width Lets you resize the symbol that displays in the

legend. You must clear Squared to use this
control.

Width Units Lets you set the units that are used to size the
width of the symbol.

Default border Lets you use the default TeeChart format for the
symbol. If you clear this check box, you can set a
custom border using the Border button.

Border Lets you set a custom border for the symbols. You
must clear Default Border to use this option. The
Border Editor opens, see Border Editor Dialog
Box.

Position Lets you put the symbol to the left or right of its
text.

Bentley HAMMER V8i Edition User’s Guide 11-843

Chart Options Dialog Box

Continuous Lets you attach or detach legend symbols. If you

select this check box, the color rectangles of the
different items are attached to each other with no
vertical spacing. If you clear this check box, the
legend symbols are drawn as separate rectangles.

Squared Lets you override the width of the symbol, so you

can make the symbol square shaped.

Format Tab

Use the Format tab to set and format the box that contains the legend. The Format tab
contains the following controls:

Color Lets you set a color for the fill of the legend’s box.
The Color Editor opens, see Color Editor Dialog
Box.

Frame Lets you define the outline of the legend’s box.

The Border Editor opens, see Border Editor
Dialog Box.

Pattern Lets you set a pattern for the fill of the legend’s
box. The Hatch Brush Editor opens, see Hatch
Brush Editor Dialog Box.

Round Frame Lets you round the corners of the legend’s box.
Select this check box to round the corners of the
shape.

Transparent Lets you set the fill of the legend’s box as

transparent. If the shape is completely transparent,
you cannot see it, so clear this check box if you
cannot see a shape that you expect to see.

Transparency Lets you set transparency for the legend’s box,

where 100 is completely transparent and 0 is
completely opaque.

Text Tab

11-844 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Use the Text tab to format the text used in the legend. The Text tab contains the
following controls:

Font Lets you set the font properties for the text. This
opens the Windows Font dialog box.

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

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 trans-
parent 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.

Bentley HAMMER V8i Edition User’s Guide 11-845

Chart Options Dialog Box

Direction Sets the direction of the gradient. Vertical causes

the gradient to display from top to bottom,
Horizontal displays a gradient from right to left,
and Backward/Forward diagonal display gradients
from the left and right bottom corners to the
opposite corner.

Angle Lets you customize the direction of the gradient

beyond the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient.

Middle Lets you select a middle color for your gradient.

The Color Editor opens. Select the No Middle
Color check box if you want a two-color gradient.

End Lets you select the final color for your gradient.

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear
this check box to change the brightness of the
background on-screen. This does not affect printed
output.

Transparency Lets you set transparency for your gradient, where

100 is completely transparent and 0 is completely
opaque.

Options Tab

Sigma Lets you use the options controls. Select this

check box to use the controls in the Options tab.

Sigma Focus Lets you set the location on the chart background
of the gradient’s end color.

Sigma Scale Lets you control how much of the gradient’s end
color is used by the gradient background.

Shadow Tab

11-846 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Use the Shadow tab to create a shadow for the legend. The Shadow tab contains the
following controls:

Visible Lets you display a shadow. Select this check box

to display the shadow, clear this check box to turn
off the shadow effect.

Size Set the size of the shadow by increasing or

decreasing the numbers for Horizontal and/or
Vertical Size.

Color Lets you set a color for the shadow. You might set
this to gray but can set it to any other color. The
Color Editor opens, see Color Editor Dialog Box.

Pattern Lets you set a pattern for the shadow. The Hatch
Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Transparency Lets you set transparency for your shadow, where

100 is completely transparent and 0 is completely
opaque.

Bevels Tab

Use the Bevels tab to create a rounded effects for the legend. The Bevels tab contains
the following controls:

Bevel Outer Lets you set a raised or lowered bevel effect, or no

bevel effect, for the background for the selected
title.

Color Lets you set the color for the bevel effect that you
use; inner and outer bevels can use different color
values.

Bevel Inner Lets you set a raised or lowered bevel effect, or no

bevel effect, for the inside of the background for
the selected title.

Size Lets you set a thickness for the bevel effect that
you use; inner and outer bevels use the same size
value.

Bentley HAMMER V8i Edition User’s Guide 11-847

Chart Options Dialog Box

3D Tab
Use the 3D tab to add a three-dimensional effect to your graph. The 3D tab contains
the following controls:

3 Dimensions Lets you display the chart in three dimensions.

Select this check box to turn on three-dimensional
display.

3D % Lets you increase or decrease the three-

dimensional effect. Set a larger percentage for
more three-dimensional effect, or a smaller
percentage for less effect.

Orthogonal Lets you fix the graph in the two-dimensional

work plane or, if you clear this check box, lets you
use the Rotation and Elevation controls to rotate
the graph freely.

Zoom Text Lets you magnify and reduce the size of the text in
a graph when using the zoom tool. clear this check
box if you want text, such as labels, to remain the
same size when you use the zoom tool.

Quality Lets you select how the graph displays as you

manipulate and zoom on it.

Clip Points Trims the view of a series to the walls of your

graph’s boundaries, to enhance the three-
dimensional effect. Turn this on to trim the graph.
You only see this effect when the graph is in
certain rotated positions.

Zoom Lets you magnify and reduce the display of the

graph in the Graph dialog box.

Rotation Lets you rotate the graph. You must clear

Orthogonal to use this control.

Elevation Lets you rotate the graph. You must clear

Orthogonal to use this control.

Horiz. Offset Lets you adjust the left-right position of the graph.

Vert. Offset Lets you adjust the up-down position of the graph.

11-848 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Perspective Lets you rotate the graph. You must clear

Orthogonal to use this control.

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
• Point Tab
• General Tab
• Data Source Tab
• Marks Tab

Format Tab
Use the Format tab to set up how the selected series appears. The Format tab contains
the following controls:

Border Lets you format the graph of the selected series.

The Border Editor opens, see Border Editor
Dialog Box.

Color Lets you set a color for the graph of the selected
series. The Color Editor opens, see Color Editor
Dialog Box.

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). The Hatch Brush
Editor opens, see Hatch Brush Editor Dialog Box.

Dark 3D Lets you automatically darken the depth

dimension for visual effect.

Color Each Assigns a different color to each series indicator.

Clickable This is unused by Bentley HAMMER V8i.

Bentley HAMMER V8i Edition User’s Guide 11-849

Chart Options Dialog Box

Color Each line Lets you enable or disable the coloring of

connecting lines in a series. This is unused by
Bentley HAMMER 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 completely transparent and 0 is completely
opaque.

Stairs Lets you display a step effect between points on

your graph.

Inverted Inverts the direction of the stairs effect

Outline Displays an outline around the selected series. The

Border Editor opens.

Point Tab
Use the Point tab to set up how the points that make up the selected series appear. The
Point tab contains the following controls:

Visible Lets you display the points used to create your

graph.

3D Lets you display the points in three dimensions.

Dark 3D Lets you automatically darken the depth

dimension for visual effect.

11-850 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Inflate Margins Adjusts the margins of the points to display points

that are close to the edge of the graph. If you clear
this option, points near the edge of the graph
might only partly display.

Pattern Lets you set a pattern for the points in your series.
The Hatch Brush Editor opens, see Hatch Brush
Editor Dialog Box. You must clear Default to use
this option.

Default Lets you select the default format for the points in
your series. This overrides any pattern selection.

Color Each Assigns a different color to each series indicator.

Style Lets you select the shape used to represent the

points in the selected series.

Width/Height Lets you set a size for the points in the selected
series.

Border Lets you set the outline of the shapes that

represent the points in the selected series. The
Border Editor opens, see Border Editor Dialog
Box.

Transparency Lets you set transparency for the points in the

selected series, where 100 is completely
transparent and 0 is completely opaque.

General Tab
Use the General tab to modify basic formatting and relationships with axes for series
in a graph. The General tab contains the following controls:

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 (see Style Tab).

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.

Bentley HAMMER V8i Edition User’s Guide 11-851

Chart Options Dialog Box

Depth Lets you set the depth of the three-dimensional

effect (see 3D Tab).

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 Bentley HAMMER 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 Bentley HAMMER 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 Bentley HAMMER V8i.

• Random—xxxx not sure

• Number of sample values—xxxx not sure
• Default—xxxx not sure
• Apply—xxxx not sure

11-852 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

Clipped Lets you display marks outside the graph border.

clear this check box to let marks display outside
the graph border, or select it to clip the marks to
the graph border.

Multi-line Lets you display marks on more than one line.

Select this check box to enable multi-line marks.

All Series Visible Lets you display marks for all series.

Style Lets you set the content of the marks.

Draw every Sets the interval of the marks that are displayed.
Selecting 2 would display every second mark, and
3 would display every third, etc.

Angle Lets you rotate the marks for the selected series.

Arrow Tab

Use the Arrow tab to display a leader line on the series graph to indicate where the
mark applies. The Arrow tab contains the following controls:

Border Lets you set up the leader line. The Border Editor
opens, see Border Editor Dialog Box.

Pointer Lets you set up the arrow head (if any) used by the
leader line. The Pointer dialog box opens, see
Pointer Dialog Box.

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.

Bentley HAMMER V8i Edition User’s Guide 11-853

Chart Options Dialog Box

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.

Frame Lets you define the outline of the boxes. The

Border Editor opens, see Border Editor Dialog
Box.

Pattern Lets you set a pattern for the fill of the boxes. The
Hatch Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Round Frame Lets you round the corners of the boxes. Select
this check box to round the corners of the shape.

Transparent Lets you set the fill of the boxes as transparent. If

the shape is completely transparent, you cannot
see it, so clear this check box if you cannot see a
shape that you expect to see.

Transparency Lets you set transparency for the boxes, where 100
is completely transparent and 0 is completely
opaque.

Text Tab

Use the Text tab to format the text used in the marks. The Text tab contains the
following controls:

Font Lets you set the font properties for the text. This
opens the Windows Font dialog box.

11-854 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Color Lets you select the color for the text. Double-click
the colored square between Font and Fill to open
the Color Editor dialog box (see Color Editor
Dialog Box).

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 trans-
parent and 0 is completely opaque.

Gradient Tab

Use the Gradient tab to create a gradient color background for your marks. The
Gradient tab contains the following subtabs and controls:

Format Tab

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.

Bentley HAMMER V8i Edition User’s Guide 11-855

Chart Options Dialog Box

Angle Lets you customize the direction of the gradient

beyond the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient.

Middle Lets you select a middle color for your gradient.

The Color Editor opens. Select the No Middle
Color check box if you want a two-color gradient.

End Lets you select the final color for your gradient.

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear
this check box to change the brightness of the
background on-screen. This does not affect printed
output.

Transparency Lets you set transparency for your gradient, where

100 is completely transparent and 0 is completely
opaque.

Options Tab

Sigma Lets you use the options controls. Select this

check box to use the controls in the Options tab.

Sigma Focus Lets you set the location on the chart background
of the gradient’s end color.

Sigma Scale Lets you control how much of the gradient’s end
color is used by the gradient background.

Shadow Tab

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

Visible Lets you display a shadow. Select this check box

to display the shadow, clear this check box to turn
off the shadow effect.

Size Set the size of the shadow by increasing or

decreasing the numbers for Horizontal and/or
Vertical Size.

11-856 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Color Lets you set a color for the shadow. You might set
this to gray but can set it to any other color. The
Color Editor opens, see Color Editor Dialog Box.

Pattern Lets you set a pattern for the shadow. The Hatch
Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Transparency Lets you set transparency for your shadow, where

100 is completely transparent and 0 is completely
opaque.

Bevels Tab

Use the Bevels tab to create a rounded effects for your marks. The Bevels tab contains
the following controls:

Bevel Outer Lets you set a raised or lowered bevel effect, or no

bevel effect, for the background for the selected
title.

Color Lets you set the color for the bevel effect that you
use; inner and outer bevels can use different color
values.

Bevel Inner Lets you set a raised or lowered bevel effect, or no

bevel effect, for the inside of the background for
the selected title.

Size Lets you set a thickness for the bevel effect that
you use; inner and outer bevels use the same size
value.

Chart Options Dialog Box - Tools Tab

Use the Tools tab to add special figures in order to highlight particular facts on a given
chart. For more information, see Chart Tools Gallery Dialog Box on page 11-868. 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.

Bentley HAMMER V8i Edition User’s Guide 11-857

Chart Options Dialog Box

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 Bentley HAMMER V8i.

Note: Each tool has its own parameters, see Chart Tools Gallery Dialog
Box.

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:

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.

11-858 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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:

Include Series Data This is unused by Bentley HAMMER 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.

Bentley HAMMER V8i Edition User’s Guide 11-859

Chart Options Dialog Box

Text separator Lets you specify how you want rows of data
separated. This is supported by the Save function
and only by the Copy function if you first saved
using the text separator you have selected, before
you copy.

Chart Options Dialog Box - Print Tab

Use the Print tab to preview and print your graph. The Print tab contains the following
controls and subtabs:

Printer Lets you select the printer you want to use.

Setup Lets you configure the printer you want to use. For
example, if the selected printer supports printing
on both sides of a page, you might want to turn on
this feature.

Print Prints the displayed graph to the selected printer.

Page Tab

Orientation Lets you set up the horizontal and vertical axes of

the graph. Many graphs print better in Landscape
orientation because of their width:height ratio.

Zoom Lets you magnify the graph as displayed in the

print preview window. Use the scrollbars to
inspect the graph if it doesn’t fit within the
preview window after you zoom. Changing the
zoom does not affect the size of the printed output.

Margins Lets you set up top, bottom, left, and right margins
that are used when you print.

Margin Units Lets you set the units used by the Margins
controls: percent or hundredths of an inch.

Format Tab

Print Background When checked, prints the background of the

graph.

11-860 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

Ending Lets you set the ending style of the border.

Dash Lets you select the dash style, if you have a

selection other than Solid set for the border style.

Width Lets you set the width of the border.

Style Lets you set the style for the border. Solid is an
uninterrupted line.

Transparency Lets you set transparency for your border, where

100 is completely transparent and 0 is completely
opaque.

Bentley HAMMER V8i Edition User’s Guide 11-861

Chart Options Dialog Box

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:

Format Tab

Visible Sets whether a gradient displays or not. Select this

check box to display a gradient you have set up,
clear this check box to hide the gradient.

Direction Sets the direction of the gradient. Vertical causes

the gradient to display from top to bottom,
Horizontal displays a gradient from right to left,
and Backward/Forward diagonal display gradients
from the left and right bottom corners to the
opposite corner.

Angle Lets you customize the direction of the gradient

beyond the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient.

Middle Lets you select a middle color for your gradient.

The Color Editor opens. Select the No Middle
Color check box if you want a two-color gradient.

End Lets you select the final color for your gradient.

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear
this check box to change the brightness of the
background on-screen. This does not affect printed
output.

Transparency Lets you set transparency for your gradient, where

100 is completely transparent and 0 is completely
opaque.

Options Tab

Sigma Lets you use the options controls. Select this

check box to use the controls in the Options tab.

11-862 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Sigma Focus Lets you set the location on the chart background
of the gradient’s end color.

Sigma Scale Lets you control how much of the gradient’s end
color is used by the gradient background.

To access the Gradient Editor dialog box, click Chart Settings in the Graph dialog box,
then click the Tools tab. Select the Axis tab and Color Band tool, then click the
Gradient button.

Color Editor Dialog Box

Use the Color Editor dialog box to select a color. Click the basic color you want to use
then click OK to apply the selection. The Color Editor dialog box contains the
following controls:

Transparency Lets you set transparency for your color, where

100 is completely transparent and 0 is completely
opaque.

Custom Lets you define a custom color to use. The Color

dialog box opens, see Color Dialog Box.

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.

Bentley HAMMER V8i Edition User’s Guide 11-863

Chart Options Dialog Box

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

Use the Hatch Brush Editor dialog box to set a fill. The Hatch Brush Editor dialog box
contains the following controls and tabs:

Visible Displays or hides the pattern. Select this check

box to display the selected pattern.

• Hatch Brush Editor Dialog Box - Solid Tab

• Hatch Brush Editor Dialog Box - Hatch Tab
• Hatch Brush Editor Dialog Box - Gradient Tab
• Hatch Brush Editor Dialog Box - Image Tab

Hatch Brush Editor Dialog Box - Solid Tab

Use the Solid tab to set a solid color as the fill. The Solid tab contains the following
controls:

Transparency Lets you set transparency for your color, where

100 is completely transparent and 0 is completely
opaque.

Custom Lets you define a custom color to use. The Color

dialog box opens, see Color Dialog Box.

OK/Cancel Click OK to use the selection. Click Cancel to

close the dialog box without making a selection.

11-864 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Hatch Brush Editor Dialog Box - Hatch Tab

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/ Select the color you want to use for the

Foreground background and foreground of the pattern. This
opens the Color Editor, see Color Editor Dialog
Box.

% Lets you set transparency for your color, where

100 is completely transparent and 0 is completely
opaque.

Hatch Brush Editor Dialog Box - Gradient Tab

Use the Gradient tab to set a blend of two or three colors as the fill. Click OK to apply
the selection. The Gradient tab contains the following controls:

Format Tab

Visible Sets whether a gradient displays or not. Select this

check box to display a gradient you have set up,
clear this check box to hide the gradient.

Direction Sets the direction of the gradient. Vertical causes

the gradient to display from top to bottom,
Horizontal displays a gradient from right to left,
and Backward/Forward diagonal display gradients
from the left and right bottom corners to the
opposite corner.

Angle Lets you customize the direction of the gradient

beyond the Direction selections.

Colors Tab

Start Lets you set the starting color for your gradient.

Middle Lets you select a middle color for your gradient.

The Color Editor opens. Select the No Middle
Color check box if you want a two-color gradient.

Bentley HAMMER V8i Edition User’s Guide 11-865

Chart Options Dialog Box

End Lets you select the final color for your gradient.

Gamma Correction Lets you control the brightness with which the
background displays to your screen; select or clear
this check box to change the brightness of the
background on-screen. This does not affect printed
output.

Transparency Lets you set transparency for your gradient, where

100 is completely transparent and 0 is completely
opaque.

Options Tab

Sigma Lets you use the options controls. Select this

check box to use the controls in the Options tab.

Sigma Focus Lets you set the location on the chart background
of the gradient’s end color.

Sigma Scale Lets you control how much of the gradient’s end
color is used by the gradient background.

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

11-866 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Pointer Dialog Box

Use the Pointer dialog box to set up a pointers for use with leader lines. The Pointer
dialog box contains the following controls:

Visible Sets whether a pointer displays or not.

3D Lets you display the pointer in three dimensions.

Dark 3D Lets you automatically darken the depth

dimension for visual effect.

Inflate Margins Adjusts the margins of the pointers to display

pointers that are close to the edge of the graph. If
you clear this option, pointers near the edge of the
graph might only partly display.

Pattern Lets you set a pattern for the pointers. The Hatch
Brush Editor opens, see Hatch Brush Editor
Dialog Box. You must clear Default to use this
option.

Default Lets you select the default format for the pointers.
This overrides any pattern selection.

Color Each Assigns a different color to each pointer.

Style Lets you select the shape used to represent the

pointers.

Width/Height Lets you set a size for the pointers.

Border Lets you set the outline of the shapes that

represent the pointers. The Border Editor opens,
see Border Editor Dialog Box.

Transparency Lets you set transparency for the pointers, where

100 is completely transparent and 0 is completely
opaque.

To access the Pointer dialog box, click Chart Settings in the Graph dialog box, then
click Series > Marks > Arrow.

Bentley HAMMER V8i Edition User’s Guide 11-867

Chart Options Dialog Box

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 informa-
tion, see Chart Options Dialog Box - Tools Tab on page 11-857.

Click one of the following links to learn more about the Chart Tools Gallery dialog
box:

• Chart Tools Gallery Dialog Box - Series Tab

• Chart Tools Gallery Dialog Box - Axis Tab
• Chart Tools Gallery Dialog Box - Other Tab

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.

11-868 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Pen Lets you define the cursor tool. The Border Editor
opens, see Border Editor Dialog Box.

Drag Marks

Lets you drag series marks. To use this tool, you must display the marks for a selected
series, see Marks Tab. After you have added the Drag Marks tool to your graph, you
can modify the following settings:

Series Lets you select the series to which you want to

apply the tool.

Reset Positions Moves any marks you have dragged back to their
original position.

Drag Point

Lets you drag a series point. After you have added the Drag Point tool to your graph,
you can modify the following settings:

Series Lets you select the series to which you want to

apply the tool.

Style Lets you constrain the movement of the series

point to one axis or both (no constraint).

Mouse Button Lets you select the mouse button you click to drag.

Cursor Lets you select the appearance of the cursor when

using the tool.

Draw Line

Lets you draw a line on the graph by dragging. After you have added the Draw Line
tool to your graph, you can modify the following settings:

Series Lets you select the series to which you want to

apply the tool.

Pen Lets you define the line. The Border Editor opens,
see Border Editor Dialog Box.

Button Lets you select the mouse button you click to drag.

Bentley HAMMER V8i Edition User’s Guide 11-869

Chart Options Dialog Box

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.

Gantt Drag

Lets you move and resize Gantt bars by dragging. This is unused by Bentley
HAMMER 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:

Series Lets you select the series to which you want to

apply the tool.

Browse Lets you navigate to and select the image you

want to use. Browse is unavailable when there is a
selected image. To select a new image, first clear
the existing one.

Clear Lets you remove a selected image. Clear is

unavailable when there is no selected image.

Mode Lets you set up the image you select.

• Normal—Puts the background image in the
top-left corner of the graph.
• Stretch—Resizes the background image to fill
the entire background of the graph. The image
you select conforms to the series to which you
apply it.
• Center—Puts the background image in the
horizontal and vertical center of the graph.
• Tile—Repeats the background image as
many times as needed to fill the entire back-
ground of the graph.

11-870 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Mark Tips

Displays data in tooltips when you move the cursor over the graph. After you have
added the Mark Tips tool to your graph, you can modify the following settings:

Series Lets you select the series to which you want to

apply the tool

Style Lets you select what data the tooltips display.

Action Sets when the tooltips display. Select Click if you

want the tooltips to display when you click, or
select Move if you want the tooltips to display
when you move the mouse.

Delay Lets you delay how quickly the tooltip displays.

Nearest Point

Lets you define and display an indicator when you are near a point in the selected
series. After you have added the Nearest Point tool to your graph, you can modify the
following settings:

Series Lets you select the series to which you want to

apply the tool.

Fill Lets you set the fill for the nearest-point indicator.
The Hatch Brush Editor opens, see Hatch Brush
Editor Dialog Box.

Border Lets you set the outline of the nearest-point

indicator. The Border Editor opens, see Border
Editor Dialog Box.

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 Bentley HAMMER V8i.

Bentley HAMMER V8i Edition User’s Guide 11-871

Chart Options Dialog Box

Series Animation

Animates series points. After you have added the Series Animation tool to your graph,
you can modify the following settings:xxxx seems broken.

Series Lets you select the series to which you want to

apply the tool.

Steps Lets you select the steps used in the animation. Set
this control towards 100 for smoother animation
and away from 100 for quicker, but less smooth
animation.

Start at min. value Lets you start the animation at the series’
minimum value. clear this check box to set your
own start value.

Start value Sets the value at which the animation starts. To use
this control, you must clear Start at min. value.

Execute! Starts the animation.

Chart Tools Gallery Dialog Box - Axis Tab

Use the Axis tab to add tools related to the axes in your chart. The Axis tab contains
the following tools:

Axis Arrows

Lets you add arrows to the axes. The arrows permit you to scroll along the axes. After
you have added the Axis Arrows tool to your graph, you can modify the following
settings:

Axis Select the axis to which you want to add arrows.

Border Lets you set the outline of the arrows. The Border
Editor opens, see Border Editor Dialog Box.

Fill Lets you set the fill for the arrows. The Hatch
Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Length Lets you set the length of the arrows.

Inverted Scroll Lets you change the direction in which the arrows
let you scroll.

11-872 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Scroll Changes the magnitude of the scroll. Set a smaller

percentage to reduce the amount of scroll caused
by one click of an axis arrow, or set a larger
percentage to increase the amount of scroll caused
by a click.

Position Lets you set an axis arrow at the start, end, or both
positions of the axis.

Color Band

Lets you apply a color band to your graph for a range of values you select from an
axis. After you have added the Color Band tool to your graph, you can modify the
following settings:

Axis Select the axis that you want to use to define the
range for the color band.

Border Lets you set the outline of the color band. The
Border Editor opens, see Border Editor Dialog
Box.

Pattern Lets you set the fill of the color band. The Hatch
Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Gradient Lets you set a gradient for the color band. A

gradient overrides any solid color fill you might
have set. The Gradient Editor opens, see Gradient
Editor Dialog Box.

Color Lets you set a solid color for the color band. The
Color Editor opens, see Color Editor Dialog Box.

Start Value Sets where the color band begins. Specify a value
on the selected axis.

End Value Sets where the color band ends. Specify a vale on
the selected axis.

Transparency Lets you set transparency for your color, where

100 is completely transparent and 0 is completely
opaque.

Bentley HAMMER V8i Edition User’s Guide 11-873

Chart Options Dialog Box

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.

Color Line

Lets you apply a color line, or plane in three dimensions, at a point you set at a value
on an axis. After you have added the Color Line tool to your graph, you can modify
the following settings:

Axis Select the axis that you want to use to define the
location for the line.

Border Lets you set the outline of the color line. The
Border Editor opens, see Border Editor Dialog
Box.

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), clear
this check box to display the line as a line rather
than a plane.

11-874 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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 Bentley HAMMER 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.

Cursor Lets you set the style of the cursor when you move
it over the annotation.

Position Tab

Auto Lets you select a standard annotation position.

Custom Lets you select a custom position for the

annotation. Select this check box to override the
Auto setting and enable the Left and Top controls.

Left/Top Lets you set a position from the Left and Top
edges of the graph tab for the annotation.

Callout Tab

Border Lets you set up the leader line. The Border Editor
opens, see Border Editor Dialog Box.

Pointer Lets you set up the arrow head (if any) used by the
leader line. The Pointer dialog box opens, see
Pointer Dialog Box.

Position Sets the position of the callout.

Bentley HAMMER V8i Edition User’s Guide 11-875

Chart Options Dialog Box

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.

Frame Lets you define the outline of the boxes. The

Border Editor opens.

Pattern Lets you set a pattern for the fill of the boxes. The
Hatch Brush Editor opens, see Hatch Brush Editor
Dialog Box.

Round Frame Lets you round the corners of the boxes. Select
this check box to round the corners of the shape.

Transparent Lets you set the fill of the boxes as transparent. If

the shape is completely transparent, you cannot
see it, so clear this check box if you cannot see a
shape that you expect to see

Transparency Lets you set transparency for the boxes, where 100
is completely transparent and 0 is completely
opaque.

Text Tab

Font Lets you set the font properties for text. This
opens the Windows Font dialog box.

Color Lets you select the color for the text font. Double-
click the colored square between Font and Fill to
open the Color Editor dialog box.

Fill Lets you set a pattern for the text font. The Hatch
Brush Editor opens.

11-876 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Shadow Lets you set a shadow for the text.

• Visible—Lets you display a shadow for the
text. Select this check box to display the
shadow.
• Size—Lets you set the location of the shadow.
Use larger numbers to offset the shadow by a
large amount.
• Color—Lets you set a color for the shadow.
You might set this to gray but can set it to any
other color. The Color Editor opens.
• Pattern—Lets you set a pattern for the
shadow. The Hatch Brush Editor opens.
• Transparency—Lets you set transparency for
your shadow, where 100 is completely trans-
parent and 0 is completely opaque.

Gradient Tab

Format Format—Lets you set up the gradient’s

properties.
• Visible—Sets whether a gradient displays or
not. Select this check box to display a gradient
you have set up, clear this check box to hide
the gradient.
• Direction—Sets the direction of the gradient.
Vertical causes the gradient to display from
top to bottom, Horizontal displays a gradient
from right to left, and Backward/Forward diag-
onal 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.

Bentley HAMMER V8i Edition User’s Guide 11-877

Chart Options Dialog Box

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.
• 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 trans-
parent and 0 is completely opaque.

Options Lets you control the affect of the start and end
colors on the gradient, the middle color is not
used.
• Sigma—Lets you use the options controls.
Select this check box to use the controls in the
Options tab.
• Sigma Focus—Lets you set the location on
the chart background of the gradient’s end
color.
• Sigma Scale—Lets you control how much of
the gradient’s end color is used by the
gradient background.

Shadow Tab

Visible Lets you display a shadow. Select this check box

to display the shadow, clear this check box to turn
off the shadow effect.

Size Set the size of the shadow by increasing or

decreasing the numbers for Horizontal and/or
Vertical Size.

11-878 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Color Lets you set a color for the shadow. You might set
this to gray but can set it to any other color. The
Color Editor opens.

Pattern Lets you set a pattern for the shadow. The Hatch
Brush Editor opens.

Transparency Lets you set transparency for your shadow, where

100 is completely transparent and 0 is completely
opaque.

Bevels Tab

Bevel Outer Lets you set a raised or lowered bevel effect, or no

bevel effect, for the outside of the legend.

Color Lets you set the color for the bevel effect that you
use; inner and outer bevels can use different color
values.

Bevel Inner Lets you set a raised or lowered bevel effect, or no

bevel effect, for the inside of the legend.

Size Lets you set a thickness for the bevel effect that
you use; inner and outer bevels use the same size
value.

Page Number

Lets you add a page number annotation. For more information, see Annotation.

Rotate

Lets you rotate the chart by dragging. After you have added the Rotate tool to your
graph, you can modify the following settings:

Inverted Reverses the direction of the rotation with respect

to the direction you move the mouse.

Style Lets you rotate horizontally, vertically, or both.

Rotation is horizontal rotation about a vertical
axis, whereas elevation is vertical rotation about a
horizontal axis.

Outline Lets you set the outline. The Border Editor opens,
see Border Editor Dialog Box.

Bentley HAMMER V8i Edition User’s Guide 11-879

Chart Options Dialog Box

TeeChart Gallery Dialog Box

Use the TeeChart Gallery dialog box to change the appearance of a series.

Series
The available series chart designs include:

• Standard
• Stats
• Financial
• Extended
• 3D
• Other
• View 3D—Lets you view the chart design in two or three dimensions. Select this
check box to view the charts in 3D, clear it to view them in 2D.
• Smooth—Smooths the display of the charts. Select this check box to smooth the
display, clear it to turn off smoothing.

11-880 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Functions
The available function chart designs include:

• Standard
• Financial
• Stats
• Extended
• View 3D—Lets you view the chart design in two or three dimensions. Select this
check box to view the charts in 3D, clear it to view them in 2D.
• Smooth—Smooths the display of the charts. Select this check box to smooth the
display, clear it to turn off smoothing.

Customizing a Graph

To customize a graph

1. If you do not have your own model, open one of the example files.
2. Create a graph.
a. Click Compute.
b. Close the Calculation Summary.
c. Save your model.

Bentley HAMMER V8i Edition User’s Guide 11-881

Chart Options Dialog Box

d. Right click an element. To add more than one element press <Shift+click>,
then right-click and select Graph.

e. Click Add to Graph Manager to save to the Graph manager.

11-882 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

3. Move the legend.

a. Click Chart Settings, to open the Chart Options dialog box.
b. Click the Chart icon, Legend tab, and Position subtab.
c. Click Right in the Position area to set the legend to the right side of the graph.
You can use other controls on this subtab to move the legend.

4. Change the line colors and weights.

a. Click Chart Settings to open the Chart Options dialog box.
b. In the Chart > Series tab click the series to edit, then select and highlight it.
You can select more than one series by pressing <Ctrl> or <Shift> + click.

c. Click Series and select the Format tab.

d. Click Color to open the Color Editor and select a new color.

Bentley HAMMER V8i Edition User’s Guide 11-883

Chart Options Dialog Box

e. Click OK after you click the color you want to use. The series that are
changed are those that you highlighted in the Chart > Series tab.
f. Click Outline to open the Border Editor to change the thickness of a line.
g. Select Visible.
h. Change the Width.
i. Make sure the Transparency is set to 0 if you want the line to appear opaque.
j. Click OK after you define the line width and attributes. The series that are
changed are those that you highlighted in the Chart > Series tab.
5. Change the interval between labels, grid, and ticks.
a. Click Chart > Axes > Scales > Change to change the interval between labels
on the axes.

b. Select the Axis you want to change from the list of axes in the Axes area.

c. In the Increment dialog box, type the new value and click OK. This also
changes the distance between major and minor ticks.

d. If needed, change the axis you have selected for changes.

e. Click Chart > Axes > Minor and change the Count to change the interval
between minor ticks on the axes.

11-884 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

6. You can show and hide a grid associated with the major ticks.
a. Click Chart > Axes > Ticks.
b. Select the axis to change the grid, then click Grid.
c. In the Border Editor dialog box, select or clear Visible to show or hide the
grid.

7. You can show and hide a grid associated with the minor ticks.
a. Click Chart > Axes > Minor.
b. Select the axis to change the grid, then click Grid.
c. In the Border Editor dialog box, select or clear Visible to show or hide the
grid.

8. You can set the minimum and maximum range for an axis.
a. Click Chart > Axes > Scales.
b. Select the axis to change the grid, then click Grid.
c. Use the Minimum tab to change the minimum value for an axis. Clear the
Auto check box.
d. Click Change.
e. Set the minimum value for the axis.
f. Use the Maximum tab to change the maximum value for an axis. Clear the
Auto check box.
g. Click Change.
h. Set the maximum value for the axis.

9. Change the background colors.

a. Click Chart > Panel > and select Background.
b. Use the Color and Pattern buttons to set a background color and/or pattern
for the graph.

10. Change the number of decimal places used in axis labels.

a. Click Chart > Axes > Labels > Format.
b. Select the axis you want to change.
c. Change the number of decimal places by making a selection from the Values
Format menu.

Bentley HAMMER V8i Edition User’s Guide 11-885

Chart Options Dialog Box

11. Change the fonts used by the axes and titles.

a. Click Chart > Axes > Labels > Text.
b. Select the axis you want to change.
c. Click Font to open the Font dialog box and change the format of the fonts
used by the axis labels.
d. Click OK.
12. Add a text box to the graph.
a. Click Tools > Add > Other > Annotation.
b. In the Text pane, type the text you want in your annotation.

Note: There are some limitations to user modifications to the graphs in

Bentley HAMMER V8i. For example, changes to the format of the
axis ticks (the values shown on the axis) are overridden and use
the proper formatter. You can change the format via the Tools-
>Options, Units tab or by right-clicking the axis in question and
click on the <Formatter> Properties... menu item. This will open
the Set Field Options Dialog Box. In this dialog you can change
the unit, display precision and format.

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.

11-886 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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

Bentley HAMMER V8i Edition User’s Guide 11-887

Chart Options Dialog Box

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:
– Start Date Time - Specify the date and time the field data was collected. It is
important to ensure that your data shows correctly on the plot compared to the
simulated data. For example, if the calculation Base Date and Start Time
differ from the field data, they will not overlay properly on any graphs of the
corresponding data.
– Element - Choose the element that represents the field data measurement
location. Click the ellipsis button to select the element from the drawing.
– Data Storage Unit - The storage unit doesn’t generally need to be changed,
however it becomes a consideration when the user wants to import/export
time-series data using ModelBuilder. ModelBuilder sets the value using the
underlying (unitless) time-series data field, so (unlike most fields), there is no
conversion of values to storage units when working directly with the field.
To address this issue, you can specify the storage unit associated with the time
series. Note that if the user changes the storage unit, existing values will be
interpreted differently. The user can retain their values by copying them from
the table, changing the unit, and pasting the values back in.
– Time From Start - Specify an offset of the start time and date for an EPS
scenario.
– Attribute Value - Enter the value for the specified attribute at the specified
Time from Start.

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.

11-888 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

Bentley HAMMER V8i Edition User’s Guide 11-889

Calculation Summary

Calculation Summary
The calculation summary gathers useful information related to the state of the calcula-
tion (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:

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

The tabs below the time step table contain the following information:

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

11-890 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

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.

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

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.

Bentley HAMMER V8i Edition User’s Guide 11-891

Transient Calculation Summary

The Scenarios pane lists all of the available scenarios. Check the box next to a
scenario to display the data for that scenario in the graph. The Expand All button
opens all of the folders so that all scenarios are visible; the Collapse button closes the
folders.

The Fields pane lists all of the available output fields. Check the box next to a field to
display the data for that field type in the graph. The Expand All button opens all of the
folders so that all fields are visible; the Collapse button closes the folders.

Transient Calculation Summary

The Transient Calculation Summary opens automatically after you perform a transient
calculation. It provides a summary of the calculations performed on the model. You
can also access this report by clicking Analysis > Transient Calculation Summary.

Click the tabs in the summary dialog box to see the various types of results:

• Summary Tab
• Initial Conditions Tab
• Extreme Pressure and Heads Tab

11-892 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Summary Tab

This tab provides a summary of some of the important details about the calculation
options, network elements, and global settings used in the calculation. The following
fields are included in this tab:

• Time Step: The length of a single time step.

• Number of Time Steps: The number of time steps in the simulation.
• Total Simulated Time: The total length of time in the simulation.
• Number of Nodes: The number of node elements in the network.
• Number of Pipes: The number of pipe elements in the network.
• Specific Gravity: The specific gravity of the liquid used in the simulation.
• Wave Speed (Global): Speed for the liquid being conveyed, the pipe material
selected and its dimension ratio (DR), bedding, and other factors.
• Vapor Pressure: Pressure below which a liquid changes phase and become a gas
(steam for water), at a given temperature and elevation.
• Number of Report Paths: The number of profiles that have been been marked as
report paths.

Initial Conditions Tab

This tab displays a table containing the initial conditions for each report path in the
simulation. The table consists of the following columns:

• Label: The label of the associated report path.

• Start Node: The beginning node for the associated report path.
• Head (Initial at Start Node, Transient): The initial head at the start node for the
associated path.
• Stop Node: The end node for the associated report path.
• Head (Initial at Stop Node, Transient): The initial head at the stop node for the
associated path.

Extreme Pressure and Heads Tab

This tab provides the following information as a sorted table in which each line is a
different point simulated in the HAMMER model:

• End Point: The node element that is one of the boundaries for a report path. Each
report path has two end points.

Bentley HAMMER V8i Edition User’s Guide 11-893

RResults Table Dialog Box

• Upsurge Ratio: The maximum pressure over the steady state pressure.
• Max. Pressure: Maximum pressure calculated for the associated end point.
• Min. Pressure: Minimum pressure calculated for the associated end point.
• Max. Head: Maximum head calculated for the associated end point.
• Min. Head: Minimum head calculated for the associated end point.

RResults 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

Search specified terms in the document.

Opens a previously saved Preview Document File

Open (.prnx).

11-894 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Saves the current prview as a Preview Document

Save
File

Opens a Print dialog, allowing you to choose the

Print printer, pages to be printed, and number of copies.

Prints the document using the default printer.

Quick Print

Opens the Page Seuip dialog, allowing you to

Page Setup specify the page setup settings, including page
size, orientation, and margins.

Opens a submenu that allows you to set the

Scale document scale.

Clicking this button toggles the Hand tool, which

Hand Tool allows you to move the page around.

Clicking this button toggles the Magnifier tool,

Magnifier which allows you to zoom the document view.

Zooms the page out.

Zoom Out

Zoom Displays the current zoom; also allows you choose

the current zoom level.

Zooms the page in.

Zoom In

Sets the view to the first page of the document.

First Page

Sets the view to the previous page of the

Previous Page
document.

Sets the view to the next page of the document.

Next Page

Sets the view to the last page of the document.

Last Page

Opens a submenu that allows you to define the

Multiple Pages number of pages that are viewed at once.

Opens a submenu that allows you to choose the

Color background color of the document.

Bentley HAMMER V8i Edition User’s Guide 11-895

Print Preview Window

Opens the Watermark dialog, allowing you to

Watermark define the watermark settings.

Opens the Export dialog, which allows you to

Export define the export settings and export the document
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)

Opens the Export dialog, which allows you to

Send via Email define the 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.

11-896 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

Transient Thematic Viewer

The Transient Thematic Viewer allows you to apply colored highlighting to the pipes
and nodes in the model according to their calculated values for a specified attribute.

Field Name Select the attribute to apply the thematic

coloration.

Selection Set Apply an attribute to a previously defined

selection set or to All Elements, which calculates
the thematic coloration based on all elements in
the model.

Calculate Range Clicking this button will populate the Minimum

and Maximum fields with the minimum and
maximum values for the attribute selected in the
Field Name box.

Minimum Lowest value to be included in thematic

coloration.

Maximum Highest value for which thematic coloration will

be generated.

Steps Number of even increments that the specified

value range will be divided by.

Use Gradient When this box is checked, variations between two

colors will be displayed as a gradient rather than a
discrete seperation.

Bentley HAMMER V8i Edition User’s Guide 11-897

Print Preparation

Color Maps Thematic coloration is based on attribute ranges.

Use the Initialize button to create five evenly
spaced ranges and associated colors. Click the
New button to add a new row to the table. CLick
the Delete button to remove the currently selected
row from the table.

• Initialize—This button, located to the right of

the Contour section, will initialize the Minimum,
Maximum, Increment, and Index Increment
values based on the actual values observed
for the elements in the selection set.

Tip: Initialization can be

accomplished by clicking the
Initialize button to automatically
generate values for the
minimum, maximum,
increment, and index increment
to create an evenly spaced
thematic set.

• Ramp—Automatically generate a gradient

range between two colors that you specify.
Pick the color for the first and last values in the
list and the program will select colors for the
other values.
• Invert—Reverses the order of the colors
according to range.
• Above Range Color—The color that will be
applied to elements whose value falls above
the specified maximum value.

Print Preparation
Detailed help for the Print Preparation feature can be found in the PrintPrepara-
tion.chm found in the Bentley/HAMMER folder.

Also note the following considerations

11-898 Bentley HAMMER V8i Edition User’s Guide

 Presenting Your Results

• For Admins: To set up a template, create the Legend rectangle by placing a View-
port 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.

Bentley HAMMER V8i Edition User’s Guide 11-899

Print Preparation

11-900 Bentley HAMMER V8i Edition User’s Guide

 Importing and
Exporting Data 12
Moving Data and Images between Model(s) and other Files

Importing a Bentley HAMMER Database

Exporting a HAMMER v7 Model

Importing and Exporting EPANET Files

Importing and Exporting Submodel Files

Exporting a DXF File

File Upgrade Wizard

Moving Data and Images between Model(s) and

other Files
Bentley HAMMER 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 else-
where 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

Bentley HAMMER V8i Edition User’s Guide 12-901

Moving Data and Images between Model(s) and other Files

models, first copy out to an intermediate file (e.g. shape file for element data,
spreadsheet for component data). Two overall types of data can be moved to and
from the model.
a. Element data consists of the actual pipes, nodes, etc that make up the model.
ModelBuilder preserves the correct x-y coordinates and properties of the
elements. This is useful for GIS/CAD data.
b. Component data and collections (e.g. pump definitions, patterns, unit
demands) do not have spatial coordinates. These are written to a spreadsheet/
database file and then imported into another model.

3. Import/Export Submodels (see Importing and Exporting Submodel Files): 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 (see 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):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 (see Importing a Bentley HAMMER Database): 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): 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.

12-902 Bentley HAMMER V8i Edition User’s Guide

 Importing and Exporting Data

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 Bentley HAMMER Database

You can import a Bentley HAMMER database file, which will create a new model
using the data in the database.

To import a Bentley HAMMER Database

1. Click the File menu, select Import, then choose Bentley HAMMER Database
from the submenu.
2. Browse to and highlight the wtg.sqlite file to import.
3. Click Open.

Exporting a HAMMER v7 Model

You can export your model as a HAMMER v7 input file, which can then be opened in
HAMMER v7.

To export a HAMMER v7 Input File

1. Click the File menu, select Export, then choose HAMMER 7.

2. Choose a file name and location for the HAMMER input file and click the Save
button.
3. Click OK in the HAMMER Export prompt.

Bentley HAMMER V8i Edition User’s Guide 12-903

Importing and Exporting EPANET Files

Importing and Exporting EPANET Files

You can import 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, alter-
natives, 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 alterna-
tive 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.

12-904 Bentley HAMMER V8i Edition User’s Guide

 Importing and Exporting Data

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 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 that is current is "False".

To import a submodel

1. Click the File menu and select Import…Submodel.

2. In the Select Submodel File to Import dialog box, select the submodel file to be
imported. Click the Open button.

Exporting a Submodel

You can export any portion of a model as a submodel for import into other 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. For more information about input data transfer, see Importing and
Exporting Submodel Files.

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.

Importing a Bentley Water Model

For Bentley Water versions newer than the 2004 , please see the Bentley Water
documentation regarding the Export to Bentley HAMMER command.

To import a Bentley Water 2004 Model

Click the File menu and select Import, then choose the Bentley Water 2004 Model
command.

The Bentley Water Import wizard Opens. .

Bentley HAMMER V8i Edition User’s Guide 12-905

Importing and Exporting Submodel Files

Specify the input data source by selecting a data source type, a data source, and a
geometry data file (*.dat). If you want to update only those elements specified in the
geometry data file, check the associated checkbox. Click Next.

Specify the node, pipe, component, adn elevation table names. When finished, click
Next.

Specify the unit options for the model. When finished, click Finish.

Progress indicator runs. When completed, a Bentley Water Import Summary opens.

The Save button allows you to save the statistics to a Rich Text file (*.rtf). The Copy
button copies the statistics to the Windows clipboard.

Close the Import Summary.

When prompted with “Do you wish to synchronize the drawing now?”, click “Yes” to
synchronize immediately or “No” to synchronize later.

Oracle Login

This dialog appears when you choose an Oracle Spatial Data source.

Enter the oracle User ID, Password, and Data Source, then click OK.

12-906 Bentley HAMMER V8i Edition User’s Guide

 Importing and Exporting Data

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, direc-
tory, 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 associ-
ated 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 Signifi-
cant 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.

Bentley HAMMER V8i Edition User’s Guide 12-907

File Upgrade Wizard

File Upgrade Wizard

The File Upgrade Wizard allows you to allows you to upgrade older Bentley
HAMMER 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>Bentley
Bentley HAMMER 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 Bentley HAMMER 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.

12-908 Bentley HAMMER V8i Edition User’s Guide

 Importing and Exporting Data

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.

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.

Bentley HAMMER V8i Edition User’s Guide 12-909

Export to Shapefile

12-910 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference
13
Pressure Network Hydraulics

Friction and Minor Loss Methods

Engineer’s Reference

Genetic Algorithms Methodology

Energy Cost Theory

Variable Speed Pump Theory

Hydraulic Equivalency Theory

Thiessen Polygon Generation Theory

Method for Modeling Pressure Dependent Demand

References

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 elec-
tronic and mechanical controls.

Network Hydraulics Theory

For modeling purposes, these system elements are organized into the following cate-
gories:

• Pipes—Transport water from one location (or node) to another.

Bentley HAMMER V8i Edition User’s Guide 13-911

Pressure Network Hydraulics

• Junctions/Nodes—Specific points, or nodes, in the system at which an event of

interest is occurring. This includes points where pipes intersect, where there are
major demands on the system such as a large industry, a cluster of houses, or a fire
hydrant, or critical points in the system where pressures are important for analysis
purposes.
• Reservoirs and Tanks—Boundary nodes with a known hydraulic grade that
define the initial hydraulic grades for any computational cycle. They form the
baseline hydraulic constraints used to determine the condition of all other nodes
during system operation. Boundary nodes are elements such as tanks, reservoirs,
and pressure sources.
• Pumps—Represented as nodes. Their purpose is to provide energy to the system
and raise the water pressure.
• Valves—Mechanical devices used to stop or control the flow through a pipe, or to
control the pressure in the pipe upstream or downstream of the valve. They result
in a loss of energy in the system.

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 solu-
tion, there are some governing principles that drive the behavior of the network,
including the Conservation of Mass and Energy Principle, and the Energy Principle.

The two modes of analysis are Steady-State Network Hydraulics and Extended Period
Simulation. This program solves for the distributions of flows and hydraulic grades
using the Gradient Algorithm.

The Energy Principle

The first law of thermodynamics states that for any given system, the change in energy
is equal to the difference between the heat transferred to the system and the work done
by the system on its surroundings during a given time interval.

The energy referred to in this principle represents the total energy of the system minus
the sum of the potential, kinetic, and internal (molecular) forms of energy, such as
electrical and chemical energy. The internal energy changes are commonly disre-
garded in water distribution analysis because of their relatively small magnitude.

13-912 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

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: V2/2g

Where: p = Pressure (N/m2, lb./ft.2)

 = Specific weight (N/m3, lb./ft.3)
z = Elevation (m, ft.)
V = Velocity (m/s, ft./sec.)
g = Gravitational acceleration constant (m/s2, ft./sec.2)

These quantities can be used to express the headloss or head gain between two loca-
tions 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, respec-
tively. Balancing the energy across two points in the system, you then obtain the
energy equation:

2 2
p V p V
-----1 + z 1 + -----1- + h p = -----2 + z 2 + -----2- + h L
 2g  2g
Where:

p = Pressure (N/m2, lb./ft.2)

 = Specific weight (N/m3, lb./ft.3)

z = Elevation at the centroid (m, ft.)

Bentley HAMMER V8i Edition User’s Guide 13-913

Pressure Network Hydraulics

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 quanti-
ties, 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 piezom-
eter. 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

13-914 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Conservation of Mass and Energy

Conservation of Mass

At any node in a system containing incompressible fluid, the total volumetric or mass
flows in must equal the flows out, less the change in storage. Separating these into
flows from connecting pipes, demands, and storage, you obtain:

 QIN t   Q OUT t  VS

Where: QIN = Total flow into the node (m3/s, cfs)
QOUT = Total demand at the node (m3/s, cfs)
VS = Change in storage volume (m3, ft.3)
t = 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

Bentley HAMMER V8i Edition User’s Guide 13-915

Pressure Network Hydraulics

The same basic principle can be applied to any path between two points. As shown in
the figure above, the 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 guaran-
teed 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 equiva-
lent looped networks or pseudo-loops.
• Using the method avoids the post-computation step of loop and path definition,
which adds significantly to the overhead of system computation.
• The method is numerically stable when the system becomes disconnected by
check valves, pressure regulating valves, or modeler’s error. The loop and path
methods fail in these situations.
• The structure of the generated system of equations allows the use of extremely
fast and reliable sparse matrix solvers.

The derivation of the Gradient Algorithm starts with two matrices and ends as a
working system of equations.

Derivation of the Gradient Algorithm

Given a network defined by N unknown head nodes, P links of unknown flow, and B
boundary or fixed head nodes, the network topology can be expressed in two inci-
dence matrices:

A12 = A21T (P x N) Unknown head nodes incidence matrix

and

13-916 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

A10 = A01T (P x B) Fixed head nodes incidence matrix

The following convention is used to assign matrix values:

A12(i,j) = 1, 0, or -1 (PxN) Unknown head nodes incidence matrix

Assigned nodal demands are given by:

qT = [q1, q2,…, qN] (1 x N) Nodal demand vector

Assigned boundary nodal heads are given by:

HfT = [Hf1, Hf2,…, HfB] (1 x B) Fixed nodal head vector

The headloss or gain transform is expressed in the matrix:

(1 x P) Non-linear laws expressing headlosses in

FT(Q) = [f1, f2…, fp]
links

fi  fi (Qi )

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:

QT = [Q1,Q2…, Qp] (1 x P) Unknown link flow rate vector

Unknown nodal heads are defined by:

HT = [H1, H2 …, HN] (1 x N) Unknown nodal head vector

Bentley HAMMER V8i Edition User’s Guide 13-917

Pressure Network Hydraulics

These topology and quantity matrices can be formulated into the generalized matrix
expression using the laws of energy and mass conservation:

A 12H  F(Q)   A 10H f

A 12 Q  q

A second diagonal matrix that implements the vectorized head change coefficients is
introduced. It is generalized for Hazen-Williams friction losses in this case:

R Q n1 1 
 1 1 
 n  1 
R2 Q2 2
 
A 11   ... 
 ... 
 n 1

 R P QP P 

This yields the full expression of the network response in matrix form:

 A 11 A 12  Q  A 10H f 
  
 A 21 0  H   q



To solve the system of non-linear equations, the Newton-Raphson iterative scheme

can be obtained by differentiating both sides of the equation with respect to Q and H
to get:

NA 11 A 12  dQ  dE 
  
 A 21 0   dH   dq 

with

n1 
 
n2
N 
 ... 
 
 nP 

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:

1
 1

H k 1  (A 21 N 1 A 11 A 12 ) 1 A 21 N 1 (Q k  A 11 A 10 H f )  (q  A 21Q k )

1
Q k 1  (1  N 1 )Q k  N 1 A 11 (A 12 H k 1  A 10 H f )

13-918 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

The solution for each unknown nodal head for each time iteration is computationally
intensive. This high-speed solution utilizes a highly optimized sparse matrix solver
that is specifically tailored to the structure of this matrix system of equations.

Sources:

Todini, E. and S. Pilati, “A gradient Algorithm for the Analysis of Pipe Networks,”
Computer Applications in Water Supply, Vol. 1—Systems Analysis and Simulation,
ed. By Bryan Callback and Chin-Hour Or, Research Studies Press LTD, Watchword,
Hertfordshire, England.

The Linear System Equation Solver

The Conjugate Gradient method is one method that, in theory, converges to an exact
solution in a limited number of steps. The Gradient working equation can be
expressed for the pressure network system of equations as:

Ax  b

where:

x  Hk  1

 1

b   A 21 N 1 (Q k  A 11 A 10 H f )  (q  A 21Q k )

The structure of the system matrix A at the point of solution is:

A  A 21(NA 11 ) 1 A 12  A 21DA 12

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:

Bentley HAMMER V8i Edition User’s Guide 13-919

Pressure Network Hydraulics

A  LLT
where L is lower triangular with positive diagonal elements. Making the Cholesky
factorization allows the system to be solved in two steps:

y  L1b

x  (LT ) 1 y

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 soft-
ware solves the system of equations using a variant of Cholesky’s method which has
been optimized to reduce fill-in of the factorization matrix, thus minimizing storage
and reducing overall computational effort.

Pump Theory

Pumps are an integral part of many pressure systems. Pumps add energy, or head
gains, to the flow to counteract headlosses and hydraulic grade differences within the
system.

A pump is defined by its characteristic curve, which relates the pump head, or the
head added to the system, to the flow rate. This curve is indicative of the ability of the
pump to add head at different flow rates. To model behavior of the pump system, addi-
tional 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.

13-920 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

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 characteristic 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:

Q1 n
 1
Q2 n2

and

2
h 1  n1 
 
h 2  n 2 

Where: Q = Pump flow rate (m3/s, cfs)

h = Pump head (m, ft.)
n = Pump speed (rpm)

Bentley HAMMER V8i Edition User’s Guide 13-921

Pressure Network Hydraulics

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 relation-
ships for 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:

Tip: 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 esti-
mating pump size, but should not be used for any analysis for which more accu-
rate results are desired.
• Design Point (One-Point)—A pump can be defined by a single design point (Hd
@ Qd). From this point, the curve’s interception with the head and discharge axes
is computed as Ho = 1.33•Hd and Qo = 2.00•Qd. This type of pump is useful for
preliminary designs but should not be used for final analysis.
• Standard (Three-Point)—This pump curve is defined by three points—the
shutoff head (pump head at zero discharge), the design point (as with the single-
point pump), and the maximum operating point (the highest discharge at which
the pump performs predictably).

13-922 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

• Standard Extended—The same as the standard three-point pump but with an

extended point at the zero pump head point. This is automatically calculated by
the program.
• Custom Extended—The custom extended pump is similar to the standard
extended pump, but allows you to enter the discharge at zero pump head.
• Multiple Point—This option allows you to define a custom rating curve for a
pump. The pump curve is defined by entering points for discharge rates at various
heads. Since the general pump equation, shown below, is used to simulate the
pump during the network computations, the user-defined pump curve points are
used to solve for coefficients in the general pump equation:

Y  A  (B  Q C )

Where: Y = Head (m, ft.)

Q = Discharge (m3/s, cfs)
A,B,C = Pump curve coefficients

The Levenberg-Marquardt Method is used to solve for A, B and C based on the given
multiple-point rating curve.

Valve Theory

There are several types of valves that may be present in a pressurized system. These
valves have different behaviors and different responsibilities, but all valves are used
for automatically controlling parts of the system. They can be opened, closed, or throt-
tled to achieve the desired result.

Check Valves (CVs)

Check valves are used to maintain flow in only one direction by closing when the flow
begins to reverse. When the flow is in the specified direction of the check valve, it is
considered to be fully open.

Bentley HAMMER can model distribution system check valves in two ways.

1. A check valve can be specified as a property of a pipe. Flow is only permitted to

go from the Start Node to the Stop Node.
2. A check valve node element can be placed in the network. In this case, flow is
only permitted in the direction of the downstream pipe. If a check valve is to be
used in a Hammer simulation, this type of check valve must be used.

Bentley HAMMER V8i Edition User’s Guide 13-923

Pressure Network Hydraulics

Check valves are generally used on the suction side of pumps. Bentley HAMMER
assumes that all pumps have a check valve on their downstream side. Therefore, a user
should not specify a check valve there..

Flow Control Valves (FCVs)

FCVs are used to limit the maximum flow rate through the valve from upstream to
downstream. FCVs do not limit the minimum flow rate or negative flow rate (flow
from the To Pipe to the From Pipe). These valves are commonly found in areas where
a water district has contracted with another district or a private developer to limit the
maximum demand to a value that will not adversely affect the provider’s system.

Pressure Reducing Valves (PRVs)

Pressure reducing valves are often used for separate pressure zones in water distribu-
tion networks. These valves prevent the pressure downstream from exceeding a speci-
fied 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-head-
loss relationship, rather than using standard hydraulic formulas. GPVs can be used to
represent reduced pressure backflow prevention valves, well draw-down behavior,
and turbines.

13-924 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Friction and Minor Loss Methods

Chezy’s Equation

Colebrook-White Equation

Hazen-Williams Equation

Darcy-Weisbach Equation

Swamee and Jain Equation

Manning’s Equation

Minor Losses

Chezy’s Equation

Chezy’s equation is rarely used directly, but it is the basis for several other methods,
including Manning’s equation. Chezy’s equation is:

Q CA  RS

Where: Q = Discharge in the section (m3/s, cfs)

C = Chezy’s roughness coefficient (m1/2/s, ft.1/2/sec.)
A = Flow area (m2, 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:

1 k 2.51
= - 2 log +
f Ł12.0 R Re f ł

Bentley HAMMER V8i Edition User’s Guide 13-925

Friction and Minor Loss Methods

Full Flow (Closed Conduit):

1 k 2.51
= - 2 log +
f Ł3. 7 D Re f ł

Where: f = Friction factor (unitless)

k = Darcy-Weisbach roughness height (m, ft.)
Re = Reynolds Number (unitless)
R = Hydraulic radius (m, ft.)
D = Pipe diameter (m, ft.)

Hazen-Williams Equation

The Hazen-Williams Formula is frequently used in the analysis of pressure pipe

systems (such as water distribution networks and sewer force mains). The formula is
as follows:

Q  k  C  A  R0.63  S0.54

Where: Q = Discharge in the section (m3/s, cfs)

C = Hazen-Williams roughness coefficient (unitless)
A = Flow area (m2, ft.2)
R = Hydraulic radius (m, ft.)
S = Friction slope (m/m, ft./ft.)
k = Constant (0.85 for SI units, 1.32 for US units).

13-926 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

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:

L V2
hL = f
D 2g

Where: hL = Headloss (m, ft.)

f = Darcy-Weisbach friction factor (unitless)

D = Pipe diameter (m, ft.)
L = Pipe length (m, ft.)
V = Flow velocity (m/s, ft./sec.)
g = Gravitational acceleration constant (m/s2, ft./sec.2)

For section geometries that are not circular, this equation is adapted by relating a
circular section’s full-flow hydraulic radius to its diameter:

D = 4R

Where: R = Hydraulic radius (m, ft.)

D = Diameter (m, ft.)

This can then be rearranged to the form:

RS
Q  A  8g 
f
Where: Q = Discharge (m3/s, cfs)
A = Flow area (m2, ft.2)
R = Hydraulic radius (m, ft.)
S = Friction slope (m/m, ft./ft.)
f = Darcy-Weisbach friction factor (unitless)
g = Gravitational acceleration constant (m/s2, ft./sec.2)

The Swamee and Jain equation can then be used to calculate the friction factor.

Bentley HAMMER V8i Edition User’s Guide 13-927

Friction and Minor Loss Methods

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.

1.325
f =
Ø ø2
Œln e + 5. 74 œ
Œ Ł 3.7 D 0.9 œ
º Re łß

Where: f = Friction factor (unitless)

 = Roughness height (m, ft.)
D = Pipe diameter (m, ft.)
Re = Reynolds Number (unitless)

The friction factor is dependent on the Reynolds number of the flow, which is depen-
dent on the flow velocity, which is dependent on the discharge. As you can see, this
process requires the iterative selection of a friction factor until the calculated
discharge agrees with the chosen friction factor.

Manning’s Equation

Note: Manning’s roughness coefficients are the same as the

roughness coefficients used in Kutter’s equation.

Manning’s equation, which is based on Chezy’s equation, is one of the most popular
methods in use today for free surface flow. For Manning’s equation, the roughness
coefficient in Chezy’s equation is calculated as:

R1/ 6
Ck
n

Where: C = Chezy’s roughness coefficient (m1/2/s, ft.1/2/sec.)

R = Hydraulic radius (m, ft.)
n = Manning’s roughness (s/m1/3)
k = Constant (1.00 m1/3/m1/3, 1.49 ft.1/3/ft.1/3)

13-928 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Substituting this roughness into Chezy’s equation, you obtain the well-known
Manning’s equation:

k
Q  A  R2 / 3  S1/ 2
n

Where: Q = Discharge (m3/s, cfs)

k = Constant (1.00 m1/3/s, 1.49 ft.1/3/sec.)
n = Manning’s roughness (unitless)
A = Flow area (m2, ft.2)
R = Hydraulic radius (m, ft.)
S = Friction slope (m/m, ft./ft.)

Minor Losses

Minor losses in pressure pipes are caused by localized areas of increased turbulence
that create a drop in the energy and hydraulic grades at that point in the system. The
magnitude of these losses is dependent primarily upon the shape of the fitting, which
directly affects the flow lines in the pipe.

Flow Lines at Entrance

The equation most commonly used for determining the loss in a fitting, valve, meter,
or other localized component is:

Bentley HAMMER V8i Edition User’s Guide 13-929

 V2
hm  K
2g

Where: hm = Loss due to the minor loss element (m, ft.)

K = Loss coefficient for the specific fitting

V = Velocity (m/s, ft./sec.)
g = Gravitational acceleration constant (m/s2, ft./sec. 2)

Typical values for fitting loss coefficients are included in the Fittings Table.

Generally speaking, more gradual transitions create smoother flow lines and smaller
headlosses. For example, the figure below shows the effects of entrance configuration
on typical pipe entrance flow lines.

Engineer’s Reference
This section provides you with tables of commonly used roughness values and fitting
loss coefficients.

Roughness Values—Manning’s Equation

Commonly used roughness values for different materials are:

Manning’s Coefficient (n) for Closed Metal Conduits Flowing Partly

Full

Channel Type and Description Minimum Normal Maximum

a. Brass, smooth 0.009 0.010 0.013

b. Steel

1. Lockbar and welded 0.010 0.012 0.014

2. Riveted and spiral 0.013 0.016 0.017

c. Cast iron

1. Coated 0.010 0.013 0.014

13-930 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Manning’s Coefficient (n) for Closed Metal Conduits Flowing Partly

Full (Cont’d)

Channel Type and Description Minimum Normal Maximum

2. Uncoated 0.011 0.014 0.016

d. Wrought iron

1. Black 0.012 0.014 0.015

2. Galvanized 0.013 0.016 0.017

e. Corrugated metal

1. Subdrain 0.017 0.019 0.021

2. Storm drain 0.021 0.024 0.030

Roughness Values—Darcy-Weisbach Equation (Colebrook-White)

Commonly used roughness values for different materials are:

Darcy-Weisbach Roughness Heights e for Closed Conduits

Pipe Material  (mm)  (ft.)

Glass, drawn brass, copper (new) 0.0015 0.000005

Seamless commercial steel (new) 0.004 0.000013

Commercial steel (enamel coated) 0.0048 0.000016

Commercial steel (new) 0.045 0.00015

Wrought iron (new) 0.045 0.00015

Asphalted cast iron (new) 0.12 0.0004

Galvanized iron 0.15 0.0005

Cast iron (new) 0.26 0.00085

Concrete (steel forms, smooth) 0.18 0.0006

Bentley HAMMER V8i Edition User’s Guide 13-931

Engineer’s Reference

Darcy-Weisbach Roughness Heights e for Closed Conduits

Pipe Material  (mm)  (ft.)

Concrete (good joints, average) 0.36 0.0012

Concrete (rough, visible, form marks) 0.60 0.002

Riveted steel (new) 0.9 ~ 9.0 0.003 - 0.03

Corrugated metal 45 0.15

Roughness Values—Hazen-Williams Equation

Commonly used roughness values for different materials are:

Hazen-Williams Roughness Coefficients (C)

Pipe Material C

Asbestos Cement 140

Brass 130-140

Brick sewer 100

Cast-iron

New, unlined 130

10 yr. Old 107-113

20 yr. Old 89-100

30 yr. Old 75-90

40 yr. Old 64-83

Concrete or concrete lined

Steel forms 140

Wooden forms 120

Centrifugally spun 135

Copper 130-140

Galvanized iron 120

Glass 140

13-932 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Hazen-Williams Roughness Coefficients (C)

Pipe Material C

Lead 130-140

Plastic 140-150

Steel

Coal-tar enamel, lined 145-150

New unlined 140-150

Riveted 110

Tin 130

Vitrified clay (good condition) 110-140

Wood stave (average condition) 120

Typical Roughness Values for Pressure Pipes

Typical pipe roughness values are shown below. These values may vary depending on
the manufacturer, workmanship, age, and many other factors.

Comparative Pipe Roughness Values

Manning’s Hazen-
Darcy-Weisbach
Material Coefficient Williams
Roughness Height
n C

k (mm) k (0.001 ft.)

Asbestos cement 0.011 140 0.0015 0.005

Brass 0.011 135 0.0015 0.005

Brick 0.015 100 0.6 2

Cast-iron, new 0.012 130 0.26 0.85

Concrete:

Steel forms 0.011 140 0.18 0.6

Wooden forms 0.015 120 0.6 2

Centrifugally spun 0.013 135 0.36 1.2

Bentley HAMMER V8i Edition User’s Guide 13-933

Engineer’s Reference

Comparative Pipe Roughness Values (Cont’d)

Manning’s Hazen-
Darcy-Weisbach
Material Coefficient Williams
Roughness Height
n C

Copper 0.011 135 0.0015 0.005

Corrugated metal 0.022 — 45 150

Galvanized iron 0.016 120 0.15 0.5

Glass 0.011 140 0.0015 0.005

Lead 0.011 135 0.0015 0.005

Plastic 0.009 150 0.0015 0.005

Steel

Coal-tar enamel 0.010 148 0.0048 0.016

New unlined 0.011 145 0.045 0.15

Riveted 0.019 110 0.9 3

Wood stave 0.012 120 0.18 0.6

Fitting Loss Coefficients

For similar fittings, the K-value is highly dependent on things such as bend radius and
contraction ratios.

Typical Fitting K Coefficients

Fitting K Value Fitting K Value

Pipe Entrance 90° Smooth Bend

Bellmouth 0.03-0.05 Bend Radius / D = 4 0.16-0.18

Rounded 0.12-0.25 Bend Radius / D = 2 0.19-0.25

Sharp-Edged 0.50 Bend Radius / D = 1 0.35-0.40

Projecting 0.80 Mitered Bend

Contraction—Sudden  = 15° 0.05

D2/D1 = 0.80 0.18  = 30° 0.10

13-934 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Typical Fitting K Coefficients (Cont’d)

Fitting K Value Fitting K Value

D2/D1 = 0.50 0.37  = 45° 0.20

D2/D1 = 0.20 0.49  = 60° 0.35

Contraction—Conical  = 90° 0.80

D2/D1 = 0.80 0.05 Tee

D2/D1 = 0.50 0.07 Line Flow 0.30-0.40

D2/D1 = 0.20 0.08 Branch Flow 0.75-1.80

Expansion—Sudden Cross

D2/D1 = 0.80 0.16 Line Flow 0.50

D2/D1 = 0.50 0.57 Branch Flow 0.75

D2/D1 = 0.20 0.92 45° Wye

Expansion—Conical Line Flow 0.30

D2/D1 = 0.80 0.03 Branch Flow 0.50

D2/D1 = 0.50 0.08

D2/D1 = 0.20 0.13

Variable Speed Pump Theory

The variable speed pump (VSP) model within Bentley HAMMER V8i lets you model
the performance of pumps equipped with variable frequency drives. Variable
frequency drives continually adjust the pump drive shaft rotational speed in order to
maintain pressure and flow requirements in a network while improving energy effi-
ciency and other operating characteristics as summarized by Lingireddy and Wood
(1998);

• Minimization of excess pressures and energy usage,

• Leakage control through more precise pressure regulation,
• Flexible pump scheduling, improving off peak energy utilization,
• Control of tank drain and fill cycles,

Bentley HAMMER V8i Edition User’s Guide 13-935

Variable Speed Pump Theory

• Improved system performance during emergency water usage events such as fires
and main breaks,
• Reduction of transients produced when pumps start and stop,
• Simplification of flow control procedures.

Bentley HAMMER V8i variable speed pumping feature will allow designers to make
better decisions by empowering them to fully evaluate the advantages and disadvan-
tages associated with VSPs for their unique application.

Within Bentley HAMMER V8i there are two different ways to model VSPs
depending on the data available to describe pump operations. The relative speed factor
is a unitless number that quantifies the rotational speed of the pump drive shaft. 1) If
the relative speed factor (or for EPS simulations a series of factors) is known, a pattern
based VSP can be used. 2) If the relative speed factor is unknown, it can be estimated
using the VSP with Bentley HAMMER V8i new Automatic Parameter Estimation
eXtension (APEX).

• Pattern Based VSPs—The variable speed pumping model lets you adjust pump
performance using the relative speed factor. A single relative speed setting or a
pattern of time varying relative speed factors can be applied to the pump. This is
especially useful when modeling the operation of existing VSPs in your system.
The Affinity Laws are used to adjust pump performance according to the relative
speed factor setting.
See Pump Theory for more information about pump curves.
• VSPs with APEX—APEX can be used in conjunction with the VSP model to
estimate an unknown relative speed setting sufficient to maintain an operating
objective. APEX uses an explicit algorithm to solve for unknown parameters
directly (Boulos and Wood, 1990). This technique has proven to be powerful,
robust, and computationally efficient for estimation of network parameters and
has been improved to allow use for steady state and extended period simulations.
To use APEX for estimating relative speed factors, the control node and control
level setting for the pump must be selected and the pump curve and operating
range for the pump must be defined. The following paragraphs provide guidelines
for performing these tasks.
• Control Node Location—The location of the control node is an important
consideration that affects pump operating efficiency, pressure maintenance perfor-
mance, and, in rare instances, the stability of the parameter estimation calculation.
The algorithm has been designed to allow multiple VSPs to operate within one
pressure zone of a network; however, the pump and control node pairs should be
decoupled from one another. In other words, a control node should be located such
that only the pump it controls influences it. If the pressure zone of the model
contains a tank or reservoir (hydraulic boundary conditions), consider making the

13-936 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

boundary condition the control node as opposed to selecting a pressure junction

near the boundary. This will eliminate the possibility of specifying a set of
hydraulic conditions that are impossible to maintain and thus reduce the possi-
bility of computational failure.
• Setting the Target Head—The control node target head is the constant elevation
of the hydraulic grade line (HGL) that the VSP will attempt to maintain. The
target head at the control node must be within the physical limitations of the VSP
as it has been defined (pump curve and maximum speed setting). If the target head
is greater then the maximum head, the pump can generate at the demanded flow
rate the pump will automatically revert to fixed speed operation at the maximum
relative speed setting, and the target head will not be maintained.

Tip: Navigating to the target head settings—The VSP target head for
junction nodes can be set on the VSP tab of the Pump dialog box
and for tanks on the Section tab of the Tank dialog box by
adjusting the initial level.

• Setting the Maximum Relative Speed Factor—For flexible operation, a vari-

able speed drive and pump should be configured such that it can efficiently
operate over a range of speeds to satisfy the pressure and flow requirements it will
be subject. The value selected for the maximum relative speed factor depends on
the normal operating range of the drive motor. To set the proper maximum value,
you must determine the drive motor’s normal operating speed and maximum
operating speed (the maximum speed at which the drive motor normally operates,
not the speed at which the drive catastrophically fails). The relative speed factor is
defined as the quotient of the current operating speed and the normal operating
speed. Thus the maximum relative speed factor is the maximum operating speed
of the drive divided by the normal operating speed. For example, a maximum rela-
tive speed factor of 2.0 means that the maximum speed is two times the normal
operating speed, and a maximum relative speed factor of 1.0 means that the
maximum operating speed is equal to the normal operating speed.
• Defining the Pump Curve—In order to determine the relative speed factor using
APEX, the pump curve must be smooth and continuously differentiable; thus a
one point or three point power function curve definition must be used. For best
results, the curve should be defined for the normal operating speed of the pump
(corresponding to a relative speed factor equal to 1.0, regardless of the maximum
speed setting).

Variable speed pump theory includes:

VSP Interactions with Simple and Logical Controls

Bentley HAMMER V8i Edition User’s Guide 13-937

Variable Speed Pump Theory

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 Bentley HAMMER 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 flexi-
bility to model real world behaviors. The paragraphs that follow describe guidelines
for defining simple and logical controls with VSPs.

• Pattern based VSPs—The pattern of relative speed factors specified for a VSP
takes precedence over all simple and logical control commands. Therefore, the
use of controls with pattern based VSPs is not recommended. Rather, the pattern
of relative speed factors should be defined such that control objectives are implic-
itly met.
• VSPs with APEX—A VSP can be switched into any one of three different states.
When the VSP is On, the APEX will estimate the relative speed sufficient to
maintain a constant pressure head at the control node. When the VSP is Off, the
relative speed factor and flow through the pump are set to zero, and the pressure
head at the control node is a function of the prevailing network boundary and
demand conditions. When the control state of a VSP is Fixed Speed Override, the
pump will operate at the maximum speed setting and the target head will no
longer be maintained. The Temporarily Closed state for a VSP indicates that the
check valve (CV) within the pump has closed in response to prevailing hydraulic
conditions, and that the target head cannot be maintained. The VSP control node
can be specified at any junction node or tank in a network model. As described
below, however, the behavior of simple and logical controls depends on the type
of control node selected.
• Junction Nodes—When the VSP control node type selected is a junction node,
the VSP will behave according to some automatic behaviors in addition to the
controls defined for the pump. If the head at the control node is above the target
head, the pump state will automatically switch to Off. If the head at the control
node is less then the target head, the pump state will automatically switch to On.
The VSP will automatically switch into and out of the Fixed Speed Override and
Temporarily Closed states in order to maintain the fixed head at the control node
and prevent reverse flow through the pump. Additional controls can be added to
model more complex use cases.
• Tanks—When the VSP control node is a tank, you must manage the state of the
pump through control definitions, allowing for flexible modeling of the complex
control behaviors that may be desired for tanks. If a VSP has a state of On, the
pump will maintain the current level of the tank. For example, at the beginning of
a simulation, if a VSP has status of on it will maintain the initial level of the tank.
As the simulation progresses and the pump happens to turn off, temporarily close,
or go into fixed speed override, the level in the tank will be determined in

13-938 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

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

The VSP model is fully integrated with the Energy Cost Manager for easy estimation
of pump operating costs. When comparing the energy efficiency of fixed speed and
variable speed pumps, however, it is important to bear in mind that the pumps are not
maintaining the same pressures in the network. The performance of the pumps should
be compared in such a way that takes this difference into account; otherwise the
comparison is of little value. For example, consider a comparison between a VSP and
a fixed-speed pump is prepared, but the target head at the control node is greater than
the head maintained there by the fixed speed pump. The VSP energy efficiency
numbers will be disappointing because the VSP is maintaining higher pressures.

The concept of a minimum acceptable head (or pressure) can be useful when evalu-
ating the performance of fixed speed and variable speed pumps. Both pumps should
be sized and operated such that the pressure is equal to or greater than the minimum
acceptable head. In this way, the heads maintained by the respective pumps can be
used to define equivalency between the respective designs. When the comparison is
thoughtfully designed and conducted, it is likely that the energy efficiency improve-
ments possible with VSPs will come to light more clearly.

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 geom-
etry. 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:

Bentley HAMMER V8i Edition User’s Guide 13-939

Hydraulic Equivalency Theory

Lr = L1 + L2

Principles

The equations derived below are based on the following principles. The equations
below are for two pipes but can be extended to n pipes.

For pipes in series:

Qr = Q1 = Q2

where Q = flow, r refers to the resulting pipe, and 1 and 2 refer to the pipes being
removed.

hr = h1 + h2

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

KL Q 1.85
h = -------------  ----
4.87  C
D
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:

13-940 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

0.54
Lr
-------------
2.63
Dr
C r = -------------------------------------------------------
 Li  0.54

  ----------------------------
Di Ci 
4.87 1.85

Solved for D:

0.205
Lr
---------------
0.38
Cr
D r = -----------------------------------------------------------
 Li  0.205

  -----------------------------
Di Ci
4.87 1.85
- 

Parallel Pipes

Solved for C:

0.54 2.63
Lr Ci Di
Cr = ------------
Dr
2.63
-
 ------------------
Li
0.54
-

Solved for D:

 L 0.54 2.63 0.38

C i D i 
D r =  ------------ 
r
-------------------
 C 0.54 
 r Li 

Manning’s Equation

2
KL  n Q 
h = -----------------------
5.33
D
Series Pipes

Solved for n:

Bentley HAMMER V8i Edition User’s Guide 13-941

Hydraulic Equivalency Theory

2 0.5
Dr  Li n 
2.66
n r = -------------  
i 
------------
-
0.5  5.33
Lr  Di 

Solved for D:

  0.188
 
 L n2 
D r =  ------------------------
r r
 2
 Li n 

r
 -------------
 Di
5.33

Parallel Pipes

Solved for n:

2.66
Dr
-------------
0.5
Lr
n r = ------------------------
2.66
Di
 -------------
Li n
0.5

Solved for D:

 2.66 0.376
D i 
Dr =  Lr n 
0.5
-------------
 0.5 
 L i n

Darcy-Weisbach Equation

2
KLfQ
h = -----------------
5
D

13-942 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

It is the roughness k—not f—that is a property of the pipe. While f behaves well, the
roughness can take on negative values in the parallel pipe case. Therefore, only solu-
tions for D will be developed.

The other problem with the Darcy-Weisbach equation is that D and f are not uniquely
related and depend on the Reynolds number, which is a function of velocity. So the
question that must be first answered is, Which value of f should be used in the equa-
tions? This is especially tricky when the individual pipes have different values of k.
First, a velocity of 1 m/s will be used as a reference velocity to calculate Reynolds
number for the individual pipes. Second, an iterative solution must be used to solve
for D.

That is

1. Pick a D and k based on the dominant pipe.

2. Calculate f for the resultant pipe using Swamee-Jain formula.
3. Use that f for fr in the equations below.
4. Check if Dr is close enough to D used to calculate f.
5. Repeat until convergence.

The Swamee-Jain equation is

1.325
f = ---------------------------------------------------
5.74 2
ln  ------------ + -------------
k
 3.7D 0.9
Re

where

VD
Re = --------

 must be selected so that the units cancel. Typical values are 1.00e-6 m2/s or 1.088e-
5 ft.2/sec.

Series Pipes

Bentley HAMMER V8i Edition User’s Guide 13-943

Hydraulic Equivalency Theory

  0.2
 
 Lr ff 
D r =  --------------------
 L i f i


 ---------
Di 
5

Parallel Pipes

  2.5  2  0.2
Di
D r = Lr f r 

 -------------------- 
  0.5 
   Li f i   

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 skele-
tonize 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 approxi-
mately in half. I worked through the math for coming up with an equivalent minor loss
coefficient and it’s a mess. Using half the minor loss coefficient isn’t exactly correct,
but it pretty much accounts for things.

13-944 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Numerical Check
To check the equations, run through examples of each. Solve for head loss in each pipe
individually and then combine to see how the head loss in the equivalent pipe
compares for series pipes and for parallel, see how the flow compares. Stick with the
SI units (i.e., flow in m3/s, D, L and h in m).

Series

Use Q = 1 m3/s and solve for head loss. Pipe 1 is the dominant pipe.

Comparison between the Sum of the Headlosses from the Two Pipes
and the Headloss from the Equivalent Pipe

Resulting,
Resulting,
Pipe 1 Pipe 2 solve for
solve for D
C,n

Length 100 80 180 180

0.75k,
Diameter 1 0.75 0.88
0.855n

C 100 120 100 71

k 0.002 0.0015 0.002 X

n 0.013 0.012 0.013 0.0197

h (Hazen) 0.21 0.49 0.72 0.72

h (Manning) 0.17 0.55 0.72 0.72

h (Darcy) 0.20 0.58 0.77 X

Parallel

Bentley HAMMER V8i Edition User’s Guide 13-945

Thiessen Polygon Generation Theory

Use head loss = 1 m and solve for Q.

Comparison between the Sum of the Flows from the Two Pipes and
the Flow from the Equivalent Pipe

Resulting,
Resulting,
Pipe 1 Pipe 2 solve for
solve for D
C,n

Length 100 80 100 100

Diameter 1 0.75 0.88 1.18n, 1.21k

C 100 120 100 163

k 0.002 0.0015 0.002 X

n 0.013 0.012 0.013 0.0083

Q (Hazen) 2.31 1.47 3.74 3.77

Q (Manning) 2.40 1.35 3.72 3.75

Q (Darcy) 2.26 1.31 3.55 X

Thiessen Polygon Generation Theory

Naïve Method

Plane Sweep Method

Naïve Method

A Thiessen polygon of a site, also called a Voronoi region, is the set of points that are
closer to the site than to any of the other sites.

Let P = {p1, p2,…pn} be the set of sites and V = {v(p1), v(p2),…v(pn)} represent the
Voronoi regions or Thiessen polygons for Pi, which is the intersection of all of the half
planes defined by the perpendicular bisectors of pi and the other sites. Thus, a naïve
method for constructing Thiessen Polygons can be formulated as follows:

13-946 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Step 1 For each i such that i = 1, 2,…, n, generate n - 1 half planes H(pi,pj), 1 </= j </
= n, i <> j, and construct their common intersection v(pi).

Step 2 Report V = {v(p1), v(p2),…v(pn)} as the output and stop.

This naïve procedure is, however, very inefficient for generating Thiessen polygons.
The computation time increases exponentially as the number of sites increases. There
are many other more competent methods for constructing a Thiessen polygon.

Plane Sweep Method

The plane sweep technique is a fundamental method for solving two-dimensional

geometric problems. It works with a special line called a sweepline, a vertical line
sweeping the plane from left to right. It hits objects one by one as the sweepline
moves. Whenever it crosses an object, a portion of the problem is solved. Therefore, it
enables a two-dimensional problem to be solved in a sequence of one-dimension
processing. Sweep plane technique provides a conceptually simple and efficient algo-
rithm. Steven Fortune (1986; 1987) has developed a sweepline algorithm for
constructing Thiessen polygons. This algorithm has been implemented in the Bentley
HAMMER Thiessen Polygon Generator. The detailed working algorithm is given as
follows:

1. Q <------- P.
2. Choose and delete the left-most point, say pi from Q.
3. L <------- the list consisting of a single region (V(pi).
4. While Q is not empty, repeat Steps 1-3.
5. If w is a site, say w = pi, do:
a. Find region (V(pi) on L containing pi.

b. Replace (V(pi) on L by the sequence ((V(pj), h-(pi, pj), ((V(pi)), h+(pi, pj),
(V(pj).

c. Add to Q the intersection of h-(pi, pj) with the intermediate lower half hyper-
bola on L and the intersection of h+(pi, pj) with the immediate upper half
hyperbola on L.

6. If w is an intersection, say w = (qt), do:

a. Replace sub-sequence (h±(pi, pj), (V(pi)), h±(pi, pk)) on L by h = h-(pi, pk) or

h = h+(pi, pk) appropriately.

b. Delete from Q any intersection of h±(pi, pj) or h±(pi, pk) with others.

Bentley HAMMER V8i Edition User’s Guide 13-947

Method for Modeling Pressure Dependent Demand

c. Add to Q any intersection of h with its immediate upper half hyperbola and its
immediate lower half parabola on L.
d. Mark (qt) as a Voronai vertex incident to h±(pi, pj), h±(pi, pk), and h.

7. Repeat all half hyperbolas ever listed on L, all the Voronai vertices marked in the
preceding step, and the incidence relations among them.

The sweepline algorithm is an efficient technique for constructing a Thiessen polygon.

The computation time required for the worst case is O(nlog n). It produces a far more
competent method than the naïve method and provides satisfactory performance for
generating Thiessen polygons for a large number of points.

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 emer-
gency 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

Pressure Dependent Demand

Demand Deficit

Solution Methodology

Modified GGA Solution

Direct GGA Solution

13-948 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Use Cases

In 1994, the Dutch water authority posted the guideline for water companies to eval-
uate the level of water supply while coping with calamity events. A tentative guideline
requirement is that a water system must meet 75% of the original demand for the
majority of customers and no large group of customers (2000 resident addresses)
should receive less than 75% of their original demand.

The guideline is applicable to all the elements between the source and tap in a water
system and is required to find the effect of every element. In order to calculate the
water supply level under a calamity event, a hydraulic modeling approach is proposed:

1. Take one element at a time out of a model, copying the calamity event of element
outage
2. Run the model for peak hours of all demand types and also the peak hours of tank
filling. The actual demand needs to be modeled as a function of pressure; the
supply is considered unaffected if the pressure is above the required pressure
threshold
3. Evaluate the water supply level for each demand node. If there is less than 2000
resident customers receiving less than 75% of the normal demand, then the
requirement is met. Repeat Step 1 to simulate another calamity event. If the
requirement is not met, continue with step 4.
4. Perform 24 hours pressure dependent demand simulation for the maximum
demand day under the calamity even
5. Sum up the actual demand for each node over 24 hours
6. Check if there is any node where the totalized demand over 24 hours is less than
75% of the maximum day demand; if not, the guideline is met. Otherwise an
appropriate system improvement needs to be identified in order to meet the guide-
line.
UK water companies are required by law to provide water at a pressure that will,
under normal circumstances, enable it to reach the top floor of a house. In order to
assess if this requirement is satisfied, companies are required to report against a
service level corresponding to a pressure head of 10 meters at a flow of 9 liters per
minute. In addition, water companies are also required to report the supply reference
for unplanned and planned service interruptions.

Both use cases provide some generality for water utilities world wide to evaluate the
performance of water systems under emergency and low pressure conditions. An
emergency event can be specified as one set of element outages. In order to quantify
the water supply level under such an event, the demand must be modeled as a function
of nodal pressure. Hydraulic model needs to be enhanced to perform pressure depen-
dent demand simulation and to compute the level of certainty/supply level.

Bentley HAMMER V8i Edition User’s Guide 13-949

Method for Modeling Pressure Dependent Demand

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:

Qis, j
Si , j   100%
Qi

This gives the percentage of the demand that a system supplies to node i under
calamity event j. The key is to calculate the actual supply demand Qis under the outage
that may cause lower than required junction pressure. The less the demand, the greater
the impact the calamity is on the system supplied capacity and the more critical the
element is to the system.

Pressure Dependent Demand

Whenever a calamity occurs, the systems pressures are affected. Some locations may
not have the required pressure. Nodal demand, water available at a location, is depen-
dent 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:



0 Hi  0
 
Qis  H i 
   0  Hi  Ht
Qri  H ri 
 
 H t 
Hi  Ht
 H ri 



Where:

13-950 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Hi = calculated pressure at node i

Qri = requested demand or reference demand at node i
Qsi = calculated demand at node i
Hri = reference pressure that is deemed to supply full requested/reference demand
Ht = 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%.

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:

Bentley HAMMER V8i Edition User’s Guide 13-951

Method for Modeling Pressure Dependent Demand

N
Q j   (Qi  Qis, j ) when Si , j  St
i 1

Q 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 criti-
cality, 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 solu-
tion 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 algo-
rithm (GGA).

 A11 ... A 12   Q    A10 H 0 

 ... ... ...   ...    ... 
    
 A21 ... 0   H    q 

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:

 A11 ... A 12   Q    A10 H 0 

 ... ... ...   ...    ... 
    
 A21 ... A22   H    q 

A new diagonal matrix A22 is added to the solution matrix. The non-zero diagonal
element is given as

A22 (i, i )  Qis

13-952 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Modified GGA Solution

By following the original derivation of GGA, pressure dependent demand formula can
be solved as:

 D11 ... A 12   dQ   dE 
 ... ... ...   ...    ... 
    
 A21 ... D22   dH   dq 

The difference from the original GGA is the new diagonal matrix D22, which is the
deviation of A22 of pressure head H.

0 Pi s  0
  1
  Hi 
D22 (i, i )      Qi 0  Pi s  Pt
  Pt 
0 Pi s  Pt


The modified GGA is to calculate D22 for each pressure dependent demand node and
add at A(i, i) as follows:

A(i, i )   pij  D22 (i, i )

j

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

An alternative solution method is to directly apply GGA as derived but move the pres-
sure dependent demand term to the right

Bentley HAMMER V8i Edition User’s Guide 13-953

References

 A11 ... A 12   Q    A10 H 0 

 ... ... ...   ...    ... 
    
 A21 ... 0   H    A22 H  q 

This method will require no matrix modification of original GGA, but the program
will update the nodal demand according to the pressure head of the left side of the
matrix.

References
Babovic V., Wu Z. Y. & Larsen L. C., “Calibrating Hydrodynamic Models by Means
of Simulated Evolution,” in Proceeding of Hydroinformatics, Delft, Netherlands,
pp193-200, 1994.

Benedict, R. P., Fundamentals of Pipe Flow, John Wiley and Sons, Inc., New York,
1980.

Brater, Ernest F. and Horace W. King, Handbook of Hydraulics, McGraw-Hill Book

Company, New York, 1976.

Boulos, P. F. and D. J. Wood, “Explicit Calculation of Pipe-Network Parameters,”

Journal of Hydraulic Engineering, ASCE, 116(11) 1329-1344, 1987.

Cesario, A. Lee, Modeling, Analysis, and Design of Water Distribution Systems,

AWWA, 1995.

Clark, R.M., “Chlorine demand and Trihalomethane formation kinetics: a second-

order model,” Journal of Environmental Engineering, Vol. 124, No. 1, pp. 16-24,
1998.

Clark, R. M., W. M. Grayman, R. M. Males, and A. F. Hess, “Modeling Contaminant

propagation in Drinking Water Distribution Systems,” Journal of Environmental
Engineering, ASCE, New York, 1993.

Cohon, J.L., Multi-objective Programming and Planning. Academic Press, New York,
1978.

Computer Applications in Hydraulic Engineering, Fifth Edition, Waterbury, Connect-

icut, Haestad Press, 2002.

CulvertMaster User’s Guide, Waterbury, Connecticut, Haestad Methods, 2000.

13-954 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

Dunlop, E.J., WADI Users Manual, Local Government Computer Services Board,
Dublin, Ireland, 1991.

Essential Hydraulics and Hydrology, Waterbury, Connecticut, Haestad Press, 1998.

FlowMaster PE Version 6.1 User’s Guide, Waterbury, Connecticut, Haestad Methods,

2000.

George, A. & Liu, J. W-H., Computer Solution of Large Sparse Positive Definite
Systems, Prentice-Hall, Englewood Cliffs, NJ, 1981.

Goldberg, D.E., Genetic Algorithms in Search, Optimization and Machine Learning.

Addison Wesley, Reading, MA, 1989.

Goldberg, D. E., Korb, B., & Deb, K., “Messy genetic algorithms: Motivation, anal-
ysis, 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 Distribu-

tion, 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 Cincin-
nati, 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 Distribu-

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

Bentley HAMMER V8i Edition User’s Guide 13-955

References

Osiadacz, A.J., Simulation and Analysis of Gas Networks, E. & F.N. Spon, London,
1987.

Practical Guide to Hydraulics and Hydrology, Waterbury, Connecticut, Haestad Press,

1997.

Roberson, John A., John J. Cassidy, and Hanif M. Chaudhry, Hydraulic Engineering,
Houghton Mifflin Company, Massachusetts, 1988.

Roberson, John A. and Clayton T. Crowe, Engineering Fluid Mechanics 4th Edition,
Houghton Mifflin Company, Massachusetts, 1990.

Rossman, Lewis A., EPANET User’s Manual (AWWA Workshop Edition), Risk Reduc-
tion Engineering Laboratory, Office of Research and Development, USEPA, Ohio,
1993.

Rossman, Lewis A. et al., “Numerical Methods for Modeling Water Quality in Distri-
bution Systems: A Comparison,” Journal of Water Resources Planning and Manage-
ment, 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 Manage-
ment, Vol. 119, No. 5, 505-517, 1993.

Rossman, L.A., Clark, R.M., and Grayman, W.M., “Modeling chlorine residuals in
drinking-water distribution systems,” Journal of Environmental Engineering, Vol.
120, No. 4, 803-820, 1994.

Rossman, L.A. and Boulos, P.F., “Numerical methods for modeling water quality in
distribution systems: A comparison,” Journal of Water Resource Planning and
Management, Vol. 122, No. 2, 137-146, 1996.

Rossman, L.A. and Grayman, W.M., “Scale-model studies of mixing in drinking water
storage tanks,” Journal of Environmental Engineering, Vol. 125, No. 8, pp. 755-761,
1999.

Salgado, R., Todini, E., & O’Connell, P.E., “Extending the gradient method to include
pressure regulating valves in pipe networks,” Proc. Inter. Symposium on Computer
Modeling of Water Distribution Systems, University of Kentucky, May 12-13, 1988.

Sanks, Robert L., Pumping Station Design, Butterworth-Heinemann, Inc., Stoneham,

Massachusetts, 1989.

13-956 Bentley HAMMER V8i Edition User’s Guide

 Technical Reference

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, Connect-
icut, 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 cali-
brated 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 Simula-
tion, Hobart, Tasmania, Australia, 8-11 December, 1997b.

Bentley HAMMER V8i Edition User’s Guide 13-957

References

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 & Environ-
mental 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.

13-958 Bentley HAMMER V8i Edition User’s Guide

 Appendix

Bentley HAMMER V8i 14

Theory and Practice

Bentley HAMMER V8i is an advanced numerical simulator of hydraulic transient

phenomena (water hammer) in water, wastewater, industrial, and mining systems.
Built with busy engineers in mind, it simplifies data entry and allows you to focus on
visualizing, improving, and delivering your results quickly and professionally.
Bentley HAMMER V8i can handle any fluid or system that a typical steady-state
hydraulic model like WaterCAD can, but it can also solve a broader range of prob-
lems, as shown in the table below.

Table 14-1: Bentley HAMMER V8i Capabilities

WaterCAD Bentley HAMMER V8i*

Steady or gradually varying turbulent

Rapidly varying or transient flow
flow

Slightly compressible, two-phase fluids

Incompressible, Newtonian, single-
(vapor and liquid) and two-fluid systems
phase fluids
(air and liquid)

Closed-conduit pressurized systems

Full pipes with air intake and release at discrete
points

• * Bentley HAMMER V8i capabilities are in addition to WaterCAD’s capabilities

With Bentley HAMMER V8i, you can analyze drinking water systems, sewage force-
mains, fire protection systems, well pumps, and raw-water transmission lines. You can
change the specific gravity of the fluid to model oil or slurries, for example. Bentley
HAMMER V8i assumes that changes in other fluid properties, such as temperature,
are negligible. It does not currently model fluids with significant thermal variations,
such as can occur in cogeneration or industrial systems.

Bentley HAMMER V8i Edition User’s Guide 14-959

Acknowledgements

The Bentley HAMMER V8i algorithms will grow and evolve to keep pace with the
state of the practice in water distribution and wastewater collection modeling. Because
the mathematical solution methods are continually extended, this manual deals prima-
rily with the fundamental principles underlying these algorithms and focuses less on
the details of their implementation.

This appendix introduces the principles of hydraulic transients in piping systems,

reviews current analytical approaches and engineering practices, discusses the poten-
tial sources and impacts of water hammer, and presents a proven approach to help you
select and size surge-control equipment. Several transient simulations are integrated
into the discussion to provide context.

RELATED TOPICS

• See “Acknowledgements” on page 960.

• See “Overview of Hydraulic Transients” on page 961.
• See “Hydraulic Transient Theory” on page 970.
• See “Water System Characteristics” on page 985.
• See “Pump Theory” on page 995.
• See “Valve Theory” on page 1002.
• See “Friction and Minor Losses” on page 1016.
• See “Developing a Surge-Control Strategy” on page 1037.
• See “Engineer’s Reference” on page 1064.
• See “References” on page 1072.

14.1 Acknowledgements
Bentley HAMMER V8i is based on technology originally created by Environmental
Hydraulics Group (GENIVAR), led by Dr. Alan Fok, P.Eng., a designated Hydraulic
Specialist, and assisted by Dr. Sheldon Zemell. Bentley Systems and GENIVAR have
forged a long-term collaboration to support and improve Bentley HAMMER V8i. The
software is intended to represent the latest technology in water hammer analysis and
design. Some of the text in this section is adapted from Chapter 13 of Haestad Press’
Advanced Water Distribution Modeling and Management (AWDM), written by Dr.
Edmundo Koelle, Dr. Thomas Walski, P.E., and the Haestad staff, or extracted from
Alan Fok’s past technical publications and Ph. D. thesis.

RELATED TOPICS

• See “Overview of Hydraulic Transients” on page 961.

• See “Hydraulic Transient Theory” on page 970.

14-960 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

• See “Water System Characteristics” on page 985.

• See “Pump Theory” on page 995.
• See “Valve Theory” on page 1002.
• See “Friction and Minor Losses” on page 1016.
• See “Developing a Surge-Control Strategy” on page 1037.
• See “Engineer’s Reference” on page 1064.
• See “References” on page 1072.

14.2 Overview of Hydraulic Transients

A transient is a temporary flow and pressure condition that occurs in a hydraulic
system between an initial steady-state condition and a final steady-state condition.
When velocity changes rapidly in response to the operation of a flow-control device
(for instance, a valve closure or pump start), the compressibility of the liquid and the
elasticity of the pipeline cause a transient pressure wave to propagate throughout the
system. If the magnitude of this transient pressure wave and the resulting transient
flow variation is great enough and adequate transient-control measures are not in
place, a transient can cause system hydraulic components to fail (for instance, a pipe
burst).

Transient Tip: In general, transients resulting from relatively slow

changes in flow rate are referred to as surges, and those
resulting from more rapid changes in flow rate are
referred to as water hammer events. Surges in
pressurized systems are different than tidal or storm
surges, flood waves, or dam breaks, which can occur in
open-water bodies. A water hammer wave travels much
faster in a pressurized system and it can burst even the
strongest pipes. In general engineering practice, the
terms surge, transient, hammer, and water hammer are
synonymous.

Transients can occur in pressurized systems conveying any fluid, including the
following:

• Water (raw or treated) systems—transmission lines including booster stations,

low-head pumps and piping in water treatment plants, or high-lift pump stations
and connected networks or distribution systems with branching and looping pipes.
• Wastewater (sewage) systems—pressurized sewage forcemains, surcharged
sewers flowing by gravity, and sewers that are partially pressurized and partially
open channel.

Bentley HAMMER V8i Edition User’s Guide 14-961

Overview of Hydraulic Transients

• Combined sewers and tunnels—combined sewers under surcharge with deep-

well pump stations, time-varying inflows from surface sewer systems to drop
shafts, and large storage chambers or deep tunnel conveyance or storage systems.
• Hydro power—penstocks, turbines, and tailraces, including spherical valves.
• Slurry or oil pumping—mining slurries and tailings reclaim lines, oil transmis-
sion pipelines, airport refueling systems, and liquefied natural gas (LNG)
pumping.
• Industrial fluid systems—closed loops, heaters, coolers, boilers, steam, and
other water-conveyance or cogeneration systems. This requires a special version
of Bentley HAMMER V8i to track the heat of the fluid. A transient analysis is
critical for operator safety.

Bentley HAMMER V8i has been used extensively to analyze and design water and
wastewater systems, as well as slurry and oil systems. GENIVAR has analyzed steam,
industrial, and cogeneration systems with custom versions and has calculated transient
forces on above-ground anchors.

RELATED TOPICS

• See “History of Solution Methods” on page 962.

• See “Causes of Transient Initiation” on page 964.
• See “Impacts of Transients” on page 967.
• See “Design of Protective Equipment” on page 970.
• See “Acknowledgements” on page 960.
• See “Hydraulic Transient Theory” on page 970.
• See “Water System Characteristics” on page 985.
• See “Pump Theory” on page 995.
• See “Valve Theory” on page 1002.
• See “Friction and Minor Losses” on page 1016.
• See “Developing a Surge-Control Strategy” on page 1037.
• See “Engineer’s Reference” on page 1064.
• See “References” on page 1072.

14.2.1 History of Solution Methods

The study of hydraulic transients is generally considered to have begun with the works
of Joukowsky (1898) and Allievi (1902). The historical development of this subject
makes for good reading (Wood F., 1970). A number of pioneers made breakthrough
contributions to the field, including R. Angus and John Parmakian (1963), who popu-

14-962 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

larized and refined the graphical calculation method. Benjamin Wylie and Victor
Streeter (1993) combined the method of characteristics with computer modeling. The
field of fluid transients is still rapidly evolving worldwide (Brunone et al., 2000;
Koelle and Luvizotto, 1996; Filion and Karney, 2002; Hamam and McCorquodale,
1982; Savic and Walters, 1995; Walski and Lutes, 1994; Wu and Simpson, 2000).

Various methods have been developed to solve transient flow in pipes. These range
from approximate equations to numerical solutions of the nonlinear Navier-Stokes
equations:

• Arithmetic method—Assumes that flow stops instantaneously (in less than the
characteristic time, 2 L/a), cannot handle water column separation directly, and
neglects friction (Joukowski, 1898; Allievi, 1902).
• Graphical method—Neglects friction in its theoretical development but includes
a means of accounting for it through a correction (Parmakian, 1963). It is time-
consuming and not suited to solving networks or pipelines with complex profiles.
• Design charts—Provides basic design information for simple topologies at a few
specific points (valve closure, pump and pipeline with no protection, surge tank,
or air chamber protection). This method has been replaced by computer programs
(Fok, 1978; Fok, 1980; Fok et al., 1982) based on the transient energy concept and
backed by field and laboratory work (Fok, 1987).
• Wave-plan method—Represents initial transient disturbances as a series of
pulses and tracks reflections at boundaries (Wood et al., 1966).
• Method of Characteristics (MOC)—Most widely used and tested approach,
with support for complex boundary conditions and friction and vaporous cavita-
tion models. Bentley HAMMER V8i uses the MOC. It converts the partial differ-
ential equations (PDEs) of continuity and momentum (e.g., Navier-Stokes) into
ordinary differential equations that are solved algebraicially along lines called
characteristics. An MOC solution is exact along characteristics, but friction,
vaporous cavitation, and some boundary representations introduce errors in the
results (Gray, 1953; Streeter and Lai, 1962; Elansary, Silva, and Chaudhry, 1994).

Haestad Press’ 2002 Advanced Water Distribution Modeling and Management docu-
ments other less-common methods. Transients have also been studied using:

• Laboratory Models—A scale model can be built to reproduce transients

observed in a prototype (real) system, typically for forensic or steam system
investigations. As a design method, this approach is limited by model scale effects
and by very high costs. However, models have provided invaluable basic research
data on vaporous cavitation and vortex shedding (St. Anthony Falls) and transient
friction (Perugia, Italy).
• Field Tests—Field tests can provide key modeling parameters such as the pres-
sure-wave speed or pump inertia. Advanced flow and pressure sensors equipped
with high-speed data loggers make it possible to capture fast transients, down to 5
milliseconds. Methods such as inverse transient calibration and leak detection use

Bentley HAMMER V8i Edition User’s Guide 14-963

Overview of Hydraulic Transients

such data. Like all tests, however, data are obtained at a finite number of locations
and generalizing the findings requires assumptions, with uncertainties spread
across the system. At best, tests provide local data and a feel for the systemwide
response. At worst, tests can lead to physically doubtful conclusions limited by
the scope of the test program.

Neither laboratory models nor field testing can substitute for the careful and correct
application of a proven hydraulic transient computer model, such as Bentley
HAMMER V8i.

The extended-period simulation (EPS) capability of models such as WaterCAD or

WaterGEMS does not consider momentum, and is therefore incapable of analyzing
hydraulic transients. Such simulations are sufficient to analyze hydraulic systems that
undergo velocity and pressure changes slowly enough that inertial forces are insignifi-
cant. If a system undergoes large changes in velocity and pressure in short time
periods, then transient analysis is required.

RELATED TOPICS

• See “Causes of Transient Initiation” on page 964.

• See “Impacts of Transients” on page 967.
• See “Design of Protective Equipment” on page 970.

14.2.2 Causes of Transient Initiation

The cause of a hydraulic transient is any sudden change in the fluid itself or any
sudden change at the pressurized system’s boundaries, including:

• Changes in fluid properties—such as depressurization due to the sudden

opening of a relief valve, a propagating pressure pulse, heating or cooling in
cogeneration or industrial systems, mixing with solids or other liquids (may affect
fluid density, specific gravity, and viscosity), formation and collapse of vapor
bubbles (cavitation), and air entrainment or release from the system (at air vents
and/or due to pressure waves).
• Changes at system boundaries—such as rapidly opening or closing a valve, pipe
burst (due to high pressure) or pipe collapse (due to low pressure), pump start/
shift/stop, air intake at a vacuum breaker, water intake at a valve, mass outflow at
a pressure-relief valve or fire hose, breakage of a rupture disk, and hunting and/or
resonance at a control valve.

14-964 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Sudden changes such as these create a transient pressure pulse that rapidly propagates
away from the disturbance, in every possible direction, and throughout the entire pres-
surized system. If no other transient event is triggered by the pressure wave fronts,
unsteady-flow conditions continue until the transient energy is completely damped
and dissipated by friction.

The majority of transients in water and wastewater systems are the result of changes at
system boundaries, typically at the upstream and downstream ends of the system or at
local high points. Consequently, you can reduce the risk of system damage or failure
with proper analysis to determine the system’s default dynamic response, design
protection equipment to control transient energy, and specify operational procedures
to avoid transients. Analysis, design, and operational procedures all benefit from
computer simulations with Bentley HAMMER V8i.

The three most common causes of transient initiation, or source devices, are all
moving system boundaries.

H.G
.L.
H.G.L. H.G.L.
Reservoir

Penstock
Governor
Pump Check
Generator Valve
Valve ow
Fl F lo
Sump w
Gate Tailrace
Turbine

Pump Turbine Valve

Figure 14-1: Common Causes of Hydraulic Transients

Pumps—A pump’s motor exerts a torque on a shaft that delivers energy to the pump’s
impeller, forcing it to rotate and add energy to the fluid as it passes from the suction to
the discharge side of the pump volute. Pumps convey fluid to the downstream end of a
system whose profile can be either uphill or downhill, with irregularities such as local
high or low points. When the pump starts, pressure can increase rapidly. Whenever
power sags or fails, the pump slows or stops and a sudden drop in pressure propagates
downstream (a rise in pressure also propagates upstream in the suction system).

Turbines—Hydropower turbines are located at the downstream end of a conduit, or

penstock, to absorb the moving water’s energy and convert it to electrical current.
Conceptually, a turbine is the inverse of a pump, but very few pumps or turbines can
operate in both directions without damage. If the electrical load generated by a turbine
is rejected, a gate must rapidly stop flow, resulting in a large increase in pressure,
which propagates upstream (in the penstock).

Bentley HAMMER V8i Edition User’s Guide 14-965

Overview of Hydraulic Transients

Valves—A valve can start, change, or stop flow very suddenly. Energy conversions
increase or decrease in proportion to a valve’s closing or opening rate and position, or
stroke. Orifices can be used to throttle flow instead of a partially open valve. Valves
can also allow air into a pipeline and/or expel it, typically at local high points.
Suddenly closing a flow-control valve (with piping on both sides) generates transients
on both sides of the valve, as follows:

• Water initially coming towards the valve suddenly has nowhere to go. As water
packs into a finite space upstream of the valve, it generates a high-pressure pulse
that propagates upstream, away from the valve.
• Water initially going away from the valve cannot suddenly stop, due to its inertia
and, since no flow is coming through the valve to replace it, the area downstream
of the valve may “pull a vacuum,” causing a low-pressure pulse to propagate
downstream.

The similarity of the transient conditions caused by different source devices provides
the key to transient analysis in a wide range of different systems: understand the initial
state of the system and the ways in which energy and mass are added or removed from
it. This is best illustrated by an example for a typical pumping system (see “Figure 14-
2: Typical Locations where Transient Pulses Initiate”on page 14-967):

1. A pump (upstream source device) starts up from the static HGL and accelerates
flow until its input energy reaches a dynamic equilibrium with friction at the
steady HGL.
2. A power failure occurs and the pump stops supplying hydraulic energy; therefore,
the HGL drops rapidly at the pump and a low-pressure pulse propagates down-
stream towards the reservoir. Subatmospheric pressures can occur at the high
point (minimum transient head), but the reservoir maintains downstream pressure
at its liquid level by accepting or supplying liquid as required, often several times
during the transient event.

Note: As the HGL drops to the pipeline elevation, a vacuum breaker

valve can be installed at the local high point to supply or expel
air from the system in a manner analogous to the reservoir. This
tends to maintain atmospheric pressure at the valve, minimizing
subatmospheric pressures when air is admitted and often
reducing high pressures when air is expelled.

3. The pressure pulse is reflected toward the pump, but it encounters a closed check
valve (designed to protect the pump against high pressures) that reflects the pulse
as a high pressure toward the reservoir again (maximum transient head).
4. Friction eventually attenuates the transient energy and the system reaches a final
steady state: static HGL, in this case, since pumping has stopped and flow at the
reservoir is zero.

14-966 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

The foregoing discussion illustrates the typical concepts to consider when analyzing
hydraulic transients. Computer models are an ideal tool for tracking momentum,
inertia, and friction as the transient evolves, and for correctly accounting for changes
in mass and energy at boundaries. Note that transients propagate throughout the entire
pressurized system.

Maximum Transient Head

Friction ( hf ) Reservoir
Steady HGL

Static HGL
ad
i en t He
ns
Tra Downstream
High Point
im um
Pipeline
Devices Min Source Devices

Upstream Source Devices

Figure 14-2: Typical Locations where Transient Pulses Initiate

Note: Devices can be a pump, valve, or other operable equipment.

RELATED TOPICS

• See “History of Solution Methods” on page 962.

• See “Impacts of Transients” on page 967.
• See “Design of Protective Equipment” on page 970.

14.2.3 Impacts of Transients

Hydraulic transients can result in the following physical phenomena:

High or low transient pressures—These can be applied to piping and joints in a frac-
tion of a second and they often alternate from high to low and vice versa. High pres-
sures resulting from the collapse of vapor pockets are analogous to cavitation in a
pump: they primarily accelerate wear and tear, but they can burst a pipe by over-
coming its surge-tolerance limit. Subatmospheric or even full-vacuum pressures can
combine with overburden and groundwater pressures to collapse pipes by buckling
failure. Groundwater can also be sucked into the piping.

Bentley HAMMER V8i Edition User’s Guide 14-967

Overview of Hydraulic Transients

High transient flows—These can result in significant degradation of water quality as

deposits and rust are loosened and entrained at high velocities. This is aggravated
whenever flows reverse direction during a transient event. High-velocity flows also
exert forces at pipe bends.

Transient forces—Rapidly moving pressure pulses result in temporary, but very

significant, transient forces at bends and other fittings, which can cause joints to
move. Even for buried pipe, repeated deflections combined with pressure cycling can
wear out joints and result in leakage or outright failure. Thrust blocks are typically
sized for steady-state forces plus a safety factor—not transient forces—and typically
resist thrust in only one direction. In pump stations, low pressures on the downstream
side of a slow-closing check valve may result in a very fast closure known as valve
slam. A 10 psi (69 kPa) pressure differential across the face of a 16 in. (400 mm)
valve can result in impact forces in excess of 2,000 lb. (8,900 N).

Column separation—Water columns typically separate at abrupt changes in profile

or local high points due to subatmospheric pressure. The space between the water
columns is filled either by the formation of vapor (e.g., steam at ambient temperature)
or air, if it is admitted to the pipeline through a valve. With vaporous cavitation, a
vapor pocket forms and then collapses when the pipeline pressure increases as more
flow enters the region than leaves it. Collapse of the vapor pocket can cause a
dramatic high-pressure transient if the water column rejoins very rapidly, which can,
in turn, cause the pipeline to rupture. Vaporous cavitation can also result in pipe
flexure that damages pipe linings. High pressures can also result when air is expelled
rapidly from a pipeline, which tends to repeat more times than when a vapor pocket
collapses.

Vibrations—Rapid transient pressure fluctuations can result in vibrations or reso-

nance that can cause even flanged pipes and fittings (bend and elbows) to dislodge,
resulting in a leak or rupture. In fact, the cavitation that commonly occurs with water
hammer can—as the phenomenon’s name implies—release energy that sounds like
someone pounding on the pipe with a hammer.

Hydraulic transient impacts can be expected at the following locations:

• Check valves at pumps as flow reverses from the downstream reservoir to the
pump.
• Reservoir inlet valves, altitude valves at elevated tanks, or isolation valves if they
close rapidly.
• Local high points where vapor or air pockets collapse.
• Dead ends as they reflect incoming pulses with up to double the wave amplitude.
• Pipe bursts, where flow leaving the system may exceed the steady-state flow (in
systems with high static head compared to the dynamic head).

14-968 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

• Surge-control devices if not properly designed or operated.

• Changes in pipeline profile or alignment where transient forces may be signifi-
cant.

Hydraulic transient impacts can be expected to occur at the following times:

• Pump startup before transient energy has decayed sufficiently or before all air has
been removed from the line.
• Pump emergency shutdown which may result in water-column separation and
severe transient pressures due to vapor or air pocket formation and collapse.
• Pump shifting during normal operations, which may result in frequent pressure
shocks.

Environmental concerns due to hydraulic transients include:

• Sewage spills or leaks to soils or groundwater during high transient pressures.

• Drinking water contamination due to air, debris, or groundwater intrusion during
subatmospheric pressures.

Hydraulic transients can result in the following infrastructure management issues and
risks:

• Premature aging and wear of valves, pipes, and pumps due to high magnitude and/
or frequent pressure shocks.
• Pump cavitation due to low suction head and pipe lining damage due to vacuum
conditions.
• Rapid pump or valve operation by major water users (e.g., a food production
factory) may accelerate the pipe material and anchor fatigue in their vicinity.
• Service interruptions due to repair and maintenance of infrastructure.

RELATED TOPICS

• See “History of Solution Methods” on page 962.

• See “Causes of Transient Initiation” on page 964.
• See “Design of Protective Equipment” on page 970.

Bentley HAMMER V8i Edition User’s Guide 14-969

Hydraulic Transient Theory

14.2.4 Design of Protective Equipment

For typical water-distribution main installation, transient analysis may be necessary

even if velocities are low. System looping and service connections may amplify tran-
sient effects and need to be studied carefully. Transient analysis should be performed
for large, high-value pipelines, especially those with pump stations.

A complete transient analysis, in conjunction with other system design activities,

should be performed during the initial design phases of a project. Normal flow-control
operations and predicable emergency operations should, of course, be evaluated
during the design. However, uncommon flow-control activities can occur once the
system is in operation, making it important that all factors that could affect the integ-
rity of the system be considered.

RELATED TOPICS

• See “History of Solution Methods” on page 962.

• See “Causes of Transient Initiation” on page 964.
• See “Impacts of Transients” on page 967.

14.3 Hydraulic Transient Theory

In pressurized networks, a steady-state condition or transient event at one point in the
system can affect all other parts of the system. Consequently, computer models must
consider every pipe that is directly connected to a pressurized system, regardless of
administrative or political boundaries.

While a systemwide approach increases the information an engineer must consider,

the physical principles that govern the behavior of the network provide a unified
conceptual basis for tackling the problem. Two fundamental laws apply to steady-
state, EPS or transient models:

• Conservation of mass—also expressed as the continuity equation, which states

that matter cannot be created or destroyed.
• Conservation of energy—also expressed as the momentum equation, which
states that energy cannot be created or destroyed.

The best way to arrive at sound, physically meaningful conclusions and recommenda-
tions is to keep these principles in mind whenever you interpret the results of a
hydraulic model. Bentley HAMMER V8i makes this easy by tracking the mass inflow
or outflow of air or water at any location and by plotting or animating the resulting
total energy at any point and time in the system.

14-970 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

RELATED TOPICS

• See “Conservation of Energy” on page 971.

• See “Governing Equations for Steady-State Flow” on page 972.
• See “Governing Equations for Unsteady (or Transient) Flow” on page 975.
• See “Rigid Column Theory” on page 980.
• See “Rigid Column versus Elastic Theory” on page 982.
• See “Elastic Theory” on page 984.
• See “Acknowledgements” on page 960.
• See “Overview of Hydraulic Transients” on page 961.
• See “Water System Characteristics” on page 985.
• See “Pump Theory” on page 995.
• See “Valve Theory” on page 1002.
• See “Friction and Minor Losses” on page 1016.
• See “Developing a Surge-Control Strategy” on page 1037.
• See “Engineer’s Reference” on page 1064.
• See “References” on page 1072.

14.3.1 Conservation of Energy

The first law of thermodynamics states that for any given system and time interval, the
change in total energy is equal to the difference between the heat transferred to the
system and the work done by the system on its surroundings. In hydraulic terms,
changes in the total energy of a fluid do not consider changes in its internal (molec-
ular) forms of energy, such as electrical and chemical energy, because these are
usually relatively small.

In hydraulic terms, energy is often represented as energy per unit weight, resulting in
units of length. At any point in a hydraulic system, the total energy of a fluid consists
of three components that can be expressed as an equivalent elevation, or head:

Pressure Head: p/

Elevation Head: z

Velocity Head: V2/2g

Bentley HAMMER V8i Edition User’s Guide 14-971

Hydraulic Transient Theory

Where: p = pressure (N/m2, lb/ft2)

 = specific weight (N/m3, lb/ft3)

z = elevation (m, ft)
V = velocity (m/s, ft/sec.)
g = gravitational acceleration constant (m/s2, ft/sec.2)

Converting the total energy to an equivalent head allows it to be plotted on the same
scale as elevation for any point in the system, either on pipeline profiles or maps,
allowing engineers to visualize changes as slopes or contour lines, respectively. This
gives a better feel for the resulting behavior of the system, especially when reviewing
the results of an EPS or transient analysis. Further, the difference between this energy
level and the pipeline elevation is equal to the total gauge pressure.

RELATED TOPICS

• See “Governing Equations for Steady-State Flow” on page 972.

• See “Governing Equations for Unsteady (or Transient) Flow” on page 975.
• See “Rigid Column Theory” on page 980.
• See “Rigid Column versus Elastic Theory” on page 982.
• See “Elastic Theory” on page 984.

14.3.2 Governing Equations for Steady-State Flow

Steady-state models, such as WaterCAD or WaterGEMS, are capable of two modes of

analysis: steady state and extended period simulation (EPS). EPS solves a series of
consecutive steady states using a gradient algorithm and accounting for mass in reser-
voirs and tanks (e.g., net inflows and storage). Both methods assume the system
contains an incompressible fluid, so the total volumetric or mass inflows at any node
must equal the outflows, less the change in storage.

In addition to pressure head, elevation head, and velocity head, there may also be head
added to the system, for instance, by a pump, and head removed from the system by
friction. These changes in head are referred to as head gains and head losses, respec-
tively. Balancing the energy across two points in the system yields the energy or
Bernoulli equation for steady-state flow:

P1 V2 P V2
+ z1 + 1 + h p = 2 + z2 + 2 + hL
g 2g g 2g

14-972 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Where: p = pressure (N/m2, lb/ft2)

 = specific weight (N/m3, lb/ft3)

z = elevation at the centroid (m, ft)
V = velocity (m/s, ft/sec.)

g = gravitational acceleration constant (m/s2, ft/sec.2)

hp = head gain from a pump (m, ft)

hL = combined headloss (m, ft)

The components of the energy equation can be combined to express two useful quanti-
ties, the hydraulic grade and the energy grade:

• 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 hydraulic 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 figure.

Figure 14-3: EGL and HGL

RELATED TOPICS

• See “Conservation of Energy” on page 971.

• See “Governing Equations for Unsteady (or Transient) Flow” on page 975.

Bentley HAMMER V8i Edition User’s Guide 14-973

Hydraulic Transient Theory

• See “Rigid Column Theory” on page 980.

• See “Rigid Column versus Elastic Theory” on page 982.
• See “Elastic Theory” on page 984.

Conservation of Mass at Steady State

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, gives the continuity equation:

QIN D t = QOUT D t + D Vs

Where: QIN = total flow into the node (m3/s, cfs)

QOUT = total demand at the node (m3/s, cfs)
V S = change in storage volume (m3, ft3)
t = change in time (sec.)

RELATED TOPICS

• See “Conservation of Energy at Steady State” on page 974.

• See “Governing Equations for Steady-State Flow” on page 972.

Conservation of Energy at Steady State

The conservation of energy principle states that the head losses through the system
must balance at each point. For pressure networks, this means that the total head loss
between any two nodes in the system must be the same regardless of what path is
taken between the two points. The sign of the head loss must be 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).

The same basic principle can be applied to any path between two points. The
combined head loss around a loop must be zero to achieve the same hydraulic grade as
at the beginning.

RELATED TOPICS

• See “Conservation of Mass at Steady State” on page 974.

• See “Governing Equations for Steady-State Flow” on page 972.

14-974 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

14.3.3 Governing Equations for Unsteady (or Transient) Flow

Hydraulic transient flow is also known as unsteady fluid flow. During a transient anal-
ysis, the fluid and system boundaries can be either elastic or inelastic:

• Elastic theory describes unsteady flow of a compressible liquid in an elastic

system (e.g., where pipes can expand and contract). Bentley HAMMER V8i uses
the Method of Characteristics (MOC) to solve virtually any hydraulic transient
problems.
• Rigid-column theory describes unsteady flow of an incompressible liquid in a
rigid system. It is only applicable to slower transient phenomena.

Both branches of transient theory stem from the same governing equations. Bentley
HAMMER V8i uses the more advanced elastic theory systemwide for virtually every
simulation, but it can also switch to the faster rigid-column theory (in specific reaches
and for special applications) to reduce execution time, as discussed in “Rigid-Column
Simulation” on page 7-255.

The continuity equation and the momentum equation are needed to determine V and p
in a one-dimensional flow system. Solving these two equations produces a theoretical
result that usually corresponds quite closely to actual system measurements if the data
and assumptions used to build the numerical model are valid. Transient analysis
results that are not comparable with actual system measurements are generally caused
by inappropriate system data (especially boundary conditions) and inappropriate
assumptions.

Continuity Equation for Unsteady Flow

The continuity equation for a fluid is based on the principle of conservation of mass.
The general form of the continuity equation for unsteady fluid flow is as follows:

¶H dH a 2 ¶V
+V + =0
¶t ¶x g ¶x

Where: a = pressure wave speed

V = average velocity in the pipe, parallel to the x-axis
H = hydraulic grade line or HGL

The second term on the left-hand side of the preceding equation is small relative to
other terms and is typically neglected, yielding the following simplified continuity
equation, as used in the majority of unsteady models:

Bentley HAMMER V8i Edition User’s Guide 14-975

Hydraulic Transient Theory

¶H a 2 ¶V
+ =0
¶t g ¶x

RELATED TOPICS

• See “Momentum Equation for Unsteady Flow” on page 976.

• See “Method of Characteristics (MOC)” on page 977.
• See “Governing Equations for Unsteady (or Transient) Flow” on page 975.

Momentum Equation for Unsteady Flow

The equations of motion for a fluid can be derived from the consideration of the forces
acting on a small element, or control volume, including the shear stresses generated by
the fluid motion and viscosity. The three-dimensional momentum equations of a real
fluid system are known as the Navier-Stokes equations. Since flow perpendicular to
pipe walls is approximately zero, flow in a pipe can be considered one-dimensional,
for which the continuity equation reduces to:

¶V ¶V ¶H fV V
+V +g + =0
¶t ¶x ¶x 2D

Where: f = Darcy-Weisbach friction coefficient

= inside diameter of the pipe (or equivalent
D
dimension)
V = velocity of fluid
 = specific weight of the fluid

The last term on the left-hand side represents friction losses in the direction of flow:

fV V
2D

The first term on the left-hand side is the local acceleration term, while the second
term represents the convective acceleration, proportional to the spatial change of
velocity at a point in the fluid, which is often neglected to yield the following simpli-
fied equation:

14-976 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

¶V ¶H fV V
+g + =0
¶t ¶x 2D

Equations and , though rigorous and explicit, incorporate the following assumptions,
which are often not strictly valid in real water systems:

• Fluid is homogeneous—water typically incorporates a small amount of dissolved

and/or entrained air whose exact percentage changes along the system.
• Fluid and pipe wall are linearly elastic—in aging water pipes whose shape has
become noncircular and whose integrity may be compromised by cracks (virtually
every water system leaks), fluid may escape the system rather than being
compressed and deformations imposed on piping may not be entirely recovered.
• Flow is one-dimensional—this assumption has been shown to be inaccurate at
tees in suction lines. Minor losses result from three-dimensional vorticity.
• Pipe flows full—even in pressurized systems, air or vapor can accumulate at local
high points, forcing the water to accelerate and pass underneath it. In extreme
cases, this phenomenon can significantly diminish pumping efficiency (e.g., vapor
lock).
• Average velocity is used—experiments show that the velocity distribution
changes across a cross section during transient events, even for flow in straight
pipes.
• Viscous losses similar to steady state—emerging research in transient or
unsteady friction is challenging this assumption.

Nevertheless, these assumptions are essentially valid for the majority of the time in the
majority of water systems. Solving these equations yields accurate numerical simula-
tion results in most cases.

RELATED TOPICS

• See “Continuity Equation for Unsteady Flow” on page 975.

• See “Method of Characteristics (MOC)” on page 977.
• See “Governing Equations for Unsteady (or Transient) Flow” on page 975.

Method of Characteristics (MOC)

Bentley HAMMER V8i uses the most widely used and tested method, known as the
Method of Characteristic (MOC), to solve governing equations and for unsteady pipe
flow. Using the MOC, the two partial differential equations can be transformed to the
following two pairs of equations:

Bentley HAMMER V8i Edition User’s Guide 14-977

Hydraulic Transient Theory

g dH dV fV V
+ + =0
a dt dt 2D C+
dx
= +a
dt

g dH dV fV V
- + + =0
a dt dt 2D C-
dx
= -a
dt

Equations and cannot be solved analytically, but they can be expressed graphically in
space-time as characteristic lines (or curves), called characteristics, that represent
signals propagating to the right (C+) and to the left (C-) simultaneously and from each
location in the system, as shown in the figure below. At each interior solution point,

signals arrive from the two adjacent points simultaneously. A linear combination of H
and V is invariant along each characteristic if friction losses are neglected; therefore,
H and V can be obtained exactly at solution points. With head losses concentrated at
solution points and the assumption that friction is small, an iterative procedure is used
in conjunction with MOC to advance the solution in time.

14-978 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Transient modeling essentially consists of solving these equations, for every solution
point and time step, for a wide variety of boundary conditions and system topologies.
To obtain a general computer model like Bentley HAMMER V8i, the following addi-
tional capabilities are required:

• Boundary conditions must also be expressed as algebraic and/or differential equa-

tions based on their physical properties. This must be done for every hydraulic
element in the model and solved along with the characteristic equations.
• Equations of state are incorporated to model vaporous cavitation, whereby the
fluid can flash into vapor at low pressures, for example. The assumptions incorpo-
rated into Bentley HAMMER V8i are described in “Water Column Separation and
Vapor Pockets” on page 7-260.
• The length of computational reaches must be set to achieve sufficient accuracy
without resulting in too small a time step and an excessively long execution time.
Bentley HAMMER V8i automatically sets an optimal time step based on pipe
lengths, wave speeds, and overall system size, so you can get your model results
faster.
• Friction losses are assumed to be concentrated at solution points. Different models
can be implemented, ranging from steady-state to quasi-steady to unsteady (tran-
sient) friction.
Bentley HAMMER V8i has been used for over 15 years on a large number of water
and wastewater projects, evolving during this time to add new boundary conditions
while preserving ease of use and accuracy. Thus, it is a proven model with many
“electron miles” and a solid track record of matching field observations (when avail-
able). It has also been used to model other fluids and tackle problems in other industry
sectors, adding to its generality and confirming its robust algorithms.

A derivation of the complete equations for transient analysis (using elastic theory) is
beyond the scope of this manual, but it can be found in other references, such as
Almeida and Koelle (1992) and Wylie and Streeter (1993).

The derivation for incompressible flow and rigid pipe walls is provided in the next
section. The derivation of the wave celerity and pressure-wave speed for compressible
flow and elastic system boundaries is provided next.

RELATED TOPICS

• See “Continuity Equation for Unsteady Flow” on page 975.

• See “Momentum Equation for Unsteady Flow” on page 976.
• See “Governing Equations for Unsteady (or Transient) Flow” on page 975.

Bentley HAMMER V8i Edition User’s Guide 14-979

Hydraulic Transient Theory

14.3.4 Rigid Column Theory

The rigid model assumes that the pipeline is not deformable and the liquid is incom-
pressible; therefore, system flow-control operations affect only the inertial and fric-
tional aspects of transient flow. Given these considerations, it can be demonstrated
using the continuity equation that any system flow-control operations results in instan-
taneous flow changes throughout the system, and that the liquid travels as a single
mass inside the pipeline, causing a mass oscillation. If liquid density and pipe cross
section are constant, the instantaneous velocity is the same in all sections.

These rigidity assumptions result in an easy-to-solve ordinary differential equation;

however, its application is limited to the analysis of surge. Newton’s second law of
motion is sufficient to determine the dynamic hydraulic of a rigid water body during
the mass oscillation:

dH = f (L/D)(V|V|/2g) + (L/g) (dV/dt)

Where: dH = change in head (m, ft)

If a steady-state flow condition is established—that is, if dV/dt = 0—then this Equa-

tion equation simplifies to the Darcy-Weisbach formula for computation of head loss
over the length of the pipeline. However, if a steady-state flow condition is not estab-
lished because of flow control operations, then three unknowns need to be determined:
H1(t) (the left-hand head), H2(t) (the right-hand head), and V(t) (the instantaneous
flow velocity in the conduit). To determine these unknowns, the engineer must know
the boundary conditions at both ends of the pipeline.

Using the fundamental rigid-model equation, the hydraulic grade line can be estab-
lished for each instant. The slope of this line indicates the head loss between the two
ends of the pipeline, which is also the head necessary to overcome frictional losses
and inertial forces in the pipeline. For the case of flow reduction caused by a valve
closure (dQ/dt < 0), the slope is reduced. If a valve is opened, the slope increases,

14-980 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

potentially allowing vacuum conditions to occur. The change in slope is directly

proportional to the flow change. Generally, the maximum transient head envelope
calculated by rigid water column theory (RWCT) is a straight line, as shown in the
following figure.

Maximum Transient Head Envelope (Elastic)

Maximum Head
(Rigid)
Reservoir
Steady-State HGL

id)
Head (Rig
Minimum

Minimum Transient Head Envelope (Elastic)

Pipeline

Pump Station + Transient Energy Calculated by Elastic

Water Column Theory (EWCT)
Reservoir Transient Energy Calculated by Rigid
Water Column Theory (RWCT)

Figure 14-4: Static and Steady HGL versus Rigid and Elastic Transient
Head Envelopes

The rigid model has limited applications in hydraulic transient analysis because the
resulting equations do not accurately model pressure waves caused by rapid flow-
control operations. The rigid model applies to slower surge or mass oscillation tran-
sients, as defined in “Wave Propagation and Characteristic Time” on page 14-989.
HAMMER only utilizes rigid column theory under certain conditions (see “Extended
CAV Method”).

RELATED TOPICS

• See “Conservation of Energy” on page 971.

• See “Governing Equations for Steady-State Flow” on page 972.
• See “Governing Equations for Unsteady (or Transient) Flow” on page 975.
• See “Elastic Theory” on page 984.

Bentley HAMMER V8i Edition User’s Guide 14-981

Hydraulic Transient Theory

14.3.5 Rigid Column versus Elastic Theory

Prior to the widespread use of computers, the subject of rigid water column-theory
was very popular. Substantial effort was devoted by numerous researchers and engi-
neers to improve its accuracy and to determine the range of its application. “Figure 14-
5: When to Use Elastic versus Rigid Column Theory for a Valve Closure”on page 14-
983 is a dimensionless plot of valve closure time (divided by half the characteristic
time, L/a) versus the ratio of initial head to transient head in a frictionless (or very low
friction) system. The graph shows that different researchers, beginning in 1933,
proposed various criteria to determine when an elastic solution is necessary and when
a rigid-column solution is sufficiently accurate.

The thick black lines were obtained from computer simulations using both methods
and showing the level of error resulting from using RWCT instead of EWCT (Fok,
1987). The error resulting from RWCT instead of EWCT is shown graphically in
“Figure 14-5: When to Use Elastic versus Rigid Column Theory for a Valve

14-982 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Closure”on page 14-983. EWCT correctly accounts for fluid compressibility, resulting
in a significantly higher estimate of the maximum transient head than RWCT. Bentley
HAMMER V8i solves every problem using elastic theory and the MOC for maximum
accuracy.

Symbols
g = gravitational acceleration
(m/s)
ho = head loss across valve (m)
a = pressure wave speed (m/s)
Fok’s boundary Vo= initial flow velocity through
valve (m/s)
(1987) between tq = time of valve closure (s)
l = pipe length (m)
EWCT and RWCT
using HAMMER

20 10 5 2.5 % of ERROR
Ho = (gho/avo)

)
,74
73
19
VALVE HEAD,

(
CT
RW
’s
od
Wo

TIME of VALVE CLOSURE T q = (tq/l/a)

Figure 14-5: When to Use Elastic versus Rigid Column Theory for a Valve
Closure

Bentley HAMMER V8i Edition User’s Guide 14-983

Hydraulic Transient Theory

RELATED TOPICS

• See “Conservation of Energy” on page 971.

• See “Governing Equations for Steady-State Flow” on page 972.
• See “Governing Equations for Unsteady (or Transient) Flow” on page 975.
• See “Elastic Theory” on page 984.

14.3.6 Elastic Theory

The elastic model assumes that changing the momentum of the liquid causes expan-
sion or compression of the pipeline and liquid, both assumed to be linear-elastic. Since
the liquid is not completely incompressible, its density can change slightly during the
propagation of a transient pressure wave. The transient pressure wave will have a
finite velocity that depends on the elasticity of the pipeline and of the liquid as
described in “Celerity and Pipe Elasticity” on page 14-985.

In 1898, Joukowski established a theoretical relationship between pressure and

velocity change during a transient flow condition. In 1902, Allievi independently
developed a similar elastic relation and applied it to a uniform valve closure. The
elastic theory developed by these two pioneers is fundamental to the field of
hydraulic transients. The combined elasticity of both the water and the pipe walls is
characterized by the pressure wave speed, a. This relation is a simplified form of the
equation (see equation ) applicable to an instantaneous stoppage of velocity.

(H – Ho) = –a / g (V – Vo)

Where: o = denotes initial conditions.

For an instantaneous valve closure or stoppage of flow, the upsurge pressure (H–Ho) is
known as the “Joukowski head.” Given that a is roughly 100 times as large as g, a 1
ft./sec. (0.3 m/s) change in velocity can result in a 100 ft. (30 m) change in head.
Because changes in velocity of several feet or meters per second can occur when a
pump shuts off or a hydrant or valve is closed, it is easy to see how large transients can
occur readily in water systems.

The mass of fluid that enters the part of the system located upstream of the valve
immediately after its sudden closure is accommodated through the expansion of the
pipeline due to its elasticity and through slight changes in fluid density due to its
compressibility. This equation does not strictly apply to the drop in pressure down-
stream of the valve, if the valve discharges flow to the atmosphere.

RELATED TOPICS

• See “Conservation of Energy” on page 971.

14-984 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

• See “Governing Equations for Steady-State Flow” on page 972.

• See “Governing Equations for Unsteady (or Transient) Flow” on page 975.
• See “Rigid Column versus Elastic Theory” on page 982.

14.4 Water System Characteristics

Haestad Press’ Advanced Water Distribution Modeling and Management describes
many of the topics in this section in greater detail.

RELATED TOPICS

• See “Acknowledgements” on page 960.

• See “Overview of Hydraulic Transients” on page 961.
• See “Hydraulic Transient Theory” on page 970.
• See “Pump Theory” on page 995.
• See “Valve Theory” on page 1002.
• See “Friction and Minor Losses” on page 1016.
• See “Developing a Surge-Control Strategy” on page 1037.
• See “Engineer’s Reference” on page 1064.
• See “References” on page 1072.

14.4.1 Celerity and Pipe Elasticity

The elasticity of any medium is characterized by the deformation of the medium due
to the application of a force. If the medium is a liquid, this force is a pressure force.
The elasticity coefficient (also called the elasticity index, constant, or modulus) is a
physical property of the medium that describes the relationship between force and
deformation.

Thus, if a given liquid mass in a given volume (V) is subjected to a static pressure rise
(dp), a corresponding reduction (dV < 0) in the fluid volume occurs. The relationship
between cause (pressure increase) and effect (volume reduction) is expressed as the
bulk modulus of elasticity (E) of the fluid, as given by:

dp dp
Ev = - =
dV dr
V r

Bentley HAMMER V8i Edition User’s Guide 14-985

Water System Characteristics

Where: Ev = bulk modulus of elasticity

dp = static pressure rise

= incremental change in liquid volume with respect
dV
to initial volume
= incremental change in liquid density with respect
d/
to initial density

A relationship between a liquid’s modulus of elasticity and density yields its charac-
teristic wave celerity:

Ev dp
a= =
r dr

Where: a = characteristic wave celerity of the liquid

The characteristic wave celerity (a) is the speed with which a disturbance moves
through a fluid. Its value is approximately 4,716 ft./sec. (1,438 m/s) for water and
approximately 1,115 ft./sec. (340 m/s) for air.

Injecting a small percentage of small air bubbles can lower the effective wave speed of
the fluid/air mixture, provided it remains well mixed. This is difficult to achieve in
practice, because diffusers may malfunction and air bubbles may come out of suspen-
sion and coalesce or even buoy to the top of pipes and accumulate at elbows, for
example.

In 1848, Helmholtz demonstrated that wave celerity in a pipeline varies with the elas-
ticity of the pipeline walls. Thirty years later, Korteweg developed an equation to
determine wave celerity as a function of pipeline elasticity and liquid compressibility.
Bentley HAMMER V8i uses an elastic model formulation that requires the wave
celerity to be corrected to account for pipeline elasticity.

Ev
r
a=
E D
1+ v y
Ee

Where: E = Young’s modulus of elasticity for pipe material

14-986 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Equation is valid for thin walled pipelines (D/e > 40). The factor  depends on pipe-
line support characteristics and Poisson’s ratio. depends on the following:

• Pipe is anchored throughout against axial movement: = 1 – µ2, where µ is

Poisson’s ratio
• Pipe is equipped with functioning expansion joints throughout: = 1 – µ/2
• Pipe is supported only at one end and allowed to undergo stress and strain both
laterally and longitudinally: = 5/4 –  (ASCE, 1975)
For thick-walled pipelines, various theoretical equations have been proposed to
compute celerity; however, field investigations are needed to verify these equations.
Tables “Table 14-2: Physical Properties of Some Common Pipe Materials”on page 14-
987 and “Table 14-3: Physical Properties of Some Common Liquids”on page 14-988
provide values for various pipeline materials and liquids that are useful to calculate
celerity during transient analysis. “Figure 14-6: Celerity versus Pipe Wall Elasticity
for Various D/e Ratios”on page 14-988 provides a graphical solution for celerity given
pipe-wall elasticity and various diameter/thickness ratios.

Table 14-2: Physical Properties of Some Common Pipe Materials

Young’s Modulus
Poisson’s Ratio,
Material

(109 lbf/ft2) (GPa)

Steel 4.32 207 0.30

Cast Iron 1.88 90 0.25

Ductile Iron 3.59 172 0.28

Concrete 0.42 to 0.63 20 to 30 0.15

Reinforced Concrete 0.63 to 1.25 30 to 60 0.25

Asbestos Cement 0.50 24 0.30

PVC (20oC) 0.069 3.3 0.45

Polyethylene 0.017 0.8 0.46

Polystyrene 0.10 5.0 0.40

Fiberglass 1.04 50.0 0.35

Granite (rock) 1.0 50 0.28

Bentley HAMMER V8i Edition User’s Guide 14-987

Water System Characteristics

Table 14-3: Physical Properties of Some Common Liquids

Bulk Modulus of
Density
Elasticity
Temperature
Liquid
(oC) (slugs/
(106 lbf/ft2) (GPa) (kg/m3)
ft3)

Fresh Water 20 45.7 2.19 1.94 998

Salt Water 15 47.4 2.27 1.99 1,025

1.5 to 1.67 to
Mineral Oils 25 31.0 to 40.0 860 to 890
1.9 1.73

Kerosene 20 27.0 1.3 1.55 800

Methanol 20 21.0 1.0 1.53 790

Figure 14-6: Celerity versus Pipe Wall Elasticity for Various D/e Ratios

14-988 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

For pipes that exhibit significant viscoelastic effects (for example, plastics such as
PVC and polyethylene), Covas et al. (2002) showed that these effects, including creep,
can affect wave speed in pipes and must be accounted for if highly accurate results are
desired. They proposed methods that account for such effects in both the continuity
and momentum equations.

RELATED TOPICS

• See “Wave Propagation and Characteristic Time” on page 989.

• See “Wave Reflection and Transmission in Pipelines” on page 990.
• See “Type of Networks and Pumping Systems” on page 992.
• See “Putting It All Together” on page 994.

14.4.2 Wave Propagation and Characteristic Time

Note: The representative system length, L, can be approximated for a

network by taking the longest path connecting a pump to a
storage element, such as a tank or reservoir.

The pressure wave generated by a flow-control operation propagates with speed a,

reaching the other end of the pipeline in a time interval equal to L/a seconds. The same
time interval is necessary for the reflected wave to travel back to its origin, for a total
of 2 L/a seconds. The quantity 2 L/a is termed the characteristic time for the pipeline.
It is used to classify the relative speed of a maneuver that causes a hydraulic transient.

If a flow-control operation produces a velocity change in a time interval less than or

equal to a pipeline’s characteristic time, the operation is considered “rapid.” Flow-
control operations that occur over an interval longer than the characteristic time are
designated “gradual” or “slow.” The classifications and associated nomenclature are
summarized in the following table for different operation time, Tm.

Table 14-4: Classification of Flow Control Operations Based on System

.

Characteristic Time

Time of Maneuver Operation Classification

TM = 0 Instantaneous

T M  2L  a Rapid

T M  2L a Gradual

T M » 2L a Slow

Bentley HAMMER V8i Edition User’s Guide 14-989

Water System Characteristics

The characteristic time is significant in transient flow analysis because it dictates

which method is applicable for evaluating a particular flow-control operation in a
given system. The rigid model provides accurate results only for surge transients
generated by slow flow-control operations that do not cause significant liquid
compression or pipe deformation. Instantaneous, rapid, and gradual changes must be
analyzed with the elastic model. Bentley HAMMER V8i uses the elastic model by
default to ensure an accurate solution, regardless of the system’s characteristic time.

RELATED TOPICS

• See “Celerity and Pipe Elasticity” on page 985.

• See “Wave Reflection and Transmission in Pipelines” on page 990.
• See “Type of Networks and Pumping Systems” on page 992.
• See “Putting It All Together” on page 994.

14.4.3 Wave Reflection and Transmission in Pipelines

In addition to the equations describing transient flow, it is important to know about the
effect of boundaries—such as tanks, dead ends, and pipe branches—that modify the
effects of hydraulic transient phenomena.

Transient Tip: Hydraulic systems commonly have interconnected

pipelines with differing characteristics, such as material
and diameter. These pipeline segments and connection
points (nodes) define a system’s topology.

When a wave traveling in a pipe and defined by a head pulse Ho comes to a node, it is
transmitted with a head value Hs to all other connected pipes and reflects back to the
initial pipe with a head value Hr. The wave reflection occurring at a node changes the
head and flow conditions in each of the pipes connected to the node.

If the distances between the pipe connections are small, the head at all connections can
be assumed to be the same (that is, the head loss through the node is negligible), and
the transmission factor (s) can be defined as

Ao
2
D Hs a
s= = n o
D Ho Ai
i= 0 ai

14-990 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Where: s = transmission factor (dimensionless)

Hs = head of transmitted wave (ft, m)

Ho = incident head pulse (ft, m)

Ao = incoming pipe area (ft2, m2)

ao = incoming wave speed (ft/sec., m/s)

Ai = area of i-th pipe (ft2, m2)

ai = wave speed of i-th pipe (ft/sec., m/s)

n = number of outgoing pipes

i = pipe number index

In a closed system without friction to dampen transients, transients would persist

indefinitely. However, viscous and friction effects typically cause transients to atten-
uate within seconds to minutes. Bentley HAMMER V8i is an essential tool to keep
track of the transient pressure-wave reflections and the friction and elastic effects
during the simulation, as follows:

• Because friction does exist in an actual system, the potential head change calcu-
lated using the Joukowsky equation underestimates the actual head rise. This
underestimation is due to packing—an additional increase in head occurring at
the valve as the pressure wave travels upstream.
• The small velocity behind the wave front means that the velocity difference across
the wave front is less than Vo, so the pressure change is progressively less than the
potential surge as the wave travels upstream. This effect, which is concurrent with
line packing, is called attenuation or reduction.
• Transient pressure waves are partially transmitted and simultaneously reflected
back at every junction with other pipes, depending on their wave speed and diam-
eter.
Although Bentley HAMMER V8i calculates the proportion of an incoming transient
energy pulse that is transmitted and reflected at each junction node, it is useful to
consider how this phenomenon takes place in a typical hydraulic system using the
relation for the reflection factor:

D Hr
r= = s- 1
D Ho

Bentley HAMMER V8i Edition User’s Guide 14-991

Water System Characteristics

Where: r = reflection factor

Hr = head of reflected wave (ft, m)

Several special cases can be considered, including:

• Pipe connected to a reservoir—In this case, n = 1, s = 0, and r = –1. In other

words, a wave reaching a reservoir reflects with the opposite sign.
• Pipe connected to a dead-end or closed valve—In this case, n = 1, and, through the
derivation of an equation for r similar to Equation , it can be shown that r = 1. In
other words, a wave reflects at a closed extremity of a pipe with the same sign
and, therefore, head amplification occurs at that extremity. If a flow-control oper-
ation causes a negative pressure wave that reaches a closed valve, the wave’s
reflection causes a further reduction in pressure. This transient flow condition can
cause liquid column separation and, in low-head systems, potential pipeline
collapse. At a dead end, the wave is reflected with twice the pressure head of the
incident wave.
• Pipe diameter reduced (celerity increase)—In this case, A1 < A0, and s > 1, so the
head that is transmitted is amplified. For example, if A1 = A0/4 (or D1 = D0/2),
then s = 8/5=1.6 and r = s – 1 = 0.6, and the head transmitted to the smaller pipe-
line is 60 percent greater than the incoming head. The larger pipeline is also
subjected to this head change after the wave partially reflects at the node. If the
diameter is reduced to zero, the junction becomes a dead end.
• Pipe diameter increased (celerity decrease)—In this case, an attenuation of the
incident head occurs at a pipeline diameter increase. The smaller pressure wave is
transmitted to the larger pipeline and, after the reflection, the smaller pipeline is
subjected to the lower final head. At an expansion, the reflected wave has the
opposite sign of the incident wave. In the limit, as the diameter increases indefi-
nitely, the reservoir case is obtained.

RELATED TOPICS

• See “Celerity and Pipe Elasticity” on page 985.

• See “Wave Propagation and Characteristic Time” on page 989.
• See “Type of Networks and Pumping Systems” on page 992.
• See “Putting It All Together” on page 994.

14.4.4 Type of Networks and Pumping Systems

Although an infinite number of network topologies are possible, the possibilities can
be reduced to the following key characteristics:

14-992 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

• Network characteristics—A water system usually consists of several main trans-

mission pipelines (from pumping stations to reservoirs, elevated tanks, or booster
stations) and many branches and loops to distribute water to local water-demand
points.
• Piping characteristics—These include pipeline length (L), diameter (D), rough-
ness (C or f), elevations or profile (based on topography), water levels at suction
and receiving water bodies, flow (Q), pressure head (H) at nodes, and pressure
wave speed (a).
• Pressure wave speed—This varies from as low as 340 m/s to as high as 1,438 m/
s for water in thin-walled plastic pipes to thick steel pipes, respectively. Pressure
wave speed is also affected by pipe installation due to bedding, anchorage, and
soil conditions.
• Modeling complexity—In the past, networks were usually reduced to a few key
water mains, taking the flow distribution, pipeline profiles, and kinetic energy of
the system into consideration. This usually provided conservative results for these
main lines, but the transient energy transmitted from the main lines to the distribu-
tion network (or vice versa) was overlooked. Modern computer models, such as
Bentley HAMMER V8i, can simulate networks with thousands of pipes and
dozens or hundreds of boundary conditions.

For the purpose of transient analysis, pumping systems can be grouped as follows:

• Open pumping system—An open-water system consists of upstream reservoirs,

pump stations, and downstream reservoirs or elevated tanks. Transient pressure-
wave travel is confined to a single system and transient energy cannot be trans-
mitted to another system. With a favorable pipeline profile (e.g., concave
upward), no significant vapor cavity occurs and the water columns do not sepa-
rate. The maximum upsurge pressure seldom rises 50% higher than the steady
pressure head. However, an irregular pipeline profile can result in a large water-
column separation and severe transient pressures. Vapor or air pockets will even-
tually collapse due to flow reversing from the upstream reservoir or tank.
• Closed system—In a closed system, the pump supplies water and maintains
adequate pressure for the whole system. There is neither a reservoir nor a stand-
pipe in the system. Closed systems usually service a small water supply zone.
Pumps employed in a closed system often have flat pump curves that are undesir-
able from a transient perspective because rapid flow alterations can occur. After a
power failure, the downsurge likely results in more vapor cavities than in an open
system, while the upsurge is relatively small in comparison. Upon pump startup,
higher transient pressures can be expected due in part to the greater number of air
cavities that are trapped and remain in the system, and in part due to inherently
rapid flow acceleration. The air trapped at local high points should always be
released.

Bentley HAMMER V8i Edition User’s Guide 14-993

Water System Characteristics

• Boosted system—For some water systems, water may be delivered directly to a

booster pumping station that resupplies water to another system on its discharge
side. Normally, no reservoir or suction well is installed upstream of the booster
pumping station; consequently, the hydraulic performance of one side of the
booster pumping system can be significantly affected by the transient conditions
of the other side. From a hydraulic point of view, all possible combinations of
power failure should be considered, including:
– All the pump stations fail while the booster continues to operate.
– Only the booster fails while all others continue to operate.
– A global power failure occurs at all pumping stations for both systems.

Because of flow continuity, the booster pump stops soon after a power failure in
the upstream system and the resulting transients may be similar to a power failure
at both pumping stations. In cases where the booster pump fails while the
upstream pump continues to operate, a worse transient may result in part of the
water system.

RELATED TOPICS

• See “Celerity and Pipe Elasticity” on page 985.

• See “Wave Propagation and Characteristic Time” on page 989.
• See “Wave Reflection and Transmission in Pipelines” on page 990.
• See “Putting It All Together” on page 994.

14.4.5 Putting It All Together

Prior to performing the calculations of transient flow and head, Bentley HAMMER
V8i surveys the system’s characteristics, considers the various pipe and fluid proper-
ties, and automatically determines an optimal time step. By default, Bentley
HAMMER V8i uses the method of characteristics and short time steps to ensure that
simulation results will be accurate enough to support firm conclusions about the
effects of transients in the system. Bentley HAMMER V8i takes hours of guesswork
about time steps and methodology out of your day, allowing you to focus on inter-
preting and communicating the results to stakeholders.

As a modeler, you need to focus on the following factors for a successful Bentley
HAMMER V8i run:

• Pick the run duration following the guidelines in “Project Management and
Options” on page 4-178.
• Enter the correct liquid properties as described in “Liquid Properties” on page 4-
184.

14-994 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

• Select an advanced friction model if the effects of repeated transient cycling is a

concern, as described in “Selecting the Friction Method” on page 4-185.
• Describe the boundary conditions and other hydraulic elements correctly using the
information provided in “Overview of Hydraulic Element Properties” on page 6-
207.
After a successful run, you need to interpret the results as described in “Reviewing
your Results” on page 3-123. Perhaps you need a few runs to assess the sensitivity of
your results to vapor pressure, elevations, and wave speed if the model predicts
“Water Column Separation and Vapor Pockets” on page 7-260. Finally, even the most
thorough analysis has little value if its conclusions and recommendations are not
communicated clearly and powerfully; review the quick start lessons and the tips
provided in “Reviewing your Results” on page 3-123.

RELATED TOPICS

• See “Celerity and Pipe Elasticity” on page 985.

• See “Wave Propagation and Characteristic Time” on page 989.
• See “Wave Reflection and Transmission in Pipelines” on page 990.
• See “Type of Networks and Pumping Systems” on page 992.

14.5 Pump Theory

This section supplements the discussion of “Rotating Equipment” on page 6-220,
covering the following topics:

• “Pump Fundamentals” on page 6-221

• “Pump Inertia” on page 6-223
• “Specific Speed” on page 6-224
• “First-Quadrant and Four-Quadrant Representations” on page 6-226
• “Variable-Speed Pumps (VSP or VFD)” on page 6-226

The above topics introduced the subject as a means of selecting the correct pump
representation for a particular Bentley HAMMER V8i run. The following sections
focus on theoretical and practical aspects:

• “Pump Characteristics and Behavior” on page 14-996

• “Variable-Speed Pumps” on page 14-1000
• “Constant-Horsepower Pumps” on page 14-1001

Bentley HAMMER V8i Edition User’s Guide 14-995

Pump Theory

RELATED TOPICS

• See “Acknowledgements” on page 960.

• See “Overview of Hydraulic Transients” on page 961.
• See “Hydraulic Transient Theory” on page 970.
• See “Water System Characteristics” on page 985.
• See “Valve Theory” on page 1002.
• See “Friction and Minor Losses” on page 1016.
• See “Developing a Surge-Control Strategy” on page 1037.
• See “Engineer’s Reference” on page 1064.
• See “References” on page 1072.

14.5.1 Pump Characteristics and Behavior

Pumps are an integral part of many pressurized systems. Pumps add energy, or head
gains, to the flow to counteract head losses within the system.

A pump is defined by its curve, which relates the pump head, or the head added to the
system, to the flow rate. This curve indicates the ability of the pump to add head at
different flow rates. To model the behavior of the pump system, additional informa-
tion is needed to find the actual point at which the pump will operate.

14-996 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

The system operating point is based on the point at which the pump curve crosses the
system curve representing the static lift and head losses due to friction and minor
losses (for more information, see “Minor Losses” on page 14-1025). When these
curves are superimposed, the operating point is found at their intersection. This is
shown in the following figure:

Figure 14-7: 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 characteristic curve remains constant. These shifts in the system curve
result in a shifting operating point over time periods ranging from minutes to hours.

At steady state, a pump can be described using a simple curve relating the total
dynamic head (TDH) added to the fluid at every possible flow rate within the pump’s
operating range. Additional curves describe the pump’s suction energy (e.g., its
required net positive suction head or NPSHR) and power requirements at each flow
rate.

From a hydraulic transient perspective, these dynamic variables must be considered,

including power input; rotational speed; and the moment of inertia of the pump,
motor, and shaft (including couplings). Each of these properties can have a
pronounced effect on the behavior of the pump during a surge or after a power failure:

1. Pump inertia—Pumps with a lighter impeller and motor have a small moment of
inertia; they can be accelerated and stopped faster because there is less stored
kinetic energy. The trend has been towards lighter pumps. After a power failure,

Bentley HAMMER V8i Edition User’s Guide 14-997

Pump Theory

low-inertia pumps maintain forward flow for a shorter time and stop sooner. This
results in more-sudden changes in flow and pressures than would occur with
heavier pumps, and consequently in more-severe water hammer.
2. Pump curve shape—Flat pump curves are undesirable from a hydraulic tran-
sient perspective because they can result in a large change in flow rate for a
moderate change in head. This can result in a very rapid decrease in flow during
an emergency shutdown.
3. Dynamic change to the system curve—After a large pipe break or uncontrolled
valve opening, the system head curve can suddenly drop far below its usual head
requirement, so the pump no longer needs to add much (if any) energy to supply
the required flow. In cases such as these, the pump’s run-out head can become
higher than the required static lift. Very large losses in the suction system may
result in cavitation and overspeed conditions, both of which can cause pump wear
and damage. This can be avoided by proper pump selection (steady state) and
controls to shut the pump down and reduce or stop flow during such transients.
4. Dynamic change to the operating point—A shut-off head too close to the high-
head end of the operating range could result in nuisance interruptions of power to
the pump, each of which results in a hydraulic transient due to the emergency
pump shut down (similar to a power failure).
5. Change in NPSHR due to wear or impeller trimming—NPSHR is different for
each turbomachine in a pump station, but manufacturers typically provide this
information. The NPSHR of neighboring pumps can be different from each other.
Further, the manufacturer’s NPSHR curve can become invalid after decades of
wear, poor maintenance, or actual modifications to the impeller. Fortunately,
NPSH can be obtained from field tests. The available NPSHA is determined based
on the reservoir head and losses in the suction system. Pump cavitation occurs if
the NPSH margin, NPSHA – NPSHR is insufficient. Even at incipient cavitation,
an inadequate margin can result in less efficient pumping or even in a breakdown
of the pump curve, whereby a pump may be running but contributing very little
head above a limiting flow. Consult Hydraulic Institute (http://www.pumps.org)
publications for more information on this important issue.

Whenever a pump is forced outside its normal operating range during a hydraulic tran-
sient, vibrations and cavitation may result—even if it does not reach shut-off or run-
out conditions. Reverse spin can force the pump motor (if it is not disconnected) to
generate electricity, rapidly increasing its temperature and possibly damaging the
motor-control circuitry. For these reasons, it is wise to protect pumps against transient
damage by providing suitable discharge-side check valves.

RELATED TOPICS

• See “Variable-Speed Pumps” on page 1000.

• See “Constant-Horsepower Pumps” on page 1001.

14-998 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Specific Speed
If reverse spin is possible, a four-quadrant curve representation can be selected based
on your pump’s specific speed. According to affinity laws, impellers with similar
geometry and streamlines tends to have similar specific speeds.

Transient Tip: 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 HAMMER V8i will output
physically meaningful results provided you select the
correct four-quadrant curve based on your pump’s
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 HAMMER V8i, simply

calculate the specific speed and select the closest available setting in the Specific
Speed field of the pump’s Element Editor. You can calculate your pump’s specific
speed, Ns, using the following equation:

N Q
N s = -----------------
34
H
Where:

Ns is specific speed (rpm)

N is pump rotaional speed (rpm)
Q is flow rate (m3/s or gpm) at the point of best efficiency
H is total head (m or ft) per stage at the point of best efficiency

“Table 14-5: Specific Speeds for Typical Pump Categories in both Unit Systems”on
page 14-1000 shows typical values of specific speed for which an exact four-quadrant
representation is built into Bentley HAMMER V8i. Centrifugal pumps tend to have
lower specific speeds than axial-flow or multi-stage pumps. Few four-quadrant char-
acteristic 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 HAMMER V8i has a built-in check valve immedi-
ately downstream of the pump.

Bentley HAMMER V8i Edition User’s Guide 14-999

Pump Theory

Note: If you need a four-quadrant pump curve but your pump’s

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.

Table 14-5: Specific Speeds for Typical Pump Categories in both

Unit Systems

Unit System Specific Speed, Ns

Centrifugal pumps Axial-Flow Pumps

Multistage pumps
(radial-vane or (mixed-flow or
(axial or mixed-flow)
flange-screw types) flange-screw types)

U.S. Customary 1280 4850 7500

SI Metric 25 94 145

14.5.2 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:

Q1 n1
=
Q2 n2

and

2
h1 n
= 1
h2 Łn2 ł

Where: Q = pump flow rate (m3/s, cfs)

h = pump head (m, ft)
n = pump speed (rpm)

14-1000 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Figure 14-8: Effect of Relative Speed on Pump Curve

RELATED TOPICS

• See “Pump Characteristics and Behavior” on page 996.

• See “Constant-Horsepower Pumps” on page 1001.

14.5.3 Constant-Horsepower Pumps

WaterCAD and WaterGEMS provide many ways to enter pump curves, as described
in “Pump Fundamentals” on page 6-221. Bentley HAMMER V8i allows any pump
curve to be represented as pairs of heads and corresponding flows, interpolating
linearly between these values when required during the simulations. It is therefore
desirable to enter as many line segments as is practical to accurately describe the
pump’s operating range.

Fortunately, Bentley HAMMER V8i automatically imports pump curves. If a multiple

point rating curve was entered in WaterCAD, WaterGEMS, or produced using the
Levenberg-Marquardt Method, as shown in the following equation, an equivalent
multiple-point rating curve is imported automatically into Bentley HAMMER V8i.

Y = A - (B · Q C )

Where: Y = head (m, ft)

Q = discharge (m3/s, cfs)

A, B, C = pump curve coefficients

Bentley HAMMER V8i Edition User’s Guide 14-1001

Valve Theory

RELATED TOPICS

• See “Pump Characteristics and Behavior” on page 996.

• See “Variable-Speed Pumps” on page 1000.

14.6 Valve Theory

Several types of valves are in use at any one time in a pressurized system. These
valves have different behaviors due to their different purposes, but all valves are used
for controlling flow. They can be opened, closed, or throttled to achieve the desired
result. In terms of hydraulic transient analysis and design, valves can be classified as
flow control or surge control valves. Flow control valve types are discussed in “Flow-
Control Valve Fundamentals” on page 6-214:

• Pressure-reducing valves (PRVs)

• Pressure-sustaining valves (PSVs)
• Pressure-breaker valves (PBVs)
• Flow-control valves (FCVs)
• Throttle-control valves (TCVs)
• General-purpose valves (GPVs)

RELATED TOPICS

• See “Valve Selection and Sizing Considerations” on page 1003.

• See “Typical Valve Bodies and Pistons” on page 1005.
• See “Closing Characteristics of Valves” on page 1006.
• See “Flow-Decreasing Characteristics” on page 1009.
• See “Acknowledgements” on page 960.
• See “Overview of Hydraulic Transients” on page 961.
• See “Hydraulic Transient Theory” on page 970.
• See “Water System Characteristics” on page 985.
• See “Pump Theory” on page 995.
• See “Friction and Minor Losses” on page 1016.
• See “Developing a Surge-Control Strategy” on page 1037.
• See “Engineer’s Reference” on page 1064.
• See “References” on page 1072.

14-1002 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

14.6.1 Valve Selection and Sizing Considerations

A simple approach to valve sizing would be to determine the required valve coeffi-
cient (Cv), as defined in ANSI/ISA Standards S75.01:

Cv = Flow ( specific gravity / pressure drop)1/2

where flow is in US gallons per minute and pressure drop is in pounds per square inch
(psi) at 60oF (16oC). A designer would also check the maximum anticipated flow rate
and temperature combination to avoid choking or flashing conditions. The most
extreme flow rates are likely to occur during a transient.

Bentley HAMMER V8i is the most versatile design tool for valve sizing because it
allows you to simulate the operating conditions a valve is likely to encounter during
steady-state or transient events. Bentley HAMMER V8i models valves differently
depending on their response time. The principal difference between flow-control and
surge-control valves is their response or activation time:

Flow control valves—The majority of valves in a water system are intended for on/
off operation (i.e., they either allow or block flow). In addition to this, flow-control
valves throttle flow using various methods that depend on the valve body, piston or
pinch mechanism, and actuator. Although special trim is available to deal with
sustained high-velocity or high-pressure differentials, most flow-control valves are
not designed to react to or handle transient conditions for any length of time. They are
typically actuated to ensure a slow opening or closure. Actuators are typically
hydraulic, electric, or (less often for water systems) compressed air:

• Hydraulic actuators—Small-diameter tubes called pilots are connected

upstream and downstream of the valve and the difference in pressure between
these points is used to open or close it. The type of valve depends on how the
upstream and downstream pilots are connected to the valve body and/or drained
out of it to ambient, or atmospheric, pressure. The term piloting is often used to
describe the hydraulic (and sometimes electrical) circuitry and connecting tubes.
• Electric actuators—These are motors coupled to gear works to ensure a gradual
opening or closure. In water systems, electric actuators are most often used to
operate large isolation valves, only some of which may be connected to backup or
emergency power (for use during a power failure). Typically, a manual over-ride

Bentley HAMMER V8i Edition User’s Guide 14-1003

Valve Theory

and hand wheel is also provided for each valve. The gear ratios are set so that a
large number of turns is required on the wheel to fully open or close the valve.
Even for the fittest operator, this ensures that the valve cannot be closed too
quickly, to prevent water hammer.
• Compressed-air actuators—Compressed- or instrument-air actuators are far
more common in industrial settings, where valves and flows are typically smaller
than in water or wastewater systems (e.g., typically m3/hr. instead of m3/s, respec-
tively). The compressed air is typically maintained at a set pressure and some
reserve capacity is usually stored to allow operations to continue after a power
failure. Since compressors are required to maintain pressure in a gas vessel, it is
possible to use such actuators nearby, but this is rarely done.

Surge-control valves—The majority of surge-control valves are sized and actuated to

respond very quickly to hydraulic transient conditions and to handle far greater flows
and pressure drops than flow-control valves (albeit for shorter times). Small tanks
containing compressed nitrogen or other special gases are sometimes provided to help
valves open more quickly. The piloting is typically designed to respond to sudden or
gradual changes in pressure or even to the rate of change of pressure. Hydraulic or
compressed-air actuators are preferred because these valves are typically installed to
protect against a power failure or sag, during which electrical actuators may fail to
operate. Because hydraulic transients occur so quickly in most systems, the time
required to bring backup power on line is often too long to be of use during transients.

Any valve can initiate a hydraulic transient if it is opened or closed too quickly with
respect to the system’s characteristic time, or if it is operated in an uncontrolled
manner. Uncontrolled operation can occur due to a failure of hydraulic piloting to
react during very high reverse-flow velocities, for example. This illustrates the impor-
tance of sizing a valve to handle the full range of flows it will encounter during its
service life. Another example is that instrument-air pressure can fail to reach a valve at
the correct flow rate or pressure, due to clogged filters or worn orifices, incapacitating
its compressed-air actuator.

Transient Tip: It is essential to follow the valve manufacturer’s

selection, sizing, and maintenance schedules to avoid
specifying a valve that is unsuitable for a specific
application. A critical first step in the process of sizing
surge-control valves is to perform a thorough hydraulic
transient analysis using Bentley HAMMER V8i to
determine the normal and transient conditions the valve
will encounter during its entire service life (e.g., for
current, interim, and ultimate water-supply conditions
and surge-control scenarios). Improper selection or
sizing of surge-control valves can result in worse
transients than if no protection were installed.

14-1004 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

RELATED TOPICS

• See “Typical Valve Bodies and Pistons” on page 1005.

• See “Closing Characteristics of Valves” on page 1006.
• See “Flow-Decreasing Characteristics” on page 1009.

14.6.2 Typical Valve Bodies and Pistons

Every flow- or surge-control valve consists of a valve body to convey (and sometimes
redirect) flow and a piston to open, restrict, or block flow. Since all valves can cause a
sudden stoppage of flow, resulting in hydraulic transients if closed too quickly, it is
important to know how each type operates. The following paragraphs summarize key
characteristics for each type:

Butterfly valves are very common in water systems, primarily for on-off and throt-
tling service. A circular disc or vane pivots around an axis at right angles to the direc-
tion of flow in the pipe. Typically, a quarter-turn is sufficient to open or close this
valve. Actuators are often installed to require a large number of turns to prevent rapid
closure, sudden stoppage of flow, and the resulting hydraulic transients.

Gate valves are a general-service valve used primarily for on-off, nonthrottling
service. A flat face, vertical disc, or gate slides down through the valve to block flow.
These valves can be found on very large suction or discharge piping inside most water
pumping stations, often equipped with actuators with very large gear ratios to allow
manual operation. They may be operated only yearly or less frequently.

Globe valves are used for on-off service and throttling applications. A plug with a flat
or convex bottom is lowered onto a matching horizontal seat located at the center of
the valve. Raising the plug opens the valve, allowing flow. Many different types of
materials and pistons are available, including anticavitation or multi-orifice cages.
Globe valves are typically available with a straight-through body or with an angle
body that simultaneously turns flow through 90 degrees.

Plug valves are used primarily for on-off service and some throttling. They control
flow by means of a cylindrical or tapered plug with a hole in the center that either lines
up with the flow path or blocks it with a quarter-turn in either direction. Actuators are
often installed to require a large number of turns to prevent rapid closure, sudden stop-
page of flow, and the resulting hydraulic transients. Plug valves are common in
process or industrial applications.

Ball valves are used primarily for on-off service and some throttling. They are similar
to the plug valve but use a rotating ball with a hole through it. Many garden hose
attachments are ball valves, requiring a quarter-turn to open or close, but many faucets
are also ball valves that require many turns. Large ball valves are used to throttle flow
in pump-discharge lines.

Bentley HAMMER V8i Edition User’s Guide 14-1005

Valve Theory

Diaphragm valves handle corrosive, erosive, and dirty service. They close by means
of a flexible diaphragm attached to a piston, sometimes called a compressor, that can
be lowered by the valve stem onto a weir to seal and cut off flow. Diaphragm valves
are used for waste water, industrial fluids, and for mining applications, such as
pumping light slurries or tailings-reclaim water.

Pinch valves are particularly suited for slurries or liquids with large amounts of
suspended solids. They seal by means of one or more flexible elements, such as a
rubber tube, that can be pinched to shut off flow. The flexible element can vary widely
from food-grade to special natural and synthetic rubbers to handle corrosive and/or
abrasive fluids and mixtures.

Needle valves are volume-control valves that restrict flow in small lines. Needle
valves are commonly used for speed control in piloting by allowing operators to set
the time required for fluid to move to or from the valve piston chamber. The fluid
going through the valve turns 90 degrees and passes through an orifice that is the seat
for a rod with a cone-shaped tip. Positioning the cone in relation to the seat changes
the size of the orifice.

Related Topics

• See “Valve Selection and Sizing Considerations” on page 1003.

• See “Closing Characteristics of Valves” on page 1006.
• See “Flow-Decreasing Characteristics” on page 1009.

14.6.3 Closing Characteristics of Valves

Depending on the body and piston for a type of valve, closing it by moving the piston
at a constant rate results in a different rate of decrease in the area open to flow. Near
the end of the closure, some types decrease this area faster while others slow down.
Bentley HAMMER V8i has built-in area-closure characteristics for various types of
valves to ensure this important factor is represented adequately. You can select the
correct valve type and know that the decrease in flow will be modeled in a realistic
manner as the valve closes.

14-1006 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Note: For most manufacturers, the rate at which area decreases as the
valve closes is a close approximation to the rate at which flow
decreases, often reported as a Cv curve. If either curve is
available for your valve, you can enter it as an area-closure
curve in Bentley HAMMER V8i.

For ease of interpretation, valve closing can be represented numerically by the shape
of closure (S) parameter that represents the rate of opening area deceleration during
the time of a complete closure (Tc), or stroke time, if the stroke varies linearly with
time. If a partial closure, opening, or full opening is specified, Bentley HAMMER V8i
correctly tracks the area open to flow. The following equations are used to relate area
to stroke:

• Increasing deceleration—If the rate of change of the area open to flow (with
respect to a constant stroke speed) increases at the end of the closure period, the
valve closing pattern can be expressed as:

A/A0 = 1 - (T/Tc )-S

Where: A/A0 = the fraction of the full valve-opening area

= the fraction of time required to completely close

T/Tc
the valve
= the shape of valve closure, which is greater than 1
S
for increasing deceleration

• Decreasing deceleration—If the rate of change of the area open to flow (with
respect to a constant stroke speed) decreases at the end of the closure period, the
exponent S should be less than 1 and the valve-closing pattern can be expressed as

A/A0 = (1 - T/Tc )-S

For valves commonly used in engineering practice, the following values of S are used
by Bentley HAMMER V8i according to the valve type:

Valve S

Butterfly valve -1.85

Ball valve -1.35

Bentley HAMMER V8i Edition User’s Guide 14-1007

Valve Theory

Valve S

Globe valve 1.00

Circular gate valve 1.35

Needle valve 2.00

User-defined (enter curve) n/a

The relationship between the fraction of area open to flow (A/A0) and the stroke (T/Tc)
is shown in the following figure.

10 Decrease in Open Area near end of Closure

Circular Gate Valve
9 (Accelerated Closure)
A/Ao = 1-(T/Tc)-S

Accelerating Uniform Decelerating

Needle Valve Needle S = 2
8
Circular Gate S = 1.35
Circular Gate Valve
7 Where S > 1
Opening Area A/Ao

Globe S = ± 1, linear
6

5 Globe Valve
A/Ao = (1-T/Tc)- S
4 Ball S = -1.35
Ball Valve Butterfly S = -1.85
3 Where S < -1
Butterfly Valve
2

0 1 2 3 4 5 6 7 8 9 10
T/Tc
Figure 14-9: Relationship between Fraction of Area Open to Flow and
Stroke

RELATED TOPICS

• See “Valve Selection and Sizing Considerations” on page 1003.

• See “Typical Valve Bodies and Pistons” on page 1005.
• See “Flow-Decreasing Characteristics” on page 1009.

14-1008 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

14.6.4 Flow-Decreasing Characteristics

Normally, the flow rate decreases much slower than that of the opening area during
the early stage of the valve closing. However, this pattern inverts toward the end of the
valve-closing period. As shown in the figure below for most common valves, the
majority of flow drops to zero quickly near the end of the valve-closing stroke (or
time).
10

9
Circular Gate Valve
8 (Accelerating Closure)

7
Flow Decrease Q/Qo

6 Butterfly Valve

0 1 2 3 4 5 6 7 8 9 10
T/Tc

Figure 14-10: Flow Patterns for Common Valves

RELATED TOPICS

• See “Valve Selection and Sizing Considerations” on page 1003.

• See “Typical Valve Bodies and Pistons” on page 1005.
• See “Closing Characteristics of Valves” on page 1006.

14.7 Air Valve Theory

For any nodal type in communication with atmosphere (e.g., Discharge to Atmo-
sphere, Air Valve), air may be injected into the pipeline whenever the local (gauge)
pressure drops to zero or below. In the specific case of an air valve, the injected air is
expelled from the pipeline under pressure through a restrictive orifice in order to
cushion the subsequent impact of the rejoining adjacent liquid columns. Thus, in the
following discussion, although we will refer to an air valve, it should be observed that

Bentley HAMMER V8i Edition User’s Guide 14-1009

Air Valve Theory

the injected air will remain at atmospheric pressure for all other nodal types capable of
allowing the entry of air. Consequently, in the current version of HAMMER, air
entering or escaping at a small crack or hole in the piping, valve and/or joints could
only be represented by an air valve.

There are two air pocket models embedded in HAMMER: Elastic (Concentrated) and
Rigid Column (Extended). The former is a more standard treatment wherein each air
pocket is localized at its formation point, whereas the latter is an innovative rigid
column representation of the adjacent branches with tracking of the air-liquid inter-
face.

Modes of Operation

For Air Valves in HAMMER, there may be up to three orifice diameters: one for inlet
and two for outlet; demarcated by either a Transition Volume or a Transition Pressure.
The diameters of three orifices and the transition volume/pressure are input parame-
ters (some of which are only available for certain Air Valve Types - see Air Valves for
details) which materially affect the performance of the Air Valve.

It should be noted that the Transition Volume is an artificial construct that approxi-
mates the inner workings of combination (a.k.a. triple-acting, or three-stage) air valve.
The volume adopted is usually the volume of the body of the air valve, since floats
typically operate inside the air valve to reduce the air outflow orifice size once liquid
starts to enter the air valve body (i.e. when the volume of air remaining is less than the
volume of the body of the valve). The Transition Pressure is simply an internal pres-
sure in the pipeline, above which the large diameter air outflow orifice is forced
closed. The user must select whether a valve utilizes a Transition Volume or Transi-
tion Pressure as the trigger to switch between the large diameter orifice and the small
diameter orifice.

For any of the three orifices, HAMMER automatically calculates air flow throttling
due to the "sonic velocity" using a formulation after Comolet (1961). Using this
formulation the air mass flow rate, QM is determined as follows:

(1)

 0 is the density of air at 4°C and 1 atmosphere (=1.293 g/l), S=0.6A, with A being
the cross-sectional area of the orifice.

14-1010 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

 is the exponent in the gas law, p is the absolute pressure, the subscript 0 denotes

standard conditions, and p   = constant. For air inflow, (1) is again applicable,
except that the ratio within the square brackets is inverted to be p/p0 as p0>p in this
instance. The exponent,  , in the gas law is hard-coded as 1.4, which corresponds to
adiabatic compression/expansion appropriate for the typically rapid processes which
occur.

With reference to the Modes of Operation figure below, four modes of air valve oper-
ation have been identified: (a) full (no air), (b) vacuum breaker, (c) exhaust, and (d)
compression. Under normal steady-state conditions, the pipeline will be full (of
liquid) as the (gauge) pressure exceeds zero. Should the pressure decline to zero, the
Air Valve will serve as a vacuum breaker as it opens to allow the entry of air. During
this phase, an expanding air pocket forms, but eventually system conditions can cause
the flow to reverse. If the air volume is greater than the Transition Volume (or the
internal pressure is less than the Transition Pressure), air is released through a large-

Bentley HAMMER V8i Edition User’s Guide 14-1011

Air Valve Theory

diameter orifice in exhaust mode; when the remaining air volume decreases below the
Transition Volume (or the internal pressure increases above the Transition Pressure),
the large-diameter orifice closes and the small-diameter orifice opens to vent the
remaining air, which now undergoes significant compression.

14-1012 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Full and Partially Full Branches

An air valve may be connected to more than one pipe branch and at any instant it is
quite possible for some branches to be full while others have air volumes. Conse-
quently, ambiguity arises when flow towards the air valve occurs in a full branch. To
process this scenario, the following rules are adopted within the software:

• Inflow into a full branch yields a full branch

• Excess inflow from the full branch(es) is allocated to the air pockets in other
branches in proportion to the air pocket sizes

14.7.1 Extended CAV Method

HAMMER normally models air or vapor volumes as concentrated at specific points

along a pipe. However, HAMMER can simulate an extended air volume if it enters the
system at a local high point (via an Air Valve element, sometimes called a combina-
tion air valve or CAV).

To enable this, from the Transient Solver Calculation Options, set the Run
Extended CAV field to True. HAMMER will track the extent of the air pocket and
the resulting mass-oscillation and water column accelerations. HAMMER still calcu-
lates 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 solu-
tions, without increasing execution time.

Rigid Liquid Columns in Branches

When a sufficiently large volume of air enters a pipeline, the flow regime evolves
from hydraulic transients to mass oscillations. Thus, at least in the vicinity of the air,
the system may be represented by rigid-column theory in lieu of the elastic approach.
Besides improved computational efficiency, the rigid approach allows for the tracing
of the air-liquid interface, under simplifying assumptions, with a concomitant change
in the hydraulic grade line, and also tracks momentum more accurately. A rigid
column is considered in each branch adjacent to an Air Valve extending to the neigh-
boring node which is at a lower elevation in order that the branch be sloped upward
towards to the Air Valve. Furthermore, it is assumed that the liquid surface is hori-
zontal and that each branch is terminated at its upper end by the intersection of a
vertical plane through the Air Valve with the pipe.

The air pocket consists of portions in each of the branches overlying the rigid
columns, with the air pocket instantaneously at constant pressure due to its low
density. The neighboring node is a M-way junction, each branch of which (except for
the one containing the AV) is handled by means of the elastic theory. In light of this
background, we formulate the equations of motion at each neighboring node, An say,
in terms of the following (2M + 4) variables: head and flow in each of the M branches,

Bentley HAMMER V8i Edition User’s Guide 14-1013

Air Valve Theory

head and flow of the rigid column, and length and level of the rigid column. Corre-
spondingly, there are (2M + 4) equations comprised of characteristics and head loss
for each branch, continuity at An and at the horizontal surface, conservation of
momentum for the rigid column, and column length as a function of its level. These
equations are solved iteratively by postulating that all friction coefficients are small
and that the flows may be reasonably approximated by values from the previous time
step.

Determination of Air Pocket Properties

In the process of handling the rigid columns described above, the pressure of the over-
lying air is taken to be provided by the value at the previous time step. At the conclu-
sion of each time step, there is generally a change in the level in each constituent
branch which in turn leads to a variation in the total air volume. Simultaneously,
depending on the mode of operation of the Air Valve as described in the “Air Valve
Theory” section, air can enter or exit the valve freely or under compression. To deter-
mine the volume, mass, and pressure of the air in the pipeline, we solve nonlinear
equations for mass flow rate through the air valve along with the isentropic gas law
and (air) mass continuity. In this way, the air pocket properties are updated and
employed for the succeeding time step, after due allowance for flow from any full
branches as outlined below.

Liquid Transfer from Full Branches

At any instant, it is quite possible for some branches of an Air Valve to be full while
others possess air volumes above the rigid columns. Consequently, as in the case of
the elastic theory, ambiguity arises when flow towards the Air Valve occurs in a full
branch: how does this inflow past the Air Valve distribute itself among the existing air
pockets? In essence, the same rules enforced in the elastic case are also applicable in
the present situation as follows: (i) For inflow into a full branch, the branch remains
full. (ii) 'Over-the-top' inflow from the full branch(es) is allocated to the air volumes in
adjacent branches in proportion to their sizes.

Transitions between Elastic and Inelastic Approaches

The elastic (concentrated) model is intended for when the closed conduits are filled
with liquid or when there are only small air volumes present. As HAMMER is based
upon the conveyance of a single liquid in a network of closed conduits flowing full,
this representation is readily integrated in the program; moreover, there are no restric-
tions on the type or elevation of neighbor nodes. However, the elastic treatment is an
oxymoron inasmuch as the air has finite volume with zero extent, so that the liquid
level is constrained to be no lower than the pipe's elevation at the Air Valve location.
On the other hand, the inelastic (extended) model works best for large air volumes by
tracing the movement of the horizontal interface between the overlying air and the
liquid in each branch adjacent to the Air Valve. In this way, the liquid level is not

14-1014 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

limited to the Air Valve's elevation as a lower bound. Such an approach is more diffi-
cult to implement and visualize. Furthermore, multiple additional constraints are
imposed on neighbor nodes which must be junction elements (with no demands),
lower than the Air Valve, and associated with (neighbor to) exactly one Air Valve.

Initial Model and First Transition

At the start of a run, as there is typically no air present in the system, the elastic
(concentrated) representation is normally invoked. HAMMER tracks the volume of
air in each branch, together with the level of the virtual horizontal liquid surface if the
rigid-column approach were being applied. As soon as the transition level for any
branch is reached, the rigid (extended) model is utilized in all branches. This level is
chosen as being 10% of the vertical drop from the Air Valve to the adjacent interior
point within the branch. By definition, at the instant that the transition level is
breached in some branch, the liquid levels in the other branches are above their
respective transition levels. Immediately prior to the transition, the flows in the
branches should be nearly constant, whereas afterwards the level drops from the Air
Valve's height to the transition level. It is crucial that the discharges and heads be
properly transferred at all interior and end points of each branch in a continuous
fashion. In the user notifications, there is an informational message of the form "At
time step 'x' at node 'y', transition from CONCENTRATED to EXTENDED." to indi-
cate that a transition has occurred.

Limit on Air Pocket Size

In the rigid methodology, the basic premise is that each branch pipe around the Air
Valve contains a liquid column extending from the horizontal surface to the neighbor
node. In the event that the air expands greatly so that the interface moves down
towards the neighbor node to the verge of draining, HAMMER issues a warning
message, freezes the horizontal surface at the elevation of the neighbor node, and
continues to track the volume (which could conceivably exceed the branch's volume).
The warning message has the form "*** WARNING: At time step 'a' at Air Valve 'y',
the branch connected to node 'z' has drained."

Counter-Transition Strategy

If the rigid model is invoked to simulate a large air pocket at the Air Valve, it is
possible that the volume will subsequently shrink with the liquid levels in the
branches receding until they cross the transition levels. When all liquid levels are
above the transition levels, the Transient Solver reverts to the elastic model with the
printing of the message "At time step 'x' at node 'y', transition from EXTENDED to
CONCENTRATED." in the user notifications. Such transitions can recur multiple
times during a simulation. It should be observed that the instantaneous volume of the

Bentley HAMMER V8i Edition User’s Guide 14-1015

Friction and Minor Losses

air pocket at the moment that the transition occurs is indeed variable by virtue of the
criterion adopted. During the rigid (extended) phase, the flow is constant along each
branch while the head is linear from the neighbor node to the horizontal surface
whence it is parallel to the pipe until the peak at the Air Valve.

14.8 Friction and Minor Losses

Friction loss methods for Steady State and Extended Period simulations include:

• “Hazen-Williams Equation” on page 14-1017

• “Darcy-Weisbach Equation” on page 14-1017
• “Manning’s Equation” on page 14-1019
Friction Loss Methods for transient analysis runs include:

• “Quasi-Steady Friction” on page 14-1021

• “Unsteady or Transient Friction” on page 14-1022

RELATED TOPICS

• See “Acknowledgements” on page 960.

• See “Overview of Hydraulic Transients” on page 961.
• See “Hydraulic Transient Theory” on page 970.
• See “Water System Characteristics” on page 985.
• See “Pump Theory” on page 995.
• See “Valve Theory” on page 1002.
• See “Developing a Surge-Control Strategy” on page 1037.
• See “Engineer’s Reference” on page 1064.
• See “References” on page 1072.

14.8.1 Steady State / Extended Period Simulation Friction

Methods

Friction loss methods for Steady State and Extended Period simulations include:

• “Hazen-Williams Equation” on page 14-1017

• “Darcy-Weisbach Equation” on page 14-1017
• “Manning’s Equation” on page 14-1019

14-1016 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

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 equation is:

Q = k C A R 0.63 S 0.54

Where: Q = discharge in the section (m3/s, cfs)

C = Hazen-Williams roughness coefficient (unitless)

A = flow area (m2, ft2)

R = hydraulic radius (m, ft)
S = friction slope (m/m, ft/ft)
k = constant (0.85 for SI units, 1.32 for U.S. units).

RELATED TOPICS

• See “Darcy-Weisbach Equation” on page 1017.

• See “Manning’s Equation” on page 1019.
• See “Minor Losses” on page 1025.
• See “Quasi-Steady Friction” on page 1021.
• See “Unsteady or Transient Friction” on page 1022.

Darcy-Weisbach Equation
Because of its nonempirical 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:

L V2
hL = f
D 2g

Where: hL = headloss (m, ft)

f = Darcy-Weisbach friction factor (unitless)

Bentley HAMMER V8i Edition User’s Guide 14-1017

Friction and Minor Losses

D = pipe diameter (m, ft)

L = pipe length (m, ft)
V = flow velocity (m/s, ft/sec.)

g = gravitational acceleration constant (m/s2, ft/sec.2)

For section geometries that are not circular, this equation is adapted by relating a
circular section’s full-flow hydraulic radius to its diameter as:

D = 4R

Where: R = hydraulic radius (m, ft)

D = diameter (m, ft)

This can then be rearranged to the form:

R S
Q= A 8g
f

Where: Q = discharge (m3/s, cfs)

A = flow area (m2, ft2)
R = hydraulic radius (m, ft)
S = friction slope (m/m, ft/ft)
f = Darcy-Weisbach friction factor (unitless)
g = gravitational acceleration constant (m/s2, ft/sec.2)

The Swamee and Jain equation can then be used to calculate the friction factor. For
more information, see “Swamee and Jain Equation” on page 1-56.

RELATED TOPICS

• See “Hazen-Williams Equation” on page 1017.

• See “Manning’s Equation” on page 1019.
• See “Minor Losses” on page 1025.
• See “Quasi-Steady Friction” on page 1021.
• See “Unsteady or Transient Friction” on page 1022.

14-1018 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Manning’s Equation

Note: Manning’s roughness coefficients are the same as the

roughness coefficients used in Kutter’s equation. This friction
method is not used in Bentley HAMMER V8i, but it is included
here for completeness.

Manning’s equation, which is based on Chézy’s equation, is one of the most popular
methods in use today for free-surface flow. For Manning’s equation, the roughness
coefficient in Chézy’s equation is given by:

1
R 6
C= k
n

Where: C = Chézy’s roughness coefficient (m1/2/s, ft1/2/sec.)

R = hydraulic radius (m, ft)

n = Manning’s roughness (s/m1/3)

k = constant (1.00 m1/3/m1/3, 1.49 ft1/3/ft1/3)

Substituting this roughness into Chézy’s equation gives you the well-known
Manning’s equation:

k 2 1
Q= A R 3 S 2
n

Where: Q = discharge (m3/s, cfs)

k = constant (1.00 m1/3/s, 1.49 ft1/3/sec.)

n = Manning’s roughness (unitless)

A = flow area (m2, ft2)

R = hydraulic radius (m, ft)
S = friction slope (m/m, ft/ft)

RELATED TOPICS

• See “Chézy’s Equation” on page 59.

• See “Hazen-Williams Equation” on page 1017.

Bentley HAMMER V8i Edition User’s Guide 14-1019

Friction and Minor Losses

• See “Swamee and Jain Equation” on page 56.

• See “Darcy-Weisbach Equation” on page 1017.

14.8.2 Transient Analysis Friction Methods

Steady Friction
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 deter-
mines the friction factor based on this information:

• If a pipe has zero flow at the initial steady-state, HAMMER uses the Friction
Coefficient specified in the Pipe Physical properties. (Alternatively, if the user has
the 'Specify Initial Condition' Transient Solver calculation option to True, the user
must enter a Darcy-Weisbach friction factor, f)
• 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 calcu-
lated 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 user-entered friction factors to the appropriate format.

Distributed frictional losses are assumed to be concentrated at discrete computational

points treated as hypothetical inline orifices. The head difference between the
upstream and downstream side of the orifice is typically taken to be proportional to
the square of the instantaneous velocity as in the “Darcy-Weisbach Equation”.

14-1020 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Consequently, at every calculation point, there are two heads: one on the upstream
side and one on the downstream side as indicated in the figure below (Bergeron,
1961). These differ by the head loss between adjacent calculation points. The addition
of the nonlinear equation Darcy-Weisbach equation to the system of characteristic
equations does complicate the task of advancing the solution forward in time, and
leads to an approximation in terms of the friction coefficient which is typically small.

Historically (Parmakian, 1961; Wylie and Streeter, 1993), in simulating unsteady flow
in closed conduits, frictional losses have been represented by means of a steady-state
friction coefficient as derived from the initial conditions and/or the entered value in
the case of zero-flow pipes. For each artificial inline orifice, a head-loss coefficient is
determined so that the total pipe loss due to the summation of such local losses is iden-
tical to the distributed loss of the pipe. After the coefficients are calculated initially,
they remain invariant throughout the run.

Quasi-Steady Friction

In this approach (Fok, 1987), the Darcy-Weisbach coefficient at any point depends on
the state of the system at the previous time step. At the outset, the friction coefficient
for each pipe is a function of the initial flow, Q0, as follows: (i) calculated from the
steady-state conditions if |Q0| > 0, or (ii) the user-entered value of the coefficient if Q0
= 0. For the starting value of the friction coefficient, the relative roughness of each

Bentley HAMMER V8i Edition User’s Guide 14-1021

Friction and Minor Losses

pipe is estimated by means of the Swamee and Jain (1976) approximation of the
Moody diagram. For subsequent time steps, the Reynolds number is computed at each
point on the basis of the previous iteration's velocity and then an updated friction coef-
ficient is ascertained.

The steady-state friction method is actually a special case of the quasi-steady method
because it assumes that the friction factor does not vary with time. The quasi-steady
friction method is virtually an unsteady method, although one based on steady-state
friction factors (c.f. “Unsteady or Transient Friction”). The quasi-steady method is
more computationally demanding than steady-state friction.

RELATED TOPICS

• See “Hazen-Williams Equation” on page 1017.

• See “Darcy-Weisbach Equation” on page 1017.
• See “Manning’s Equation” on page 1019.
• See “Unsteady or Transient Friction” on page 1022.

Unsteady or Transient Friction

Compared to a steady state, fluid friction increases during hydraulic transient events
because rapid changes in transient pressure and flow increase turbulent shear. Bentley
HAMMER V8i can track the effect of fluid accelerations to estimate the attenuation of
transient energy more closely than would be possible with quasi-steady or steady-state
friction.

It is known that past velocity and/or temporal acceleration play a significant role in
determining transient friction (Brunone et al., 1991; Bughazem and Anderson, 2000;
Vardy and Hwang, 1991). Motivated by experimental data and published formulae in
recent years for estimating the transient friction factor (Brunone et al., 2000; Vardy
and Brown, 1995; Vitkovsky et al., 2000), we have proposed an unsteady friction
model defined by an amplification of the quasi-steady friction factor by the following
factor:

14-1022 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

where V is velocity, t is time, g is gravitational acceleration, = 10,000 and = 4

(0) for acceleration (deceleration). The partial derivative of velocity with respect to
time is the temporal acceleration at any point and is evaluated at the previous time
step. On account of ongoing research in this area, an alternative transient friction
method has also been provided (Bergant, Simpson and Vitkovsky, 2001). Selecting
"Unsteady - Vitkovsky" as the transient friction method will employ the below formu-
lation:

Where f is the Darcy-Weisbach friction factor, fq is the quasi-unsteady component of

the friction factor (based on updating Reynolds number for each new computation), D
is pipe diameter, V is flow velocity, t is time, a is wave speed, sign(V) is equal to +1
when velocity is greater than zero and -1 when velocity is less than zero, x is distance,
and k is Brunone's friction coefficient. The coefficient k can be computed using the
following equation:

C
k = -----------
2

Where C* is Vardy's shear decay coefficient.

For laminar flow C* = 0.00476

For turbulent flow

This unsteady friction method from Vitkovsky is now the recommended unsteady fric-
tion method for use in HAMMER.

Bentley HAMMER V8i Edition User’s Guide 14-1023

Friction and Minor Losses

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 or pipes or more. Typically, transient friction has little or no effect on the
initial low and high pressures, and these are usually the largest ever reached in the
system. This is illustrated from the following Bentley HAMMER V8i simulation
results comparing steady, quasi-steady and transient friction methods.

250

Steady Quasi-Steady Transient

Steady
230
Quasi-
Head (m)

steady

210

Unsteady
(Transient)
190
0 5 10 15 20 25
Time (s)
Figure 14-11: Bentley HAMMER V8i Results for Steady-State, Quasi-
Steady, and Transient Friction Methods

Transient Tip: The steady-state friction method yields conservative

estimates of the extreme high and low pressures that
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 estimates of
recurring and decaying extremes.

Discussion

For the initial pressure rise or decline, the various models yield results which are
nearly identical to each other, as well as to empirical data. As time passes, however,
the match progressively deteriorates for subsequent peaks and valleys especially when
the flow changes are more abrupt as illustrated above. The usual convex velocity
profile in steady state begins to break down when the flow is rapidly varied with
regions of flow recirculation, flow reversal and increased intensity of turbulence
(Brunone et al., 2000). Thus, the fundamental assumption of one-dimensional flow is

14-1024 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

severely strained. Although the unsteady model, in particular, matches the empirical
decay in amplitude quite well, it fails to account for the attendant change in the shape
of the wave with increasing time. The topic of unsteady friction remains in the fore-
front of hydraulics research.

Tip: The "Unsteady - Vitkovsky" method is the recommended

unsteady friction method. The "Unsteady" transient friction
method is included primarily for compatibility with older
versions of HAMMER.

RELATED TOPICS

• See “Hazen-Williams Equation” on page 1017.

• See “Darcy-Weisbach Equation” on page 1017.
• See “Manning’s Equation” on page 1019.
• See “Minor Losses” on page 1025.
• See “Quasi-Steady Friction” on page 1021.

14.8.3 Minor Losses

Minor losses in pressure pipes are caused by localized areas of increased turbulence
that create a drop in the energy and hydraulic grades at that point in the system. The
magnitude of these losses is dependent primarily upon the shape of the fitting, which
directly affects the flow lines in the pipe.

Figure 14-12: Flow Lines at Entrance

The equation most commonly used for determining the loss in a fitting, valve, meter,
or other localized component is:

Bentley HAMMER V8i Edition User’s Guide 14-1025

Cavitation

V2
hm = K
2g

Where: hm = loss due to the minor loss element (m, ft)

K = loss coefficient for the specific fitting

V = velocity (m/s, ft/sec.)

g = gravitational acceleration constant (m/s2, ft/sec. 2)

Typical values for fitting loss coefficients are included in the fittings table, see “Fitting
Loss Coefficients” on page 14-1069.

Generally speaking, more-gradual transitions create smoother flow lines and smaller
head losses. For example, “Figure 14-12: Flow Lines at Entrance”on page 14-1025
shows the effects of entrance configuration on typical pipe entrance flow lines.

RELATED TOPICS

• See “Hazen-Williams Equation” on page 1017.

• See “Darcy-Weisbach Equation” on page 1017.
• See “Manning’s Equation” on page 1019.
• See “Quasi-Steady Friction” on page 1021.
• See “Unsteady or Transient Friction” on page 1022.

14.9 Cavitation
During a Transient Analysis, if the gauge pressure, P, of the fluid declines to its vapor
pressure limit, P0, then vapor will begin to form and the vapor volume will expand at
all such computation points as long as P0 persists. In fact, as the pressure approaches
P0, air will be released from solution and the wave speed will decrease; this behavior
can be simulated in HAMMER using the wave speed reduction factor.

For simplicity, let us focus on an interior point of a pipe. With the inclusion of friction,
there are three unknowns at each time step for every interior point in single-phase
flow: two heads and a discharge. In fact, in order to track the vapor volume(s), Xi, i =
1, 2, that may form, additional variables are required to record such volumes. There
are two fundamental hypotheses invoked in treating vapor pockets:

14-1026 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

• Vapor pockets occupy the complete cross-sectional area

• vapor pockets are localized at point of formation

Although these hypotheses are not entirely valid - on physical and logical grounds - it
turns out that it is difficult if not impossible to proceed without them and that they
allow us to predict the system behavior remarkably well (Provoost, 1976). By virtue
of these assumptions, there is no flow across a pocket and the interface between the
vapor and liquid remains fixed in space.

Solution

It is convenient to conceptualize each interior point as being comprised of two conju-

gate points infinitesimally close to each other as shown in the Interior Vapor Pocket
figure below. To solve for the unknowns at the interior point, there are two distinct
regimes based on whether a vapor pocket has formed:

(i) Pressure Exceeds Vapor Pressure (P > P0)

The single-phase fluid is described by two characteristic equations, two head-loss

equations, continuity, and zero vapor volumes. Thus, one can solve for the heads, Hi
and H, flows, Qi, where i = 1, 2 and Qi is the inflow towards the point from the ith
branch.

Because of continuity, Q1 = - Q2.

(ii) Pressure Equals Vapor Pressure ( P = P0)

In this case, consider the head, H, in the "middle" of the point is H0 = P0 + Z, where Z
is the elevation of the point. In addition, there are still two characteristic equations,
two head-loss equations and the continuity relations, with the latter being as follows:

dXi / dt = - Qi

In summary, in both modes, there are seven variables - H, Hi, Qi and Xi - and seven
equations.Transitions between these two states may occur multiple times during a
simulation. It is also physically possible that a vapor pocket both opens and closes, or
vice-versa, within a single (and arbitrary) time step. There is logic in the transient
solver to detect this occurrence and deal with it. HAMMER traces the evolution of the
vapor pockets and records the maximum volume attained at each point during the
simulation.

The localization of vapor pockets to points is merely a convenient conceptualization

which is logically and physically impossible. Nevertheless, for volumes which are
smaller than those occupied by the pipeline between adjacent calculation points, the
simulation is quite robust. However, the program neither adjusts its method of calcula-

Bentley HAMMER V8i Edition User’s Guide 14-1027

Cavitation

tion (e.g., by limiting the size of pockets or transferring excess volumes to adjacent
points) nor prints warning/error messages should the vapor volumes grow large
enough to fill the pipe segment between two computation points. The user must pay
attention to this limitation of the program.

Note: Cavitation is not calculated during Steady State or EPS (i.e.

Initial Conditions) computations - it is only calculated during
Transient computations.

14-1028 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

14.10 Time Step and Computational Reach Length

During a transient analysis there is a definite wave travel time, i= Li/ai, where Li
and ai are the length and wave speed, respectively, of pipe i in a network. In the
method of characteristics (MOC), the solution at each (calculation) point is advanced
one time step, T, in each iteration starting from its known initial value. During the
time T, the wave will travel from one point to its neighbour. Since the points lie in
the interior and at the ends of each pipe, it is necessary that i be a multiple of T;
in other words, it is mandatory for a wave to traverse any pipe in an integral number of
time steps. To achieve this goal, the times i may need to be adjusted as discussed
below.

Travel Time Statistics

HAMMER computes the following statistics for wave travel times in a network with n
pipes:

• Total travel time to traverse all pipes in the network:

• Mean travel time:

• Variance:

Some of these statistics are employed in determining an appropriate time step.

Automatic Selection of Time Step

The transient calculation time step, T, depends on , , n, and . Each i

must be divisible by T. We start by selecting an integer:

based on heuristics attempting to balance accuracy and performance as follows:

N = n  n y   

Bentley HAMMER V8i Edition User’s Guide 14-1029

Time Step and Computational Reach Length

where (n) and y( ) are respectively monotonically increasing and decreasing

functions which are defined as follows:

Finally, the time step T is determined as / N.

Adjustment in Wave Speeds

In the selection of a time step, there is nothing to ensure that the i will be exactly
divisible by T. To accomplish this task, the i can be rounded according to the
following rules:

A. i >= T
B. implement a bias towards increasing i

To round the i, one can adjust the length, wave speed or both for each pipe.

If the length is adjusted, then errors will arise in the mass, momentum, energy and
friction coefficient. Moreover, if the Viewer were to display the adjusted lengths, then
the user could conceivably believe that the pipes are being distorted. For slower
changes leading to mass oscillations in the system, it can be demonstrated that the
alterations to the network will have an impact on the results.

On the other hand, should the wave speed be adjusted, this can lead to errors in the
calculation of rapid transients - think of Joukowsky's formula which depends on wave
speed but is explicitly independent of length.

14-1030 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

The user can choose whether to adjust length or wave speed in HAMMER (see “Tran-
sient Time Step Options Dialog”) does have the responsibility to exercise some discre-
tion in constructing a model of a hydraulic system. As a approximate measure of the
adequacy of the model, a warning message appears in the output log in the event that
any adjustment exceeds the Max Adjustment value in the Transient time Step Options
dialog box. The default value for this parameter is 75%; i.e., | ai| / ai > 0.75 when
adjusting wave speed, or | Li | / Li > 0.75 when adjusting length, then a user notifi-
cation message suggests that the user consider reducing the time step or subdividing
longer pipes and/or lengthening shorter pipes.

It should be noted that large wave speed adjustments in small pipes in branches, or in
main lines with slowly changing flows, may have little impact on the hydraulic tran-
sients in the system. However, the impact could be significant if transients in the short
pipes (whose wave speeds tend to be reduced) are of interest.

14.11 TURBINE SIMULATION IN HAMMER

14.11.1 Four-quadrant Characteristics of Turbomachinery

In terms of wave propagation using the MOC, a turbine is a boundary condition in

HAMMER. A set of differential equations are used to compute the head and flow at
the turbine during the transient event(s). The four-quadrant curves that describe the
hydraulic 'turbine characteristics' of the turbomachine have nothing to do with wave
propagation and should not be confused with the MOC.

Bentley HAMMER V8i Edition User’s Guide 14-1031

TURBINE SIMULATION IN HAMMER

14.11.2 Numerical Representation of Hydroelectric Turbines

This section describes the general equations for the schematic turbine shown in
“Figure 14-13: Schematic of Turbine Hydraulic Element in Hammer”on page 14-1032
(that also shows the upstream and downstream computational points).

Figure 14-13: Schematic of Turbine Hydraulic Element in Hammer

Turbine equations:

H1  1Q = h1 1q1

H2  2Q = h2  2q2

Where: H = head at the end of current time step

Q = flow at the end of current time step
h = head computed during previous time step
q = flow computed during previous time step

a
 (where a is the wave speed and S is the pipe cross-
gS sectional area)

Pipe head loss equations:

H1  f1Q|Q| = HC

14-1032 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

H2  f2Q|Q| = HB

Where: f = frictional coefficient

HB = head at point B at the end of current time step

HC = head at point C at the end of current time step

Valve head loss equation:

HC  HA = KvQ|Q|

Where: HA = head at point A at the end of current time step

Kv = valve loss coefficient

Four-quadrant turbine curves:

Mhyd =FM(Q, N, w)

HA  HB =FH(Q, N, w)

Where: Mhyd = hydraulic torque

N = rotational speed of the turbine

w = wicket gate position
FM = torque function

FH head function

Conservation of angular momentum:

Bentley HAMMER V8i Edition User’s Guide 14-1033

Transient Forces

c t
N = n + --------   M hyd + m hyd  –  M electrical + m electrical  
2

= turbine’s rotational speed computed during

Where: n
previous time step
m = torque computed during previous time step
M = torque at the current time step
30g (W= weight of turbine and generator, R= radius of
c = --------------2-
WR gyration)

Algebraic manipulations reduce equations () to () to a pair of non-linear equations in

the unknowns Q and N as follows:

FH(Q, N, w)  (Kv  f1  f2)Q|Q|  (1  2)Q  (h2  h1  2q2  1q1) = 0

c t c t
N – n – --------  F M  Q N w  + m hyd  + --------  M electrical + m electrical  = 0
2 2

The non-linear equations () and () can be solved by iteration using Newton’s method
in conjunction with the four-quadrant head and torque curves for various wicket gate
positions.

14.12 Transient Forces

1. Computations
In accordance with Newton’s Third Law, the force exerted on the piping by the
conveyed liquid is equal and opposite to that applied on the liquid by the piping.
On physical grounds, the latter is due to the following causes: gravity, fluid fric-
tion drag, and changes in pipe diameter and/or direction.
The linear-momentum and action-reaction principles are applied to an appropriate
control volume (CV) to construct general formulae for instantaneous forces
applied to pipe walls by the conveyed liquids. Specifically, a fixed control volume
is defined as being centered around a node, which can be internal (associated with
multiple pipes) or external (at the end of exactly one pipe) as illustrated in “Figure
14-14: Control Volume for Internal Node”on page 14-1036 or “Figure 14-15:
Control Volume for External Node”on page 14-1036 , respectively.

14-1034 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

i
3 Momentum Decrease Internal Node
within CV

Control Volume (CV)

Momentum into CV Weight

Pressure
Branch Pipe, i

Bentley HAMMER V8i Edition User’s Guide 14-1035

Transient Forces

Figure 14-14: Control Volume for Internal Node

Momentum into CV

1
Pseudobranch Pressure

Momentum Decrease
within CV External Node

Control Volume (CV)

Momentum into CV Weight

Pressure
Branch Pipe, 1

Figure 14-15: Control Volume for External Node

It is assumed that HAMMER has already computed the transient flow/velocity

and head/pressure for every end point and at each relevant instant. Then, the
following relation must hold:
Net force on the liquid in CV = rate of increase of momentum within CV
+ momentum flowrate out of CV boundary surface (CS)
Therefore, after collapsing the CV onto the junction or node:

 g i Ai (Hi  Z) n i  R =  i ( Qi v i)

where the subscript i refers to the ith pipe emanating from the node,  is mass
density, g is acceleration due to gravity, H is head, Z is elevation, n is the unit
inner normal to the CS, A is cross-sectional area, R is the resultant force exerted
by the pipe on the liquid, t is time, v is the fluid velocity, and Q is the flowrate
towards the node. Note that any boldfaced underlined quantity is a vector.

14-1036 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

By rearranging (), it follows that the reaction force on the pipe, applied by the
liquid, is given by the vector formula:

P = -R =  i Ai [ vi2 + g (H i - Z) ] ni

where i = +1, if the flow in the branch is directed towards the node, and -1 other-
wise. On account of the discretization involved, this force is apportioned equally
to each of the end points situated at the node.
The first term on the right-hand side of (), which involves v, is associated with
momentum flowing across the boundary CS. All terms are functions of time,
except for the transverse component of weight which acts in the downward direc-
tion -k, where k is a unit vertical upward vector. The longitudinal (or axial)
component of weight (if any), a body force on the CV, is already accounted for in
the hydraulic transient equations used by Bentley HAMMER V8i to solve for
flow/velocity and head/pressure at each instant.
In terms of the Cartesian coordinates, with z being measured vertically upward,
the magnitude of the resultant force P = (Px, Py, Pz) = -R = (-Rx, -Ry, -Rz) on the
pipe is given by:

P = R = |-R| = [Rx2  Ry2  Rz2] 0.5

For instance, in the case of an internal node as in Figure C-1 with N = 2, vertical
pipes meeting at an angle of 180 degrees, and steady flow, then the magnitude of
the resultant is given by the relation g | H2 A2 - H1 A1|. For steady flow in a
vertical pipe discharging to atmosphere through an orifice at its top end as in
Figure C-2, the resultant downward force on the pipe is Q|V - v|, with Q, V, and
v being the flow and velocity at the vena contracta and in the pipe, respectively.
The result of the force computations may be restricted to periodic times, as indi-
cated in Transient Solver Calculation Options > Report Times. If the forces
are enabled in the Run Dialog, a table of maximum forces - over all time steps
regardless of report period - is constructed in the output log with columns: Node,
Time, Magnitude, Fx, Fy, and Fz. In the report database, two tables, Force_History
and Force_Maxima, are created.

14.13 Developing a Surge-Control Strategy

Ideally, a system is designed and operated to minimize the likelihood of damaging
transient events. However, in reality, transients still occur; thus, methods for control-
ling transients are necessary. This section has two goals: (1) to make the hydraulic
engineer aware of the system conditions that lead to the development of undesirable
transients, such as pump and valve operations, and (2) to present the protection
methods and devices that should be used during design and construction of particular
systems and discuss their practical limitations.

Bentley HAMMER V8i Edition User’s Guide 14-1037

Developing a Surge-Control Strategy

There are two possible strategies for controlling transient pressures. The first is to
focus on minimizing the possibility of transient conditions during project design by
specifying appropriate flow-control operations and avoiding the occurrence of emer-
gency and unusual system operations. The second is to install protection devices to
control potential transients due to uncontrollable events, such as power and equipment
failures.

Systems protected by adequately designed surge tanks are generally not adversely
affected by emergency or unusual flow-control operations, because operational failure
of surge tanks is unlikely. In systems protected by gas vessels, however, an air outflow
or air-compressor failure can lead to damage from transients. Consequently, potential
emergency situations and failures should be evaluated and avoided to the extent
possible through the use of alarms that detect device failures and control systems that
act to prevent them.

With most small, well-gridded water-distribution network piping, sufficient safety

factors are built into the system, such as adequate pipe-wall thickness and sufficient
reflections (tanks and dead ends) and withdrawals (water use). The effects of tran-
sients are most likely to result in pipe failures in long pipelines with long character-
istic times (large values of 2 L/a), high velocities, and few branches. Filion and
Karney (2002) found that water usage and leaks in a distribution system can result in a
dramatic decay in the magnitude of transient pressure effects.

RELATED TOPICS

• See “Piping System Design and Layout” on page 1039.

• See “Protection Devices” on page 1040.
• See “Approaches to Surge Protection” on page 1042.
• See “Pump Protection” on page 1052.
• See “Surge-Relief Valves” on page 1055.
• See “Operation and Maintenance” on page 1062.
• See “Acknowledgements” on page 960.
• See “Overview of Hydraulic Transients” on page 961.
• See “Hydraulic Transient Theory” on page 970.
• See “Water System Characteristics” on page 985.
• See “Pump Theory” on page 995.
• See “Valve Theory” on page 1002.
• See “Friction and Minor Losses” on page 1016.
• See “Engineer’s Reference” on page 1064.
• See “References” on page 1072.

14-1038 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

14.13.1 Piping System Design and Layout

When designing water-distribution systems, the engineer needs to consider economic

and technical factors, such as acquisition of property, construction costs, site topog-
raphy, and geological conditions. In addition, emergency flow-control scenarios
should be analyzed and tested during the design phase, since they affect the piping
system design and the specification of surge-protection equipment.

Pipeline layouts with undulating topographic profiles are common. For these systems,
it may be desirable to change the route and/or profile of the pipeline to avoid high
points that are prone to air accumulation or exposure to low pressures (or both), but
this is seldom possible. If the minimum transient head is above the elevation of the
piping system, then transient protection devices are most likely unnecessary, thus
minimizing construction costs and operational risks.

Low-head systems are more prone to experience transient vacuum conditions and
liquid-column separation than are high-head systems. If the system designer does not
account for the occurrence of low transient pressures in low-head systems, then a
pipeline with inadequate wall thickness may be specified, potentially leading to pipe-
line collapse even if the pipeline is buried in a well-compacted trench. For example,
low-head systems with buried steel pipelines and diameter/thickness ratios (D/e) more
than 200 should be avoided because of the risk of structural collapse during a transient
vacuum condition, particularly if the trench fill is poorly compacted.

Steel, PVC, HDPE, and thin-wall ductile-iron pipes are susceptible to collapse due to
vapor separation, but any pipe that has been weakened by repeated exposure to these
events may experience fatigue failure. A pipe weakened by corrosion may also fail.
Where very low pressures are possible during transient events, the engineer may
choose to use a more expensive material to preclude the chance of collapse. For
example, for large-diameter pipes under high pressures, steel is usually more econom-
ical than ductile iron or high-pressure concrete. However, the engineer may select
high-pressure concrete or ductile iron because it is less susceptible to collapse and
may eliminate the need for operational constraints.

Piping systems constructed above ground are more susceptible to collapse than buried
pipelines. With buried pipelines, the surrounding bedding material and soil provide
additional resistance to pipeline deformations and help the pipeline resist structural
collapse. Above-ground pipelines must be anchored securely against steady-state and
transient forces.

Using combination-air valves to avoid subatmospheric or vacuum conditions requires

careful analysis of possible transient conditions to ensure that the air valve is
adequately sized and designed. Several cases cited in the literature describe the
collapse of piping systems due to the failure of an air inlet valve that was poorly sized,
designed, or maintained. Combination-air valves can provide reliable surge control,
but the potential for operational failures in air valves should not be ignored.

Bentley HAMMER V8i Edition User’s Guide 14-1039

Developing a Surge-Control Strategy

Other factors that influence extreme transient heads are pressure wave speed and
liquid velocity. Selecting larger diameters to obtain lower velocities with the purpose
of minimizing transient heads is acceptable for short pipeline systems delivering rela-
tively low flows. However, for long pipeline systems, the diameter should be selected
to optimize construction and operating costs. Long piping systems almost always
require transient protection devices.

After considering these factors during the conceptual and preliminary designs, the
project should move into the final design phase. Any changes to the system during
final design should be analyzed with the transient model to verify that the previous
results and specifications are still appropriate prior to commissioning.

RELATED TOPICS

• See “Protection Devices” on page 1040.

• See “Approaches to Surge Protection” on page 1042.
• See “Pump Protection” on page 1052.
• See “Surge-Relief Valves” on page 1055.
• See “Operation and Maintenance” on page 1062.
• See “Developing a Surge-Control Strategy” on page 1037.

14.13.2 Protection Devices

Using a transient model, the engineer can try different valve operating speeds, pipe
sizes, and pump controls to see if the transient effects can be controlled to acceptable
levels. If transients cannot be prevented, specific devices to control transients may be
needed.

Some methods of transient prevention include:

• Slow opening and closing of valves—Generally, slower valve-operating times

are required for longer pipeline systems. Operations personnel should be trained
in proper valve operation to avoid causing transients.
• Proper hydrant operation—Closing fire hydrants too quickly is the leading
cause of transients in smaller distribution piping. Fire and water personnel need to
be trained on proper hydrant operation.
• Proper pump controls—Except for power failures, pump flow can be slowly
controlled using various techniques. Ramping pump speeds up and down with
soft-start or variable-speed drives can minimize transients, although slow opening
and closing of pump-control valves downstream of the pumps can accomplish a
similar effect, often at lower cost. The control valve should be opened slowly after
the pump is started and closed slowly prior to shutting down the pump.

14-1040 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

• Lower pipeline velocity—Pipeline size and thus cost can be reduced by allowing
higher velocities. However, the potential for serious transients increases with
decreasing pipe size. It is usually not cost effective to significantly increase pipe
size to minimize transients, but the effect of transients on pipe sizing should not be
ignored in the design process.
• Stronger pipe—For long-term reliability, pipes and joints should be strong
enough to resist both high and subatmospheric, or even vacuum, pressures.

To control minimum pressures, the following can be adjusted or implemented:

• Pump inertia
• Surge tanks
• Air chambers
• One-way tanks
• Air inlet valves
• Pump bypass valves

To control maximum pressures, the following can be implemented:

• Relief valves
• Anticipator relief valves
• Surge tanks
• Air chambers
• Pump bypass valves

The items in the preceding lists are discussed in the sections that follow. These items
can be used singly or in combination with other devices.

RELATED TOPICS

• See “Piping System Design and Layout” on page 1039.

• See “Approaches to Surge Protection” on page 1042.
• See “Pump Protection” on page 1052.
• See “Surge-Relief Valves” on page 1055.
• See “Operation and Maintenance” on page 1062.
• See “Developing a Surge-Control Strategy” on page 1037.

Bentley HAMMER V8i Edition User’s Guide 14-1041

Developing a Surge-Control Strategy

14.13.3 Approaches to Surge Protection

A reliable surge-protection system must be in place before the occurrence of uncon-

trolled emergency conditions (e.g., power failure or load rejection in a pump or
turbine). The most common tactics to control water hammer can be grouped into three
categories, as shown in the following table.

Table 14-6: Comparison of Surge-Protection Approaches

System- Flow-
Surge-Relief
Approach Improvement Supplement
Approach
Approach Approach

• Realign pipeline • Surge tank • Various surge-

route control valves
• Air chamber
including
Surge Control • Recut or
• Increase pump SRV, CAV,
Measures/Impacts improve profile
inertia and SAV
• Enlarge pipe size
• Rupture disk
• Reduce flow

Reliability +++++ +++ +

Cost --- - +++

Operation and
+++++ +++ +
Maintenance

Complexity +++ ++ +

Flexibility --- + +++

• Legend: + Positive effect, - Negative effect

Note: Careful operational procedures and maintenance programs are

very important to protect the water system from water hammer
damage due to equipment malfunction.

These three approaches differ significantly in terms of the required civil and piping
works, physical appearance, hydraulic characteristics, long-term reliability, opera-
tional complexity and flexibility, and cost of construction, operation, and mainte-
nance.

However, these measures have a common basis—all three attempt to protect the
system from water hammer by reducing the rate of change of flow to minimize the
effects of transients. Each approach modifies a different governing parameter, as
described in the following sections.

14-1042 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Table 14-7: Governing Parameters for Hydraulic Transients

A) Piping system characteristics

(i) Static variables

• Pipe length (L)

• Pipe size (D)
• Pipe profile
• Static lift (Ho)
• Pipeline surface roughness (C or f)
• Pressure wave speed (a)
• Pipe flow (Q) or velocity (V)
• Node pressure (P) or head (H)
• Network connectivity (looping, branching, dead ends)
B) Pump-motor characteristics (turbine characteristics are similar)
• Power (Pw)
• Rotating speed (N) or torque (M)
• Pump total dynamic head (TDHo)
• Pumping capacity (Qo)

• Moment of inertia (WR2)

• Net positive suction head required (NPSHr)

C) Valve characteristics
• Types (check valve, surge anticipator, vacuum breaker, air release ….)
• Closure characteristics (butterfly, needle, …)
• Operation procedures (time to open, close, operating curve ….)
D) Surge tank characteristics
• Diameter (Ds) or surface area (As)
• Geometry and variation
• Top (spilling) and bottom (dewatering) elevation
• Orifice size and differential ratio

Bentley HAMMER V8i Edition User’s Guide 14-1043

Developing a Surge-Control Strategy

Table 14-7: Governing Parameters for Hydraulic Transients (Cont’d)

E) Air Chamber characteristics

• Diameter (Da) and length (La)
• Orifice size and differential ratio
• Orientation (vertical or horizontal)
F) Transient characteristics
• Upsurge head (Hup)
• Downsurge head (Hdown)
• Flow (Q) and direction
• Vapor or air volume in line
• Time for maximum transient to occur
• Dampening rate

RELATED TOPICS

• See “Piping System Design and Layout” on page 1039.

• See “Protection Devices” on page 1040.
• See “Pump Protection” on page 1052.
• See “Surge-Relief Valves” on page 1055.
• See “Operation and Maintenance” on page 1062.
• See “Developing a Surge-Control Strategy” on page 1037.

14-1044 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

System-Improvement Method
This method is the most reliable, with the least operation and maintenance require-
ment. However, it is very expensive and usually used only as a last resort. It consists
of the following measures:

1. Reduce velocity—The smaller the pipe flow velocity, the less potential there is
for a large rate of change in velocity (dV/dt). Normal velocities can be reduced by
enlarging the pipe diameter or redistributing the flow to twin pipes.
2. Pipe material—The pressure wave speed a of a flexible pipe material is less than
that for rigid pipe. For a very fast stoppage of flow (< 2 L/a), the transient effect of
pressure-wave speed is prominent. Changing pipe material may improve the
outcome, although the surge tolerance of a more flexible pipe may be less.
3. Pipeline improvement—Pipeline profiles with prominent local high points are
susceptible to the occurrence of subatmospheric or even full vacuum pressure,
resulting in water-column separation and vapor or air pockets in the pipeline. Very
high upsurge pressures can result when water columns subsequently rejoin. Extra
excavation or fill can reduce or eliminate local high points.

RELATED TOPICS

• See “Flow-Supplement Approach” on page 1045.

• See “Two-Way Surge Tank” on page 1046.
• See “One-Way Surge Tank” on page 1049.
• See “Gas Vessel or Air Chamber” on page 1049.
• See “Increase of Inertia” on page 1052.

Flow-Supplement Approach
This approach can be used to effectively control transients resulting from a pump shut-
down or startup. Following a power failure, energy stored in hydraulic or mechanical
devices can be converted into kinetic energy to force flow into the system and prevent
vapor or air pockets from forming.

Such energy conversions reduce the rate of change of flow and, consequently, the
magnitude of the resulting hydraulic transients. Part of the flow enters the surge tank
or air chamber at start-up or during the upsurge, thereby reducing the effects of an
otherwise rapid increase in flow. Due to its relatively high cost, this very reliable
method may not be feasible in small water systems.

The following sections describe specific implementations of the flow-supplement

approach.

Bentley HAMMER V8i Edition User’s Guide 14-1045

Developing a Surge-Control Strategy

RELATED TOPICS

• See “System-Improvement Method” on page 1045.

• See “Two-Way Surge Tank” on page 1046.
• See “One-Way Surge Tank” on page 1049.
• See “Gas Vessel or Air Chamber” on page 1049.
• See “Increase of Inertia” on page 1052.

Two-Way Surge Tank

A two-way surge tank controls transients by converting stored potential energy in the
elevated water body inside the tank into kinetic energy, which supplements flow in the
piping system at critical times (or vise versa, for pipe flow into the tank) during
periods of rapid flow variation. The tank is normally located at the pumping station or
at a high point in the system.

A differential orifice may be installed at the riser of the tank to throttle reverse flow
from the system to the tank, but create very little loss for flow leaving the tank. If an
overflow and drain is provided, the tank can also act as a foolproof overpressure
device that can overflow in a controlled manner.

14-1046 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

One of the main concerns is the stability problem inside the tank. A rapid rise or drop
in water level in the tank should be avoided. Usually, the surface area of the tank
should be significantly larger than that of the pipeline. In a high-head water system or
a sanitary forcemain, a two-way surge tank may not be economically feasible because
of height or odor problems. A sample Bentley HAMMER V8i run extracted from a
case study is shown in the following figure.

Bentley HAMMER V8i Edition User’s Guide 14-1047

Developing a Surge-Control Strategy

Surge Tank

Figure 14-16: Output of Bentley HAMMER V8i Run for a Two-Way Surge
Tank

14-1048 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

RELATED TOPICS

• See “System-Improvement Method” on page 1045.

• See “Flow-Supplement Approach” on page 1045.
• See “One-Way Surge Tank” on page 1049.
• See “Gas Vessel or Air Chamber” on page 1049.
• See “Increase of Inertia” on page 1052.

One-Way Surge Tank

A one-way surge tank is a relatively small conventional surge tank, with a check valve
in the connecting pipe, or riser, that only allows flow out of the tank. The tank water
level is maintained by an altitude valve bypassing the check valve. The tank is located
at the high point to supply water and prevent water-column separation. However, one-
way tanks provide no upsurge protection to the system because no flow is allowed
back into the tank. Wherever there is a possibility of freezing, surge tanks may require
insulation or heating.

On sewerage forcemains, special consideration should be given to:

• The design of the check valve at the riser to protect against debris or jamming.
• Careful pump restart procedures following a power failure.
• Cost of refilling this tank with drinking water (to avoid odors).
• A chamber may be required to enclose the tank.
• A sanitary sewer may be required to drain liquid overtopping the tank.

RELATED TOPICS

• See “System-Improvement Method” on page 1045.

• See “Flow-Supplement Approach” on page 1045.
• See “Two-Way Surge Tank” on page 1046.
• See “Gas Vessel or Air Chamber” on page 1049.
• See “Increase of Inertia” on page 1052.

Gas Vessel or Air Chamber

This control device functions similarly to a surge tank but its potential energy is stored
as compressed air. The air chamber is usually used in a high-head pumping system. It
should be located close to the pumping station and inside an enclosed building. Auxil-
iary equipment such as compressors are also required.

Bentley HAMMER V8i Edition User’s Guide 14-1049

Developing a Surge-Control Strategy

A differential orifice can be installed to minimize the chamber size by creating greater
head losses for inflows to the vessel than to outflows entering the system. For a system
with a high friction head, one should consider optimizing the chamber by installing
several clusters of probes, each throttling and/or starting (or stopping) a specific
number of operating pumps. “Figure 14-17: Output of Bentley HAMMER V8i Run
for an Air Chamber”on page 14-1050 shows the effectiveness of a gas vessel in
controlling hydraulic transients.

Figure 14-17: Output of Bentley HAMMER V8i Run for an Air Chamber

14-1050 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Some manufacturers and engineers reduce the air chamber size by letting air into it
during the downsurge period. There are a number of serious concerns in the practical
application of this, as follows:

• If the downsurge head drops to or below the pump station elevation, part of the
pipeline may already be subjected to subatmospheric pressures or even a full-
vacuum condition. This may defeat the purpose of an air chamber installed to
protect against the downsurge.
• Normally, an air chamber requires a high static head to be practical. If the down-
surge head drops to the pump station, a large upsurge head can also bounce back,
considerably higher than the static head. This may also defeat the purpose of its
upsurge protection.
• Air inside a gas vessel (air chamber) is always contained by a thick metal shell
and separated from atmospheric pressure by piping and a reservoir. With an air-
inlet valve mounted on the top, during the downsurge period a large quantity of air
at atmospheric pressure can rush into the chamber. During the upsurge (or even
possibly during normal operation) period, the huge pressure difference between
the inside and outside of the chamber provides a high possibility that a large
volume of air could escape through a leak in the inlet valve. Since an air chamber
is a pressure vessel, pressure inside the chamber is many times greater than atmo-
spheric pressure outside the chamber. The mechanical part of the air-inlet valve
can leak or fail.

When a significant volume is required, two smaller gas vessels should be considered
to provide redundancy whenever one unit has to be maintained, or in case one loses its
gas volume and is ineffective during a transient. The following appurtenances require
careful design:

• There should be two or more redundant air compressors, each equipped with a
tank to store enough air at the required pressure to supply the gas vessel for short
times after a power failure. Compressors should be capable of running from
generators during an extended power failure if diesel fire pumps will be running.
• Level-control probes should be set for high and low level, high and low alarm, and
drain or fill. Compressors should be started and stopped according to these levels.
Avoid setting high- and low-level probes too close to the normal operating range
to avoid spurious warnings—this can cause operators to ignore more serious low-
or high-level alarms.

RELATED TOPICS

• See “System-Improvement Method” on page 1045.

• See “Flow-Supplement Approach” on page 1045.
• See “Two-Way Surge Tank” on page 1046.
• See “One-Way Surge Tank” on page 1049.

Bentley HAMMER V8i Edition User’s Guide 14-1051

Developing a Surge-Control Strategy

• See “Increase of Inertia” on page 1052.

Increase of Inertia
Inertia increases when flywheels are added to a shaft to increase the kinetic energy
stored in rotating parts, thereby buffering a rapid pump shutdown. Pumps have tended
to get smaller and smaller (with less inertia) and lighter, multistage vertical pumps are
used more frequently. This has tended to make this option far less common.

RELATED TOPICS

• See “System-Improvement Method” on page 1045.

• See “Flow-Supplement Approach” on page 1045.
• See “Two-Way Surge Tank” on page 1046.
• See “One-Way Surge Tank” on page 1049.
• See “Gas Vessel or Air Chamber” on page 1049.

14.13.4 Pump Protection

Pump protection includes:

• “Check Valve” on page 14-1053

• “Booster Pump Bypass” on page 14-1053

RELATED TOPICS

• See “Piping System Design and Layout” on page 1039.

• See “Protection Devices” on page 1040.
• See “Approaches to Surge Protection” on page 1042.
• See “Surge-Relief Valves” on page 1055.
• See “Operation and Maintenance” on page 1062.
• See “Developing a Surge-Control Strategy” on page 1037.

14-1052 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Check Valve
A check valve on the discharge line of a pump should have a fast closing time to
prevent flow reversal through the pump and the valve slam that can occur with
delayed valve closure, or where surge tanks are incorporated into the pump station
design. Valve slam can damage the valve, pump, or system piping. If it is not possible
to have a check valve that closes before the surge tank responds and slams the valve,
some type of dampening device, such as a dash pot, is necessary to control valve
closure during the last 5 to 10 percent of the valve travel.

RELATED TOPICS

• See “Booster Pump Bypass” on page 1053.

• See “Pump Protection” on page 1052.

Booster Pump Bypass

Another type of protection device is the pump bypass. The following figure shows a
booster pumping system. When the booster pumps shut down, the resulting reduction
in flow generates pressure waves on both sides of the pump. The wave traveling
upstream is a positive transient and the wave traveling downstream is a negative tran-
sient.

Figure 14-18: Booster Pumping System with Bypass

Depending on the relative lengths of the upstream pipeline (LS) and the downstream
pipeline (LR) and the magnitude of the velocity changes, a pump bypass connection
can act as a transient protection element. Water continues past the booster station if the
downstream pressure falls below the upstream pressure, thus limiting the pressure rise
upstream of the booster station and the pressure drop downstream.

Bentley HAMMER V8i Edition User’s Guide 14-1053

Developing a Surge-Control Strategy

The next figure shows the transient analysis results for such a system. These results
show that the bypass opened to transfer water from the upstream pipeline to the down-
stream pipeline, which helped to attenuate or control the maximum and minimum
pressure transients on the upstream and downstream sides of the station.

Figure 14-19: Booster Pump Shutdown

The effectiveness of a booster-station bypass depends on the specific booster pumping

system and the relative lengths of the upstream and downstream pipelines. If the low-
pressure surge generated on the discharge side of the pump is still greater than the
high-pressure surge generated on the suction side of the pump (which tends to occur if
LR < LS), the bypass will not open. For systems in which the bypass may not open,
other transient protection devices are necessary. Each system should be individually
analyzed to assess the occurrence of excessive high- and/or low-pressure transients
and determine strategies to control potentially excessive pressures.

RELATED TOPICS

• See “Check Valve” on page 1053.

• See “Booster Pump Bypass” on page 1053.
• See “Pump Protection” on page 1052.

14-1054 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

14.13.5 Surge-Relief Valves

There are many documented cases of poorly specified control valves. Some of these
valves do not operate adequately because of excessive head loss or cavitation during
steady-state flow conditions; others are inadequate to control hydraulic transients
because of poor valve selection or poor operation. When specifying valves for flow
control and/or pumping stations, the engineer must carefully evaluate the type,
number, and size of valves to provide adequate steady and transient flow regulation.

Note: Even with a comprehensive understanding of the system

equipment and operations, the engineer should realize that it
may not be possible to precisely model the actual system and
system components. Therefore, it is the engineer’s
responsibility to recognize these modeling limitations, use
appropriate safety factors, and apply good engineering
judgement when performing transient analysis.

The advantage of surge-relief valves is that they are relatively inexpensive and easy to
fit into a pumping system at the locations of interest. Generally, valves control surge
conditions by opening and/or closing according to preset characteristics. This restricts
hydraulic transients to more tolerable limits, but it can rarely eliminate cavitation or
water-column separation. Moreover, if the valves are oversized or operated too
rapidly, other types of water hammer problems may result (e.g., water bleeding, and
excessive flow reversals), possibly resulting in worse transients than without valve
protection. However, with careful Bentley HAMMER V8i modeling and design,
valves offer a versatile and powerful means to safely control water hammer.

The following are different types of surge-relief valves:

• Check valve—mechanical or electrical control

• Pressure-relief valve
• Station-bypass line with check valve
• Inline bypass with check valve
• Air-inlet (vacuum breaker) valve
• Air-release valve
• Combined air valve
• Hydraulically controlled slow-closing air valve
• Surge-anticipator valve
• Rupture disk

The following descriptions and figures show their geometry and schematics:

Bentley HAMMER V8i Edition User’s Guide 14-1055

Developing a Surge-Control Strategy

Check valve—a check valve is commonly installed in a municipal pumping station to

prevent flow from reversing through the pump. A dashpot may be provided to avoid
check valve slam; however, surges still may occur in the piping system and other
methods may also be required. A check valve equipped with an electronically
controlled closure device is often used by engineers. The timing and rate of closure
must be carefully set to protect both the pump and the discharge system.

Qo
Flow at P.S.

Flow
Check With Valve

Time
a) Check Valve Rotential
Reverse Flow

Pressure-relief valve—This valve is usually installed across the pumps and discharge
headers or at critical points along the pipeline. It opens when a preset pressure is
exceeded and closes immediately after pressure drops below this setting. A damped
closure may be provided to allow for a longer closing time. One of the main concerns
is the considerable time lag for the valve to open following a power failure. Transient
pressure waves can come and go in a fraction of second. Very often, this valve is used
as a redundant measure, to limit the pressure rise during normal pumping operations.

Pump station bypass with check valve—If the suction water level is high, a bypass
line can slow the reduction in flow by supplying water to the pipeline during the
downsurge period (following a power failure) using potential energy in the suction
reservoir. However, it provides no upsurge protection to a pumping system because no
back flow is allowed through the check valve. It can be effective in a downhill or flat
pipeline.

14-1056 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

A smaller bypass line is sometimes provided (as shown by dotted lines) around the
check valve in the primary bypass line.

Inline bypass with check valve—The check valve is usually located downstream of
the location of cavitation at a high point. The bypass line should be sized so that no
high pressure is built up at the downstream section and no large reverse-flow velocity
occurs in the upstream section of the check valve. Normally, an air valve needs to be
installed at the crest to eliminate vapor pressure, and a surge-anticipator valve is
located at the pump station to protect it and the pipe section between the pump and the
high point.

Air-inlet (vacuum-breaker) valve—This valve consists of an orifice that can be

opened or blocked based on system pressure, often by a float device. When pressure
drops below the valve elevation, air is sucked in quickly through the inlet orifice to
maintain atmospheric pressure. If the opening is too small, the incoming air velocity
may reach the sonic limit, resulting in subatmospheric pressure inside the system. This
valve does not allow air to escape the system; it must exit farther down the line.

Air-release valve—This valve also consists of an orifice equipped with a mechanism

to open or close it, often by a float device. When air accumulates inside the valve
body, or reaches a preset residual volume, air is released from the valve in an orderly
and gradual manner. Air is not allowed to enter the system. This valve is commonly
installed at all local high points within the water system.

Bentley HAMMER V8i Edition User’s Guide 14-1057

Developing a Surge-Control Strategy

Combination air valve—Combination air valves consist of at least two components:

a) a large air inlet valve, b) a large outlet orifice (two-way), and possibly a restrictor of
some kind to reduce the opening to a much smaller orifice (three-way) when air in the
valve body is less than the residual volume. When pressure drops below the elevation
of the valve, air enters quickly through the vacuum breaker to maintain the pressure
near atmospheric. Upon the upsurge, air can be expelled quickly through the bigger
outlet, until the air in the system is almost totally removed and water starts to enter the
valve body. The remaining air volume inside the valve is released in a controlled
manner by the small outlet orifice, acting as an air cushion to reduce the transient pres-
sure rise.

This type of valve is popular both for water-distribution systems and sanitary force-
mains. However, if the air volume allowed into the pipe system is big and, if it is
released too quickly, excessively high transient pressures can occur when the two
water columns accelerate towards each other during a prolonged period of air release.
The static head can defeat the effectiveness of the air cushion due to the large buildup
of momentum in these accelerating water columns.

14-1058 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Hydraulically controlled slow-closing air valves—This valve is located at high

points of the piping system and acts like an air-inlet valve and surge-anticipator. When
line pressure at the valve drops below atmospheric pressure, it admits air into the pipe-
line. Upon upsurge, air, water, or a mixture of air and water can bleed out to the atmo-
sphere. One of the drawbacks of this installation is the need for a piping system to
drain water away.

Surge-anticipator valve—The surge anticipator is normally installed across the

pump suction and discharge headers, with suitable connecting piping. It opens quickly
at a specified time after power failure (or at a preset low-pressure limit) to allow flow
to begin before the main upsurge returns to the pump station, then closes slowly at a
preadjusted rate. During the valve-closing period, flow may decrease much more
rapidly than the opening area of the valve. High flow velocities in the pipeline can
prevent a hydraulically actuated SAV from closing, in extreme cases. Consult the
valve manufacturer’s catalog to select the correct valve type, size, and piloting (if
applicable) for your application.

Time
Delay Fully Open

Valve Operation
Valve Opening

(Automatic Control)

Fast Open Slow Closing

g) Surge Anticipator Time

Bentley HAMMER V8i Edition User’s Guide 14-1059

Developing a Surge-Control Strategy

Rupture disk—A rupture disk is equipped with a membrane which can burst to
discharge a large flow rate and relieve mass (pressure) from the system whenever tran-
sient pressures exceed a pre-set value. Such disks may rupture at a different pressure
and both the upper and lower burst limit provided by the manufacturer should be
modeled using Bentley HAMMER V8i.

Pressure-sustaining valve—This valve is usually installed at the downstream end of

a pump-discharge line. It dissipates large amounts of energy just before flow drains to
a lower-energy water system. The valve sustains a stable pressure to the upstream,
higher-head system, by adjusting the opening area of the valve multi-orifices.
However, during the transient period, this valve cannot physically tune the orifices
fast enough to catch rapid pressure changes.

14-1060 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

A sample run based on a case study is presented in the following figure. As shown, the
combination air valve does not help to control surge due to the big air pocket and the
high head at the downstream reservoir, in this particular case.

Figure 14-20: Bentley HAMMER V8i Results for a Combined Air Valve

Bentley HAMMER V8i Edition User’s Guide 14-1061

Developing a Surge-Control Strategy

RELATED TOPICS

• See “Piping System Design and Layout” on page 1039.

• See “Protection Devices” on page 1040.
• See “Approaches to Surge Protection” on page 1042.
• See “Pump Protection” on page 1052.
• See “Operation and Maintenance” on page 1062.
• See “Developing a Surge-Control Strategy” on page 1037.

14.13.6 Operation and Maintenance

The following items can be considered when setting operation and maintenance
procedures for a pumping system:

• Time delay—Following a power failure or emergency shutdown, pumps should

be restarted only after transients have had sufficient time to decay and air has been
removed from the piping as much as possible. A transient decay analysis can be
simulated and a timer should be used to prevent a premature pump restart of:
– The diesel pump
– The duty pump (if power resumed quickly)
– The standby power grid

Transient Tip: Restart time delays required to allow transients to decay

are typically short in terms of water supply (tens of
seconds). However, transients caused by a power failure
may already have come and gone (in a fraction of
second) within the same restart period. Should
significant air still remain in the water system, a fast
restart of the above device may actually worsen
hydraulic transients.

• Slow change of pump operation—Flow in the water system will increase or

decrease slowly if the following procedures are applied:
– Sequential pump shutdown or startup
– Variable-speed pump ramps up and down gradually
– Soft-start motor controllers for pump startup and shutdown
– Slow and progressive operation of pump discharge control valves
– Slow operation of isolation valves, drain valves, or reservoir/tank inlet valves

14-1062 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

• Air venting—The air trapped at local high points must always be released during
both normal and emergency pumping operations. During line filling, air at local
high points must be vented in the proper order and pump flow must be much
smaller than its design capacity to avoid severe hydraulic transients and pipe
breaks.
• Suction system hydraulics—The size of the suction well and/or the suction lines
should be designed and operated adequately to prevent spilling or dewatering.
Whenever the capacity of the pump station increases, the suction system should
be modeled and possibly upgraded to ensure that NPSHA is greater than NPSHR,
while the upstream reservoir can freely fluctuate between designed high- and low-
water levels.
• Slow change of valve operation—Valve opening or closing times must be long
enough. Alternatively, two or more stages can be used, with different stroke
speeds for each.
• Alarm setup—Alarm systems should be regularly tested and checked. If false
alarms occur frequently, conduct an analysis to determine the causes and provide
remedial measures. Otherwise, operators may shutdown the alarm system to elim-
inate annoyances.
• Maintenance—It is essential to regularly inspect and clean the protection
devices, particularly those located outside the pump station.
• Staff training—A workshop can be presented to the engineers and operators, who
often know their water system better than any expert. Very often, the system needs
to be pushed beyond normal operating ranges to achieve the water-supply objec-
tives. Training is particularly critical for existing pumping stations that have been
upgraded many times. It is also possible that operators are not aware of transients
occurring far from the pump station, where no one may be present to experience
them.

RELATED TOPICS

• See “Piping System Design and Layout” on page 1039.

• See “Protection Devices” on page 1040.
• See “Approaches to Surge Protection” on page 1042.
• See “Pump Protection” on page 1052.
• See “Surge-Relief Valves” on page 1055.
• See “Developing a Surge-Control Strategy” on page 1037.

Bentley HAMMER V8i Edition User’s Guide 14-1063

Engineer’s Reference

14.14 Engineer’s Reference

This section describes the engineering libraries available to HAMMER users and
provides tables of commonly used roughness values and fitting loss coefficients. Also
included are liquid properties at standard temperatures and pressures. Each parameter
library is discussed in a separate section:

• Liquids—It is essential to regularly inspect and clean the protection devices,

particularly those located outside the pump station.
• Materials—It is essential to regularly inspect and clean the protection devices, p
• Valves—It is essential to regularly inspect and clean the protection devices, p
• Pumps—It is essential to regularly inspect and clean the protection devices, p
• Turbines—It is essential to regularly inspect and clean the protection devices, p

Transient Tip: It is the responsibility of the hydraulic transient analyst

to select appropriate model parameters. Correct results
depend on correct input and interpretation of the output.

Roughness Values:

• “Roughness Values—Manning’s Equation” on page 14-1065

• “Roughness Values—Darcy-Weisbach Equation (Colebrook-White)” on page 14-
1066
• “Roughness Values—Hazen-Williams Equation” on page 14-1067
• “Typical Roughness Values for Pressure Pipes” on page 14-1068
• “Fitting Loss Coefficients” on page 14-1069

RELATED TOPICS

• See “Acknowledgements” on page 960.

• See “Overview of Hydraulic Transients” on page 961.
• See “Hydraulic Transient Theory” on page 970.
• See “Water System Characteristics” on page 985.
• See “Pump Theory” on page 995.
• See “Valve Theory” on page 1002.
• See “Friction and Minor Losses” on page 1016.
• See “Developing a Surge-Control Strategy” on page 1037.
• See “References” on page 1072.

14-1064 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

14.14.1 Roughness Values—Manning’s Equation

Commonly used roughness values for different materials are:

Table 14-8: Manning’s Coefficient (n) for Closed Metal Conduits

Flowing Partly Full

Channel Type and Description Minimum Normal Maximum

a. Brass, smooth 0.009 0.010 0.013

b. Steel

1. Lockbar and welded 0.010 0.012 0.014

2. Riveted and spiral 0.013 0.016 0.017

c. Cast iron

1. Coated 0.010 0.013 0.014

2. Uncoated 0.011 0.014 0.016

d. Wrought iron

1. Black 0.012 0.014 0.015

2. Galvanized 0.013 0.016 0.017

e. Corrugated metal

1. Subdrain 0.017 0.019 0.021

2. Storm drain 0.021 0.024 0.030

Bentley HAMMER V8i Edition User’s Guide 14-1065

Engineer’s Reference

14.14.2 Roughness Values—Darcy-Weisbach Equation

(Colebrook-White)

Commonly used roughness values for different materials are:

Table 14-9: Darcy-Weisbach Roughness Heights e for Closed

Conduits

Pipe Material  (mm)  (ft.)

Glass, drawn brass, copper (new) 0.0015 0.000005

Seamless commercial steel (new) 0.004 0.000013

Commercial steel (enamel coated) 0.0048 0.000016

Commercial steel (new) 0.045 0.00015

Wrought iron (new) 0.045 0.00015

Asphalted cast iron (new) 0.12 0.0004

Galvanized iron 0.15 0.0005

Cast iron (new) 0.26 0.00085

Concrete (steel forms, smooth) 0.18 0.0006

Concrete (good joints, average) 0.36 0.0012

Concrete (rough, visible, form marks) 0.60 0.002

Riveted steel (new) 0.9 ~ 9.0 0.003 - 0.03

Corrugated metal 45 0.15

14-1066 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

14.14.3 Roughness Values—Hazen-Williams Equation

Commonly used roughness values for different materials are:

Table 14-10: Hazen-Williams Roughness

Coefficients (C)

Pipe Material C

Asbestos Cement 140

Brass 130-140

Brick sewer 100

Cast-iron

New, unlined 130

10 yr. Old 107-113

20 yr. Old 89-100

30 yr. Old 75-90

40 yr. Old 64-83

Concrete or concrete lined

Steel forms 140

Wooden forms 120

Centrifugally spun 135

Copper 130-140

Galvanized iron 120

Glass 140

Lead 130-140

Plastic 140-150

Steel

Coal-tar enamel, lined 145-150

New unlined 140-150

Bentley HAMMER V8i Edition User’s Guide 14-1067

Engineer’s Reference

Table 14-10: Hazen-Williams Roughness

Coefficients (C) (Cont’d)

Pipe Material C

Riveted 110

Tin 130

Vitrified clay (good condition) 110-140

Wood stave (average condition) 120

14.14.4 Typical Roughness Values for Pressure Pipes

Typical pipe roughness values are shown below. These values vary according to the
manufacturer, workmanship, age, and many other factors.

Table 14-11: Comparative Pipe Roughness Values

Manning’s Hazen-
Darcy-Weisbach
Material Coefficient Williams
Roughness Height
n C

k (mm) k (0.001 ft)

Asbestos cement 0.011 140 0.0015 0.005

Brass 0.011 135 0.0015 0.005

Brick 0.015 100 0.6 2

Cast-iron, new 0.012 130 0.26 0.85

Concrete:

Steel forms 0.011 140 0.18 0.6

Wooden forms 0.015 120 0.6 2

Centrifugally spun 0.013 135 0.36 1.2

Copper 0.011 135 0.0015 0.005

Corrugated metal 0.022 — 45 150

Galvanized iron 0.016 120 0.15 0.5

Glass 0.011 140 0.0015 0.005

Lead 0.011 135 0.0015 0.005

14-1068 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Table 14-11: Comparative Pipe Roughness Values (Cont’d)

Manning’s Hazen-
Darcy-Weisbach
Material Coefficient Williams
Roughness Height
n C

Plastic 0.009 150 0.0015 0.005

Steel

Coal-tar enamel 0.010 148 0.0048 0.016

New unlined 0.011 145 0.045 0.15

Riveted 0.019 110 0.9 3

Wood stave 0.012 120 0.18 0.6

14.14.5 Fitting Loss Coefficients

For similar fittings, the K-value is highly dependent on such things as bend radius and
contraction ratios.

Table 14-12: Typical Fitting K Coefficients

Fitting K Value Fitting K Value

Pipe Entrance 90° Smooth Bend

Bellmouth 0.03-0.05 Bend Radius / D = 4 0.16-0.18

Rounded 0.12-0.25 Bend Radius / D = 2 0.19-0.25

Sharp-Edged 0.50 Bend Radius / D = 1 0.35-0.40

Projecting 0.80 Mitered Bend

Contraction—Sudden  = 15° 0.05

D2/D1 = 0.80 0.18  = 30° 0.10

D2/D1 = 0.50 0.37  = 45° 0.20

D2/D1 = 0.20 0.49  = 60° 0.35

Contraction—Conical  = 90° 0.80

D2/D1 = 0.80 0.05 Tee

D2/D1 = 0.50 0.07 Line Flow 0.30-0.40

Bentley HAMMER V8i Edition User’s Guide 14-1069

Engineer’s Reference

Table 14-12: Typical Fitting K Coefficients (Cont’d)

Fitting K Value Fitting K Value

D2/D1 = 0.20 0.08 Branch Flow 0.75-1.80

Expansion—Sudden Cross

D2/D1 = 0.80 0.16 Line Flow 0.50

D2/D1 = 0.50 0.57 Branch Flow 0.75

D2/D1 = 0.20 0.92 45° Wye

Expansion—Conical Line Flow 0.30

D2/D1 = 0.80 0.03 Branch Flow 0.50

D2/D1 = 0.50 0.08

D2/D1 = 0.20 0.13

14.14.6 Properties of Common Liquids

Hydraulic transient analysis requires the correct specific gravity, kinematic viscosity
and vapor pressure. The following table lists liquids included in the HAMMER
library: liquids.xml (an editable text file). If the temperature of your liquid differs
from available table entries, select the nearest one or interpolate between table values.

Table 14-13: Liquid Properties

WaterCAD Specific Kinematic Viscosity Vapor

Liquid
library? Gravity (m2/s) Pressure (m)

Water at 4ºC (39ºF) Yes 1.000 1.5656(10)-6 -10.25

Water at 10ºC (50ºF) 1.001 1.344(10)-6 -10.21

Water at 15.6ºC (60ºF) 1.000 1.123(10)-6 -10.15

Water at 20ºC (68ºF) Yes 1.000 1.004(10)-6 -10.09

Water at 54.0ºC(130ºF) 0.988 5.160(10)-7 -8.72

Water at 160ºC(320ºF) 0.909 -999 52.7

Ethyl Alcohol at
20ºC(68ºF)
Yes 0.790 1.500(10)-6 -999

14-1070 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Table 14-13: Liquid Properties (Cont’d)

WaterCAD Specific Kinematic Viscosity Vapor

Liquid
library? Gravity (m2/s) Pressure (m)

Carbon tetrachloride at
20ºC(68ºF)
Yes 1.590 6.000(10)-7 -999

Kerosene at 20ºC(68ºF) Yes 0.810 2.370(10)-6 -999

Mercury at 20ºC(68ºF) Yes 13.550 1.200(10)-7 -999

Mercury at 38ºC(100ºF) 13.600 1.100(10)-7 -999

SAE 10W at
38ºC(100ºF)
Yes 0.870 4.100(10)-5 -999

SAE 10W-30 at
38ºC(100ºF)
Yes 0.880 7.600(10)-5 -999

SAE 30 at 38ºC(100ºF) Yes 0.880 1.100(10)-4 -999

SAE 30 at 54ºC(130ºF) 0.908 4.750(10)-5 -999

Sea water at 10ºC(50ºF) Yes 1.030 1.400(10)-6 -999

Freon at 21ºC(70ºF) 1.430 2.950(10)-7 -999

Glycerine at 20ºC(68ºF) Yes 1.260 5.100(10)-4 -999

Glycerine at
38ºC(100ºF)
1.260 1.760(10)-4 -999

Propylene glycol at
21ºC(70ºF)
1.038 1.5.200(10)-5 -999

Hydrochloric acid
(31.5%) at 20ºC(68ºF)
1.050 1.900(10)-6 -999

Sulfuric acid(100%) at
20ºC(68ºF)
1.830 1.460(10)-5 -999

Gasoline at 16ºC(60ºF) 0.710 6.700(10)-7 -999

Gasoline at 38ºC(100ºF) 0.710 5.550(10)-7 -999

Kerosene at
38ºC(100ºF)
0.800 2.000(10)-6 -999

60 Brix Sucrose solution

at 21ºC(70ºF)
1.290 4.970(10)-5 -999

60 Brix Sucrose solution

at 38ºC(100ºF)
1.290 1.870(10)-5 -999

Bentley HAMMER V8i Edition User’s Guide 14-1071

References

Table 14-13: Liquid Properties (Cont’d)

WaterCAD Specific Kinematic Viscosity Vapor

Liquid
library? Gravity (m2/s) Pressure (m)

70 Brix Sucrose solution

at 21ºC(70ºF)
1.350 3.640(10)-4 -999

70 Brix Sucrose solution

at 38ºC(100ºF)
1.350 8.660(10)-5 -999

Milk at 20ºC(68ºF) 1.035 1.130(10)-6 -999

Blackstrap molasses at
38ºC(100ºF)
1.475 5.500(10)-3 -999

Note: Units shown in the table correspond to units in the liquids.xml library file.

The values in the above table are taken from the WaterCAD/WaterGEMS engineering
library files and from Tables 6, 7 and 8 in the Pump Handbook (Karassik, 2001).

14.15 References
Allievi, L., “General Theory of Pressure Variation in Pipes”, Ann. D. Ing. Et Archit.
Ital. Dec. 1902. English translation by Holmes, E., ASME, 1925

ASCE. (1975). Pressure Pipeline Design for Water and Wastewater. ASCE, New York,
New York.

Bergant, A., Simpson, A. and Vitkovsky, J., "Developments in unsteady pipe flow
friction modeling," Journal of Hydraulic Research, Vol. 39, No. 3, 2001

Bergeron, L., “Waterhammer in Hydraulics and Wave Surge in Electricity”, John

Wiley & Sons, Inc., N.Y., 1961

Brunone, B., Golia, U.M., and Greco, M. , "Some Remarks on the Momentum Equa-
tion for Fast Transients", International Meeting on Hydraulic Transients with Column
Separation, 9th Round Table, IAHR, Valencia, Spain, 1991.

Brunone, B., Karney, B.W., Mecarelli, M., and Ferrante, M. “Velocity Profiles and
Unsteady Pipe Friction in Transient Flow” Journal of Water Resources Planning and
Management, ASCE, 126(4), 236-244, Jul. 2000.

Bughazem, M.B. and Anderson, A., "Investigation of an Unsteady Friction Model for
Waterhammer and Column Separation", The 8th International Conference on Pressure
Surges, BHR, The Hague, The Netherlands, 2000.

14-1072 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Chaudhry, M.H., “Applied Hydraulic Transients”, Van Nostrand Reinhold Co., N.Y.,
1979

Chaudhry, M.H. and Yevjevich, V. (1981) “Closed Conduit Flow”, Water Resources
Publication, USA

Chaudhry, M. H. (1987). Applied Hydraulic Transients. Van Nostrand Reinhold, New

York.

Comolet, R., "Mecanique Experimentale des Fluides, Tome 1: Statique et Dynamique

des Fluides non Visqueux", Masson, Paris, France, 1961.

Elansari, A. S., Silva, W., and Chaudhry, M. H. (1994). “Numerical and Experimental
Investigation of Transient Pipe Flow.” Journal of Hydraulic Research, 32, 689.

Filion, Y., and Karney, B. W. (2002). “A Numerical Exploration of Transient Decay

Mechanisms in Water Distribution Systems.”, Proceedings of the ASCE Environ-
mental Water Resources Institute Conference, American Society of Civil Engineers,
Roanoke, Virginia

Fok, A., “Design Charts for Air Chamber on Pump Pipelines”, J. of Hyd. Div., ASCE,
Sept. 1978

Fok, A., Ashamalla, A., and Aldworth, G., “Considerations in Optimizing Air
Chamber for Pumping Plants”, Symposium on Fluid Transients and Acoustics in the
Power Industry, San Francisco, U.S.A. Dec. 1978

Fok, A., “Design Charts for Surge Tanks on Pump Discharge Lines”, BHRA 3rd Int.
Conference on Pressure Surges, Bedford, England, Mar. 1980.

Fok, A., “Waterhammer & Its Protection in Pumping Systems”, Hydrotechnical

Conference, CSCE, Edmonton, May 1982

Fok, A., “A contribution to the Analysis of Energy Losses in Transient Pipe Flow”,
Ph.D. Thesis, University of Ottawa, 1987

Fox, J.A., “Hydraulic Analysis of Unsteady Flow in Pipe Network”, Wiley, N.Y., 1977

Hamam, M.A. and McCorquodale, J.A., “Transient Conditions in the Transition from
Gravity to Surcharged Sewer Flow”, Canadian J. of Civil Eng., Sep. 1982

Jaeger, C., “Fluid Transients in Hydro-Electric Engineering Practice”, Blackie & Son
Ltd., 1977

Jelev, I. , "The Damping of Flow and Pressure Oscillations in Water Hammer Anal-
ysis", Journal of Hydraulic Research, Delft, The Netherlands, 27(1), 1989.

Bentley HAMMER V8i Edition User’s Guide 14-1073

References

Joukowski, N. Paper to Polytechnic Soc. Moscow, Spring of 1898, English translation

by Miss O. Simin. Proc. AWWA, 1904

Karassik, I.J. (Editor), “Pump Handbook - Third Edition”, McGraw-Hill, 2001.

Koelle, E., Luvizotto, Jr., E., and Andrade, J.P.G. “Personality Investigation of
Hydraulic Networks using MOC – Method of Characteristics” Proceedings of the 7th
International Conference on Pressure Surges and Fluid Transients, Harrogate Durham,
United Kingdom, 1996.

Li, J. & McCorquodale, A. (1999) “Modelling Mixed Flow in Storm Sewers,” Journal
of Hydraulic Engineering, ASCE, Vol. 125, No. 11, pp. 1170-1180.

Moody, L. F., “Friction Factors for Pipe Flow”, Trans. ASME, Vol. 66, 1944

Parmakian, J., “Waterhammer Design Criteria”, J. of Power Div., ASCE, Sept. 1957

Parmakian, J. (1963). Waterhammer Analysis. Dover Publications, Inc., New York,

New York.

Parmakian, J., "Waterhammer Relief with Valves for Pumping Installations", Amer-
ican Water Works Association - Ontario Section, Seminar on Effective Valve Selec-
tion for Control of Water, Toronto, Canada, 1980.

Pezzinga, G., "Quasi-2D Model for Unsteady Flow in Pipe Networks", Journal of
Hydraulic Engineering, ASCE, 125(7), 1999.

Pickford, J., “Analysis of Surge”, Macmillian, London 1969

Provoost, G.A., "Investigation into Cavitation in a Prototype Pipeline Caused by Water

Hammer", Proceedings of the Second International Conference on Pressure Surges,
London, England, 1976.

Quick, R.S., “Comparison & Limitations of Various Waterhammer Theories”, J. of

Hyd. Div., ASME, May 1933

Rich, G.R., “Hydraulic Transients”, Dover, USA 1963

Savic, D.A., and Walters, G.A. (1995). “Genetic Algorithms Techniques for Cali-
brating Network Models”, Report No. 95/12, Centre for Systems and Control Engi-
neering, School of Engineering, University of Exeter, Exeter, United Kingdom, 41.

Sharp, B., “Waterhammer Problems & Solutions”, Edward Arnold Ltd., London 1981

Shuy, E.B. (1996). "Wall Shear Stress in Accelerating and Decelerating Turbulent
Pipe Flows", Journal of Hydraulic Research, 34(2), 1996.

14-1074 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Silva-Araya, W.F. and Chaudhry, M.H., "Computation of Energy Dissipation in Tran-

sient Flow", Journal of Hydraulic Engineering, ASCE, 123(2), 1997.

Skousen, P., “Valve Handbook”, McGraw Hill, New York, 1998

Song, C.C. et al, “Transient Mixed-Flow Models for Storm Sewers”, J. of Hyd. Div.,
Vol. 109, Nov. 1983

Stephenson, D., “Pipe Flow Analysis”, Elsevier, Vol. 19, S.A. 1984

Streeter, V. L., Lai, C. (1962). “Waterhammer Analysis Including Fluid Friction.”

Journal of Hydraulics Division, ASCE, 88, 79.

Streeter V.L. and Wylie E.B., “Fluid Mechanics”, McGraw-Hill Ltd., USA 1981

Stepanoff, A.J., "Centrifugal and Axial Flow Pumps", John Wiley and Sons, Inc., New
York, N.Y., USA, 1963.

Strohmer, F., "Investigating the Characteristics of Shutoff Valves by Model Tests",

Water Power and Dam Construction, 1977.

Swamee, P.K. and Jain, A.K., "Explicit Equations for Pipe-Flow Problems", Journal of
the Hydraulics Division, ASCE, 102(5), 1976.

Thorley, A.R.D., “Fluid Transients in Pipeline Systems”, D.&L. George, Herts,

England, 1991.

Thorley, A.R.D and A. Chaudry., “Pump Characteristics for Transient Flow Analysis”,
Department of Mechnical Engineering & Aeronautics, City University, London ECIV
OHB

Tullis, J.P., “Control of Flow in Closed Conduits”, Fort Collins, Colorado, 1971

Vallentine, H.R., “Rigid Water Column Theory for Uniform Gate Closure”, J. of Hyd.
Div. ASCE, July 1965

Vardy, A.E. and Brown, J.M.B., "Transient Turbulent Smooth Pipe Friction", Journal
of Hydaulic Research, Delft, The Netherlands, 33(4), 1995.

Vardy, A.E. and Hwang, K.L., "A Characteristic Model of Transient Friction in
Pipes", Journal of Hydraulic Research, Delft, The Netherlands, 29(5), 1991.

Vitkovsky, J.P., Lambert, M.F., Simpson, A.R., and Bergant, A., "Advances in
Unsteady Friction Modelling in Transient Pipe Flow", The 8th International Confer-
ence on Pressure Surges, BHR, The Hague, The Netherlands, 2000.

Bentley HAMMER V8i Edition User’s Guide 14-1075

References

Watters, G.Z., “Modern Analysis and Control of Unsteady Flow in Pipelines”, Ann
Arbor Sci., 2nd Ed., 1984.

Walski, T.M. and Lutes, T.L. (1994) “Hydraulic Transients Cause Low-Pressure Prob-
lems.” Journal of the American Water Works Association, 75(2), 58.

Wood, D. J., Dorsch, R. G., and Lightner, C. (1966). “Wave-Plan Analysis of Unsteady
Flow in Closed Conduits.” Journal of Hydraulics Division, ASCE, 92, 83.

Wood, F.M., “History of Waterhammer”, Civil Engineering Research Report, #65,

Queens University, Canada, 1970.

Wood, F.M., “Comparison of the Rigid Column and Elastic Theories for Water-
hammer”, Can. Hydraulic Conference, U. of Alberta, Edmonton, May 1973.

Wu, Z. Y., and Simpson, A.R. “Evaluation of Critical Transient Loading for Optimal
Design of Water Distribution Systems.” Proceedings of the Hydroinformatics confer-
ence, Iowa, 2000.

Wylie, E.B., “Rigid Water Column Theory”, Ch. 6. 7 in “Closed Conduit Flow”,
edited by Chaudhry & Yeijevich, V., Water Resource Publications, USA, 1981

Wylie, E. B., and Streeter, V. L. (1993). Fluid Transients in Systems. Prentice-Hall,

Englewood Cliffs, New Jersey.

Zhou, F., Hicks, F., and Steffler, P., "Analysis of Effects of Air Pocket on Hydraulic
Failure of Urban Drainage Infrastructure", Canadian Journal of Civil Engineering, 31,
2004.

Zielke, W., “Frequency Dependent Friction in Transient Pipe Flow”, Ph. D. Thesis, U.
of Michigan, 1966.

RELATED TOPICS

• See “Acknowledgements” on page 960.

• See “Overview of Hydraulic Transients” on page 961.
• See “Hydraulic Transient Theory” on page 970.
• See “Water System Characteristics” on page 985.
• See “Pump Theory” on page 995.
• See “Valve Theory” on page 1002.
• See “Friction and Minor Losses” on page 1016.
• See “Developing a Surge-Control Strategy” on page 1037.
• See “Engineer’s Reference” on page 1064.

14-1076 Bentley HAMMER V8i Edition User’s Guide

 Bentley HAMMER V8i Theory and Practice

Bentley HAMMER V8i Edition User’s Guide 14-1077

References

14-1078 Bentley HAMMER V8i Edition User’s Guide

 Menus
15
File Menu

Edit Menu

Analysis Menu

Components Menu

View Menu

Tools Menu

Report Menu

Help Menu

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.

Bentley HAMMER V8i Edition User’s Guide 15-1079

File Menu

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.

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 Bentley HAMMER 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).
• Submodels—Opens a Select Submodel File to
Import window where you can choose the file to
import (*.sqlite).
Bentley Water 2004 Edition Model—Opens a
Bentley Water Import window where you can
specify the output water model file.

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).
• HAMMER 7—Export the current project to a
Bentley HAMMER input file (.inp).
• Publish i-model—Opens the Publish to i-
model dialog.

15-1080 Bentley HAMMER V8i Edition User’s Guide

 Menus

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

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.

Bentley HAMMER V8i Edition User’s Guide 15-1081

Edit Menu

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

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 element’s

label.

Analysis Menu
The Analysis menu contains the following commands:

15-1082 Bentley HAMMER V8i Edition User’s Guide

 Menus

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 Opens the Post Calculation Processor dialog.

Processor

Transient Results Opens the transient results viewer dialog.

Viewer

Transient Time Step Opens the Transient Time Step Options dialog.
Options

Transient Thematic Opens the Transient Thematic Viewer dialog.

Viewer

Calculation Summary Opens the Calculation Summary to view results.

Transient Calculation Opens the Transient Calculation Summary to view

Summary results of transient calculations.

User Notifications Opens User Notifications allowing you to view

warnings and errors uncovered by the validation
process.

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 Bentley HAMMER 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 Allows you to establish the initial conditions for

Conditions the transient simulation

Bentley HAMMER V8i Edition User’s Guide 15-1083

Components Menu

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 When this option is toggled on, initial conditions

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 Opens the Pressure Dependent Demand Functions

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 Opens the Minor Loss Coefficients Manager

Coefficients dialog.

GPV Headloss Curves Opens the GPV Headloss Curves manager where
you can create and edit headloss curves for
General Purpose Valves.

Valve Characteristics Opens the Valve Characteristics dialog.

Air Flow Curves Opens the Air Flow Curves dialog.

Engineering Libraries Opens the Engineering Libraries Manager.

15-1084 Bentley HAMMER V8i Edition User’s Guide

 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.

Bentley HAMMER V8i Edition User’s Guide 15-1085

View Menu

Property Grid Opens the Property Grid Customizations Manager.

Customizations

Auto-Refresh Turns automatic updates to the main window view

on or off whenever changes are made to the
Bentley HAMMER 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 Bentley
HAMMER 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.

15-1086 Bentley HAMMER V8i Edition User’s Guide

 Menus

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 Bentley HAMMER 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 Opens a Select dialog to select elements in the

Selection drawing to make them Inactive or Active.

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 Opens the SCADAConnect manager where you can

add or edit SCADA connections.

Skelebrator Opens the Skelebrator manager, where you can define

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

Bentley HAMMER V8i Edition User’s Guide 15-1087

Tools Menu

Demand Control Opens the Demand Control Center manager where

Center you can add new demands, delete existing demands, or
modify existing demands.

Unit Demand Control Opens the Unit Demand Control Center manager
Center 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 Opens the Assign Isolation Valves to Pipes where you
to Pipes 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 Opens the HAMMER Initial Conditions dialog.

Conditions

15-1088 Bentley HAMMER V8i Edition User’s Guide

 Menus

Database Utilities Opens a menu containing the following commands:

• Compact Database—When you delete data from
a Bentley HAMMER V8i project, such as elements
or alternatives, the database store that Bentley
HAMMER 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 HAMMER 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 Bentley
HAMMER 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 Directory—This
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 Directory—This command
copies the result files that are currently being used by
the model to the project directory (where the project
.sqlite is stored).

Bentley HAMMER V8i Edition User’s Guide 15-1089

Report Menu

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.

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 Opens a submenu containing a number of reports

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:

Bentley HAMMER V8i Opens the online help Table of Contents.

Help

Quick Start Lessons Opens the online help to the Quick Start Lessons
Overview topic.

15-1090 Bentley HAMMER V8i Edition User’s Guide

 Menus

Welcome Dialog Opens the Welcome dialog box.

Check for SELECT Opens your Web browser to the Bentley Web site,
Updates where you can check for Bentley HAMMER V8i
updates.

Bentley Institute Opens your browser to the Bentley Institute

Training Training web site.

Bentley Professional Opens your browser to the Bentley Professional

Services Services web site.

Bentley SELECT Opens your browser to SELECTservices area of

Support the Bentley web site.

Bentley Communities Opens your browser to the BentleyCommunities

section of the website.

Bentley.com Opens the home page on the Bentley web site.

About Bentley Opens the About Bentley Bentley HAMMER V8i

HAMMER V8i dialog box, which displays copyright information
about the product, registration information, and
the current version number of the release.

Bentley HAMMER V8i Edition User’s Guide 15-1091

Help Menu

15-1092 Bentley HAMMER V8i Edition User’s Guide

 Element Properties
Reference 16
Edit Element Properties

Pipe Attributes

Junction Attributes

Hydrant Attributes

Tank Attributes

Reservoir Attributes

Periodic Head-Flow Attributes

Pump Attributes

Pump Station Attributes

Variable Speed Pump Battery Attributes

Turbine Attributes

Valve Attributes

Valve With Linear Area Change Attributes

Check Valve Attributes

Orifice Between Pipes Attributes

Discharge To Atmosphere Attributes

Surge Tank Attributes

Hydropneumatic Tank Attributes

Bentley HAMMER V8i Edition User’s Guide 16-1093

Edit Element Properties

Air Valve Attributes

Surge Valve Attributes

Rupture Disk Attributes

Isolation Valve Attributes

Spot Elevation Attributes

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 ex-
panded category can be collapsed by clicking plus (+) next to the category head-
ing. 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.

16-1094 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Has User Defined Length?: Allows the calculated scaled pipe lengths to be over-
ridden 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 coefficent for the element is
manually set, otherwise the value is derived from the minor loss library.
• Minor Losses: List of all associated minor losses associated with the element, and
can be used to generate the composite minor loss coefficient.
• Status (Initial): Choices: Open, Closed
• Specify Local Bulk Reaction Rate?: If true than a local Bulk Reaction Rate can be
specified for the pipe, otherwise the bulk reaction rate associated with selected
constituent will govern.
• Bulk Reaction Rate (Local): Coefficient defining how rapidly a constituent grows
or decays over time.
• Specify Local Wall Rate?: If true then a local wall reaction rate can be specified
for the selected pipe.
• Wall Reaction Rate (First Order): First order coefficient defining the rate at which
a substance reacts with the wall of a pipe. Is available if global constituent is set
to first order.
• Wall Reaction Rate (Zero Order): Zero order coefficient defining the rate at which
a substance reacts with the wall of a pipe. Is available if the global constituent is
set to zero order.
• Zone: Specify the zone for the element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Wave Speed: The speed with which a disturbance (i.e. pressure wave) moves
through the fluid in the pipe.
• Flow (Initial): A value corresponding to flow in the pipe at the beginning of the
transient simulation.
• Hydraulic Grade (Initial Start): The start node hydraulic grade elevation at the
beginning of the transient simulation.
• Hydraulic Grade (Initial Stop): The stop node hydraulic grade elevation at the
beginning of the transient simulation.
• Pressure (Start): Pressure at the start node of the pipe.
• Pressure (Stop): Pressure at the stop node of the pipe.
• Number of Breaks: The number of breaks that occurred on this pipe.

Bentley HAMMER V8i Edition User’s Guide 16-1095

Pipe Attributes

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

16-1096 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Trace (Start): Trace percentage at start end of the pipe.

• Trace (Stop): Trace percentage at stop end of the pipe.
• Age (Start): Water age at the start end of the pipe.
• Age (Stop): Water age at the stop end of the pipe.
• Flow (Minimum Absolute): Minimum flow magnitude through pipe over the
course of the simulation.
• Flow (Maximum Absolute): Maximum flow magnitude through the pipe over the
course of the simulation.
• Velocity (Maximum): Maximum velocity of flow that occurs in pipe over the
course of the simulation.
• Velocity (Minimum): Minimum velocity of flow that occurs in pipe over the
course of the simulation.
• Headloss Gradient (Minimum): Minimum headloss gradient that occurs at the
selected pipe.
• Headloss Gradient (Maximum): Maximum headloss gradient that occurs at the
selected pipe.
• Flow (Minimum): Minimum flow through pipe over the course of the simulation.
• Flow (Maximum): Maximum flow through the pipe over the course of the simula-
tion.
• 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.

Bentley HAMMER V8i Edition User’s Guide 16-1097

Pipe Attributes

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

16-1098 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Velocity (Maximum, Transient): Maximum velocity at any point along the pipe
over the course of the transient simulation.
• Wave Speed Adjustment Percent: The wave speed adjustment applied to this pipe
(relative to the original wave speed) so that a sharp pressure-wave front can travel
the length of one of the pipe's interior segments in one time step.
• Wave Speed Adjustment: The wave speed adjustment applied to this pipe so that a
sharp pressure-wave front can travel the length of one of the pipe's interior
segments in one time step.
• Length Adjustment Percent: The length adjustment applied to this pipe (relative to
the original length) so that a sharp pressure-wave front can travel the length of one
of the pipe's interior segments in one time step.
• Length Adjustment: The length adjustment applied to this pipe so that a sharp
pressure-wave front can travel the length of one of the pipe's interior segments in
one time step.
• Velocity (Initial, Transient): The flow velocity along the pipe at the beginning of
the transient simulation.
• Pressure (Maximum at Stop Node, Transient): Maximum pressure at the pipe's
stop node over the course of the transient simulation.
• Pressure (Maximum at Start Node, Transient): Maximum pressure at the pipe's
start node over the course of the transient simulation.
• Pressure (Minimum at Stop Node, Transient): Minimum pressure at the pipe's stop
node over the course of the transient simulation.
• Pressure (Minimum at Start Node, Transient): Minimum pressure at the pipe's
start node over the course of the transient simulation.
• Head (Maximum at Stop Node, Transient): Maximum head at the pipe's stop node
over the course of the transient simulation.
• Head (Maximum at Start Node, Transient): Maximum head at the pipe's start node
over the course of the transient simulation.
• Head (Minimum at Start Node, Transient): Minimum head at the pipe's start node
over the course of the transient simulation.
• Head (Minimum at Stop Node, Transient): Minimum head at the pipe's stop node
over the course of the transient simulation.
• 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.

Bentley HAMMER V8i Edition User’s Guide 16-1099

Junction Attributes

• Head (Initial at Start Node, Transient): The head at the pipe's start node at the
beginning of the transient simulation.
• Head (Initial at Stop Node, Transient): The head at the pipe's stop node at the
beginning of the transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume along the pipe over the
course of the transient simulation.
• Vapor Volume (Maximum, Transient): Maximum vapor volume along the pipe
over the course of the transient simulation.
• Velocity (Maximum Flushing): The maximum achieved pipe velocity across all
flushing events. If comparing against previous results (for other alternatives/
scenarios) this result is the maximum achieved velocity across all flushing events
for which results exist.
• Shear Stress (Maxmum Flushing): The maximum achieved shear stress across all
flushing events. If comparing against previous results (for other alternatives/
scenarios) this result is the maximum achieved shear stress across all flushing
events for which results exist.
• Flushing Event: The flushing event that resulted in the pipe maximum achieved
velocity. If comparing against previous results, this flushing event may be defined
in another alternative/scenario.
• Satisfies Flushing Target Velocity?: True if the maximum achieved velocity for
the pipe is greater than or equal to the target velocity.
• Satisfies Flushing Target Shear Stress?: True if the maximum achieved shear
stress for the pipe is greater than or equal to the target shear stress.
• Break Rate: The break rate for the pipe over time.
• Break Rate (Pipe Group): The break rate for the group the pipe belongs to.
• Projected Breaks: The projected number of breaks for this pipe.
• Annual Expected Cost: The annual expected cost of the breaks for this pipe.
• Present Worth: How much the pipe is currently worth based on the projection cost.
• Break Rate (Scaled): A weighted combination of the individual pipe break rate
and the pipe break rate of the group to which the pipe belongs.

Junction Attributes
• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.

16-1100 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Specify Local Fire Flow Constraints?: If set to true then local fire flow constraints
which override the global values can be set for the current junction.
• Fire Flow (Needed): The flow rate required at the junction to meet fire flow
demands. This value will be added to or replace the junctions baseline demand,
depending on the default setting for applying fire flows as specified in the Fire
Flow Alternative dialog box.
• Fire Flow (Upper Limit): This input defines the maximum allowable fire flow that
a junction can provide and the maximum allowable fire flow that can occur at any
single withdrawal location.
• Pressure (Residual Lower Limit): Minimum residual pressure to occur at the junc-
tion node. The program determines the amount of fire flow available such that the
residual pressure at the junction node does not fall below this target pressure.
• Pressure (Zone Lower Limit): Minimum pressure to occur at all junction nodes
within the Zone you are testing. The model determines the available fire flow such
that the minimum zone pressures do not fall below this target pressure.
• Pressure (System Lower Limit): Minimum pressure allowed at any junction in the
entire system as a result of the fire flow withdrawal. If a node's pressure anywhere
in the system falls below this constraint while withdrawing fire flow, fire flow will
not be satisfied.
• Use Velocity Constraint: If set to true, then a velocity constraint can be specified
for the node.
• Velocity (Upper Limit): Maximum velocity allowed in the associated pipe set.
• Use Minimum System Pressure Constraints?: If set to true then the fire flow anal-
ysis 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 depen-
dent demand parameters that override the global default values can be set for the
current junction.

Bentley HAMMER V8i Edition User’s Guide 16-1101

Junction Attributes

• 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 appli-
cable at dead ends.
• Pressure Drop (Typical): Pressure drop across the orifice corresponding to the
initial/typical flow.
• Flow (Typical): If the initial flow is zero, then this is a typical (positive) flow.
• Demand Collection: A collection of baseline demands and associated temporal
patterns.
• Unit Demand Collection: A collection of unit demands, associated unit counts,
and temporal patterns.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion 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 constit-
uent 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 constit-
uent 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.

16-1102 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• 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 main-
taining all fire flow pressure constraints.
• Pressure (Calculated Residual): Calculated pressure at the junction node during
the fire flow withdrawal.
• Pressure (Calculated Zone Lower Limit): Minimum calculated pressure of all
junctions in the same zone as this junction.
• Junction w/ Minimum Pressure (Zone): Label of the junction corresponding to the
minimum zone pressure.
• Pressure (Calculated System Lower Limit): Minimum calculated pressure of all
junctions in the system.
• Junction w/ Minimum Pressure (System): Junction corresponding to the minimum
system pressure.
• Is Fire Flow Run Balanced?: If set to true then the fire flow analysis was able to
solve.
• Fire Flow Iterations: Number of iterations required to hone in on the fire flow
result.
• Flow (Total Needed): If fire flow is added to baseline demand this equals the sum
of the calculated demand and the needed fire flow, otherwise is equivalent to the
needed fire flow.
• Flow (Total Available): If fire flow is added to the baseline demand this equals the
sum of the calculated demand and the available fire flow at the node, otherwise it
is equivalent to the available fire flow.
• Fire Flow (Total Upper Limit): If fire flow is added to base line, this equals the
sum of the demand at the junction plus the fire flow upper limit, otherwise it is
equivalent to the fire flow upper limit.
• Junction w/ Minimum Pressure (Zone @ Total Flow Needed): If baseline flow is
added to demand, this represents the junction with the minimum pressure in the
zone as a result of the total needed demand and fire flow.
• Pressure (Calculated Residual @ Total Flow Needed): Lower limit for system
pressure at node.
• Pressure (Calculated Zone Lower Limit @ Total Flow Needed): Lower limit for
pressure in zone at node
• Pipe w/ Maximum Velocity: Label of pipe with max velocity

Bentley HAMMER V8i Edition User’s Guide 16-1103

Junction Attributes

• Velocity of Maximum Pipe: Velocity in pipe with highest velocity.

• Demand (Minimum): Minimum demand at node over the course of the simula-
tion.
• Demand (Maximum): Maximum demand at node over the course of the simula-
tion.
• 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 simula-
tion.
• Pressure (Maximum): Maximum pressure at node over the course of the simula-
tion.
• Age (Minimum): Minimum age at node over the course of the simulation.
• Age (Maximum): Maximum age at node over the course of the simulation.
• Trace (Minimum): Minimum trace at node over the course of the simulation.
• Trace (Maximum): Maximum trace at node over the course of the simulation.
• Concentration (Minimum): Minimum concentration at node over the course of the
simulation.
• Concentration (Maximum): Minimum concentration at node over the course of
the simulation.
• Demand: Total calculated demand at selected element.
• Demand Adjusted Population: Population of area supplied by current node. This
value is derived from the unit demand loads applied to the collection and their
equivalent populations.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.

16-1104 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Pressure (Maximum, Transient): Maximum pressure at node over the course of

the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Hydrant Attributes
• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Include 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 junc-
tion 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.

Bentley HAMMER V8i Edition User’s Guide 16-1105

Hydrant Attributes

• Pressure (System Lower Limit): Minimum pressure allowed at any junction in the
entire system as a result of the fire flow withdrawal. If a node's pressure anywhere
in the system falls below this constraint while withdrawing fire flow, fire flow will
not be satisfied.
• Use Velocity Constraint: If set to true, then a velocity constraint can be specified
for the node.
• Velocity (Upper Limit): Maximum velocity allowed in the associated pipe set.
• Use Minimum System Pressure Constraints?: If set to true then the fire flow anal-
ysis 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 depen-
dent 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 appli-
cable at dead ends.
• Pressure Drop (Typical): Pressure drop across the orifice corresponding to the
initial/typical flow.
• Flow (Typical): If the initial flow is zero, then this is a typical (positive) flow.
• Demand Collection: A collection of baseline demands and associated temporal
patterns.
• Unit Demand Collection: A collection of unit demands, associated unit counts,
and temporal patterns.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.

16-1106 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• 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 constit-
uent 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 constit-
uent 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 main-
taining 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.

Bentley HAMMER V8i Edition User’s Guide 16-1107

Hydrant Attributes

• 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 simula-
tion.
• Demand (Maximum): Maximum demand at node over the course of the simula-
tion.
• 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 simula-
tion.
• Pressure (Maximum): Maximum pressure at node over the course of the simula-
tion.
• Age (Minimum): Minimum age at node over the course of the simulation.
• Age (Maximum): Maximum age at node over the course of the simulation.

16-1108 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Trace (Minimum): Minimum trace at node over the course of the simulation.
• Trace (Maximum): Maximum trace at node over the course of the simulation.
• Concentration (Minimum): Minimum concentration at node over the course of the
simulation.
• Concentration (Maximum): Minimum concentration at node over the course of
the simulation.
• Demand: Total calculated demand at selected element.
• Demand Adjusted Population: Population of area supplied by current node. This
value is derived from the unit demand loads applied to the collection and their
equivalent populations.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Tank Attributes
• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.

Bentley HAMMER V8i Edition User’s Guide 16-1109

Tank Attributes

• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Include in Energy Calculation?: If set to true, cost generated by the element will
be included in the calculations, otherwise they will be excluded.
• Has Separate Inlet?: Specifies whether this tank has a separate inlet pipe (only
significant when modeling top fill tanks or throttling inlets).
• Inlet Pipe: Specifies which pipe will be used to model a top fill inlet, throttling
inlet, or both.
• Tank Fills From Top?: Set this to true if you wish to model a top fill inlet.
• Level (Inlet Invert): Specify the invert level for the inlet. If the upstream HGL is
lower than this level the tank will not fill.
• Inlet Valve Throttles?: Set this to true if there is a throttling valve (such as a float
valve) on the inlet.
• Discharge Coefficient (Fully Open): Specifies the discharge or flow coefficient of
the inlet valve in its fully open position.
• Level Inlet Valve Fully Closes: Specifies the level at which the throttling valve
becomes fully closed allowing no more flow to pass into the tank.
• Valve Characteristics: Specifies the valve characteristics definition to be used for
this valve. If the Valve Characteristic Curve is not defined then a default curve
will be used. The default curve will have (Relative Closure, Relative Area) points
of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Elevation (Base): Elevation of the storage tank base used as a reference when
entering water surface elevations in the tank in terms of levels.
• Elevation (Maximum): Highest allowable water surface elevation or level. If the
tank fills above this point, it will be automatically shut off from the system.
• Level (Maximum): A reference level to compare the hydraulic grade in the tank.
Does not influence the calculations.
• Diameter: Diameter of tank with constant circular cross-section.
• Area (Average): Cross-Sectional area of tank for constant x-section tanks.
• Volume Full (Input): The full active volume of the variable area tank (i.e., the
volume at 100% depth), exclusive of any inactive volume.
• Operating Range Type: Choices: Elevation, Level
• Section: Choices: Circular, Non-Circular, Variable Area
• Cross-Section Curve: Defines a curve which specifies the relationship between
depth and volume.

16-1110 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Specify Local Bulk Rate?: If true than a local Bulk Reaction Rate can be specified
for the tank, otherwise the bulk reaction rate associated with selected constituent
will govern.
• Bulk Reaction Rate (Local): Coefficient defining how rapidly a constituent grows
or decays over time.
• Tank Mixing Model: Choices: 2-Compartment, Completely Mixed, FIFO, LIFO
• Compartment 1: Percent of available storage that makes up the first compartment.
Inflow and outflow is assumed to take place in the first compartment.
• Compartment 2: Percent of available storage that makes up the second compart-
ment. The second compartment receives overflow from the first, and this overflow
is completely mixed.
• Elevation (Minimum): Lowest allowable water surface elevation or level. If the
tank drains below this point, it will be automatically shut off from the system.
• Volume (Inactive): The inactive volume of the tank. This volume is the inacces-
sible 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 gener-
ated. Calculation notifications are produced to advise you of any alarm level
violations.
• Level (High Alarm): The level above which the high level alarm is generated.
Calculation notifications are produced to advise you of any alarm level violations.
• Elevation (Low Alarm): The elevation below which the low level alarm is gener-
ated. Calculation notifications are produced to advise you of any alarm level
violations.
• Level (Low Alarm): The level below which the low level alarm is generated.
Calculation notifications are produced to advise you of any alarm level violations.
• Use High Alarm?: Specifies whether or not to check high alarm levels during
Steady State/EPS calculation and generate messages if the levels are violated.
• Use Low Alarm?: Specifies whether or not to check low alarm levels during
Steady State/EPS calculation and generate messages if the levels are violated.
• Elevation (Initial): Starting water surface elevation/level in the tank.
• Level (Initial): Starting water surface elevation/level in the tank.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.

Bentley HAMMER V8i Edition User’s Guide 16-1111

Tank Attributes

• Elevation (Initial, Transient): Enter a value only if a check valve is installed (i.e.,
case of a one-way surge tank), or there is an initial inflow/outflow head loss. By
default, the intial water surface level is taken equal to the head in the adjacent
pipe.
• Report Period (Transient): Number of time steps between successive printouts of
operation. By default, this printout is suppressed.
• Demand Collection: A collection of baseline demands and associated temporal
patterns.
• Unit Demand Collection: A collection of unit demands, associated unit counts,
and temporal patterns.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion 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 constit-
uent 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 constit-
uent mass rate at this node over time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Relative Closure (Calculated, Inlet Valve): The relative closure of the tank throt-
tling 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 throt-
tles).
• 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.

16-1112 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Status (Calculated, Inlet Valve): Choices: Active, Inactive, Closed

• Volume Full (Calculated): The full active volume of the tank between the limits of
the defined operating range, exclusive of any inactive volume.
• Level (Calculated): Difference between calcuted hydraulic grade and the base
elevation of the tank.
• Volume (Calculated): Total volume of fluid in tank including the inactive volume.
• Percent Full: The ratio of tank active volume to the calculated tank full active
volume. Active volume is the tank volume within the operating range and is
exclusive of inactive volume.
• Status (Calculated): Choices: Empty, Emptying, Filling, Full, Stagnant
• Flow (Out net): Net flow out of the element.
• Flow (In net): Net flow into the element.
• Demand Adjusted Population: Population of area supplied by current node. This
value is derived from the unit demand loads applied to the collection and their
equivalent populations.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.

Reservoir Attributes
• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.

Bentley HAMMER V8i Edition User’s Guide 16-1113

Reservoir Attributes

• Notes: Additional information about this element.

• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Hydraulic Grade Pattern: Allows you to apply a pattern for changes to the reser-
voirs hydraulic grade line over time for extended period simulations.
• Elevation (Inlet/Outlet Invert): Elevation of the reservoir inlet/outlet invert.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion 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 constit-
uent 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 constit-
uent mass rate at this node over time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Flow (Out net): Net flow out of the element.
• Flow (In net): Net flow into the element.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.

16-1114 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Periodic Head-Flow Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Sinusoidal: If sinusoidal, then mean value, amplitude and phase are entered;
otherwise, a table of values is required. A sinusoidal quantity X has the form: X =
X0 + A sin( 2 * PI * t / T + Phase ).
• Mean Value (Head): The mean head value. Required only if sinusoidal data speci-
fied.
• 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 speci-
fied.
• 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.

Bentley HAMMER V8i Edition User’s Guide 16-1115

Periodic Head-Flow Attributes

• Head Pattern: A collection of time/head pairs representing the transient flow

pattern.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion 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 constit-
uent 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 constit-
uent mass rate at this node over time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Discharge (Calculated): Calculated discharge from the node.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient 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.

16-1116 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Pump Attributes
• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Pump Definition: Select the pump definition to apply to the selected pump.
• Is Variable Speed Pump?: If set to true then the pump will act as a Variable Speed
Pump.
• Relative Speed Factor (Maximum): The highest relative speed factor that the
pump can be set at to meet the target head at the control node. If the target head
cannot be met when the pump is set at the maximum relative speed factor, the
maximum will be used.
• VSP Type: Choices: Pattern Based, Fixed Head, Fixed Flow
• Flow (Target): The relative speed of a VSP of type "Fixed Flow" will be adjusted
to meet the Flow (Target).
• Pattern (Relative Speeds): Select the pattern by which the relative speed factor is
adjusted over the course of the simulation. (Note that patterns override settings
changes made by controls).
• Control Node: The node that the VSP checks to determine whether to increase,
maintain, or decrease its relative speed factor.
• Hydraulic Grade (Target): The Head that the VSP will attempt to maintain for the
Control Node.
• Control Node on Suction Side?: Specifies if the VSP has a suction side control
node.
• Relative Speed Factor (Initial): Determines the initial speed of the pump impeller
relative to the speed at which the pump curve is defined.
• Status (Initial): Choices: On, Off
• Include in Energy Calculation?: If set to true, cost generated by the element will
be included in the calculations, otherwise they will be excluded.

Bentley HAMMER V8i Edition User’s Guide 16-1117

Pump Attributes

• Energy Pricing: Specify which energy pricing definition is to be used when calcu-
lating 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 effi-
ciency point.
• Head (Nominal): Rated or duty head for the pump, often at or near the best effi-
ciency point.
• Relative Speed (Initial, Transient): The initial pump relative speed to be used in
the transient analysis.
• Torque (Nominal): Specifies the nominal torque that, when multiplied by the
Operating Rule's pattern multiplier values will result in the torque values used by
the engine.
• Pump Type (Transient): Choices: Shut Down After Time Delay, Constant Speed -
No Pump Curve, Constant Speed - Pump Curve, Variable Speed/Torque, Pump
Start - Variable Speed/Torque
• Time (Delay until Shut Down): Time at which power to pump motor is shut off.
By default, there is no time delay.
• Time (For Valve to Close): The time taken for the pump discharge control valve to
close after the transient simulation begins.
• Time (For Valve to Operate): Time to close check valve (or to open it if initial
flow is zero). If the check valve allows flow only in one direction, enter 0.
• Control Variable: Choices: Speed, Torque
• Status (Initial, Transient): Choices: On, Off
• Pump Valve Type: Choices: Check Valve, Control Valve
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Report Period (Transient): Number of time steps between successive printouts of
operation. By default, this printout is suppressed.
• Pump Station: The Pump Station to which this Pump belongs.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.

16-1118 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Zone: Specify the zone for the element.

• Relative Speed Factor (Calculated): Current relative speed factor of pump at
current time step.
• Hydraulic Grade (Suction): Calculated hydraulic grade at suction side of the
pump.
• Hydraulic Grade (Discharge): Calculated hydraulic grade at discharge side of the
pump.
• Flow (Total): Total flow pumped by standard pump or the pump battery.
• Pump Head: Head gain between suction and discharge side of the pump.
• Pressure (Suction): Calculated pressure at suction side of the pump.
• Pressure (Discharge): Calculated pressure at discharge side of the pump.
• Flow (Absolute): The magnitude of flow through the pump regardless of flow
direction.
• Pump Exceeds Operating Range?: Is true if the system demands on the pump
exceeds its capabilities.
• Status (Calculated): Choices: On, Off, Pump Cannot Deliver Head (Closed),
Pump Result Cannot Deliver Flow (Open)
• Peak Power: Displays the peak energy usage, as calculated during the extended
period simulation. This result is displayed even if Peak Demand Charges are not
applied.
• Time of Peak Energy Cost: Time when energy cost is maximum.
• Demand Charge: The charge applied per kW.
• Demand Charge Period: Time over which demand charge is averaged in order to
get $/day.
• Peak Power Cost: Displays the energy cost as calculated during the extended
period simulation. If no Peak Demand Charge has been applied to the associated
Energy Price Definition, this field will display as zero.
• Peak Power Cost (Daily): The cost associated with the Peak Demand Charge.
• Volume Pumped (Incremental): Total volume of flow pumped during current time
step.
• Volume Pumped (Cumulative): Total volume of flow pumped up to the current
time step.
• Water Power: The amount of energy transferred to the water by the pump.
• Pump Efficiency: The Pump Efficiency value is representative of the ability of the
pump to transfer the mechanical energy generated by the motor to Water Power.
• Wire to Water Efficiency: The ratio of the Water Power to the Wire Power.
• Wire Power: The amount of energy delivered to the pump motor.

Bentley HAMMER V8i Edition User’s Guide 16-1119

Pump Attributes

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

16-1120 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Head (Maximum Operating): Displays the maximum operating head of the refer-
enced pump definition if applicable.
• Flow (Maximum Operating): Displays the maximum operating flow of the refer-
enced pump definition if applicable.
• Flow (Maximum Extended): Displays the maximum extended flow of the refer-
enced pump definition if applicable.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Pump Station Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.

Bentley HAMMER V8i Edition User’s Guide 16-1121

Pump Station Attributes

• Notes: Additional information about this element.

• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Geometry: Specify the geometric coordinates for this entity.
• Scaled Area: A polygon area value obtained from the underlying map dimensions.
• Is Active?: Specifies whether this element is active in the current scenario.
• Controls: Opens a filtered controls editor that only displays the controls associated
with the pumps in the selected pump station.
• Pumps: Pump elements that belong to this pump station.
• Time of Use: The total number of pump hours run during the simulation.
• Volume Pumped: The total volume of fluid pumped during the simulation.
• Water Power: The total amount of energy transferred to the water by the pumps in
the pump station over the course of the simulation.
• Efficiency (Average) Pump Station: Water power out divided by motor brake
power in as a percentage.
• Wire to Water Efficiency (Average): Water power out divided by wire power in as
a percentage.
• Wire Power (Total): The total amount of energy delivered to all the pump motors
in the pump station during the simulation.
• Energy Usage (Total): The total energy used during the simulation.
• Energy Use Cost (Total): Total cost of energy used during the simulation.
• Energy Usage (Daily): Amount of energy used during the 24-hour period.
• Energy Use Cost (Daily): The cost of energy used during a 24-hour period, deter-
mined by the calculated energy usage and the energy pricing pattern.
• Cost per Unit Volume (Summary): Cost of energy divided by the volume pumped
over the course of the simulation.
• Flow (Total): Total flow pumped by pumps in the pump station at the current time
step.
• Volume Pumped (Incremental): Total volume of flow pumped during the current
time step.
• Volume Pumped (Cumulative): Total volume of flow pumped up to the current
time step.
• Water Power: The amount of power transferred to the water by the pumps in the
pump station at the current time step.

16-1122 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Efficiency Pump Station: Water power out from the station divided by the motor
brake power in at the current time step, expressed as a percentage.
• Wire to Water Efficiency: Water power from the station divided by the wire power
in to the station at the current time step, expressed as a percentage.
• Wire Power: The amount of power delivered to the pump motors at the pump
station at the current time step.
• Energy Used (Incremental): Total energy used during the current time step.
• Energy Used (Cumulative): Total amount of energy used up to the current time
step.
• Energy Price: Cost per unit of energy at the current time step.
• Energy Cost (Incremental): The cost of energy used during the current time step.
• Energy Cost (Cumulative): The total cost of energy used up to the current time
step.
• Cost per Unit Volume: Cost per unit of volume pumped for the current time step.

Variable Speed Pump Battery Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Battery Pump Definition: Select pump definition for the lead and lag pumps in the
battery.
• Control Node: The node that the battery checks to determine whether to increase,
maintain, or decrease its relative speed factor.
• Hydraulic Grade (Target): The Head that the battery will attempt to maintain for
the Control Node.
• 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 rela-
tive speed factor is adjusted to maintain the target head for a fixed head VSPB.
(Lag pumps are not used for constant flow VSPBs).

Bentley HAMMER V8i Edition User’s Guide 16-1123

Variable Speed Pump Battery Attributes

• 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: Fixed Head, Fixed Flow
• Number of Running Lag Pumps (Initial): The initial number of running lag pumps
for the transient simulation.
• Relative Speed Factor (Initial): Determines the initial speed of the pump impeller
relative to the speed at which the pump curve is defined.
• Status (Initial): Choices: On, Off
• Include in Energy Calculation?: If set to true, cost generated by the element will
be included in the calculations, otherwise they will be excluded.
• Energy Pricing: Specify which energy pricing definition is to be used when calcu-
lating 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 effi-
ciency point.
• Head (Nominal): Rated or duty head for the pump, often at or near the best effi-
ciency 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.

16-1124 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Report Period (Transient): Number of time steps between successive printouts of

operation. By default, this printout is suppressed.
• Pump Station: The Pump Station to which this Pump belongs.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow (Lead Pump): Flow contributed by the lead pump in the pump battery.
• Number of Running Lag Pumps: Number of pump battery lag pumps running
duing the current time step.
• 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.

Bentley HAMMER V8i Edition User’s Guide 16-1125

Variable Speed Pump Battery Attributes

• Demand Charge: The charge applied per kW.

• Demand Charge Period: Time over which demand charge is averaged in order to
get $/day.
• Peak Power Cost: Displays the energy cost as calculated during the extended
period simulation. If no Peak Demand Charge has been applied to the associated
Energy Price Definition, this field will display as zero.
• Peak Power Cost (Daily): The cost associated with the Peak Demand Charge.
• Volume Pumped (Incremental): Total volume of flow pumped during current time
step.
• Volume Pumped (Cumulative): Total volume of flow pumped up to the current
time step.
• Water Power: The amount of energy transferred to the water by the pump.
• Pump Efficiency: The Pump Efficiency value is representative of the ability of the
pump to transfer the mechanical energy generated by the motor to Water Power.
• Wire to Water Efficiency: The ratio of the Water Power to the Wire Power.
• Wire Power: The amount of energy delivered to the pump motor.
• Energy Used (Incremental): Total energy used during current time step.
• Energy Used (Cumulative): Total amount of energy used up to the current time
step.
• Energy Price: Cost per unit of energy.
• Energy Cost (Incremental): The energy cost during the current time step.
• Energy Cost (Cumulative): The total energy cost up to the current time step.
• Cost per Unit Volume: Cost per unit of volume pumped for current time step.
• Relative Speed Factor (Energy Cost Engine): Relative speed of pump at current
time step.
• Motor Efficiency: The Motor Efficiency value is representative of the ability of
the motor to transform electrical energy to rotary mechanical energy.
• Time of Use: The amount of time the pump is turned on over the course of the
simulation.
• Utilization: Percentage of total time during the EPS that the pump was On.
• Volume Pumped (Total): The total volume of fluid pumped during the simulation.
• Water Power (Average): The average amount of energy transferred to the water by
the pump over the course of the simulation.
• Pump Efficiency (Average): The average pump efficiency during the simulation.
• Wire to Water Efficiency (Average): The average ratio of the Water Power to the
Wire Power.

16-1126 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• 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 refer-
enced pump definition if applicable.
• Flow (Maximum Operating): Displays the maximum operating flow of the refer-
enced pump definition if applicable.
• Flow (Maximum Extended): Displays the maximum extended flow of the refer-
enced pump definition if applicable.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.

Bentley HAMMER V8i Edition User’s Guide 16-1127

Turbine Attributes

• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Turbine Attributes
• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Time (Delay until Valve Operates): The time delay prior to operating the spherical
valve.
• Time For Valve To Operate: Time required to operate the spherical valve. By
default, it is set equal to one time step.
• Diameter (Spherical Valve): The diameter of the spherical valve.
• Efficiency: The efficiency of the turbine. A typical value is 90.
• Moment of Inertia: The (weight) moment of inertia accounts for the turbine,
generator, and entrained water.
• Speed (Rotational): Also known as synchronous speed for a turbine. The power it
generates depends on it.
• Pattern (Gate Opening): Operating Rule describes the percent wicket gate opening
vs time.
• Specific Speed: This represents the type of turbine. HAMMER ships with 4-quad-
rant 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.

16-1128 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Operating Case: Choices: Instant Load Rejection, Load Rejection, Load Accep-
tance, Load Variation
• Turbine Curve: Turbine Curve is only required for a steady run. For a transient
run, HAMMER uses a 4-quadrant curve based on Specific Speed, Rated Head and
Rated Flow.
• Electrical Torque Curve: Defines the time vs torque response for the turbine. Only
applies to the Load Rejection operating case.
• Report Period (Transient): Number of time steps between successive printouts of
operation. By default, this printout is suppressed.
• Status (Initial): Choices: Open, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow: Total flow through the turbine.
• Headloss: Change in head across turbine.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the
turbine.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the turbine.
• Pressure (From): Calculated pressure at the entrance of the turbine.
• Pressure (To): Calculated pressure at the exit to the turbine.
• Flow (Absolute): Magnitude of flow through the selected turbine.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.

Bentley HAMMER V8i Edition User’s Guide 16-1129

Valve Attributes

• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Valve Attributes
Pressure Reducing Valve (PRV) Attributes

Pressure Breaker Valve (PBV) Attributes

Flow Control Vale (FCV) Attributes

Throttle Control Valve (TCV) Attributes

General Purpose Valve (GPV) Attributes

Pressure Reducing Valve (PRV) Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.

16-1130 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow /

(Pressure Drop) ^ 0.5.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Hydraulic Grade Setting (Initial, Transient): The initial HGL setting for the tran-
sient simulation.
• Valve Characteristics: Specifies the valve characteristics definition to be used for
this valve. If the Valve Characteristic Curve is not defined then a default curve
will be used. The default curve will have (Relative Closure, Relative Area) points
of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Setting Type: Choices: Pressure, Hydraulic Grade
• Pressure Setting (Initial): Specify the initial pressure setting for the valve.
• Hydraulic Grade Setting (Initial): Specify the initial hydraulic grade setting for the
valve.
• Pattern (Valve Settings): Allows you to apply a pattern to make changes to the
valve's setting over time for use in extended period simulations. For settings
patterns to work the valve must have a Status (Initial) equal to Active. For pres-
sure 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.

Bentley HAMMER V8i Edition User’s Guide 16-1131

Valve Attributes

• 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 automati-
cally adjusted to maintain constant valve outlet pressure.
• Opening Rate Coefficient: A constant that relates PRV opening rate during a tran-
sient 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 tran-
sient simulation to the difference between the PRV pressure setting and the
computed PRV outlet pressure. Units are change in the valve relative closure per
second per unit of pressure difference.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Status (Initial, Transient): Choices: Active, Inactive, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Hydraulic Grade Setting (Calculated): Hydraulic Grade Setting during current
time step.
• Pressure Setting (Calculated): Pressure setting for valve at current time step.
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed

16-1132 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Minor Loss Coefficient (Unified): Displays the current minor loss value for the
element, depending on whether its derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Pressure Sustaining Valve (PSV) Attributes

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

Bentley HAMMER V8i Edition User’s Guide 16-1133

Valve Attributes

• Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow /

(Pressure Drop) ^ 0.5.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Hydraulic Grade Setting (Initial, Transient): The initial HGL setting for the tran-
sient simulation.
• Valve Characteristics: Specifies the valve characteristics definition to be used for
this valve. If the Valve Characteristic Curve is not defined then a default curve
will be used. The default curve will have (Relative Closure, Relative Area) points
of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Setting Type: Choices: Pressure, Hydraulic Grade
• Pressure Setting (Initial): Specify the initial pressure setting for the valve.
• Hydraulic Grade Setting (Initial): Specify the initial hydraulic grade setting for the
valve.
• Pattern (Valve Settings): Allows you to apply a pattern for changes to the valve's
setting over time for extended period simulations. (Note that patterns override
settings changes made by controls).
• Status (Initial): Choices: Active, Inactive, Closed
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity
through the valve and a corresponding minor loss when a minor loss coefficient is
entered.
• Valve Coefficient Type: Specifies which type of coefficient to enter for the control
valve. If entering discharge coefficient, the value is internally converted into an
equivalent headloss coefficient (minor loss).
• Discharge Coefficient (Fully Open): The discharge coefficient of the valve when
fully open. Used in lieu of minor loss for valves of this coefficient type.
• Specify Local Minor Loss?: If True, the minor coefficient for the element is
manually set in the Minor Loss Coefficient (Local) field; otherwise the value is
derived from the minor loss library.
• Minor Loss Coefficient (Local): User-input minor loss coefficient. You can either
type the value directly in this field or select the value from the minor loss library.
The minor loss is applied to the valve when it is fully open (inactive). Note that
minor losses do not apply to the following valve types: General Purpose Valve and
Valve With Linear Area Change. These two valve types do not support a (fully)
open status and always apply the head/flow relationship defined by their headloss
curve and discharge coefficient, respectively.
• Status (Initial, Transient): Choices: Active, Inactive, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.

16-1134 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Hydraulic Grade Setting (Calculated): Hydraulic Grade Setting during current
time step.
• Pressure Setting (Calculated): Pressure setting for valve at current time step.
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the
element, depending on whether its derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.

Bentley HAMMER V8i Edition User’s Guide 16-1135

Valve Attributes

• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Pressure Breaker Valve (PBV) Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Flow (Initial): This is a typical (positive) flow through the valve.
• Pressure Drop (Initial): Pressure drop corresponding to the typical flow.
• Setting Type: Choices: Pressure, Hydraulic Grade
• Pressure Setting (Initial): Specify the initial pressure setting for the valve.
• Hydraulic Grade Setting (Initial): Specify the initial hydraulic grade setting for the
valve.
• Pattern (Valve Settings): Allows you to apply a pattern for changes to the valve's
setting over time for extended period simulations. (Note that patterns override
settings changes made by controls).
• Status (Initial): Choices: Active, Inactive, Closed
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity
through the valve and a corresponding minor loss when a minor loss coefficient is
entered.

16-1136 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Valve Coefficient Type: Specifies which type of coefficient to enter for the control
valve. If entering discharge coefficient, the value is internally converted into an
equivalent headloss coefficient (minor loss).
• Discharge Coefficient (Fully Open): The discharge coefficient of the valve when
fully open. Used in lieu of minor loss for valves of this coefficient type.
• Specify Local Minor Loss?: If True, the minor coefficient for the element is
manually set in the Minor Loss Coefficient (Local) field; otherwise the value is
derived from the minor loss library.
• Minor Loss Coefficient (Local): User-input minor loss coefficient. You can either
type the value directly in this field or select the value from the minor loss library.
The minor loss is applied to the valve when it is fully open (inactive). Note that
minor losses do not apply to the following valve types: General Purpose Valve and
Valve With Linear Area Change. These two valve types do not support a (fully)
open status and always apply the head/flow relationship defined by their headloss
curve and discharge coefficient, respectively.
• Status (Initial, Transient): Choices: Active, Inactive, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Hydraulic Grade Setting (Calculated): Hydraulic Grade Setting during current
time step.
• Pressure Setting (Calculated): Pressure setting for valve at current time step.
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.

Bentley HAMMER V8i Edition User’s Guide 16-1137

Valve Attributes

• Status (Calculated): Choices: Active, Inactive, Closed

• Minor Loss Coefficient (Unified): Displays the current minor loss value for the
element, depending on whether its derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Flow Control Vale (FCV) Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.

16-1138 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Flow Setting (Initial): Initial flow setting for the flow control valve.
• Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow /
(Pressure Drop) ^ 0.5.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Flow (Initial, Transient): The initial flow to be used in the transient analysis.
• Pattern (Valve Settings): Allows you to apply a pattern for changes to the valve's
setting over time for extended period simulations. (Note that patterns override
settings changes made by controls).
• Valve Characteristics: Specifies the valve characteristics definition to be used for
this valve. If the Valve Characteristic Curve is not defined then a default curve
will be used. The default curve will have (Relative Closure, Relative Area) points
of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Status (Initial): Choices: Active, Inactive, Closed
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity
through the valve and a corresponding minor loss when a minor loss coefficient is
entered.
• Valve Coefficient Type: Specifies which type of coefficient to enter for the control
valve. If entering discharge coefficient, the value is internally converted into an
equivalent headloss coefficient (minor loss).
• Discharge Coefficient (Fully Open): The discharge coefficient of the valve when
fully open. Used in lieu of minor loss for valves of this coefficient type.
• Specify Local Minor Loss?: If True, the minor coefficient for the element is
manually set in the Minor Loss Coefficient (Local) field; otherwise the value is
derived from the minor loss library.
• Minor Loss Coefficient (Local): User-input minor loss coefficient. You can either
type the value directly in this field or select the value from the minor loss library.
The minor loss is applied to the valve when it is fully open (inactive). Note that
minor losses do not apply to the following valve types: General Purpose Valve and
Valve With Linear Area Change. These two valve types do not support a (fully)
open status and always apply the head/flow relationship defined by their headloss
curve and discharge coefficient, respectively.
• Status (Initial, Transient): Choices: Active, Inactive, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.

Bentley HAMMER V8i Edition User’s Guide 16-1139

Valve Attributes

• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow Setting (Calculated): Flow setting at selected valve for current time step.
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the
element, depending on whether its derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.

16-1140 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Throttle Control Valve (TCV) Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Headloss Coefficient Setting (Initial): Set the initial headloss coefficient for the
valve.
• Discharge Coefficient (Initial): The discharge coefficient used at the start of a
steady state or EPS run.
• Relative Closure (Initial): The initial relative closure used at the start of a steady
state or EPS run. (A relative closure of 0%% means the valve is 0%% closed, or
100%% open. Conversely, a relative closure of 100%% means the valve is
100%% closed, or 0%% open).
• Coefficient Type: Choices: Headloss Coefficient, Discharge Coefficient, Valve
Characteristics Curve
• Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow /
(Pressure Drop) ^ 0.5.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Pattern (Valve Settings): Allows you to apply a pattern for changes to the valve's
setting over time for extended period simulations. (Note that patterns override
settings changes made by controls).
• Pattern (Relative Closures): Allows you to apply a pattern for changes to the
valve's relative closure over time for extended period simulations. (Note that
patterns override settings changes made by controls).

Bentley HAMMER V8i Edition User’s Guide 16-1141

Valve Attributes

• Discharge Coefficient (Fully Open): The discharge coefficient of the valve when
fully open. Used in lieu of minor loss for valves of this coefficient type.
• Relative Closure (Initial Transient): The initial relative closure of the valve at the
start of the transient calculation.
• Valve Characteristics: Specifies the valve characteristics definition to be used for
this valve. If the Valve Characteristic Curve is not defined then a default curve
will be used. The default curve will have (Relative Closure, Relative Area) points
of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Status (Initial): Choices: Active, Inactive, Closed
• Specify Local Minor Loss?: If true then the minor coefficent for the element is
manually set, otherwise the value is derived from the minor loss library.
• Minor Losses: List of all associated minor losses associated with the element, and
can be used to generate the composite minor loss coefficient.
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity
through the valve and a corresponding minor loss when a minor loss coefficient is
entered.
• Status (Initial, Transient): Choices: Active, Inactive, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Headloss Coefficient Setting (Calculated): TCV headloss coefficient setting at the
current time step.
• Discharge Coefficient Setting (Calculated): TCV discharge coefficient setting at
the current time step.
• Relative Closure (Calculated): TCV relative closure at the current time step. (A
relative closure of 0%% means the valve is 0%% closed, or 100%% open.
Conversely, a relative closure of 100%% means the valve is 100%% closed, or
0%% open).
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.

16-1142 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Pressure Loss: Change in pressure across the valve.

• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the
element, depending on whether its derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Bentley HAMMER V8i Edition User’s Guide 16-1143

Valve Attributes

General Purpose Valve (GPV) Attributes

• ID: Unique identifier assigned to this element.

• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Flow (Initial): This is a typical (positive) flow through the valve.
• Pressure Drop (Initial): Pressure drop corresponding to the typical flow.
• Discharge Coefficient (Transient): Discharge coefficient, Cv, is defined as: Flow /
(Pressure Drop) ^ 0.5.
• Operating Rule: Specifies the operation of the valve during a transient simulation.
• Transient Analysis Behavior: Choices: Orifice, Valve
• Valve Characteristics: Specifies the valve characteristics definition to be used for
this valve. If the Valve Characteristic Curve is not defined then a default curve
will be used. The default curve will have (Relative Closure, Relative Area) points
of (0,1) and (1,0).
• Valve Type: Choices: Butterfly, Needle, Circular Gate, Globe, Ball, User Defined
• Status (Initial): Choices: Active, Closed
• Specify Local Minor Loss?: If true then the minor coefficent for the element is
manually set, otherwise the value is derived from the minor loss library.
• Minor Losses: List of all associated minor losses associated with the element, and
can be used to generate the composite minor loss coefficient.
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity
through the valve and a corresponding minor loss when a minor loss coefficient is
entered.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.

16-1144 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Flow: Total flow through the valve.

• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.
• Pressure (To): Calculated pressure at the exit to the valve.
• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the
element, depending on whether its derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient 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.

Bentley HAMMER V8i Edition User’s Guide 16-1145

Valve With Linear Area Change Attributes

• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Valve With Linear Area Change Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Status (Initial): Choices: Active, Closed
• Specify Local Minor Loss?: If true then the minor coefficent for the element is
manually set, otherwise the value is derived from the minor loss library.
• Minor Losses: List of all associated minor losses associated with the element, and
can be used to generate the composite minor loss coefficient.
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity
through the valve and a corresponding minor loss when a minor loss coefficient is
entered.
• Status (Initial, Transient): Choices: Active, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow: Total flow through the valve.
• Velocity: Velocity of flow traveling through the valve.
• Headloss: Change in head across the valve.
• Pressure Loss: Change in pressure across the valve.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the valve.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the valve.
• Pressure (From): Calculated pressure at the entrance of the valve.

16-1146 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Pressure (To): Calculated pressure at the exit to the valve.

• Flow (Absolute): Magnitude of flow through the selected valve.
• Status (Calculated): Choices: Active, Inactive, Closed
• Minor Loss Coefficient (Unified): Displays the current minor loss value for the
element, depending on whether its derived or local.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Check Valve Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.

Bentley HAMMER V8i Edition User’s Guide 16-1147

Check Valve Attributes

• Notes: Additional information about this element.

• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Flow (Typical): This value is 0 should the valve be initially closed.
• Pressure (Threshold): The pressure difference between upstream and downstream
side to (re)open the (closed) valve. If 0 entered, the valve (re)opens when the
upstream pressure exceeds the downstream pressure.
• Closure Time: Time to close the valve, from the fully open position, after reverse
flow is sensed. This establishes the rate of closure in case the valve's opening is
partial.
• Open Time: Time to open the valve, from the fully closed position, after specified
pressure difference is exceeded. This establishes the rate of opening in case the
valve's closure is partial.
• Allow Disruption of Operation?: Determines whether an operation (opening or
closing) can be terminated prematurely due to a signal to reverse.
• Located At Wye?: Specifies whether the check valve is simulated as a simple
check valve in a run of pipe, or if it is simulated as a wye connection.
• Flow Direction: Choices: Towards Wye, Away from Wye
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow: Total flow through the check valve.
• Flow (Absolute): Magnitude of flow through the selected check valve.
• Pressure: Calculated pressure at the check valve.
• Hydraulic Grade: Calculated hydraulic grade at the check valve.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.

16-1148 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Orifice Between Pipes Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Pressure Drop (Typical): Pressure drop corresponding to the typical flow.
• Flow (Typical): This is a typical (positive) flow through the orifice or valve.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.

Bentley HAMMER V8i Edition User’s Guide 16-1149

Orifice Between Pipes Attributes

• Age (Initial): Specify the initial age of the fluid at the selected element.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Flow: Total flow through the orifice.
• Headloss: Change in head across orifice.
• Hydraulic Grade (From): Calculated hydraulic grade at the entrance of the orifice.
• Hydraulic Grade (To): Calculated hydraulic grade at the exit of the orifice.
• Pressure (From): Calculated pressure at the entrance of the orifice.
• Pressure (To): Calculated pressure at the exit to the orifice.
• Flow (Absolute): Magnitude of flow through the selected orifice.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Is Closed?: True if the current element is closed during the current time step.
• Is Open?: Set to true if open during the current time step.
• Is Initially Closed?: If true, the initial condition for the control element is "Closed"
or "Off."
• Controlled?: Is true if a control action in the current control set references the
selected element.
• Cannot Deliver Flow or Head?: If true then the cannot deliver head or cannot
deliver flow warning was generated for the element for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient 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.

16-1150 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Discharge To Atmosphere Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Discharge Element Type: Choices: Orifice, Valve, Rating Curve
• Gas Volume (Initial): The accumulated air at the orifice at the beginning of the
simulation.
• Time to Start Operating: Valve starts to operate after this time.
• Time to Fully Open or Close: Time to close (or open, if zero initial flow) the
valve.
• Valve Initial Status: Choices: Open, Closed
• Pressure Head vs. Flow: Specify a collection of Pressure Head vs. Flow points.
• Report Period (Transient): Number of time steps between successive printouts of
operation. By default, this printout is suppressed.
• Pressure Drop (Typical): Pressure drop corresponding to the typical flow.
• Flow (Typical): This is a typical (positive) flow through the orifice or valve.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion 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 constit-
uent concentration varies over time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint
Booster, Mass Booster

Bentley HAMMER V8i Edition User’s Guide 16-1151

Surge Tank Attributes

• 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 constit-
uent mass rate at this node over time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Discharge (Calculated): Calculated discharge from the node.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Surge Tank Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.

16-1152 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Diameter (Orifice): Specifies the diameter of the tank inlet orifice. Only used by
the transient engine.
• Ratio of Losses: Ratio of the head losses for equal inflows to / outflows from the
tank via the orifice. Default value is 2.5.
• Headloss Coefficient: Applies to flow from the tank to the pipe/riser. This must be
a positive number.
• Surge Tank Type: Choices: Simple, Differential
• Has Check Valve?: Specify whether there is a check valve installed on the tank
inlet/outlet. For the case of steady state and EPS simulations, a surge tank with a
check valve is simulated as a pressure junction.
• Diameter (Internal Riser): This is the upper riser.
• Elevation (Top of Internal Riser): The top of the upper riser.
• Elevation (Junction of Risers): Elevation at which the external and internal risers
meet.
• Diameter (External Riser): This is the lower riser.
• Elevation (Orifice from Internal Riser to Tank): Elevation of the internal riser
orifice.
• Elevation (Top of Tank Base): The elevation of the top of the hemisherical base of
the tank. For a cylindrical tank, this is equal to the pipe elevation.
• Weir Length: The width of the weir.
• Treat as Junction?: Specifies whether or not to treat the surge tank as a junction in
steady state and EPS simulations.
• Elevation (Base): Elevation of the storage tank base used as a reference when
entering water surface elevations in the tank in terms of levels.
• Elevation (Maximum): Highest allowable water surface elevation or level. If the
tank fills above this point, it will be automatically shut off from the system.
• Level (Maximum): A reference level to compare the hydraulic grade in the tank.
Does not influence the calculations.
• Diameter: Diameter of tank with constant circular cross-section.
• Area (Average): Cross-Sectional area of tank for constant x-section tanks.
• Volume Full (Input): full active volume of the variable area tank (i.e., the volume
at 100% depth), exclusive of any inactive volume.
• Operating Range Type: Choices: Elevation, Level
• Section: Choices: Circular, Non-Circular, Variable Area
• Cross-Section Curve: Defines a curve which specifies the relationship between
depth and volume.

Bentley HAMMER V8i Edition User’s Guide 16-1153

Surge Tank Attributes

• Specify Local Bulk Rate?: If true than a local Bulk Reaction Rate can be specified
for the tank, otherwise the bulk reaction rate associated with selected constituent
will govern.
• Bulk Reaction Rate (Local): Coefficient defining how rapidly a constituent grows
or decays over time.
• Tank Mixing Model: Choices: 2-Compartment, Completely Mixed, FIFO, LIFO
• Compartment 1: Percent of available storage that makes up the first compartment.
Inflow and outflow is assumed to take place in the first compartment.
• Compartment 2: Percent of available storage that makes up the second compart-
ment. The second compartment receives overflow from the first, and this overflow
is completely mixed.
• Elevation (Minimum): Lowest allowable water surface elevation or level. If the
tank drains below this point, it will be automatically shut off from the system.
• Volume (Inactive): The inactive volume of the tank. This volume is the inacces-
sible 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 gener-
ated. Calculation notifications are produced to advise you of any alarm level
violations.
• Level (High Alarm): The level above which the high level alarm is generated.
Calculation notifications are produced to advise you of any alarm level violations.
• Elevation (Low Alarm): The elevation below which the low level alarm is gener-
ated. Calculation notifications are produced to advise you of any alarm level
violations.
• Level (Low Alarm): The level below which the low level alarm is generated.
Calculation notifications are produced to advise you of any alarm level violations.
• Use High Alarm?: Specifies whether or not to check high alarm levels during
Steady State/EPS calculation and generate messages if the levels are violated.
• Use Low Alarm?: Specifies whether or not to check low alarm levels during
Steady State/EPS calculation and generate messages if the levels are violated.
• Elevation (Initial): Starting water surface elevation/level in the tank.
• Level (Initial): Starting water surface elevation/level in the tank.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.

16-1154 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Elevation (Initial, Transient): Enter a value only if a check valve is installed (i.e.,
case of a one-way surge tank), or there is an initial inflow/outflow head loss. By
default, the intial water surface level is taken equal to the head in the adjacent
pipe.
• Report Period (Transient): Number of time steps between successive printouts of
operation. By default, this printout is suppressed.
• Demand Collection: A collection of baseline demands and associated temporal
patterns.
• Unit Demand Collection: A collection of unit demands, associated unit counts,
and temporal patterns.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion 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 constit-
uent 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 constit-
uent mass rate at this node over time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Volume Full (Calculated): The full active volume of the tank between the limits of
the defined operating range, exclusive of any inactive volume.
• Level (Calculated): Difference between calcuted hydraulic grade and the base
elevation of the tank.
• Volume (Calculated): Total volume of fluid in tank including the inactive volume.
• 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.

Bentley HAMMER V8i Edition User’s Guide 16-1155

Hydropneumatic Tank Attributes

• Demand Adjusted Population: Population of area supplied by current node. This

value is derived from the unit demand loads applied to the collection and their
equivalent populations.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Hydropneumatic Tank Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Volume of Gas (Initial): The initial volume of gas in the pressure vessel at the start
of the simulation. During the transient event, this gas volume expands or
compresses, depending on the transient pressures in the system. Not used in
steady state or EPS analyses.
• Diameter (Tank Inlet Orifice): The size of the opening between the gas vessel and
the main pipe line. It is typically smaller than the main pipe size.

16-1156 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• 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 inter-
face. (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.
• Elevation (Base): Elevation of the storage tank base used as a reference when
entering water surface elevations in the tank in terms of levels.
• Treat as Junction? - Selects whether or not the hydropneumatic tank is treated as a
junction in steady state and EPS simulations. Note that if you wish to use the
steady state/EPS results as input for a HAMMER transient analysis and you set
this field to True, you will need to manually enter the Volume of Gas (Initial) for
the tank for HAMMER
• Volume of Gas (Initial) - The initial volume of gas in the pressure vessel at the
start of the simulation. During the transient event, the gas volume expands or
compresses, depending on the transient pressures in the system. This value is not
used in steady state or EPS analyses.
• Operating Range Type: Choices: Elevation, Level
• Tank Calculation Model: Choices: Constant Area Approximation, Gas Law
Model
• Volume (Effective): The effective volume of the constrant area approximation
hydropneumatic tank.
• HGL On: The lowest operational hydraulic grade desired for the hydropneumatic
tank. You should define a simple or logical control that uses this hydraulic grade
as the minimum operational value. For example, define a control to turn on a
pump.
• HGL Off: The highest operational hydraulic grade desired for the hydropneumatic
tank. You should define a simple or logical control that uses this hydraulic grade
as the maximum operational value. For example, define a control to turn off a
pump.

Bentley HAMMER V8i Edition User’s Guide 16-1157

Hydropneumatic Tank Attributes

• Atmospheric Pressure Head: This field represents atmospheric pressure and is

used in the gas law model computation of the hydropneumatic tank.
• HGL (Initial): Starting water surface elevation/level in the tank. Used in steady
state and EPS analyses.
• Level (Initial): Starting water surface elevation/level in the tank. Used in steady
state and EPS analyses.
• Liquid Volume (Initial): Starting liquid volume in the tank. For constant area
approximation tanks this volume includes the inactive volume of the tank that lies
below the effective volume. Only used in steady state and EPS analyses.
• Air Flow Curve (Air Inflow Orifice): Curve that defines orifice behavior for the
injection of air into the pipeline.
• Air Flow Curve (Air Outflow Orifice): Curve that defines discharge of air when
the volume is greater than or equal to the transition volume (TV).
• Air Flow Calculation Method: Choices: Orifice Diameter, Air Flow Curve
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Elevation (Initial, Transient): Enter a value only if a check valve is installed (i.e.,
case of a one-way surge tank), or there is an initial inflow/outflow head loss. By
default, the intial water surface level is taken equal to the head in the adjacent
pipe.
• Report Period (Transient): Number of time steps between successive printouts of
operation. By default, this printout is suppressed.
• Demand Collection: A collection of baseline demands and associated temporal
patterns.
• Unit Demand Collection: A collection of unit demands, associated unit counts,
and temporal patterns.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion 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 constit-
uent concentration varies over time.
• Constituent Source Type: Choices: Concentration, Flow Paced Booster, Setpoint
Booster, Mass Booster

16-1158 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Concentration (Base): This data field allows you to specify the corresponding
constituent concentration at this node over time.
• Mass Rate (Base): This data field allows you to specify the corresponding constit-
uent mass rate at this node over time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Gas Volume (Calculated): The calculated volume of gas in the hydropneumatic
tank.
• Pressure (Calculated): The calculated pressure in the hydropenumatic tank.
• Liquid Volume (Calculated): The calculated liquid volume in the hydropneumatic
tank.
• Percent Full: The ratio of the fluid volume in the tank to the calculated full volume
of the tank.
• Flow (Out net): Net flow out of the element.
• Flow (In net): Net flow into the element.
• Demand Adjusted Population: Population of area supplied by current node. This
value is derived from the unit demand loads applied to the collection and their
equivalent populations.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Bentley HAMMER V8i Edition User’s Guide 16-1159

Air Valve Attributes

Air Valve Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Air Volume (Initial): Volume of air near the valve at the start of the simulation.
The default is zero. If volume is nonzero, the pressure must be zero.
• Time to Close: For an air valve, adiabatic compression (i.e., gas law exponent =
1.4) is assumed.The valve starts to close linearly with respect to area only when
air begins to exit from the pipe. If air subsequently re-enters, then the 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 tran-
sition pressure (TP) (depending on which trigger is used to switch the outflow
orifice size). This diameter is typically small enough for the injected air to be
compressed, which can help prevent severe transient pressures. Generally air
flows out the large air outflow orifice for some time before switching to the small
air outflow orifice for the final stages of air release.
• Diameter (Large Air Outflow Orifice): Refers to the discharge of air when the
local air volume is greater than or equal to the transition volume (TV), or the air
pressure is less than or equal to the transition pressure (TP) (depending on which
trigger is used to switch the outflow orifice size). This diameter is typically large
enough that there is little or no restriction to air outflow. Generally air flows out
the large air outflow orifice for some time before switching to the small air
outflow orifice for the final stages or air release.
• Diameter (Air Inflow Orifice): Diameter of the air inflow orifice (the orifice
through which air enters the pipeline when the pipe internal pressure is less than
atmospheric pressure). This diameter should be large enough to allow the free
entry of air into the pipeline. If set to zero, this diameter is considered infinite (i.e.
there is no restriction to air inflow).
• Diameter (Air Outflow Orifice): Diameter of the air outflow orifice (the orifice
through which air is expelled from the pipeline).
• Transition Pressure: The local internal system air pressure at the air valve above
which the transient solver switches from using the large air orifice to the small air
orifice (in order to minimize transients).

16-1160 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• Transition Volume: The local volume of air at the air valve below which the tran-
sient solver switches from using the large air orifice to the small air orifice (in
order to minimize transients). This volume often corresponds to the volume of the
body of the air valve.
• Air Flow Curve (Small Air Outflow Orifice): Curve that defines discharge of air
when the air volume is less than the transition volume (TV), or the air pressure is
greater than the transition pressure (TP).
• Air Flow Curve (Large Air Outflow Orifice): Curve that defines discharge of air
when the air volume is greater than or equal to the transition volume (TV), or the
air pressure is less than or equal to the transition pressure (TP).
• Air Valve Type: Choices: Slow Closing, Double Acting, Triple Acting, Vacuum
Breaker
• Trigger to Switch Outflow Orifice Size: Select whether the transient solver
switches from the large air outflow orifice to the small air outflow orifice based on
Transition Volume or Transition Pressure.
• Report Period (Transient): Number of time steps between successive printouts of
operation. By default, this printout is suppressed.
• Treat Air Valve as Junction?: Specifies whether or not to treat the air-valve as a
junction element in steady state and EPS simulations. If false, the valve may allow
part full flow subject to the prevailing hydraulic conditions.
• Air Flow Curve (Air Inflow Orifice): Curve that defines orifice behavior for the
injection of air into the pipeline.
• Air Flow Curve (Air Outflow Orifice): Curve that defines discharge of air when
the volume is greater than or equal to the transition volume (TV).
• Air Flow Calculation Method: Choices: Orifice Diameter, Air Flow Curve
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion 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 constit-
uent 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.

Bentley HAMMER V8i Edition User’s Guide 16-1161

Surge Valve Attributes

• Mass Rate (Base): This data field allows you to specify the corresponding constit-
uent mass rate at this node over time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Surge Valve Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Diameter (SAV): The valve's characteristics are determined by its Cv and type, so
that the diameter is only used for descriptive purposes.
• Threshold Pressure (SAV): Pressure below which the SAV opens.

16-1162 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• 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
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion 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 constit-
uent 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 constit-
uent mass rate at this node over time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.

Bentley HAMMER V8i Edition User’s Guide 16-1163

Rupture Disk Attributes

• Trace (Calculated): Trace at selected element for current time step.

• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Rupture Disk Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Pressure Threshold: The pressure above which the rupture disk breaks to vent the
liquid to atmosphere.
• Pressure Drop (Typical): Pressure drop corresponding to the typical flow.
• Flow (Typical): This is a typical (positive) flow through the orifice or valve.
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Trace (Initial): Specify the initial trace amount at the current location.
• Zone: Specify the zone for the element.
• Concentration (Initial): Specify the initial concentration for the global concentra-
tion at the selected element.

16-1164 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

• 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 constit-
uent 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 constit-
uent mass rate at this node over time.
• Age (Initial): Specify the initial age of the fluid at the selected element.
• Pressure: Calculated pressure at node.
• Pressure Head: Calculated pressure head at node.
• Hydraulic Grade: Calculated hydraulic grade at node.
• Age (Calculated): Age at selected element for current time step.
• Trace (Calculated): Trace at selected element for current time step.
• Concentration (Calculated): Concentration at selected element for current time
step.
• Has Calculation Messages Now?: If true then the current element has associated
calculation warning messages for the current time step.
• Head (Maximum, Transient): Maximum head at node over the course of the tran-
sient simulation.
• Head (Minimum, Transient): Minimum head at node over the course of the tran-
sient simulation.
• Pressure (Maximum, Transient): Maximum pressure at node over the course of
the transient simulation.
• Pressure (Minimum, Transient): Minimum pressure at node over the course of the
transient simulation.
• Air Volume (Maximum, Transient): Maximum air volume at node over the course
of the transient simulation. Not applicable to Reservoirs and Rating curves.
• Vapor Volume (Maximum, Transient): Maximum vapor volume at node over the
course of the transient simulation. Not applicable to Reservoirs and Rating curves.

Isolation Valve Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.

Bentley HAMMER V8i Edition User’s Guide 16-1165

Spot Elevation Attributes

• Notes: Additional information about this element.

• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Diameter (Valve): Inside diameter of the valve. Used to calculate the velocity
through the valve and a corresponding minor loss when a minor loss coefficient is
entered.
• Minor Loss Coefficient: K value in the minor headloss equation.
• Is Operable?: If true, valve can be used in identifying segments.
• Status (Initial): Choices: Open, Closed
• Elevation: Elevation at centroid of junctions, valves, and pumps; the ground
elevation at tanks; the hydraulic grade at reservoirs.
• Installation Year: Specify the install year of the element. It does not affect the
calculations.
• Zone: Specify the zone for the element.
• Hydraulic Grade: Hydraulic Grade at valve location on pipe.
• Pressure: Pressure at valve location on pipe.
• Flow: Magnitude of flow through isolation valve.
• Velocity: Velocity through the isolation valve.
• Distance from End Point (Unified): Presents the active Distance From End Point
for the current isolation valve.
• Is Closed?: True if current isolation valve is closed during the current time step.

Spot Elevation Attributes

• ID: Unique identifier assigned to this element.
• Label: Descriptive label for this element.
• Notes: Additional information about this element.
• GIS-IDs: List of associated IDs on the GIS/data-source side.
• Hyperlinks: Associate one or more web link, photo, word processing document,
or other file with this element.
• Hydraulic Grade (Enhanced)Interpolated hydraulic grade at this location.
• Pressure (Enhanced)Pressure based on the interpolated hydraulic grade.

16-1166 Bentley HAMMER V8i Edition User’s Guide

 Element Properties Reference

Bentley HAMMER V8i Edition User’s Guide 16-1167

Spot Elevation Attributes

16-1168 Bentley HAMMER V8i Edition User’s Guide

 Technical Information
Resources 17
docs.bentley.com

Bentley Services

Bentley Discussion Groups

Bentley on the Web

TechNotes/Frequently Asked Questions

BE Magazine

BE Newsletter

Client Server

BE Careers Network

Contact Bentley Systems

docs.bentley.com

Bentley ServicesBentley Discussion Groups

Bentley on the Web

TechNotes/Frequently Asked Questions

BE Magazine

BE NewsletterClient Server

BE Careers Network

Bentley HAMMER V8i Edition User’s Guide 17-1169

docs.bentley.com

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.

17-1170 Bentley HAMMER V8i Edition User’s Guide

 Technical Information Resources

Bentley Services
There are a variety of Bentley Services, including Bentley SELECTR priority services,
one-on-one consulting, training programs, MicroStation resellers, as well as your local
technical support provider.

U.S./Canada/Latin [email protected]
America

Europe/Middle East/ [email protected]

Africa

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 tech-
nology. 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 exam-

ples relevant to your day-to-day project efforts. Training is developed concurrently
with software applications to provide knowledge of the latest tools and features. Addi-
tionally, all Bentley Institute faculty meet rigorous certification requirements.

Bentley HAMMER V8i Edition User’s Guide 17-1171

Bentley Discussion Groups

To access the Bentley Institute home page directly from Bentley HAMMER, 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 prod-
ucts, services, industries, events and training, community information, and the latest
corporate news announcements pertaining to Bentley Systems, Incorporated, your
global provider of collaborative software solutions.

TechNotes/Frequently Asked Questions

TechNotes, FAQs and other technical support information are available online at
Bentley's Bentley HAMMER 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.

17-1172 Bentley HAMMER V8i Edition User’s Guide

 Technical Information Resources

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 informa-

tion in the form of book excerpts, case studies, commentary and analysis, and
productivity tips. For more detailed information go online to http://
www.bentley.com and click the Support link.

BE Careers Network
The BE (Bentley Empowered) Careers Network is a program dedicated to supporting
accredited academic institutions by providing the latest releases of Bentley products,
as well as world-renowned support, online communities, and the latest engineering
news and information. For details about the BE Careers Network go online at http://
www.becareers.org/.

Contact Bentley Systems

Contact Bentley Systems if you want product information, to upgrade your software,
or need technical support.

Sales

Bentley Systems’ professional staff is ready to answer your questions. Please contact
your sales representative for any questions regarding Bentley Systems’ latest products
and prices.

Toll-free U.S. Phone: 800-727-6555

Worldwide Phone: +1-203-755-1666
Fax: +1-203-597-1488
Email: [email protected]

Bentley HAMMER V8i Edition User’s Guide 17-1173

Contact Bentley Systems

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 Bentley
HAMMER 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 Bentley HAMMER V8i.log files located in the product
directory (e.g., C:\Documents and Settings\<User Name>\Local Settings\Applica-
tion 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

17-1174 Bentley HAMMER V8i Edition User’s Guide

 Technical Information Resources

Bentley HAMMER V8i Edition User’s Guide 17-1175

Contact Bentley Systems

17-1176 Bentley HAMMER V8i Edition User’s Guide

 Glossary
18
Glossary
ABCDEFGHILMNOPRSTVWX

Age: An analysis for the age of water determines how long the
water has been in the system, and is a general water
quality indicator.
Available Fire Flow: Amount of flow available at a node for fire protection
while maintaining all fire flow pressure constraints.

.bak: Extension for backup files.

Base Elevation & Level: Elevation from which all tank levels are measured. For
example, a tank level of two meters represents a water
surface elevation two meters above the base elevation.
Boundary Node: Node with a known hydraulic grade. It may be static
(unchanging with time), such as a reservoir, or dynamic
(changes with time), such as a tank. Every pipe network
must contain at least one boundary node. In order to
compute the hydraulic grade at the other nodes in the
network, they must be reachable from a boundary.
Bulk Reaction Coefficient: Coefficient used to define how rapidly a constituent
grows or decays over time. It is expressed in units of 1/
time, for first-order reactions.

Bentley HAMMER V8i Edition User’s Guide 18-1177

Glossary

Calc. Min. System Pressure: Minimum calculated pressure of all junctions in the
system during fire flow withdrawal at a node.
Calc. Min. Zone Pressure: Minimum calculated pressure of all junctions in the same
zone as the node where fire flow withdrawal occurs.
Calc. Residual Pressure: Calculated pressure at the junction node where the fire
flow withdrawal occurs.
Calculation Unready: An element that does not have all the required
information for performing an analysis is considered to
be calculation unready.
C-Coefficient: Roughness coefficient used in the Hazen-Williams
Equation.
Check Valve: Prevents water from flowing backwards through the pipe.
In other words, water can only flow from the From Node
to the To Node.
Closed/Inactive Status: You can control the status of a valve to be either inactive
or closed. Inactive means that the valve will act like an
open pipe where flow can occur in either direction, and
the headloss across the valve will be calculated using the
valve’s minor loss factor. Closed means that no flow will
occur through the valve.
Constituent: Any substance, such as chlorine or fluoride, for which the
growth or decay can be adequately described through the
use of a bulk reaction coefficient and a wall reaction
coefficient.
Context Menu: A shortcut menu opened by right-clicking a project
element or data entry field. Commands on the context
menu are specific to the current state of the selected item.
Control Status: A pressure pipe can be either Open or Closed. Open
means that flow occurs in the pipe, and Closed means
that no flow occurs in the pipe.
Conveyance Element: A pipe or channel used to transport water.
Coordinates: Distances perpendicular to a set of reference axes. Some
areas may have predefined coordinate systems, while
other coordinate systems may be arbitrary. Coordinates
may be presented as X and Y values or may be defined as
Northing and Easting values, depending on individual
preferences.

18-1178 Bentley HAMMER V8i Edition User’s Guide

 Glossary

Cross Section Type: Tanks can have either a constant area cross section or a
variable area cross section. The cross section of a tank
with a constant area is the same throughout the depth.
The cross section of a tank with a variable area varies
throughout the depth.
Crosshair: The cursor that looks like a plus sign (+).
Current Storage Volume: The volume of water currently stored in a tank. It
includes both the hydraulically active volume and the
hydraulically inactive volume.
CV: Check valve.

.dgn: Drawing information in MicroStation.

.dwg: Drawing information in AutoCAD.
.dwh: Drawing information in Stand-Alone.
Database Connections: A connection represented by a group of database links.
There may be a single linked external file within a
connection, or there may be several external file links
within a single connection.
Dataset: A Bentley HAMMER V8i project.
DBMS: An acronym that stands for Database Management
System. These systems can be relational (RDBMS) or
non-relational.
DEM: Digital elevation model.
Demand: Represents the total demand from an individual junction
for the current time period. It is based on the information
from the Demand tab of the Junction Editor.
Design Point: Point at which a pump was originally intended to operate,
and 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.
Diameter: Refers to a pipe or valve’s inside diameter. It is the
distance between two internal points directly opposite
each other.
Discharge: Volumetric rate of flow given in units of length3/time.
DLG: Digital line graph.
Double-Click: To click the left mouse button twice in rapid succession.

Bentley HAMMER V8i Edition User’s Guide 18-1179

Glossary

Drag: To hold down one of the mouse buttons while you move
the mouse.

Element: An object such as a tank, junction node, or pipe in a

drawing.
Elevation: The distance from a datum plane to the center of the
element. Elevations are often referenced with mean sea
level as the datum elevation.
Energy Grade Line (EGL): Sum of datum (base elevation), elevation, velocity head,
and pressure head at a section.
EPS: Extended Period Simulation.
Extended Edit: A small button with an ellipsis (…) as the label.
Extended edit buttons are located next to drop-down
choice lists, and provide further editing for the associated
choice list items.
External Files: Any file outside of this program that can be linked. These
include database files (such as FoxPro, Dbase or
Paradox) and spreadsheets (such as Excel or Lotus).
Throughout the documentation, all of these file types will
be referred to as databases or external files
interchangeably.
Extrapolate: To infer a value based on other known values, with the
desired value lying outside the known range. Often based
upon extending the slope of the line connecting the
previous known values to the desired point. See also:
interpolate.

Feature Class: 1. A classification describing the format of geographic

features and supporting data in a coverage. Coverage
feature classes for representing geographic features
include point, arc, node, route-system, route, section,
polygon and region. One or more coverage features are
used to model geographic features; for example, arcs and
nodes can be used to model linear features such as street
centerlines. The tic, annotation, link, and boundary
feature classes provide supporting data for coverage data
management and viewing.

18-1180 Bentley HAMMER V8i Edition User’s Guide

 Glossary

2. The conceptual representation of a geographic feature.

When referring to geographic features, feature classes
include point, line, area, and surface.
Feature Dataset: A feature dataset is a collection of feature classes that
share the same spatial reference.
Field Links: Define the actual mapping between model element
attributes and columns within each database table.
File Extension: The period and three characters, typically, at the end of a
filename. A file extension usually identifies the kind of
information the file contains. For example, files you
create in AutoCAD have the extension *.DWG.
Fire Flow Upper Limit: The maximum allowable fire flow that can occur at a
withdrawal location. This is a user-specified practical
limit that will prevent this program from computing
unrealistically high fire flows at locations such as
primary system mains, which have large diameters and
high service pressures. Remember that a system’s ability
to deliver fire flows is ultimately limited by the size of
the hydrant opening and service line, as well as the
number of hydrants available to combat a fire at a
specific location.
Flow: Represents the calculated value of the pipe, valve, or
pump discharge at the given time.
From Node: Represents the pipe’s starting node. Positive flow rates
are in the direction of from towards to. Negative flow
rates are in the opposite direction.
From Pipe: The pipe that connects to the upstream side of a valve or
pump.

GA: Genetic algorithm.

GEMS Datastore: The relational database that Bentley HAMMER V8i
uses to store model data. Each Bentley HAMMER
V8i project uses two main files for data storage, the
datastore (.sqlite) and the Bentley HAMMER V8i
Modeler-specific data (.wtg). Although the Bentley
HAMMER V8i datastore is an .sqlite file, cannot be
a geodatabase.

Bentley HAMMER V8i Edition User’s Guide 18-1181

Glossary

Generations: The maximum value for genetic algorithm generations is

determined by the Maximum Era Number and Era
Generation Number you set in the GA Parameters. The
actual number of generations that get calculated depend
on the Stopping Criteria you set.
Geodatabase: Short for geographic database, a geodatabase stores
spatial and descriptive data in an efficient manner.
Geodatabases are the standard file format for ArcGIS v8
and later.

Headloss: Represents the energy lost due to friction and minor

losses. The headloss field displays the pipe, valve, or
pump’s total headloss at the given time.
Headloss Gradient: Presents the headloss in the pipe as a slope, or gradient.
This allows you to more accurately compare headlosses
for pipes of different lengths.
Hydraulic Grade: Elevation to which water would rise under zero pressure.
For open surfaces, such as reservoirs and tanks, this is
equal to the water surface elevation. The hydraulic grade
field presents the hydraulic grade for the element at the
current time period as calculated based on the system
flow rates and head changes.
Hydraulic Grade Setting: The constraint to which a valve regulates, expressed in
units of head (Length). Depending on the type of valve, it
may refer to either the upstream or downstream hydraulic
grade or the headloss across the valve.

:Inactive Volume: The volume of water below the minimum elevation of the
tank. This volume of water is always present, even when
the tank reaches its minimum elevation and closes itself
off from the system. Therefore, it is hydraulically
inactive. It is primarily used for water quality
calculations.
Inflow & Outflow: An inflow is a flow into a node from the system, while an
outflow is a flow from the node into the system. A
negative outflow is the same as a positive inflow, and a
negative inflow is the same as a positive outflow.

18-1182 Bentley HAMMER V8i Edition User’s Guide

 Glossary

Inheritance: Refers to the parent-child relationships used by scenarios

and alternatives. Just as in the natural world, inheritance
is used to refer to the situation where an entity receives
something from its parent. For example, we speak of a
child inheriting blue eyes from a parent. Unlike in the
natural world, inheritance in scenarios and alternatives is
dynamic. If the parent’s attribute changes, the child’s
attribute automatically changes at the same time, unless
the value is explicitly changed in a child.
Initial Settings: Sets the status of an element for a steady-state analysis or
the first time step in an extended period simulation. The
initial settings for a pipe, pump, or valve can be set using
the elemental dialog boxes or a table.
Initial Water Quality: Represents the starting conditions at a node for age, trace,
or constituent concentration. The initial value will be
slightly different depending on the analysis type.
Interpolate: Estimating a value between two known values assuming
a linear relationship. See also: extrapolate.
Invert: Lowest point of a pipe opening. Sometimes referred to as
the flow line.

Label: The unique name by which an element will be referenced

in reports, error messages, and tables.
Length: Represents the distance on a pipe from the From Node to
the To Node, according to the scaled length of the pipe.
To enter an overriding length, click the User Defined
Length field and type in your desired length value.
LIDAR: Light Detection and Ranging.

.sqlite: The open database file.

.mdk: Backup of mdb.
Manning’s Coefficient: Roughness coefficient used in Manning’s Formula.
Material: The selection of a pipe’s construction material. This
material will be used to determine a default value for the
pipe’s roughness.

Bentley HAMMER V8i Edition User’s Guide 18-1183

Glossary

Maximum Elevation: The highest allowable water surface elevation in a tank.

If the tank fills above this point, it will automatically shut
off from the system.
Max. Extended Operating Point:The absolute maximum discharge at which a pump
can operate, with zero head being added to the system.
This value may be computed by the program or entered
manually.
Maximum Operating Point: The highest discharge for which a pump is actually
intended to run. At discharges above this point, the pump
may behave unpredictably, or its performance may
decline rapidly.
Menu: A menu of available commands or actions you can
perform. Access menus from the menu bar at the top of
the main program window.
Messages: The section that contains information generated during
the calculation of the model, such as warnings, errors,
and status updates.
Messages Light: A light that appears on the Tab of the Messages sheet.
The light will be red if errors occurred during the
analysis, yellow if there are warnings or cautions, and
green if there are no warnings or errors.
Metadata: Additional information (aside from tabular and spatial
data) that makes the data useful. Includes characteristics
and information that are required to use the data but are
not contained within the data itself.
Minimum Elevation: The lowest allowable water surface elevation in a tank. If
the tank drains below this point, it will automatically shut
off from the system.
Minimum System Junction: The junction where the calculated minimum system
pressure occurs.
Minimum System Pressure: The minimum pressure allowed at any junction in the
entire system as result of 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. A fire flow analysis may be configured
to ignore this constraint.
Minimum Zone Junction: The junction where the calculated minimum zone
pressure occurs.
Minimum Zone Pressure: The minimum pressure to maintain 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

18-1184 Bentley HAMMER V8i Edition User’s Guide

 Glossary

associated with it, which can be specified 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.
Minor Loss: The field that presents the total minor loss K value for a
pipe or valve. If an element has more than one minor
loss, each can be entered individually by clicking the
Ellipsis (…) button.
Modeler/Stand-Alone: The Bentley software environment, and not the
AutoCAD one.
Mouse Buttons: The left mouse button is the primary button for selecting
or activating commands. The right mouse button is used
to activate shortcut context menus and help. Note that the
mouse button functions can be redefined using the
Windows Control Panel. If your mouse is equipped with
a mouse wheel, you can use it for various panning and
zooming functions.

.nrg: File containing energy cost results.

Needed Fire Flow: The flow rate required at a junction to satisfy fire flow
demands.
Network Element: An element that forms part of the network model.
Annotation elements, such as polylines, borders, and text,
are not network elements.
Number: The number of parallel conveyance elements in a model.
Notes: The field that allows you to enter text relevant to the
model. It may include a description of an element, a
summary of your data sources, or any other information
of interest.

.out: File with complete scenario results.

ODBC: Open Database Connectivity (ODBC) is a standard
programming interface developed by Microsoft for
accessing data in relational and non-relational database
management systems (DBMS).

Bentley HAMMER V8i Edition User’s Guide 18-1185

Glossary

On/Off Status: The status of a pump can be either on or off. On means

that flow will occur in the downstream direction, and the
pump will add head to the system according to it’s
characteristic curve. Off means that no flow will occur,
and no head will be added.
Open/Closed Status: The status of a pipe can be either open or closed. Open
means that flow can occur in either direction. Closed
means that no flow will occur through the pipe.

.pv8: The previous version for files upgraded to new.

PBV: Pressure breaker valve.

Percent Full: The ratio of the current storage volume to the total
storage volume, multiplied by 100.
Pipe Status: Indicates whether the pipe is open or closed. As input,
this determines how the pipe begins the simulation. As
output, it shows the calculated status of the pipe at the
given time.
Polyline: A composite element that consists of a series of line
segments. Each line segment begins and ends at a vertex.
A vertex may be another element such as a junction, tank,
or pump.
Power: Represents the water horsepower of a pump. This is the
horsepower that is actually transferred from the pump
into the water. Depending on the pump’s efficiency, the
actual power consumed (brake horsepower) may vary.
Pressure: The field that displays the pressure for the current time
period.
Pressure Setting: The constraint to which a valve regulates, expressed in
units of pressure (Force per Length²). Depending on the
type of valve, it may refer to either the upstream or
downstream pressure or the pressure drop.
PRV: Pressure reducing valve.
PSV: Pressure sustaining valves.
Pump Status: A pump can have two different status conditions: On,
which is normal operation, or Off, which is no flow under
any condition.

18-1186 Bentley HAMMER V8i Edition User’s Guide

 Glossary

.rpc: The file with scenario messages.

RDBMS: An acronym that stands for Relational Database
Management System.
Relate: A temporary connection between table records using a
common item shared by both tables. Each record in one
table is connected to those records in the other table that
share the same value for the common item.
Relational Database: A database in which the data is structured in such a way
as to associate tables according to attributes that are
shared by the tables.
Relational Join: The process of merging two attribute tables using a
common item.
Relative Speed Factor: Defines the characteristics of a pump relative to the speed
for which the pump curve was entered, in accordance
with the affinity laws. A speed factor of 1.00 would
indicate pump characteristics identical to those of the
original pump curve.
Residual Pressure: The minimum residual pressure to occur at a junction
node. The program determines the amount of fire flow
available such that the residual pressure at a junction
node does not fall below this target pressure.
Reynolds Number: Ratio of viscous forces relative to inertial forces. A high
Reynold’s number indicates turbulent flow, while a low
number indicates laminar flow.
Roughness: A measure of a pipe’s resistance to flow. Pipes of
different ages, construction material, and workmanship
may have different roughness values.
Roughness Coefficient: A value used to represent the resistance of a conveyance
element to flow. In the Manning’s equation, this value is
inversely proportional to flow. The smaller the roughness
coefficient, the greater the flow.

Satisfies Fire Flow: A true or false statement indicating whether this junction
node meets the fire flow constraints. A check mark in the
box means the Fire Flow Constraints were satisfied for
that node. If there is no check mark, the Fire Flow
Constraints were NOT satisfied.

Bentley HAMMER V8i Edition User’s Guide 18-1187

Glossary

Schema: A diagrammatic representation; an outline or model.

Essentially, a schema represents the number of tables, the
columns they contain, the data types of the columns, and
any relationships between the tables.
Select: The process of adding one or more elements to an active
selection set.
Selection Set: The active group of selected elements. A selection set
allows editing or an action, such as move or delete, to be
performed on a group of elements.
Shape: The cross-sectional geometric form of a conveyance
element (i.e., circular, box, arch, etc.).
Shapefile: A file format that stores spatial and attribute data for the
spatial features within the dataset. A shapefile consists of
a main file, an index file, and a dBASE table. Shapefiles
were the standard file storage format for ArcView 3.x and
earlier.
Shutoff Point: The point at which a pump will have zero discharge.
Typically the maximum head point on a pump curve.
Size: Inside diameter of a pipe section for a circular pipe.
Spatial Reference: The spatial reference for a feature class describes its
coordinate system (for example, geographic, UTM, and
State Plane), its spatial domain, and its precision. The
spatial domain is best described as the allowable
coordinate range for x, y coordinates, m- (measure)
values, and z-values. The precision describes the number
of system units per one unit of measure. A spatial
reference with a precision of 1 will store integer values,
while a precision of 1000 will store three decimal places.
Stand-Alone/Modeler: The Bentley Systems software environment, and not the
AutoCAD one.
Starting Elevation: The value that is used as the beginning condition for an
extended period simulation.
Status Pane: The area at the bottom of the window used for displaying
status information.
Storage Node: Special type of node where a free water surface exists,
and the hydraulic head is the elevation of the water
surface above sea level.

18-1188 Bentley HAMMER V8i Edition User’s Guide

 Glossary

Table Links: A table link must be created for every database table or
spreadsheet worksheet that is to be linked to the current
model. Any number of Table Links may reference the
same database file.
TCV: Throttle control valve.
To Node: Represents a pipe’s ending node. Positive flow rates are
in the direction of from towards to. Negative flow rates
are in the opposite direction.
To Pipe: The pipe that connects to the downstream side of a valve
or pump.
Total Active Volume: The volume of water between minimum elevation and
maximum elevation of a tank. This is an input value for
variable area tanks.
Total Storage Volume: The holding capacity of a tank. It is the sum of the
maximum hydraulically active storage volume and the
hydraulically inactive storage volume.
Total Needed Fire Flow: If you choose to add the fire flow to the baseline demand,
the Total Needed Fire Flow is equal to the Needed Fire
Flow plus the baseline demand. If you choose not to add
the fire flow to the baseline demand, the Total Needed
Fire Flow is equal to the Needed Fire Flow.
Trace (Source Ident.): Determines what percentage of water at any given point
originated at a chosen tank, reservoir, or junction.
Trials: The maximum value for genetic algorithm trials is
determined by what you set for Stopping Criteria. Note
that you can set a number larger than (Maximum Era
Number)*(Era Generation Number)*(Population Size),
but calculations beyond that number (for this example,
the value is 45,000) are less likely to produce significant
improvements in optimization.

Valve Status: A valve can have several different status conditions:

Closed (no flow under any condition), Active (throttling,
opening, or closing dependent on system pressures and
flows), and Inactive (wide open, with no regulation).

Bentley HAMMER V8i Edition User’s Guide 18-1189

Glossary

Velocity: The field that displays the calculated value for a pipe,
valve, or pump velocity at a given time. It is found by
dividing the element’s flow rate by its cross-sectional
area.
Vertex: An element in a topological network.

.wtg: File that displays Bentley HAMMER information.

wtg.sqlite: To distinguish between the Bentley HAMMER modeling
data file and another programs data file. The most
important file because it contains all of the modeling
data.
Wall Reaction Coefficient: Defines the rate at which a substance reacts with the wall
of a pipe, and is expressed in units of length/time.
Bentley HAMMER V8i
Datastore: The relational database that Bentley HAMMER V8i uses
to store model data. Each Bentley HAMMER V8i project
uses two main files for data storage, the datastore (.sqlite)
and the Bentley HAMMER V8i specific data (.wtg).
Bentley HAMMER File Types:The following lists different types of files that can be
used with Bentley HAMMER.
.bak – backup of most files
GEMS Data Store – modeling data
Geodatabase – topology (in ArcGIS version)
.dwh, .dgn, .dwg – drawing information in stand-alone,
Microstation, AutoCAD
.mdk – backup of mdb
.out – complete results by scenario
.rpc – scenario messages
.nrg – energy cost results
.pv8 – previous version for files upgraded to new
.xml – used for libraries
WaterObjects: The object model used by Bentley HAMMER V8i, which
allows for the extension and customization of the core
software functions.

18-1190 Bentley HAMMER V8i Edition User’s Guide

 Glossary

Water Quality: The field that displays the water quality for the current
time period.
Water Quality Analysis: An analysis that can be one of three types: Age, Trace, or
Constituent.

.xml: File used for libraries.

Bentley HAMMER V8i Edition User’s Guide 18-1191

Glossary

18-1192 Bentley HAMMER V8i Edition User’s Guide

 Index

A Allocation strategies 470

alternative 565
about dialog box 11 Alternative Editor Dialog Box 582
accelerated redraw 157 Alternative Editor dialog box 582
accuracy 457 Alternative Manager 580, 586
acknowledgements 960 Alternatives 579
actions tab 709 alternatives 561, 579
active 716 base 583
Active Topology 716 child 583
active topology 586 creating 584
Active Topology Alternative 586 editing 584
active topology child alternative 589 hydrology 599
add a background layer 99 initial conditions 595
add a background layer folder 98 merge 579
add a FlexTable folder 788 overview 561, 579
add a help topic 9 analysis
add or remove a button 32 hydraulic 637, 639, 640, 912
Add To Selection Set dialog box 325 Analysis Menu 1082
Adding and Removing Toolbar Buttons 31 Analysis menu 1082
Adding Annotations 752 Analysis Toolbar 15
adding annotations 752 Analysis toolbar 15
adding color coding 759 analyzing improvement suggestions 573
Adding Color-Coding 759 Animating Profiles 782
adding elements 300 animating profiles 782
Adding Folders 752 Animation Controls 777
address Annotating Your Model 747
See contacting Bentley Systems. 1174 annotation properties 754
Addresses 1174 Annotation Properties dialog box 754
Advantages of Automated Scenario Manage- annotations 747, 748, 754
ment 561 adding 752
affinity laws 921 deleting 753
After One Branch Collapsing 522 editing 753
After Two Branch Collapsing 523 renaming 753
Age 1177 Application Window Layout 11
age Apply Demand and Pattern to Selection Dialog
alternative 602 Box 500
Age Alternatives 602 apply minor losses 548
air chamber 1049 applying a zone to a junction 194
air inflow 284 applying a zone to a pump 201
Air valve 251 applying a zone to a reservoir 200
Air Valve (Slow-Closing) between 2 Pipes 283 applying a zone to a tank 197
alarm 198 applying a zone to a valve 231
applying an HGL pattern to a reservoir 201

Bentley HAMMER V8i Edition User’s Guide Index-1193

B

Applying Elevation Data 455 Background Layer manager 96

applying minor losses to a valve 231 Background Layers 95
applying zone to hydrant 196 background layers 96
ArcCatalog 130 deleting 100
ArcCatalog Geodatabase Components 131 dxf files 105
ArcEdit 129 editing 100
ArcGIS 129, 130 image compression 103
integration 129 shapefiles 104
ArcGIS Applications 130 supported image types 96
ArcGIS applications 130 backing up your model 556
ArcGIS Integration 129 base alternative 579
ArcGIS Integration with WaterGEMS 130 Base alternatives 583
ArcInfo 129 base alternatives 583
ArcMap 131 Base and Child Scenarios 577
ArcMap client 131 base elevation 1178
ArcSDE 453 Base Elevation & Level 1177
ArcView 129 Base Scenarios 577
assigning demands to a junction 193 Batch Assign Isolation Valves dialog box 306
Attribute 565 batch pipe split 309
Attribute Inheritance 568 batch run 534
attributes Batch Run Editor Dialog Box 579
editing 312 Batch Split Pipe dialog box 308
scenario 565 BE Careers Network 1173
AutoCAD 106, 107, 119, 120 BE Magazine 1172
commands 117, 125 BE Newsletter 1173
drawing synchronization 123 Before Branch Collapsing 522
entities 116, 125 Bend command 305
integrating with SewerGEMS 120 Bentley discussion groups 1172
undo/redo 127 Bentley Institute 1171
AutoCAD Mode 106 Bentley Professional Services 1171
AutoCAD mode 106, 107, 119, 120 Bentley SELECT 10, 1171
graphical layout 109 Bentley services 1171
menus 121 Bentley Systems 1169
project files 122 addresses 1173
Autodesk 106, 119 contacting 1173
automated scenario management 561 email addresses 1174
automated skeletonization 516 program update 10
Automated Skeletonization Techniques 519 Web site 1174
Available Fire Flow 1177 Bentley Water 905
Average Day Conditions 570 Bernoulli equation 913, 972
Billing Meter aggregation 472
booster pump bypass 1053
B Border Editor dialog box 861
border properties for graphs 861
backflow preventer 672 Border tool 285
background layer 99, 100 border tool 284
background layer files Boundary Node 1177
using with ProjectWise 176 boundary node 1178
background layer folder 98, 99 boundary polygon feature classes 496

Index-1194 Bentley HAMMER V8i Edition User’s Guide

 C

Branch Collapsing 522 Tools tab 857

branch collapsing Chart Tools Gallery dialog box 868
See Skelebrator. 519 check data 666
Branch Trimming 519 check run 649
branch trimming 519, 522, 542 Check Valve 1178
browse topics 8 check valve 273, 923
buffering point area percentage 495, 496 check valves 923, 1053
build number 11 Chezy’s Equation 925
bulk reaction Chezy’s equation 925, 929, 1019
coefficient 1178 child alternative
Bulk Reaction Coefficient 1177 creating active topology 589
Child Scenarios 577
child scenarios 577
C Cholesky 919
clearing element selection 304
C coefficient 926, 1178 Client Server 1173
CAD 93 Closed/Inactive Status 1178
Calc. Min. System Pressure 1178 closed-form analytical solutions 651
Calc. Min. Zone Pressure 1178 coefficient 1187
Calc. Residual Pressure 1178 roughness 1187
calculation coefficients
unready 1178 engineer’s reference 930
Calculation Summary 890 Colebrook-White
calculation summary 890 equation 925
Calculation Summary Graph Series Options dia- typical values 931, 1066
log box 891 collapse a subtopic 8
Calculation Unready 1178 collapsing branch
calculator 213 See Skelebrator. 519
calibration 651, 663 collections
Calibration Nodes 460 minor loss 183
calibration nodes 460 color coding 757
C-Coefficient 1178 adding 759
celerity 985 deleting 760
Change Series Title dialog box 868 editing 760
change the position of a background layer 100 renaming 761
changing the drawing view 87 color coding legend 761
Changing Units, Format, and Precision in Color Coding Your Model 757
FlexTables 794 Color dialog box 863
characteristic curve Color Editor dialog box 863
pump 921 Color-Coding Properties dialog box 762
pumps 920, 921 column headings
characteristic time 989 editing for FlexTables 794
Chart Options 823 Combination Air Valve 282
Chart Options Dialog Box 823 commands (AutoCAD mode) 117, 125
Chart Options dialog box 823 Components Menu 1084
Chart Tab 824 Components menu 1084
Export tab 858 Composite Action 712
Print tab 860 Composite Condition 708
Series Tab 849 Composite Logical Action 710

Bentley HAMMER V8i Edition User’s Guide Index-1195

C

Compress Database command 1089 status 1178

compressing large database files 1089 valve 923
Compute Toolbar 17 Control Manager 697
Concentration (Base) 605 Control Sets tab 713
Concentration (Initial) 605 Control Status 1178
Conditions List 710 Controlling Toolbars 31
Conditions tab 702 controls 700
conditions tab 702 controls tab 698
conjugate gradient method 919 Conveyanc Element 1178
connection Coordinates 1178
synchronization 123, 124 copy FlexTable data 805
Connections manager 403 copy graph data 813
connectivity copying
explicit 427 FlexTables 805
implicit 427 Copying, Exporting, and Printing FlexTable
conservation Data 804
of mass & energy 915 Correct Data Format 429
conservation of energy 971, 974 correcting an error 572
Constant Area Approximation 259 create a FlexTable report 805
constant horsepower pump 922 create a new Alternative 584
constant horsepower pumps 1001 create a new FlexTable 791
constant power pump 922 create a new profile 777
Constituent 1178 create a new scenario 578
constituent 1178 create an active topology alternative 589
alternative 605 create Observed Data 821
Constituent Source Type 606 Create Selection Set dialog box 323
Constituents manager 609 creating
constructing a query 371, 798 graph 811
consumption node 650 Creating a New FlexTable 791
contacting Bentley Systems Creating a Project Inventory Report 808
email 1174 creating a query 370
fax 1174 Creating a Scenario Summary Report 808
hours 1174 Creating Alternatives 584
mail 1174 creating alternatives 584
technical support 1174 Creating an Active Topology Child Alternative
telephone 1174 589
Context Menu 1178 creating dynamic 323
context menu 1178 creating queries 371, 798
continuity equation 974 creating reports 807
continuity equation for unsteady flow 975 Creating Scenarios 577
contour 764, 765, 766 creating selection sets 323
smoothing 765, 767 cross section of a variable area tank 197
Contour Browser 763, 767 Cross Section Type 1179
contour labels 127 Crosshair 1179
Contour Manager 762 Current Storage Volume 1179
contour maps 457 curve
Contour Plot 767 pump 920, 921, 922
Contours 762 pumps 1000, 1001
control curved pipes 305

Index-1196 Bentley HAMMER V8i Edition User’s Guide

 D

custom AutoCAD entities 116, 125 DE Geodatabase 427

custom extended dead-end pipes 519
pump 923 decimal point 316
custom results path 5 default units 165
custom sort 799 default workspace 35
Customization Editor 389 defining pump settings 201
customize defining user data extensions 376
drawing 122 delete a background layer 100
customize a graph 881 delete a background layer folder 99
customizing delete a FlexTable folder 788
FlexTables 800 deleting
Customizing a Graph 881 FlexTables 792
customizing graphs 881 Deleting Annotations 753
Customizing Managers 35 deleting annotations 753
Customizing the Toolbars 31 Deleting Background Layers 100
customizing toolbars and buttons 31 deleting background layers 100
Customizing WaterGEMS Toolbars and Buttons deleting color coding 760
31 deleting elements 304
Customizing Your FlexTable 800 Deleting FlexTables 792
CV 1179 Deleting Folders 752
CV at Full Opening 284 deleting groups of elements in a selection set 325
Deleting Profiles 781
deleting profiles 781
D DEM 459, 463, 1179
Demand 1179
Darcy Weisbach demand
Colebrook-White equation 925 multipliers 695
equation 927 demand allocation 469
roughness values 931 Demand Alternatives 594
Darcy-Weisbach Demand Collection dialog box 194
equation 1018 Demand Control Center 497
roughness values 1066 demand deficit 951
Darcy-Weisbach equation 927, 942, 1017 demand projection 475
dashed line 307 Design Point 1179
data design point 216, 922
check 665, 666 Diameter 283, 284, 1179
organization 579 Diameter of Orifice/ Throat 283
validation 665 Digital Elevation Models 460
Data Format Needs Editing 429 digital elevation models (DEMs) 457
data logging 653 level one 459
Data Scrubbing 519 level three 459
data scrubbing 519, 521 level two 459
data source tables 429 type A 459
data types for user data extensions 382 type B 459
Database Connections 1179 type C 459
Database Utilities 1089 digital ortho-rectified photogrammetry 457
Dataset 1179 direct GGA solution 953
DBMS 1179 Discharge 1179
DDF 463 discharge 672

Bentley HAMMER V8i Edition User’s Guide Index-1197

E

discharge coefficient 230 editing annotations 753

discharge to atmosphere 274 editing attributes 1094
display a topic 9 editing color coding 760
display format 316 editing column headings
Display Precision 316 FlexTables 794
display precision 315 Editing Column-Heading Text 794
display topics 8 editing element attributes 312
displaying multiple projects 153 Editing FlexTables 793
Distributed Scenarios 562, 563 Editing Scenarios 578
DLG 1179 editing scenarios 578
docked dynamic manager 36 editing units
docked static manager 36 FlexTables 794
dominant pipe criteria 545, 547 efficiency
Double Acting 253 pumps 216
Double Click 1179 EGL 914, 973
Drag 1180 elastic theory 975, 982, 984
drag 1180 elasticity 985
drawing Element 1180
setup (AutoCAD mode) 122 element
synchronization (AutoCAD mode) 123 deleting 116
drawing scale 163 modify 116
drawing style 93 moving 117, 126
duplicate labels 332 element attributes 1094
duty point 216 Element Attributes Reference 1093
DWG 123 element label project files 168
DXF 463 element labeling settings 168
DXF Properties 105 element relabeling 801
DXF Properties dialog box 105, 323, 325 Element Symbology Manager 748
Dynamic Inheritance 567 using folders in 751
dynamic inheritance 567 Element Symbology manager 747
element symbols 93
elements 181
E adding in the middle of a pipe 304
adding to your model 300
edit a FlexTable 793 clearing selection of 304
edit a profile 780 deleting 301
edit a scenario 579 editing attributes 312
Edit Hyperlink dialog box 361 globally editing data in numerous elements
Edit Menu 1082 795
Edit menu 1082 moving 301
edit the properties of a background layer 100 overview 181
Edit Toolbar 14 reporting on 811
Edit toolbar 14 selecting 301
editable 617 selecting all 302
editing selecting all of the same type 302
FlexTables 793 selecting by polygon 302
numerous elements at once 795 validation 649
Editing Alternatives 584 viewing in selection sets 322
editing alternatives 584 Elevation 1180

Index-1198 Bentley HAMMER V8i Edition User’s Guide

 F

elevation 1178, 1184 momentum for unsteady flow 976

base 1178 transients 975
calibration nodes 460 unsteady state 975
determining pressure 455 valve closing pattern 1007
maximum 1184 equivalent pipe method 545, 547
obtaining data 457 error messages 423, 665
pumps 216 errors 666
value 456 ESRI ArcGIS Geodatabase functionality 425
Elevation Data 455 estimate 1181, 1184
elevation data 455 existing loads 523
elevation data source 463 existing projects 152
email 1174 exit WaterGEMS 6
email address 1174 expand a subtopic 7
energy explicit connectivity 427
conservation 915 explode elements (AutoCAD mode) 125
equation 914 export 905
grade line 914, 1180 export FlexTable data 805
principle 912 exporting
Energy Cost Alternative 619 FlexTables 805
energy cost alternative 619, 622 exporting a DXF file 907
energy equation 913 exporting FlexTables 804
energy grade 973 Extended Edit Button 1180
Energy Grade Line (EGL) 1180 extended edit button 1181
Engine Compatibility 687 Extended Period Analysis 696
engineer’s reference 1064 External Files 1180
engineering libraries 352, 354 external files 1181
overview 351 External Tool Manager 719
sharing on a network 354 Extrapolate 1180
working with 352 extrapolate 1181
engineering libraries dialog box 354
Enhanced Pressure Contours 768
enhanced pressure contours 768 F
entering data 312
entities fax 1174
in AutoCAD 116, 125 FCV 237
enumerated user data extensions 385 Feature Class 1180
Enumeration Editor dialog box 385 Feature Dataset 1181
EPS 1180 field
analysis 639, 640 links 1181
equally distributed 523, 547 Field Links 1181
equations field measurements 653
Bernoulli 972 File Extension 1181
continuity 974 File Menu 1079
continuity for unsteady flow 975 File menu 1079
Darcy-Weisbach 1017 File Upgrade Wizard 908
Hazen-Williams 1017 filter
Levenberg-Marquardt method 1001 resetting 798
Manning’s 1019 filter a FlexTable 797
method of characteristics 977 Filter dialog box 618

Bentley HAMMER V8i Edition User’s Guide Index-1199

G

filtering a FlexTable 797 flow control valve 923

finalizing the project 573 flow control valves 924
Find 313 flow decreasing characteristics 1009
Find Logical Action dialog box 710 flow distribution 473
finding elements 313 flow emitters 650, 672, 727
fire flow Flow Tolerance 683
alternative 613, 614, 617 folders
Fire Flow System Data 617 in Element Symbology Manager 751
Fire Flow Upper Limit 1181 in FlexTables Manager 788
fire flow upper limit 1184 format
fire hydrants 724 unit 315
fire hydrants as flow emitters 727 Format Graph Shortcut Viewer 738
first law of thermodynamics 971 formulas 930
fitting loss coefficients 929, 934, 1069, 1070 Francis 242
Fixed Point 316 Free Form 755
FlexTable Dialog Box 789 friction 1022
FlexTable dialog box 789 friction and minor loss methods 925
FlexTable Setup Dialog Box 802 friction loss 1016
FlexTable Setup dialog box 802 From Node 1181
FlexTables 783 from node 1184
copying 804 From Pipe 1181
copying data 805 from pipe 1184
creating 791
customizing 800
deleting 792 G
editing 793
editing column headings 794 GA 1181
editing globally 795 Gas Law Model 259
editing units 794 gas vessel 1049
exporting 804 Gaussian elimination method 920
exporting data 805 GEMS Datastore 1181
filtering 797 General 316
global editing 795 general purpose valves 924
navigating in 794 general settings 156
opening 791 Generations 1182
ordering columns 796 genetic algorithms 955, 957
printing 804, 805 Geodatabase 1182
renaming 792 Geodatabase feature 425
reports 805 geodatabase support 425
saving as text 805 Geometric data source 400
shortcut keys 794 Geometric Networks 426
sorting column order 796 Getting Started in Bentley WaterGEMS 1
FlexTables Manager 784 Getting Started with the ArcMap Client 131
folders in 788 GIS
FlexTables manager 784 demand allocation 469
floating manager 35 GIS Basics 128
Flow 1181 GIS style 93
flow 1184 GIS-ID 430, 431
flow arrows 106, 136 global edit 796

Index-1200 Bentley HAMMER V8i Edition User’s Guide

 H

global edit FlexTable column 795 Hazen-Williams Formula 926

global editing head 672
FlexTables 795 head loss 237
global settings 155 Headloss 1182
Global tab 156 headloss 1184
globally editing data 795 headloss curves for GPVs 232
Google Earth 140 Headloss Gradient 1182
GPV 237 headloss gradient 1184
grade line Helmholtz 986
energy 914 Help 20
hydraulic 914 help files and books 1170
gradient algorithm 916 Help Menu 1090
derivation 916 Help menu 1090
Gradient Editor dialog box 862 Help Toolbar 20
graph HGL 914, 973, 1184
copying and pasting data 817 HGL setting 1184
data 817 high alarm 198
new 811 high-speed sensors 653
Graph Dialog Box 813 history of what-if analyses 562
Graph dialog box 814 hydrants 196, 724
Graph Manager 811 hydrants as flow emitters 727
Graph Series Options dialog box 819 hydraulic equivalency 524
graphical layout Hydraulic Equivalency Theory 939
AutoCAD 109 Hydraulic Grade 1182
graphing 811 hydraulic grade 973, 1184
changing total time period 812 hydraulic grade line 915
Graphs 811 Hydraulic Grade Setting 1182
graphs 811 hydraulic grade setting 1184
customizing 881 hydraulic transient
printing 813 See also transient.
grid 463 hydraulic transients
groundwater well 721 overview 961
hydraulically close tanks 724
hydrology alternatives 599
H hydropneumatic tank 259
Hydropower Plants 244
Haestad Methods hyperlinks 358
program update 10
Haestad.log 1174
HAMMER I
capabilities 959
HAMMER elements 299 image compression 103
HAMMER v7 656 Image Filter 102
Hatch Brush Editor dialog box 864 Image Properties Dialog Box 102
Hazen-Williams Image Properties dialog box 102
typical values 932 i-models 391
Hazen-Williams equation 926, 940, 1017 impeller 921
coefficients 933, 1068 implicit connectivity 427
roughness values 932, 1067 import 433, 438, 442, 904

Bentley HAMMER V8i Edition User’s Guide Index-1201

J

import Bentley Water Model 905 junctions 193

import database 903
Import dialog box 386
importing and exporting Epanet files 904 K
importing/exporting skelebrator settings 558
impulse turbine 241 K coefficients 934, 1069, 1070
In 913 Kaplan 242
inactive 716 KnowledgeBase 10
Inactive elements 716
Inactive Volume 1182
inactive volume 1184 L
individual elements
adding to your model 300 Label 1183
inertia 217, 1052 label 1184
pumps 217 labeling elements 315
inflow 1184 LandXML 463
Inflow & Outflow 1182 lateral loss 196
Inflow Diameter 283 laws
Inheritance 566, 1183 affinity 921
inheritance 566, 568, 1184 conservation of mass and energy 915
dynamic 567 layout
overriding 567 AutoCAD 109, 110
Initial Air Volume 282 layout settings 158
initial conditions alternative 595 layout tool 300
initial conditions of networks 812 Layout Toolbar 21
initial flow equals zero 812 Layout toolbar 21
Initial Settings 1183 legend 761
initial settings 1184 Length 1183
alternative 595 length 1184
Initial Water Quality 1183 length approximation 663
initial water quality 1184 level 1178
inline isolation valve replacement 526 Levenberg-Marquardt method 923, 1001
installation 4 library types 352
instant load rejection 246 license 3
integrating AutoCAD with SewerGEMS 120 LIDAR 458, 1183
integration 130 light 1184
intermediate node removal 520 messages 1184
Interpolate 1183 Line tool 286
interpolate 1184 line tool 284
Invert 1183 linear system equation solver 919
invert 1184 linear theory method 916
Is Constituent Source? 606 load acceptance 246
Is offset to the left of referenced link? 230 load distribution strategy 542, 547
isolation valve 307 Load rejection 244
LoadBuilder 476
manager 476
J run summary 489
wizard 477
junction conditions and tolerances 555 Local and Inherited Values 568

Index-1202 Bentley HAMMER V8i Edition User’s Guide

 M

local and inherited values 568 merging pipes of the same diameter 548
logical control 701 messages 1184
dialog box 699 light 1184
manager 697 meter aggregation 472
set editor 714 meter assignment 470
logical control: method of characteristic (MOC) 977
See operational controls alternative. methods for solving transient flow 963
Logical controls 700 Microstation Mode 106
logical controls minimum
overview 696 system junction 1184
loop retaining sensitivity 551 system pressure 1178
loop-based algorithms 916 zone pressure 1178
loss 1016 minor loss 237
losses 1025 Minor Loss Coefficients dialog box 186
friction 918, 927 minor loss collection 183
minor 920, 925, 929, 930, 1026 Minor Loss Collection dialog box 184
low alarm 198 minor loss strategy 545
minor losses 920, 925, 929, 944, 1016, 1025
fitting 934, 1069, 1070
M mixed flow turbine 242
model and optimize distribution system 637
mail 1174 Model Spot Elevation 463
maintenance procedures 1062 ModelBuilder 433, 438, 442
Management controls 694 errors and warnings 423
Manning’s Coefficient 1183 supported formats 399
Manning’s coefficient 1184 using 399
Manning’s equation 928, 941, 1019 ModelBuilder Connections manager 403
roughness values 930, 1065 ModelBuilder wizard 407
typical values 933, 1068 modeler definition 1185
Manual Scenarios 564 modeling fire hydrants as flow emitters 727
manual skeletonization 528, 539 modeling pressure dependent demand 948
mass conservation 915 modeling tips 721, 729
Mass Rate (Base) 605 modeling variable speed pumps 729
material 1184 modified GGA solution 953
Max Adjustment 663 moment of inertia 248
maximum momentum equation 976
extended operating point 1184 motor
number of removal levels 545 pump 937
number of trimming levels 542 motor and pump inertia 213
operating point 1184 move
Maximum Day Conditions 571 elements 117, 126
measurements 653 labels 117, 126
menu move a toolbar 32
context 1178 moving elements 304
Menus 1079 moving toolbars 32
merge multiple 673, 732
merge pump curve 922, 923, 1001
alternatives 579 multiple elements
merging pipes by 548 selecting 302

Bentley HAMMER V8i Edition User’s Guide Index-1203

N

multiple point pump 923 opening managers 35

multiple projects operating point 997
maximum number of 152 operation 796
Multipliers 695 operation classification 989
Municipal License Administrator 3 operation procedures 1062
operation time 989
Operational Alternative 696
N operational alternative 599
operational controls alternative 599
naive method 946 options 155
named views 317 calculation 674
Naming and Renaming FlexTables 792 Options Dialog Box
navigating in a FlexTables 794 ProjectWise settings 169
Navigating in Tables 794 Options dialog box 156, 161
network connectivity 427 Oracle 452, 453
network hydraulics theory 911 ordering
Network Navigator 326 FlexTable columns 796
network navigator 309 organize data 579
network review 309 orifice at branch end 651
network topologies 992 orifice demand 650
network topology 649 orphaning of pipes 521
network walking algorithm 528 outflow 1184
New Logical Action dialog box 710 Outflow Diameter 283
nodal demand vector 917 output
node 1178, 1184 tables 783
boundary 1178 output data 681
from 1184 Overriding Inheritance 567
nodes overriding inheritance 567
consumption 650 overview
Number 316 transients 961
number
Reynolds 1187
numerical calibration 651 P
numerical check 945
Numerical Value of Elevation 456 Pan tool 87
panning 87
using a mousewheel to 88
O parallel 673, 732
Parallel Pipe Merging 525
Observed Data 820 parallel pipes 722
Obtaining Elevation Data 457 modeling 722
Obtaining elevation data 457 removal 525, 544
open a manager 35 parallel pumps 723
open FlexTables 791 Parameters for SAV
open Help 6 283
open the registration dialog box 11 Parameters for SRV 283
Open Time 284 parent scenario 577
Opening FlexTables 791 pattern 691, 692
Opening Managers 35 demand multipliers 692

Index-1204 Bentley HAMMER V8i Edition User’s Guide

 P

extended period analysis 640, 696 upgrades and updates 4

pattern editor 692 version number 11
time steps 692 positive displacement pump 214
Pattern (Constituent) 606 predefined queries 366
Pattern Manager 693 Presenting Your Results 735
patterns 442 preserve network integrity 551
PBV 237 pressure
Peak Hour Conditions 572 head 913, 914, 973
Pelton 241 pressure breaker valve 923
performing calculations of transient flow and pressure breaker valves 924
head 994 pressure dependent demand 950
Periodic Head-Flow 250 Pressure Dependent Demands 507
physical alternative 590, 591 pressure engine 299
physical properties 590 pressure pipes
Pipe 1094 adding a minor loss collection to 183
pipe 1184 typical values 933
diameter 548 pressure reducing valves 924
from 1184 pressure sustaining valve 923
length 1184 pressure sustaining valves 924
material 1184 Pressure Threshold 512
merging 520 pressure vessel 259
merging same diameters 548 pressure wave 989
parallel 722 pressure zone export 343
Pipe Attributes 1094 Pressure Zone Manager 333
pipe conditions and tolerances 554 pressurized systems 961
pipe elasticity 985 principles 940
pipe elasticity and celerity 987 Print Preparation 898
pipe inventory 808 Print Preview 894
pipe material 182 print preview
pipe materials 987 FlexTables 805
pipes 182 Print Preview Window 894
modeling with curves 305 printing
splitting 304 FlexTables 805
piping design 1039 Printing a Graph 813
piping layout 1039 printing FlexTables 804
plane sweep 947 printing graphs 813
PLC 221 proejct queries 366
point profile
design/duty 216 editing 780
point demand assignment 475 profile setup 770
Pointer dialog box 867 Profile Viewer 775
Poisson’s ratio 987 Profile Viewer dialog box 781
polygons profiles 768
used to select elements 302 animating 782
Polyline Vertices dialog box 306 creating 777
PondPack deleting 781
build number 11 renaming 781
installation 4 viewing 781
upgrade 10 Profiles manager 768

Bentley HAMMER V8i Edition User’s Guide Index-1205

Q

Profiles Series Options dialog box 774 Pump Curve dialog box 211, 212
Program Maintenance Dialog Box 10 pump curves 438
programmable logic controller 221 pump definitions 433
project pump patterns 700
files 111, 122, 123 pump settings 201
project inventory 808 pump station 226
Project Properties dialog box 154 pump types 211, 212
Project tab 161 pumping systems 992
projection 475 pumps 201, 673, 732
projects 152 920
ProjectWise 170 behavior 996
closing projects 171 bypass 1053
general guidelines for using 171 characteristics 996
using background layer files with 176 constant horsepower 1001
viewing status 173 constant speed, no pump curve 215
ProjectWise options 169 constant speed, pump curve 216
properties defining settings for 201
editing 312 efficiency 216
Property Editor 312, 1094 elevation 216
using Find Element 313 fundamentals 215
Property Grid Customizations 388 inertia 217
proportional to coalesced pipe attributes 523 operating point 997
proportional to dominant criteria 547 protection 1052
proportional to existing load 548 pump start - variable speed/torque 216
protected elements manager 536 quadrants 220
protection devices 1040 shut down after time delay 215
protection equipment 970 specific speed 217, 218, 999
Protective Equipment Reference 282 speed 216
prototypes 345 theory 995
pump 723 variable speed 1000
affinity laws 920 variable speed (VSP) 221
constant horsepower 922 variable speed/torque 216
curve 920, 921, 923
custom extended 923
groundwater well 721 Q
impeller 921
motor 937 quadrant representations 220
multiple point 923 QuadrantCurves.txt 287
operating point 920, 921, 922 QuadrantCurvesPredefined.txt 287
parallel 723 Quasi-steady Friction 686
series 723 queries 366, 371, 798
static head 921 creating 370
static lift 920 in FlexTables 797
theory 920 predefined 366
three point 922, 937 project 366
type 922 shared 366
variable speed 921 Queries Manager 366
pump characteristics 286 Query Builder dialog box 372
Pump Curve Definitions dialog box 202 Query Parameters 369

Index-1206 Bentley HAMMER V8i Edition User’s Guide

 R

R Results Table 894

Reynolds number 1187
ranking rigid column theory 975, 980, 982
FlexTable columns 796 roughness
Rasters 463 Chezy’s equation 925
reaction turbine 242 coefficient 930, 1065
read-only 617 Colebrook-White equation 925
reconnect 305 Darcy-Weisbach equation 927
Record Types 459 Hazen-Williams equation 926
redo 126, 127 Manning’s equation 928
reference roughness height 926, 928, 931, 1066
engineer’s 930 roughness values 930
Reference Pressure 512 Colebrook-White 931, 1066
References 954 Darcy-Weisbach 931, 1066
references 1072 Hazen-Williams 932, 1067
relabeling elements 315 Manning’s 930, 1065
relative closure 237 typical 933, 1068
Relative Closure (Initial Transient) 237 rounding of numbers 316
relative speed factor 1187 rule based 697
remove orphaned nodes 551 runout 216
removing elements from selection sets 325 rupture disk 274
rename a background layer 100
rename a background layer folder 99 S
rename a FlexTable folder 788
rename FlexTables 792
SAV 272, 284
renaming
SAV Closure Trigger 272
FlexTables 792
SAV/SRV at End of 1 Pipe 283
renaming annotations 753
SAV/SRV between 2 Pipes 284
Renaming Folders 752
save
Report Menu 1090
as drawing *.DWG 124
Report menu 1090
saving FlexTables as text 805
report options 808
SCADA 653
Reporting 807
Scenario 565
reporting
Scenario Attributes and Alternatives 565
on a group of elements in a selection set 325
scenario example 570
Reporting Time Step 681
Scenario Inheritance 569
reports 807
Scenario Management
creating for elements 811
Example 570
FlexTables 805
Scenario Manager 575
scenario 808
scenario summary 808
standard 808
Scenarios 574
re-register 130
scenarios 561
reserviors 200
advantages of using 561
reset
attribute inheritance 568
FlexTable filter 798
attributes 565
reset a filter 798
base 577
Reset Workspace 35
creating new 578
residual pressure 1187
editing 578

Bentley HAMMER V8i Edition User’s Guide Index-1207

S

inheritance 566 FlexTables 794

local and inherited values in 568 Show Flow Arrows 106, 136
overview 561, 564, 574 SHP 463
Scenarios Toolbar 16 shutoff 216
Scenarios toolbar 16 SI 316
schema definition 1188 Simple Logical Action 710
Scientific 316 simultaneous path adjustment method 916
scrubbing Skelebrator 521
See Skelebrator. 519 batch run 534
SDTS 458, 463 branch trimming 522, 542
search for text 9 conditions and tolerances 553
second law of motion 980 data scrubbing 521
select boundary polygon feature class 495 parallel pipes removal 525, 544
select the point 495 protected elements manager 536
selecting all elements 302 series pipe removal 523, 546
selecting an element 302 skeletonization manager 530
selecting elements skeletonization preview 527
all of the same type 302 troubleshooting 557
by polygon 302 using 529
selecting multiple elements 302 what it does 528
Selection Set Element Removal dialog box 325 Skelebrator features 527
selection sets 319, 320, 323, 325 Skelebrator Progress Summary dialog box 556
adding a group of elements to 325 Skelebrator-specific selection sets 536
adding elements to 324 skeletonization 516
creating 323 branch trimming 519
creating from queries 323 data scrubbing 519
group-level operations 325 example 517
in FlexTables 790, 791 manager 530
removing elements from 325 network walking algorithm 528
viewing elements in 322 series pipe removal 520
Selection Sets Manager 320 Skelebrator 521
Selection tool 22 techniques 519
Self-Contained Scenarios 563 See also Skelebrator.
Self-Contained scenarios 563 skeletonization and active topology 559
Series Pipe Merging 523 skeletonization and scenarios 557
series pipe merging Skeletonization Using Skelebrator, Skelebrator,
See Skelebrator. 521 Using Skelebrator 521
Series Pipe Removal 520 Slow Closing 252
series pipe removal 520, 523, 546 Small Outflow Diameter 283
series pumps 723 Smart Pipe Removal 521, 551
Set Field Options dialog box 315 smoothing contours 765
setting options 155 snap menu (AutoCAD mode) 118, 126
setup 122 Software 1170
Shapefile Properties 104 software
Shapefile Properties dialog box 104 upgrades 10
Shared Field Specification dialog box 384 Software Updates via the Web and Bentley SE-
shared queries 366 LECT 10
sharing engineering libraries on a network 354 solution methodology 952
shortcut keys solutions to modeling problems 721

Index-1208 Bentley HAMMER V8i Edition User’s Guide

 T

sort columns in FlexTable 796 hours 1174

sort contents of FlexTable 796 surge control 1037
sorting surge control strategy 1037
FlexTable columns 796 surge protection 1042
Sorting and Filtering FlexTable Data 796 surge relief valves 1055
sparse matrix 916, 919, 920 surge tank 277, 1046, 1049
spatial data 427 surge-anticipator valve 272
spatial reference 463 Swamee and Jain equation 928
Spatial Reference System 178 SWG file 123
specific speed 249 symbol
equation 218, 999 visibility (AutoCAD mode) 122
pumps 217, 218, 999 synchronize (AutoCAD mode) 123
speed 673, 732 system operating point 920
pumps 216
split 304
splitting pipes 304 T
spot elevations 239
Spring Constant 283 Table
SRS 178 Properties 802
stand-alone definition 1188 Type 802
Stand-Alone Editor 87 table
standard extended pump 923 setup 802
standard reports 808 tables
Standard toolbar 12 column headings 794
start WaterGEMS 4 editing FlexTables 793
Starting Bentley WaterGEMS 3 units 794
starting Bentley WaterGEMS 3 tabular report 783
starting projects 152 tank
static head hydraulically close 724
pump 921 tanks 196
static lift TCV 237
pump 920 technical support 1172, 1174
station 673, 732 TeeChart Gallery dialog box 880
statistics 806 text 117, 126
statuses Text tool 285
initial settings 1184 text tool 284
Steady Friction 686 the energy principle 912
steady state flow 972 The Importance of Accurate Elevation Data 455
steady-state analyses 639 The Scenario Cycle 564
Stieltjes 919 The WaterGEMS ArcMap Client 131
storage volume 1184 theme folders
active 1189 renaming 752
inactive 1184 theme groups
Stored Prompt Responses dialog box 160 deleting 752
subdivide 663 theory 935
submodel 904, 905 network hydraulics 912
supply level evaluation 950 valve 924
support 1174 Thiessen polygon generation 491
addresses 1174 Thiessen Polygon Generation Theory 946

Bentley HAMMER V8i Edition User’s Guide Index-1209

U

three point pump 922, 937 Triple Acting 253

Threshold Pressure 283, 284 Troubleshooting 10
Threshold Pressure (SAV) 272 troubleshooting 666
throttle control valve 923 knowledge database 10
throttle control valves 924 turbine 248
Time (For Valve to Close) 655 inertia 248
Time for SAV to Close 272 turbine characteristics 286
Time for SAV to Open 272 turbine element reference 248
time of simulation 812 turn toolbars off 32
Time SAV Stays Fully Open 272 turn toolbars on 32
Time Series Field Data 886 turning toolbars off 32
time step 662, 682 turning toolbars on 31
selection 649 Type of SAV 284
Time to Close 284 Type of Valve(s) 283
Time to Open 284 types of networks 992
TIN 463 types of pumping systems 992
toolbars 11 types of valve 1005
Tools Menu 1087
Tools menu 1087
Tools Toolbar 25 U
Tools toolbar 25
Tooltip customization 390 U.S. customary 316
top feed/bottom gravity discharge tank 726 Understanding Scenarios and Alternatives 561
topology 665, 666, 916 Unit 316
total active volume 1189 Unit Demand Collection dialog box 194
trace Unit Demand Control Center 505
alternative 610 Unit Line Flow Method 489
trace alternative 610 unit of measurement 316
transient flow equations 975 units 165
transient friction 1022 editing for FlexTables 794
Transient Friction Method 686 units and formatting 315
transient pressure pulses 653 unregister 130
Transient Results Viewer 735, 741 Unsteady Friction 686
Transient Run Duration 684 unsteady friction 1022
transients unsteady state
causes 964 equations 975
effects 967 updates 4
initiation 965 updating PondPack via the Web 10
overview 961 upgrade
theory 970 PondPack 10
transition pressure 253 upgrades 4
Transitional Volume 283 upstream node demand proportion 548
transmission pipelines 990 use 50/50 split 545
TRex Terrain Extractor 460 use cases 949
TRex terrain extractor 460 use equivalent pipes 545, 547
TRex Wizard 462 use ignore minor losses 545
TRex wizard 462 use skip pipe if minor loss > max 545
trimming use the Graph Manager 811
See Skelebrator. 519 use the index 8

Index-1210 Bentley HAMMER V8i Edition User’s Guide

 V

User Data Extensions 630 Vapor Pressure 685

user data extensions 376 vapor pressure
data types 382 adjustment 646
enumerated 385 Variable 673, 732
User Data Extensions dialog box 379 variable elevation curve 271
User Notification Details dialog box 670 variable frequency drive 729, 935
User Notifications 666 variable speed pump 935
user notifications 666, 669 curve equations 921
User Notifications Manager 666, 669 theory 935
user-defined ratio 523, 548 Variable Speed Pump Battery 225
USGS 463 variable speed pump theory 935
USGS DEM 459 variable speed pumps 221, 921, 1000
USGS topological maps 457 vector 463
Using ArcCatalog with a WaterGEMS Database velocity
131 head 915
Using Folders in the Element Symbology Man- version number 11
ager 751 VFD 729, 935
Using Profiles 768 view
using Skelebrator 529 tabular 783
Using Standard Reports 808 View Menu 1085
using with SewerGEMS 170 View menu 1085
View Toolbar 19
Viewing and Editing Data in FlexTables 783
V viewing elements in a selection set 322
Viewing Profiles 781
vacuum 645 viewing profiles 781
Vacuum Breaker 254 visibility of symbols 122
validation 649, 651, 665, 666 Vitkovsky 1023
valve 237, 1178 VLA 237
check 1178 volume 1184
theory 923 inactive 1184
valve characteristic 235 total active 1189
valve characteristics 234 VSP 221, 673, 730, 731, 732, 936, 937, 938,
valve closing pattern 1007 939
valve discharge coefficient 656 VSPs 673, 732
valve patterns 700
valve types 229
valve with linear area change 277 W
valves 1003
bodies 1005 warning messages 423
closing characteristics 1006 warnings 666
pistons 1005 water column separation 645
selection 1003 water main 724
sizing 1003 WaterCAD
surge relief 1055 custom AutoCAD entities 116, 125
theory 1002 WaterCAD in AutoCAD 106, 119
types 1005 WaterCAD Managers 35
vapor 645 WaterGEMS Toolbar 132
vapor pockets 645 WaterObjects 37

Bentley HAMMER V8i Edition User’s Guide Index-1211

Y

wave propagation 989 Zoom Toolbar 28

wave reflection 990 Zoom Window 89
wave speed 188 zooming 87
adjustments 646
Wave Speed Reduction 647
wavespeed 663
WCD file 111
Web updates 10
Website 1174
Welcome dialog 151
Welcome dialog box 151
well 721
groundwater 721
well groundwater 722
What-If 562
white 617
table columns 793
window color settings 157
Working in ArcGIS 128
Working with FlexTable Folders 788
Working with Graph Data
Viewing and Copying 813
Working with WTG Files 4
World Wide Web
See Web. 10

yellow 617
table cells 793
Young’s modulus 987

zero flow at time 0 812

zones 182
Zones manager 349
Zoom 90
Zoom Center dialog box 89
Zoom Dependent Visibility 91
Zoom Extents 88
Zoom Factor 90
Zoom In 89
Zoom Out 89
Zoom Previous
Zoom Next 90
Zoom Realtime 89

Index-1212 Bentley HAMMER V8i Edition User’s Guide

 Z

Bentley HAMMER V8i Edition User’s Guide Index-1213

Z

Index-1214 Bentley HAMMER V8i Edition User’s Guide