You are on page 1of 616

GASWorkS 9.

User's Manual

Bradley B Bean PE
419 East Columbia Street
Colorado Springs, Colorado 80907 USA
Toll Free: 1-800-391-9391 ! Telephone: (719) 578-9391 ! Fax: (719) 578-9394

2015 Bradley B Bean PE - All rights reserved.


GASWorkS and the "B-Cubed" logo are trademarks of Bradley B Bean PE.
Windows is a trademark of Microsoft Corporation.

This document is formatted for double-sided printing.

GASWorkS 9.0
Table Of Contents

License Agreement
GASWorkS, its options, and supplements are licensed for installation on only one computer per authorized
copy. That is, only one copy of the program is intended to be installed per license. Each purchased copy of
the program represents one license. We are relying on your honesty and integrity to ensure that multiply
copies of the program are not created.
In reference to this paragraph, the following definitions shall apply: Software shall mean the GASWorkS
program, documentation, and any associated options, enhancements, or supplements; User shall mean the
individual or organization purchasing the Software, the individual or organization employing the persons to
be using the Software, the individual or organization otherwise responsible for the administration of the use
of the Software, or any affiliate thereof; Developer shall mean Bradley B Bean PE. By use of the Software,
the User consents to accept full responsibility for the use of the Software including: Interpretations or
decisions based on any results derived from the Software; Any claims resulting from the use, accidental
misuse, or intentional misuse of the Software by the User; And for reimbursement of the original purchase
price to the Developer for each unauthorized copy of the Software generated from the User's authorized copy.
Depending on the specific version received by the User, the Software will use a certain copy protection
method. The method may require registration of the Software with the Developer, installation of a physical
security device on the Users equipment, or another method of protection. By installing the Software the User
consents to the means of copy protection.

It is the User's obligation to immediately return the Software, without installing it, if
they do not concur and consent to these Licensing requirements.

Trademark Notice
GASWorkS, GASBase, and the "B-Cubed" logo are trademarks of Bradley B Bean PE. dBASE is a
trademark of ASHTON TATE a division of Borland International. AutoCAD is a trademark of Autodesk,
Inc. Arc/Info is a trademark of Environmental Resource Systems Inc. Windows (and it variations and
derivations) are trademarks of Microsoft Corporation. MicroStation is a trademark of Bentley System Inc.

Copyright Warning
The GASWorkS software and User's Manual are protected under United States and international copyright
laws and treaties. Making unauthorized copies of either the software or the associated documentation is a
violation of United States and international law. Don't be a criminal, don't copy.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0
Table Of Contents

Guarantee
If you are not fully satisfied with the performance of GASWorkS, uninstall the software, return the original
distribution materials, security device (if provided), and documentation within thirty (30) days of the date
of receipt. We will promptly refund the original purchase price.
If during the useful lifetime of the software, GASWorkS or its options do not perform as claimed, notify us
of the deficiency and we will promptly address your concern and do our best to correct the problem.

Application Limit
The number of Users that can simultaneously run the GASWorkS software is dependent on the license style
purchased. This number is referred to as the Application Limit. A Single-User License allows only one User
at a time. A Limited Network License allows a fixed number of Users, which is dependent upon the purchase
agreement. Licenses with an unlimited number of Users are also available.
When GASWorkS is executed, it checks the number of Users currently using the software. If the Application
Limit is not exceeded, the software will be started. If the Application Limit is exceeded, a warning message
will appear.
If GASWorkS is abnormally terminated, the User count may become corrupt and GASWorkS may
erroneously report the number of current Users. If this occurs, use the following procedure to prevent future
display of the warning message.
! Select the Windows Start button. The program menu list will be displayed.
! Select the Run item from the program list.
On 32-bit machines, at the Open prompt type:
\Program Files\GASWorkS 9\app\GW90.exe /-1
On 64-bit machines, at the Open prompt type:
\Program Files (x86)\GASWorkS 9\app\GW90.exe /-1
If GASWorkS was installed in a non-standard location, at the Open prompt type:
\Installed Location\GASWorkS 9\app\GW90.exe /-1 replacing Installed
Location with the appropriate directory name.
Note...

Include the quotation marks. There are spaces between Program and Files, between Files and
(x86), between GASWorkS and 9, and between the closing quote () and the forward slash (/).

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

ii

GASWorkS 9.0
Table Of Contents

Software Updates
From time to time the GASWorkS software is revised and updated to correct reported or discovered bugs,
to add User requested enhancements, and to perform other required maintenance. These updates are available
for download and installation from our website www.b3pe.com. Notification of updates is not generally made
to the User community, the User should occasionally check for new updates from this site.
Additional support, documents, new and updated Property Tables, program updates, and frequently asked
questions and answers can also be found on our website.

About This Manual


This Manual attempts to provide the User with an understanding of the GASWorkS software by providing
extensive descriptions and documentation of its various features. The main body of the Manual presents
descriptions of the various menu items and data screens. Separate sections are provided for several of the
more extensive features. The Appendix section of this Manual presents a primer on network analysis, along
with technical documentation of the various equations and data files used and supported by GASWorkS.
The use of italics is used extensively throughout the Manual. Italicized words are used in two manners - one
to emphasize a word, the other to indicate the name of a menu item, menu list, command button, data item,
or keyboard key.
In addition to the information contained in this Manual, examples, how-to tips and instructions are included
in the GASWorkS Help Guide.
A copy of this Manual in Portable Document Format (pdf) is contained on the GASWorkS installation CD.
With some versions of GASWorkS, the Demonstration Guide, Users Manual, and Help Guide are installed
and viewable using the Help menu. Additional information and documentation may be found on our website
www.b3pe.com.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

iii

GASWorkS 9.0
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

iv

GASWorkS 9.0

Table Of Contents

License Agreement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Trademark Notice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Copyright Warning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Guarantee. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii
Application Limit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii
Software Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
About This Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
GETTING STARTED. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installing GASWorkS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Software Copy Protection.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Starting GASWorkS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using GASWorkS.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Uninstalling GASWorkS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Release Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1
3
3
5
6
7
7
8

GENERAL INFORMATION. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Hardware/Software Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GASWorkS Data Elements.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using The Menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Negotiating The Screens. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Executing Commands & Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Accessing Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Notes On Dimensional Units. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Notes For International Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using The Help System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Getting Help - Contact Us.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17
19
19
20
20
21
22
23
23
24
25

MENU ITEMS.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File - File Management.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
New - Create A New Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
New Project - Create A New Model.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Open - Open An Existing Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Close - Close A Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Save - Save Model Changes.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Save As - Save Model Changes To Another Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rename - Change The Name Of The Current Model. . . . . . . . . . . . . . . . . . . . . . . . . . .
Copy - Copy Model Files.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delete - Delete Model Files.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Append - Append Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Bundle - Bundle & Unbundle Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Bundle A Model - Zip A Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Unbundle A Model - Unzip A Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27
29
29
30
31
32
32
32
33
34
34
35
36
36
37

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Table Of Contents

Purge - Remove Unrequired Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Preferences.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Paths - Set The Default File Directories.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Property Tables - Set The Default Property Tables. . . . . . . . . . . . . . . . . . . . . .
Settings - Set User Interface Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Facility Settings - Display/Edit Facility Settings. . . . . . . . . . . . . . . . . . . . . . . .
Save Current Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Retrieve Saved Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Restore A Model - Restore Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Restore Samples - Restore The Sample Models.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Quick Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Exit GASWorkS - Close GASWorkS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Edit - Entering & Editing Data.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Model Notes - Edit The Model Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mass Update - Mass Update Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Property Tables - Edit The Property Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Facility Settings - View/Edit The Facility Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Run File - View/Edit The Run File Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Analysis - Calculating Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Solve Single Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Execute Run File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calculate Gas Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GASCalc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report - Viewing & Printing Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Standard (All) - Report Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Standard (Select). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customer.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Header.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary - Create A Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connectivity - Create A Connectivity Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Property Tables - Report Property Table Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data Check - Find & Report Data Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Solution Log - View A Solution Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report Options - Set Report Format Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphics - Accessing The Graphic Data Interface (GDI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
View/Edit - View & Edit The Model Data.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Settings - Change Graphic Settings.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Background Settings - Set A Background Image.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Save Display As Bitmap - Save The Displayed Image. . . . . . . . . . . . . . . . . . . . . . . . . .
Save Display To Clipboard - Copy The Displayed Image.. . . . . . . . . . . . . . . . . . . . . . .
Utilities - Using The Utility Routines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set Defaults - Specify The Default Data Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Bradley B Bean PE

37
37
38
38
38
39
39
39
40
40
40
41
42
42
42
43
43
44
45
45
45
46
46
48
48
49
49
49
49
49
49
50
50
50
51
51
53
53
53
54
54
55
56
56

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

vi

GASWorkS 9.0

Table Of Contents

Customer Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Attribute File - Attach An Attribute File.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Update External Loads - Assign & Update Node Loads. . . . . . . . . . . . . . . . . .
Execute SQL Statement - Update Attribute Values. . . . . . . . . . . . . . . . . . . . . .
Pipe Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Attribute File - Attach An Attribute File.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Execute SQL Statement - Update Attribute Values. . . . . . . . . . . . . . . . . . . . . .
Import/Export - Importing & Exporting Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data Check - Check The Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Miscellaneous. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Check Connectivity.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Renumber Nodes.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calculate XYs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sort Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Window - Window (Screen) Access Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Arrange Icons.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Arrange Screens - Arrange Open Screens. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Windows List - Access Open Screens. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Help - Use The Help Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents - Access The Help Topics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
View Help Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Help - Instructions For Using Help System. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Technical Support - How To Reach Us. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contact Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Request Registration Number.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Send Help Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
View Demonstration Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
View Users Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About GASWorkS - Setup & Version Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56
57
57
58
58
58
59
59
60
60
60
61
61
62
63
63
63
63
64
64
65
65
65
65
66
66
66
67
67

DATA SCREENS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Bundle Specifications Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Connectivity Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Customer Data Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Data Check Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Data Check Specifications Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Default Data Values Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Facility Settings Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
File Selection Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Find Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Gas Properties Calculation Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Header Data Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Mass Update Specifications Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Model Notes Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

vii

GASWorkS 9.0

Table Of Contents

Node Data Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Path Settings Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pipe Data Report.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Preference Settings Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Print Control Screen - (Long Form). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Print Control Screen - (Short Form). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Project Specifications Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Property Table Settings Screen.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Query Specifications Screen.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Renumbering Specifications Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report Options Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Run File Specifications Screen.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Solution Data Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Solution Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Solution Log Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sort Specifications Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary Report Options Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
XY Calculation Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

119
125
127
136
138
141
143
146
148
151
152
157
160
171
173
175
176
178
182

GRAPHIC DATA INTERFACE (GDI). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


GDI Window Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GDI Window Icons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GDI Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GDI Commands & Icons Descriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mouse Events.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Key Events.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Entering Coordinates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Attribute Valve Data Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Background Image Settings Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Color Legend. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customer Data Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Edit Graphic Data Values Screen - (Lines). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Edit Graphic Data Values Screen - (Symbols). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Edit Text Values Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic Settings Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multiple Edit Specifications Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Node Data Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pipe Data Screen.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Plot Settings Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Profile Options Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Scale Factor Calculation Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Selected Route Profile Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set Display Colors Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

185
187
189
190
191
235
237
237
240
241
249
250
257
259
261
263
268
271
279
293
299
301
303
305

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

viii

GASWorkS 9.0

Table Of Contents

Specify Shift Details Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Text Display Options Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tool Palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Trace Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Trace Specifications Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Trace & Update Specification Screen.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

308
310
312
314
315
318

PROPERTY TABLES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Property Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Updating The Property Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Property Table Report.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Compressor Tab.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fittings Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pipe Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Regulator Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Valve Tab.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Well Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

321
323
325
326
329
332
334
337
340
343

ATTRIBUTE DATA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customer Attribute Settings Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pipe Attribute Settings Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Updating External Loads. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Data Lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using SQL To Update Attribute Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Define SQL Update Specification Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Linked Attribute Database Definition Screen.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

347
350
355
360
362
365
365
367

IMPORT & EXPORT ROUTINES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371


Import/Export Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Import/Export File Selection Screen.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
IMPORT ROUTINES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Import ASCII (Column) Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Define ASCII Column File Format Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Import ASCII (Delimited) Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Define ASCII Delimited File Format Screen.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Import dBASE Format Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database File Format Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Import DXF Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DXF Import Specification Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Import MIF/MID Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Import Shape (SHP) Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Import Stoner PD/XY Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Bradley B Bean PE

379
381
382
382
385
385
388
388
390
390
397
399
403

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

ix

GASWorkS 9.0

Table Of Contents

Import XLS Format Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Import X-Y Customer Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customer X-Y Specification Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Import X-Y Node Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Import X-Y Valve Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

404
405
405
407
408

EXPORT ROUTINES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Exporting Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export ASCII Customer Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export ASCII Node Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export ASCII Pipe Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export dBASE Customer Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export dBASE Node Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export dBASE Pipe Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export DXF Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DXF Export Options Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export GASWorkS 7.0 Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export Microsoft Access Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export Microsoft Excel Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export Shape (SHP) Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export Stoner Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export X-Y Customer Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Export X-Y Node Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

409
411
412
414
417
421
423
426
429
429
432
433
434
435
436
437
438

MISCELLANEOUS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Personalizing GASWorkS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Non-Pipe Elements.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using The Relate Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Run Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using The Pipe Sizing (Optimization) Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using The Query Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Attribute Valves. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using The Extract Routine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working With Gas Properties.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calculating Gas Temperatures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Diversified Customer Loads.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using The Facility Type Item. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Convergence Problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using A Command Alias File.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Program Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

439
441
448
452
453
454
458
460
461
462
463
464
467
468
470
471

APPENDIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Network Primer.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
GASWorkS Data Items.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Table Of Contents

Supported Dimensional Units.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Standard Dimensional Units. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pipe Flow Equations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Regulator Flow Equations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Valve Flow Equations.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Compressor Power Equations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Well Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Support Equations.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Compressibility Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Temperature Calculations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GASWorkS Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Standard Property Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Definition Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data List Files.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

495
499
500
518
522
527
530
531
538
541
547
550
553
554

GLOSSARY.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
INDEX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

xi

GASWorkS 9.0

Bradley B Bean PE

Table Of Contents

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

xii

GASWorkS 9.0

Getting Started
Table Of Contents

GETTING STARTED

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Getting Started
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Getting Started
Table Of Contents

Introduction
Use the procedures outlined in this section to install GASWorkS and begin using it to model your gas system.
If you are a new User, working the example model contained in the Demonstration Guide will provide
instructions and examples of using the basic features of the GASWorkS software. If you are a current User,
you might browse the Release Notes topic in the Getting Started section of this Manual to review the new
features contained in this version of the software.
In addition to the example included with this Manual, the Help System contains many other examples and
how-to tips. The Building Your First Model example is a good topic to start with.
A list of the available commands in the Graphic Data Interface (GDI) is provided in that section of this
Manual. The Menu Items section of this Manual provides some abbreviated instructions on accessing and
using many of the routines found in the software.
GASWorkS is suitable for modeling a variety of distribution, gathering, transmission, and plant piping
systems containing most any compressible, single phase fluid. Many of the examples used in its
documentation refer to distribution type systems. However, please consider that the methods required to
create and solve these examples, are exactly the same as those required to create and solve a model of any
type of system.
If you encounter problems, or have specific questions, refer to the appropriate section of this Manual for
detailed instructions, descriptions, and explanations. Or, use the Help System to view examples and how-to
tips on performing a specific task.
Feel free to contact us with your questions. Additional support, documents, new and updated Property
Tables, program updates, and frequently asked questions and answers can also be found on our website
www.b3pe.com.

Installing GASWorkS
An appropriate version of Windows must be running in order to install GASWorkS. If it is not, start
Windows now. Depending on the format that the software was received in, proceed with one of the
installation options described as follows.
Note...

On Windows Vista or newer machines, you will need to be logged on as the Full Administrator
or use the Run as administrator option when executing the installation file.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Getting Started
Table Of Contents

Installation From A CD
! Place the CD in the appropriate disk drive.
For Windows XP, Vista, 7:
If the AutoPlay screen is displayed, select the Open folder to view files item. Double-click the
setup.exe file. If the User Account Control screen is displayed, select the Yes command button to
proceed.
If the AutoPlay screen does not appear, select the Start button on the Windows Task Bar. Select
the Run item from the Start menu list or on Windows 7 click in the File Search prompt. Type the
letter corresponding to the drive containing the setup CD, followed by setup.exe, then press the
Enter key. For example, type d:setup.exe, then press the Enter key or select the OK command button
to proceed.
For Windows 8:
Switch to the Windows 8 desktop.
If a notification appears on the desktop, click the notification. Select to open the folder. If a
notification does not appear, a window displaying the disk contents should automatically appear.
Double-click the setup.exe file. If the User Account Control screen is displayed, select the Yes
command button to proceed.
If the disk contents are not automatically displayed, right-click the cursor in the lower-left corner
of the desktop. Select the Run item from the menu list. Type the letter corresponding to the drive
containing the setup CD, followed by setup.exe, then press the Enter key. For example, type
d:setup.exe, then press the Enter key or select the OK command button. If the User Account Control
screen is displayed, select the Yes command button to proceed.
For Windows 10:
If the File Explorer screen is displayed, double-click the setup.exe file. If the User Account Control
screen is displayed, select the Yes command button to proceed.
If the File Explorer screen is not displayed, select the Windows/Start button on the Windows Task
Bar. Select the File Explorer item from the Start menu list. The File Explorer screen will be
displayed. Double-click the setup.exe file. If the User Account Control screen is displayed, select
the Yes command button to proceed.
! After completing the appropriate steps from above, the main setup screen will be displayed. Proceed by
following the General Installation Instructions described later.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Getting Started
Table Of Contents

Installation From An Electronically Received File


Note...

In the following steps it is assumed that the setup file containing the GASWorkS software has
already been downloaded to your machine. If it has not been downloaded, go to our FTP site to
download it now before continuing.
Instructions on how to access our FTP site are provided at the time of purchase.

! Find the location where the downloaded folder is saved on your machine. Open the folder using Windows
File Explorer.
! Double-click on the executable setup file contained in the compressed folder. If a Windows Security
warning appears, allow your machine to install the file.
! The main setup screen will be displayed. Proceed by following the General Installation Instructions
described later.

General Installation Instructions


After the setup program has been started, several screens will appear during the installation process. Read
the contents of each screen carefully and respond appropriately.
Note...

On the License Agreement screen, read the terms of the License carefully and select the Agree
to option. If you do not wish to accept the License Agreement, you will not be able to continue
with the installation process.

A message will appear when the installation process is complete. The message will indicate whether the
installation was successful or whether it failed. Select the appropriate option to clear the message.

Software Copy Protection


GASWorkS uses several means of software copy protection. We understand that this may be offensive to
some Users, however it is essential to ensuring the commercial viability of GASWorkS. One of the following
methods may be used to protect the installed version of the GASWorkS.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Getting Started
Table Of Contents

Registration Number
Some versions of GASWorkS will require the software to be registered. If your version does, the Registration
screen will be displayed. This displays the Serial Number associated with your license and will prompt you
to enter the Registration Number. To request the Registration Number, select the Request Registration
Number command button, or manually request the registration number by sending an email (please include
your Company Name and the Serial Number) to registration@b3pe.com. Once you have received the
Registration Number, enter the number at the prompt, then select the Continue command button. You will
not be able to fully use the software until it has been registered.
If you need to enter the Registration Number at a later time, select the Cancel command button to close the
Registration screen. After you have received the Registration Number, restart GASWorkS and enter the
number at the prompt.
When using registration protection, GASWorkS may be installed on multiple machines, however it can only
be used to solve a model on the machine that has been registered. Only Edit and View routines are
available on the machines which are not registered.

USB Port Hardware Key


If a USB port hardware key is provided, additional installation steps are required. See the readkey.txt file
located on the GASWorkS distribution CD for additional instructions. Once the software for the key has been
installed, place the key in an available USB port.
When using USB key protection, GASWorkS may be installed on multiple machines and the USB key may
be shared. However, GASWorkS can only be used to solve a model on the machine where the USB key
is installed. Only Edit and View routines are available on the machines which do not contain the key.

Starting GASWorkS
Note...

An appropriate version of Windows must be running before GASWorkS may be executed. If


Windows is not running, begin its execution now.
On Windows Vista, 7, and 8 machines, you will need to be logged on as the Full Administrator
or use the Run As Administrator option the first time you execute the GASWorkS software.

! From the Windows Desktop select the GASWorkS 9.0 shortcut icon.
! The GASWorkS software will be started.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Getting Started
Table Of Contents

!After the software has been loaded into memory, the GASWorkS
Copyright Notice will be displayed. Select the Continue command
button.
Depending on the preference settings, a blank screen may be displayed,
or the Graphic Data Interface (GDI) window may be displayed. In either
case choose the desired option from the pull-down menus, GDI
Command List, or toolbars.
Once installed, to become acquainted with the features of the
GASWorkS software, we suggest that you work the example described
in the Demonstration Guide. The guide and other documentation can be viewed and printed from the Help
menu list.

Using GASWorkS
GASWorkS is designed to be easy and intuitive to use. However, there are a few general concepts that need
to be learned before becoming proficient with the software. There are two ways to get started with
GASWorkS.
One, the General Information section in this Manual provides an introduction to many of the basic concepts
required to use GASWorkS. Review this section to obtain general information needed to use the software.
Once the general concepts have been learned, use the Help System to review the numerous examples and
how-to tips for instructions on performing the various tasks required to create, solve, report, and edit a model
of your piping system.
The other method is to work the example contained in the Demonstration Guide. The guide will introduce
the basic concepts required to create, solve, report, and edit a simple example model. If time is short, we
suggest that you start with the Demonstration Guide - then review the contents of the Manual when time is
available.

Uninstalling GASWorkS
If after using the GASWorkS software you wish to remove it, select the Uninstall GASWorkS 9.0 menu item
from the GASWorkS menu list. In Windows 8, right-click on the GASWorkS 9.0 tile on the start screen, then
select the Uninstall option.
! After the Uninstall Program has been started, read the contents of each screen carefully and respond
appropriately.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Getting Started
Table Of Contents

Note...

If the Uninstall Program asks to remove any shared system files, select the No command button.

! A message will appear when the Uninstall routine is complete. The message will indicate whether the
routine was successful or whether it failed. Select the appropriate option to clear the message.
Note...

On some machines, the Uninstall routine will not be able to remove any directory or file that has
been created after the initial installation.
! Some of the files and/or folders created by GASWorkS after the installation may include files
in the initialization directory (ini), files in the default calculation file directory (files), and/or files
in the application directory (app).
! To remove these files and/or folders, use Windows File Explorer to find and delete the
remaining files and folders. An example of the path for the initialization folder is shown below.
The other folders have similar path locations.
32-bit machines - C:\Program Files\GASWorkS 9\ini
64-bit machines - C:\Program Files (x86)\GASWorkS 9\ini

Release Notes
GASWorkS 9.0 represents a continued evolution of the GASWorkS software - however, as with all
evolutionary processes, things change. In this revision, the most noticeable change will be in the way that
the data is managed. The previous versions of GASWorkS used a database style management system - open
a data table, retrieve a record from the table, make a change, replace the record into the table. With this
method the data is continuously saved to disk storage. GASWorkS 9.0 uses an open, edit, save method of file
management, similar to the methods used in spreadsheet and wordprocessor applications. With this method
the model files are opened and loaded into memory. When changes are made they are only saved to the data
in memory, not the data in disk storage. When the work session is complete, the User may chose to save the
data changes or discard them. Remember to save your changes.
Numerous other changes were made, additional commands and functions were added, and inevitably some
features were discontinued. A partial summary of the many feature changes is provided in the following
tables.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Getting Started
Table Of Contents
Data Management

The most noticeable change to existing Users will be how the data files are managed. Good or bad GASWorkS now uses the open, edit, save management scheme for handling its data files. Other data
management changes include...
Support For Facility Identification Is Provided - Pipes and associated customers can be grouped by
facility type, similar to layers in a CAD application. Individual facilities can be set to be reported, solved,
displayed - or set to active to allow or disallow editing. The User can revise the facility list.
Customers - A Link ID data item was added to enhance sharing of data with other applications. A Unit
Count item was added to allow a single customer feature to more easily represent multiple physical
customers. Support is now provided for branch customers. This allows one customer to feed from
another customer. Multi-segment service lines are now supported. For our UK customers, individual
diversity handling is now supported.
Pipes - A Link ID data item was added to enhance sharing of data with other applications. An external
database can now be attached to the pipe features in the model. A Facility Type data item has been added.
Fittings (valves, elbows, and tees) can be attached directly to a pipe segment. The equivalent length is
automatically computed and used during calculation.
Nodes - Separate control for application of the design factor and status for base and external loads was
added. Long node names - up to 40 characters - are now supported.
Property Tables - The various Property Tables (Pipe, Valve, Regulator, Compressor, Well, and Fittings)
are accessed using an improved spreadsheet style interface. Now the User has the ability to save and
retrieve specific tables. As well as the ability to setup color and linetype specifications for individual pipe
sizes and types. Pipe sizes to include during pipe sizing (optimization) can now be more easily identified.
See the Property Tables section in this Manual for notes on using old look-up tables.
File Handling - GASWorkS 7.0 files are automatically imported when opened. A graphic preview of the
model is displayed on the File Selection screen. Implementation of open, edit, and save style file handling.
Automatic save at User specified time intervals is supported.
Linked Database - A linked database feature has been added to replace the GASBase database. Pipe and
customer model data can be complimented by the use of linked database. The linked database is
automatically managed by GASWorkS - as model features are added or deleted, the associated (linked)
database feature is also updated. The fields in the linked database can be specified by the User based on
a seed file. The contents of the linked database can be manipulated using Standard Query Language
(SQL) manipulation commands.
Undo - An undo feature has been added to allow restoration of previous data or graphic changes. The
undo feature can be turned on or off by the User. The Undelete Oops command has been expanded
to include Customer, User Graphic, and User Text features.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

GASWorkS 9.0

Getting Started
Table Of Contents
Data Management

Deleted files are now automatically sent to the Windows Recycle Bin instead of being permanently
deleted.

Customer Load Manipulation


Customer Feature Data - A multiple unit field has been added - a single customer feature can be used
to represent multiple customers (units). A link identification field has been added to allow enhanced
connection between the GASWorkS data model and an external database.
Diversity - For Users of the IGE diversity calculations, heating/construction type and annual usage can
now be set for each individual customer. Calculation in looped systems is now supported.

Graphic Data Interface (GDI)


The Graphic Data Interface was enhanced by the addition of many new commands and features. Listed
here in no particular order, the new features include...
One-Click Access To The Pipe, Node, & Customer Data - To access pipe data, left-click on a pipe feature.
To access node data, press the Shift key while left-clicking on a node feature. To access customer data,
press the Ctrl key while left-clicking on a customer feature.
Multi-Segment Service Lines Are Supported - Customer features may have polyline type service lines. The
main tap location can be specified by the User.
Support For User Graphic Lines & Symbols Is Now Provided - Graphic (non-model) lines and symbols
can be included in the model graphics. Graphics are added by drawing or inserting the feature at User
specified locations. A new GDI toolbar has been added to allow management of the Graphic features.
Automatic Assignment Of Supply Main On Customer Entry - A command is provided for one-click entry
of customer features - select a customer location, and the customer is automatically assigned to the nearest
main.
Automated Insertion & Addition Of Regulator, Compressor, & Valve Elements - A set of commands has
been added which allows the addition and insertion of non-pipe elements. The Insertion routine
automatically updates pipe lengths when the device is inserted into an existing segment.
Enhanced GDI Command List - The GDI Command List includes the traditional alphabetic listing and a
new grouped listing. The grouped listing groups commands by type in toolboxes. For example, the
Add commands are grouped in one toolbox, the Edit commands in another, etc. The lists have been
expanded to include all of the new and existing commands.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

10

GASWorkS 9.0

Getting Started
Table Of Contents
Graphic Data Interface (GDI)

Plot Preview - The plot image is displayed in a preview window before it is sent to plotter/printer when
plotting.
Plot To User Specified Scale - Plots may be made to fit the specified page size, or to a User specified
scale.
Enhanced Arc Handling - Arcs can now be adjusted after they have been entered. Pipe ends for arc type
pipes can be moved.
Additional Symbol & Line Styles - New node symbols and line styles have been added. Non-continuous
line styles can be used with all line widths.
Improved Flow-Arrow Handling - Style, Size, & Display Selection - Flow arrows can be displayed as the
traditional arrow heads or as chevrons at mid-section.
Automated Header Tap On Lateral Pipe Entry - Using a Ctrl-click selection at the From Node and To
Node Location prompt, will automatically tap the pipe near the selected location.
Double The Number Of Customer Edit & Entry Commands - Numerous other commands have been added
for editing and entering customer data. The Customer Data Commands toolbar is now two-tiered.
Calculation Of Pressure Drop Between Graphically Selected Points - The pressure drop between a pair
of selected node points can be displayed based on a User selection.
Automated Calculation Of Efficiency Based On Calibration Values - The efficiency of the pipes along a
route between two User selected points can be automatically computed based on User specified calibration
values.
Calculation Of Item Statistics For Graphically Selected Data Features - A summary of various data
values can be displayed based on a User selected set of features.
Extract, Copy, & Move Pipe, Node, & Customer Features Based On A Graphically Identified Selection
Set - A portion of a system can be extracted from a model, based on a User specified set of features.
Associated pipes, nodes, and customers are included in the Extraction and Deletion routines.
Match Hydraulic & Graphic Properties - The properties of a selected feature can be applied to other User
selected features.
Multi-Segment Measurement Tool - Distance along a multi-segment route can be measured using the new
Measure Distance routine.
Support Of Branch Customers - A grouping of trunk and branch customers can be created, allowing
one customer to be supplied from another.
Save & Retrieve Graphical Views - A graphic view can be saved, then retrieved at a later time.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

11

GASWorkS 9.0

Getting Started
Table Of Contents
Graphic Data Interface (GDI)

Multiple View Tab (Panels) Are Provided - The GDI Window supports three separate panels, each with
the ability to display a different view of the model.
Multiple Previous & Next Zooms - Each GDI panel allows up to ten views to be saved and accessed using
the Zoom Previous and Zoom Next commands.
Trace & Update Data Values Along A Trace Route - Pipe, node, and customer values can be changed
along a trace route.
Set Hydraulic Symbols Independent Of Pipe Length - Pipe symbol size for compressors, regulators, valves,
and wells can be set independent of the actual element graphical length.
Save Display To Windows Clipboard - The GDI display can be saved to the Windows Clipboard and
pasted into supporting applications.
Calculate XY Coordinates From Latitude & Longitude - Approximate planar coordinates can be calculated
from geographic coordinates.
Automatically Set Text Display Limit - The text display limit can be set to the current view by simply
double-clicking the display limit data field.
Entry Of Pipe By Length & User Drawn Angle - In addition to the previous entry methods, a pipe segment
can be added by entering a desired length, then graphically selecting the desired angle.
Display Pipe Length During Manual Graphic Entry - The pipe length can optionally be displayed during
entry.
Automatically Reset Feature Colors - Useful after traces and queries.
Automatically Find & Delete Zero Length Pipes - Useful for data imported from CAD and GIS sources.
Pipe color and line-type can be set using values contained in the Pipe Property Table, based on size and
type values, or based on facility type.
Improved Background Handling - Including: Support for blocks in DXF backgrounds. Ability to set
scale and origin shift when attaching a DXF background. Turn display of individual background image
off without unattaching the image. Support for SHP file background images is now supported.
Support For Typed Commands - Support is now provided for manual entry of typed commands. This may
seem like a step backwards, but often it is quicker to type a command than to find and select it from the
GDI Command List. Full or abbreviated commands may be entered, and the User may create a command
alias list to use their own name for the GDI Commands.
A Routine To Automatically Identify & Tap Unbroken Intersections Has Been Added - This is especially
useful for cleaning up imported CAD and GIS data.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

12

GASWorkS 9.0

Getting Started
Table Of Contents
Graphic Data Interface (GDI)

Overall improvement of display speed.


Right-clicking the mouse while working in the GDI Window, displays a pop-up menu allowing a
command to be repeated, the display to be panned or zoomed, or a feature edit command to be executed.
A routine has been added to create and display a profile of various data values along a User specified
route.

Solution Routine
Capacity - Support for increased model capacity - the solution, reports, and GDI display have been tested
and verified with models up to 250,000 nodes in size.
Optimization - A more robust Pipe Sizing routine now produces more accurate and consistent optimal pipe
size sets. Ability to set limit pressures at multiple condition nodes. A maximum velocity limit may be
imposed. The Pipe Property Table to use for new size selection can be specified independent of the model
Pipe Property Table.
Flow Equations - Support for several additional pipe flow equations was added, including additional
versions of the AGA partially- and fully-turbulent equation, and the high and low pressure versions of the
IMC (Polyflo) equations.
Diversity - For Users of the IGE diversity calculations, heating/construction type and annual usage can
now be set for each individual customer. Calculation in looped systems is now supported.
The Temperature Calculation routines have been replaced with a set of routines that more accurately
predict the temperature loss and gain along a pipe segment.

Reports
The various report features have been enhanced in a number of ways - which include...
Standard Reports - Enhanced in report data editing. Enhanced Query routine allows a query specification
to be saved and retrieved. Improved print handling especially for wide reports. Inclusion of customer
model and attribute data. Inclusion of pipe attribute data. Automatic sort by node name or ID number.
Ability to delete a feature from the report. Graphically find a feature from a record selected in a report.
Summary Report - Addition of numerous items to the system summary option. The report is displayed in
a User revisable text window. Selected contents can be copied, cut, and pasted into other applications.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

13

GASWorkS 9.0

Getting Started
Table Of Contents
Reports

Data Check - Additional items and options have been added to the Check routines. The report is displayed
in a User revisable text window. Selected contents can be copied, cut, and pasted into other applications.
Exclusion Report - Additional items and options have been added to the Check routines. The report is
displayed in a User revisable text window. Selected contents can be copied, cut, and pasted into other
applications.

Other Features
Mass Update - Expanded item support including assignment and query of graphical properties. The ability
to save and retrieve query specifications was added.
DXF Import - Now allows assignment of multiple pipe layers. Specification of arc resolution.
Specification of length and coordinate units, and origin shift - allowing automatic scale and shift during
import. Import of pipe, valve, customer, and User Text features has been incorporated into a single routine.
The ability to save and retrieve an import specification was added.
Utilities - An Automated Node Reduction routine was added. This routine is especially useful when
working with CAD and GIS data that needs a bit of cleanup after importing. A routine has been added to
create a graphical model from a non-graphical model.
Quick Export - A set of Quick Export routines have been added to allow the export of data associated with
the current model to be exported to a number of formats with a single click. All pipe, node, and customer
data is included in the export. Supported formats include, Microsoft Access database, Microsoft Excel
workbook spreadsheets, ESRI Shape file, GASWorkS 7.0, dBASE, and ASCII text files.

Discontinued Features
Several features have been discontinued from the current GASWorkS release. Their exclusion was based
on their perceived usefulness with respect to the latest software functionality. These features include...
Model Edit Data Form - The fill-in-the-blank style model edit data form is no longer supported. This
routine was most useful for creating non-graphical models. Non-graphical models are no longer supported.
GASBase - The predefined customer and pipe attribute database included in previous versions of
GASWorkS has been discontinued. Similar and more robust features are provided by the new Linked
database feature. When a GASWorkS 7.0 model with an associated GASBase database is imported, the
GASBase database is converted to a Linked database. All of the data will be retained, however some of
the automated load manipulation functionality of GASBase will be lost.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

14

GASWorkS 9.0

Getting Started
Table Of Contents
Discontinued Features

Import/Export - Some Import and Export routines have been discontinued including the GasTool and Data
Dump formats, and some old versions of GASWorkS. If conversion from these formats is required, we
can process them for you.

We hope that you will be pleased with the many improvements and enhancements we have made to
GASWorkS. Please let us know if you have any comments, concerns, or questions regarding our latest
release.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

15

GASWorkS 9.0

Getting Started
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

16

GASWorkS 9.0

General Information
Table Of Contents

GENERAL
INFORMATION

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

17

GASWorkS 9.0

General Information
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

18

GASWorkS 9.0

General Information
Table Of Contents

Hardware/Software Requirements
GASWorkS will operate on any personal computer (PC) configured to run Windows XP or newer operating
system, through Windows 10. The GASWorkS software will require a minimum of 86 MB of free hard disk
space when installed will full documentation.

GASWorkS Data Elements


GASWorkS uses an intuitive set of data elements to represent the piping systems that it models. The basic
elements of its data structure are nodes, pipes, and customer data. Nodes represent the connections,
intersections, and terminations of pipes. Nodes are the points where flow is introduced into the system
(supplies) or taken out of the system (demands). Nodes can also be used to represent customer connections
and to assign customer loads. Customer features provide an efficient and intuitive way of representing
customer locations and demands.
Pipes connect the nodes and carry flow
between them. Flow can be thought of
as going into or out of nodes.
However, flow only goes through
pipes. GASWorkS supports various
types of pipe elements - Line Pipe,
Regulators, Valves, Fittings, Wells,
and Compressors.
Both hydraulic and attribute pipe data
may be maintained. The hydraulic pipe data represents the items which affect the flow and pressure drop
through the pipes. For example, pipe diameter, length, connectivity, etc. The attribute data represents items
which do not affect the flow or pressure drop through the pipes.
The customer data contains information about the location and demand of the customers associated with a
model. The customer data can be divided into two types of information - model data which describes the
customers location, the supply main identity, the load application details, and the total customer load - and
a second type of information called attribute information, which can contain a variety of non-model data
associated with the customer.
All of the model files are accessed by way of a single key file known as the Header file. This file
contains some general information about the model and the solution control parameters and serves as the
access point for all of the other files.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

19

GASWorkS 9.0

General Information
Table Of Contents

A variety of other data is also used to support GASWorkS and its various routines. These include gas
properties, attribute valves, User Text, and background images. Each is described in detail in various sections
of this Manual.

Using The Menus


The various routines and features associated with the
GASWorkS software are accessed through pull-down
menus. The menus are grouped under headings by
functionality. The menu headings are displayed near the
top of the main GASWorkS screen.
Menu items are accessed by selecting an item from a
menu list. The menu lists are activated by selecting the
appropriate menu heading. Menu headings and menu
items may be selected by clicking on the menu heading
or menu item. A menu list may be deactivated by
pressing the Esc key or selecting another menu heading.
Some menu items have submenus associated with them,
these are accessed through submenu headers. Submenu headers are followed by ... and a right arrow
symbol. Rest or click the mouse on the header title to access the submenu. Multiple submenus may exist.

Negotiating The Screens


GASWorkS provides numerous data screens for entering, editing, viewing, and managing the data it requires.
Generally, a data screen will contain various controls including data fields for entering individual data values,
drop-down lists for selecting predefined data, option buttons and check-boxes for selecting specific options,
data tabs for displaying specific data groups, and command buttons and icons for executing various functions.
The Tab or Enter keys, or the mouse may be used to move between the controls contained on all screens.
Calculated Value - Data fields or display panels highlighted with a yellow background represent calculated
data values. In general, they cannot be directly edited by the User - these values change when one of the
editable values are changed and a calculation is successfully executed.
Checkbox - On some screens, options are presented using checkboxes. Where a check-box is used, a check
mark (T) will appear in the box when the option is selected. The status of a check-box may be changed by
clicking in the box, or by pressing the Space Bar while the cursor is in the box.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

20

GASWorkS 9.0

General Information
Table Of Contents

Data Field - Data fields are provided for items where the value must be entered by typing. To enter a value
in a data field, position the cursor in the appropriate data field, then type the desired value. When entering
numbers in a data field, do not include the digit grouping identifier (thousands identifier). For example, enter
ten thousand as 10000" not as 10,000".
Drop-Down List - Some items are supported by drop-down data lists. For example, dimensional units are
associated with a drop-down list of available values. To activate a drop-down data list, click on the arrow
symbol next to the right side of the data field. Select an item from the list by clicking on the item.
Icon - An icon is a small image which represents the function that the command performs. Icons can only
be selected using the mouse. An example of an icon, is the printer symbol icon found on many report screens.
Option Button - On some screens, either-or options are presented using an option button. When option
buttons are used, a dot inside the option circle indicates that the option is selected. Option buttons are usually
found in groups. Only one option may be selected at a time. To change the status of an option button, click
on the desired button, or use the Arrow keys to move between options.
Scroll Bar - The horizontal scroll bar (the bar directly beneath the viewing screen) is used to move the screen
right and left. The screen contents may be wider than the display window, the horizontal scroll bar allows
viewing of the off-display portions of the screen. The vertical scroll bar (the bar directly to the right of the
viewing screen) is used to move up and down in the screen. The vertical bar allows the screen to be browsed
by adjusting the bar's slider. The scroll bars may be adjusted by moving the bars "slider" with the mouse,
or by clicking on the arrow symbols associated with the specific bar. Large changes in the display can be
made by clicking on the desired bar, either before or after the slider's position.
Tab - On some screens, data items are grouped and displayed on data tabs. To access the data contained on
a tab, click on the tabs heading, use the Arrow keys when the tab heading is highlighted, or hold down the
Alt key while pressing the key associated with the underlined letter displayed in the tabs heading.
The GASWorkS Graphic Data Interface (GDI) window provides a unique set of access methods. Refer to
the Graphic Data Interface section of this Manual for specific notes and instructions on its use.

Executing Commands & Functions


Many screens and message contain command buttons. These buttons may be used to access a specific
function or to perform a specific action. The Close or Cancel command buttons found on many of the data
screens are examples of command buttons. When a command button is selected, the function associated with
that command button is executed. Command buttons may be selected by one of the following methods:
! Left-click on the command button.
! Use the Tab key to position the cursor on the desired command button, then press the Enter key.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

21

GASWorkS 9.0

General Information
Table Of Contents

! Press and hold down the Alt key while pressing the key corresponding to the underlined letter of
the desired command button.

Accessing Files
A common File Selection screen is used by all
GASWorkS routines to enter required Filenames. The
screen allows the drive, directory, and name of the
desired file to be selected or entered.

To Select A Drive
To select a drive, click the arrow key to the right of the
Drives list. Either click on the desired drive, press the
key corresponding to the desired drive letter, or use the
Up or Down arrow keys to change the selected drive.

To Select A Directory
To select a directory, either double-click on the associated directory in the list, press the key corresponding
to the first letter of the desired directory (until the correct directory is selected), or use the Up or Down arrow
keys to change the selected directory. To display the contents of a directory, double-click on the directory
name.

To Select A File
To select a file, either click on the associated file in the list, press the key corresponding to the first letter of
the desired file (until the correct file is selected), or use the Up or Down arrow keys to change the selected
file.

To Manually Enter A Filename


Move the cursor to the Filename data field. Type the desired drive, path (directory), Filename, and extension
in the Filename data field. GASWorkS database files are managed through their associated header file. The
header file uses an .hdr extension, consequently the ".hdr" extension must be included when manually
entering a model's header Filename.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

22

GASWorkS 9.0

General Information
Table Of Contents

To Select A Recently Opened File


Move the cursor to the Filename data field. Select the desired file by clicking on the arrow symbol adjacent
to the data field, then click on the name of the desired file using the mouse.
After the desired Filename has been entered or selected, select the Continue command button to proceed. To
close the File Selection screen and terminate the routine, select the Cancel command button.
Note...

Each time GASWorkS starts, it automatically opens the last model file that was worked on. This
feature can be disabled by closing the model before leaving GASWorkS.

Notes On Dimensional Units


When GASWorkS first starts, its default dimensional units are set to standard US values (Feet, Inches, Psi,
Fahrenheit). To change the default dimensional units:
! Select the Set Defaults menu item from the Utilities menu list. The Default Data Values screen
will be displayed.
Select the Dimensional Units tab to access the currently selected dimensional units. Make
changes as appropriate.
Select the Apply Displayed Values Only command button to change the values used in the
current model. Note - Do not select the Apply All Values command button unless you are
certain that you want to apply all of the default setting values, including data values, to the
current model.
As used in GASWorkS, unless otherwise specified, all pressure units represent gauge units. Within the
documentation, gauge pressure units are generally shown without a suffix, absolute pressure units are shown
with an a or (Abs) suffix. Gas Volume values or volumetric flow rates are expressed in standard cubic
units, based on (adjusted to) the specified base pressure and temperature.

Notes For International Users


GASWorkS attempts to accommodate the needs of International Users by providing a robust set of
dimensional units. These units can be selected as appropriate for the Users particular needs.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

23

GASWorkS 9.0

General Information
Table Of Contents

GASWorkS does have a particular weakness when it comes to the various Property Tables that contain
predefined Compressor, Fittings, Pipe, Regulator, Valve, and Well data. These lists are primarily oriented
towards US manufacturers and sizes. These tables can be easily modified by the User to more specifically
meet the particular needs of each User. The tables provided with the software are intended to provide a
starting point to allow the User to create their own custom tables.
Note...

The example models provided with GASWorkS all use US units of measure. To obtain valid
results, these examples must be worked using the US units. When working these examples, if the
default data values and dimensional units have been changed, they must be reset to their original
US values before working with the example model.

GASWorkS can accommodate either a comma (,) or a dot (.) as the decimal identifier, or a comma (,) or a
dot (.) as the digit grouping identifier depending on the associated Windows setting. For example, ten
thousand and one tenth can be displayed as 10,000.10" or as 10.000,10" depending on the Windows
setting.
Use the Regional and Language options found in the Windows Control Panel to change the digit grouping
and decimal identification settings.

Using The Help System


GASWorkS help topics are presented in the Help System and in the Help Guide. Each document contains
unique topics.
GASWorkS has an extensive Help System. The topics contained in the Help System provide numerous
examples and how-to tips. To access the Help System, select the Contents menu item from the Help menu
list, or press the F1 key. The Help Topics screen will be displayed, select the Index tab to display a listing
of the topic subjects contained in the Help System. Select an item from the Index list to view the associated
topic documentation.
To access the Help Guide, select the View Help Guide menu item from the Help menu list, or press the F1
key while holding down the Ctrl key.
Generally, the help documents are installed when the software is installed. If one or more of the documents
are missing, they are available for download from our website, www.b3pe.com.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

24

GASWorkS 9.0

General Information
Table Of Contents

Getting Help - Contact Us


Hours - Our normal work hours are 8:00 A.M. to 5:00 P.M. Mountain Time, Monday through Friday.
However if you have a problem, please try at any time, we may be in.
By Telephone - Telephone: (719) 578-9391

Toll Free (US Only): 1-800-391-9391

By Email - help@b3pe.com
By Website - www.b3pe.com

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

25

GASWorkS 9.0

General Information
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

26

GASWorkS 9.0

Menu Items
Table Of Contents

MENU ITEMS

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

27

GASWorkS 9.0

Menu Items
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

28

GASWorkS 9.0

Menu Items
Table Of Contents

This section provides a general reference for using the GASWorkS menu items. Grouped by functional topic,
procedures are described for using each of the items available in the GASWorkS menu lists. Most of the
menu items will launch a data or specifications screen. Further information describing the use and features
with the screens is provided in later sections of this Manual.
Some menu items have submenus associated with them, and are accessed through submenu headers.
Submenu headers are followed by ... and a right arrow symbol. Rest or click the cursor on the header title
to access the submenu. Multiple submenus may exist.
Certain menu items will not be displayed if a model is not open.

File - File Management


The GASWorkS model file management routines are grouped under the File menu heading. The routines
located under this heading are used to manage the model files only. That is, these routines manipulate the
files directly associated with a model. The contents and use of each of the GASWorkS files are described
in the Appendix section of this Manual.
Access to the GASWorkS support files, such as the Property Tables, is handled by the individual routines
that access or manipulate those specific files. Management routines such as copying and deleting the support
files must be performed manually by the User.
A GASWorkS model consists of a number of files each possessing the same name but varying extensions.
Some of the files represent the header, pipe, node, and customer data associated with each model, others
represent support, or other data files. A full list of the specific file extensions is contained in the Appendix
section of this Manual. GASWorkS manages the model files based on the name of the header file. When
prompting for a model name, GASWorkS expects the ".hdr" extension to be present. Be sure to include the
".hdr" extension when manually entering a model name.
Only one model may be open at a time. The name of the currently opened model is displayed at the top of
the GASWorkS screen. Certain menu items and commands will prompt for a Filename if a function which
affects a model file is executed, and a model has not already been opened. Once a model has been opened,
execution of subsequent model related routines will apply to the open model. The routines found in the File
menu list are described in the following sections.

New - Create A New Model


The New menu item creates a new set of model files. To create a new GASWorkS model:
! Select the New menu item from the File menu list. A File Selection screen will be displayed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

29

GASWorkS 9.0

Menu Items
Table Of Contents

! In the Filename data field, either enter the name of the new model or select a model name from
the list.
! Select the Continue command button to accept the specified model Filename.
If the name of an existing model is selected or entered, a warning message will appear. To overwrite an
existing model, select the Yes command button. To return to the File Selection screen without overwriting
the existing files, select the No command button. If you choose to overwrite the model files, the contents of
the original files will be sent to the Windows Recycle Bin.
If an existing model is already open, a warning message will appear asking whether to save or discard the
changes. Select the Yes command button to save any changes to the existing model, close the existing model,
and open the selected model. Select the No command button to close the existing model without saving any
changes, and open the selected model. Select the Cancel command button to exit and return to the existing
model.
When a valid Filename has been selected or entered, GASWorkS will create and open a new header file, and
a set of empty data and support files. The contents of the header file will be similar to the last saved model.
The Graphic Data Interface (GDI) window should automatically open. Use the appropriate GDI Commands
to enter the data associated with the new model. If the GDI Window does not automatically open, select the
View/Edit menu item from the Graphics menu list.
As new pipe and node features (records) are added, the values initially populating the new items are extracted
from the default data values. The default data values and dimensional units may be set by using the Set
Defaults routine found in the Utilities menu list.
If the path name is omitted when entering a new Filename, the current drive and directory will be assigned
as the path. If the extension is omitted, the ".hdr" extension will automatically be applied.

New Project - Create A New Model


The New Project menu item is similar to the New item. It creates a new set of model files, but it also allows
various settings to be selected before creating the model. To create a new GASWorkS model:
! Select the New Project menu item from the File menu list. The Project Specifications screen will
be displayed.
! Either enter or select the name of the new model. Select the desired support file settings. Select
any desired background files or attribute files to attach. Select the Continue command button to
create the model.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

30

GASWorkS 9.0

Menu Items
Table Of Contents

If the name of an existing model is selected or entered, a warning message will appear. To overwrite an
existing model, select the Yes command button. To return to the File Selection screen without overwriting
the existing files, select the No command button. If you choose to overwrite the model files, the contents of
the original files will be sent to the Windows Recycle Bin.
When a valid Filename has been selected or entered, GASWorkS will create and open a new header file, and
a set of empty data and support files. The contents of the header file will be similar to the last saved model.
The Graphic Data Interface (GDI) window should automatically open. Use the appropriate GDI Commands
to enter the data associated with the new model. If the GDI Window does not automatically open, select the
View/Edit menu item from the Graphics menu list.
As new pipe and node features (records) are added, the values initially populating the new items are extracted
from the default data values. The default data values and dimensional units may be set by using the Set
Defaults routine found in the Utilities menu list.

Open - Open An Existing Model


The Open menu item opens an existing model for editing, reporting, or solving. To open an existing model:
! Select the Open menu item from the File menu list. A File Selection screen will be displayed.
! In the Filename data field, either enter or select the name of the desired model. Remember to
include the ".hdr" extension if you manually enter the name. A warning message will appear if the
file is not found.
! Select the Continue command button to accept the selected Filename.
If an existing model is already open, a warning message will appear asking whether to save or discard the
changes. Select the Yes command button to save changes to the existing model, close the existing model and
open the selected model. Select the No command button to close the existing model without saving any
changes, and open the selected model. Select the Cancel command button to exit and return to the existing
model.
When a valid Filename has been selected, GASWorkS will open and read the associated model files. Once
the model is read into memory the various Edit, Report, and Solution routines can be used to manipulate the
model. Choose the desired routine to proceed. Routines that require access to a model file will automatically
prompt for a Filename, if a model is not currently open.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

31

GASWorkS 9.0

Menu Items
Table Of Contents

Note...

If the Automatically Open GDI Window preference setting is selected (checked), the Graphic
Data Interface (GDI) window will be displayed after a valid Filename has been selected or
entered.
If a GASWorkS 7.0 model is selected, a warning message will appear asking whether to import
the file - respond appropriately. If the model is imported, a separate (converted) set of model files
will be created with the same name as the original file followed by a _90" suffix.

Close - Close A Model


The Close menu item closes the currently open model. To close the current model:
! Select the Close menu item from the File menu list.
If changes have been made to the model, a warning message will appear asking whether to save or discard
the changes - select the appropriate response.
Note...

Each time GASWorkS starts, it automatically opens the last open model file. This feature can be
disabled by closing the model before exiting GASWorkS.

Save - Save Model Changes


The Save menu item saves the changes made to the currently open model. To save changes to the current
model:
! Select the Save menu item from the File menu list.

Save As - Save Model Changes To Another Name


The Save As menu item saves the changes of the current model to another (different) model name and
changes the name of the currently open model to the specified name. To save the current model changes to
another Filename:
! Select the Save As menu item from the File menu list. A File Selection screen will be displayed.
! In the Filename data field, either enter or select the new model name to save the changes to.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

32

GASWorkS 9.0

Menu Items
Table Of Contents

! Select the Continue command button to accept the specified Filename.


If the name of an existing model is selected or entered, a warning message will appear. To overwrite an
existing model, select the Yes command button. To return to the File Selection screen without overwriting
the existing files, select the No command button. If you choose to overwrite the model files, the contents of
the original files will be sent to the Windows Recycle Bin.
After a valid Filename has been selected, GASWorkS will copy the contents of the currently open model into
the selected model files.
Note...

The Save As routine saves (copies) the contents of the data stored in memory, not the data stored
in the file on disk. To copy the data stored on disk to another destination use the Copy routine.

Rename - Change The Name Of The Current Model


The Rename menu item changes the name of the currently open model to another User specified name. The
name of the various files associated with the model will be changed to the specified name. Unsaved changes
to the current model will not be saved. To change the name of the current model:
! Select the Rename menu item from the File menu list. A File Selection screen will be displayed.
! In the Filename data field, either enter or select the new model name.
! Select the Continue command button to accept the specified Filename.
If the name of an existing model is selected or entered, a warning message will appear. To overwrite an
existing model, select the Yes command button. To return to the File Selection screen without overwriting
the existing files, select the No command button. If you choose to overwrite the model files, the contents of
the original files will be sent to the Windows Recycle Bin.
After a valid Filename has been selected, GASWorkS will change the name of the current model to the
specified name. A message will appear indicating the result of the Rename routine. Select the OK command
button to clear the message.
Note...

The Rename routine changes the name of the data files stored on the disk to a new User specified
name, it does not save the data stored in memory. To save the data stored in memory to another
destination use the Save As routine. The Rename routine does not make a copy of the disk files,
it only changes the name of the files. Use the Copy routine to make a copy of the disk files.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

33

GASWorkS 9.0

Menu Items
Table Of Contents

Copy - Copy Model Files


GASWorkS provides a routine for copying the files associated with a model. This routine will automatically
copy the various model files to a specified destination model name. To copy the files associated with the
currently open model:
! Select the Copy menu item from the File menu list. A File Selection screen will be displayed.
! In the Filename data field, either enter or select the name of the desired model to be copied.
! Select the Continue command button to accept the specified Filename.
If the name of an existing model is selected or entered, a warning message will appear. To overwrite an
existing model, select the Yes command button. To return to the File Selection screen without overwriting
the existing files, select the No command button. If you choose to overwrite the model files, the contents of
the original files will be sent to the Windows Recycle Bin.
After a valid Filename has been selected, GASWorkS will copy the contents of the source model's files into
the destination model files. Upon completion of the Copy routine, a message will appear asking to open the
new model. Select the Yes command button to open the new model, or select the No command button to close
the currently open model.
If the Automatically Open GDI Window preference setting is selected (checked), the Graphic Data Interface
(GDI) Window will be displayed if the new model is opened.
Note...

The Copy routine copies the contents of the data stored in the disk file, not the data stored in
memory. To save the data stored in memory to another destination use the Save As routine.

Delete - Delete Model Files


The Delete menu item deletes all of the files associated with a User selected model. The Deletion routine
deletes all of the files associated with the selected model, including its backup files. To delete an existing
model's files:
! Select the Delete menu item from the File menu list. If a model is currently open, a message will
appear asking delete the currently open model. Select the appropriate response. If the No command
button is selected, a File Selection screen will be displayed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

34

GASWorkS 9.0

Menu Items
Table Of Contents

! In the Filename data field, either enter or select the name of the desired model to be deleted.
Remember to include the ".hdr" extension if you manually enter the name. A warning message will
appear if the file is not found.
! Once a valid Filename has been entered or selected, select the Continue command button to delete
the selected models files.
! A warning message will appear asking to confirm the model's deletion. Select the Yes command
button to delete the selected model, or select the No command button to cancel the routine.
! A message will appear indicating the result of the Delete routine. Select the OK command button
to clear the message.
If the model you are attempting to delete is open, you will get an error message that reads at least one file
is read-only. Close the model and re-execute the routine.
After the selected model has been deleted, the File Selection screen will be re-displayed - either select
another model for deletion, or select the Cancel command button to end the routine.
Note...

After a valid name has been selected, GASWorkS will delete the contents of each file
associated with the selected model. The files are not actually deleted, but sent to the Windows
Recycle Bin. The files may be manually restored using Windows Explorer.

Append - Append Model Files


The Append menu item provides a routine for appending (joining) two models together. Before appending
two files, ensure that the models do not contain redundant node names. The appended model files will
become corrupt if redundant node names are present. The Renumber Nodes routine found in the
Miscellaneous submenu of the Utilities menu list can be used to automatically renumber or rename a model's
nodes.
All model files are appended, except the header file of the model being appended to is retained as the header
file for the new combined model. The model to be appended to, must be open before attempting to execute
the Append routine. To append another file to the currently open model:
! Select the Append menu item from the File menu list. A File Selection screen will be displayed.
! In the Filename data field, either enter or select the name of the desired model to add to the
currently open model. Remember to include the ".hdr" extension if you manually enter the name. A
warning message will appear if the file is not found.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

35

GASWorkS 9.0

Menu Items
Table Of Contents

! A warning message will appear asking to confirm the appending of the two models. Select the Yes
command button to append the selected models, or select the No command button to cancel the
routine.
! When the Append routine is complete, a message will appear notifying whether the operation
succeeded or failed. If the process failed or the result was not as expected, close the model without
saving the changes.

Bundle - Bundle & Unbundle Model Files


GASWorkS provides a set of routines for bundling (zipping) and unbundling (unzipping) a models file set.
These routines are contained in the Bundle submenu of the File menu list.

Bundle A Model - Zip A Model


The Bundle A Model menu item provides a routine for bundling all of a models files into a single zip
format file. This is useful for archiving, backing up, or sharing models with others. The model must be open
before it can be bundled. To bundle the files associated with the currently open model:
! Select the Bundle A Model menu item from the Bundle submenu of the File menu list. The Bundle
Specifications screen will be displayed.
! Select (check) the desired options, then select the Continue command button to proceed.
! A message will appear indicating the result of the Bundle routine. Select the OK command button
to clear the message.
The file created by the Bundle routine will be named the same as the model, except that it will end with a
.zip extension. The bundled files format is PKZip 2.04g compatible. The file may be unbundled using the
GASWorkS Unbundle routine, or it may be unzipped using any compatible file compression program.
Note...

Some firewall and security systems will not allow a zip file containing files with a double
extension. The backup files created by GASWorkS contain double extensions. Select (check) the
Exclude Backup Files bundle option to exclude these files from the file bundle.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

36

GASWorkS 9.0

Menu Items
Table Of Contents

Unbundle A Model - Unzip A Model


The Unbundle A Model menu item provides a routine for unbundling a set of files contained in a single zip
format file. The zip file can be created either by the GASWorkS Bundle routine, or by another zip
application. To unbundle a zip file of a model:
! Select the Unbundle A Model menu item from the Bundle submenu of the File menu list. A File
Selection screen will be displayed.
! In the Filename data field, either enter or select the name of the zip file to unbundle. Remember
to include the ".zip" extension if you manually enter the name. A warning message will appear if the
file is not found.
! When a valid Filename has been selected or entered, select the Continue command button to
proceed with unzipping or extracting the contents of the specified zip file.
! Upon completion of the Unbundle routine, a message will appear asking to open the model. Select
the Yes command button to open the new model, or select the No command button to close the
currently open model.

Purge - Remove Unrequired Model Files


The Purge menu item provides a routine for automatically removing unrequired model files, such as zero
length files and backup files. This process is referred to as purging and is useful for cleaning up a model
before archiving, backing up, or sharing models with others. The model must be open before it can be purged.
To purge the currently open model:
! Select the Purge menu item from the File menu list. A warning message will appear asking to
confirm whether to proceed with the Purge routine. Select the Yes command button to purge the
selected model, or select the No command button to cancel the routine.
! A message will appear indicating the result of the Purge routine. Select the OK command button
to clear the message.

Preferences
GASWorkS allows the User to specify certain User interface behaviors. The routines accessing the available
settings are contained in the Preferences submenu list of the File menu list. They are described in the
following sections.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

37

GASWorkS 9.0

Menu Items
Table Of Contents

Paths - Set The Default File Directories


The Paths menu item allows the User to specify the default location of the various model and initialization
files, the Property Tables, and the license file. These locations are used when a new model is created or when
a Property Table or file is needed. Other locations can be specified by the User during the course of using
the software. The default location is the directory or folder that GASWorkS uses first when dealing with
various file operations. To specify the preferred locations:
! Select the Paths menu item from the Preferences submenu of the File menu list. The Path Settings
screen will be displayed.
! Select the appropriate tab, then select the appropriate drive and directory of the preferred location.
The last open folder in the directory list indicates the selected path location.
! Select the Close command button to save any changes.

Property Tables - Set The Default Property Tables


The Property Tables menu item allows the User to specify which Property Tables (contained in the selected
Property Table path) to use with the current model. To specify the desired Property Table names:
! Select the Property Tables menu item from the Preferences submenu of the File menu list. The
Property Table Settings screen will be displayed.
! Select the Change Path Setting command button to change the Property Table directory. Select
the desired name from the displayed file lists.
! Select the Close command button to save any changes.

Settings - Set User Interface Options


The Settings menu item allows the User to specify several settings which affect various behaviors of the
GASWorkS User interface. For example, one of these settings causes the Graphic Data Interface (GDI)
Window to automatically open and display the current model when the software is first started. To change
the preference settings:
! Select the Settings menu item from the Preferences submenu of the File menu list. The Preference
Settings screen will be displayed.
! Select (check) any desired options.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

38

GASWorkS 9.0

Menu Items
Table Of Contents

! Select the Close command button to save any changes.

Facility Settings - Display/Edit Facility Settings


The Facility Settings menu item provides access to the Facility Settings. To view or edit the Facility Settings:
! Select the Facility Settings menu item from the Preferences submenu of the File menu list. The
Facility Settings screen will be displayed.
! Browse or edit the displayed settings as appropriate. Select the Save As Default command button
to save the current settings as the default settings to be used when creating a new model.
! Select the Apply command button to save any changes.
Note...

This item performs the same function as the Facility Settings menu item in the Edit menu list.

Save Current Settings


The Save Current Settings menu item allows the current path and preference settings to saved for future use.
To save the current settings:
! Select the Save Current Settings menu item from the Preferences submenu of the File menu list.
A File Selection screen will be displayed.
! Either enter or select an appropriate Filename.
! Select the Continue command button to save the settings.

Retrieve Saved Settings


The Retrieve Saved Settings menu item allows previously saved path and preference settings to be retrieved
and applied. To retrieve saved settings:
! Select the Retrieve Saved Settings menu item from the Preferences submenu of the File menu list.
A File Selection screen will be displayed.
! Select an existing Filename, then select the Continue command button to retrieve and apply the
settings.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

39

GASWorkS 9.0

Menu Items
Table Of Contents

Restore A Model - Restore Model Files


The Restore A Model menu item provides a routine for restoring the backup copies of a model's data files.
GASWorkS automatically creates a backup copy of the various model files each time the Save routine is
used, and prior to the use of the Import or Merge routines. To restore the backup version of the currently
open model:
! Select the Restore A Model menu item from the File menu list.
! A message will appear when the restoration is complete. Select the OK command button to clear
the message.
GASWorkS exchanges the contents of the original model files and the backup model files. If a model is
erroneously restored, immediately re-execute the Restore routine to return the original data. Unless instructed
by the User, the current changes will not be saved before the Restore routine is executed.

Restore Samples - Restore The Sample Models


When GASWorkS is initially installed, several sample (example) files and models are copied to the
destination disk. As the various examples are worked, these files will change. To restore the original
(unchanged) example model files:
! Select the Restore Samples menu item from the File menu list.
! A message will appear when the restoration is complete. Select the OK command button to clear
the message.

Quick Export
GASWorkS provides a set of routines for saving the contents of the currently open model to a set of data files
in a User specified format. These routines are contained in the Quick Export submenu of the File menu list.
The Quick Export routines provide a simplified duplication of the functionality of the Import and Export
routines.
! To export the model data to a selected file format, select the desired format item from the submenu
list.
More information on the files that are created using the Quick Export routine is contained in the Export
Routines section of this Manual.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

40

GASWorkS 9.0

Menu Items
Table Of Contents

Exit GASWorkS - Close GASWorkS


To close GASWorkS, select the Exit GASWorkS menu item from the File menu list. If changes have been
made to the model, a message will appear asking whether to save or discard the changes, respond
appropriately.
Note...

If a model is open when GASWorkS is exited, that model will automatically be reopened the next
time GASWorkS is started.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

41

GASWorkS 9.0

Menu Items
Table Of Contents

Edit - Entering & Editing Data


The majority of the model data editing features are handled in the GDI Window or in the Standard Reports.
A few special Edit routines are handled outside of those functions. These routines are accessed through the
Edit menu list. The routines found in the Edit menu list are described in the following sections.

Model Notes - Edit The Model Notes


To access the notes associated with an existing model:
! Select the Model Notes menu item from the Edit menu list. The Model Notes screen will be
displayed.
! Enter or edit the model notes using standard text editing techniques. The notes can contain up to
32,000 alphanumeric characters.
! Select the Close command button to close the screen and save any changes.
The notes can also be viewed from the Header Data Report of the Standard Reports and from the Model
Notes tab on the Solution Data screen.

Mass Update - Mass Update Model Data


The Mass Update routine allows mass changes to be made to the pipe, node, or customer data based on User
specified selection criteria. For example, the routine could be used to set the Pipe Efficiency to 0.92 for all
of the pipes where the Pipe Equation is set to Spitzglass-Low Pressure. To make a mass data change:
! Select the Mass Update menu item from the Edit menu list. The Mass Update Specifications
screen will be displayed.
! Enter or select the desired values for the update.
! Select the Apply command button to proceed with the update.
Note...

If the Allow Undo Of Graphic/Data Changes preference setting is selected (checked), the original
data values can be restored if an erroneous update is performed. To restore the original data
values, immediately select the Restore command button. The Restore command button will only
be enabled when the Allow Undo Of Graphic/Data Changes preference setting is selected
(checked).

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

42

GASWorkS 9.0

Menu Items
Table Of Contents

Property Tables - Edit The Property Tables


GASWorkS uses Property Tables to maintain common information associated with Pipe, Regulator,
Compressor, Valve, Fittings, and Well type elements. An extensive set of "standard" tables are supplied with
GASWorkS. The contents of the Standard Property Tables are described in the Appendix section of this
Manual. To add to or modify the Standard Property Tables:
! Select the Property Tables menu item from the Edit menu list. The Property Table Report will be
displayed.
! To edit the data values associated with a specific table, select the associated tab. The contents of
the specified table will be displayed.
! Either enter or change the desired data values by clicking in one of the associated data cells.
! Select one of the edit icons to add, delete, or insert a record into the table.
! Use the scroll bars to negotiate the table.
! When finished with the Property Table Report, select the Close command button. A warning
message will appear to save or discard any changes, select the appropriate response.
The Property Tables section of this Manual provides a detailed description of the features associated with
the Property Table Report.
Note...

This item performs the same function as the Property Tables menu item in the Report menu list.

Facility Settings - View/Edit The Facility Settings


The Facility Settings menu item provides access to the Facility Settings. To view or edit the Facility Settings:
! Select the Facility Settings menu item from the Edit menu list. The Facility Settings screen will
be displayed.
! Browse or edit the displayed settings as appropriate.
! Select the Save As Default command button to save the current settings as the default settings to
be used when creating a new model. Or, select the Apply command button to save and apply any
changes.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

43

GASWorkS 9.0

Menu Items
Table Of Contents

Note...

This item performs the same function as the Facility Settings menu item in the Preferences
submenu of the File menu list.

Run File - View/Edit The Run File Contents


The GASWorkS Run File feature allows batch type execution of model files. It is especially useful when
used with the GASWorkS Relate features. A Run File contains instructions for performing the solution of
multiple files. To view, edit, or create a Run File:
! Select the Run File menu item from the Edit menu list. A File Selection screen will be displayed.
! Either enter or select the name of a Run File. Remember to include the ".run" extension if you
manually enter the name. When a valid Filename has been selected, the Run File Specifications
screen will be displayed. If a valid Filename has not been found a message will appear, asking to
create a Run File, respond appropriately.
! Browse or edit the displayed settings as appropriate. Select the Close command button to save any
changes.
Suggestions on using the Run File feature are included in the Using Run Files topic in the Miscellaneous
section of this Manual.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

44

GASWorkS 9.0

Menu Items
Table Of Contents

Analysis - Calculating Values


The GASWorkS Calculation routines are grouped under the Analysis menu heading. The routines located
under this heading are used to solve a single model file, or calculate gas properties based on a gas
composition. The routines found in the Analysis menu list are described in the following sections.

Solve Single Model


Solving a model involves calculating the unknown pressure and flow values. To solve a GASWorkS model:
! Select the Solve Single Model menu item from the Analysis menu list. The Solution Data screen
will be displayed.
! Make any desired changes to the data values and options.
! Select the Solve command button to proceed with the solution. The Solution Log will be displayed.
! When the Solution routine is complete, select the Close command button to close the log and
return to the GDI Window.
During the solution, a log of the solution activity is written to a file known as a Solution Log file. The log
file has the same name as the model it is associated with, however the extension is ".slg". The contents of
the log file may be viewed or printed using the Solution Log menu item found in the Report menu list.
The Data Screens section of this Manual provides a detailed description of the features associated with both
the Solution Data screen and the Solution Log.

Execute Run File


The GASWorkS Run File feature allows batch type execution of model files. It is especially useful when
used with the GASWorkS Relate features. A Run File contains instructions for performing the solution of
multiple files. To begin the execution of a Run File:
! Select the Execute Run File menu item from the Analysis menu list. A File Selection screen will
be displayed.
! Either enter or select the name of an existing Run File. Remember to include the ".run" extension
if you manually enter the name. A warning message will appear if the file is not found. When a valid
Filename has been selected, select the Continue command button. The Solution Log will be
displayed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

45

GASWorkS 9.0

Menu Items
Table Of Contents

! When the solution process is complete, select the Close command button to close the log and
return to the GDI Window.
During the solution, a log of the solution activity is written to the Solution Log file. The log file can be
viewed or printed using the Solution Log routine found in the Report menu list.
Suggestions on using the Run File feature are included in the Using Run Files topic in the Miscellaneous
section of this Manual.

Calculate Gas Properties


GASWorkS provides a routine for calculating the gas properties (specific gravity, viscosity, heating value,
and specific heat ratios) from a gas composition. The routine can be used to calculate properties for the
current model, or any other case. To use the Gas Properties routine:
! Select the Calculate Gas Properties menu item from the Analysis menu list. The Gas Properties
screen will be displayed.
! Select the Clear command button to set all of the data items to blank (null) values.
! Enter the appropriate values, then select the Calculate command button to calculate the new
property values.
Note...

Some of the solution calculations require that a gas properties file be created and saved with the
same name as the model. The Gas Properties routine can be used to create the required file.
Additionally, the gas properties can be set and calculated for individual nodes. The Data Screens
section of this Manual fully describes the contents and features associated with the Gas Properties
screen.
The Gas Properties screen can also be accessed from the Default Data Values screen or from
the Node Data screen.

GASCalc
If the GASCalc software is installed on the Users machine and in its normal location, it can be accessed
using the GASCalc menu item from the Analysis menu list. If GASCalc is not installed or is installed in a
non-standard location, the menu item will be disabled.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

46

GASWorkS 9.0

Menu Items
Table Of Contents

! To open the GASCalc software from within the GASWorkS software, select the GASCalc menu
item from the Analysis menu list. The GASCalc program will be displayed.
! Close or minimize GASCalc when finished.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

47

GASWorkS 9.0

Menu Items
Table Of Contents

Report - Viewing & Printing Data


The GASWorkS Report routines are grouped under the Report menu heading. The routines located under
this heading are used to view and print the data contained in the model and support files. The routines found
in the Report menu list are described in the following sections.

Standard (All) - Report Model Data


The Standard Report routine creates a set of standard format reports of the Customer, Header, Node, and Pipe
Data associated with a model. The report provides a separate section for each data type. Portions of the report
format may be configured by the User. If customer features are not present, the Customer Data Report will
not be displayed. To create and view a Standard Report:
! Select the Standard (All) menu item from the Report menu list.
! If a model has not been previously opened, a File Selection screen will be displayed. Either enter
or select the name of an existing model's header file. Remember to include the ".hdr" extension if
you manually enter the Filename.
! When a valid Filename has been
selected, or if a model is already open,
the Standard Report screens will be
displayed.
! Click on any portion of the desired
report to move it to the front. Or, select
the desired report from the Window
menu list to move it to the front.
! To browse through a report, adjust
the scroll bars with the mouse.
! To edit a data value, click the
associated data cell. An edit box will
appear in the selected data cell. Press
the Enter key, or click another data cell
to save the change.
! To close a specific Report screen, select the Close This Report command button on the desired
report. To close all of the Report screens, select the Close All Reports command button on any of
the screens.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

48

GASWorkS 9.0

Menu Items
Table Of Contents

The Data Screens section of this Manual provides detailed descriptions of the features associated with the
Standard Report screens.

Standard (Select)
Report screens can be displayed individually by using the menu items in the Standard (Select) submenu. The
Standard (All) Menu Items topic provides additional information on working with the Standard Reports.

Customer
The Customer menu item allows the User to display only the Customer Data Report.

Header
The Header menu item allows the User to display only the Header Data Report.

Node
The Node menu item allows the User to display only the Node Data Report.

Pipe
The Pipe menu item allows the User to display only the Pipe Data Report.

Summary - Create A Summary Report


The Summary routine provides a choice of certain predefined data and result summaries. To create a
Summary Report:
! Select the Summary menu item from the Report menu list. The Summary Report Options screen
will be displayed.
! Select (check) the desired options to include in the report.
! Select the Report command button. The Summary Report will be displayed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

49

GASWorkS 9.0

Menu Items
Table Of Contents

! To browse through the report, adjust the scroll bars with the mouse.
! To close the Report, select the Close command button.
The Data Screens section of this Manual provides detailed descriptions of the features associated with the
Summary Report.

Connectivity - Create A Connectivity Report


GASWorkS provides a routine for reporting how the nodes are interconnected. This relationship between
the nodes is referred to as the "connectivity". To create a Connectivity Report:
! Select the Connectivity menu item from the Report menu list. The Connectivity Report will be
displayed.
! To browse through the report, adjust the scroll bars with the mouse.
! To close the Report, select the Close command button.
The Data Screens section of this Manual provides detailed descriptions of the features associated with the
Connectivity Report.

Property Tables - Report Property Table Data


See the Property Tables topic under the Edit Menu Items description of this Manual.
Note...

This item performs the same function as the Property Tables menu item in the Edit menu list.

Data Check - Find & Report Data Errors


The Data Check menu item allows the results of a previously performed data check to be viewed. To view
the results of a data check:
! Select the Data Check menu item from the Report menu list.
! If a Data Check has not been run, a message will appear asking to execute a Data Check. Select
the Yes command button. The Data Check Specifications screen will be displayed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

50

GASWorkS 9.0

Menu Items
Table Of Contents

! Make any changes, then select the Check command button. The Data Check Report will be
displayed.
! To browse through the report, adjust the scroll bars with the mouse.
! To close the Report, select the Close command button.
The Data Screens section of this Manual provides detailed descriptions of the features associated with the
Data Check Report.

Solution Log - View A Solution Log


During execution of the solution, a log file is created which contains the activity of the Solution routine. The
name of the log file is the same name as the model with the extension of ".slg". This menu item is only
enabled once the Solution routine has been run. To view the contents of a Solution Log Report:
! Select the Solution Log menu item from the Report menu list. The Solution Log Report will be
displayed.
! To browse through the report, adjust the scroll bars with the mouse.
! To close the Report, select the Close command button.
The Data Screens section of this Manual provides detailed descriptions of the features associated with the
Solution Log Report.

Report Options - Set Report Format Options


GASWorkS allows the User to specify various report format options, including the number of decimal places
that are used when displaying the various data and analysis results, or the increment value for the display of
the pressure drop per unit length value. These settings are referred to as the Report Options. To set the Report
Options:
! Select the Report Options menu item from the Report menu list. The Report Options screen will
be displayed.
! Enter or select (check) the desired settings.
! Select the Close command button to save any changes and close the screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

51

GASWorkS 9.0

Menu Items
Table Of Contents

The Data Screens section of this Manual provides detailed descriptions of the features associated with the
Report Options screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

52

GASWorkS 9.0

Menu Items
Table Of Contents

Graphics - Accessing The Graphic Data Interface (GDI)


The Graphic Data Interface (GDI) allows graphical entry and editing of the various data associated with a
model. The GDI provides a map style display of the model and allows point-and-click access to the
associated model data. The features associated with the GDI are fully described in the Graphic Data
Interface section of this Manual.
Various GDI functions are located under the Graphics menu heading. The routines found in the Graphics
menu list are described in the following sections.

View/Edit - View & Edit The Model Data


GASWorkS provides graphical access to the model data and schematic through the GDI Window. If the
model data was entered graphically, or the nodes have otherwise been assigned coordinates, a schematic of
the model will be displayed on the GDI Window. To access the GDI Window:
! Select the View/Edit menu item from the Graphics menu list.
! If a model has not been previously opened, a File Selection screen will be displayed. Select or
enter the name of an existing model's file. Remember to include the ".hdr" extension if you manually
enter the name. A warning message will appear if the file is not found.
! When a valid Filename has been selected, or if a model is already open, the GDI Window will be
displayed.
! Use the Scroll icon to pan the view of the schematic, or select one of the various zoom icons from
the View Controls toolbar to enlarge or reduce the view of the schematic.
! Select one of the data access or edit icons to edit and view the model data.
! To close the GDI, select the Close icon in the upper-right corner of the GDI Window.

Settings - Change Graphic Settings


Several of the settings that control the behavior of the GDI are set using the Graphics Settings routine. The
settings are accessed through the Graphic Settings screen. To access the Graphic Settings screen:
! Select the Settings menu item from the Graphics menu list. The Graphic Settings screen will be
displayed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

53

GASWorkS 9.0

Menu Items
Table Of Contents

! Enter or select (check) the desired items and options.


! Select the Close command button to save any changes and close the screen.
The Graphic Data Interface section of this Manual provides a detailed description of the features associated
with the Graphic Settings screen.

Background Settings - Set A Background Image


Various image formats can be used as a background to a model's schematic. The assignment and control of
the background images are performed using the Background Settings routine. To attach, remove, or modify
the display of a background image:
! Select the Background Settings menu item from the Graphics menu list. The Background Image
Settings screen will be displayed.
! To attach an image, select one of the Attach command buttons. A File Selection screen will be
displayed. Select the desired Filename, then select the Continue command button. Make any desired
changes to the settings.
! To remove an image, select (check) the file to be removed from the Attached Background Files
list, then select the Remove command button.
! Select the Apply command button to immediately apply the current settings to the GDI. Select the
Close command button to save any changes and close the screen.
The Graphic Data Interface section of this Manual provides a detailed description of the features associated
with the Background Image Settings screen.

Save Display As Bitmap - Save The Displayed Image


The currently displayed GDI image can be saved to a bitmap file for use with other applications. To save the
GDI display to a bitmap file:
! Select the Save Display As Bitmap menu item from the Graphics menu list. A File Selection screen
will be displayed.
! Either enter or select the name of the file to save the image to. Remember to include the ".bmp"
extension if you manually enter the name. When a valid Filename has been selected, the image will
be saved.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

54

GASWorkS 9.0

Menu Items
Table Of Contents

! A message will appear indicating the result of the Save routine. Select the OK command button
to clear the message.

Save Display To Clipboard - Copy The Displayed Image


The currently displayed GDI image can be saved (copied) to the Windows graphic clipboard. This allows
the image to be pasted into another graphic application. To copy the GDI display to the clipboard:
! Select the Save Display To Clipboard menu item from the Graphics menu list.
! A message will appear indicating the result of the Copy routine. Select the OK command button
to clear the message.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

55

GASWorkS 9.0

Menu Items
Table Of Contents

Utilities - Using The Utility Routines


GASWorkS provides several routines for performing various model support functions. These features are
referred to as Utility routines. They include routines for setting default data values, and performing various
import and export functions. The Utility routines are grouped under the Utilities menu heading. These
routines are described in the following sections.

Set Defaults - Specify The Default Data Values


The initial data and unit values used to populate the various data fields are referred to as the default data.
The Set Defaults routine allows the User to set the values for certain data items which are automatically
populated when a new model is created. To specify the default data values:
! Select the Set Defaults menu item from the Utilities menu list. The Default Data Values screen
will be displayed.
! Select the desired data tab, and either enter or select the appropriate default data or options.
! Select the Close command button to save any changes and close the screen.
Note...

The Set Defaults routine is most commonly used to set default data values and dimensional units
before entering data. The default data values will be used when a new feature is added. However,
the routine can also be used to change the data values for existing features by selecting the
appropriate Apply Values command button. Be careful using the various Apply command
buttons when features already exist in the model - all associated values will be changed to the
specified default data values.
The Data Screens section of this Manual provides a detailed description of the features
associated with the Default Data Values screen.

Customer Data
The Customer Data submenu contains several Customer Management routines. These routines include the
ability to attach an external database file, update external loads, and to manipulate an attached database using
Standard Query Language commands. These routines are grouped under the Customer Data submenu
heading and are described in the following sections.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

56

GASWorkS 9.0

Menu Items
Table Of Contents

Attribute File - Attach An Attribute File


GASWorkS maintains various model related customer data as part of its model files. It allows non-model
data (referred to as attribute data), to be contained in an external database file. The required connection
information is specified using the Customer Attribute File routine. To attach (or un-attach) an attribute file:
! Select the Attribute File menu item from the Customer Data submenu of the Utilities menu list.
The Customer Attribute Settings screen will be displayed.
! Either enter or select the appropriate data.
! Select the Close command button to save any changes and close the screen.
The Attribute Data section of this Manual provides a detailed description of the features associated with the
Customer Attribute Settings screen.

Update External Loads - Assign & Update Node Loads


Customer loads are assigned to node loads through the external node load parameter. Sometimes, especially
after new data has been imported or changed using the SQL Update routine, these assignments need to be
updated. The Update External Loads routine provides two functions, first if an external attribute file is
attached, the routine will update the total load value for each of the customers, second it will reassign the
total load value for each of the customers to the appropriate external node value. To update the load
assignments:
! Select the Update External Loads menu item from the Customer Data submenu of the Utilities
menu list.
! If an external attribute file is attached, a warning message will appear asking to set the customer
total load value to zero where a match is not found in the attribute file. Select the Yes command
button to zero the loads, or select the No command button to leave unmatched features unchanged.
! A message will appear when the update is complete. Select the OK command button to clear the
message.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

57

GASWorkS 9.0

Menu Items
Table Of Contents

Execute SQL Statement - Update Attribute Values


If a customer attribute file is attached, values in the attribute file can be changed using an SQL Statement.
SQL is an acronym for Standard Query Language which is a special language for manipulating and
modifying data in a SQL compatible database. This feature is useful for changing customer load values
contained in the attribute file, based on a special relationship or calculation method. To update values in an
attribute file:
! Select the Execute SQL Statement menu item from the Customer Data submenu of the Utilities
menu list. The Define SQL Update Specification screen will be displayed.
! Either enter the desired SQL statement or select a previously saved SQL statement, then select the
Execute command button.
! A message will appear when the statement processing is complete. Select the OK command button
to clear the message.
The Data Screens section of this Manual provides a detailed description of the features associated with the
Define SQL Update Specification screen.

Pipe Data
The Pipe Data submenu contains several Pipe Management routines. These routines include the ability to
attach an external database file, and to manipulate an attached database using Standard Query Language
commands. These routines are grouped under the Pipe Data submenu heading and are described in the
following sections.

Attribute File - Attach An Attribute File


GASWorkS maintains various model related pipe data as part of its model files. It allows non-model data
(referred to as attribute data), to be contained in an external database file. The required connection
information is specified using the Pipe Attribute File routine. To attach (or un-attach) an attribute file:
! Select the Attribute File menu item from the Pipe Data submenu of the Utilities menu list. The
Pipe Attribute Settings screen will be displayed.
! Either enter or select the appropriate data.
! Select the Close command button to save any changes and close the screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

58

GASWorkS 9.0

Menu Items
Table Of Contents

The Attribute Data section of this Manual provides a detailed description of the features associated with the
Pipe Attribute Settings screen.

Execute SQL Statement - Update Attribute Values


If a pipe attribute file is attached, values in the attribute file can be changed using an SQL Statement. SQL
is an acronym for Standard Query Language which is a special language for manipulating and modifying data
in a SQL compatible database. To update values in an attribute file:
! Select the Execute SQL Statement menu item from the Pipe Data submenu of the Utilities menu
list. The Define SQL Update Specification screen will be displayed.
! Either enter the desired SQL statement or select a previously saved SQL statement, then select the
Execute command button.
! A message will appear when the statement processing is complete. Select the OK command button
to clear the message.
The Data Screens section of this Manual provides a detailed description of the features associated with the
Define SQL Update Specification screen.

Import/Export - Importing & Exporting Files


GASWorkS provides various Import and Export routines for exchanging data with other applications through
a variety of file formats. These routines are controlled through the Import/Export screen. To import or export
model data:
! Select the Import/Export menu item from the Utilities menu list. The Import/Export screen will
be displayed.
! Select the desired file format from the File Type list.
! Select the appropriate command button to translate the GASWorkS data into or from another file
format. A File Selection screen will be displayed.
! Select the desired source and target files. Select the Continue command button to proceed with
the translation.
! Depending on the specified file type, additional data screens may be displayed to further define
the import or export specification. After the translation is complete, select the Close command button
to close the routine.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

59

GASWorkS 9.0

Menu Items
Table Of Contents

The Import & Export section of this Manual provides a detailed description of the features associated with
the various Import and Export screens.

Data Check - Check The Model Data


GASWorkS provides an extensive Data Check routine. The routine checks for out-of-bounds conditions as
well as general data entry and connectivity errors. The Data Check routine is controlled through the Data
Check Specifications screen. To perform a check of a model's data:
! Select the Data Check menu item from the Utilities menu list. The Data Check Specifications
screen will be displayed.
! Either enter or select (check) the desired settings.
! Select the Check command button to proceed with the data check.
! When the check is complete, a warning message will appear, indicating whether errors were
encountered. If errors were found, select the Yes command button to view the Data Check Report,
or select the No command button to close the screen without viewing the report.
The Data Screens section of this Manual provides a detailed description of the features associated with the
Data Check Specifications screen and Report.

Miscellaneous
Several routines are provided to perform miscellaneous utility functions. These routines are contained in the
Miscellaneous submenu of the Utilities menu list. These routines are described in the following sections.

Check Connectivity
GASWorkS maintains model connectivity information on a continuous basis as features are added and
removed from the model. Occasionally however, this connectivity information may become corrupt. This
can happen if a solution is abnormally terminated, or if the pipe or node data files are manipulated by an
outside application. GASWorkS provides a routine for checking for corrupt connectivity. Additionally, the
routine will delete any unused nodes found in the node data. To check the model connectivity:
! Select the Check Connectivity menu item from the Miscellaneous submenu of the Utilities menu
list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

60

GASWorkS 9.0

Menu Items
Table Of Contents

!A message will appear when the check is complete. Select the OK command button to clear the
message.

Renumber Nodes
GASWorkS provides a routine that allows a model's node numbers (names) to be automatically changed
based on User specified criteria. The routine is controlled through the Renumbering Specifications screen.
To renumber a model's nodes:
! Select the Renumber Nodes menu item from the Miscellaneous submenu of the Utilities menu list.
The Renumbering Specifications screen will be displayed.
! Enter the desired Starting Number and Increment Value, then select the Renumber command
button.
! When the Renumbering routine is complete, select the Close command button to close the screen.
The Data Screens section of this Manual provides a detailed description of the features associated with the
Renumbering Specifications screen.

Calculate XYs
GASWorkS provides a routine that allows XY coordinate values to be automatically added to a file that does
not already possess coordinate values. This routine is intended to provide rough coordinate values to a text
only style model. To add coordinates to a model:
! Select the Calculate XYs menu item from the Miscellaneous submenu of the Utilities menu list.
The XY Calculation screen will be displayed.
! Enter the name of the desired Starting Node, then select the Calculate command button.
! A message will appear when the calculation is complete. Select the OK command button to clear
the message.
! Select the Close command button to close the screen.
The Data Screens section of this Manual provides a detailed description of the features associated with the
XY Calculation screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

61

GASWorkS 9.0

Menu Items
Table Of Contents

Sort Model
GASWorkS provides a variety of sorting options for reordering the pipes and nodes in the model data files.
The sort feature is controlled through the Sort Specifications screen. To sort the currently open model's data
files:
! Select the Sort Model menu item from the Miscellaneous submenu of the Utilities menu list. The
Sort Specifications screen will be displayed.
! Select the desired sort method from the list, then select the Sort command button.
! A message will appear when the sort is complete. Select the OK command button to clear the
message.
The Data Screens section of this Manual provides a detailed description of the features associated with the
Sort Specifications screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

62

GASWorkS 9.0

Menu Items
Table Of Contents

Window - Window (Screen) Access Utilities


Several utilities are provided for arranging and accessing any open windows (screens). These routines are
grouped under the Window menu heading. These routines are described in the following sections.

Arrange Icons
When several screens are minimized to an icon, it is sometimes helpful to have the icons automatically
arranged for easier viewing. Select the Arrange Icons menu item from the Window menu list to automatically
arrange any displayed icons. The icons will be placed along the bottom of the GASWorkS main screen.

Arrange Screens - Arrange Open Screens


When several screens are open and overlapping, it is sometimes helpful to have the screens automatically
arranged for easier viewing. Select the Arrange Windows menu item from the Window menu list to
automatically arrange any open screens. The screens will be placed in a stacked arrangement.

Windows List - Access Open Screens


A list of open screens is placed at the bottom of the Window menu list. When several screens are open and
overlapping, it is sometimes difficult to access a specific screen. A screen may be easily and quickly accessed
by selecting its name from the window list. When a screen name is selected, it is moved on top (or in front)
of the other screens.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

63

GASWorkS 9.0

Menu Items
Table Of Contents

Help - Use The Help Resources


GASWorkS provides an extensive Help System and Help Guide which describes various examples and howto tips. The Help Guide and Help System are designed to compliment the documentation contained in the
Users Manual - not replace it. The Help routines are grouped under the Help menu heading. These routines
are described in the following sections.

Contents - Access The Help Topics


The items or subjects contained in the GASWorkS Help System are referred to as topics. The topics are
accessed through the Help Topics screen. This screen contains three tabbed sections which provide three
separate methods for accessing the contents of the Help System. The easiest and quickest method of
accessing a specific topic is by using the Help Index. To access a topic using the Help Index:
! Select the Contents menu item from the Help
menu list. The Help Topics screen will be
displayed.
! Select the Index tab. The Help Index list will
be displayed.
! Type the first few letters of the subject or
item that you would like to find. Any matching
items in the list will be displayed at the top of
the list. Or, use the scroll bar to browse through
the list until you find the subject or item that
you are interested in.
! When the desired subject has been found,
select the Display command button. If only one
topic is associated with the subject, the topic
will be displayed immediately. If more than one
topic is associated with the subject, a list of related topics will be displayed. Select the desired topic
from the list and then select the Display command button to view the topic.
! On the Topic Display screen, select the Print command button to print the contents of the topic.
Or, select the Exit menu item from the File menu list to close the screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

64

GASWorkS 9.0

Menu Items
Table Of Contents

View Help Guide


Depending on how GASWorkS was installed, an electronic copy (PDF version) of the Help Guide may
have been installed in the GASWorkS application directory. If the guide was installed, this item will be
enabled. Select this item to display the Help Guide.
If the Help Guide was not installed during the installation process, a copy of the Help Guide may be manually
downloaded from our website www.b3pe.com. When manually installing the file, copy the file to the
GASWorkS application directory (\Program Files\GASWorkS 9\app or \Program Files (X86)\GASWorkS
9\app).
Note...

A compatible version of Adobe Acrobat Reader or an equivalent application must be installed


to use this feature.

Using Help - Instructions For Using Help System


If you need help understanding how to use and navigate the Help System, select the Using Help menu item
from the Help menu list. When selected, the Help Topics screen will be displayed. Select the Contents tab,
a table of contents will appear. Select the Using Help book from the list by double-clicking on the
associated book icon. Now either select a topic contained in the book, or select the Print command button
to print the contents of the Using Help book.

Technical Support - How To Reach Us


Several support options are contained in the Technical Support submenu. These items are described in the
following sections.

Contact Information
To view the Technical Support Contact Information, select the Contact Information menu item from the
Technical Support submenu of the Help menu list. Our Contact Information will be displayed on the
Technical Support screen. Select the OK command button to close the screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

65

GASWorkS 9.0

Menu Items
Table Of Contents

Request Registration Number


When the software is first started after being installed, it will request the User to enter a Registration
Number. The Registration Number can be requested from the Registration screen on the initial start-up of
the software. If a Registration Number needs to be requested at another time, select the Request Registration
Number menu item from the Technical Support submenu of the Help menu list. A pre-generated email will
be displayed, requesting the new number. Review the contents of the email, then send the email after
making any desired changes. We will process the request and respond at our earliest convenience.

Send Help Request


To send a help request to us, select the Send Help Request menu item from the Technical Support submenu
of the Help menu list. If a model is currently open, a message will appear asking to bundle the current model
- respond appropriately. A blank email will be generated and displayed. Describe the nature of your problem
or issue in the body (content) section of the email. When possible, it is best to attach a bundled copy of the
model to the email. After completing the problem description and attaching the bundled model, send the
email. We will reply to the help request at our earliest convenience.
Note...

The help request will automatically attach a file containing the About GASWorkS information,
and optionally a bundle (.zip file) of the model to the email.

View Demonstration Guide


Depending on how GASWorkS was installed, an electronic copy (PDF version) of the Demonstration
Guide may have been installed in the GASWorkS application directory. If the Demonstration Guide was
installed this item will be enabled. Select this item to display the Demonstration Guide.
If the Demonstration Guide was not installed during the installation process, a copy of the Demonstration
Guide may be manually downloaded from our website www.b3pe.com. When manually installing the file,
copy the file to the GASWorkS application directory (\Program Files\GASWorkS 9\app or \Program Files
(X86)\GASWorkS 9\app).
Note...

A compatible version of Adobe Acrobat Reader or an equivalent application must be installed


to use this feature.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

66

GASWorkS 9.0

Menu Items
Table Of Contents

View Users Manual


Depending on how GASWorkS was installed, an electronic copy (PDF version) of the Users Manual may
have been installed in the GASWorkS application directory. If the Users Manual was installed this item will
be enabled. Select this item to display the Users Manual.
If the Users Manual was not installed during the installation process, a copy of the Users Manual may be
manually downloaded from our website www.b3pe.com. When manually installing the file, copy the file to
the GASWorkS application directory (\Program Files\GASWorkS 9\app or \Program Files
(X86)\GASWorkS 9\app).
Note...

A compatible version of Adobe Acrobat Reader or an equivalent application must be installed


to use this feature.

About GASWorkS - Setup & Version Information


Select this item to display the version and setup information about your current GASWorkS installation.
Select the OK command button to close the information screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

67

GASWorkS 9.0

Menu Items
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

68

GASWorkS 9.0

Data Screens
Table Of Contents

DATA SCREENS

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

69

GASWorkS 9.0

Data Screens
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

70

GASWorkS 9.0

Data Screens
Table Of Contents

The previous section described the function of the GASWorkS menu items. In that section, numerous data
and specifications screens were introduced. This section provides a detailed description of many of those
screens. Separate sections are also provided for the more extensive routines and functional groups. The
descriptions are listed in alphabetical order based on the screen name.

Bundle Specifications Screen


A routine is provided that allows the various files associated with a model to be bundled (zipped) into a
single file. The Bundle routine is controlled by the Bundle Specifications screen. The screen is accessed by
selecting the Bundle A Model menu item from the Bundle submenu of the File menu list. The features
associated with the screen are described as follows.

Data Items
Exclude Backup Files - A checkbox used to indicate whether the backup files will be excluded in the
bundled file. Select (check) this option if desired.
Include Assigned Attribute Field Lists - A checkbox used to indicate whether the assigned attribute field
lists will be included in the bundled file. Select (check) this option if desired.
Include Assigned Property Tables - A checkbox used to indicate whether the currently assigned Property
Tables will be included in the bundled file. Select (check) this option if desired.
Include Attached Attribute Files - A checkbox used to indicate whether the attached attribute files will be
included in the bundled file. This option will only be displayed if a customer or pipe attribute file is attached.
Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

71

GASWorkS 9.0

Data Screens
Table Of Contents

Include Attached Background Image Files - A checkbox used to indicate whether any attached background
image files will be included in the bundled file. This option will only be displayed if one or more background
image files are attached. Select (check) this option if desired.
Include Model Files - A checkbox used to indicate whether the model files will be included in the bundled
file. Select (check) this option if desired.

Command Buttons
Continue - A command button used to proceed with the Bundle routine and create the bundled file. A
message will appear when the process is complete.
Cancel - A command button used to close the screen without creating a bundled file.

Notes & Considerations


! The contents of the options list will vary depending on what features are being used with the associated
model.
! The file created by the Bundle routine will be located in the same directory as the model, will have the
same name as the model, and will end in a .zip extension. The bundled files format is PKZip 2.04g
compatible. The file can be unbundled (unzipped) using the Unbundle A Model menu item from the Bundle
submenu of the File menu list, or it may be unzipped using any compatible file compression program.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

72

GASWorkS 9.0

Data Screens
Table Of Contents

Connectivity Report
The interconnectivity of a model may be displayed and printed using the Connectivity Report. The report
is accessed by selecting the Connectivity menu item from the Report menu list. The features associated with
the report are described as follows.

Displayed Items
Record # - Refers to the position of the current node record in the node data file. This value is automatically
assigned and cannot be changed by the User.

Command Buttons & Icons


Close - A command button used to close the report.
Find - An icon used to find a record in the report by Node Name. When selected, the Find screen
will be displayed. Enter the desired Node Name, then select the Search command button. To find
another occurrence of the Node Name, select the Find Next command button.
Go To - An icon used to display a specific Record Number at the top of the report. When
selected, the Go To screen will be displayed. Enter the Record Number to be displayed, then
select the Continue command button.
Maximize Window Size - An icon used to cause the reports window size to be increased to fill
the GASWorkS display screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

73

GASWorkS 9.0

Data Screens
Table Of Contents

Print - An icon used to print the contents of the report. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.
Reset Window Size - An icon used to cause the reports window size to be normalized or
reduced to its standard size.

Notes & Considerations


! The number of columns in the report will vary according to the largest number of connected nodes.
! If the report is too wide to print, reduce the column widths by adjusting their width using the mouse, set
the printer to use landscape mode, and reduce the printer font size. If no adjustment is made to the reports
width, the report will be printed on multiple pages.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

74

GASWorkS 9.0

Data Screens
Table Of Contents

Customer Data Report


When selected, the Standard Report routine creates several report sections, one each for the contents of the
Header, Customer, Node, and Pipe data files. The Customer Data Report is accessed by selecting the
Customer menu item from the Standard (Select) submenu of the Report menu list. The features associated
with the Customer Data Report section of the Standard Report are described as follows.

Hydraulic Tab

Data Items
Adjust Load By Design Factor - Indicates that the nodes base load value will be multiplied by the Design
Factor during the solution process. The original data value is not changed by this setting, the load value is
only modified during the solution calculation. To set a value, click in the associated data cell till the desired
option is displayed.
Application - Specifies how to apply the customers load. To select a value, click in the associated data cell,
then select an item from the list.
Both - Indicates that one-half of the load will be applied to the external load value of the assigned
pipes From and To Node.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

75

GASWorkS 9.0

Data Screens
Table Of Contents

Diversified - Indicates that the load will be applied to the pipes downstream node according to
the associated IGE standard. Select an appropriate Diversified option and heating style type from
the list.
From - Indicates that the entire load will be applied to the external load value of the assigned pipes
From Node.
To - Indicates that the entire load will be applied to the external load value of the assigned pipes
To Node.
Customer Link ID Number - Specifies an identification number used to link to an external database. When
a linked database is attached, the number is automatically assigned. When any other type of external
database is attached, the number is assigned by the User. The number should generally represent a value that
is unique in the database. When no external database is attached, the number can be used to maintain any
User desired alphanumeric value. The value can be a combination of up to twenty (20) alphanumeric
characters. To enter a value, click in the associated data cell, then type the desired value.
Load - Specifies the load for each customer unit. If no database is attached, the item may be manually
entered by the User. Otherwise, the item will be automatically assigned. To enter a value, click in the
associated data cell, then type the desired value. Use a negative value to indicate a demand (flow leaving the
system). Or, use a positive value to indicate a supply (flow entering the system). If the load is manually
entered, ensure that the value is expressed in terms of the selected dimensional unit.
Load Units - Specifies the dimensional unit for the Load value. To select a value, click in the associated data
cell, then select an item from the list.
Status - Indicates the status of the connection between the model and the attribute file. If the status is turned
Off, the connection will be disabled until turned back On. To set a value, click in the associated data cell
till the desired option is displayed.
Unit Count - Specifies the total number of units (customers) that the selected individual customer represents.
The value must be in the range of 1 to 32,000. To enter a value, click in the associated data cell, then type
the desired value.
X Coordinate - Specifies the customers horizontal location (east-west coordinate). To enter a value, click
in the associated data cell, then type the desired value. Ensure that the value is expressed in terms of the
assigned dimensional unit.
Y Coordinate - Specifies the customers vertical location (north-south coordinate). To enter a value, click
in the associated data cell, then type the desired value. Ensure that the value is expressed in terms of the
assigned dimensional unit.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

76

GASWorkS 9.0

Data Screens
Table Of Contents

Calculated Values
Branch ID - If the selected customer is a trunk customer, this item represents the ID Number of the branch
customer assigned to it. This value is automatically assigned and cannot be changed by the User.
ID Number - Displays the customers unique internal (to GASWorkS) identification number. This value is
automatically assigned and cannot be changed by the User.
Supply Pipe (Main) Link ID Number - Displays the Link ID number of the pipe (main) that supplies the
customer - the pipe that the customer is assigned to. The customers load will be assigned to the external load
of the pipes From and To Node as specified by the Load Application setting. This value cannot be changed
by the User. If the assigned pipe does not have an assigned Link ID value, the record number of the
assigned pipe will be displayed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

77

GASWorkS 9.0

Data Screens
Table Of Contents

Attribute Tab
The Attribute tab of the Customer Data Report displays the associated attribute file data. If a linked or
external database is attached, these items will display the values contained in the linked database record.
If a linked database is attached, the values can be changed by the User. If the attached database is of another
type, the values are view-only and cannot be changed by the User. To edit a value, click in the associated data
cell, then make the change - click another data cell or press the Enter key to save the change.

Calculated Values
ID Number - Displays the customers unique internal (to GASWorkS) identification number. This value is
automatically assigned and cannot be changed by the User.
Pipe Facility Type - Displays the assigned Facility Type of the pipe (main) that the customer is attached to.
The customer inherits the same Facility Type as the assigned pipe (main). This value is automatically
assigned and cannot be changed by the User.

Displayed Items
Record # - Refers to the position of the current customer record in the customer data file. This value is
automatically assigned and cannot be changed by the User.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

78

GASWorkS 9.0

Data Screens
Table Of Contents

Command Buttons & Icons


Close All Reports - A command button used to close all sections of the Standard Report.
Close This Report - A command button used to close the Customer Data Report while leaving any other
sections of the Standard Report open.
Copy Current Selection - An icon used to extract (copy) the currently selected (highlighted)
customer records into a new or existing model.

Delete Customer - An icon used to delete the currently selected (highlighted) customer record.

Delete Current Selection - An icon used to delete the currently selected (highlighted) records.

Find - An icon used to find a record in the report by Link ID Number. When selected, the Find
screen will be displayed. Enter the desired Link ID Number, then select the Search command
button. To find another occurrence of the Link ID Number, select the Find Next command button.
Find Customer - An icon used to find and flag the currently selected (highlighted) customer
record on the GDI Window. This icon is only displayed if the GDI Window is open before the
report is opened.
Go To - An icon used to display a specific Record Number at the top of the report. When
selected, the Go To screen will be displayed. Enter the Record Number to be displayed, then
select the Continue command button.
Make Selection Set - An icon used to create a selection set of customers which meet a specified
selection criteria. When selected, the Query Specifications screen will be displayed. Enter the
desired selection criteria, then select the Perform Query command button.
Maximize Window Size - An icon used to cause the reports window size to be increased to fill
the GASWorkS display screen.

Oops (Undelete) - An icon used to restore (undelete) a recently deleted customer record.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

79

GASWorkS 9.0

Data Screens
Table Of Contents

Print - An icon used to print the contents of the report. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.
Reset Selection Set - An icon used to clear (reset) the current selection set. When selected, all
the reportable customer records will now be displayed in the report.

Reset Window Size - An icon used to cause the reports window size to be normalized or
reduced to its standard size.

Restore Columns - An icon used to restore the display of all the columns (data items). When
selected, all of the columns associated with the report will now be displayed in the report.

Set Columns - An icon used to specify which columns (data items) to display in the report. When
selected, the Columns screen will be displayed. Select (check) the data items to be displayed, then
select the Apply command button. Note - Column display widths can be adjusted by dragging the
column separator lines.
Sort Ascending - An icon used to sort the records in ascending order (A to Z) based on the ID
Number values.

Sort Descending - An icon used to sort the records in descending order (Z to A) based on the ID
Number values.

Undo - An icon used to undo (restore) the most recent data change.

Notes & Considerations


! In addition to using the Set Columns routine, the report can also be modified by adjusting or "collapsing"
a column. To adjust a column, place the mouse cursor on the vertical line separating the desired column from
the next adjacent column. The cursor will change appearance. While holding down the left mouse button,
drag the column line to the new desired position. To collapse a column, follow the procedures outlined
above, except that when dragging the column line, drag it all the way to the left - the column will then be
collapsed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

80

GASWorkS 9.0

Data Screens
Table Of Contents

! To make the Customer Data Report activate (the window on the top of the report stack), click on any
visible portion of report's screen, or select the report from the Window menu list.
! If an attribute file is attached, the contents of the file will be displayed on the Attribute tab of the report.
Depending on the type of file attached, the attribute data values may or may not to be allowed to be edited
by the User.
! Normally the report contains more information than will fit on a single page. If this condition occurs when
trying to print, a warning message will appear. When the warning appears, select the desired option. To print
a report that is too wide for the printer, eliminate some of the uninteresting columns from the report using
the Set Columns routine, or by manually collapsing undesired columns, reduce the column widths by
adjusting their width using the mouse, set the printer to use landscape mode, and reduce the printer font size.
If no adjustment is made to the reports width, the report will be printed on multiple pages.
! Only data items associated with customers attached to pipes that are assigned Facility Types that are
active can be edited in the report. The Facility Settings can be viewed and changed using the Facility
Settings menu item found in the Edit menu list, or the Report Options menu item found in the Report menu
list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

81

GASWorkS 9.0

Data Screens
Table Of Contents

Data Check Report


Errors encountered during the Data Check routine are written to a file known as the Data Check file. The
file contains a log of the errors which were encountered during the check. The contents of the file can be
viewed using the Data Check Report. The report is accessed by selecting the Data Check menu item from
the Report menu list. The features associated with the report are described as follows.

Command Buttons & Icons


Close - A command button used to close the report.
Copy To Clipboard - An icon used to copy the contents of the report to the Windows clipboard.
A message will appear when the data has been copied, select the OK command button to clear the
message. Once copied the contents may be pasted to another application.
Maximize Window Size - An icon used to cause the reports window size to be increased to fill
the GASWorkS display screen.

Print - An icon used to print the contents of the report. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

82

GASWorkS 9.0

Data Screens
Table Of Contents

Reset Window Size - An icon used to cause the reports window size to be normalized or
reduced to its standard size.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

83

GASWorkS 9.0

Data Screens
Table Of Contents

Data Check Specifications Screen


The Data Check routine is controlled by the Data Check Specifications screen. The screen is accessed by
selecting the Data Check menu item from the Report menu list. The screen will only appear the first time the
Data Check routine is executed. The features associated with the screen are described as follows.

Pipe Tab

Data Items
Connectivity - A checkbox used to indicate whether the model connectivity will be included in the data
check. Select (check) this option if desired.
Maximum - A group of data fields used to specify the maximum (entered) value for the associated data
items.
Minimum - A group of data fields used to specify the minimum (entered) value for the associated data items.
Pipe Data - A checkbox used to indicate whether the pipe data values will be included in the data check.
Select (check) this option if desired.
Diameter - A group of data fields used to specify the minimum and maximum pipe diameter values.
Enter the associated values by typing them into the data fields. Ensure the values are expressed in
terms of the assigned dimensional unit.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

84

GASWorkS 9.0

Data Screens
Table Of Contents

Efficiency - A group of data fields used to specify the minimum and maximum pipe efficiency
values. Enter the associated values by typing them into the data field. Ensure the values are
expressed in terms of the assigned dimensional unit.
Length - A group of data fields used to specify the minimum and maximum pipe length values.
Enter the associated values by typing them into the data fields. Ensure the values are expressed in
terms of the assigned dimensional unit.
Pipe Property Table - A checkbox used to indicate whether a check will be performed to ensure
that each size/type value found in the pipe data, exists in the associated Property Table. Select
(check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

85

GASWorkS 9.0

Data Screens
Table Of Contents

Node Tab

Data Items
Check For Large Flow Balance Errors - A checkbox used to indicate whether large node errors will be
included in the data check. Select (check) this option if desired.
Maximum - A group of data fields used to specify the maximum (entered) value for the associated data
items.
Minimum - A group of data fields used to specify the minimum (entered) value for the associated data items.
Node Data - A checkbox used to indicate whether the node data values will be included in the data check.
Select (check) this option if desired.
Elevation - A group of data fields used to specify the minimum and maximum node elevation
values. Enter the associated values by typing them into the data fields. Ensure the values are
expressed in terms of the assigned dimensional unit.
Pressure - A group of data fields used to specify the minimum and maximum node pressure values.
Enter the associated values by typing them into the data fields. Ensure the values are expressed in
terms of the assigned dimensional unit.
Temperature - A group of data fields used to specify the minimum and maximum node (gas
flowing) temperature values. Enter the associated values by typing them into the data fields. Ensure
the values are expressed in terms of the assigned dimensional unit.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

86

GASWorkS 9.0

Data Screens
Table Of Contents

Total Load - A group of data fields used to specify the minimum and maximum node total load
values. Enter the associated values by typing them into the data fields. Use a negative value to
indicate a demand (flow leaving the system). Or, use a positive value to indicate a supply (flow
entering the system). Ensure the values are expressed in terms of the assigned dimensional unit.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

87

GASWorkS 9.0

Data Screens
Table Of Contents

Customer Tab

Data Items
Check For Redundant Link ID Numbers - A checkbox used to indicate whether redundant Link ID
Number values will be included in the data check. Select (check) this option if desired.
Check For Redundant Customer Locations - A checkbox used to indicate whether redundant customer
location values will be included in the data check. Select (check) this option if desired.
Customer Data - A checkbox used to indicate whether the customer data values will be included in the data
check. Select (check) this option if desired.
Per Unit Load - A group of data fields used to specify the minimum and maximum load values for
each customer unit. Enter the associated values by typing them into the data fields. Use a negative
value to indicate a demand (flow leaving the system). Ensure the values are expressed in terms of
the assigned dimensional unit.
Unit Count - A group of data fields used to specify the minimum and maximum total number of
units (customers) that the selected individual customer represents. Enter the associated values by
typing them into the data fields. The values must be in the range of 1 to 32,000.
Maximum - A group of data fields used to specify the maximum (entered) value for the associated data
items.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

88

GASWorkS 9.0

Data Screens
Table Of Contents

Minimum - A group of data fields used to specify the minimum (entered) value for the associated data items.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

89

GASWorkS 9.0

Data Screens
Table Of Contents

Other Tab

Data Items
Graphically Flag Items With Errors - A checkbox used to indicate whether the flag symbols will be placed
on features that contain errors. Select (check) this option if desired. The flags can be viewed in the GDI
Window. Use the Clear Error Flags command to turn the error flags off.
Only Include Facilities Set To Report - A checkbox used to indicate whether only the features associated
with facility types that are set for reporting, will be included in the data check. Select (check) this option if
desired.

Command Buttons
Check - A command button used to execute the Data Check routine. A message will appear when the check
is complete. If errors are encountered, a message will appear asking to display the Data Check Report. Select
an appropriate response.
Close - A command button used to close the screen without performing the data check.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

90

GASWorkS 9.0

Data Screens
Table Of Contents

Notes & Considerations


! The Data Check routine allows the model data to be screened for out-of-bounds, connectivity, and general
errors. The routine does not perform any corrections of the data, it only identifies the errors it encounters and
creates a report of its findings. Some of the checks performed are described in the following table.
Check Type

Reported Errors

Connectivity

Pipes with bad node record numbers.


Node connected to more than four pipes.
Node connected to more than six pipes.
Node not connected to any pipe.
Node connected to itself.
Redundant pipes.
Dead-end node with zero load value.

Customer

Missing attribute file (if assigned).


Corrupt supply main assignment.
Invalid dimensional units.
Positive Per Unit Load value.
Out-of-bounds values - Values that either exceed the specified maximum
value, or are less than the specified minimum value.
Warning if status is set to Off.
Multiple customers at the same location.
Invalid Link ID value.

Node

Missing or empty node data file.


Redundant node names.
Out-of-bounds values - Values that either exceed the specified maximum
value, or are less than the specified minimum value.
Both pressure and load values are known or unknown.
Invalid dimensional units.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

91

GASWorkS 9.0

Data Screens
Table Of Contents

Check Type

Reported Errors
Multiple nodes at the same location.
Warning if the status is set to Off for the base or external load.

Pipe

Missing or empty pipe data file.


Missing Property Tables.
Invalid from or to node record numbers.
Size/Type not found in the Property Tables.
Multiple Size/Type matches in the Property Tables.
Out-of-bounds values - Values that either exceed the specified maximum
value, or are less than the specified minimum value.
Invalid pipe flow equation value.
Warning if status set to Off.
Invalid dimensional units.
Large diameter to length ratio.
Elevation difference greater than length value.
Invalid equivalent length value.
Invalid regulator or compressor set pressure.
Unusual known/unknown settings at the outlet of regulators and
compressors.
Invalid compressor efficiency value.
Invalid or zero valve opening setting.
Invalid well count, equation coefficient, or exponent value.
Unsupported hydraulic type.
Invalid or redundant Link ID value.

! If errors are encountered during the check, an error message will appear. If a message appears, select the
Yes command button to view the report.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

92

GASWorkS 9.0

Data Screens
Table Of Contents

! To view or print the Data Check Report at other times, select the Data Check menu item from the Report
menu list.
! When the Pipe Property Table option is selected (checked), the Data Check routine will search the current
Pipe Property Table for each Size/Type (diameter) value found in the pipe data file. If the value is not found,
an error will be generated. If the value is found, the Data Check routine will check the inside diameter value
to see if it falls within the specified diameter minimum and maximum value limits. If actual inside diameter
values are entered for the Size/Type value, instead of Size/Type Codes, do not select (check) the Pipe
Property Table option.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

93

GASWorkS 9.0

Data Screens
Table Of Contents

Default Data Values Screen


The default data values are used to initially populate the pipe and node data values when creating a new
model or adding new features to an existing model. These values are set using the Default Data Values
screen. The screen can be accessed by selecting the Set Defaults menu item from the Utilities menu list. The
features associated with the screen are described as follows.

Hydraulic Data Tab

Data Items
Allow Pipe Sizing - A checkbox used to indicate whether the default pipe sizing option. This setting is used
to indicate which pipes are to be sized when the Calculate Pipe Sizes (Optimize) option is selected during
a solution. Select (check) this option if desired.
Node Base Load - A data field used to enter the default node base load value. Enter a value by typing it into
the data field. Ensure the value is expressed in terms of the assigned dimensional unit. Use a negative value
to indicate a demand (flow leaving the system). Or, use a positive value to indicate a supply (flow entering
the system). If customer features will be used with the model, set the default load value to zero (0).

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

94

GASWorkS 9.0

Data Screens
Table Of Contents

Node Elevation - A data field used to enter the default node elevation value. Enter a value by typing it into
the data field. Ensure the value is expressed in terms of the assigned dimensional unit.
Node Pressure - A data field used to enter the default node pressure value. Enter a value by typing it into
the data field. Ensure the value is expressed in terms of the assigned dimensional unit.
Node Temperature - A data field used to enter the default node (gas flowing) temperature value. Enter a
value by typing it into the data field. Ensure the value is expressed in terms of the assigned dimensional unit.
Pipe Efficiency - A data field used to enter the default pipe efficiency value. Enter a value by typing it into
the data field. Ensure the value is expressed in terms of the assigned dimensional unit.
Pipe Equation - A drop-down list used to select the default pipe flow equation. Select an item from the list.
Pipe Size/Type - A drop-down list used to select the default pipe size/type (diameter) value. Either enter a
value by typing it into the data field, or select an item from the list. If the value is manually entered, ensure
the value is expressed in terms of the assigned dimensional unit.
Value Is Unknown - A checkbox used to indicate whether the associated data value is unknown. Select
(check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

95

GASWorkS 9.0

Data Screens
Table Of Contents

Gas Properties Tab

Data Items
Heating Value - A data field used to enter the default heating value. Enter a value by typing it into the data
field. Ensure the value is expressed in terms of the assigned dimensional unit.
Specific Gravity - A data field used to enter the default specific gravity value. Enter a value by typing it into
the data field. This value is dimensionless.
Specific Heat Ratio - A data field used to enter the default specific heat ratio value. Enter a value by typing
it into the data field. This value is dimensionless.
Viscosity - A data field used to enter the default viscosity value. Enter a value by typing it into the data field.
Ensure the value is expressed in terms of the assigned dimensional unit.
Values Are Unknown - A checkbox used to indicate whether the associated data values are unknown. Select
(check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

96

GASWorkS 9.0

Data Screens
Table Of Contents

Command Button
Calculate Properties From Composition - A command button used to calculate the gas properties from a
known composition. When selected, the Gas Properties screen will be displayed. Enter the desired data,
calculate the values, then select the Apply command button to apply the new values and return to the Default
Data Values screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

97

GASWorkS 9.0

Data Screens
Table Of Contents

Dimensional Units Tab

Data Items
Coordinates - A drop-down list used to select the dimensional units to use for all of the coordinate values.
Select an item from the list.
Diameter - A drop-down list used to select the dimensional units to use for all of the diameter values. Select
an item from the list.
Efficiency - A drop-down list used to select the dimensional units to use for all of the efficiency values.
Select an item from the list.
Elevation - A drop-down list used to select the dimensional units to use for all of the elevation values. Select
an item from the list.
Heating Value - A drop-down list used to select the dimensional units to use for all of the heating values.
Select an item from the list.
Length - A drop-down list used to select the dimensional units to use for all of the length values. Select an
item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

98

GASWorkS 9.0

Data Screens
Table Of Contents

Load - A drop-down list used to select the dimensional units to use for all of the load values. Select an item
from the list.
Node Pressure - A drop-down list used to select the dimensional units to use for all of the node pressure
values. Select an item from the list.
Pipe Flow Rate - A drop-down list used to select the dimensional units to use for all of the flow rate and
capacity values. Select an item from the list.
Pressure Drop - A drop-down list used to select the dimensional units to use for all of the pressure drop
values. Select an item from the list.
Temperature - A drop-down list used to select the dimensional units to use for all of the temperature values.
Select an item from the list.
Velocity - A drop-down list used to select the dimensional units to use for all of the velocity values. Select
an item from the list.
Viscosity - A drop-down list used to select the dimensional units to use for all of the absolute or dynamic
viscosity values. Select an item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

99

GASWorkS 9.0

Data Screens
Table Of Contents

Miscellaneous Tab

Data Items
Node Increment - A drop-down list used to select the node increment value. Select an item from the list.
Pipe Facility Type - A drop-down list used to select the default pipe facility type. Select an item from the
list.
Pipe Sizing Group - A drop-down list used to select the default pipe sizing group. Select an item from the
list.

Command Buttons
Apply All Values - A command button used to apply all of the current default data values to all of the pipes
and nodes in the currently open model. This routine is useful when a new model is created using the wrong
default data values and settings.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

100

GASWorkS 9.0

Data Screens
Table Of Contents

Apply Displayed Values Only - A command button used to apply the current default data values associated
with the currently displayed data tab, to all of the pipes and nodes in the currently open model. This routine
is useful when only a specific set of the default data values need to be set or changed (for example, to reset
the dimensional units).
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save the currently displayed settings.
Retrieve Settings - A command button used to retrieve a previously saved settings. When selected, a File
Selection screen will be displayed. Enter the desired Filename, then select the Continue command button to
apply the saved settings and return to the Default Data Values screen.
Save Settings - A command button used to save the current settings to a data file for use at a later time.
When selected, a File Selection screen will be displayed. Enter the desired Filename, then select the Continue
command button to return to the Default Data Values screen.

Notes & Considerations


! The default data values are used to initially populate the pipe and node data items when a new feature is
added. These include selected default data values that are most commonly used for the system being
modeled. These values and settings may need to be changed from time to time depending on the nature of
the current model.
! Any of the default data values may be overridden as the new features are entered (if the Query During New
Feature Entry graphic setting is selected), or after the data has been entered using any of the data editing
features.
! Customer default data is handled different from the pipe and node data. When a new customer is added,
the data associated with the last customer in the database is used to populate the appropriate data fields for
the new customer. When creating a new model and manually entering customer features, remember to set
the data for the first customer to appropriate values, before adding additional customers.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

101

GASWorkS 9.0

Data Screens
Table Of Contents

Facility Settings Screen


The facility items and settings associated with a model are managed using the Facility Settings screen. The
Facility Settings screen can be accessed by selecting the Facility Settings menu item from the Edit menu list,
or by selecting the Facility Settings menu item from the Preferences submenu of the File menu list. The
features associated with the screen are described as follows.

Data Items
Active - Indicates whether the data features associated with the Facility Name can be changed using the
various Edit routines. Generally, all features associated with a non-active Facility Name, are excluded from
the Edit routines. The exception is that if the Ignore Facility Settings On Mass Update preference setting is
selected (checked), all records will be included in changes made by the Mass Update routine. To set a value,
click in the associated data cell till the desired option is displayed.
Color - Specifies the color to use to display the pipes associated with the Facility Name, when the pipe Line
Color is set to Facility Table. To set a Color, select the Click To Select Color item from the list. The
Color Palette will be displayed. Select the desired color, then select the OK command button. Or, select
Default from the list.
Display - Indicates whether the data features associated with the Facility Name will be displayed in the GDI
Window. To set a value, click in the associated data cell till the desired option is displayed.
Line Style - Specifies the line style to be used to display the pipes associated with the Facility Name, when
the pipe Line Style is set to Facility Table. Select an item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

102

GASWorkS 9.0

Data Screens
Table Of Contents

Line Width - Specifies the line width to be used to display the pipes associated with the Facility Name, when
the pipe Line Width is set to Facility Table. Select an item from the list.
Report - Indicates whether the data features associated with the Facility Name will be included in the various
Report routines. To set a value, click in the associated data cell till the desired option is displayed.
Solve - Indicates whether the data features associated with the Facility Name are included in the Solution
routine. Be careful when excluding features from the solution process, as a non-solvable configuration may
result when excluding portions of the piping system. To set a value, click in the associated data cell till the
desired option is displayed.

Command Buttons & Icons


Add Record - An icon used to add a new record to the end of the item list. After the new item is
added, enter new data by clicking in the associated data cell. Either a data cell or a data list will
appear. Either type the desired value or select an item from the list. Press the Enter key or click
in another data cell to save any changes.
Apply - A command button used to close the screen and apply any changes.
Cancel - A command button used to close the screen without saving any changes.
Delete Record - An icon used to delete the currently selected (highlighted) item.

Insert Record - An icon used to insert a new item just before the currently selected (highlighted)
item. After the new item is inserted, enter new data by clicking in the associated data cell. Either
a data cell or a data list will appear. Either type the desired value or select an item from the list.
Press the Enter key or click in another data cell to save any changes.
Maximize Window Size - An icon used to cause the screens window size to be increased to fill
the GASWorkS display screen.

Move Record - An icon used to move the currently selected (highlighted) item to a new location
in the item list. When selected, a prompt will appear for the new location to move the item to.

Open - An icon used to open a previously saved facility settings file. When selected, a File
Selection screen will be displayed. Enter or select the desired Filename, then select the Open
command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

103

GASWorkS 9.0

Data Screens
Table Of Contents

Reset Window Size - An icon used to cause the screens window size to be normalized or
reduced to its standard size.

Save - An icon used to save the contents of the currently displayed facility settings. When
selected, a File Selection screen will be displayed. Enter or select the desired Filename, then
select the Save command button. Once saved, the list can be opened and used with other models.
Save As Default - A command button used to save the current facility settings as the default settings to be
used when creating a new model.

Notes & Considerations


! The Facility Settings screen lists the facility names (types) associated with the current model or opened
file, and their associated settings. The settings control how the data features associated with a specific type
are handled by the various Report, Display, Edit, and Solution routines.
! Facility Types are primarily assigned to pipe data features. The node and customer features inherit the
Facility Type of the pipe that they are associated with or assigned to.
! Nodes can be associated with several pipe features, and each pipe potentially could possess different
Facility Types and settings. In these cases the node handling varies according to the routine. If at least one
associated pipe possesses a Facility Type that allows a process, then the node is allowed in any associated
activities. For example, if at least one pipe is set to display, the node is displayed - if at least one pipe is set
to report, the node is reported, etc.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

104

GASWorkS 9.0

Data Screens
Table Of Contents

File Selection Screen


GASWorkS uses two types of File Selection screens - one type is used for accessing model (header) files,
and one is used for accessing support and other file types. The screen is accessed by selecting the various
menu items in the File menu list. The features associated with the screen are described as follows.

Data Items
Directories - A list box used to specify the directory (folder) on the selected disk drive to look in. Select the
desired directory from the list. When a directory has been selected, any files matching the specified extension
or search pattern will be displayed in the Files list box.
Drives - A drop-down list used to select the disk drive to look in. Select the desired drive from the list. When
a drive is selected, the directories contained on that drive will be listed in the Directories list box.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

105

GASWorkS 9.0

Data Screens
Table Of Contents

File Statistics - A list box used to display the various information about the currently selected (highlighted)
file. The contents of the display will vary depending on the type of the selected file. This item is only
displayed for model file selection.
Filename - A data list used to specify the name of the file to be used. A list of the most previously used files
can be accessed by clicking on the arrow symbol adjacent to the data field. The Filename can be entered by
various means - type the desired name into the data field, select the desired Filename from the list, or use the
Drives, Directories, and Files lists to select the file. If the name is manually entered, include the path and
extension. Names longer than the field will be scrolled to the left. Extension values will vary according to
the file type.
Files - A list box used to display the matching files found in the selected directory (folder) on the selected
disk drive. Select the desired file from the list. When a file has been selected, two methods may be used to
proceed. The first, press the Enter key to display the selected file in the Filename data field. The name may
then be modified if desired. When satisfied with the Filename, select the Continue command button or press
the Enter key to proceed. The second way to proceed is to double-click on the desired file. This method will
cause the highlighted file to be immediately selected, and the File Selection screen to be closed.

Command Buttons
Cancel - A command button used to close the screen without saving any changes. When selected, this will
also cancel the routine that invoked the screen.
Continue - A command button used to accept the selected file and proceed with the associated routine.

Notes & Considerations


! Depending on the routine that invoked the File Selection screen, the response to errors which may occur
while selecting a file will vary. If the routine requires a new Filename and an existing Filename is selected,
the screen will prompt whether the file should be overwritten. If the routine requires the name of an existing
file and the name of a non-existent file is specified, the screen will respond with either a warning message
that the file does not exist, or will prompt whether the file should be created depending on the nature of the
calling routine.
! Wild card characters may be entered in the Filename data field, to alter the contents of the Files list box.
Valid characters are "*" for multi-character replacement, and "?" for single character replacement.
! Drives, Directories, and Filename values must correspond to the standard DOS format. That is, drive
letters must be followed by a colon ":". Directories must be separated by a back slash "\". Extensions must
be proceeded by a dot ".".

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

106

GASWorkS 9.0

Data Screens
Table Of Contents

! When manually entering a value in the Filename data field, include the drive, full path name, Filename,
and extension values.
! The name of the current model is displayed near the top of the main GASWorkS screen.
! If an existing file is chosen to be overwritten, the file is not actually destroyed, it is sent to the Windows
Recycle Bin.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

107

GASWorkS 9.0

Data Screens
Table Of Contents

Find Screen
The Find routine is used by many of the data and report screens. It allows records to be located
by searching for a specified data value. The search criteria is entered using the Find screen. The
screen is accessed by selecting the Find icon from the various screens. The features associated
with the screen are described as follows.

Data Items
Search Value - A data field used to specify the data value to search for. Enter a value by typing it into the
data field. The title of this field and the meaning of the value varies depending on the item being search for,
and which routine opened the screen.

Command Buttons
Cancel - A command button used to close the screen without performing the search.
Find Next - If this command button is enabled, select it to search for another occurrence of the most
previously specified search value.
Search - A command button used to initiate the search.

Notes & Considerations


! When executed the first time, searching begins from the start of the file, for a record matching the search
criteria. If a match is found, the matching record is made current. To find other occurrences, re-execute the
Find routine and select the Find Next command button. If no match is found, a message will appear. Select
the OK command button to clear the message.
! When the Find Next command button is selected, the search begins at the last matching record, then
searches to the end of the file. If no match is found, the search begins again at the beginning of the file and
continues until a match is found, or the entire file has been searched.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

108

GASWorkS 9.0

Data Screens
Table Of Contents

! The Search value varies depending on the data screen or report invoking the Find routine. For pipe data,
both the From and To Node names are searched. For node data, the Node Name values are searched.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

109

GASWorkS 9.0

Data Screens
Table Of Contents

Gas Properties Calculation Screen


GASWorkS provides a routine for calculating the Heating Value, Specific Gravity, Specific Heat Ratio, and
Viscosity based on an entered gas composition. The routine can be accessed from several locations - select
the Calculate Gas Properties menu item from the Analysis menu list, select the Calculate Properties From
Composition command button from the Default Data Values screen, or select the Calculate Property Values
command button from the Node Data screen. The features associated with the screen are described as
follows.

Data Items
Gas Composition - A group of data fields used to enter the individual components found in the gas mixture.
Enter the values by typing them into the various data fields. The values are expressed as mole percentages.
The sum of all of the percentages must equal 100%. If a component does not exist in the gas, leave its data
field empty, or set its value to zero.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

110

GASWorkS 9.0

Data Screens
Table Of Contents

Heating Value Method - A drop-down list used to select which method to use to calculate the heating value.
Select an item from the list. The properties will need to be recalculated if the method is changed.

Calculated Values
Heating - Displays the calculated (gross) heating value associated with the composition. Ensure the value
is expressed in terms of the selected dimensional unit.
Specific Gravity - Displays the calculated specific gravity value associated with the composition. Specific
Gravity is a dimensionless value which represents the ratio of the weight of the gas composition, compared
to dry air.
Specific Heat Ratio - Displays the calculated ratio of specific heat values associated with the composition.
The value represents the ratio of the constant pressure specific heat to the constant volume specific heat. This
value is dimensionless.
Viscosity - Displays the calculated (absolute or dynamic) viscosity value associated with the composition.
Ensure the value is expressed in terms of the selected dimensional unit.

Command Buttons
Apply - The function of this button varies depending on the source that opened the screen. If the screen was
accessed from the Analysis menu list, selecting this command button applies the calculated gas properties
values to all of the nodes in the current model. If the screen was accessed from the Default Data Values
screen, selecting this command button will apply the calculated values to the default gas properties. If the
screen was accessed from the Node Data screen, selecting this command button will apply the calculated
values to the currently selected node.
Calculate - A command button used to calculate the various gas property values.
Clear - A command button used to set the data items to blank (null) values.
Close - A command button used to close the screen.
Open - A command button used to retrieve a previously saved gas properties file.
Print - A command button used to print the contents of the screen.
Save - A command button used to save the contents of the screen to a gas properties file.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

111

GASWorkS 9.0

Data Screens
Table Of Contents

Notes & Considerations


! Some of the options in the Solution routine require that a single gas properties file be saved for the model.
This screen can be used to create the required file - select the Save command button and use the model name
for the gas properties file.
! The combined sum of the mole percent values of all of the individual components must equal one hundred
(100.00). Use the Other data field to enter any remainder required to force a perfect total. The Other data
field can also be used to accommodate a component not available in the Component list. The Other data
value has no influence on the calculated values, it is only used to allow for a perfect composition total.
! The gas property values are calculated at the models currently set base conditions.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

112

GASWorkS 9.0

Data Screens
Table Of Contents

Header Data Report


When selected, the Standard Report routine creates several report sections, one each for the contents of the
Header, Customer, Node, and Pipe data files. The Header Data Report is accessed by selecting the Header
menu item from the Standard (Select) submenu of the Report menu list. The unique features associated with
the Header Data section of the Standard Report are described as follows.

Command Buttons & Icons


Close All Reports - A command button used to close all sections of the Standard Report.
Close This Report - A command button used to close the Header Data Report while leaving any other
sections of the Standard Report open.
Maximize Window Size - An icon used to cause the reports window size to be increased to fill
the GASWorkS display screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

113

GASWorkS 9.0

Data Screens
Table Of Contents

Print - An icon used to print the contents of the report. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.
Reset Window Size - An icon used to cause the reports window size to be normalized or
reduced to its standard size.

View/Edit Model Notes - A command button used to display the Model Notes screen. When the screen is
displayed, edit the notes as desired, then select the Close command button on the Model Notes screen to save
any changes. The Model Notes Screen Description can be found later in this section of the Manual.

Notes & Considerations


! To make a specific section of the Standard Report active, click on any visible portion of the desired
section's screen - or, select the desired report from the Window menu list.
! The Header Data Report may be maximized, minimized, or resized to assist in viewing.
! The header data cannot be edited from the report. Use the Solution Data screen to edit the header data.
! To locate the location of the node with the largest error on the graphic display, double-click on either the
Largest Node Error label or in the associated data cell. If the GDI Window is open, a flag will be placed at
the nodes location.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

114

GASWorkS 9.0

Data Screens
Table Of Contents

Mass Update Specifications Screen


Mass changes can be made to the model data. This type of change is referred to as a mass update. The
Mass Update routine is controlled using the Mass Update Specifications screen. The screen is accessed by
selecting the Mass Update menu item from the Edit menu list. The features associated with the screen are
described as follows.

Data Items
Equal To - A data list used to enter or select the new value for the specified Set value. Either select an item
from the list or enter a value by typing it into the data field. The characteristics and contents of this item will
change depending on the Set value.
Is - A drop-down list used to select the search operator to be used during the Mass Update. The search
operator specifies the relation between the Where and To values, except in the case of the All operator.
When the All operator is selected, the values of the Where and To fields are ignored - in this case all data
features associated with the specified Where item are selected. Select an item from the list.
Saved Specifications - A drop-down list used to select a previously saved Mass Update Specification. To
use a previous specification, select an item from the list.
Set - A drop-down list used to select the data item to be updated. Select an item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

115

GASWorkS 9.0

Data Screens
Table Of Contents

To - A data list used to enter or select the value to be used as the check value during the Mass Update. Either
select an item from the list or enter a value by typing it into the data field. The characteristics and contents
of this item will change depending on the Where value.
Where - A drop-down list used to select which data item is to be used as the search item during the Mass
Update. Select an item from the list.

Command Buttons
Apply - A command button used to make the specified change.
Close - A command button used to close the screen.
Delete Displayed Specification - A command button used to delete the specification currently displayed in
the Saved Specifications list.
Restore - A command button used to restore the data values which existed just prior to the executed update.
Save Current Specification - A command button used to save the specification currently displayed in the
Where, Is, and To data fields.

Notes & Considerations


! If the Allow Undo Of Graphic/Data Changes preference option is selected (checked), erroneous changes
to the model data can be undone by immediately selecting the Restore command button after the update
has been made.
! The meanings of the search operators are:
Operator

Definition

Applies To

Equal To - All Set items with a Where value that is


equal to the To value will be changed.

Both numeric and string


values.

<>

Not Equal To - All Set items with a Where value that


is not equal to the To value will be changed.

Both numeric and string


values.

<

Less Than - All Set items with a Where value that is


less than the To value will be changed.

Numeric values only.

>

Greater Than - All Set items with a Where value that


is greater than the To value will be changed.

Numeric values only.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

116

GASWorkS 9.0

Data Screens
Table Of Contents

Operator

Definition

Applies To

<=

Less Than Or Equal To - All Set items with a Where


value that is less than or equal to the To value will
be changed.

Numeric values only.

>=

Greater Than Or Equal To - All Set items with a


Where value that is greater than or equal to the To
value will be changed.

Numeric values only.

All

All items associated with the selected Set item will


be changed.

Any

Ends With

All items which end with the specified Ends With


value will be changed.

String values only.

Like

All items which contain the specified Like value will


be changed.

String values only.

Max

All items contained in the specified maximum group


will be changed.

Numeric values only.

Min

All items contained in the specified minimum group


will be changed.

Numeric values only.

Not Like

All items which do not contain the specified Not


Like value will be changed.

String values only.

Starts
With

All items which start with the specified Starts With


value will be changed.

String values only.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

117

GASWorkS 9.0

Data Screens
Table Of Contents

Model Notes Screen


Notes and reference information about an analysis or model may be kept using the Model Notes feature. The
notes are accessed through the Model Notes edit screen. The screen can be accessed by selecting the Model
Notes menu item in the Edit menu list. The features associated with the screen are described as follows.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.
Print - An icon used to print the contents of the screen. When selected, the Print Control screen will be
displayed. Make any desired changes to the printer settings, then select the Print command button.

Notes & Considerations


! The notes can be edited by using basic text edit functions to type in the desired contents. The editor
supports standard Windows cut and paste commands (Ctrl-C , Ctrl-X, and Ctrl-V) as well as the other
standard editing commands controlled by the Enter, Backspace, Delete, and the Arrow keys. The editor will
automatically wrap the text if the line is longer than the available viewing space. To cause a specific line
break, press the Enter key at the end of the desired line. The Tab keys do not function within the editor.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

118

GASWorkS 9.0

Data Screens
Table Of Contents

Node Data Report


When selected, the Standard Report routine creates several report sections, one each for the contents of the
Header, Customer, Node, and Pipe data files. The Node Data Report is accessed by selecting the Node menu
item from the Standard (Select) submenu of the Report menu list. The unique features associated with the
Node Data section of the Standard Report are described as follows.

Data Items
Adjust Base Q (Load) By DF (Design Factor) - Indicates that the nodes base load value will be multiplied
by the Design Factor during the solution process. The original data value is not changed by this setting, the
load value is only modified during the solution calculation. To set a value, click in the associated data cell
till the desired option is displayed.
Adjust External Q (Load) By DF (Design Factor) - Indicates that the nodes external load value will be
multiplied by the Design Factor during the solution process. The original data value is not changed by this
setting, the load value is only modified during the solution calculation. To set a value, click in the associated
data cell till the desired option is displayed.
Base Load - Specifies the node's base load. If the value is Known, click in the associated data cell, then type
the desired value. Ensure that the value is expressed in terms of the selected dimensional unit. If the value
is Unknown, select No from the Load Known list. Initially the field is populated with the default load
value. If the model has been recently solved and the load is unknown, the item will contain the calculated
load value for the node. See the following Notes & Considerations section for additional information on the
base and external load values.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

119

GASWorkS 9.0

Data Screens
Table Of Contents

Base Load Status - Indicates whether the base load value is on or off during the Solution routine. If the
status is set to Off the value is assumed to be zero (0) during the solution calculation. The original data
value is not changed by this setting. To set a value, click in the associated data cell till the desired option is
displayed.
Elevation - Specifies the node's height above sea level. To enter a value, click in the associated data cell,
then type the desired value. Ensure that the value is expressed in terms of the assigned dimensional unit.
Initially, the field is populated with the default elevation value.
External Load Status - Indicates whether the external load value is on or off during the solution
process. If the status is set to Off the value is assumed to be zero (0) during the solution calculation. The
original data value is not changed by this setting. To set a value, click in the associated data cell till the
desired option is displayed.
Heating Value - Specifies the heating value of the gas as measured (calculated) at the node. To enter a value,
click in the associated data cell, then type the desired value. Ensure that the value is expressed in terms of
the assigned dimensional unit.
Load Units - Specifies the dimensional unit for the various load values. To select a value, click in the
associated data cell, then select an item from the list.
Node Name - Specifies a unique name or number for the selected node. The name may contain up to forty
(40) alphanumeric characters. The name is automatically assigned when a new node is added, however the
User can change the name to any desired value. The name must be unique to the model. To enter a value,
click in the associated data cell, then type the desired value. A warning message will appear if the name
already exists.
Pressure - Specifies the node's pressure. If the value is known, click in the associated data cell, then type
the desired value. Ensure that the value is expressed in terms of the selected dimensional unit. If the value
is unknown, select No from the Pressure Known list. Initially, the field is populated with the default
pressure value. If the model has been recently solved and the pressure is unknown, the item will contain the
calculated pressure value for the node.
Pressure Units - Specifies the dimensional unit for the pressure value. To select a value, click in the
associated data cell, then select an item from the list.
Specific Gravity - Specifies the specific gravity value of the gas as measured (calculated) at the node. To
enter a value, click in the associated data cell, then type the desired value. As used by GASWorkS, the
specific gravity represents the weight or density of the gas compared to dry air.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

120

GASWorkS 9.0

Data Screens
Table Of Contents

Specific Heat - Specifies the specific heat ratio of the gas as measured (calculated) at the node. To enter a
value, click in the associated data cell, then type the desired value. As used by GASWorkS, the specific heat
ratio represents the constant pressure specific heat divided by the constant volume specific heat of the gas
mixture.
Temperature - Specifies the average flowing temperature of the gas at the node's location. If the value is
known, click in the associated data cell, then type the desired value. Ensure that the value is expressed in
terms of the assigned dimensional unit. If the value is unknown, select No for Temperature Known.
Initially, the field is populated with the default temperature value. If the model has been recently solved and
the temperature is unknown and the Calculate Temperature Values solution option was selected (checked),
the item will contain the calculated temperature value for the node.
Viscosity - Specifies the dynamic viscosity of the gas as measured (calculated) at the node. To enter a value,
click in the associated data cell, then type the desired value. Ensure that the value is expressed in terms of
the assigned dimensional unit.

Displayed Items
Record # - Refers to the position of the current node record in the node data file. This value is automatically
assigned and cannot be changed by the User.

Calculated Values
Atmospheric Pressure - Displays the calculated atmospheric pressure value based on the node's elevation.
External Load - Displays the external load value times the design factor value, if the Adjust Ext Q By DF
option is set to Yes.
External Load (Fixed) - Displays the portion of the external load which cannot be adjusted by the design
factor.
Related Model - If the node is related to another model, this item displays the name of the model that the
node is related to. The list contains the name of all models in the same directory as the current model. Select
the desired model name from the list.
Related Node - If the node is related to another model, this item displays the name of the node in the related
model that the node is related to. The list contains the name of all nodes in the related model. Select the
desired node name from the list.
Total Load - Displays the total of the (adjusted) base and external load values.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

121

GASWorkS 9.0

Data Screens
Table Of Contents

X Coordinate - Displays the nodes horizontal location (east-west coordinate).


Y Coordinate - Displays the nodes vertical location (north-south coordinate).

Command Buttons & Icons


Close All Reports - A command button used to close all sections of the Standard Report.
Close This Report - A command button used to close the Node Data Report while leaving any other sections
of the Standard Report open.
Find - An icon used to find a record in the report by Node Name. When selected, the Find screen
will be displayed. Enter the desired Node Name, then select the Search command button. To find
another occurrence of the Node Name, select the Find Next command button.
Find Node - An icon used to find and flag the currently selected (highlighted) node record in the
GDI Window. This icon is only displayed if the GDI Window is open before the report is opened.

Go To - An icon used to display a specific Record Number at the top of the report. When
selected, the Go To screen will be displayed. Enter the Record Number to be displayed, then
select the Continue command button.
Make Selection Set - An icon used to create a selection set of nodes which meet a specified
selection criteria. When selected, the Query Specifications screen will be displayed. Enter the
desired selection criteria, then select the Perform Query command button.
Maximize Window Size - An icon used to cause the reports window size to be increased to fill
the GASWorkS display screen.

Print - An icon used to print the contents of the report. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.
Reset Selection Set - An icon used to clear (reset) the current selection set. When selected, all
the reportable customer records will now be displayed in the report.

Reset Window Size - An icon used to cause the reports window size to be normalized or
reduced to its standard size.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

122

GASWorkS 9.0

Data Screens
Table Of Contents

Restore Columns - An icon used to restore the display of all the columns (data items). When
selected, all of the columns associated with the report will now be displayed in the report.

Set Columns - An icon used to specify which columns (data items) to display in the report. When
selected, the Columns screen will be displayed. Select (check) the data items to be displayed, then
select the Apply command button. Note - Column display widths can be adjusted by dragging the
column separator lines.
Sort Ascending - An icon used to sort the records in ascending order (A to Z) based on the Node
Name values.

Sort Descending - An icon used to sort the records in descending order (Z to A) based on the
Node Name values.

Undo - An icon used to undo (restore) the most recent data change.

Notes & Considerations


! Unused (extra) node names may appear in the Node Data Report depending on when the report is viewed.
This is normal - the unused nodes will be removed from the node data file during the Solution routine.
! In addition to using the Set Columns icon to specify which columns are to be displayed, the report can also
be modified by adjusting or "collapsing" a column.
! To make a specific section of the Standard Report active, click on any visible portion of the desired
section's screen, or select the desired report from the Window menu list.
! The dimensional unit for the Atmospheric Pressure value is automatically set to the same dimensional unit
as the Base Pressure unit.
! The displayed Base Load value represents the unadjusted base load. The displayed External Load value
represents the adjusted value. The displayed Total Load value represents the sum of the adjusted base,
adjusted external, and the fixed external load values.
! Only data items associated with nodes attached to pipes that are assigned Facility Types that are active
can be edited in the report. The Facility Settings can be viewed and changed using the Facility Settings menu
item found in the Edit menu list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

123

GASWorkS 9.0

Data Screens
Table Of Contents

! Normally the report contains more information than will fit on a single page. If this condition occurs when
trying to print, a warning message will appear. When the warning appears, select the desired option. To print
a report that is too wide for the printer, eliminate some of the uninteresting columns from the report using
the Set Columns routine, or by manually collapsing undesired columns, reduce the column widths by
adjusting their width using the mouse, set the printer to use landscape mode, and reduce the printer font size.
If no adjustment is made to the reports width, the report will be printed on multiple pages.
! The Report item in the Facility Settings controls which features are included in the report. Only nodes
attached to pipes that are assigned Facility Types that are allowed to be reported, are included in the report.
The facility settings can be viewed and changed using the Facility Settings menu item found in the Edit menu
list, or the Report Options menu item from the Report menu list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

124

GASWorkS 9.0

Data Screens
Table Of Contents

Path Settings Screen


The default directory locations for the various files associated with a GASWorkS model and the support files
are controlled using the Path Settings screen. The screen is accessed by selecting the Paths menu item from
the Preferences submenu of the File menu list. The features associated with the screen are described as
follows.

Data Items
Current Setting - A data field used to specify the default location for the associated data type files. Use the
Drive and Directories items to change the current setting. Select the desired tab to display the associated
setting.
Directories - A list box used to display the folders and subfolders associated with the selected drive. Select
the desired directory from the list by double-clicking on the folder name. The last open folder indicates
the selected directory.
Drive - A drop-down list used to select the an available disk drive. Select the desired drive from the list.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

125

GASWorkS 9.0

Data Screens
Table Of Contents

Close - A command button used to close the screen and save any changes.

Notes & Considerations


! The path settings establish the default location of the various GASWorkS model and support files. The
model file path can be overridden when selecting a file using the File Selection screen. All other paths
indicate locations used by GASWorkS to find the necessary support files. These directories can only be
changed using the Path Settings screen.
! The License path indicates where the valid license file is located. In general, the default (as installed)
location should be used, except where a network installation is used. In that case follow the supplemental
network installation instructions for correctly setting the License directory.
! The Path and Preference settings can be saved using the Save Current Settings menu item from the
Preferences submenu of the File menu list.
! The Initialization Files tab allows the User to view and select the path for the initialization files. The
initialization files contain information about the screen location and previous data values and settings for
each screen.
! The License File tab allows the User to view and select the path for the software license and registration
files. For local installations this value should be set to the app subdirectory of the main GASWorkS
directory. For network installations this value should be set to the appropriate network location.
! The Model Files tab allows the User to view and select the path for the model data files. The model files
contain information about the screen location and previous data values and settings for each screen.
! The Property Files tab allows the User to view and select the path for the Property Tables. The Property
Tables contain dimensional and other property data for the various pipes and devices used in the GASWorkS
calculations.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

126

GASWorkS 9.0

Data Screens
Table Of Contents

Pipe Data Report


When selected the Standard Report routine creates several report sections, one each for the contents of the
Header, Customer, Node, and Pipe data files. The Pipe Data Report is accessed by selecting the Pipe menu
item from the Standard (Select) submenu of the Report menu list. The unique features associated with the
pipe section of the Standard Report are described as follows.

Hydraulic Tab

Data Items
Allow Calculation - Indicates whether the pipe size can be calculated during the Solution routine, when the
Calculate Pipe Sizes (Optimize) solution option is selected (checked). To set a value, click in the associated
data cell till the desired option is displayed. This item is only displayed for Pipe type elements.
Attached Fittings - Indicates the number of fittings that are currently attached to the segment. Click in the
data cell to display the Fitting Data screen. Make any desired changes, then select the Close command button
to attach the fittings.
Diameter/Roughness Units - Specifies the diameter and roughness dimensional unit to be used for the
segment. To select a value, click in the associated data cell, then select an item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

127

GASWorkS 9.0

Data Screens
Table Of Contents

Efficiency - Specifies the efficiency value for Compressor, Fitting, and Pipe type elements. To enter a value,
click in the associated data cell, then type the desired value. Ensure the value is expressed in terms of the
assigned dimensional unit. Initially, the efficiency is set to the default efficiency value. For Compressor type
elements, this item refers to the mechanical efficiency of the compressor.
Element Type - Specifies the hydraulic element type for the segment. To select a value, click in the
associated data cell, then select an item from the list. The content of the various sections of this report will
vary depending on the selected value. This value is initially set to a Pipe type element. This item is displayed
for all element types.
Equation - Specifies the flow equation to be used with Fitting and Pipe type elements. To select a value,
click in the associated data cell, then select an item from the list. This item is only displayed for Fitting and
Pipe type elements.
Flow Units - Specifies the flow dimensional unit to be used for the segment. To select a value, click in the
associated data cell, then select an item from the list. This item is displayed for all element types.
From Node - Refers to the name of the beginning node of the pipe element.
Length - Specifies the hydraulic length of Pipe type elements. To enter a value, click in the associated data
cell, then type the desired value. Ensure the value is expressed in terms of the selected dimensional unit.
Initially, the length is set to the pipe's "graphic" length. This item is only displayed for Pipe type elements.
Length Units - Specifies the length dimensional unit to be used for the segment. To select a value, click in
the associated data cell, then select an item from the list. This item is displayed for all element types.
Pressure Units - Specifies the pressure dimensional unit to be used for the segment. To select a value, click
in the associated data cell, then select an item from the list. This item is displayed for all element types.
Size/Type - Specifies the size and type for the segment. The meaning of this item varies depending on the
selected element type. The various meanings are listed in the following table. Initially, this item is set to the
default Size/Type value. To select a value, click in the associated data cell, then select an item from the list.
This item is displayed for all element types.
Element Type

Size/Type Meaning

Compressor

Represents the Size/Type Code for the compressor. The desired Size/Type
Code may be selected from the list. The content of the list represents the
Size/Type Codes found in the currently selected Compressor Property Table.

Fitting

Represents the Size/Type Code for the fitting. The desired Size/Type Code
may be selected from the list. The content of the list represents the Size/Type
Codes found in the currently select Fittings Property Table.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

128

GASWorkS 9.0

Data Screens
Table Of Contents

Element Type

Size/Type Meaning

Pipe

Represents the Size/Type Code, or the inside diameter value for the pipe.
The desired Size/Type Code may be selected from the list, or the inside
diameter value may be manually entered by typing the value into the data
field. The content of the list represents the Size/Type Codes found in the
currently selected Pipe Property Table.

Regulator

Represents the Size/Type Code for the regulator. The desired Size/Type
Code may be selected from the list. The content of the list represents the
Size/Type Codes found in the currently selected Regulator Property Table.

Valve

Represents the Size/Type Code for the valve. The desired Size/Type Code
may be selected from the list. The content of the list represents the Size/Type
Codes found in the currently assigned Valve Property Table.

Well

Represents the Size/Type Code for the well. The desired Size/Type Code
may be selected from the list. The content of the list represents the Size/Type
Codes found in the currently assigned Well Property Table. If the Unique
value is selected, the required well parameters may be manually entered in
the appropriate data fields.

Status - Indicates whether the segment is turned on or off. To set a value, click in the associated data
cell till the desired option is displayed. This item is displayed for all element types.
To Node - Refers to the name of the ending node of the pipe element.
Total Efficiency - Specifies the efficiency value used in the Solution routine. The value is only displayed
for Pipe type elements. To enter a value, click in the associated data cell, then type the desired value. Ensure
the value is expressed in terms of the assigned dimensional unit. See the following Notes & Considerations
section for information on how the total efficiency is calculated.

Calculated Values
% (Percent) SMYS - Displays the ratio of the Hoop Stress value to the Specified Minimum Yield Strength
(SMYS) value. The value is based on the SMYS value found in the Pipe Property Table. This item is not
displayed if the SMYS value is zero (0) in the table for the assigned Size/Type Code, or if the Size/Type
Code is not found in the table. The value is only displayed for Pipe type elements.
Average Pressure - Displays the average pressure along the segment.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

129

GASWorkS 9.0

Data Screens
Table Of Contents

Drop Per XXX - Displays the unit pressure drop along the pipe segment. This value is calculated by dividing
the overall pressure drop by the segments length then multiplying the result by the specified Pressure Drop
Per Length value. The pressure drop per length value can be set by selecting the Report Options menu item
from the Report menu list.
Equivalent Length - Displays the equivalent length value for the pipe segment when fittings are attached.
The value is only displayed for Pipe type elements.
Flow Rate - Displays the calculated flow rate for the segment. If this value is positive, it indicates that the
flow direction is from the From Node to the To Node. If the value is negative, it indicates that the flow
direction is from the To Node to the From Node.
Hoop Stress - Displays the calculated hoop stress value for the segment. The value is based on the larger
of the From or To Pressures, and the outside diameter and wall thickness values found in the Pipe Property
Table. This item is not displayed if the Size/Type Code is not found in the table. The value is only displayed
for Pipe type elements.
ID Number - Displays the pipes unique internal (to GASWorkS) identification number. This value is
automatically assigned and cannot be changed by the User.
Inside Diameter - Displays the pipe's inside diameter value. If the Size/Type value represents a code, this
value represents the Inside Diameter value extracted from the assigned Pipe Property Table. Otherwise this
item represents the interpreted numeric value of the Size/Type alphanumeric value. The value is only
displayed for Pipe type elements.
Pressure Drop - Displays the linear pressure drop for the segment (the From Pressure minus the To
Pressure). Note that when elevation differences are present along the pipe segment, it is possible for the
downstream pressure to be larger than the upstream pressure. If this value is positive, it indicates that the
From Node pressure is larger than the To Node pressure. If the value is negative, it indicates that the To Node
pressure is greater than the From Node pressure.
Roughness - Displays the inside pipe wall roughness for the pipe segment. The value is extracted from the
Pipe Property Table for the assigned Size/Type Code. The value is only displayed for Pipe type elements.
Velocity - Displays the maximum velocity of the gas flow in the pipe segment. The value is calculated using
the lower of the segments end pressures, the volumetric flow rate, and the inside diameter value for the
segment. The value is only displayed for Pipe type elements.
Volume - Displays the volume of gas contained in the pipe segment. The value is calculated using the
average pressure value, the inside diameter, and the length of the pipe segment. The value is only displayed
for Pipe type elements.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

130

GASWorkS 9.0

Data Screens
Table Of Contents

Attribute Tab
The Attribute tab of the Pipe Data Report displays the associated attribute file data. If a linked database is
attached, the values can be changed by the User. If the attached database is of another type, the values are
view-only and cannot be changed. To edit a value, click in the associated data cell containing the value to
be changed - click another data cell or press the Enter key to save the change.

Data Items
Address - Specifies the name of the pipe address value. To enter a value, click in the associated data cell,
then type the desired value.
Comments - Specifies comments and notes associated with the pipe attribute data. To enter a value, click
in the associated data cell, then type the desired value.
Facility Type - Specifies the facility to be associated with the pipe segment. To select a value, click in the
associated data cell, then select an item from the list.
From Node - Refers to the name of the beginning node of the pipe element.
Link OK - If an external database is attached, this item indicates whether the pipe feature should be linked
to the external database. If Yes is selected, the pipe will be linked by matching the Link ID value. To set
a value, click in the associated data cell till the desired option is displayed.
Pressure Units - Specifies the dimensional units for the associated pressure values contained in the attached
attribute file. To select a value, click in the associated data cell, then select an item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

131

GASWorkS 9.0

Data Screens
Table Of Contents

To Node - Refers to the name of the ending node of the pipe element.

Calculated Values
Customer Count - Displays the number of customers attached to the segment. This item is automatically
calculated and cannot be changed by the User.
ID Number - Displays the pipes unique internal (to GASWorkS) identification number. This value is
automatically assigned and cannot be changed by the User.
Link ID Number - Displays an identification number used to link to an external database. When a linked
database is attached, the number is automatically assigned. When any other type of external database is
attached, the number is assigned by the User, and generally represents a value that is unique in the database.
When no external database is attached, the number can be used to maintain any User desired alphanumeric
value. The value can be a combination of up to twenty (20) alpha-numeric characters.

Displayed Items
Record # - Refers to the position of the current pipe record in the pipe data file. This value is automatically
assigned and cannot be changed by the User.

Command Buttons & Icons


Close All Reports - A command button used to close all sections of the Standard Report.
Close This Report - A command button used to close the Pipe Data Report while leaving any other sections
of the Standard Report open.
Copy Current Selection - An icon used to extract (copy) the currently selected (highlighted) pipe
records into a new or existing model.

Delete Current Selection - An icon used to delete the currently selected (highlighted) records.

Delete Pipe - An icon used to delete the currently selected (highlighted) pipe record.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

132

GASWorkS 9.0

Data Screens
Table Of Contents

Find - An icon used to find a record in the report by the From or To Node Name. When selected,
the Find screen will be displayed. Enter the desired From or To Node Name, then select the
Search command button. To find another occurrence of the From or To Node Name, select the
Find Next command button.
Find Pipe - An icon used to find and flag the currently selected (highlighted) pipe record in the
GDI Window. This icon is only displayed if the GDI Window is open before the report is opened.

Go To - An icon used to display a specific Record Number at the top of the report. When
selected, the Go To screen will be displayed. Enter the Record Number to be displayed, then
select the Continue command button.
Make Selection Set - An icon used to create a selection set of pipe items which meet a specified
selection criteria. When selected, the Query Specifications screen will be displayed. Enter the
desired selection criteria, then select the Perform Query command button.
Maximize Window Size - An icon used to cause the reports window size to be increased to fill
the GASWorkS display screen.

Oops (Undelete) - An icon used to restore (undelete) a recently deleted pipe record.

Print - An icon used to print the contents of the report. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.
Reset Selection Set - An icon used to clear (reset) the current selection set. When selected, all
the reportable customer records will now be displayed in the report.

Reset Window Size - An icon used to cause the reports window size to be normalized or
reduced to its standard size.

Restore Columns - An icon used to restore the display of all the columns (data items). When
selected, all of the columns associated with the report will now be displayed in the report.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

133

GASWorkS 9.0

Data Screens
Table Of Contents

Set Columns - An icon used to specify which columns (data items) to display in the report. When
selected, the Columns screen will be displayed. Select (check) the data items to be displayed, then
select the Apply command button. Note - Column display widths can be adjusted by dragging the
column separator lines.
Sort Ascending - An icon used to sort the records in ascending order (A to Z) based on the From
Node Name values.

Sort Descending - An icon used to sort the records in descending order (Z to A) based on the
From Node Name values.

Undo - An icon used to undo (restore) the most recent data change.

Notes & Considerations


! In addition to using the Set Columns icon to specify which columns are to be displayed, the report can also
be modified by adjusting or "collapsing" a column.
! To make a specific section of the Standard Report active, click on any visible portion of the desired
section's screen - or, select the desired report from the Window menu list.
! Normally the report contains more information than will fit on a single page. If this condition occurs when
trying to print, a warning message will appear. When the warning appears, select the desired option. To print
a report that is too wide for the printer, eliminate some of the uninteresting columns from the report using
the Set Columns routine, or by manually collapsing undesired columns, reduce the column widths by
adjusting their width using the mouse, set the printer to use landscape mode, and reduce the printer font size.
If no adjustment is made to the reports width, the report will be printed on multiple pages.
! The Report item in the Facility Settings controls which features are included in the report. Only pipes
assigned Facility Types that are allowed to be reported, are included in the report. The Facility Settings can
be viewed and changed using the Facility Settings menu item found in the Edit menu list, or the Report
Options menu item from the Report menu list.
! If an attribute file is attached, the contents of the file will be displayed on the Attribute tab of the report.
Depending on the type of file attached, the attribute data values may or may not be allowed to be edited.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

134

GASWorkS 9.0

Data Screens
Table Of Contents

! Only data items associated with pipes that are assigned Facility Types that are active can be edited in
the report. The Facility Settings can be viewed and changed using the Facility Settings menu item found in
the Edit menu list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

135

GASWorkS 9.0

Data Screens
Table Of Contents

Preference Settings Screen


Various GASWorkS program behaviors can be set using the Preference Settings screen. The screen is
accessed by selecting the Settings menu item from the Preferences submenu of the File menu list. The
features associated with the screen are described as follows.

Data Items
Allow Extended Desktop Display - A checkbox used to indicate whether the software should support
extended desktop displays (i.e. dual monitors). Select (check) this option if desired.
Allow Undo Of Graphic/Data Changes - A checkbox used to indicate whether graphic and data changes
can be reversed (undone) using the Undo command. Select (check) this option if desired. If this item is not
selected (not checked), erroneous changes must be manually corrected.
Automatically Display GDI Command List - A checkbox used to indicate whether the GDI Command List
will be automatically displayed each time the cursor is passed over the associated icon. Select (check) this
option if desired. If this item is not selected (not checked), the GDI Command List icon must be clicked to
display the GDI Command List.
Automatically Open GDI Window - A checkbox used to indicate whether the GDI Window will be
automatically opened each time a model is opened or GASWorkS is opened. Select (check) this option if
desired.
Automatically Save At Timed Increments - A checkbox used to indicate whether the model data in
memory will be saved to the associated disk file at User specified time-increments. Select (check) this option
if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

136

GASWorkS 9.0

Data Screens
Table Of Contents

Automatic Save Increment - A data field used to enter the time increment between automatic saves. This
item is only enabled when the Automatically Save At Timed Increments preference setting is selected
(checked). Enter a value by typing it into the data field. The value should be expressed in terms of Minutes.
Display Reminders - A checkbox used to indicate whether additional messages will appear during certain
commands and routines providing reminders to the User. Select (check) this option if desired.
Ignore Facility Settings On Mass Update - A checkbox used to indicate whether all data features will be
included in the Mass Update routine. Select (check) this option if desired. If this item is not selected (not
checked), only items associated with Facility Types which are set to Active, will be included in the Mass
Update routine.
Save Model Before Solving - A checkbox used to indicate whether the current model data will be saved to
the associated disk before the Solution routine is executed. Select (check) this option if desired.
Show Tooltips - A checkbox used to indicate whether the tooltips will be displayed when the cursor is rested
over an icon, menu item, command button, or data field or list. Select (check) this option if desired.
Use Command Alias File - A checkbox used to indicate whether command alias values will be read from
the Command Alias File. When this item is selected (checked), alias values are read from the command
alias file, and can then be used by typing them on the GDI Command Line. Select (check) this option if
desired.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.

Notes & Considerations


! When the Automatically Save At Timed Increments preference setting is selected (checked), the model will
be saved at time increments as specified by the User by the value entered in the Automatic Save Increment
data field.
! The Path and Preference settings can be saved using the Save Current Settings menu item from the
Preferences submenu of the File menu list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

137

GASWorkS 9.0

Data Screens
Table Of Contents

Print Control Screen - (Long Form)


GASWorkS uses two Print Control screens. The Long Form is displayed when the Print icon
is selected from one of the various Report screens. The Print Control screen allows various printer
settings to be set by the User. The features associated with the screen are described as follows.

Data Items
Bottom Margin - A data field used to enter the distance from the bottom of the page to the bottom of the
printed report. Enter a value by typing it into the data field. Ensure the value is expressed in terms of the
assigned dimensional unit.
Collate Pages - A checkbox used to indicate whether pages are collated when multiple copies are printed.
That is, the copies will be grouped together - the Header Data Report - the Node Data Report pages 1, 2, 3... the Pipe Data Report pages 1, 2, 3... - the Customer Data Report pages 1, 2, 3, etc. Select (check) this option
if desired.
Grid Format - An option button used to specify if the report will be printed using a grid (spreadsheet) style
format. When selected (checked), the additional options located below the Grid Format option are enabled.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

138

GASWorkS 9.0

Data Screens
Table Of Contents

Include (Report Sections) - A group of checkboxes used to indicate which reports to include in the printed
report. Select (check) the box(es) next to the various sections to include them in the printed report. This
section is only displayed, when one of the Standard Reports is being printed.
Landscape Orientation - A checkbox used to indicate whether to use landscape orientation when printing
the report. When the option is not selected (not checked), the report will be printed in portrait orientation.
Select (check) this option if desired.
Left Margin - A data field used to enter the distance from the left side of the page to the left side of the
printed report. Enter a value by typing it into the data field. Ensure the value is expressed in terms of the
assigned dimensional unit.
Name - A data field used to specify the name of the font to be used when printing the report. The font is set
using the Font screen. Double-click in the data field to open the Font screen. Select the desired font, then
select the OK command button.
Number Of Copies - A data field used to enter the number of copies to be printed. Enter a value greater than
zero, by typing it into the data field.
Print Dimensional Units - A checkbox used to indicate whether the dimensional units for data items which
can be assigned individual units, are included in the printed report. When the option is not selected (not
checked) this setting suppresses the printing of all of the dimensional unit values. This option is only
available when the Grid Format option is selected. Select (check) this option if desired.
Print Grid Lines - A checkbox used to indicate whether to include grid lines when using the Grid Format
in the printed report. Printing grid lines enhances the readability of the report, but their inclusion also
increases the print time. This option is only available when the Grid Format option is selected. Select (check)
this option if desired.
Print Page Numbers - A checkbox used to indicate whether to include page numbers in the printed report.
Select (check) this option if desired.
Printer - A drop-down list used to select the printer. To change the selection, select a printer from the list
or select the Printer Setup command button.
Right Margin - A data field used to enter the distance from the right side of the page to the right side of the
printed report. Enter a value by typing it into the data field. Ensure the value is expressed in terms of the
assigned dimensional unit.
Size - A data field used to specify the size of the font to be used when printing the report. The value is set
using the Font screen. Double-click in the data field to open the Font screen. Select the desired size, then
select the OK command button. The size is expressed in printer points. One printer point is approximately
equal to 1/72 of an inch.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

139

GASWorkS 9.0

Data Screens
Table Of Contents

Top Margin - A data field used to enter the distance from the top of the page to the top of the printed report.
Enter a value by typing it into the data field. Ensure the value is expressed in terms of the assigned
dimensional unit.

Command Buttons
Cancel - A command button used to cancel the Print routine. Depending on the status of the current print
activities, the Print routine may not terminate immediately.
Print - A command button used to print the report.
Printer Setup - A command button used to open the Printer Setup screen. The contents of the screen will
vary depending on the selected printer and the configuration of the computer system. Make any desired
changes, then select the OK command button to return to the Print Control screen.

Notes & Considerations


! The Printer Dimensional Units for the margin values are set by selecting the Report Options menu item
from the Report menu list.
! Report contents can be printed to PDF format if a third-party PDF printer is installed. To print to a PDF
printer, select the PDF printer name from the printer list, select the Print command button, enter a Filename
when prompted, and the contents will be printed to the selected Filename.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

140

GASWorkS 9.0

Data Screens
Table Of Contents

Print Control Screen - (Short Form)


GASWorkS uses two Print Control screens. The Short Form is displayed when the Print icon
is selected from one of the various data screens. The Print Control screen allows various printer
settings to be set by the User. The features associated with the screen are described as follows.

Data Items
Bottom Margin - A data field used to enter the distance from the bottom of the page to the bottom of the
printed report. Enter a value by typing it into the data field.
Collate Pages - A checkbox used to indicate whether pages are collated when multiple copies are printed.
That is, the copies will be grouped together by the associated reports. Select (check) this option if desired.
Landscape Orientation - A checkbox used to indicate whether to use landscape orientation when printing
the report. When the option is not selected (not checked), the report will be printed in portrait orientation.
Select (check) this option if desired.
Left Margin - A data field used to enter the distance from the left side of the page to the left side of the
printed report. Enter a value by typing it into the data field.
Name - A data field used to specify the name of the font to be used when printing the report. The font is set
using the Font screen. Double-click in the data field to open the Font screen. Select the desired font, then
select the OK command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

141

GASWorkS 9.0

Data Screens
Table Of Contents

Number Of Copies - A data field used to enter the number of copies to be printed. Enter a value greater than
zero, by typing it into the data field.
Printer - A drop-down list used to select the printer. Select an item from the list.
Right Margin - A data field used to enter the distance from the right side of the page to the right side of the
printed report. Enter a value by typing it into the data field.
Size - A data field used to specify the size of the font to be used when printing the report. The value is set
using the Font screen. Double-click in the data field to open the Font screen. Select the desired size, then
select the OK command button. The size is expressed in printer points. One printer point is approximately
equal to 1/72 of an inch.
Top Margin - A data field used to enter the distance from the top of the page to the top of the printed report.
Enter a value by typing it into the data field.

Command Buttons
Cancel - A command button used to cancel the Print routine. Depending on the status of the current print
activities, the Print routine may not terminate immediately.
Print - A command button used to print the Report.
Printer Setup - A command button used to open the Printer Setup screen. The contents of the screen will
vary depending on the selected printer and the configuration of the computer system. Make any desired
changes, then select the OK command button to return to the Print Control screen.

Notes & Considerations


! The Printer Dimensional Units for the margin values are set by selecting the Report Options menu item
from the Report menu list.
! Report contents can be printed to PDF format if a third-party PDF printer is installed. To print to a PDF
printer, select the PDF printer name from the printer list, select the Print command button, enter a Filename
when prompted, and the contents will be printed to the selected Filename.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

142

GASWorkS 9.0

Data Screens
Table Of Contents

Project Specifications Screen


The Project Specifications screen is displayed when the New Project menu item is selected from the File
menu list. The screen allows several settings to be specified when creating a new model. The features
associated with the screen are described as follows.

Data Items
Attach A Linked Customer Attribute File - A checkbox used to indicate whether a linked customer
attribute file will be created and attached to the new model. When selected (checked), the adjacent dropdown list will be enabled which contains the available database definitions. Select the desired file from the
list.
Attach A Linked Pipe Attribute File - A checkbox used to indicate whether a linked pipe attribute file will
be created and attached to the new model. When selected (checked), the adjacent drop-down list will be
enabled which contains the available database definitions. Select the desired file from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

143

GASWorkS 9.0

Data Screens
Table Of Contents

Background Files - Displays a list of the attached background files. Select the Select From Existing DXF
Files command button to attach files.
Default Settings - A drop-down list used to select the default settings file to be associated with the new
model. Either select a previously saved file from the list, or select Default from the list to use the settings
associated with the most previously open model.
Facility Settings - A drop-down list used to select the facility settings file to be associated with the new
model. Either select a previously saved file from the list, or select Default from the list to use the currently
saved default file.
Header Template - A drop-down list used to select the name of an existing header file to use as a template
for creating the new model. Only header files associated with models contained in the current Model Files
path are displayed. Either select a name from the list, or select Default from the list to use the currently
saved default file.
Model Name - A data field used to enter the name for the new model. Either enter a name by typing it into
the data field, or select the Select From Existing Models command button to select an existing model name.
Pipe/Main Sizing Table - A drop-down list used to select which Pipe Property Table will be used when
calculating pipe sizes in the Solution routine. Select a table from the list.
Preference Settings - A drop-down list used to select the preference settings file to be associated with the
new model. Either select a previously saved file from the list, or select Default from the list to use the
current path and preference settings.

Command Buttons
Cancel - A command button used to close the screen without creating a new model.
Continue - A command button used to close the screen and create a new model based on the specified
settings.
Retrieve - A command button used to retrieve a previously saved specification file.
Save - A command button used to save the current settings to a specification file.
Select From Existing DXF Files - A command button used to open a File Selection screen and select an
existing DXF image Filename.
Select From Existing Models - A command button used to open a File Selection screen and select an
existing Model Name.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

144

GASWorkS 9.0

Data Screens
Table Of Contents

Notes & Considerations


! Only DXF style background image files may be attached using the Project Specifications. To attach other
types of background files, use the Background Settings menu item from the Graphics menu list, after the
model has been created and opened.
! When one of the Attach A Linked Attribute File items are selected, an appropriate linked database file
will be attached to the model when it is created. See the Attribute Data section later in this Manual for more
information on working with linked attribute files.
! A Default Settings file can be created using the Default Data Values screen. Select the Set Defaults menu
item from the Utilities menu list to open the screen. See the Default Data Values Screen Description in the
Data Screens section of this Manual for more information on creating and saving a file. If the Default item
is selected for the Default Settings, the values associated with the most recently open model will be used.
! A Facility Settings file can be created using the Facility Settings screen. Select the Facility Settings menu
item from the Edit menu list to open the screen. See the Facility Settings Screen Description in the Data
Screens of this Manual for more information on creating and saving a file. If the Default item is selected
for the Facility Settings, the values associated with the most recently open model will be used.
! A Preference Settings file can be created using the Save Current Settings menu item from the Preferences
submenu of the File menu list. If the Default item is selected for the Preference Settings, the values
associated with the most recently open model will be used.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

145

GASWorkS 9.0

Data Screens
Table Of Contents

Property Table Settings Screen


The various Property Tables used by GASWorkS can be set using the Property Table Settings screen. The
screen is accessed by selecting the Property Tables menu item from the Preferences submenu of the File
menu list. The features associated with the screen are described as follows.

Data Items
Compressor - A drop-down list used to select the Property Table to be used for the compressor values.
Select an item from the list.
Current Property Path - Displays the current location (path) of the Property Table files. The path can be
changed by either selecting the Change Path Setting command button, or by double-clicking on the current
path label.
Fittings - A drop-down list used to select the Property Table to be used for the fitting values. Select an item
from the list.
Pipe - A drop-down list used to select the Property Table to be used for the pipe values. Select an item from
the list.
Regulator - A drop-down list used to select the Property Table to be used for the regulator values. Select
an item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

146

GASWorkS 9.0

Data Screens
Table Of Contents

Valve - A drop-down list used to select the Property Table to be used for the valve values. Select an item
from the list.
Well - A drop-down list used to select the Property Table to be used for the well values. Select an item from
the list.

Command Buttons
Cancel - A command button used to close the screen without saving the current settings.
Change Path Setting - A command button used to change the path (location) setting for the Property Table
files.
Close - A command button used to close the screen and save the current settings.

Notes & Considerations


! Only tables contained in the current Property Table path (location) are displayed in the associated dropdown lists.
! When moving a model from one machine to another, the Property Table may not be valid on the new
machine, and may not contain the same information as the previous tables. When moving a model to another
machine it is recommended that the model is first bundled using the Bundle A Model menu item from the
Bundle submenu of the File menu list, using the Include Assigned Property Tables option. Move the bundled
file and unbundle it using the Unbundle A Model menu item from the Bundle submenu of the File menu list this will move both the model and Property Tables.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

147

GASWorkS 9.0

Data Screens
Table Of Contents

Query Specifications Screen


The Make Selection Set routine found in the Standard Report, the Color By Query routine, and
the Flag Items routines found in the GDI allow selection of data features based on a User
specified selection criteria. These selection sets are created using the Query Specifications screen.
The screen is displayed when the Make Selection Set icon is selected from the various report
screens. The features associated with the screen are described as follows.

Data Items
Find Records Where Left Item (Where) - A drop-down list used to select which data item is to be used as the search item
during the Query Selection. Select an item from the list.
Middle Item (Is) - A drop-down list used to select the search operator to be used during the Query
Selection. The search operator specifies the relation between the Where and To values, except in the
case of the All operator. When the All operator is selected, the values of the Where and To fields
are ignored - in this case all data features associated with the specified Where value are selected.
Select an item from the list.
Right Item (To) - A drop-down list used to select the value to be used as the check value during the
Query Selection. Either enter a value by typing it into the data field, or select an item from the list.
The characteristics of this item change depending on the Where value.
Saved Specifications - A drop-down list used to select a previously saved Query Specification. To use a
previous specification, select the desired specification from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

148

GASWorkS 9.0

Data Screens
Table Of Contents

Command Buttons
Close - A command button used to close the screen.
Delete Displayed Specification - A command button used to delete the specification currently displayed in
the Saved Specifications list.
Perform Query - A command button used to perform the query.
Save Current Specification - A command button used to save the specification currently displayed in the
Where, Is, and To data fields.

Notes & Considerations


! A selection set is cleared by selecting the Reset Selection Set icon from the associated report
icon tray.
! The meanings of the search operators are:
Operator

Definition

Applies To

Equal To - Finds all records with an item value that is


equal to the specified value.

Both numeric and string


values.

<>

Not Equal To - Finds all records with an item value


that is not equal to the specified value.

Both numeric and string


values.

<

Less Than - Finds all records with an item value that


is less than the specified value.

Numeric values only.

>

Greater Than - Finds all records with an item value


that is greater than the specified value.

Numeric values only.

<=

Less Than Or Equal To - Finds all records with an


item value that is less than or equal to the specified
value.

Numeric values only.

>=

Greater Than Or Equal To - Finds all records with an


item value that is greater than or equal to the specified
value.

Numeric values only.

All

Finds all records associated with the specified Where


item.

Any

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

149

GASWorkS 9.0

Data Screens
Table Of Contents

Operator

Definition

Applies To

Ends
With

Finds all records that end with the specified Equal To


value.

String values only.

Like

Finds all records with an item value that contains the


specified Equal To value.

String values only.

Max

Finds a specified number of records which possess the


highest item values.

Numeric values only.

Min

Finds a specified number of records which possess the


lowest item values.

Numeric values only.

Not Like

Finds all records that do not contain the specified


Equal To value.

String values only.

Starts
With

Finds all records that start with the specified Equal To


value.

String values only.

! Use the Diameter item to allow a pipe size to be typed. Use the Size/Type item to select a pipe size from
the values contained in the Pipe Property Table. Or, use the Size/Type (Unlisted) item to type a Size/Type
value not listed in the Pipe Property Table.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

150

GASWorkS 9.0

Data Screens
Table Of Contents

Renumbering Specifications Screen


A routine is provided that allows the node numbers to be renamed or renumbered based on a User specified
starting number and increment value. The routine is controlled using the Renumbering Specifications screen.
The screen is accessed by selecting the Renumber Nodes menu item from the Miscellaneous submenu of the
Utilities menu list. The features associated with the screen are described as follows.

Data Items
Increment Value - A data field used to enter the increment value between node numbers. Enter a value by
typing it into the data field.
Starting Number - A data field used to enter the value to start the numbering from. Enter a value by typing
it into the data field.

Command Buttons
Close - A command button used to close the screen.
Renumber - A command button used to perform the renumbering. A message will appear when the process
is complete.

Notes & Considerations


! The Renumber Nodes routine is performed as follows - The starting node number is assigned to the first
node found in the node data file. The starting number is increased by the increment value and this number
is assigned to the next node in the file. This process is continued until all of the nodes have been renumbered.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

151

GASWorkS 9.0

Data Screens
Table Of Contents

Report Options Screen


The number of decimal places displayed by the various reports and data screens, along with various other
settings, can be set by the User using the Report Options screen. The screen is accessed by selecting the
Report Options menu item from the Report menu list. The features associated with the screen are described
as follows.

Decimals Tab

Data Items
Number Of Decimals To Display - A group of drop-down lists used to select the number of decimal places
to display for the associated parameter. To set the number, click in the associated data cell. A data list will
be displayed. Select a value from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

152

GASWorkS 9.0

Data Screens
Table Of Contents

Facilities Tab

Data Items
Indicate Which Facilities To Include In The Reports - A group of checkboxes used to indicate which
Facility Types are to be included in the report activities. To include a Facility Type in the various Report
routines, select (check) the item. To exclude a Facility Type from the Report routines, unselect (uncheck)
the item. The contents of the list will vary depending on the Facility Types associated with the current model.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

153

GASWorkS 9.0

Data Screens
Table Of Contents

Other Tab

Data Items
Indicate Which Options To Include In Exceptions Report - A group of checkboxes used to indicate which
exceptions to report when an Exceptions Report is included in the Solution Log. Select (check) the desired
options.
Compressors With High Inlet Pressure - A checkbox used to indicate whether compressors with
inlet pressures greater than the set pressure are reported. Select (check) this option if desired.
Large Node Errors - A checkbox used to indicate whether nodes with errors greater than the
convergence tolerance are reported. Select (check) this option if desired.
Large Pressure Nodes - A checkbox used to indicate whether nodes with unusually high pressure
values are reported. Select (check) this option if desired.
Low Flow Pipes - A checkbox used to indicate whether pipes with flows less than the convergence
tolerance are reported. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

154

GASWorkS 9.0

Data Screens
Table Of Contents

Negative Pressure Nodes - A checkbox used to indicate whether nodes with pressure values less
than zero are reported. Select (check) this option if desired.
Regulators With Back Flow - A checkbox used to indicate whether regulator type elements with
flow towards the outlet node, or away from the inlet node are reported. Select (check) this option if
desired.
Regulators With Low Inlet Pressure - A checkbox used to indicate whether regulator type
elements with inlet pressure values below their set pressure are reported. Select (check) this option
if desired.
Zero Flow Pipes - A checkbox used to indicate whether pipes with no (zero) flows are reported.
Select (check) this option if desired.
Zero Pressure Nodes - A checkbox used to indicate whether nodes with zero pressure values are
reported. Select (check) this option if desired.
Pressure Drop Per - A data field used to enter the unit value to be used to calculate the Pressure Drop Per
Unit Length values. Enter a value by typing it into the data field.
Printer Dimensional Units - A pair of option buttons used to specify which dimensional unit to apply to
the printer settings used by the Print Control screens. Select the desired option.
Sort All Reports When Opened - A group of option buttons used to specify whether the Header Data,
Customer Data, Node Data, and Pipe Data Reports are automatically sorted when they are opened. Select
the desired option.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.
Save As Default - A command button used to save the current settings as the default setting to be used when
creating a new model.

Notes & Considerations


! The value of the Number Of Decimals To Display is used to indicate the number of digits displayed to the
right of the decimal identifier (point) when displaying the associated value.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

155

GASWorkS 9.0

Data Screens
Table Of Contents

! The Pressure Drop Per Unit Length value is calculated by dividing the product of the linear pressure drop
and the length of the pipe segment, by the Pressure Drop Per (Length) value.
! The exception options only apply when the Include Exceptions In Log Report option is selected (checked)
in the Solution Data options. The Exception Report can be used to troubleshoot a model that is not
converging or as a quick double-check for model validity.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

156

GASWorkS 9.0

Data Screens
Table Of Contents

Run File Specifications Screen


GASWorkS provides access to the run file data through the Run File Specifications screen. The screen is
accessed by selecting the Execute Run File menu item from the Analysis menu list. The features of the screen
are described as follows.

Data Items
Design Factor - Specifies the value of the design factor to be used during the solution of the specified model.
To enter a value, click in the associated data cell, then type the desired value. If this value is non-zero, it will
replace the value assigned to the model. This item can be useful when solving a system of models for various
load scenarios.
Model Name - Specifies the name of the model to be solved. To select a value, click in the associated data
cell, then select an item from the list. The contents of the list represent the models contained in the directory
(folder) containing the current run file.
Output Model Name - Specifies the name of the model to save the results of the solution to. To select a
value, click in the associated data cell, then select an item from the list.
Run Sequence -Refers to the order in which the model is to be solved. For example, if the value of this item
is 3, the model identified by the Model Name would be solved third in the solution sequence. Models are
solved in the order listed in the report. Use the Move Record icon to change the order of the model list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

157

GASWorkS 9.0

Data Screens
Table Of Contents

Command Buttons & Icons


Add Record - An icon used to add a new record to the end of the list. After the new record is
added, enter new data by clicking in the associated data cell. Either a data cell or a data list will
appear. Either type the desired value or select an item from the list. Press the Enter key or click
in another data cell to save any changes.
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.
Delete Record - An icon used to delete the currently selected (highlighted) record.

Insert Record - An icon used to insert a new record just before the currently selected
(highlighted) record. After the new record is inserted, enter new data by clicking in the associated
data cell. Either a data cell or a data list will appear. Either type the desired value or select an item
from the list. Press the Enter key or click in another data cell to save any changes.
Maximize Window Size - An icon used to cause the screens window size to be increased to fill
the GASWorkS display screen.

Move A Record - An icon used to move the currently selected (highlighted) record to a new
location in the list. When selected, a prompt will appear for the new location to move the record
to.
Open - An icon used to open a previously saved run file. When selected, a File Selection screen
will be displayed. Enter or select the desired Filename, then select the Open command button.

Reset Window Size - An icon used to cause the screens window size to be normalized or
reduced to its standard size.

Save - An icon used to save the contents of the currently displayed run file. When selected, a File
Selection screen will be displayed. Enter or select the desired Filename, then select the Save
command button. Once saved, the file can be opened and used with other models.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

158

GASWorkS 9.0

Data Screens
Table Of Contents

Notes & Considerations


! The Design Factor specified in the Run File replaces the value contained in the associated model's header
data. However, if the value is left empty or set to zero, the solution process will use the corresponding value
found in the associated model's header data.
! The results of the analysis can be saved to a model different than the Source model. This is helpful when
you may want to use a base model and run it at different design factors. By specifying a different output
model name, the original base model is not affected.
! Additional information about using the Run File feature is contained in Miscellaneous section of this
Manual.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

159

GASWorkS 9.0

Data Screens
Table Of Contents

Solution Data Screen


GASWorkS provides access to the various solution options and data values through the Solution
Data screen. To access the screen, either select the Solve icon, or select the Solve Single Model
menu item from the Analysis menu list. The features of the screen are described as follows.

Solution Data Tab

Data Items
Atmospheric Pressure Method - A panel used to display the various methods available for calculating the
atmospheric pressure values used in the solution. The atmospheric pressure is used to convert gauge pressure
values to absolute pressure values needed in the calculations. To select a calculation method, click on the
desired item in the list to highlight it. A description of the available calculation methods can be found in the
Appendix section of this Manual.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

160

GASWorkS 9.0

Data Screens
Table Of Contents

Compressibility Method - A panel used to display the various methods available for calculating the
compressibility factors used in the solution. The compressibility factor is used to compensate for the
deviation of gas behavior from the ideal gas law, at elevated pressures. Generally, this deviation can be
ignored for systems operating at pressures less than 200 Psig. To select a calculation method, click on the
desired item in the list to highlight it. A description of the available calculation methods can be found in the
Appendix section of this Manual.
Convergence Tolerance - A data field used to enter the maximum acceptable node error for the solution.
Enter a value by typing it into the data field. Ensure the value is expressed in terms of the selected
dimensional unit. See the following Notes & Considerations section for suggestions on selecting an
appropriate convergence tolerance.
Design Factor - A data field used to enter a multiplication factor to be applied to the node loads during the
solution. Enter a value by typing it into the data field. See the following Notes & Considerations section for
additional details.
Divergence Limit - A data field used to enter the value of the maximum number of consecutive diverging
or same value iterations allowed during the solution. If the number is exceeded, the solution will be
terminated. Enter a value by typing it into the data field. See the following Notes & Considerations section
for additional details.
Maximum Iterations - A data field used to enter the maximum permissible number of iterations the solution
can make before ending. Enter a value by typing it into the data field. See the following Notes &
Considerations section for additional details.
Solution Options - A panel used to display the various solution options to be included during the Solution
routine.
Apply Design Factor To External Loads - A checkbox used to indicate whether the external loads
will be multiplied by the design factor when calculating the node loads during the solution. Select
(check) this option if desired.
Calculate Diversity - A checkbox used to indicate whether the IGE Diversity calculations will be
performed during the solution. When selected (checked) this option will cause the load associated
with non-diversified customers to be applied to the downstream node of the supplying main,
regardless of the node application setting. Select (check) this option if desired.
Calculate Gas Mixing - A checkbox used to indicate whether the gas property values will be
calculated based on the mixed flow rates. Select (check) this option if desired.
Calculate Pipe Sizes (Optimize) - A checkbox used to indicate whether the sizes of the pipes
allowed to be sized (optimized) will be calculated. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

161

GASWorkS 9.0

Data Screens
Table Of Contents

Calculate Temperature Values - A checkbox used to indicate whether the average temperature will
be calculated for each node where the temperature is set as Unknown. Select (check) this option if
desired.
Flag Large Error Node Upon Completion - A checkbox used to indicate whether a flag symbol
will be placed at the location of the node with the largest error. The flag will be placed after the
solution is finished. Select (check) this option if desired.
Ignore Elevation Differences - A checkbox used to indicate whether the node elevation differences
will be ignored when calculating node pressures. However, the correct atmospheric pressure values
will be used. Select (check) this option if desired.
Include Exceptions In Log Report - A checkbox used to indicate whether a check for unusual
conditions will be performed when the data is being saved after the solution. Any problems that are
found are referred to as exceptions and are included in the Solution Log Report. The exceptions
included in the check are controlled by the Report Options menu item found in the Report menu list.
Select (check) this option if desired.
Reset Unknown Node Pressures To Zero - A checkbox used to indicate whether the unknown
pressure values will be set to zero (0) before solving the model. This option is advised when using
the pipe sizing or calculate diversity options. Select (check) this option if desired.
Smart Processing Of One-Way Segments - A checkbox used to indicate whether one-way
segments (meeting certain criteria) will be excluded from the trial and error (iterative) portion of
the solution. The solution for these types of segments is explicit and does not require iteration to
solve. If the model contains any one-way segments, choosing this option will increase the solution
speed. Select (check) this option if desired.
Solve Unspecified Facilities - A checkbox used to indicate whether the Facility Types will be
included in the Solution routine. Select (check) this option if desired.
Update Color Coding - A checkbox used to indicate whether the color-by-range color coding will
be updated upon completion of the solution. The current range and color criteria is used to update
the GDI display. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

162

GASWorkS 9.0

Data Screens
Table Of Contents

Pipe Sizing Control Tab


See the following Notes & Considerations section, the Miscellaneous section of this Manual, or the Help
System for additional information on the Pipe Sizing (Optimization) routine and the affect of the various data
items and options on the sizing process.

Data Items
Condition Nodes - A data field used to enter up to ten condition node names. Enter a value by typing it
into the data field. If no condition nodes are identified, only the overall system pressure will be used.
Condition Pressure - A data field used to enter the required pressure value for the associated condition node
location. Enter a value by typing it into the data field. Ensure the value is expressed in terms of the assigned
dimensional unit.
Maximum Velocity - A data field used to enter the maximum allowable velocity. Enter a value by typing
it into the data field. Ensure the value is expressed in terms of the assigned dimensional unit.
Optimize By - A pair of option buttons used to specify whether the pipe size or pipe cost will be used as the
selection basis during the Optimization routine. When the Size option is selected, smaller pipe sizes will
always be used before larger pipe sizes. When the Cost option is selected, lower cost pipes will always be
selected before higher cost pipes. Select the desired option.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

163

GASWorkS 9.0

Data Screens
Table Of Contents

Pass Limit - A data field used to enter the number of passes that the Optimization routine is allowed to
execute. Enter a value by typing it into the data field. If the limit is reached before the routine is complete,
the routine will be stopped and the current pipe sizes will be saved. To restart the Optimization routine after
the pass limit has been reached, re-solve the model remembering to unselect (uncheck) the Reset Diameters
To Minimum Size option.
Path Processing - A drop-down list used to select the type of path processing method that will be used
during the Optimization routine. Select an item from the list. During the Optimization routine, the lowest
pressure node is found (when check values are minimums). Then a path is determined along the pipes feeding
into the low pressure node, back to the source of supply. The size of the pipes along this path are increased.
The path processing item specifies how the path is created and how the pipes are selected for a size increase.
Pipe Size Table - A drop-down list used to select the Pipe Property Table that will be used when calculating
pipe sizes in the Solution routine. Select a table from the list.
Pressure Values Are - A pair of option buttons used to specify whether the check (condition and system)
pressure values represent maximum or minimum values. Select the desired option.
Reset Diameters To Minimum Size - A checkbox used to indicate whether the size for all of the pipes
where the Use When Sizing option is selected, will be set to the minimum allowed value. Select (check) this
option if desired.
System Pressures - A data field used to enter the value of the overall system pressure requirement. Enter
a value by typing it into the data field. Ensure the value is expressed in terms of the selected dimensional
unit.

Command Buttons
Solve & Calculate Pipe Sizes - A command button used to perform the solution and calculate pipe sizes.
When selected, the Solution Log will be displayed. This command serves the same function as selecting
(checking) the Calculate Pipe Sizes (Optimize) solution option, then selecting the Solve command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

164

GASWorkS 9.0

Data Screens
Table Of Contents

Other Settings Tab

Data Items
Base Pressure - A data field used to enter the pressure basis for the volume measurement. Enter a value by
typing it into the data field. Ensure the value is expressed in terms of the selected dimensional unit.
Base Temperature - A data field used to enter the temperature basis for the volume measurement. Enter a
value by typing it into the data field. Ensure the value is expressed in terms of the assigned dimensional unit.
Calculation Method - A drop-down list used to select the method to be used to calculate the heat exchange
between the flowing gas and the surrounding environment. Select a method from the list. The available
methods are described in the following Notes & Considerations section.
Diameter Path Factor - A data field used to enter the diameter factor (exponent) to use when an applicable
path processing method is used during the Pipe Sizing routine. Enter a value by typing it into the data field.
This item will only be enabled when the Flow Processing Only Path Processing method is selected.
Include Joule-Thomson Effect For Pipes - A checkbox used to indicate whether the Joule-Thomson effect
(cooling due to pressure drop) will be estimated for each pipe segment. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

165

GASWorkS 9.0

Data Screens
Table Of Contents

Length Path Factor - A data field used to enter the length factor (exponent) to use when an applicable path
processing method is used during the Pipe Sizing routine. Enter a value by typing it into the data field. This
item will only be enabled when the Flow Processing Only or Flow-Pressure Drop Processing Path
Processing method is selected.
Lower Dampening - A data field used to enter the lower dampening factor for the solution. Enter a value
by typing it into the data field. The influence of the lower dampening factor is described in the following
Notes & Considerations section.
Pressure Drop Path Factor - A data field used to enter the pressure drop factor (exponent) to use when an
applicable path processing method is used during the Pipe Sizing routine. Enter a value by typing it into the
data field. This item will only be enabled when the Flow-Pressure Drop Processing Path Processing method
is selected.
Upper Dampening - A data field used to enter the upper dampening factor for the solution. Enter a value
by typing it into the data field. The influence of the upper dampening factor is described in the following
Notes & Considerations section.
Heat Exchange Parameters - The contents of this section will vary depending on the selected calculation
method.
Convection & Conduction - This method is useful when considering a buried pipe that may or may
not have insulating material applied to it. Convection between the gas stream and the pipe wall,
conduction through the pipe wall, insulation, and soil (environment) are considered. An
environmental influence zone may be specified using the Influence Factor. If no insulation is present
the Insulation Thickness may be set to zero (0).
Ambient Temperature - A data field used to enter the temperature at the outside of the
influence zone. Enter a value by typing it into the data field. Ensure the value is expressed
in terms of the assigned dimensional unit.
Environment Conductivity - A data field used to enter the thermal conductivity of the
environment within the influence zone. Enter a value by typing it into the data field. Ensure
the value is expressed in terms of the assigned dimensional unit.
Influence Factor - A data field used to enter the influence zone size of the environment.
Enter a value by typing it into the data field. The pipe outside diameter is multiplied by the
specified factor to determine the thickness of the influence zone thickness of the
environment surrounding the pipe.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

166

GASWorkS 9.0

Data Screens
Table Of Contents

Insulation Conductivity - A data field used to enter the thermal conductivity of the
insulation material. Enter a value by typing it into the data field. If no insulation is present,
set the value to zero (0).Ensure the value is expressed in terms of the assigned dimensional
unit.
Insulation Thickness - A data field used to enter the thickness of any insulation applied to
the exterior of the pipe. Enter a value by typing it into the data field. If no insulation is
present, set the value to zero (0). Ensure the value is expressed in terms of the selected
dimensional unit.
Pipe Conductivity - A data field used to enter the thermal conductivity of the pipe material.
Enter a value by typing it into the data field. Ensure the value is expressed in terms of the
assigned dimensional unit.
Convection Only - This method only considers convection heat transfer between the gas stream and
the pipe wall. This method would be useful when the pipe is exposed to the atmosphere, submerged
in a liquid, or buried in soil with a high transfer rate - locations where the surrounding environment
can act as a large heat sink and can essentially maintain a constant wall temperature on the pipe.
Wall Temperature - A data field used to enter the temperature of the pipe wall. Enter a
value by typing it into the data field. Ensure the value is expressed in terms of the assigned
dimensional unit.
Overall Transfer Coefficient - This method is useful when the value of the overall heat transfer
coefficient is known or can be estimated. The heat transfer is based on the specified coefficient.
Ambient Temperature - A data field used to enter the temperature at the outside edge of
the environment associated with the specified coefficient value. Enter a value by typing it
into the data field. For example, if a pipe is buried, the environment would be the soil
surrounding the pipe, and the ambient temperature might represent the soil temperature near
the surface or at the edge of the influence zone. Ensure the value is expressed in terms of
the assigned dimensional unit.
Transfer Coefficient - A data field used to enter the value of the overall heat transfer
coefficient. Enter a value by typing it into the data field. Ensure the value is expressed in
terms of the assigned dimensional unit.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

167

GASWorkS 9.0

Data Screens
Table Of Contents

Model Notes Tab

Data Items
Notes - Allows access to the Model Notes. Enter or revise the notes as appropriate by typing them into the
edit box. The Model Notes may consist of a description of the model and analysis. Special characters can
be used. The maximum length for the notes is approximately 32,000 characters. See the Model Notes Screen
Description in the Data Screens section of this Manual for additional details.

Command Buttons
Cancel - A command button used to close the screen without performing the solution and without saving any
changes to the data values.
Close - A command button used to close the screen without performing the solution, and saving any changes.
Solve - A command button used to perform the solution. When selected, the Solution Log will be displayed.
When the solution is complete, select the Close command button to close the log and return to the GDI
Window.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

168

GASWorkS 9.0

Data Screens
Table Of Contents

Notes & Considerations


! The Convergence Tolerance represents the maximum allowable imbalance of the solution results. If a
solution is attained for a tolerance of 0.01 Mcfh, it can be said that the solution results are within +/- 0.01
Mcfh of the exact solution for that particular model. The value of the tolerance is generally determined based
on the magnitude of the total expected system flows. The acceptable tolerance for a particular model depends
on the intended use of the results. For very tight results use a Convergence Tolerance of about one tenth
of one percent (one-thousandth) of the total expected system flow. For example, if the total system flow is
expected to be of the magnitude of 10 Mcfh the convergence tolerance might be 0.01 Mcfh. For less accurate
results, use a Convergence Tolerance of about one percent of the total expected system flow. See the
Miscellaneous section of this Manual for suggestions on handling various convergence problems and solution
errors.
! The Design Factor is used to adjust the node loads in the model. Depending on the individual node
settings, the known node loads are multiplied by the Design Factor to calculate the load values to be used
in the analysis. The Design Factor is expressed as a decimal. For example, to enter a factor representing fifty
percent, input 0.5. The Design Factor is only applied to nodes where the Adjust By Design Factor option has
been selected. The Design Factor is not applied to the external load values, unless the Apply Design Factor
To External Loads option is selected (checked) prior to the solution.
! The Divergence Limit identifies the number of consecutive diverging or equivalent error iterations that
will be allowed before the solution procedure is terminated. During the solution procedure, node errors
normally continue to decrease as the solution procedure progresses. Sometimes when solving a model, the
node errors might increase for a few iterations, then begin to decrease again. However, when trying to solve
a model containing an error, or when a model is "running-out-of-gas", the node errors may continue to
increase or stay the same, never allowing the solution to reach a state of balance. The Divergence Limit
causes the solution procedure to be automatically terminated when this occurs.
! The Lower Dampening Factor is used to stop adjustment of certain node pressures. Often several nodes
in the model are balanced, while only a few nodes require further adjustment. The nodes where the pressure
adjustment value is less than the current pressure value multiplied by the lower dampening factor will not
be adjusted any further. The Lower Dampening Factor can influence the quality of the solution. However,
if the factor is properly chosen, it can decrease the number of iterations required to reach a solution, with
only a negligible influence upon the overall quality of the solution. Generally the Lower Dampening Factor
should be set to zero (0).
! The Maximum Iteration value limits the number of times that GASWorkS will attempt to reach a solution
within the specified tolerance. The number of iterations required to reach a solution varies with each model,
and with the value of the convergence tolerance. If a solution is not reached within the specified number of
iterations, GASWorkS will provide a message warning that the solution has not been completed. The solution
can be re-run and the maximum number of iterations increased as required.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

169

GASWorkS 9.0

Data Screens
Table Of Contents

! The Upper Dampening Factor is used to modify the calculated adjustment for large node errors. The
modification will be applied to errors greater than the Upper Dampening Factor multiplied by the
Convergence Factor. The Upper Dampening Factor generally does not influence the quality of the solution.
However, it can prevent a solution from being reached if improperly chosen. Enter a large number (for
example 10000) to disable the Upper Dampening Factor. Generally the factor should be entered as zero (0).
! During the Optimization routine, certain pressure requirements are checked to determine if the pipes are
properly sized. These pressure requirements can be set in two manners. A pressure may be specified at a
particular location in the system (referred to as a condition node), and an overall pressure may be set for the
entire model. See the Miscellaneous section of this Manual for additional information using the Pipe Sizing
(Optimization) routine and the affect of the various data items and options have on the sizing process.
! The base pressure and temperature are used to establish the basis for a standard volume (for example,
a standard cubic foot or cubic meter) of gas as used by the current model.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

170

GASWorkS 9.0

Data Screens
Table Of Contents

Solution Log
During a solution of a model, GASWorkS displays the Solution Log. The screen allows control
of the solution and viewing of the solution's progress. The screen is accessed by selecting the
Solve icon from the GDI Window. The features associated with the screen are described as
follows.

Data Items
Solution Status - Provides a scrollable display of the Solution Log. To browse the display, adjust the vertical
scroll bar adjacent to the display area.

Command Buttons
Cancel - A command button used to terminate the Solution routine. When selected, the solution will be
terminated - however, depending on the current solution activities, the process may not terminate
immediately. This button is disabled after the solution is complete.
Close - A command button used to close the Solution Log and return to the GDI Window. This button is
disabled during the solution process.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

171

GASWorkS 9.0

Data Screens
Table Of Contents

Notes & Considerations


! If the Include Exceptions In Log Report solution option is selected (checked) prior to the execution of
solving, any exceptions found while saving the solution results will be reported at the end of the Solution
Log. If there are more exceptions than can be contained in the log, the reported exceptions will be truncated.
An end of section message will be reported at the end of the exceptions section.
! The contents of the Solution Log may be printed by selecting the Solution Log menu item from the Report
menu list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

172

GASWorkS 9.0

Data Screens
Table Of Contents

Solution Log Report


During the solution, a log of the solution activities will be created. The log is maintained in a report known
as the "Solution Log". The Solution Log Report may be viewed while the Solution routine is active, or may
be viewed or printed at other times by selecting the Solution Log menu item from the Report menu list. The
features associated with the report are described as follows.

Data Items
Solution Status - Provides a scrollable display of the Solution Log Report. To browse the display, adjust
the vertical scroll bar adjacent to the display area.

Command Buttons & Icons


Close - A command button used to close the report.
Copy To Clipboard - An icon used to copy the contents of the report to the Windows clipboard.
A message will appear when the data has been copied, select the OK command button to clear the
message. Once copied the contents may be pasted to another application.
Maximize Window Size - An icon used to cause the reports window size to be increased to fill
the GASWorkS display screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

173

GASWorkS 9.0

Data Screens
Table Of Contents

Print - An icon used to print the contents of the report. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.
Reset Window Size - An icon used to cause the reports window size to be normalized or
reduced to its standard size.

Notes & Considerations


! If the Include Exceptions In Log Report solution option is selected (checked) prior to the execution of the
solution, any exceptions found while saving the solution results will be reported at the end of the Solution
Log Report. If there are more exceptions than can be contained in the log, the reported exceptions will be
truncated. An end of section message will be reported at the end of the exceptions section.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

174

GASWorkS 9.0

Data Screens
Table Of Contents

Sort Specifications Screen


The Sort routine provides a variety of sorting options for reordering the pipes and nodes in the model data
files. The sort features are controlled through the Sort Specifications screen. The screen is accessed by
selecting the Sort Model menu item from the Miscellaneous submenu of the Utilities menu list. The features
associated with the screen are described as follows.

Command Buttons
Close - A command button used to close the screen.
Sort - A command button used to sort the node and pipes by the selected method.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

175

GASWorkS 9.0

Data Screens
Table Of Contents

Summary Report
The Summary Report includes several specialized report sections. These sections include a summary of the
regulator and compressor data, hoop stress values, pipe lengths, supply nodes, and system components. The
User may indicate which sections they wish to include in the report. The Summary Report routine consists
of two screens, the first is the Summary Report Options screen which is used to select the desired report
sections, and the second is the Summary Report screen which displays the contents of the report. The
Summary Report Options screen is described later in this Manual. The report is accessed by selecting the
Summary menu item from the Report menu list. The features associated with the report are described as
follows.

Data Items
Summary Report - Provides a scrollable display of the Summary Report. To browse the display, adjust the
vertical scroll bar adjacent to the display area.

Command Buttons & Icons


Close - A command button used to close the report screen.
Copy To Clipboard - An icon used to copy the contents of the report to the Windows clipboard.
A message will appear when the data has been copied, select the OK command button to clear the
message. Once copied the contents may be pasted to another application.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

176

GASWorkS 9.0

Data Screens
Table Of Contents

Maximize Window Size - An icon used to cause the reports window size to be increased to fill
the GASWorkS display screen.

Print - An icon used to print the contents of the report. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.
Reset Window Size - An icon used to cause the reports window size to be normalized or
reduced to its standard size.

Notes & Considerations


! The Summary Report Options Screen Description provides additional information about the Summary
Report contents.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

177

GASWorkS 9.0

Data Screens
Table Of Contents

Summary Report Options Screen


The Summary Report includes several specialized report sections. These sections include a summary of the
regulator and compressor data, hoop stress values, pipe lengths, supply nodes, and system components. The
User may indicate which sections they wish to include in the report. The Summary Report routine consists
of two screens, the first is the Summary Report Options screen which is used to select the desired report
sections, and the second is the Summary Report screen which displays the contents of the report. The
Summary Report screen is described previously in the Data Screens section of this Manual. The Summary
Report Options screen is accessed by selecting the Summary menu item from the Report menu list. The
features associated with the screen are described as follows.

Data Items
Compressor Summary - A checkbox used to indicate whether the compressor data is to be included in the
Summary Report. The compressor section reports various data about the compressors found in the system.
Select (check) this option if desired.
Pipe Summary - A checkbox used to indicate whether the pipe data is to be included in the Summary
Report. The pipe section reports pipe footage, inch-diameter values, and cost values grouped by diameter
value. Select (check) this option if desired.
Regulator Summary - A checkbox used to indicate whether the regulator data is to be included in the
Summary Report. The regulator section reports various data about the regulators found in the system. Select
(check) this option if desired.
Supply Summary - A checkbox used to indicate whether a summary of the supply nodes is to be included
in the Summary Report. The supply nodes section lists each node with a positive load value, along with its
load and pressure values. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

178

GASWorkS 9.0

Data Screens
Table Of Contents

System Summary - A checkbox used to indicate whether the system summary is to be included in the
Summary Report. The system summary section reports the number of nodes, pipes, known and unknown
values, and total flow into and out-of the system. Select (check) this option if desired.

Command Buttons
Cancel - A command button used to close the screen without creating the report.
Report - A command button used to create the report and open the Summary Report screen.

Notes & Considerations


! The Summary Report provides a summary of the various data items contained in the model. The report can
be customized to include various User specified items. The available options are described in the following
table.
Option

Features

Compressor (Data)
Summary

Calculates Compression Ratio, Estimated Outlet Temperature, Estimated


Power Requirements, and Estimated Fuel Consumption.
Displays From Node and To Node, Compressor Type, Flow Rate, Flow
Mode, Inlet Pressure, Outlet Pressure, Compression Ratio, Inlet
Temperature, Outlet Temperature, Required Power, Rated Power, and Fuel
Consumption.

Pipe Summary

Displays Total Length, Diameter-Length, and Cost values.


Displays each unique diameter found in the model.
Displays Length summary grouped by diameter.
Displays Diameter-Length summary by diameter.
Displays Cost summary by diameter.

Regulator (Data)
Summary

Calculates Estimated Valve Coefficient, Differential Pressure, Outlet


Temperature, and Coefficient Ratio.
Displays From Node and To Node, Regulator Type, Flow Rate, Flow
Mode, Inlet Pressure, Outlet Pressure, Differential Pressure, Minimum
Differential Pressure, Inlet Temperature, Outlet Temperature, Estimated
Valve Coefficient, Published Valve Coefficient, and Coefficient Ratio.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

179

GASWorkS 9.0

Data Screens
Table Of Contents

Option

Features

Supply (Nodes)
Summary

List all Nodes with a positive load value.

System Summary

Data feature count.

Displays Node Name, Pressure, and Load Values for supply Nodes.

Known and Unknown Pressures (count).


Known and Unknown Loads (count).
Total Known and Unknown Values (count).
Total Flow into and out-of the system.
Customer feature summary.
Miscellaneous model and non-model data summary.
! The dimensional units of certain displayed items are fixed - values for these items are summarized in the
following table.
Displayed Value

Dimensional Units

Total Flow Into System

Set to Load Units of the first node in the model.

Total Flow Out-Of System

Set to Load Units of the first node in the model.

Length (Pipe Summary)

Set to Length Units of the first pipe in the model.

Cost

None

Differential Pressure (Regulators)

Set to Pressure Units of the associated record in the


Regulator Property Table.

Minimum Differential Pressure


(Regulators)

Set to Pressure Units of the associated record in the


Regulator Property Table.

Power Requirements

Set to Power Units of the associated record in the


Compressor Property Table.

Fuel Consumption

Set to Consumption Units of the associated record in


the Compressor Property Table.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

180

GASWorkS 9.0

Data Screens
Table Of Contents

! The Estimated Valve Coefficient calculated in the Regulator Data represents the following parameter:
Flow Equation

Estimated Valve Coefficient

Grove

Cv - Valve Capacity Factor

Rockwell

"K" Factor - Regulator Constant

Universal

Cg (Regulating) - Gas Sizing Coefficient

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

181

GASWorkS 9.0

Data Screens
Table Of Contents

XY Calculation Screen
A routine is provided that allows estimated coordinate values to be automatically calculated for a model
which contains no coordinate information. The routine is controlled using the XY Calculation screen. The
screen is accessed by selecting the Calculate XYs menu item from Miscellaneous submenu of the Utilities
menu list. The features associated with the screen are described as follows.

Data Items
Starting Node Name - A data field used to enter the node name to begin the calculations from. Enter a value
by typing it into the data field. The name must correspond to a node found in the currently open model.

Command Buttons
Calculate - A command button used to perform the calculation. A message will appear when the calculations
are complete. Select the OK command button to clear the message.
Close - A command button used to close the screen.

Notes & Considerations


! The starting coordinate value cannot be specified by the User. If desired, the model can be shifted after
the coordinate calculation is complete, using the Calculate XYs From Lat/Long command.
! Before performing the calculation, ensure that the GDI coordinate units are appropriately set. Select the
Settings menu item from the Graphics menu list to set the coordinate units.
! The image created by this routine is often unsightly. After the routine is complete, the node and pipe
features can be moved, to look a little better, using the various Edit commands.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

182

GASWorkS 9.0

Data Screens
Table Of Contents

! The estimated coordinates are calculated as follows. The specified starting node is assigned a location of
1000000, 1000000. A trace is begun at the starting node and connected pipes are processed in the following
order. The end coordinates for the first pipe found are calculated by extending a line east a distance equal
to its length value. The next pipe is assigned a direction of south, the next west, the next north, and their end
coordinates are calculated based on their length values. If more than four pipes are connected, the fifth and
sixth pipes are assigned a direction of southeast and southwest respectively. Once the first node has been
processed, the remaining nodes are processed in a similar fashion until all node locations have been
estimated.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

183

GASWorkS 9.0

Data Screens
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

184

GASWorkS 9.0

GDI
Table Of Contents

GRAPHIC DATA
INTERFACE (GDI)

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

185

GASWorkS 9.0

GDI
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

186

GASWorkS 9.0

GDI
Table Of Contents

This section provides instructions for using the GASWorkS Graphic Data Interface (GDI). A substantial
number of the GASWorkS features and commands are accessed through the GDI. Each of these GDI features
along with the associated data screens are described in this section.
The GDI provides graphical access to the model data. The GDI can be used to create a graphical
representation of the model which can be used to view, edit, and manipulate the GASWorkS model data. The
GDI is not intended to be a "CAD" system, however it does provide some CAD type features. For more
sophisticated graphic needs we recommend using a true drafting/design, mapping, or GIS-AM/FM product.
Data from these applications may then be shared with GASWorkS using one of its many Import routines.
The Help System provides an extensive collection of examples and how-to tips for performing a variety of
tasks using the GDI. The remainder of the section describes the various features associated with the GDI.

GDI Window Description


The GDI features are accessed through the Graphic Data Interface (GDI) Window. The features associated
with the GDI and its layout are described in the following sections.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

187

GASWorkS 9.0

GDI
Table Of Contents

With the exception of the GDI Command Line, the features associated with the GDI Window may only be
accessed by use of the mouse. If your computer system is not equipped with a mouse or compatible pointing
device, you will not be able to use the GDI.
The GDI Window contains several functional areas. The left side of the screen contains a group of icons
representing the GDI toolbar headings. A "fly-out" toolbar will be displayed when the cursor is passed over
each of the headings. The various GDI tools are grouped together on a specific toolbar. For example, tools
for changing the scale and position of the displayed image are grouped on the View Controls toolbar. The
tools (commands) are accessed through the icons displayed on the toolbars. Not all commands are available
from a toolbar - additional commands are accessed through the GDI Command List, or by typing the
command on the GDI Command Line. The meaning and function of each of the commands and icons are
described later in this section.
The central portion of the screen contains the "work area". The work area is the portion of the screen where
the image is displayed and manipulated. The appearance of the image in the display can be modified by
panning (moving right to left, and up or down), and by zooming (enlarging or reducing) the image.
Additionally, the color, size, and style of the features displayed in the work area can be manipulated by the
User.
The portion of the GDI Window directly above the work area is used to enter information needed by the
various GDI Commands, and to prompt the User for the required action. When a value is required, an entry
field will appear in the command area. Data is entered by typing in the provided entry field, then pressing
the Enter key.
The portion of the GDI Window directly below the work area contains the GDI Command Line (lower panel)
and displays the coordinates for the current mouse position or a brief description of the tool icons (upper
panel). When the cursor is moved or placed over an icon, a description of the icon's function is displayed in
the icon description area. The coordinate values represent the current (scaled) position of the cursor.
Commands may be executed by typing their identifying name value, abbreviation, or alias on the GDI
Command Line.
Along the right side of the screen several display panel tabs are displayed. Each panel can contain a
different view of the model. Select a tab to change to the associated view. Different graphic settings may be
set for each tab, however facility display settings are common for all tabs.
There are several special icons displayed on the GDI Window which are described on the following pages.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

188

GASWorkS 9.0

GDI
Table Of Contents

GDI Window Icons


Cancel - An icon used to execute the Cancel Current Command routine. This icon is located in
the upper-left corner of the GDI Window. When selected, the command currently being used will
be terminated and canceled, or if the image display is currently being repainted, the Repaint
routine will be terminated.

GDI Command List - An icon used to control the display of the GDI Command List. This icon
is located in the upper-right corner of the GDI Window. When selected, the GDI Command List
will be displayed. The GDI Command List displays a list or treed grouping of the commands
available in the GDI. Once a command is selected and executed, the GDI Command List is hidden
so that the entire work area is visible.
Two methods are available for controlling the display of the GDI Command List. One method requires the
GDI Command List icon to be clicked to display the list. The other method displays the list when the cursor
is placed over the icon. The desired method can be selected using the Settings menu item from the
Preferences submenu of the File menu list.

Scroll - An icon used to move the GDI image up or down, or right or left. This icon is located in
the lower-left corner of the GDI Window. The process of moving the image is referred to as
panning or scrolling. The amount that the image moves when the Scroll icon is selected, is
determined by the value of the Pan/Scroll Change values. The values are set by selecting the
Settings menu item from the Graphics menu list. To pan the image a certain direction, click the desired arrow
symbol on the Scroll icon.

Solve - An icon used to display the state of the model and allows the solution to be executed. This
icon is located in the lower-right corner of the GDI Window. The icon indicates whether the
model is balanced (blue balanced scale) or unbalanced (red unbalanced scale). When a change
is made to the model data, the model is considered to be unbalanced. This icon can also be used
to execute the Solve Model command. When selected, the Solution Data screen will be displayed.

Tool Palette - An icon used to control the display of the Tool Palette. This icon is located in the
upper-right corner of the GDI Window. When selected, the display of the Tool Palette will be
turned on or off. During command execution, the Tool Palette is hidden so that the entire
work area is visible. When the command is completed, the Tool Palette will be displayed again.
During a command the Tool Palette may be made visible by moving the cursor over this icon.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

189

GASWorkS 9.0

GDI
Table Of Contents

Undo - An icon used to execute the Restore routine. This icon is located in the upper-left corner
of the GDI Window. When selected, the command will undo the most previous graphic or data
change, if the Allow Undo Of Graphic/Data Changes preference option has been selected
(checked). If the Allow Undo preference option is not selected (not checked), this command has
no affect. The Allow Undo preference option can be set using the Settings menu item from the Preferences
submenu of the File menu list.

The GDI supports coordinate values ranging from 0 to 9999999. The Shift Model Coordinates command can
be used to shift, scale, and rotate an image's coordinate values if they fall outside the allowable range. The
dimensional unit of the coordinates are set by selecting the Settings menu item from the Graphics menu list.
When a new pipe is added, its length value is calculated based on the graphical length between its From
Node, To Node, and vertex coordinates. The User may override the calculated value by manually entering
the desired length value. Node names are automatically assigned during new pipe entry. The User may
override the assigned name by manually entering the desired value. The node increment (difference between
new node name/numbers) is controlled by a setting in the Default Data. Select the Set Defaults menu item
from the Utilities menu list to access the default settings.
Depending on the zoom scale, certain items may or may not be displayed. The display of text is controlled
by a User specified setting. The display of features like the customer symbols, node symbols, and flow
arrows are automatically controlled by the GDI, depending on how their size value is set. Symbol sizes can
be specified in one of two methods - absolute or relative. With the absolute method the symbol size is
expressed in terms of the coordinate units. As the model image is enlarged or reduced, the display of the
symbols are resized accordingly. With the relative method, a factor expressed as a percentage, is used to
specify the symbol size. The factor is applied to the diagonal distance across the GDI work area. The result
is that the symbol size is always displayed at the same size regardless of the zoom scale. When an absolute
size is used, and the image is zoomed to a scale where the symbols would appear very small, they are not
displayed. As the magnification of the image is increased, the symbols will eventually appear.

GDI Toolbars
Attribute Valve Commands - A toolbar that contains commands used for manipulating attribute
style valves.

Customer Data Commands - A toolbar that contains commands used for manipulating customer
features.

Data Edit Commands - A toolbar that contains commands used for viewing and editing pipe and
node data values.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

190

GASWorkS 9.0

GDI
Table Of Contents

Display Controls - A toolbar that contains commands used for control of the display of data text,
feature colors, symbols, and the background image.

Graphic Construction Commands - A toolbar that contains commands used for adding and
deleting pipe features.

Graphic Edit Commands - A toolbar that contains commands used for editing pipe and node
features.

Graphic Utility Commands - A toolbar that contains commands used for performing various
utility commands such as plotting and tracing.

Graphic Window Controls - A toolbar that contains commands used for controlling the GDI
Window.

User Graphic Commands - A toolbar that contains commands used for manipulating User
Graphic Symbol and Line features.

User Text Commands - A toolbar that contains commands used for manipulating User Text
features.

View Controls - A toolbar that contains commands used for zooming and panning the GDI image.

GDI Commands & Icons Descriptions


The GDI Commands (tools) can be executed in three manners - by selecting the command from the GDI
Command List, by clicking on the icon which represents the command from the various toolbars, or by typing
the command name on the GDI Command Line.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

191

GASWorkS 9.0

GDI
Table Of Contents

GDI Command Line Method


The GDI Command Line allows commands to be executed by typing the command name, an abbreviation
for the command, or an alias for the command. Command names and abbreviations are listed later in this
section. Instructions on creating User defined alias values is provided later in this Manual.
To execute a command from the GDI Command Line, type the name, abbreviation, or alias in the GDI
Command Line entry box, then press the Enter key to execute the command.
Commands can be entered in lower, upper, or proper case and can contain spaces in their syntax. For
example, the Add 2-Point Pipe command can be entered as ADDPIPE, addpipe, or Add Pipe.

GDI Command List Method


The GDI Command List presents the commands in two different formats - one is an alphabetical list, the
other is a grouped list in a treed format.
To select a command from the GDI Command List,
display the GDI Command List by clicking on the GDI
Command List icon. Select the desired tab. When the
grouped list is displayed, click on a toolbox to display
the commands contained in a specific grouping. When
the alphabetic list is displayed, a command can be
found by typing the unique portion of the command
name - as the command is typed, the command name
which matches the typed characters will be displayed at
the top of the GDI Command List. Click the desired
command to execute.

GDI Toolbar Method


To select a command using its icon, position the cursor over the associated toolbar, the toolbar will be
expanded. On the expanded toolbar (or Tool Palette if it is displayed), left-click on the desired icon.

Additional Information
To re-execute the most previously executed command, press the Enter key, or right-click while the cursor
is positioned over the GDI work area.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

192

GASWorkS 9.0

GDI
Table Of Contents

The Help System contains numerous examples and how-to tips for using the various GDI Commands. Refer
to the appropriate help topic to review detailed information about using each of the commands.
The various methods available for entering coordinates are described later in this section and in the Help
System.
If the Query During New Feature Entry graphic option is selected (checked), the following events will occur
when a pipe is added. If one or both of the nodes do not already exist, a data screen will be displayed to allow
entry of the new node data values. When both nodes have been entered, the Pipe Data screen will be
displayed to allow entry of the new pipe's data values. The Query During New Feature Entry graphic option
is set by selecting the Settings menu item from the Graphics menu list.
The various data screens which appear during the execution of certain commands are described later in this
section.
The commands contained in the GDI are listed on the following pages. If the command does not have an
associated icon, the command can only be executed by selecting it from the GDI Command List, or by typing
it on the GDI Command Line.

Descriptions
Add 2-Point Pipe - Adds a new 2-point style pipe feature to the model. Executing this command
will cause a series of prompts to appear to identify the From and To Node Locations.
Toolbar: Graphic Construction Commands
GDI Command Line: ADDP, ADDPIPE, AP, PIPE

Add Arc Pipe - Adds a new arc-style pipe feature to the model. Executing this command will
cause a series of prompts to appear to identify the From and To Node Locations. After both nodes
have been entered, adjust the pipes curvature by moving the cursor.
Toolbar: Graphic Construction Commands
GDI Command Line: AAP, ADDARC, ADDARCPIPE, ARC

Add Attribute Valve - Adds an attribute valve to a pipe feature. Executing this command will
cause a series of prompts to appear to identify the pipe to add the valve to and the location of the
new valve.
Toolbar: Attribute Valve Commands
GDI Command Line: AAV, ADDATTRIBUTEVALVE, ADDAV

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

193

GASWorkS 9.0

GDI
Table Of Contents

Add Branch Customer - Adds a branch-style customer feature. A branch customer can only be
added to an existing non-branch customer. Executing this command will cause a series of prompts
to appear to identify the branch customer location, the trunk customer, and the tap location.
Toolbar: Customer Data Commands
GDI Command Line: ABC, ADDBRANCH, ADDBRANCHCUSTOMER, BRANCH

Add Compressor - Adds a compressor type pipe feature. Executing this command will cause a series of
prompts to appear to identify the compressors From and To Node Locations. After both nodes have been
entered, additional prompts will appear to complete the process. Note - When entering a compressor, the
From Node must represent the upstream (suction) side of the compressor and the To Node must represent
the downstream (discharge) side of the compressor.
Toolbar: None
GDI Command Line: ADDCOMP, ADDCOMPRESSOR, COMPRESSOR

Add Customer - Adds a customer feature. Executing this command will cause a series of prompts
to appear to identify the customer location and the supply main for the customer.
Toolbar: Customer Data Commands
GDI Command Line: AC, ADDC, ADDCUST, ADDCUSTOMER, CUSTOMER

Add Customer - Auto-Assign Main - Adds a customer feature and automatically assigns the
customer to the main nearest the customer location. Executing this command will cause a prompt
to appear for the customer location.
Toolbar: Customer Data Commands
GDI Command Line: AAC, ADDAUTOCUSTOMER, AUTOCUST

Add Customer - Unassigned - Adds a customer feature, but does not require a supply main assignment.
Executing this command will cause a prompt to appear to identify the customer location. The customer can
be assigned to a supply main at another time using the Reassign Customer command.
Toolbar: None
GDI Command Line: None

Add Duplicate Customer - Adds a new customer by duplicating an existing customer. Executing this
command will cause a series of prompts to appear to identify the customer to be duplicated and the number
of customers to add. The new customer(s) will be placed at the same location with the same data values.
Toolbar: None
GDI Command Line: ADDDUP, ADDDUPCUST, ADDDUPLICATECUSTOMER, ADUP,
DUPLICATE

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

194

GASWorkS 9.0

GDI
Table Of Contents

Add Hydraulic Valve - Adds a valve type pipe feature. Executing this command will cause a series of
prompts to appear to identify the valve From and To Node Locations. After both nodes have been entered,
additional prompts will appear to complete the process.
Toolbar: None
GDI Command Line: ADDVALVE, AV, VALVE

Add Legend As Text - Converts the current Color Legend into User style text and places the text in a User
specified location. Executing this command will cause a series of prompts to identify the location, text
rotation, and the text height. The Color Legend must be converted to text to be printed.
Toolbar: None
GDI Command Line: None

Add Multiple 2-Point Pipes - Adds multiple 2-point style pipe features. Executing this command will cause
the Add 2-Point Pipe command to be repeated until the Esc key is pressed, the right mouse button is clicked,
or the Cancel icon is selected.
Toolbar: None
GDI Command Line: None

Add Multiple Attribute Valves - Adds multiple attribute valves. Executing this command will cause the
Add Attribute Valve command to be repeated until the Esc key is pressed, the right mouse button is clicked,
or the Cancel icon is selected.
Toolbar: None
GDI Command Line: None

Add Multiple Customers - Adds multiple customer features. Executing this command will cause the Add
Customer command to be repeated until the Esc key is pressed, the right mouse button is clicked, or the
Cancel icon is selected.
Toolbar: None
GDI Command Line: None

Add Multiple Customers - Auto-Assign Main - Adds multiple customer features and
automatically assigns the supply main. Executing this command will cause the Add Customer Auto-Assign Main command to be repeated until the Esc key is pressed, the right mouse button
is clicked, or the Cancel icon is selected.
Toolbar: Customer Data Commands
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

195

GASWorkS 9.0

GDI
Table Of Contents

Add Multiple Polyline Pipes - Adds multiple polyline style pipe features. Executing this command will
cause the Add Polyline Pipe command to be repeated until the Esc key is pressed, the right mouse button is
clicked, or the Cancel icon is selected.
Toolbar: None
GDI Command Line: None

Add Polyline Pipe - Adds a new polyline style pipe feature to the model. Executing this
command will cause a series of prompts to appear to identify the From Node Location and the
next vertex. To end the pipe entry, press the Enter key or right-click.
Toolbar: Graphic Construction Commands
GDI Command Line: ADDPOLY, ADDPOLYLINEPIPE, APP, PLINE, POLY

Add Polyline Service Customer - Adds a new customer feature with a polyline style service line.
Executing this command will cause a series of prompts to appear to identify the main tap location,
the service line route, and the customer location.
Toolbar: Customer Data Commands
GDI Command Line: ADDPOLYS, ADDPOLYSERVICE, APS, SERVICE

Add Polyline Vertex - Adds a new vertex to an existing polyline or 2-point style pipe feature.
Executing this command will cause a series of prompts to appear to identify the pipe to be
modified and the location of the new vertex.
Toolbar: Graphic Edit Commands
GDI Command Line: ADDPIPEVERTEX, ADDPVTX, APV

Add Regulator - Adds a regulator type pipe feature. Executing this command will cause a series of prompts
to appear to identify the regulator From and To Node Locations. After both nodes have been entered,
additional prompts will appear to complete the process. Note - When entering a regulator, the From Node
must represent the upstream (high pressure) side of the regulator and the To Node must represent the
downstream (low pressure) side of the regulator.
Toolbar: None
GDI Command Line: ADDREG, ADDREGULATOR, AR, REGULATOR

Add Service Line Vertex - Adds a new vertex to an existing polyline or 2-point style customer
service line. Executing this command will cause a series of prompts to appear to identify the
customer to be modified and the new vertex location.
Toolbar: Customer Data Commands
GDI Command Line: ADDSERVICEVERTEX, ADDSVTX, ASV

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

196

GASWorkS 9.0

GDI
Table Of Contents

Add User Graphic Line - Adds a User Graphic Line feature. Executing this command will cause
a series of prompts to appear to identify the line style, width, and start and end locations.
Toolbar: User Graphic Commands
GDI Command Line: ADDGRAPHICLINE, ADDLINE, AGL, LINE

Add User Graphic Symbol - Adds a User Graphic Symbol feature. Executing this command will
cause a series of prompts to appear to identify the symbol style, location, rotation, and size.
Toolbar: User Graphic Commands
GDI Command Line: ADDGRAPHICSYMBOL, ADDSYM, AGS, SYMBOL

Add User Text - Adds a User Text feature. Executing this command will cause a series of
prompts to appear to identify the text location, rotation, height, and value.
Toolbar: User Text Commands
GDI Command Line: ADDT, ADDTEXT, ADDUSERTEXT, AT, TEXT

Add Well - Adds a well type pipe feature. Executing this command will cause a series of prompts to appear
to identify the From and To Node Locations. After both nodes have been entered, additional prompts will
appear to complete the process.
Toolbar: None
GDI Command Line: ADDWELL, AW, WELL

Adjust Arc - Adjusts the radius of an existing arc style pipe element. Executing this command will cause
a series of prompts to appear to identify the arc pipe to be adjusted and the new radius. Note - When using
the Semicircle option, S = -1 creates a counter-clockwise semi-circle, S = 0 creates a semi-circle in the same
direction as the original arc, S = 1 creates a clock-wise semi-circle.
Toolbar: None
GDI Command Line: None

Arrange Tool Palette - Opens the Tool Palette for User manipulation. Executing this command
will cause the Tool Palette to be displayed in edit mode. Select the Close icon (in the lower-right
corner of the Tool Palette) to close the Tool Palette and exit edit mode. Once closed, the Tool
Palette can be resized and moved. See the Tool Palette Screen Description in this section of the
Manual for further details on arranging the contents of the palette.
Toolbar: Graphic Utility Commands
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

197

GASWorkS 9.0

GDI
Table Of Contents

Assign Attribute Valves - Assigns or reassigns attribute valves contained in the valve index file to the
associated main. Matches are made geographically. Executing this command will cause a message to appear
asking to select whether all unassigned valves to be assigned to the pipe nearest the valves location or to
reassign the valves. This command is useful when importing attribute valves from an outside source.
Toolbar: None
GDI Command Line: None

Assign Customer Service Lines - Automatically assigns customers to a supply pipe (main). Executing this
command will cause a message to appear asking to select whether all customer service line locations should
be determined, or only service lines for customers that are unassigned. GASWorkS will process the selected
customer types, find the main nearest the customer location, and assign the customer to that main. A 2-point
service line will be placed from the customer symbol location to a perpendicular (where possible) tap
location on the assigned pipe. This command is useful when importing customer features from an outside
source.
Toolbar: None
GDI Command Line: None

Break Flagged Intersections - Automatically breaks intersections at flagged locations. Use the Flag
Unbroken Intersections command to find and flag unbroken intersections. Executing this command will
cause the header pipe at each flagged intersection to be tapped and the lateral pipe to be connected to
the new tap. This feature is useful for cleaning up pipe data imported from an outside source. Note - See
the Help Guide for considerations for using this command.
Toolbar: None
GDI Command Line: None

Calculate Delta P (Linear) - Calculates the pressure difference between a pair of selected node points.
Executing this command will cause a series of prompts to appear to identify the node points. The linear
absolute pressure difference between the two points will be calculated and displayed.
Toolbar: None
GDI Command Line: CALCDP, CALCULATEDELTAP

Calculate Delta P (Squared) - Calculates the difference of squared pressures between a pair of selected
node points. Executing this command will cause a series of prompts to appear to identify the node points.
The difference in squared absolute pressures between the two points will be calculated and displayed.
Toolbar: None
GDI Command Line: CALCDP2, CALCULATEDELTAP2

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

198

GASWorkS 9.0

GDI
Table Of Contents

Calculate Efficiency - Calculates the efficiency along the flow path between a pair of selected node points.
Executing this command will cause a series of prompts to appear to identify the node points and the desired
pressure difference. An iterative series of calculations will be performed to compute the pipe efficiency
value, along the flow path between the selected nodes, required to match the specified pressure values. Note There should only be pipe type hydraulic elements between the selected nodes and all pipes should be
assigned the same pipe flow equation.
Toolbar: None
GDI Command Line: CALCE, CALCULATEEFFICIENCY

Calculate XYs From Lat/Long - Calculates estimated planar XY coordinates for model features whose
original coordinates are in latitude and longitude. Executing this command will cause new XY coordinate
values to be calculated for the customer, node, and pipe features, based on current coordinate values and
certain calculation assumptions.
Toolbar: None
GDI Command Line: None

Calibrate Digitizing Tablet (2-Point) - Calibrates the digitizing tablet for use with the GDI using a 2-point
registration method. Executing this command will cause a series of prompts to appear to enter the required
registration points.
Toolbar: None
GDI Command Line: None

Calibrate Digitizing Tablet (X-Point) - Calibrates the digitizing tablet for use with the GDI using a multipoint registration method. Executing this command will cause a series of prompts to be displayed to enter
the required registration points.
Toolbar: None
GDI Command Line: None

Cancel Current Command - Cancels the currently executed GDI Command, or stops the image
display if it is currently being repainted. Executing this command causes the execution of any
running command to be terminated. This command can also be used to interrupt the GDI display
drawing (repaint) process before it is complete.
Toolbar: None
GDI Command Line: C, CAN, CANCEL

Clear All Customer Flags - Clears all of the customer flags (find and item) from the display.
Toolbar: None
GDI Command Line: CLEARALLCFLAG, CLEARALLCUSTFLAG

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

199

GASWorkS 9.0

GDI
Table Of Contents

Clear All Flags - Clears all find, item, and error flags for all features from the display.
Toolbar: None
GDI Command Line: CLEARALL, CLEARALLFLAGS

Clear All Node Flags - Clears all node find and error flags from the display.
Toolbar: None
GDI Command Line: CLEARALLNFLAG, CLEARALLNODEFLAG

Clear All Pipe Flags - Clears all pipe find and error flags from the display.
Toolbar: None
GDI Command Line: CLEARALLPFLAG, CLEARALLPIPEFLAG

Clear Customer Find Flag - Clears the customer "find" flag. Executing this command will cause
the display of the flag identifying a found customer to be turned off.
Toolbar: Customer Data Commands
GDI Command Line: CFLAG, CLEARCFLAG, CLEARCUSTFLAG, CUSTFLAG

Clear Customer Item Flags - Clears the customer "item" flags. Executing this command will cause the
display of the customer item flags to be turned off.
Toolbar: None
GDI Command Line: CIFLAG, CLEARCIFLAG, CLEARCUSTITEMFLAG, CUSTIFLAG

Clear DXF Find Flag - Clears the DXF text find flag. Executing this command will cause the display of
the flag identifying a found DXF text location to be turned off.
Toolbar: None
GDI Command Line: None

Clear Error Flags - Clears Data Check error" flags. Executing this command will cause the display of the
error flags to be turned off.
Toolbar: None
GDI Command Line: None

Clear Intersection Flags - Clears the unbroken intersection identification flag. Executing this command
will cause the display of the flags identifying unbroken intersections to be turned off.
Toolbar: None
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

200

GASWorkS 9.0

GDI
Table Of Contents

Clear Node Find Flag - Clears the node find flag. Executing this command will cause the
display of the flag identifying a found node to be turned off.
Toolbar: Data Edit Commands
GDI Command Line: CLEARNFLAG, CLEARNODEFLAG, NFLAG, NODEFLAG

Clear Node Item Flags - Clears the node "item" flags. Executing this command will cause the display of
the node item flags to be turned off.
Toolbar: None
GDI Command Line: CLEARNIFLAG, CLEARNODEITEMFLAG, NIFLAG, NODEIFLAG

Clear Pipe Find Flag - Clears the pipe find flag. Executing this command will cause the
display of the flag identifying a found pipe to be turned off.
Toolbar: Data Edit Commands
GDI Command Line: CLEARPFLAG, CLEARPIPEFLAG, PFLAG, PIPEFLAG

Clear Pipe Item Flags - Clears the pipe "item" flags. Executing this command will cause the display of the
pipe item flags to be turned off.
Toolbar: None
GDI Command Line: CLEARPIFLAG, CLEARPIPEITEMFLAG, PIFLAG, PIPEIFLAG

Clear Supply Flags - Clears the supply node flags. Executing this command will cause the display of the
flags identifying supply nodes to be turned off.
Toolbar: None
GDI Command Line: CLEARSFLAG, CLEARSUPPLYFLAG, SFLAG, SUPPLYFLAG

Clear User Text Find Flag - Clears the User Text find flag. Executing this command will
cause the display of the flag identifying a found User Text item to be turned off.
Toolbar: User Text Commands
GDI Command Line: CLEARTEXTFLAG, CLEARTFLAG, TEXTFLAG, TFLAG

Close Graphics Window - Closes the Graphic Data Interface (GDI) Window. Executing this
command will cause the GDI Window to be closed. The GDI Window cannot be closed when a
command is running. Use the Cancel Current Command command to terminate a running
command.
Toolbar: Graphic Window Controls
GDI Command Line: CLOSE

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

201

GASWorkS 9.0

GDI
Table Of Contents

Convert All Arcs To Polyline Pipes - Converts all arc style pipe elements to polyline style pipe elements.
Executing this command will cause all arc style pipe elements to be converted to polyline style pipe elements.
Toolbar: None
GDI Command Line: None

Convert Arc To Polyline Pipe - Converts an arc style pipe element to a polyline style pipe element.
Executing this command will cause a prompt to appear to identify the arc style pipe feature to be converted.
Toolbar: None
GDI Command Line: A2P, ARCPOLY, CONVERTARCTOPOLYLINE

Copy Customer - Adds a new customer by making a copy of an existing customer. Executing this command
will cause a series of prompts to appear to identify the base customer to be copied, the new customer
location, and the supply main. A new customer is placed at the selected location, with the same data values
as the identified base customer. This command will be repeated until either the Esc key is pressed, the right
mouse button is clicked, or the Cancel icon is selected.
Toolbar: None
GDI Command Line: CC, COPYC, COPYCUST, COPYCUSTOMER

Copy User Text - Adds a new User Text feature by making a copy of an existing User Text feature.
Executing this command will cause a series of prompts to appear to identify the base text feature to be
copied and the new location. A new User Text feature is placed at the selected location, with the same
characteristics as the identified base User Text feature. This command will be repeated until either the Esc
key is pressed, the right mouse button is clicked, or the Cancel icon is selected.
Toolbar: None
GDI Command Line: COPYT, COPYTEXT, CT

Create Branch Customer - Creates branch and trunk style customers from two existing customer
features. Executing this command will cause a series of prompts to appear to identify the branch
customer, the trunk customer, and the new tap location.
Toolbar: Customer Data Commands
GDI Command Line: CREATEBRANCH, CREATEBRANCHCUSTOMER

Delete All Attribute Valves - Deletes all attribute valves from the model. Executing this command will
cause all attribute valves to be deleted from the model. A message will be displayed, asking whether to really
clear all attribute valves - respond appropriately.
Toolbar: None
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

202

GASWorkS 9.0

GDI
Table Of Contents

Delete All Customers - Deletes all customers from the model. Executing this command will cause all of the
customers to be deleted from the model. A message will be displayed, asking whether to really delete all
customers - respond appropriately.
Toolbar: None
GDI Command Line: None

Delete Attribute Valve - Deletes an attribute valve from a pipe feature. Executing this command
will cause a prompt to appear to identify the valve to be deleted.
Toolbar: Attribute Valve Commands
GDI Command Line: DAV, DELATTRIBUTEVALVE, DELAV

Delete Customer - Deletes a customer feature. Executing this command will cause a prompt to
appear to identify the customer to be deleted.
Toolbar: Customer Data Commands
GDI Command Line: DC, DELC, DELCUST, DELETECUSTOMER

Delete Legend Text - Deletes legend text. Executing this command will cause the legend text to be deleted.
A message will be displayed, asking whether to really delete legend text - respond appropriately.
Toolbar: None
GDI Command Line: None

Delete Marked View - Deletes a marked view. Executing this command will cause a prompt to appear to
identify the center of the marked view to be deleted.
Toolbar: None
GDI Command Line: DELETEVIEW, DELVIEW, DV

Delete Marked Views - Deletes all of the marked views. Executing this command will delete all of the
marked views. A GASWorkS Warning will be displayed, asking whether to really delete all of the marked
views - respond appropriately.
Toolbar: None
GDI Command Line: None

Delete Pipe - Deletes a pipe element. Executing this command will cause a prompt to appear to
identify the pipe to be deleted. If a pipe is erroneously erased, it may be retrieved by immediately
executing the Undelete Pipe (Oops) command.
Toolbar: Graphic Construction Commands
GDI Command Line: DELETEPIPE, DELP, DELPIPE, DP

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

203

GASWorkS 9.0

GDI
Table Of Contents

Delete Polyline Vertex - Deletes a vertex from a polyline style pipe feature. Executing this
command will cause a series of prompts to appear to identify the pipe to delete the vertex from,
and the vertex to be deleted. If a vertex is erroneously deleted, immediately use the Undo
command button to restore the deleted vertex.
Toolbar: Graphic Edit Commands
GDI Command Line: DELETEPIPEVERTEX, DELPVTX, DPV

Delete Saved View - Deletes a saved view. Executing this command will cause a prompt to
appear to identify the name of the view to remove from the saved view list.
Toolbar: View Controls
GDI Command Line: None

Delete Service Line Vertex - Deletes a vertex from a polyline style service line. Executing this
command will cause a series of prompts to appear to identify the customer to delete the vertex
from, and the vertex to be deleted. If a vertex is erroneously deleted, immediately use the Undo
command button to restore the deleted vertex.
Toolbar: Customer Data Commands
GDI Command Line: DELETESERVICEVERTEX, DELSVTX, DSV

Delete User Graphic Line - Deletes a User Graphic Line feature. Executing this command will
cause a prompt to appear to identify the User Graphic Line to be deleted.
Toolbar: User Graphic Commands
GDI Command Line: DELETEGRAPHICLINE, DELLINE, DGL

Delete User Graphic Symbol - Deletes a User Graphic Symbol feature. Executing this command
will cause a prompt to appear to identify the User Graphic Symbol to be deleted.
Toolbar: User Graphic Commands
GDI Command Line: DELETEGRAPHICSYMBOL, DELSYM, DGS

Delete User Text - Deletes a User Text feature. Executing this command will cause a prompt to
appear to select the text item to be deleted.
Toolbar: User Text Commands
GDI Command Line: DELETETEXT, DELT, DELTEXT, DT

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

204

GASWorkS 9.0

GDI
Table Of Contents

Delete Zero Length Pipes - Deletes all pipes with a zero length value. Executing this command will cause
all pipes with zero length values to be deleted from the model. A message will be displayed, asking whether
to really delete all zero length pipes - respond appropriately.
Toolbar: None
GDI Command Line: None

Display Attribute Valve Text - Turns the display of the attribute valve numbers on or off.
Executing this command will cause the display of the attribute valve numbers to be turned on
or off, depending on the current status.
Toolbar: Attribute Valve Commands
GDI Command Line: None

Display Attribute Valves - Turns the display of the attribute valve symbols on or off.
Executing this command will cause the display of the attribute valve symbols to be turned on
or off, depending on the current status. Depending on the zoom scale of the image and the
symbol size, the symbols may or may not be visible.
Toolbar: Attribute Valve Commands
GDI Command Line: None

Display Background Image - Turns the display of the background image on or off.
Executing this command will cause the display of the background images to be turned on or
off, depending on the current status.
Toolbar: Display Controls
GDI Command Line: None

Display Color Legend - Turns the display of the Color Legend on or off. Executing this
command will cause the display of the Color Legend to be turned on or off, depending on the
current status. Once displayed the Color Legend may be repositioned. The Color Legend will
remain displayed until turned off. During commands, the Color Legend will be hidden so that
the entire work area is visible. Move the cursor over the Display Color Legend icon to redisplay the hidden
Color Legend.
Toolbar: Display Controls
GDI Command Line: None

Display Crosshairs - Turns the display of the full screen Crosshairs on or off. Executing this
command will cause the display of the full screen crosshairs to be turned on or off, depending
on the current status.
Toolbar: Graphic Window Controls
GDI Command Line: CROSSHAIRS

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

205

GASWorkS 9.0

GDI
Table Of Contents

Display Customer Symbols - Turns the display of the customer symbols on or off. Executing
this command will cause the display of the customer symbols to be turned on or off,
depending on the current status. Depending on the zoom scale of the image, the symbols may or
may not be visible.
Toolbar: Customer Data Commands
GDI Command Line: None

Display Flow Arrows - Turns the display of the flow direction arrows on or off. Executing
this command will cause the display of the flow arrow symbols to be turned on or off,
depending on the current status. Depending on the zoom scale of the image and arrow size, the
symbols may or may not be visible.
Toolbar: Display Controls
GDI Command Line: None

Display Node Symbols - Turns the display of the node symbols on or off. Executing this
command will cause the display of the node symbols to be turned on or off, depending on the
current status. Depending on the zoom scale of the image and symbol size, the symbols may or
may not be visible.
Toolbar: Display Controls
GDI Command Line: None

Display Pipe Symbols - Turns the display of the piping symbols on or off. Executing this
command will cause the display of the pipe symbols to be turned on or off, depending on the
current status. Symbols will be displayed for valve, regulator, compressor, and well type pipe
elements. Depending on the zoom scale of the image and symbol size, the symbols may or may
not be visible.
Toolbar: Display Controls
GDI Command Line: None

Display Tool Palette - Turns the display of the Tool Palette on or off. Executing this command will
cause the display of the Tool Palette to be turned on or off, depending on the current status. During
command execution, the Tool Palette is hidden so that the entire work area is visible. When the command
is completed, the Tool Palette is again displayed. During a command execution, the Tool Palette may be
made visible by moving the cursor over this icon.
Toolbar: None
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

206

GASWorkS 9.0

GDI
Table Of Contents

Display User Graphics - Turns the display of the User Graphic features on or off. Executing
this command will cause the display of the User Graphic items to be turned on or off,
depending on the current status.
Toolbar: User Graphic Commands
GDI Command Line: None

Display User Text - Turns the display of the User Text features on or off. Executing this
command will cause the display of the User Text items to be turned on or off, depending on
the current status.
Toolbar: User Text Commands
GDI Command Line: None

Display Vertex Symbols - Turns the display of the vertex symbols on or off. Executing this command
will cause the display of the vertex symbols (symbols at the vertices of polyline pipe and service lines) to
be turned on or off, depending on the current status.
Toolbar: None
GDI Command Line: None

Edit Attribute Valve Data - Allows access to an attribute valve's data values. Executing this
command will cause a prompt to appear to identify the attribute valve to edit/view. Once selected,
the Attribute Valve Data screen will be displayed. Make any desired changes, then select the
Close command button to save the changes.
Toolbar: Attribute Valve Commands
GDI Command Line: EAV, EDITATTRIBUTEVALVE, EDITAV

Edit/View Customer Data - Allows access to a customer's data values. Executing this command
will cause a prompt to appear to identify the customer to edit or view. Once selected, the
Customer Data screen will be displayed. The data screen may be used to make changes to the
customer data. Make any desired changes, then select the Close command button to save the
changes.
Toolbar: Customer Data Commands
GDI Command Line: EC, EDITC, EDITCUSTOMER

Edit Customer Data By Pipe Selection - Allows access to the data values of all of the customers assigned
to a selected pipe. Executing this command will cause a prompt to appear to identify the desired pipe. Once
selected, the Multiple Customers Found data screen will be displayed. Select a customer from the list to
access the associated data on the Customer Data screen.
Toolbar: None
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

207

GASWorkS 9.0

GDI
Table Of Contents

Edit External Load - Changes the external load value for a selected node feature. Executing this command
will cause a prompt to appear to identify the node to be modified and to enter the new external load value.
Note - Use of this command may corrupt the automatic external load accounting. Particular care should be
taken when using this command.
Toolbar: None
GDI Command Line: None

Edit External Load (Fixed) - Changes the fixed external load value for a selected node feature. Executing
this command will cause a prompt to appear to identify the node to be modified and to enter the new fixed
external load value. Note - Use of this command may corrupt the automatic external load accounting.
Particular care should be taken when using this command.
Toolbar: None
GDI Command Line: None

Edit Multiple Customers - Allows changes to be made to a selected group of customers.


Executing this command will cause a prompt to appear to allow selection of the customers to be
changed. Once selected, the Multiple Edit Specifications screen will be displayed so that the
desired changes may be applied. Note - Customers can be selected by individually clicking on
each customer, by drawing a window around the desired customers, or a combination of both. To draw a
selection window, hold down the Shift key, place the cursor at the desired location of the first corner, then
left-click. Move the cursor to the other corner, a dashed box will be displayed, hold down the Shift key and
select the second corner location. If a feature that is already selected, is selected again, it will be removed
from the selection set. When the selection is complete, right-click.
Toolbar: Customer Data Commands
GDI Command Line: None

Edit Multiple Nodes - Allows changes to be made to a selected group of nodes. Executing this
command will cause a prompt to appear to allow selection of the nodes to be changed. Once
selected, the Multiple Edit Specifications screen will be displayed so that the desired changes may
be applied. Note - Nodes can be selected by individually clicking on each node, by drawing a
window around the desired nodes, or a combination of both. To draw a selection window, hold down the
Shift key, place the cursor at the desired location of the first corner, then left-click. Move the cursor to the
other corner, a dashed box will be displayed, hold down the Shift key and select the second corner location.
If a feature that is already selected, is selected again, it will be removed from the selection set. When the
selection is complete, right-click.
Toolbar: Data Edit Commands
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

208

GASWorkS 9.0

GDI
Table Of Contents

Edit Multiple Pipes - Allows changes to be made to a selected group of pipes. Executing this
command will cause a prompt to appear to allow selection of the pipes to be changed. Once
selected, the Multiple Edit Specifications screen will be displayed so that the desired changes may
be applied. Note - Pipes can be selected by individually clicking on each pipe, by drawing a
window around the desired pipes, or a combination of both. To draw a selection window, hold down the Shift
key, place the cursor at the desired location of the first corner, then left-click. Move the cursor to the other
corner, a dashed box will be displayed, hold down the Shift key and select the second corner location. If a
feature that is already selected, is selected again, it will be removed from the selection set. When the
selection is complete, right-click. When using a selection window, only pipes whose nodes fall within the
window will be selected.
Toolbar: Data Edit Commands
GDI Command Line: None

Edit/View Node Data - Allows access to a node's data values and display of its calculated values.
Executing this command will cause a prompt to appear to identify the node to edit or view. Once
selected, the Node Data screen will be displayed. The data screen may be used to make changes
to the node data. Make any desired changes, then select the Close command button to save the
changes.
Toolbar: Data Edit Commands
GDI Command Line: EDITN, EDITNODE, EN

Edit Pipe Customer Count - Changes the customer count for a selected pipe. Executing this command will
cause a series of prompts to appear to identify the desired pipe, and to enter the new customer count value.
Note - Use of this command may corrupt the automatic external load accounting. Particular care should be
taken when using this command.
Toolbar: None
GDI Command Line: None

Edit/View Pipe Data - Allows access to a pipe's data values and display of its calculated values.
Executing this command will cause a prompt to appear to identify the pipe to edit or view. Once
selected, the Pipe Data screen to be displayed. The data screen may be used to make changes to
the pipe data. Make any desired changes, then select the Close command button to save the
changes.
Toolbar: Data Edit Commands
GDI Command Line: EDITP, EDITPIPE, EP

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

209

GASWorkS 9.0

GDI
Table Of Contents

Edit User Graphic Line - Allows access to the various values used to define a User Graphic Line
feature. Executing this command will cause a prompt to appear to identify the User Graphic Line
to edit. Once selected, the Edit Graphic Data Values screen will be displayed. Make any desired
changes, then select the Close command button to save the changes.
Toolbar: User Graphic Commands
GDI Command Line: EDITGRAPHICLINE, EDITLINE, EGL

Edit User Graphic Symbol - Allows access to the various values used to define a User Graphic
Symbol feature. Executing this command will cause a prompt to appear to identify the User
Graphic Symbol to edit. Once selected, the Edit Graphic Data Values screen will be displayed.
Make any desired changes, then select the Close command button to save the changes.
Toolbar: User Graphic Commands
GDI Command Line: EDITGRAPHICSYMBOL, EDITSYM, EGS

Edit User Text - Allows access to the various values used to define a User Text feature.
Executing this command will cause a prompt to appear to identify the User Text feature to edit.
Once selected, the Edit Text Values screen will be displayed. Make any desired changes, then
select the Close command button to save the changes.
Toolbar: User Text Commands
GDI Command Line: EDITT, EDITTEXT, ET

Find Customer - Finds and flags a customer based on a User input value. Executing this
command will cause a series of prompts to appear to identify the method to search by and the
search value. Search styles can be by Address, Attribute Value, Internal ID Number, Link ID
Number, and Record Number. If a match is found, a marker flag will be placed at the associated
location. The marker flag is persistent and will remain displayed until turned off using the Clear Customer
Find Flag command. Note - If an alpha-numeric search item is selected, the case and syntax must be identical
for a match.
Toolbar: Customer Data Commands
GDI Command Line: FC, FINDC, FINDCUSTOMER

Find Customer By Address - Finds and flags a customer based on a User input Address value. Executing
this command will cause a prompt to appear to identify the address of the desired customer. If a match is
found, a marker flag will be placed at the associated location. The marker flag is persistent and will remain
displayed until turned off using the Clear Customer Find Flag command. Note - This command is only
available when an Attribute Database is attached and the Address field is assigned. The case and syntax must
be identical for a match.
Toolbar: None
GDI Command Line: FCAD, FINDADD, FINDCUSTOMERADDRESS

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

210

GASWorkS 9.0

GDI
Table Of Contents

Find Customer By Attribute - Finds and flags a customer based on a User input attribute value. Executing
this command will cause a prompt to appear to identify the search value. If a match is found, a marker flag
will be placed at the associated location. The marker flag is persistent and will remain displayed until turned
off using the Clear Customer Find Flag command. Note - This command is only available when an
Attribute Database is attached. If an alpha-numeric search item is selected, the case and syntax must be
identical for a match.
Toolbar: None
GDI Command Line: FCATT, FINDCATT, FINDCUSTOMERATTRIBUTE

Find Customer By ID - Finds and flags a customer based on a User input Internal ID value. Executing this
command will cause a prompt to appear to identify the Internal ID number of the desired customer. If a match
is found, a marker flag will be placed at the associated location. The marker flag is persistent and will remain
displayed until turned off using the Clear Customer Find Flag command.
Toolbar: None
GDI Command Line: FCID, FINDCID, FINDCUSTID, FINDCUSTOMERID

Find Customer By Link ID - Finds and flags a customer based on a User input Link ID value. Executing
this command will cause a prompt to appear to identify the Link ID number of the desired customer. If a
match is found, a marker flag will be placed at the associated location. The marker flag is persistent and will
remain displayed until turned off using the Clear Customer Find Flag command. Note - The case and
syntax must be identical for a match.
Toolbar: None
GDI Command Line: FCLINK, FINDCLINK, FINDCUSTOMERLINKID

Find Customer By Record Number - Finds and flags a customer based on a User input Record Number
value. Executing this command will cause a prompt to appear to identify the Record Number of the desired
customer. If a match is found, a marker flag will be placed at the associated location. The marker flag is
persistent and will remain displayed until turned off using the Clear Customer Find Flag command.
Toolbar: None
GDI Command Line: FCREC, FINDCREC, FINDCUSTOMERRECORD

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

211

GASWorkS 9.0

GDI
Table Of Contents

Find DXF Text - Finds and flags a DXF Text location based on a User input value. Executing this command
will cause a prompt to appear to identify the desired text value. If a match is found, a marker flag will be
placed at the associated location. The marker flag is persistent and will remain displayed until turned off
using the Clear User Text Find Flag command. Note - If the term LIKE is entered before the value to be
found, partial matches and similar case occurrences may be found. Otherwise, the case and syntax must be
identical for a match. For example, if LIKE MAIN were entered as the search string, the value Main
Street would potentially be found.
Toolbar: None
GDI Command Line: FDXF, FINDDXF, FINDDXFTEXT

Find Node - Finds and flags a node based on a User input value. Executing this command will
cause a series of prompts to appear to identify the method to search by and the search value.
Search styles can be by Name/Number Value or Record Number. If a match is found, a marker
flag will be placed at the associated location. The marker flag is persistent and will remain
displayed until turned off using the Clear Node Find Flag command. Note - If an alpha-numeric search
item is selected, the case and syntax must be identical for a match.
Toolbar: Data Edit Commands
GDI Command Line: FINDN, FINDNODE, FN

Find Node By Name - Finds and flags a node based on a User input Name/Number value. Executing this
command will cause a prompt to appear to specify the desired search value. If a match is found, a marker flag
will be placed at the associated location. The marker flag is persistent and will remain displayed until turned
off using the Clear Node Find Flag command. Note - The case and syntax must be identical for a match.
Toolbar: None
GDI Command Line: FINDNAME, FINDNODENAME, FNAME

Find Node By Record Number - Finds and flags a node based on a User input Record Number. Executing
this command will cause a prompt to appear to identify the Record Number for the desired node. The marker
flag is persistent and will remain displayed until it is turned off using the Clear Node Find Flag command.
Toolbar: None
GDI Command Line: FINDNODERECORD, FINDNREC, FNR

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

212

GASWorkS 9.0

GDI
Table Of Contents

Find Pipe - Finds and flags a pipe based on a User input value. Executing this command will
cause a series of prompts to appear to identify the method to search by and the search value.
Search styles can be by Address, Attribute Value, Internal ID Number, Link ID Number, and
Record Number. If a match is found, a marker flag will be placed at the associated location. The
marker flag is persistent and will remain displayed until turned off using the Clear Pipe Find Flag
command. Note - If an alpha-numeric search item is selected, the case and syntax must be identical for a
match.
Toolbar: Data Edit Commands
GDI Command Line: FINDP, FINDPIPE, FP

Find Pipe By Address - Finds and flags a pipe based on a User input Address value. Executing this
command will cause a prompt to appear identify the address of the desired pipe. If a match is found, a marker
flag will be placed at the associated location. The marker flag is persistent and will remain displayed until
turned off using the Clear Pipe Find Flag command. Note - This command is only available when an
Attribute Database is attached, and the Address field is assigned. The case and syntax must be identical for
a match.
Toolbar: None
GDI Command Line: FINDPIPEADDRESS, FPAD

Find Pipe By Attribute - Finds and flags a pipe based on a User input attribute value. Executing this
command will cause a prompt to appear to identify the search value. If a match is found, a marker flag will
be placed at the associated location. The marker flag is persistent and will remain displayed until turned off
using the Clear Pipe Find Flag command. Note - This command is only available when an Attribute
Database is attached. If an alpha-numeric search item is selected, the case and syntax must be identical for
a match.
Toolbar: None
GDI Command Line: FINDPATT, FINDPIPEATTRIBUTE, FPATT

Find Pipe By ID - Finds and flags a pipe based on a User input Internal ID value. Executing this command
will cause a prompt to appear to identify the Internal ID number of the desired pipe. If a match is found, a
marker flag will be placed at the associated location. The marker flag is persistent and will remain displayed
until turned off using the Clear Pipe Find Flag command.
Toolbar: None
GDI Command Line: FINDPID, FINDPIPEID, FPID

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

213

GASWorkS 9.0

GDI
Table Of Contents

Find Pipe By Link ID - Finds and flags a pipe based on a User input Link ID value. Executing this
command will cause a prompt to appear to identify the Link ID number of the desired pipe. If a match is
found, a marker flag will be placed at the associated location. The marker flag is persistent and will remain
displayed until turned off using the Clear Pipe Find Flag command. Note - The case and syntax must be
identical for a match.
Toolbar: None
GDI Command Line: FINDPLINK, FINDPIPELINKID, FPLINK

Find Pipe By Record Number - Finds and flags a pipe based on a User input Record Number value.
Executing this command will cause a prompt to appear to identify the Record Number of the desired pipe.
If a match is found, a marker flag will be placed at the associated location. The marker flag is persistent and
will remain displayed until turned off using the Clear Pipe Find Flag command.
Toolbar: None
GDI Command Line: FINDPIPERECORD, FINDPREC, FPREC

Find User Text Value - Finds and flags a User Text location based on a User input value.
Executing this command will cause a prompt to appear to identify the desired text value. If a
match is found, a marker flag will be placed at the associated location. The marker flag is
persistent and will remain displayed until turned off using the Clear User Text Find Flag
command. If this command is repeated using the same text value, the next occurrence of that value will be
located and flagged. Note - The case and syntax must be identical for a match.
Toolbar: User Text Commands
GDI Command Line: FINDT, FINDTEXT, FT

Flag Customers By Item Value - Finds and flags customers based on a User specified item value. Executing
this command will cause the Query Specifications screen to be displayed. Make the desired selection, then
select the Perform Query command button. If a match is found, a marker flag will be placed at the associated
location. Multiple matches may be found. The marker flag is persistent and will remain displayed until turned
off using the Clear Customer Item Flags command. Note - The customer symbols must be displayed to
display the flag locations.
Toolbar: None
GDI Command Line: FLAGC, FLAGCUST, FLAGCUSTOMERITEM

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

214

GASWorkS 9.0

GDI
Table Of Contents

Flag Customers With Bad Link ID Values - Finds and flags customers with bad Link ID values.
Executing this command will cause each customer whose Link ID value is not found in the assigned customer
attribute file to be marked with a flag. A message will appear stating the results of the routine, select the OK
command button to clear the message. The marker flags are persistent and will remain displayed until turned
off using the Clear All Customer Flags command. Note - The customer symbols must be turned on to
display the flag locations.
Toolbar: None
GDI Command Line: FLAGBADCID

Flag Customers With Redundant Link ID Values - Finds and flags customers with redundant Link ID
values. Executing this command will cause each customer whose Link ID value is found multiple times in
the assigned customer attribute file to be marked with a flag. A message will appear stating the results of the
routine, select the OK command button to clear the message. The marker flags are persistent and will remain
displayed until turned off using the Clear All Customer Flags command. Note - The customer symbols
must be turned on to display the flag locations.
Toolbar: None
GDI Command Line: FLAG2XCID

Flag Nodes By Item Value - Finds and flags nodes based on a User specified item value. Executing this
command will cause the Query Specifications screen to be displayed. Make the desired selection, then select
the Perform Query command button. If a match is found, a marker flag will be placed at the associated
location. Multiple matches may be found. The marker flag is persistent and will remain displayed until turned
off using the Clear Node Item Flags command. Note - The node symbols must be displayed to display the
flag locations.
Toolbar: None
GDI Command Line: FLAGN, FLAGNODE, FLAGNODEITEM

Flag Pipes By Item Value - Finds and flags pipes based on a User specified item value. Executing this
command will cause a series of prompts to appear requesting the search item and item value. Search items
can be one of any of the model data items associated with a pipe feature. If a match is found, a marker flag
will be placed at the associated location. Multiple matches may be found. The marker flag is persistent and
will remain displayed until turned off using the Clear Pipe Item Flags command.
Toolbar: None
GDI Command Line: FLAGP, FLAGPIPE, FLAGPIPEITEM

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

215

GASWorkS 9.0

GDI
Table Of Contents

Flag Supply Nodes - Finds and flags nodes with positive load values. Executing this command will cause
GASWorkS to search for nodes where the Total Load value is positive (greater than 0). A supply flag will
placed at each location where a supply node is found. The marker flags are persistent and will remain
displayed until turned off using the Clear Supply Flags command. Note - The node symbols must be turned
on to display the flag locations.
Toolbar: None
GDI Command Line: FLAGS, FLAGSUPPLY, FLAGSUPPLYNODE

Flag Unassigned Customers - Finds and flags customers which are not assigned to a supply main. Executing
this command will cause GASWorkS to search for customers that are not assigned to a pipe/main. A find
flag will be placed at all of the locations where this is true. The marker flags are persistent and will remain
displayed until turned off using the Clear Customer Find Flag command. Note - The customer symbols
must be turned on to display the flag locations.
Toolbar: None
GDI Command Line: None

Flag Unbroken Intersections - Finds and flags intersections where the lateral pipe is not connected to the
header pipe. Executing this command will cause GASWorkS to search for instances where a lateral pipe end
is located near a non-broken header pipe (tee connections where the header and lateral pipe are not
connected). The Fuzzy Tolerance screen will be displayed. Enter the appropriate value, then select the
Continue command button. In some cases unconnected pipe ends that are very close to each other will be
detected as an Unbroken Intersection. An intersection flag will be placed at each location where an
unbroken intersection is found. The marker flags are persistent and will remain displayed until turned off
using the Clear Unbroken Intersection Flags command, or until manually turned off, individually by the
User. The intersection marker flags are saved when the model is closed. Note - Before executing this
command, set the node sizes to an appropriate absolute value.
Toolbar: None
GDI Command Line: None

Go To XY Coordinates - Positions the upper-left corner of the image at a User specified


location. Executing this command will cause a prompt to appear to identify the XY Coordinates
to shift the display to.
Toolbar: View Controls
GDI Command Line: G, GOTO, GOTOXY

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

216

GASWorkS 9.0

GDI
Table Of Contents

Highlight DXF Layer - Highlights a selected dxf feature and reports information about the selected feature.
Executing this command will cause a prompt to appear to identify the dxf feature to be selected. Select a
feature and a message will appear listing information about the selected feature. Highlighting a dxf feature
is useful to identify which layer a feature is on or when trying to determine a features graphical type.
Toolbar: None
GDI Command Line: HID, HIGHLIGHTDXF, HILITD, HILITDXF

Highlight Pipe - Highlights a selected pipe. Executing this command will cause a prompt to appear to
identify the pipe to be selected. Highlighting a pipe is useful to quickly mark pipes as they are checked or
reviewed during the data check process.
Toolbar: None
GDI Command Line: HIGHLIGHTPIPE, HILITP, HILITPIPE, HIP

Insert Compressor - Inserts a compressor type element into an existing pipe element. Executing this
command will cause a series of prompts to appear to identify the pipe to insert the compressor into, the
location of the compressor end points, and the operating data. At least one end must be at an existing node
location and at least one end must be a new (tapped) location along the pipe that the compressor is being
inserted into. When adding a compressor, the From Node must represent the upstream (suction) side of the
compressor and the To Node must represent the downstream (discharge) side of the compressor.
Toolbar: None
GDI Command Line: INSC, INSCOMP, INSERTCOMPRESSOR

Insert Regulator - Inserts a regulator type element into an existing pipe element. Executing this command
will cause a series of prompts to appear to identify the pipe to insert the regulator into, the location of the
regulator end points, and the operating data. At least one end must be at an existing node location and at least
one end must be a new (tapped) location along the pipe that the regulator is being inserted into. When adding
a regulator, the From Node must represent the upstream (high pressure) side of the regulator and the To Node
must represent the downstream (low pressure) side of the regulator.
Toolbar: None
GDI Command Line: INSERTREG, INSERTREGULATOR, INSR, INSREG

Insert Valve - Inserts a valve type element into an existing pipe element. Executing this command will cause
a series of prompts to appear to identify the pipe to insert the valve into, the location of the valve end points,
and the operating data. At least one end must be at an existing node location and at least one end must be a
new (tapped) location along the pipe that the valve is being inserted into. The From Node and To Node order
do not matter for Valve type elements.
Toolbar: None
GDI Command Line: INSERTVALVE, INSV, INSVALVE

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

217

GASWorkS 9.0

GDI
Table Of Contents

Join Adjacent Pipes - Joins two adjacent pipe segments. Executing this command will cause a
series of prompts to appear to identify the pipes to be joined. During the join process the node
common to both pipes will be removed. The new (combined) pipe will possess the hydraulic and
graphic data associated with the first pipe that was selected. Note - Arc-style pipes cannot be
joined. If one of the pipes to be joined is an arc-style pipe, a prompt will appear asking whether to convert
it to a polyline pipe. If the arc pipe is converted, the two selected pipes can be joined, otherwise the command
cannot proceed.
Toolbar: Graphic Edit Commands
GDI Command Line: J, JOIN, JOINPIPES

Make User Text From Legend - See the Add Legend As Text command.

Match Customer Graphic Properties - Assigns the graphic data values from one customer feature to
another. Executing this command will cause a series of prompts to appear to identify the base customer
and the customer or customers to assign the base graphic values to.
Toolbar: None
GDI Command Line: MATCHCUSTOMERGRAPHICS, MCG

Match Node Graphic Properties - Assigns the graphic data values from one node feature to another.
Executing this command will cause a series of prompts to appear to identify the base node and the node
or nodes to assign the base graphic values to.
Toolbar: None
GDI Command Line: MATCHNODEGRAPHICS, MNG

Match Node Hydraulic Properties - Assigns the hydraulic data values from one node feature to another.
Executing this command will cause a series of prompts to appear to identify the base node and the node
or nodes to assign the base hydraulic values to.
Toolbar: None
GDI Command Line: MATCHNODEHYDRAULICS, MNH

Match Node Properties (All) - Assigns both the graphic and hydraulic data values from one node feature
to another. Executing this command will cause a series of prompts to appear to identify the base node and
the node or nodes to assign the base values to.
Toolbar: None
GDI Command Line: MATCHNODE, MATCHNODEPROPERTIES, MNP

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

218

GASWorkS 9.0

GDI
Table Of Contents

Match Pipe Facility - Assigns the facility value from one pipe feature to another. Executing this command
will cause a series of prompts to appear to identify the base pipe and the pipe or pipes to assign the base
facility values to.
Toolbar: None
GDI Command Line: MATCHFACILITY, MATCHPIPEFACILITY, MPF

Match Pipe Graphic Properties - Assigns the graphic data values from one pipe feature to another.
Executing this command will cause a series of prompts to appear to identify the base pipe and the pipe or
pipes to assign the base graphic values to.
Toolbar: None
GDI Command Line: MATCHPIPEGRAPHICS, MPG

Match Pipe Hydraulic Properties - Assigns the hydraulic data values from one pipe feature to another.
Executing this command will cause a series of prompts to appear to identify the base pipe and the pipe or
pipes to assign the base hydraulic values to.
Toolbar: None
GDI Command Line: MATCHPIPEHYDRAULICS, MPH

Match Pipe Properties (All) - Assigns both the graphic and hydraulic data values from one pipe feature to
another. Executing this command will cause a series of prompts to appear to identify the base pipe and the
pipe or pipes to assign the base values to.
Toolbar: None
GDI Command Line: MATCHPIPE, MATCHPIPEPROPERTIES, MPP

Match User Graphic Line Properties - Assigns the graphic data values from one User Graphic Line feature
to another. Executing this command will cause a series of prompts to appear to identify the base line and
the line or lines to assign the base graphic values to.
Toolbar: None
GDI Command Line: MATCHGRAPHICLINE, MATCHLINE, MGL

Match User Graphic Symbol Properties - Assigns the graphic data values from one User Graphic Symbol
feature to another. Executing this command will cause a series of prompts to appear to identify the base
symbol and the symbol or symbols to assign the base graphic values to.
Toolbar: None
GDI Command Line: MATCHGRAPHICSYMBOL, MATCHSYMBOL, MGS

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

219

GASWorkS 9.0

GDI
Table Of Contents

Match User Text Properties - Assigns the graphic data values from one User Text feature to another.
Executing this command will cause a series of prompts to appear to identify the base text and the text item
or items to assign the base graphic values to.
Toolbar: None
GDI Command Line: MATCHTEXT, MT

Maximize Graphics Window - Increases the size of the Graphic Data Interface (GDI) window
to fill the entire GASWorkS display area. Executing this command will cause the GDI Window
to be sized to maximum dimensions that will fit on the current computer display.
Toolbar: Graphic Window Controls
GDI Command Line: MAX, MAXIMIZEWINDOW, MAXWIN

Measure Distance - Calculates a distance based on two User specified points. Executing this
command will cause a series of prompts to appear to identify the points to measure between.
Similar to a polyline pipe or service, multiple points may be selected along a route. Right-click
the mouse, enter an E, or press the Enter key to end the process and display the measured
distance.
Toolbar: Graphic Utility Commands
GDI Command Line: DISTANCE, MD, MEASURE, MEASUREDISTANCE

Move Attribute Valve - Moves an attribute valve to a User specified location. Executing this
command will cause a series of prompts to appear to identify the valve to be moved and the new
location.
Toolbar: Attribute Valve Commands
GDI Command Line: MAV, MOVEATTRIBUTEVALVE, MOVEAVALVE

Move Attribute Valve Text - Moves the text associated with an attribute valve to a User
specified location. Executing this command will cause a series of prompts to appear to identify
the text to be moved, and specify the new location and rotation.
Toolbar: Attribute Valve Commands
GDI Command Line: MAVT, MOVEVALVETEXT

Move Background Image - Moves a background image to a User specified location. Executing this
command will cause a series of prompts to appear to identify the image to be affected, the base point, and
the new location. A prompt will appear to move the image, select an appropriate response.
Toolbar: None
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

220

GASWorkS 9.0

GDI
Table Of Contents

Move Branch Service Tap - Moves the tap location associated with a branch customer feature
to a User specified location. Executing this command will cause a series of prompts to appear to
identify the affected customers and the new tap location.
Toolbar: Customer Data Commands
GDI Command Line: MBT, MOVEBRANCH, MOVEBRANCHTAP

Move Customer Location - Moves a customer symbol to a User specified location. Executing
this command will cause a series of prompts to appear to identify the customer to be moved and
the new location. This command does not change the supply main assignment.
Toolbar: Customer Data Commands
GDI Command Line: MC, MOVEC, MOVECUSTOMER

Move Customer - Reassign Main - Moves a customer symbol to a User specified location and reassigns
the supply main. Executing this command will cause a series of prompts to appear to identify the customer
to be moved, the new location, and the new supply main.
Toolbar: None
GDI Command Line: MOVEREASSIGNCUST, MRC

Move Customer Text - Moves the text associated with a customer feature to a User specified
location. Executing this command will cause a series of prompts to appear to identify the text to
be moved and the new location and rotation.
Toolbar: Customer Data Commands
GDI Command Line: MCT, MOVECTEXT, MOVECUSTOMERTEXT

Move Legend Text - Moves the legend text to a User specified location. Executing this command will cause
a prompt to appear to identify the new location.
Toolbar: None
GDI Command Line: None

Move Node Location - Moves a node and any connected pipes to a User specified location.
Executing this command will cause a series of prompts to appear to identify the node to be moved
and the new location. The node's new position may be entered by coordinates or by positioning
with the mouse.
Toolbar: Graphic Edit Commands
GDI Command Line: MN, MOVEN, MOVENODE

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

221

GASWorkS 9.0

GDI
Table Of Contents

Move Node Text - Moves the text associated with a node feature to a User specified location.
Executing this command will cause a series of prompts to appear to identify the node to move the
text for and the new location and rotation.
Toolbar: Data Edit Commands
GDI Command Line: MNT, MOVENODETEXT, MOVENTEXT

Move Pipe End - Moves a pipe's end to a User specified location. Executing this command will
cause a series of prompts to appear to identify the pipe to be moved, the end to be moved, and the
new location. The pipes's new position may be entered by coordinates or by positioning with the
mouse. This command can be used to connect or disconnect a pipe from a node.
Toolbar: Graphic Edit Commands
GDI Command Line: MOVEP, MOVEPIPE, MOVEPIPEEND, MP

Move Pipe Text - Moves the text associated with a pipe feature to a User specified location.
Executing this command will cause a series of prompts to appear to identify the pipe to move the
text for and the new location and rotation.
Toolbar: Data Edit Commands
GDI Command Line: MOVEPIPETEXT, MOVEPTEXT, MPT

Move Pipe Vertex - Moves a vertex for a polyline style pipe feature to a User specified location.
Executing this command will cause a prompt to appear to identify the vertex to be moved and the
new location.
Toolbar: Graphic Edit Commands
GDI Command Line: MOVEPIPEVERTEX, MPV

Move Service Line Vertex - Moves a vertex for a polyline style service line to a User specified
location. Executing this command will cause a series of prompts to appear to identify the
associated customer, the vertex to be moved, and the new location.
Toolbar: Customer Data Commands
GDI Command Line: MOVESERVICEVERTEX, MSV

Move Service Tap Location - Moves a customer service line tap location to a User specified
location. Executing this command will cause a series of prompts to appear to identify the
associated customer and the new tap location.
Toolbar: Customer Data Commands
GDI Command Line: MOVESERVICETAP, MOVETAP, MST

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

222

GASWorkS 9.0

GDI
Table Of Contents

Move User Graphic Line End - Moves a User Graphic Line end to a User specified location.
Executing this command will cause a series of prompts to appear to identify the line to be moved,
the end (or vertex) to be moved, and the new location.
Toolbar: User Graphic Commands
GDI Command Line: MGLE, MOVEGRAPHICLINEEND, MOVELINENED

Move User Graphic Symbol - Moves a User Graphic Symbol to a User specified location.
Executing this command will cause a series of prompts to appear to identify the symbol to be
moved and the new location.
Toolbar: User Graphic Commands
GDI Command Line: MOVEGRAPHICSYMBOL, MOVESYM

Move User Text - Moves a User Text feature to a User specified location. Executing this
command will cause a series of prompts to appear to identify the text feature to be moved and the
new location.
Toolbar: User Text Commands
GDI Command Line: MOVET, MOVETEXT

Multiply Customer Loads - Multiplies all of the customer loads by a User specified value. Executing this
command will cause a prompt to appear to identify the Multiplication Factor. When selected, the existing
load values are multiplied by the specified factor.
Toolbar: None
GDI Command Line: None

Multiply Node Loads - Multiplies all of the node loads by a User specified value. Executing this command
will cause a prompt to appear to identify the Multiplication Factor. When selected, the existing load values
are multiplied by the specified factor.
Toolbar: None
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

223

GASWorkS 9.0

GDI
Table Of Contents

Node Snap - Turns the node snap feature on or off depending on the current status. When
Node Snap is turned on, a circle representing the snap target area will appear during coordinate
entry. Node snapping attempts to force (snap) new coordinate selections to an existing node near
the selected location. When a new node location is entered, GASWorkS will search for an existing
node within the snap tolerance of the entered location. If a node is found, the coordinates for the existing
node will be used, and the new line will be "snapped" to the existing node. If no node is found, a message
will appear allowing you to use the selected location or to attempt to select another location. The snap
tolerance is set by selecting the Settings menu item from the Graphics menu list. Note - As an alternative to
using node snap, the Shift key can be held down while left-clicking when entering a node location - the pipe
end will be automatically snapped to the nearest existing node regardless of the current Node Snap status.
Toolbar: Graphic Construction Commands
GDI Command Line: NODESNAP, SNAP

Oops Customer (Undelete Customer) - Restores (undeletes) a customer feature that has been
recently deleted. The command should be executed immediately following the accidental deletion.
However, it can often be used even after several commands have been executed. A message will
be displayed if no customer feature can be found to be restored.
Toolbar: Customer Data Commands
GDI Command Line: OOPSC, UNDELC, UNDELETECUSTOMER

Oops Pipe (Undelete Pipe) - Restores (undeletes) a pipe element that has been recently deleted.
The command should be executed immediately following the accidental deletion. However, it can
often be used even after several commands have been executed. A message will be displayed if
no pipe element feature can be found to be restored.
Toolbar: Graphic Construction Commands
GDI Command Line: OOPSP, UNDELETEPIPE, UNDELP

Oops User Graphic Symbol/Line (Undelete Graphic) - Restores (undeletes) a User Graphic
Symbol or Line that has been recently deleted. The command should be executed immediately
following the accidental deletion. However, it can often be used even after several commands
have been executed. A message will be displayed if no User Graphic feature can be found to be
restored.
Toolbar: User Graphic Commands
GDI Command Line: OOPSG, UNDELETEGRAPHIC, UNDELG

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

224

GASWorkS 9.0

GDI
Table Of Contents

Oops User Text (Undelete Text) - Restores (undeletes) a User Text feature that has been recently
deleted. The command should be executed immediately following the accidental deletion.
However, it can often be used even after several commands have been executed. A message will
be displayed if no User Text feature can be found to be restored.
Toolbar: User Text Commands
GDI Command Line: OOPST, UNDELETETEXT, UNDELT

Pan Image - Repositions the GDI image based on a User specified location. Executing this
command will cause a series of prompts to appear to identify two locations. The first location
identifies the reference point to be moved, and the second location identifies the reference points
new position.
Toolbar: View Controls
GDI Command Line: P, PAN

Paste CID - Adds a customer to the model (similar to the Add Customer command), and assigns the contents
of the Windows Clipboard to the Link ID value. This command is useful when manually assigning link
values from an external database to a model. To efficiently use this command copy or cut the associated
Link ID value from the external database before executing the command.
Toolbar: None
GDI Command Line: PASTECID, PASTECLINK

Paste CID Auto - Adds a customer to the model (similar to the Add Customer - Auto-Assign Main
command), and assigns the contents of the Windows Clipboard to the Link ID value. This command is useful
when manually assigning link values from an external database to a model. To efficiently use this command
copy or cut the associated Link ID value from the external database before executing the command.
Toolbar: None
GDI Command Line: PASTECIDAUTO, PASTECLINKAUTO

Plot - Plots the current GDI image. Executing this command will cause the Plot Settings screen
to be displayed. Make any desired changes, then select the Plot command button.
Toolbar: Graphic Utility Commands
GDI Command Line: PLOT

Purge Customers - Deletes customers which are unassigned and have invalid coordinate values. Executing
this command will cause a message to be displayed asking whether to really delete all customers with invalid
coordinates - respond appropriately. When selected, all customers which are unassigned to a pipe and which
possess invalid coordinate values, will be deleted.
Toolbar: None
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

225

GASWorkS 9.0

GDI
Table Of Contents

Purge User Text - Deletes User Text items with invalid coordinate values. Executing this command will
cause a message to be displayed asking whether to really delete all User Text items with invalid coordinates respond appropriately. When selected, all User Text items which possess invalid coordinate values, will be
deleted.
Toolbar: None
GDI Command Line: None

Reassign Customer - Assigns a customer to a different supply main. Executing this command
will cause a series of prompts to appear to identify the affected customer and the new supply
main.
Toolbar: Customer Data Commands
GDI Command Line: RC, REASSIGN, REASSIGNCUST, REASSIGNCUSTOMER

Reassign Customer Pipe ID Numbers - Reassigns the assigned Pipe ID Numbers for all of the customers.
Executing this command will cause a message to appear stating the results of the reassignment. Note - Use
of this command may corrupt the automatic external load accounting. Particular care should be taken when
using this command.
Toolbar: None
GDI Command Line: None

Redraw Graphic Image - Repaint (redraw) the current GDI Image. Executing this command will
cause the model and background images to be redrawn in the GDI work area. If the Automatic
Repaint graphic settings option is not selected (not checked), this command is useful for updating
the display after various display modifying commands have been executed.
Toolbar: Graphic Window Controls
GDI Command Line: RD, REDRAW, REPAINT, RP

Reduce Nodes - Eliminates unneeded nodes. Executing this command will cause the Specify Reduction
Details screen to be displayed. Make any desired changes, then select the Reduce command button. The pipes
in the model will be searched for nodes that can be deleted. The nodes are deleted when a node between two
pipes of the same size is encountered.
Toolbar: None
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

226

GASWorkS 9.0

GDI
Table Of Contents

Regenerate Model Data - Re-reads the model data and background images from the disk file.
Executing this command will cause the model data and background image data to be re-read from
the associated disk file. This command is useful to restore the original model conditions without
closing and reopening the model.
Toolbar: Graphic Window Controls
GDI Command Line: REGEN, REGENERATE, RG

Report Customers With No Coordinates - Reports customers with invalid coordinates. Executing this
command will cause a report to be displayed showing all customers which possess invalid coordinate values.
Toolbar: None
GDI Command Line: None

Reset Colors - Resets the color of the model features to their saved values. Executing this command will
change the color of all of the model features to the currently saved values. This command is useful to restore
the original colors after executing a trace or color coded query.
Toolbar: None
GDI Command Line: RESET, RESETCOLORS

Reset Customer Colors - Resets the color of the customer features to their saved values. Executing this
command will change the color of all the customer features to the currently saved values. This command is
useful to restore the original colors after executing a trace or color coded query.
Toolbar: None
GDI Command Line: RESETC, RESETCUSTOMERCOLORS

Reset Customer Pipe Link ID Assignments - Resets the Pipe Link ID values assigned to the customers.
Executing this command will cause a message to appear to verify assigning the Customer Pipe Link ID
numbers - respond appropriately. This command is useful for repairing the link between the customer and
the pipe features.
Toolbar: None
GDI Command Line: None

Reset GDI Command List Location - Resets the position of the GDI Command List to its default location.
Executing this command will cause the GDI Command List to be repositioned to the default location.
Toolbar: None
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

227

GASWorkS 9.0

GDI
Table Of Contents

Reset Node Colors - Resets the color of the node features to their saved values. Executing this command
will change the color of all the node features to the currently saved values. This command is useful to restore
the original colors after executing a trace or color coded query.
Toolbar: None
GDI Command Line: RESETN, RESETNODECOLORS

Reset Pipe Colors - Resets the color of the pipe features to their saved values. Executing this command will
change the color of all the pipe features to the currently saved values. This command is useful to restore the
original colors after executing a trace or color coded query.
Toolbar: None
GDI Command Line: RESETP, RESETPIPECOLORS

Reset Pipe Link ID Values - Resets the Pipe Link ID values. Executing this command will cause a message
to appear to verify assigning the Pipe Link ID values to the Pipe ID Value - respond appropriately. This
command is useful for repairing the link between a linked attribute file and a model. If customers are
included in the model execute the Reset Customer Pipe Link ID Assignments command after using this
command.
Toolbar: None
GDI Command Line: None

Resize Graphics Window - Resets the Graphic Data Interface (GDI) Window to its "normal"
size. Executing this command will cause the size of the GDI Window to be set to a predetermined
height and width.
Toolbar: Graphic Window Controls
GDI Command Line: None

Save Current View - Saves the currently displayed GDI view to the view list. Executing this
command will cause a prompt to appear to specify the name for the saved view.
Toolbar: View Controls
GDI Command Line: None

Save Feature Colors - Saves the currently displayed/assigned model feature colors. Executing this command
will cause the current feature colors to be saved. This is useful for saving colors assigned as a result of a trace
or color coded query. Note - Use of this command may corrupt the automatic external load accounting.
Particular care should be taken when using this command.
Toolbar: None
GDI Command Line: SAVECOLORS

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

228

GASWorkS 9.0

GDI
Table Of Contents

Scale Background Image - Adjusts the scale factor required to make the background image match a
specified linear distance, based on a pair of known points on the image. Executing this command will cause
a series of prompts to appear to identify the image to be affected, the known points, and the actual distance.
The resulting adjustment factor will be calculated and displayed. A message will be displayed asking whether
to apply the adjusted scale factor - respond appropriately.
Toolbar: None
GDI Command Line: None

Segment A Pipe - Divides a selected pipe segment into a User specified number of individual segments.
Executing this command will cause a series of prompts to appear to identify the pipe to segment, the number
of segments, and the new tap locations. This command is useful for modifying pipe segments that have been
entered in very long segments, into shorter segments.
Toolbar: None
GDI Command Line: SEGMENTPIPE

Set Attribute Valve Color - Sets the display color for the attribute valve symbols and text.
Executing this command will cause the Color Palette to be displayed. Select the desired color,
then select the OK command button.
Toolbar: Attribute Valve Commands
GDI Command Line: None

Set Attribute Valve Size - Sets the display size of the attribute valve symbols. Executing this
command will cause a prompt to appear to enter the new valve symbol size. The size value can
be set to an absolute value (in coordinate units) or to a relative value (a percentage of the diagonal
screen width).
Toolbar: Attribute Valve Commands
GDI Command Line: None

Set Colors - Sets the colors for the displayed features. Executing this command will open the Set
Display Colors screen. Make any desired changes, select the Save Feature Colors command
button, then select the Close command button.
Toolbar: Display Controls
GDI Command Line: COLORS, SETCOLORS

Set Customer Color - Sets the display color for the customer symbols. Executing this command
will cause the Color Palette to be displayed. Select the desired color, then select the OK command
button.
Toolbar: Customer Data Commands
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

229

GASWorkS 9.0

GDI
Table Of Contents

Set Customer Size - Sets the display size for the customer symbols. Executing this command will cause a
prompt to appear to enter the new customer size value. The size value can be set to an absolute value (in
coordinate units) or to a relative value (a percentage of the diagonal screen width).
Toolbar: None
GDI Command Line: None

Set Pipe Symbol Size - Sets the default display size for the pipe symbols. Executing this command will
cause a prompt to appear to enter the default pipe symbol size value. The size value can be set to an absolute
value (in coordinate units) or to a relative value (a percentage of the diagonal screen width).
Toolbar: None
GDI Command Line: None

Set Text Options - Sets the text display options. Executing this command will open the Text
Display Options screen. Make any desired changes, then select the Apply command button.
Toolbar: Display Controls
GDI Command Line: SETTEXT

Set/Unset Intersection Flag - Sets the display of the intersection flag for a selected node. Executing this
command will cause a prompt to appear to identify the desired node. If the node is not currently marked with
an intersection flag, the node will be marked. If the node is currently marked, it will be unmarked.
Toolbar: None
GDI Command Line: INTERSECTFLAG, INTERSECTIONFLAG

Set User Graphic Symbol Size - Sets the default display size for the User Graphic Symbols. Executing this
command will cause a prompt to appear to enter the default graphic symbol size value. The size value can
be set to an absolute value (in coordinate units) or to a relative value (a percentage of the diagonal screen
width).
Toolbar: None
GDI Command Line: None

Set User Text Color - Sets the display color for the User Text features. Executing this command
will cause the Color Palette to be displayed. Select the desired color, then select the OK command
button. Text colors may also be individually set using the Edit User Text command.
Toolbar: User Text Commands
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

230

GASWorkS 9.0

GDI
Table Of Contents

Shift Model Coordinates - Allows the model coordinates to be shifted, scaled, or rotated based on User
specified values. Executing this command will cause the Shift Details screen to be displayed. Make any
changes, then select the Shift command button.
Toolbar: None
GDI Command Line: None

Show Route Profile - Allows a profile of various data values to be displayed along a selected route.
Executing this command will cause the Profile Options screen to be displayed. Make any changes, then select
the Create Profile command button.
Toolbar: None
GDI Command Line: PROFILE, SHOWPROFILE

Snap Loose Pipe Ends - Automatically snaps pipe ends together where the ends fall within a User specified
tolerance value. Executing this command will cause the Fuzzy Tolerance screen to be displayed. Enter an
appropriate value, then select the Continue command button. A message will appear asking whether to update
pipe lengths - respond appropriately. Pipe ends that fall within this tolerance will be snapped together. This
command is useful for quickly correcting connectivity errors encountered on a new model created from one
of the graphic import routines.
Toolbar: None
GDI Command Line: SNAPPIPES

Snap Mode - See the Node Snap command.

Solve Model - Allows the solution to be executed. Executing this command will cause the Solution Data
screen to be displayed. Make any desired changes, then select the Solve command button.
Toolbar: None
GDI Command Line: S, SOLVE

Swap Pipe Ends - Swaps the From and To Nodes for a pipe feature. Executing this command will
cause a prompt to appear to identify the desired pipe. This command is useful for quickly
correcting regulators or compressors that have been input backwards.
Toolbar: Graphic Edit Commands
GDI Command Line: SWAP, SWAPENDS, SWAPPIPEENDS

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

231

GASWorkS 9.0

GDI
Table Of Contents

Tap Pipe - "Taps" (splits or breaks) a pipe segment. Executing this command will cause a series
of prompts to appear to identify the pipe to be tapped and the tap location. This command splits
a pipe into two segments, updates the resulting pipe segments, and adds a new node at the tap
location. Once tapped, a new pipe may be extended from the tap node.
Toolbar: Graphic Edit Commands
GDI Command Line: TAP, TAPPIPE, TP
Note - If the Ctrl key is held down while left-clicking (when selecting a From or To Node Location),
the Tap routine is automatically executed using the current cursor location to find the pipe to be
tapped and the tap location.
Note - If the desired tap location coincides with an existing node (pipe end) location, holding down
the Shift key while left-clicking (when selecting the tap location), will cause the existing node
location to be used as the tap location, and will automatically connect the pipe end associated with
the existing node to the tap location.

Toggle Digitizing Tablet On/Off - Turns the digitizing tablet on or off. Executing this
command will cause the coordinate entry from the digitizing tablet to be turned on or off,
depending on the current status. The tablet must be calibrated before it can be turned on. If an
attempt is made to turn the tablet on before it is calibrated, the Tablet Calibration routine will
automatically be started. When the tablet is turned on, commands which expect a coordinate pair for input,
will expect to receive the required coordinate values from the tablet.
Toolbar: Graphic Utility Commands
GDI Command Line: TABLET, TB

Trace - Color codes features along a trace route. Executing this command will cause the Trace
Specifications screen to be displayed. Make any desired changes, then select the Trace command
button.
Toolbar: Graphic Utility Commands
GDI Command Line: T, TRACE

Trace & Update - Allows data values to be set for features found along a trace route. Executing this
command will cause the Trace & Update Specification screen to be displayed. Make any desired changes,
then select the Trace command button.
Toolbar: None
GDI Command Line: TRACEUPDATE, TU

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

232

GASWorkS 9.0

GDI
Table Of Contents

Turn Off DXF Layer - Turns a specified layer in a DXF feature off. Executing this command will cause
a prompt to appear to identify a DXF feature on the background image layer. The layer associated with the
selected feature will be turned off.
Toolbar: None
GDI Command Line: DXFLAYER

Undelete Customer (Oops) - See the Oops Customer (Undelete Customer) command.

Undelete Pipe (Oops) - See the Oops Pipe (Undelete Customer) command.

Undelete User Graphic (Oops) - See the Oops User Graphic Symbol/Line (Undelete Graphic) command.

Undelete User Text (Oops) - See the Oops User Text (Undelete Text) command.

Undo Last Data/Graphic Change - Will undo a previous data or graphic change. Executing this command
will cause the most recent data or graphic changes to be undone. The Allow Undo Of Graphic/Data
Changes preference setting must be selected (checked) to allow this command to be functional. Note Changes made by some commands cannot be undone, specifically feature additions (like adding a pipe or
customer). New features must to be deleted to remove them.
Toolbar: None - Located near the upper-left corner of the GDI Window.
GDI Command Line: UNDO

Update Customer Count - Updates the customer count for all of the pipes. Executing this command will
cause the customer count for all of the pipes to be updated based on proximity to the customer tap locations.
This command is useful for correcting customer counts when the pipe customer counts have become corrupt.
Toolbar: None
GDI Command Line: None

View Trace Report - Displays a previously created Trace Results Report. Executing this
command will cause a File Selection screen to be displayed. Select a previously saved Trace
Report to be displayed.
Toolbar: Graphic Utility Commands
GDI Command Line: None

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

233

GASWorkS 9.0

GDI
Table Of Contents

Zoom All - Redisplays the model schematic so that the entire image fits within the GDI Window.
Executing this command will cause the display to be zoomed to fit all of the model and
background image in the GDI work area.
Toolbar: View Controls
GDI Command Line: ZA, ZALL, ZOOMA, ZOOMALL, ZOOMFIT

Zoom By Scale - Reduces or enlarges the image by a User specified Scale Factor. Executing this
command will cause a prompt to appear to identify the Zoom Scale value. Scale factors less than
one reduce the image size, scale factors greater than one enlarge the image size.
Toolbar: View Controls
GDI Command Line: ZOOMS, ZOOMSCALE, ZS, ZSCALE

Zoom In - Enlarges the image size. Executing this command will cause a prompt to appear to
identify the center of the zoom area. The image will be centered around the selected point. The
amount that the image size changes is determined by the value of the Zoom Factor value. The
Zoom Factor is set by selecting the Settings menu item from the Graphics menu list.
Toolbar: View Controls
GDI Command Line: ZI, ZIN, ZOOMI, ZOOMIN

Zoom Model - Redisplays the model schematic so that the entire model image fits within the GDI Window.
Executing this command will cause the display to be zoomed to fit all of the model (only) image in the GDI
working area.
Toolbar: View Controls
GDI Command Line: ZM, ZMDL, ZMODEL, ZOOMM, ZOOMMODEL

Zoom Next - Displays the next image in the image list. Executing this command will cause the
scale and position to be changed to the next image saved in the image list. Up to 10 images can
be maintained in the image list per Display Panel.
Toolbar: View Controls
GDI Command Line: ZN, ZNEXT, ZOOMN, ZOOMNEXT

Zoom Out - Reduces the image size. Executing this command will cause the display to be
zoomed out. The amount that the image size changes is determined by the Zoom Ratio value.
The Zoom Ratio value is set by selecting the Settings menu item from the Graphics menu list.
Toolbar: View Controls
GDI Command Line: ZO, ZOOMO, ZOOMOUT, ZOUT

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

234

GASWorkS 9.0

GDI
Table Of Contents

Zoom Previous - Displays the previous image in the image list. Executing this command will
cause the scale and position to be changed to the previous image saved in the image list. Up to 10
images can be maintained in the image list per Display Panel.
Toolbar: View Controls
GDI Command Line: ZOOMP, ZOOMPREVIOUS, ZP, ZPREV

Zoom To Saved View - Displays a previously saved view. Executing this command will cause
a prompt to appear to identify the View Name to display. Use the Save Current View command
to save a view.
Toolbar: View Controls
GDI Command Line: ZOOMV, ZOOMVIEW, ZV, ZVIEW

Zoom Window - Displays the image to fit in a User specified window. Executing this command
will cause a series of prompts to appear to identify the zoom window. Select the first corner of
the zoom area, then select the opposite corner of the zoom area. A dashed box will appear while
the second corner is being selected.
Toolbar: View Controls
GDI Command Line: ZOOMW, ZOOMWINDOW, ZW, ZWIN

Mouse Events
While working in the GDI Window, when no command is being executed, right-clicking and left-clicking
will cause certain actions to occur. The actions are described in the following table.
Mouse Event

Resulting Action

Left-Click

Causes the pipe nearest to the cursor to be selected. The Pipe Data
screen will be displayed.

Shift key & Left-Click

Causes the node nearest to the cursor to be selected. The Node Data
screen will be displayed.

Ctrl key & Left-Click

Causes the customer nearest to the cursor to be selected. The Customer


Data screen will be displayed.

Alt key & Left-Click

Causes the User Text item nearest to the cursor to be selected. The
Edit Text Values screen will be displayed.

Right-Click

Causes the pipe nearest to the cursor to be selected. The GDI Pop-Up
Menu will be displayed. Select the desired action from the list, or
close the menu without executing an action.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

235

GASWorkS 9.0

GDI
Table Of Contents

Mouse Event

Resulting Action

Shift key & Right-Click

Causes the node nearest to the cursor to be selected. The GDI Pop-Up
Menu will be displayed. Select the desired action from the list, or
close the menu without executing an action.

Ctrl key & Right-Click

Causes the customer nearest to the cursor to be selected. The GDI PopUp Menu will be displayed. Select the desired action from the list, or
close the menu without executing an action.

Alt key & Right-Click

Causes the User Text item nearest to the cursor to be selected. The
GDI Pop-Up Menu will be displayed. Select the desired action from
the list, or close the menu without executing an action.

Right-clicking when a command is being executed, can cause various actions. If the command is a repeating
command, generally right-clicking the mouse exits the command. If the command requires a value entry,
right-clicking the mouse is the same as pressing the Enter key. If the command requires a feature selection,
right-clicking the mouse is the same as a left-click.
When the Show GDI Pop-Up Menu On Right Mouse Click option is selected in the Graphic Settings, a popup menu will be displayed when the right mouse button is selected, and no command is being executed.
When display of the GDI Pop-Up Menu is disabled, right-clicking when no command is being executed, will
repeat the last command.
When the GDI Pop-Up Menu is displayed, it lists various commands that
can be executed and actions that can be taken. Actions include repeating
the last command or canceling the menu. Two command lists are
generally included. The basic command list includes the Pan and various
Zoom commands. If a feature is selected, an extended menu list will
also be included. The contents of the extended menu list will vary
depending on the style used to display the menu. The extended list will
include commands that are associated with the selected data feature.
When an item in the extended list is selected, the command is executed
and applied to the selected feature as appropriate.
The display of the GDI Pop-Up Menu can be turned off by unselecting
(unchecking) the Show GDI Pop-Up Menu On Right Mouse Click item
in the Options section on the Graphics Settings screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

236

GASWorkS 9.0

GDI
Table Of Contents

When the Automatic Pan & Zoom option is selected (checked) in the Graphic Settings, certain mouse events
will cause the GDI Image to be zoomed or panned. To pan (move) the image when this option is selected,
hold down the left mouse button and move the cursor to the new location. Release the mouse button at the
new location. The image will move as appropriate. To zoom by a window (make a specified portion of the
image larger) when this option is selected, hold down the right mouse button and move the cursor to the
lower-right corner of the desired zoom window. When the mouse button is released the image will be
redrawn as appropriate. To zoom out (make the image smaller) when this option is selected, hold down the
right mouse button and move the cursor up and to the right. When the mouse button is released the image
will be redrawn proportional to the distance that the cursor was moved compared to the diagonal display
distance of the GDI Display.
The Automatic Pan & Zoom feature can be turned on or off by selecting (checking) the Automatic Pan
& Zoom item from the Options section on the Graphics Settings screen.

Key Events
While working in the GDI Window, certain key strokes will cause various actions to occur. The actions are
described in the following table.
Key Event

Resulting Action

Ctrl key & F

Causes the Find option list to be displayed - select an item from the list to
execute the associated Find command.

Ctrl key & Z

Causes the Undo option list to be displayed - select an item from the list to
execute the associated Undo command to be executed.

Enter

Causes the currently displayed prompt value to be accepted when a command is


being executed. Or, repeats the last command if no command is being executed.

Esc

Causes the current command to be canceled.

Entering Coordinates
Many of the GDI Commands require a location to be specified by coordinates. When a coordinate pair is
required, the value can be entered using one of several methods. The methods are described in the following
table.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

237

GASWorkS 9.0

GDI
Table Of Contents

Entry Method

Entry Instructions

By Default

The various Add Pipe commands remember the position of the last To
Node value. When re-executing one of the Add Pipe commands, the
last To Node's coordinate value will be displayed as the location for the
new From Node, when the From Node Location prompt appears. To
accept the value, press the Enter key or right-click.

Coordinate Pair

X and Y coordinate values can be entered by typing the desired X value,


followed by a comma or space, and then the Y value. Do not include a
digit group separator when entering the coordinate values.
For example: 1000,1000 or 1000 1000

Fixed Length &


Selected Angle

In some cases, a location can be entered using a fixed length and a


graphically selected angle. To use this method enter an "@" symbol,
followed by the distance value, and then by "<?".
For example: @500<?
A prompt will appear after the entry to allow graphical selection of the
desired angle. The fixed length and selected angle method can be used
with the various Add Pipe commands or the Add User Graphic Line
command to specify the Next End, To Node, or vertex location.

Relative Angle &


Distance

In some cases, a location can be entered using a relative angle and a


distance. To use this method enter an "@" symbol, followed by the
distance value, then the "<" symbol, and the angle value.
For example: @500<90
The top of the screen represents an angle position of (0) zero. Positive
angles are measured clockwise from 12 oclock (North). In terms of
angle measurements, North is at the top of the screen.
The relative angle and distance method can be used with the various
Add Pipe commands or the Add User Graphic Line command to
specify the Next End, To Node, or vertex location.

Node Name

The location of an existing node can be used by entering the nodes


name (number) at the prompt. To use this method enter an "N" followed
by the name of the node, or enter an "N" followed by a space and the
name of the node to be used.
For example: N REG1, NREG1

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

238

GASWorkS 9.0

GDI
Table Of Contents

Entry Method

Entry Instructions

Mouse Selection

Free-style locations can be entered by moving the cursor or crosshairs


to the desired position, then left-click to select the current position.

Snapped To An
Existing Node
(Using Auto Snap)

A location can be snapped to an existing node location using the auto


snap feature. The auto snap feature causes the coordinates of the nearest
node to the cursor or crosshairs to be used. To use the auto snap feature,
hold down the Shift key while left-clicking.

Snapped To An
Existing Node
(Using Node Snap)

A location can be snapped to an existing node location using the node


snap feature. The node snap feature causes the coordinates of a node
falling within the snap tolerance of the cursor or crosshairs to be used.
To use the node snap feature, turn on the Node Snap mode by clicking
on the Node Snap icon located on the Graphic Construction Commands
toolbar. The node snap tolerance is set by selecting the Settings menu
item from the Graphics menu list.

Digitized

If a WinTab compliant digitizing tablet is connected, coordinate values


can be digitized using the GDI. Before the tablet can be used, it must
first be calibrated using the various Calibrate Digitizing Tablet
commands. Once calibrated, the tablet can be turned on or off using
the Toggle Digitizing Tablet On/Off command, to either accept or ignore
coordinates from the tablet. When the tablet is turned on, it will
automatically be activated when a command is executed which requires
the entry of a coordinate pair, and deactivated after the coordinate
location has been digitized. See the Help System for complete details
and examples on using a digitizing tablet with GASWorkS.

When entering coordinates for a new node's position, if an existing node is found within a distance equal to
the Node Size value, the new node's coordinates are ignored and the existing node's coordinates are used.
This prevents multiple nodes from being placed at the same location. Additionally, the Node Snap command
described earlier in this section can be used to force node snapping when entering new coordinate values.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

239

GASWorkS 9.0

GDI
Table Of Contents

Attribute Valve Data Screen


If attribute valve data is included in the model, the data associated with the Attribute Valve features are
accessed through the Attribute Valve Data screen. The screen is accessed by selecting the Edit Attribute
Valve Data command from the GDI Command List. The features associated with the data screen are
described as follows.

Data Items
Pipe ID - Displays the internal identification number of the pipe that the valve is associated with. This value
is automatically assigned and cannot be changed by the User.
Valve Number - A data field used to enter a number used to identify the valve. The number can be up to
twenty (20) alpha-numeric characters. Enter a value by typing it into the data field.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

240

GASWorkS 9.0

GDI
Table Of Contents

Background Image Settings Screen


The settings that control the display of the background image are accessed through the Background Image
Settings screen. The screen is accessed by selecting the Background Settings menu item from the Graphics
menu list. The features associated with the screen are described as follows, and varies depending on the type
of image file attached.

BMP File

Data Items
Attached Background Files - A panel used to display the names of the currently attached background image
files. Select a file from the list to make changes to its display properties. The display of a file can be
controlled by selecting (checking) or unselecting (un-checking) the file in the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

241

GASWorkS 9.0

GDI
Table Of Contents

Insertion Point (Upper Left Coordinates) - A pair of data fields used to enter the position of the upper-left
(northwest) corner of the image. The X value represents the horizontal coordinate value of the upper-left
corner, and the Y value represents the vertical coordinate value of the upper-left corner. Enter the values by
typing them into the associated data fields. Ensure that the values are expressed in terms of the default
coordinate units.
Scale Factor - A data field used to enter the number of coordinate units represented by one pixel. This value
sets the scale for the image. Either enter a value by typing it into the data field, or select the Calculate Scale
Factor command button to calculate a value. See the following Notes & Considerations section for
instructions on calculating this value.
Use The Model Path Location For The Background File Location - A checkbox used to indicate whether
the image file is located in the same directory as the associated model. This item is useful when models are
frequently shared or moved, eliminating the need to reset the image file location each time the model is
moved. Select (check) this option if desired.

Command Buttons
Calculate Scale Factor - A command button used to open the Scale Factor calculation screen. Enter the
desired values by typing them into the associated data fields, then select the Apply command button to apply
the factor to the background image. This command button is only displayed when a BMP image is selected.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

242

GASWorkS 9.0

GDI
Table Of Contents

DXF File

Data Items
Attached Background Files - A panel used to display the names of the currently attached background files.
Select a file from the list to make changes to its display properties. The display of a file can be controlled
by selecting (checking) or un-selecting (un-checking) the file in the list.
Convert Colors To Gray - A checkbox used to indicate whether the DXF image will be displayed using a
light gray color and not the original colors. Select (check) this option if desired.
Layer List - A panel used to display the names of the layers found in the selected DXF file. The Status item
specifies whether the layer will be displayed (On) or not (Off). The Layer Names item lists the layers
found in the DXF file - all layers will be listed regardless of their status in the original drawing file.
Line Weight - A data field used to enter the width of the lines used to display the DXF image. The line
weight is expressed in screen pixels. Enter a value by typing it into the data field.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

243

GASWorkS 9.0

GDI
Table Of Contents

Origin Shift (In Model Coordinate Units) - A pair of data fields used to enter the amount to shift the image
origin. The X value specifies the amount to move the image in the east-west (horizontal) direction. The Y
value specifies the amount to move the image in the north-south (vertical) direction. Enter the values by
typing them into the associated data fields. The values are expressed in Coordinate Units.
Scale Factor - A data field used to enter the scale factor for the DXF image. The image coordinates are
multiplied by the scale factor when the image is processed. The original image data is not changed, the
changes are only made to the displayed image. Enter a value by typing it into the data field.
Use The Model Path Location For The Background File Location - A checkbox used to indicate whether
the image file is located in the same directory as the associated model. This item is useful when models are
frequently shared or moved, eliminating the need to reset the image file location each time the model is
moved. Select (check) this option if desired.

Command Buttons
Turn All Layers On/Off - A command button used to turn all of the DXF layers On or Off for the
selected DXF file. Once all of the layers are turned on or off, the settings for individual layers can be
set as desired. This command button is only displayed when a DXF image is selected.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

244

GASWorkS 9.0

GDI
Table Of Contents

SHP File

Data Items
Attached Background Files - A panel used to display the names of the currently attached background files.
Select a file from the list to make changes to its display properties. The display of a file can be controlled
by selecting (checking) or un-selecting (un-checking) the file in the list.
Convert Colors To Gray - A checkbox used to indicate whether the SHP image will be displayed using a
light gray color and not the original colors. Select (check) this option if desired.
Line Style - A drop-down list used to select the style to be used to display the lines in the image. Select an
item from the list.
Line Weight - A drop-down data list used to select the width of the lines used to display the SHP image. The
line weight is expressed in screen pixels. Select an item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

245

GASWorkS 9.0

GDI
Table Of Contents

Origin Shift (In Model Coordinate Units) - A pair of data fields used to enter the amount to shift the image
origin. The X value specifies the amount to move the image in the east-west (horizontal) direction. The Y
value specifies the amount to move the image in the north-south (vertical) direction. Enter the values by
typing them into the associated data fields. The values are expressed in Coordinate Units.
Point Symbol Size (In Model Coordinate Units) - A drop-down data list used to select the size of the
symbols used to display the image. The size is expressed in Model Coordinate Units. Select an item from the
list.
Point Symbol Style - A drop-down list used to select the style used to display the symbols in the image.
Select an item from the list.
Scale Factor (Drawing Unit To Coordinate Ratio) - A data field used to enter the scale factor for the SHP
image. The image coordinates are multiplied by the scale factor when the image is processed. The original
image data is not changed, the changes are only made to the displayed image. Enter a value by typing it into
the data field.
Use The Model Path Location For The Background File Location - A checkbox used to indicate whether
the image file is located in the same directory as the associated model. This item is useful when models are
frequently shared or moved, eliminating the need to reset the image file location each time the model is
moved. Select (check) this option if desired.

Command Buttons
Apply - A command button used to close the screen and apply any changes.
Attach BMP - A command button used to attach a Bitmap File (BMP) to the model. When selected, a File
Selection screen will be displayed. Select the desired Filename, then select the Continue command button
to attach the file.
Attach DXF - A command button used to attach a Drawing Interchange File (DXF) to the model. When
selected, a File Selection screen will be displayed. Select the desired Filename, then select the Continue
command button to attach the file.
Attach SHP - A command button used to attach a Shape File (SHP) to the model. When selected, a File
Selection screen will be displayed. Select the desired Filename, then select the Continue command button
to attach the file.
Cancel - A command button used to close the screen without saving any changes.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

246

GASWorkS 9.0

GDI
Table Of Contents

Change Path For Selected File - A command button used to change the path for the currently selected
(highlighted) background image file. When selected, a File Selection screen will be displayed. Select or enter
the desired location, then select the Continue command button to save the change.
Close - A command button used to close the screen and save any changes.
Remove - A command button used to remove the currently selected (highlighted) background image file
from the model.
Save Settings For Selected File - A command button used to save changes to the currently selected
(highlighted) background image file. Changes to a background image files settings are not saved unless this
command button is selected.

Notes & Considerations


! A Bitmap (BMP) style image can be used as a background in the Graphic Data Interface (GDI). The image
file must adhere to the standard Windows Bitmap (BMP) file specifications. A Bitmap file can contain a
scanned image, or the raster output of a graphic application which supports the Bitmap format.
! A Drawing Interchange File (DXF) style image can be used as a background in the Graphic Data Interface
(GDI). The image file must adhere to the standard Drawing Interchange Format (DXF) file specifications.
The file can contain the output of a CAD or vector based drawing application that supports the DXF format.
! A Shape (SHP) file style image can be used as a background in the Graphic Data Interface (GDI). The
image file must adhere to the standard Shape file specifications. A Shape file can contain output from a GIS
or other application that supports the Shape file format. Shape files contain only one graphic type per file.
For example, a Shape file can contain only point type features or only line type features.
! A file of another format can potentially be used as a background image by first converting the file to a
format supported by GASWorkS.
! Multiple files of varying type may be a attached to a model.
! The Bitmap Scale Factor (Coordinate To Pixel Ratio) establishes the "scale" for Bitmap style images.
Bitmap images contain raster style images. Raster images are made up of small "dots" called pixels. The scale
tells the GDI how many coordinates are represented by one pixel in the file. For example, the number of feet
per pixel. To determine this value, divide the original drawing or map scale by the image resolution in dots
per inch [dots per centimeter]. For example, the Coordinate To Pixel Ratio for a 1 Inch = 2000 Feet map
scanned at 400 dots per inch would be, 2000 400 = 5 Feet/pixel. The scale factor can be automatically
calculated by selecting the Calculate Scale Factor command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

247

GASWorkS 9.0

GDI
Table Of Contents

! Before attaching a BMP file, ensure that the GDI Coordinate Units are set to match the Coordinate To
Pixel Ratio. For example, if the Coordinate To Pixel Ratio is calculated as Feet per pixel, the coordinate units
should be set to Feet, or the Coordinate To Pixel Ratio should be recalculated to accommodate the current
coordinate units.
! Before attaching a DXF file, ensure that the GDI Coordinate Units are set to match the coordinate values
found in the DXF file, or use an appropriate Scale Factor to accommodate the current coordinate units. If
more than one DXF file is attached, the coordinate values for all of the files must be expressed in the same
units.
! For SHP files, the Line Weight and Line Style only apply to files containing line type features - the Point
Symbol Size and Point Symbol Style only apply to files containing point type features.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

248

GASWorkS 9.0

GDI
Table Of Contents

Color Legend
When a data item is color coded using the Color By Range routine, a legend of the colors and associated
ranges can be displayed using the Color Legend. The features associated with the screen are described as
follows.

Data Items
Color Ranges - Represent the value ranges associated with each display color. These values are
automatically assigned and cannot be changed by the User.

Notes & Considerations


! The location of the Color Legend may be adjusted by dragging and dropping the Color Legend at the
desired location.
! The size of the Color Legend may be adjusted by dragging the edges or corners.
! The Color Legend can be converted to User Text so that it can be plotted using the Add Legend As Text
command.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

249

GASWorkS 9.0

GDI
Table Of Contents

Customer Data Screen


If customer features are included in the model, the data associated with the features are accessed through the
Customer Data screen. The features associated with the data screen are described as follows.

Model Data Tab

Data Items
Adjust Load By Design Factor - A checkbox used to indicate whether the nodes base load value will be
multiplied by the Design Factor during the solution process. The original data value is not changed by this
setting, the load value is only modified during the solution calculation. Select (check) this option if desired.
ID Number - Refers to the customers unique internal (to GASWorkS) identification number. This value
is automatically assigned and cannot be changed by the User.
Load Application - A group of option buttons used to specify how to apply the customers load. Select the
desired option.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

250

GASWorkS 9.0

GDI
Table Of Contents

Both Nodes - Indicates that one-half of the load will be applied to the external load value of the
assigned pipes From and To Node.
Diversified - Indicates that the load will be applied to the pipes downstream node according to
the associated IGE standard. When the Diversified option is selected, the heating style type is
enabled. Select an item from the list.
From Node -Indicates that the entire load will be applied to the external load value of the assigned
pipes From Node.
To Node - Indicates that the entire load will be applied to the external load value of the assigned
pipes To Node.
Per Unit Load - A data field used to enter the load for each customer unit. If no database is attached, the
item may be manually entered by the User. Otherwise, the item will automatically be assigned. To manually
enter a load value, enter a value by typing it into the data field. To indicate a demand (flow leaving the
system), enter the value as negative (-). If the load is manually entered, ensure the value is expressed in terms
of the selected dimensional unit.
Record Number -Refers to the position of the record in the data file of the selected customer feature. This
value is automatically assigned and cannot be changed by the User.
Status - A pair of option buttons used to specify the status of the connection between the model and the
attribute file. If the status is turned Off, the connection will be disabled until turned back On. Select the
desired option.
Unit Count - A data field used to enter the total number of units (customers) that the selected individual
customer represents. The value must be in the range of 1 to 32,000. Enter a value by typing it into the data
field.

Calculates Values
Customer Link ID Number - Displays the customers unique internal (to GASWorkS) identification
number. This value is automatically assigned and cannot be changed by the User.
Supplied By Branch From Customer ID - If the selected customer is a branch customer, this item
displays the ID Number of the trunk customer to which the branch is attached. This value is automatically
assigned and cannot be changed by the User.
Supplies Branch Customer ID - If the selected customer is a trunk customer, this item displays the ID
Number of the branch customer assigned to it. This value is automatically assigned and cannot be changed
by the User.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

251

GASWorkS 9.0

GDI
Table Of Contents

Supply Pipe (Main) Link ID - Displays the Link ID number of the pipe (main) that supplies the customer the pipe that the customer is assigned to. The customers load will be assigned to the external load of the
pipes From and To Node as specified by the Load Application setting. This value cannot be changed by the
User. If the assigned pipe does not have an assigned Link ID value, the record number of the assigned pipe
will be displayed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

252

GASWorkS 9.0

GDI
Table Of Contents

Graphic Data Tab

Data Items
Display Text Values - A checkbox used to indicate whether the text values for the customer will be
displayed. Select (check) this option if desired.
Symbol Color - A drop-down list used to select the color used to display the symbol at the customers
location. To set a Color, select the Selected Color item from the list. Either click in the associated color
box or select the Select Line Color command button. The Color Palette will be displayed. Select the desired
color, then select the OK command button. Or, select Default from the list.
Symbol Size - A data field used to enter the size of the symbol used to display the customers location. To
set an individual size, enter a value greater than zero (0) by typing it into the data field. Or, to use the default
size, select (check) the Use Default Size option. The size can be entered either as an absolute value expressed
in terms of the current coordinate units, or as a relative value expressed as a percentage of the diagonal
distance across the screen.
Symbol Style - A drop-down list used to select the style of the symbol used to display the customers
location. Select an item from the list, or to use the default style, select the Default item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

253

GASWorkS 9.0

GDI
Table Of Contents

Use Default Size - A checkbox used to indicate whether the default size for the customer symbol will be
used. Select (check) this option if desired.
X Coordinate - A data field used to enter the customers horizontal location (east-west coordinate). Enter
a value by typing it into the data field. Ensure that the value is expressed in terms of the assigned dimensional
unit.
Y Coordinate - A data field used to enter the customers vertical location (north-south coordinate). Enter
a value by typing it into the data field. Ensure that the value is expressed in terms of the assigned dimensional
unit.

Command Buttons
Select Symbol Color - A command button used to set the customer display color. When selected, the Color
Palette will be displayed. Select the desired color, then select the OK command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

254

GASWorkS 9.0

GDI
Table Of Contents

Attribute Data Tab

Data Items
Attribute File Data... - If a linked or external database is attached, these items will display the values
contained in the linked database record. If a linked database is attached, the values can be changed by the
User. If the attached database is of another type, the values are view-only and cannot be changed by the User.
To edit a value, click in the associated data cell, then either type the desired value or select an item from the
list. To save the change, click in another data cell or press the Enter key.
Link To Attribute File - If an external database is attached, this item indicates whether the customer feature
should be linked to the external database. If selected (checked), the customer will be linked by matching the
Link ID value. Select (check) this option if desired.

Calculated Value
Pipe Facility Type - Displays the assigned Facility Type of the pipe (main) that the customer is attached to.
The customer inherits the same Facility Type as the assigned pipe (main). This value is automatically
assigned and cannot be changed by the User.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

255

GASWorkS 9.0

GDI
Table Of Contents

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.
Close & Solve - A command button used to close the screen, save any changes, and execute the Solution
routine.
Print - A command button used to print the data associated with the current customer.

Notes & Considerations


! If an external database is attached, the Link ID value is used to make a match between the selected data
feature and the corresponding record in the database. The first record in the database, with a matching Link
ID value, is displayed in the Attribute Data list.
! The Customer Data screen can be accessed through various command methods, or by placing the cursor
near the desired customer and left-click while holding down the Ctrl key.
! The Total Load value associated with the customer is computed by multiplying the Unit Count by the Per
Unit Load value.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

256

GASWorkS 9.0

GDI
Table Of Contents

Edit Graphic Data Values Screen - (Lines)


If User Graphic Lines are present, the graphic line settings can be accessed through the Edit Graphic Data
Values screen. The features associated with the data screen are as follows.

Data Items
Facility Type - A drop-down list used to select the facility type to associate with the selected graphic line.
Select an item from the list.
Line Color - A color box used to specify the color used to display the selected graphic line. To set a color,
click in the associated color box. The Color Palette will be displayed. Select the desired color, then select
the OK command button. Or select the Select Line Color command button.
Line Style -A drop-down list used to select the style of the line used to display the selected graphic line.
Select an item from the list.
Line Width - A data field used to enter the width of the line used to display the selected graphic line. Enter
a value by typing it into the data field. The value must be greater than 0 and is expressed in terms of screen
pixels.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

257

GASWorkS 9.0

GDI
Table Of Contents

Pattern Spacing - A data field used to enter the spacing of the symbols in certain non-continuous line styles.
Enter a value by typing it into the data field. The value must be greater than 0, and is expressed in coordinate
units.
X Coordinate - A data field used to enter the horizontal location (east-west coordinate) of the start of the
selected graphic line. Enter a value by typing it into the data field. Ensure the value is expressed in terms of
the assigned dimensional unit.
X2 Coordinate - A data field used to enter the horizontal location (east-west coordinate) of the end of the
selected graphic line. Enter a value by typing it into the data field. Ensure the value is expressed in terms of
the assigned dimensional unit.
Y Coordinate - A data field used to enter the vertical location (north-south coordinate) of the start of the
selected graphic line. Enter a value by typing it into the data field. Ensure the value is expressed in terms of
the assigned dimensional unit.
Y2 Coordinate - A data field used to enter the vertical location (north-south coordinate) of the end of the
selected graphic line. Enter a value by typing it into the data field. Ensure the value is expressed in terms of
the assigned dimensional unit.

Calculated Values
Length - Displays the length of the selected graphic line in the default dimensional length units. This value
is automatically assigned and cannot be changed by the User.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.
Select Line Color - A command button used to set the graphic line display color. When selected, the Color
Palette will be displayed. Select the desired color, then select the OK command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

258

GASWorkS 9.0

GDI
Table Of Contents

Edit Graphic Data Values Screen - (Symbols)


If User Graphic Symbols are present, the graphic symbol settings can be accessed through the Graphic
Symbol Data screen. The features associated with the data screen are as follows.

Data Items
Facility Type - A drop-down list used to select the facility type to associate with the selected symbol. Select
an item from the list.
Rotation - A data field used to enter the rotation of the selected symbol. The value is expressed in degrees,
clockwise from 12 oclock (North). In terms of angle measurements, North is at the top of the screen. Enter
a value by typing it into the data field. Ensure the value is expressed in terms of the assigned dimensional
unit. Not all symbols can be rotated. For those symbols, the rotation value is ignored.
Symbol Color - A color box used to specify the color used to display the selected symbol. To set a Color,
click in the associated color box. The Color Palette will be displayed. Select the desired color, then select
the OK command button. Or select the Select Symbol Color command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

259

GASWorkS 9.0

GDI
Table Of Contents

Symbol Size - A data field used to enter the size of the selected symbol to be used for the display of the
graphic symbol. The size can be expressed as an absolute value in coordinate units, or as a value relative to
the diagonal distance across the GDI Window, expressed as a percentage. To set an individual size, enter a
value greater than zero (0) by typing it into the data field. To use the default size, select (check) the Use
Default Size item.
Symbol Style - A drop-down list used to select the style of the selected symbol to be used for the display the
graphic symbol. Select an item from the list.
Use Default Size - A checkbox used to indicate whether the default size for the graphic symbol will be used.
Select (check) this option if desired.
X Coordinate - A data field used to enter the horizontal location (east-west coordinate) of the center of the
graphic symbol. Enter a value by typing it into the data field. Ensure the value is expressed in terms of the
assigned dimensional unit.
Y Coordinate - A data field used to enter the vertical location (north-south coordinate) of the center of the
graphic symbol. Enter a value by typing it into the data field. Ensure the value is expressed in terms of the
assigned dimensional unit.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.
Select Symbol Color - A command button used to set the graphic symbol display color. When selected, the
Color Palette will be displayed. Select the desired color, then select the OK command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

260

GASWorkS 9.0

GDI
Table Of Contents

Edit Text Values Screen


If User Text features are included in the model, the data associated with the features is accessed through the
Edit Text Values screen. The Edit Text Values screen is accessed by selecting the Edit User Text command
or by selecting the Edit User Text icon from the Display Controls toolbar. The features associated with the
data screen are described as follows.

Data Items
Bold - A checkbox used to indicate whether the text value will be displayed using a bold (heavy) font style.
Select (check) this option if desired.
Color Box - A color box used to specify the color used to display the associated text values. To set a Color,
select the Set Color command button. The Color Palette will be displayed. Select the desired color, then
select the OK command button.
Facility Type - A drop-down list used to select the facility type to associate with the selected feature. Select
an item from the list.
Height - A data field used to enter the display height of the text value, expressed in coordinate units. Enter
a value by typing it into the data field.
Italic - A checkbox used to indicate whether the text value will be displayed using an italic font style. Select
(check) this option if desired.
Rotation - A data field used to enter the rotation angle used to display the text values. The rotation angle is
measured as degrees clockwise from 12 oclock (North). In terms of angle measurement, North is at the top
of the display. Enter a value by typing it into the data field.
Text Value - A data field used to enter the value to be associated with the data feature. Enter a value by
typing it into the data field.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

261

GASWorkS 9.0

GDI
Table Of Contents

Underline - A checkbox used to indicate whether a line will be placed under the text value when it is
displayed. Select (check) this option if desired.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.
Set Color - A command button used to set the text display color. When selected, the Color Palette will be
displayed. Select the desired color, then select the OK command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

262

GASWorkS 9.0

GDI
Table Of Contents

Graphic Settings Screen


The GDI control variables may be set using the Graphic Settings screen. The features associated with the
screen are described as follows.

Data Items
Options Automatic Repaint - A checkbox used to indicate whether the display will automatically be
repainted after various commands are executed (including the Solve Model command). Select
(check) this option if desired.
Automatic Zoom On Find - A checkbox used to indicate whether the display will automatically
zoom and pan so that the selected features location is centered in the display, when using one of the
Find commands. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

263

GASWorkS 9.0

GDI
Table Of Contents

Display Flow Arrow Once Per Polyline Pipe - A checkbox used to indicate whether the flow arrow
symbol will be displayed only once per polyline type pipe. Select (check) this option if desired. If
the item is not selected (not checked), a symbol will be placed on each segment of the polyline type
pipe.
Display Panel Outlines - A checkbox used to indicate whether an outline of the portion of the image
displayed on the non-current display panels, will be displayed on the current tab display. Select
(check) this option if desired.
Display Running Length - A checkbox used to indicate whether the graphic length of a pipe being
added, will be displayed as the vertices and the To Node Locations are being selected. The length
will be displayed in the coordinate panel to the right of the XY coordinate values. Select (check) this
option if desired.
Display Solid Pipe Symbols - A checkbox used to indicate whether the piping symbols will be filled
with the current pipe symbol color. Select (check) this option if desired.
Display Vertex Symbols - A checkbox used to indicate whether the vertex symbols will be placed
at the location of the vertices along a polyline type pipe or a service line. Select (check) this option
if desired.
Display UnSpecified Facilities - Depending on the number of Facility Types associated with the
model, a series of items will be displayed, allowing certain Facilities Types to be displayed or not.
If a Facility Type is selected (checked) for display, all features associated with that type will be
displayed. If a Facility Type is not selected (not checked), none of the features associated with that
type will be displayed.
Ignore Pipes Outside Display - A checkbox used to indicate whether the pipes where the From and
To Node Locations are outside the display, are not displayed. When selected (checked) this item can
help prevent the display of stray lines when zooming in and will also reduce the time required to
repaint the image. Select (check) this option if desired.
Query During New Feature Entry - A checkbox used to indicate whether the associated data
screen will be displayed when a new feature is added. Select (check) this option if desired.
Show GDI Pop-Up Menu On Right Mouse Click - A checkbox used to indicate whether the GDI
Pop-Up Menu will be displayed when the right mouse button is clicked and no command is being
executed, when working in the GDI Window. Select (check) this option if desired.
Show GDI Tooltip - A checkbox used to indicate whether the display of tooltips for the GDI
Window will be displayed. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

264

GASWorkS 9.0

GDI
Table Of Contents

Suppress Flow Arrow Where Flow Is Less Than Convergence Factor - A checkbox used to
indicate whether the display of the flow arrows will be suppressed on pipes where the flow value is
less than the convergence factor. Select (check) this option if desired.
Feature Highlight Color - A color box used to specify the color used to display the selected features. To
set a Color, click in the associated color box. The Color Palette will be displayed. Select the desired color,
then select the OK command button. Or select (check) the Use Default Color item.
Use Default Color - A checkbox used to indicate whether the Default color will be used to display the
selected features. Select (check) this option if desired.
Settings Coordinate Units - A drop-down list used to select the dimensional units to be used for the GDI
coordinate values. Select an item from the list. The dimensional unit for the pipe lengths and the
coordinate units can be different values. The length and coordinate values will automatically be
converted as necessary to ensure consistency.
Customer Symbol Size - A data cell used to enter the size of the symbol to be used for the display
of the customer features. The size can be expressed as an absolute value in coordinate units, or as
a value relative to the diagonal distance across the GDI Window, expressed as a percentage. Enter
a value by typing it into the data cell.
Customer Symbol Style -A drop-down list used to select the default symbol to be used for the
display of the customer features. Select an item from the list.
Flow Arrow Symbol Size - A data cell used to enter the size of the symbol to be used for the display
of the pipe flow arrows. The size can be expressed as an absolute value in coordinate units, or as a
value relative to the diagonal distance across the GDI Window, expressed as a percentage. Enter a
value by typing it into the data cell.
Flow Arrow Symbol Style - A drop-down list used to select the symbol to be used for the display
of the pipe flow arrows. Select an item from the list.
Node Snap Ratio - A drop-down list used to select the Node Snap Ratio value. The value is
expressed as a factor. The Node Snap Ratio is used to control the sensitivity of the Node Snap
command. See the following Notes & Considerations section for a description of this setting's use.
Select a value from the list.
Node Symbol Size -A data cell used to enter the size of the symbol to be used for the display of the
node features. The size can be expressed as an absolute value in coordinate units, or as a value
relative to the diagonal distance across the GDI Window, expressed as a percentage. Enter a value
by typing it into the data cell.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

265

GASWorkS 9.0

GDI
Table Of Contents

Node Symbol Style - A drop-down list used to select the default symbol to be used for the display
of the node features. Select an item from the list.
Pan/Scroll Change - Horizontal - A drop-down list used to select the amount to move the image
when panning the image horizontally (right or left) using the Scroll icon. The value is expressed as
a percentage of the horizontal image extent. Select a value from the list.
Pan/Scroll Change - Vertical - A drop-down list used to select the amount to move the image when
panning the image vertically (up or down) using the Scroll icon. The value is expressed as a
percentage of the vertical image extent. Select a value from the list.
Pipe Line Style - A drop-down list used to select the default line style to be used for the display of
the pipe segments. Select an item from the list.
Pipe Line Width - A drop-down list used to select the default line width to be used for the display
of the pipe segments. The width value is expressed in screen pixels. Select a value from the list.
Pipe Symbol Size - A data cell used to enter the size of the symbol to be used for the display of the
pipe symbols (for non-pipe hydraulic types). The size can be expressed as an absolute value in
coordinate units, or as a value relative to the diagonal distance across the GDI Window, expressed
as a percentage. Or, enter a zero (0) to indicate that symbol size will be determined by the distance
between the From and To Nodes. Enter a value by typing it into the data cell.
Refresh Increment - A drop-down list used to select how often the display should be updated when
the image is being repainted. The value is expressed as a percentage of the image contents. The
smaller the value, the more often the display will be updated. The larger the value the less often the
display will be updated. If the value is set at 100, the display will not be updated until the image is
completely repainted. Select a value from the list.
Supply Flag Size - A data cell used to enter the size of the flag symbol to be used to identify the
supply nodes. The size can be expressed as an absolute value in coordinate units, or as a value
relative to the diagonal distance across the GDI Window, expressed as a percentage. Enter a value
by typing it into the data cell.
User Graphic Symbol Size - A data cell used to enter the size of the User Graphic Symbols. The
size can be expressed as an absolute value in coordinate units, or as a value relative to the diagonal
distance across the GDI Window, expressed as a percentage. Enter a value by typing it into the data
cell.
Zoom Ratio - A drop-down list used to select the Zoom Ratio value. The value is expressed as a
factor. The Zoom Ratio is used to control the sensitivity of the Zoom In and Zoom Out commands.
See the following Notes & Considerations section for a description of this setting's use. Select a
value from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

266

GASWorkS 9.0

GDI
Table Of Contents

Command Buttons
Cancel - A command button used close the screen without saving any changes.
Close - A command button used to close the screen, save any changes, and apply the new settings to the
current display.
Save As Default - A command button used to the save the current settings as the default settings to use when
creating a new model.

Notes & Considerations


! The Node Snap Ratio is used to adjust the sensitivity of the Node Snap command. The product of the Node
Snap Ratio and the Node Size is referred to as the Fuzzy Tolerance. When adding a new pipe or measuring
a distance, if the Node Snap feature is On, the GDI will attempt to find an existing node within the Fuzzy
Tolerance of the selected point. A warning message will be displayed if a node is not found.
! The Zoom Ratio is used to indicate the magnitude of change in the image size which occurs when either
of the Zoom In or Zoom Out commands are used. For example, if the Zoom Ratio is set at two (2), the Zoom
In command will increase the size of the image by two times. Conversely, at a Zoom Ratio of two (2), the
Zoom Out command will decrease the size of the image by two times.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

267

GASWorkS 9.0

GDI
Table Of Contents

Multiple Edit Specifications Screen


In the GDI, multiple pipes, nodes, and customers can be edited using one of the Multiple Edit commands.
When one of these commands is used, the desired changes are assigned using the Multiple Edit
Specifications screen. The features associated with the screen are described as follows.

Data Items
Equal To - Either a drop-down list or a data field used to specify the new value for the selected Set item.
Either select an item from the list or enter a value by typing it into the data field.
Set - A drop-down list used to select the desired item to be changed. Select an item from the list.

Command Buttons
Apply - A command button used to apply any changes.
Close - A command button used to close the screen.
Close & Solve - A command button to close the screen and execute the Solution routine.

Notes & Considerations


! Several changes can be made to the selected features by changing the Set and Equal To items, and
repeatedly selecting the Apply command button.
! If a change is inadvertently made, and the Allow Undo Of Graphic/Data Changes preference setting has
been selected, immediately select the Undo icon to restore the original values.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

268

GASWorkS 9.0

GDI
Table Of Contents

! Features can be selected by individually clicking on each desired feature, by drawing a window around
the desired features, or a combination of both. To draw a selection window, hold down the Shift- key, place
the cursor at the desired location of the first corner, then left-click. Move the mouse to the other corner, a
dashed box will be displayed, hold down the Shift key and select the second corner location. If a feature that
is already selected, is selected again, it will be removed from the selection set. Right-click when the selection
is complete. When using the selection window to select pipe features, only pipes where both the From and
To Node fall within the selection window will be included.
! In addition to being able to change or set specific values, several commands may also be executed from
the Multiple Edit Specifications screen. The commands start with the Cmd prefix. The available commands
are listed in the following table.
Command

Description
Customer Features

Delete Selected
Customers

Executing this command will cause the selected customers to be deleted.


Erroneously deleted customers can be restored using the Undelete
Customer (Oops) command.

Extract Selected
Customers

Executing this command will cause the selected customers to be copied


to another model. The User will be prompted for various processing
options during execution of this command.

Move Customer
Location

Executing this command will cause the selected customers to be moved


to a new location. The customers will be moved by a User specified
location. The relative configuration of the selected customers will not be
changed.

Reassign Customer

Executing this command will cause the selected customers to be


reassigned to a new pipe/main.

Remove Service Line


(UnAssign
Customer)

Executing this command will cause the selected customers to be


unattached from their current supply main(s), and their service lines to
be eliminated. The selected customers will be unassigned after
completion of the command.

Stack Customers

Executing this command will cause the selected customers to be


stacked directly upon each other at a specified location.

Summarize Selected
Customers

Executing this command will cause a summary of the various data values
to be created for the selected customers.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

269

GASWorkS 9.0

GDI
Table Of Contents

Command

Description
Node Features

Clear Intersection
Flag

Selecting this command will cause any displayed intersection flags to be


removed.

Summarize Selected
Nodes

Selecting this command will cause a summary of the various data values
to be created for the selected nodes.
Pipe Features

Copy Selected Pipes

Executing this command will cause the selected pipes, and optionally
customers, to be copied to a new location in the current model. The User
will be prompted for various processing options during execution of this
command.

Delete Selected Pipes

Executing this command will cause the selected pipes to be deleted.


Erroneously deleted pipes can be restored using the Undelete Pipe
(Oops) command.

Extract Selected
Pipes

Executing this command will cause the selected pipes to be copied to


another model. The User will be prompted for various processing
options during execution of this command.

Summarize Selected
Pipes

Selecting this command will cause a summary of the various data values
to be created for the selected pipes.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

270

GASWorkS 9.0

GDI
Table Of Contents

Node Data Screen


In the GDI, the node data is accessed using the Node Data screen. The screen is displayed when the Edit
Node Data command is selected, or may be displayed when a new node feature is added using one of the
Graphic Construction or Graphic Edit commands. The features associated with the screen are described as
follows.

Hydraulic Tab

Data Items
Adjust Base Load By Design Factor - A checkbox used to indicate whether the nodes base load value will
be multiplied by the Design Factor during the Solution routine. The original data value is not changed by this
setting, the load value is only modified during the solution calculation. Select (check) this option if desired.
Adjust External Load By Design Factor - A checkbox used to indicate whether the nodes external load
value will be multiplied by the Design Factor during the Solution routine. The original data value is not
changed by this setting, the load value is only modified during the solution calculation. Select (check) this
option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

271

GASWorkS 9.0

GDI
Table Of Contents

Base Load - A data field used to enter the node's base load value. If the value is Known, enter a value by
typing it into the data field. Ensure the value is expressed in terms of the selected dimensional unit. If the
value is Unknown, select (check) the box adjacent to the load dimensional units. Initially the field is
populated with the default load value. If the model has recently been solved and the load is Unknown, the
field will contain the calculated load value for the node. See the following Notes & Considerations section
for additional information on the base and external load values.
Base Load Status - A pair of option buttons used to specify whether the base load value is on or off
during the Solution routine. If the status is set to Off the value is assumed to be zero (0) during the solution
calculation. The original data value is not changed by this setting. Select the desired option.
Elevation - A data field used to enter the node's height above sea level. Enter a value by typing it into the
data field. Ensure the value is expressed in terms of the assigned dimensional unit. Initially, the field is
populated with the default elevation value.
External Load Status - A pair of option buttons used to specify whether the external load value is on or
off during the Solution routine. If the status is set to Off the value is assumed to be zero (0) during the
solution calculation. The original data value is not changed by this setting. Select the desired option.
Node Name - A data field used to enter the unique name or number for the selected node. The name may
contain up to forty (40) alpha-numeric characters. The name is automatically assigned when a new node is
added, however the User can change the name to any desired value. The name must be unique to the model.
To change the name, enter a value by typing it into the data field. A warning message will appear if the name
already exists.
Pressure - A data field used to enter the node's pressure value. If the value is Known, enter a value by typing
it into the data field. Ensure the value is expressed in terms of the selected dimensional unit. If the value is
Unknown, select (check) the box adjacent to the pressure dimensional units. Initially, the field is populated
with the default pressure value. If the model has recently been solved and the pressure is Unknown, the item
will contain the calculated pressure value for the node.
Record Number - Refers to the position of the current node record in the node data file. This value is
automatically assigned and cannot be changed by the User.
Temperature - A data field used to enter the average flowing temperature of the gas at the node's location.
If the value is Known, enter a value by typing it into the data field. Ensure the value is expressed in terms
of the assigned dimensional unit. If the value is Unknown, select (check) the box adjacent to the temperature
dimensional units label. Initially, the field is populated with the default temperature value. If the model has
recently been solved and the temperature is Unknown and the Calculate Temperature Values solution option
was selected, the item will contain the calculated temperature value for the node.
Unknown - A checkbox used to indicate whether the associated data values are known or unknown. Select
(check) this option if the associated data values are Unknown.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

272

GASWorkS 9.0

GDI
Table Of Contents

Other Tab

Data Items
Allow Calculation of Gas Properties - A checkbox used to indicate whether the gas properties for this node
are calculated during the Solution routine. If the gas property values are Known, select (check) this option.
If the gas property values are Unknown, unselect (un-check) this option. Appropriate gas property values
must always be entered. Gas properties are only calculated if the gas property values are allowed to be
calculated and the Calculate Gas Mixing solution option is selected (checked). If the Calculate Gas Mixing
solution option is not selected (not checked) during the solution, the entered values will be used.
Heating Value - A data field used to enter the heating value of the gas as measured (calculated) at the node.
Enter a value by typing it into the data field. Ensure the value is expressed in terms of the assigned
dimensional unit.
Ignore Relate Information - A checkbox used to indicate whether the relate information is to be used (turns
on or off the Relate option). Select (check) this option to indicate that the relate information will not be
used.
Model Name - If the node is related to another model, the drop-down list will be enabled. It is used to
specify the name of the model that the node is related to. The list contains the name of all models in the same
directory as the current model. Select the desired model name from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

273

GASWorkS 9.0

GDI
Table Of Contents

Name - Refers to the selected nodes name. This value can be changed by the User on the Hydraulic tab.
Node Name - If the node is related to another model, the drop-down list will be enabled. It is used to specify
the name of the node in the related model that the node is related to. The list contains the name of all nodes
in the related model. Select the desired node name from the list.
Record Number - Refers to the position of the current node record in the node data file. This value is
automatically assigned and cannot be changed by the User.
Relate Style - A drop-down list used to select whether the node is related to another model and if so how
it is related. Select an item from the list.
Specific Gravity - A data field used to enter the specific gravity value of the gas as measured (calculated)
at the node. Enter a value by typing it into the data field. The value is dimensionless. As used by GASWorkS,
the specific gravity represents the weight or density of the gas compared to dry air.
Specific Heat - A data field used to enter the specific heat ratio of the gas as measured (calculated) at the
node. Enter a value by typing it into the data field. The value is dimensionless. As used by GASWorkS, the
specific heat ratio represents the constant pressure specific heat divided by the constant volume specific heat
of the gas mixture.
Viscosity - A data field used to enter the dynamic viscosity of the gas as measured (calculated) at the node.
Enter a value by typing it into the data field. Ensure the value is expressed in terms of the assigned
dimensional unit.

Command Buttons
Calculate Property Values - A command button used to open the Gas Properties calculation screen. Make
any desired changes, calculate the new values, then select the Apply command button on the Gas Properties
calculation screen to return to the Node Data screen. The new values will be entered into the appropriate data
fields on the Node Data screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

274

GASWorkS 9.0

GDI
Table Of Contents

Graphic Tab

Data Items
Display Text Values - A checkbox used to indicate whether the text values associated with the selected node
will be displayed. Select (check) this option if desired
Name - Refers to the selected nodes name. This value can be changed by the User on the Hydraulic tab.
Record Number - Refers to the position of the current node record in the node data file. This value is
automatically assigned and cannot be changed by the User.
Symbol Color - A drop-down list used to select the color used to display the node symbol. To set a Color,
select the Selected Color item from the list, then click in the associated color box. The Color Palette will
be displayed. Select the desired color, then select the OK command button. Or select the Select Symbol Color
command button. Or, select Default from the list.
Symbol Size - A data field used to enter the size of the symbol used to display the nodes location. To set
an individual size, enter a value greater than zero (0) by typing it into the data field. Or, to use the default
size, select (check) the Use Default Size option. The size can be expressed as an absolute value in coordinate
units, or as a value relative to the diagonal distance across the GDI Window, expressed as a percentage.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

275

GASWorkS 9.0

GDI
Table Of Contents

Symbol Style - A drop-down list used to select the style of the symbol used to display the nodes location.
Select an item from the list, or to use the default style, select the Default item from the list.
Use Default Size - A checkbox used to indicate whether the default size for the node symbol will be used.
Select (check) this option if desired.
X Coordinate - A data field used to enter the nodes horizontal location (east-west coordinate). Enter a value
by typing it into the data field. Ensure that the value is expressed in terms of the assigned dimensional unit.
Y Coordinate - A data field used to enter the nodes vertical location (north-south coordinate). Enter a value
by typing it into the data field. Ensure that the value is expressed in terms of the assigned dimensional unit.

Command Buttons
Select Symbol Color - A command button used to set the node display color. When selected, the Color
Palette will be displayed. Select the desired color, then select the OK command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

276

GASWorkS 9.0

GDI
Table Of Contents

Calculated Tab
This section of the Node Data screen displays various calculated values associated with the selected node.
The calculated values cannot be changed by the User. If the model data has been changed since the most
recent solution, some of the calculated data values may not be displayed. The values which may appear in
this section are described in the following table.

Calculated Values
Atmospheric Pressure - Displays the calculated atmospheric pressure value based on the node's elevation.
The units for this item are set the same as the Base Pressure dimensional units.
Base Load - If the load value was Known, this item displays the base load times the design factor if the
Adjust Base Load By Design Factor option is selected (checked). If the load value is Unknown, this value
represents the value calculated by the solution calculation.
External Load - Displays the external load times the design factor (if the Adjust External Load By Design
Factor option is selected). For example, the load for customers where the Adjust Load By Design Factor
option is selected (checked).
External Load (Fixed) - Displays the portion of the external load which cannot be adjusted by the design
factor. For example, the load for customers where the Adjust Load By Design Factor option is not selected
(not checked).

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

277

GASWorkS 9.0

GDI
Table Of Contents

Name - Refers to the selected nodes name. This value can be changed by the User on the Hydraulic tab.
Pressure (Absolute) - Displays the calculated (or entered) absolute pressure value.
Pressure (Gauge) - Displays the calculated (or entered) gauge pressure value.
Record Number - Refers to the position of the current node record in the node data file. This value is
automatically assigned and cannot be changed by the User.
Total Energy Load - Displays the total (volumetric) load value times the heating value.
Total Load - Displays the total of the (adjusted) base and external load values.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.
Close & Solve - A command button used to close the screen, save any changes, and execute the Solution
routine.
Print - A command button used to print the data associated with the current node. When selected, the Print
Control screen will be displayed. Make any desired changes to the printer settings, then select the Print
command button.

Notes & Considerations


! The load for a node is comprised of two separate values, the base load and the external load. The base load
represents a load value that can be directly input by the User, or calculated during the Solution routine. The
external load represents the load associated with the customers attached to the pipe associated with the node.
The external load cannot be changed by the User. The external load item is so named, because the value is
often derived by means of data extracted from an external database. The external load value has two portions,
a portion that can be adjusted by the design factor and a portion which cannot be adjusted by the design
factor.
! The Node Data screen can be accessed through the various command methods, or by placing the cursor
near the desired node and left-clicking while holding down the Shift key.
! Refer to the Miscellaneous section of this Manual for information and instructions on using the Relate
feature.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

278

GASWorkS 9.0

GDI
Table Of Contents

Pipe Data Screen


In the GDI, the pipe data is accessed using the Pipe Data screen. The screen is displayed when the Edit Pipe
Data command is selected, or the screen may be displayed when a new pipe is created using one of the
Graphic Construction or Graphic Edit commands. The features associated with the screen are described as
follows.

Hydraulic Tab
The contents of the Hydraulic tab will vary depending on the selected Element Type. The various content
items are described as follows.

Data Items
Allow Size Calculation - A checkbox used to indicate whether the pipe size can be calculated during the
Solution routine, when the Calculate Pipe Sizes (Optimize) solution option is selected (checked). Select
(check) this option if desired. This item is only displayed for Pipe type elements.
Coefficient - A data field used to enter the equation coefficient for a Well type element when the wells
Size/Type is set to Unique. Enter a value by typing it into the data field. The value is dimensionless. This
item is only displayed for Well type elements.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

279

GASWorkS 9.0

GDI
Table Of Contents

Control Style - A drop-down list used to select whether the set pressure for a compressor is to be applied
to the downstream (discharge) node or the upstream (suction) node. Select an item from the list. This item
is only displayed for Compressor type elements.
Drop Units - A drop-down list used to select the pressure drop dimensional units to be used for the pipe
segment. Select an item from the list. This item is displayed for all element types.
Efficiency - A data field used to enter the efficiency value for Compressor, Fitting, and Pipe type elements.
Enter a value by typing it into the data field. Ensure the value is expressed in terms of the assigned
dimensional unit. Initially, the efficiency is set to the default efficiency value. For Compressor type elements,
this item refers to the mechanical efficiency of the compressor. This item is only displayed for Compressor,
Fitting, and Pipe type elements.
Element Type - A drop-down list used to select the hydraulic element type for the segment. Select an item
from the list. The content of the Data and Calculated Values sections of this screen will vary depending on
the selected value. This value is initially set to a Pipe type element. This item is displayed for all element
types.
Equation - A drop-down list used to select the flow equation to be used with Fitting and Pipe type elements.
Select an equation from the list. This item is only displayed for Fitting and Pipe type elements.
Exponent - A data field used to enter the equation exponent for a Well type element when the wells
Size/Type is set to Unique. Enter a value by typing it into the data field. The value is dimensionless. This
item is only displayed for Well type elements.
Flow Units - A drop-down list used to select the flow dimensional units to be used for the pipe segment.
Select an item from the list. This item is displayed for all element types.
Length - A data field used to enter the hydraulic length for Pipe type elements. Enter a value by typing it into
the data field. Ensure the value is expressed in terms of the selected dimensional unit. Initially, the length
is set to the pipe's "graphic" length. This item is only displayed for Pipe type elements.
Percent Open - A data field used to enter the opening position for a Valve type element. Enter a value by
typing it into the data field. Ensure the value is expressed as a percentage, with zero (0) being completely
closed and one hundred (100) being completely open. This item is only displayed for Valve type elements.
Record Number - Refers to the position of the current element type record in the pipe data file. This value
is automatically assigned and cannot be changed by the User.
Set Pressure - A data field used to enter the set pressure value for Compressor and Regulator type elements.
Enter a value by typing it into the data field. Ensure the value is expressed in terms of the selected
dimensional unit. This item is only displayed for Compressor and Regulator type elements.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

280

GASWorkS 9.0

GDI
Table Of Contents

Size/Type - Either a drop-down list or a data field used to specify the size and type for the pipe segment. The
meaning of this item varies depending on the selected Element Type. The various meanings are listed in the
following table. Initially, this item is set to the default Size/Type value. Either select an item from the list
or enter a value by typing it into the data field. This item is displayed for all element types.
Element Type

Size/Type Meaning

Compressor

Represents the Size/Type Code for the compressor. Select the desired
Size/Type Code from the list. The content of the list represents the Size/Type
Codes found in the currently selected Compressor Property Table.

Fitting

Represents the Size/Type Code for the fitting. Select the desired Size/Type
Code from the list. The content of the list represents the Size/Type Codes
found in the currently selected Fittings Property Table.

Pipe

Represents the Size/Type Code or the inside diameter value for the pipe.
Either select the desired Size/Type Code from the list, or enter the inside
diameter value by typing it into the data field. The content of the list
represents the Size/Type Codes found in the currently selected Pipe Property
Table.

Regulator

Represents the Size/Type Code for the regulator. Select the desired
Size/Type Code from the list. The content of the list represents the Size/Type
Codes found in the currently selected Regulator Property Table.

Valve

Represents the Size/Type Code for the valve. Select the desired Size/Type
Code from the list. The content of the list represents the Size/Type Codes
found in the currently assigned Valve Property Table.

Well

Represents the Size/Type Code for the well. Select the desired Size/Type
Code from the list. The content of the list represents the Size/Type Codes
found in the currently assigned Well Property Table. If the Unique item is
selected, the required well parameters may be manually entered in the
appropriate data fields.

Sizing Group - A drop-down list used to select the sizing group to associate the current pipe segment with.
Several sizes can be assigned to a group - for example, plastic sizes could be assigned to one group and steel
to another. Each pipe segment can be assigned to a specific group. When using the Pipe Sizing routine, only
pipe sizes associated with the assigned group will be considered during the pipe selection. Select an item
from the list. This item is only displayed for Pipe type elements.
Status - A pair of option buttons used to specify whether the pipe segment is turned on or off. Select
the desired option. This item is displayed for all element types.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

281

GASWorkS 9.0

GDI
Table Of Contents

Fitting Data Tab


The Fitting Data tab is only enabled when the Element Type selected is Pipe.

Data Items
Attached Fittings - A panel used to display the fittings that are currently attached to the pipe segment.
Double-click on an item to remove it from the list.
Available Fittings - A drop-down list used to select the fittings that are available for attachment to the pipe
segment. The content of the list represents the Size/Type Codes found in the currently selected Fittings
Property Table. Select an item from the list. When a value is selected, it is added to the Attached Fittings list.

Calculated Values
Total Equivalent Length - Displays the sum or total of the equivalent length values in terms of the current
inside diameter dimensional unit for the items listed in the Attached Fittings list. The value cannot be
changed by the User.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

282

GASWorkS 9.0

GDI
Table Of Contents

Command Buttons
Clear Attached Fittings List - A command button used to delete all of items in the Attached Fittings list.
Recalculate Length - A command button used to recalculate the Total Equivalent Length value.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

283

GASWorkS 9.0

GDI
Table Of Contents

Graphic Tab

Data Items
Display Text Values - A checkbox used to indicate whether the text values for the selected pipe segment
will be displayed. Select (check) this option if desired.
Line Color - A drop-down list used to select the color of the line used to represent the pipe segment. To set
a Color, select the Selected Color item from the list, then select the Select Line Color command button.
The Color Palette will be displayed. Select the desired color, then select the OK command button. Or, select
Default item from the list.
Line Style - A drop-down list used to select the style of the line used to represent the pipe segment. Select
an item from the list.
Line Width - A drop-down list used to select the width of the line used to represent the pipe segment. Select
an item from the list. The size is expressed in screen pixels.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

284

GASWorkS 9.0

GDI
Table Of Contents

Command Buttons
Select Line Color - A command button used to set the pipe segment display color. When selected, the Color
Palette will be displayed. Select the desired color, then select the OK command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

285

GASWorkS 9.0

GDI
Table Of Contents

Attribute Tab
The values contained in the Attribute Data list will vary depending on the hydraulic element type selected,
and on whether an attribute file is attached. The various contents of the list are described as follows.

Data Items
Attribute File Data... - If a linked or external database is attached, these items will display the values
contained in the linked database record. If a linked database is attached, the values can be changed by the
User. If the attached database is of another type, the values are view-only and cannot be changed by the User.
To edit a value, click in the associated data cell, then either type the desired value or select an item from the
list. To save the change, click in another data cell or press the Enter key.
Facility Type - A drop-down list used to select the facility type to be associated with the pipe segment. To
set a value, click in the associated data cell, then select an item from the list.
Link To The Attribute File - If an external database is attached, this item indicates whether the pipe feature
should be linked to the external database. If selected (checked), the pipe will be linked by matching the Link
ID value. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

286

GASWorkS 9.0

GDI
Table Of Contents

Calculated Values
Customer Count - Displays the number of customers attached to the pipe segment. This item is
automatically calculated, however the calculated value may be overridden by the User. To enter a new value
click in the associated data cell, respond appropriately to the prompt, enter the new number by typing it in
the data cell, then press the Enter key to save the change. Note - Changing this item can corrupt the automatic
external load accounting. Particular care should be taken when changing this value.
Link ID Number - Displays the identification number used to link to an external database. When a linked
database is attached, the number is automatically assigned and cannot be changed by the User. When any
other type of external database is attached, the number is assigned by the User, and generally represents a
value that is unique in the database. When no external database is attached, the number can be used to
maintain any User desired alphanumeric value. The value can be a combination of up to twenty (20)
alpha-numeric characters.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

287

GASWorkS 9.0

GDI
Table Of Contents

Calculated Tab
This section of the Pipe Data screen displays various calculated values associated with the pipe segment. The
calculated values cannot be changed by the User. If the model has been changed since the last solution, some
items may not be displayed. The values which may appear in this section are described as follows.

Calculated Values
General From Node - Displays the name of the pipe segment's From Node.
Internal ID Number - Displays the pipe segment's unique identification number. This value is set
automatically and cannot be changed by the User.
Record Number - Refers to the position of the current pipe record in the pipe data file.
To Node - Displays the name of the pipe segment's To Node.
Hydraulic Data Average Compressibility - Displays the calculated compressibility factor for the pipe segment. The
value is based on the average pressure and temperature values.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

288

GASWorkS 9.0

GDI
Table Of Contents

Average Pressure - Displays the average pressure along the pipe segment.
Average Temperature - Displays the average temperature along the pipe segment.
Flow Rate - Displays the calculated flow rate for the pipe segment. If this value is positive, it
indicates that the flow direction is from the From Node to the To Node. If the value is negative, it
indicates that the flow direction is from the To Node to the From Node.
From Pressure - Displays the calculated or entered pressure value for the pipe segments From
Node.
Pressure Drop - Displays the linear pressure drop for the pipe segment (the From Pressure minus
the To Pressure). Note that when elevation differences are present along the pipe segment, it is
possible for the downstream pressure to be larger than the upstream pressure. If this value is positive,
it indicates that the From Node pressure is larger than the To Node pressure. If the value is negative,
it indicates that the To Node pressure is greater than the From Node pressure.
To Pressure - Displays the calculated or entered pressure value for the pipe segments's To Node.
Other Data - Compressor Type Elements
Compression Ratio - Displays the calculated compression ratio for the compressor. The value is
calculated using the calculated inlet and outlet pressures for the compressor.
Estimated Fuel Usage - Displays the estimated fuel used by the compressor. The value is calculated
using the fuel usage rate and the estimated power. This item is not displayed if the fuel usage rate
is zero (0) in the current Compressor Property Table for the assigned Size/Type Code.
Estimated Outlet Temperature - Displays the estimated temperature of the gas leaving the
compressor. The value is calculated using the compression ratio for the compressor and the specific
heat ratio of the upstream node.
Estimated Power - Displays the estimated power requirements of the compressor. The value is
calculated using the inlet and outlet pressures, the flow rate, the specified efficiency, and the power
equation associated with the compressor.
Flow Mode - Displays whether the compressor is operating in compression mode or free flowing.
If the inlet pressure to the compressor is greater than the set pressure, the solution will automatically
place the compressor in free flow.
Fuel Usage Rate - Displays the fuel usage rate extracted from the current Compressor Property
Table for the assigned compressor Size/Type Code.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

289

GASWorkS 9.0

GDI
Table Of Contents

Inlet Temperature - Displays the temperature of the gas entering the compressor.
Rated Power - Displays the rated power extracted from the current Compressor Property Table for
the assigned compressor Size/Type Code.
Other Data - Fitting Type Elements
Equivalent Diameter - Displays the equivalent diameter value for the fitting. The value is extracted
from the current Fittings Property Table for the assigned Size/Type Code.
Equivalent Length - Displays the equivalent length value for the fitting. The value is extracted from
the current Fittings Property Table for the assigned Size/Type Code.
Other Data - Pipe Type Elements
Hoop Stress - Displays the calculated hoop stress value for the pipe segment. The value is based on
the larger of the From or To Pressures, and the outside diameter and wall thickness values found in
the current Pipe Property Table. This item is not displayed if the Size/Type Code is not found in the
current Pipe Property Table.
Inside Diameter - Displays the pipe's inside diameter value. If the Size/Type value represents a
code, this value represents the inside diameter value extracted from the current Pipe Property Table.
Otherwise this item represents the interpreted numeric value of the Size/Type alpha-numeric value.
Line Volume - Displays the volume of gas contained in the pipe segment. The value is calculated
using the average pressure value, the inside diameter value, and the length of the pipe segment.
Percent SMYS - Displays the ratio of the hoop stress value to the specified minimum yield strength
(SMYS) value. The value is based on the SMYS value found in the current Pipe Property Table. This
item is not displayed if the SMYS value is zero (0) in the current Pipe Property Table for the
assigned Size/Type Code, or if the Size/Type Code is not found in the current Pipe Property Table.
Roughness - Displays the inside pipe wall roughness for the pipe segment. The value is extracted
from the current Pipe Property Table for the assigned Size/Type Code.
Total Efficiency - Displays the efficiency value used in the solution calculation. See the following
Notes & Considerations section for information on how the total efficiency is calculated.
Velocity - Displays the maximum velocity of the gas flow in the pipe segment. The value is
calculated using the lower of the segments end pressures, the volumetric flow rate, and the inside
diameter value for the pipe segment.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

290

GASWorkS 9.0

GDI
Table Of Contents

Other Data - Regulator Type Elements


Coefficient Ratio - Displays the ratio of the estimated valve coefficient to the rated valve
coefficient. Generally, the ratio should be between 0.2 and 0.8 for proper sizing. A value less than
0.2 indicates that the regulator may be oversized. A value greater than 0.8 indicates that the regulator
may be undersized.
Estimated Coefficient - Displays the estimated valve coefficient for the regulator. The value is
calculated based on the flow rate, pressure differential, and various values found in the current
Regulator Property Table for the assigned Size/Type Code.
Estimated Outlet Temperature - Displays the estimated temperature of the gas leaving the regulator.
The value is calculated using the pressure drop across the regulator.
Flow Mode - Displays whether the regulator is operating in control mode or an upset mode.
During the solution calculation, the operating mode of the regulator can be automatically changed
depending on the inlet and outlet pressure values.
Inlet Temperature - Displays the temperature of the gas entering the regulator.
Minimum Differential - Displays the minimum required differential pressure value extracted from
the current Regulator Property Table for the assigned Size/Type Code.
Rated Coefficient - Displays the rated valve coefficient value extracted from the current Regulator
Property Table for the assigned Size/Type Code.
Set Pressure - Displays the set pressure for the regulator.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.
Close & Solve - A command button used to close the screen, save any changes, and execute the Solution
routine.
Print - A command button used to print the model data associated with the current pipe segment. When
selected, the Print Control screen will be displayed. Make any desired changes to the printer settings, then
select the Print command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

291

GASWorkS 9.0

GDI
Table Of Contents

View From Node Data - A command button used to display the Node Data screen for the From Node
associated with the pipe segment. When the Node Data screen is closed, the Pipe Data screen will be
redisplayed.
View To Node Data - A command button used to display the Node Data screen for the To Node associated
with the pipe segment. When the Node Data screen is closed, the Pipe Data screen will be redisplayed.

Notes & Considerations


! The Pipe Data screen can be accessed through the various command methods, or by placing the cursor near
the desired pipe segment and left-clicking.
! For pipe type elements the size/type data item can represent one of two values. It can represent a value that
matches a Size/Type Code found in the current Pipe Property Table. Or, it can represent the actual inside
diameter value of the pipe. If the value represents a matching code, the inside diameter value is extracted
from the current Pipe Property Table when it is needed. If the value does not represent a matching value, it
is converted to a numeric value when the inside diameter is required.
! The displayed line style, width, and color can be assigned by one of several methods. By the default data
value, by manual selection, by a value assigned in the current Pipe Property Table, or by a value assigned
in the Facilities list.
! During the solution calculation a total efficiency is computed for pipe type elements and used in the
hydraulic calculation. The total efficiency value is computed as the product of the efficiency assigned
directly to the pipe segment, and the efficiency value found in the current Pipe Property Table for the
matching Size/Type Code. If no matching record is found in the current Pipe Property Table, only the
assigned value is used.
! Fittings may be attached to a pipe type element. The total equivalent length of the attached fittings is added
to the hydraulic length of the pipe segment during the solution calculation. The equivalent length value is
based on the inside diameter and equation values. In most cases, attachment of fittings has negligible affect
on the hydraulic calculation results, however in cases where many fittings are encountered in a short distance
(like meter sets, regulator sets, or compressor yard piping) it is best to include the affect of the fittings in the
hydraulic calculations by attaching the appropriate fittings to the associated pipe segment.
! If an external database is attached, the Link ID is used to make a match between the selected data feature
and the corresponding record in the database. The first record in the database with a matching Link ID value,
is displayed in the Attribute Data list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

292

GASWorkS 9.0

GDI
Table Of Contents

Plot Settings Screen


When the Plot command is selected, the Plot Settings screen will be displayed to allow the User to set the
various plot control options. The features associated with the screen are described as follows.

Page Layout Tab

Data Items
Border Width - A data field used to enter the width of the line used to draw the border. Enter a value by
typing it into the data field. Ensure the value is expressed in terms of the assigned dimensional unit. This item
is only enabled when the Include Border And Title option is selected (checked).
Bottom Margin - A data field used to enter the distance from the bottom of the page to the bottom of the
plotted image. Enter a value by typing it into the data field. Ensure the value is expressed in terms of the
assigned dimensional unit.
Include Border And Title - A checkbox used to indicate whether a border and a title will be included with
the plotted image. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

293

GASWorkS 9.0

GDI
Table Of Contents

Landscape Orientation - A checkbox used to indicate whether the image will be plotted in a landscape
orientation, with relation to the current paper size. Select (check) this option if desired.
Left Margin - A data field used to enter the distance from the left side of the page to the left side of the
plotted image. Enter a value by typing it into the data field. Ensure the value is expressed in terms of the
assigned dimensional unit.
Printer - A drop-down list used to select the printer or plotter to be used. To change the selection, select a
printer from the list or select the Printer Setup command button.
Right Margin - A data field used to enter the distance from the right side of the page to the right side of the
plotted image. Enter a value by typing it into the data field. Ensure the value is expressed in terms of the
assigned dimensional unit.
Top Margin - A data field used to enter the distance from the top of the page to the top of the plotted image.
Enter a value by typing it into the data field. Ensure the value is expressed in terms of the assigned
dimensional unit.

Command Buttons
Printer Setup - A command button used to open the Print Setup screen. The contents of the screen will vary
depending on the selected printer and the configuration of the computer system. Make any desired setting
changes, then select the OK command to return to the Plot Settings screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

294

GASWorkS 9.0

GDI
Table Of Contents

Settings Tab

Data Items
Customer Size - A data field used to enter the base size of the symbols used to plot the customers. Enter a
value by typing it into the data field. Ensure the value is expressed in terms of the assigned dimensional unit.
Font Name - A data field used to display the name of the font to be used when plotting the image. To change
the font name, click in the data field. The Font screen will be displayed. Select the desired settings, then
select the OK command button.
Font Size - A data field used to display the size of the font to be used when plotting the image. The change
the font size, click in the data field. The Font screen will be displayed. Select the desired settings, then select
the OK command button. The size is expressed in printer points. One printer point is approximately equal
to 1/72 of an inch.
Include Background Image -A checkbox used to indicate whether any attached background images will
be included with the plotted image. Select (check) this option if desired.
Line Width - A data field used to enter the base width of the lines used to plot the pipes. Enter a value by
typing it into the data field. Ensure the value is expressed in terms of the assigned dimensional unit.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

295

GASWorkS 9.0

GDI
Table Of Contents

Node Size - A data field used to enter the base size of the symbols used to plot the nodes. Enter a value by
typing it into the data field. Ensure the value is expressed in terms of the assigned dimensional unit.
Number Of Copies - A drop-down list used to select the number of copies to be printed. Select a value from
the list.
Plot Data Values - A checkbox used to indicate whether the text values for the selected node, pipe, and
customer data values will be included with the plotted image. Select (check) this option if desired.
Plot In Black And White - A checkbox used to indicate whether the image will be plotted in black and
white, otherwise the image will be printed using the currently displayed screen colors. When a bitmap style
background image is attached, the image may be printed in grayscale (not true black and white). Select
(check) this option if desired.
Scale - A drop-down list used to select the scale to plot the image at. Select a value from the list. The scale
value is expressed in terms of the currently selected printer and coordinate dimensional unit.
Use Bold Font - A checkbox used to indicate whether all the text values will be printed using a bold (heavy)
font style. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

296

GASWorkS 9.0

GDI
Table Of Contents

Style Tab

Data Items
Plot Current Display - An option button used to specify whether to plot the contents of the image currently
displayed in the GDI Window. Select this option if desired.
Plot Full Extents Of Model & Background Image - An option button used to specify whether to plot the
full contents of the model and the background image. Select this option if desired.
Plot A Saved Plot Window - An option button used to specify whether to plot the contents of a previously
saved plot window. Select this option if desired. If selected, then select the desired plot window from the
associated Window Name list.
Plot A User Selected View - An option button used to specify whether to plot the contents of a previously
saved view. Select this option if desired. If selected, then select the desired view from the associated View
Name list.
Plot A User Selected Window - An option button used to specify whether to plot the view as defined by a
User selected window. Select this option if desired. When selected, during plotting, a prompt will appear to
allow the User to specify the plot window size. Use the mouse to select the corners of the plot window. A
dashed box will be displayed to represent the selected plot window's size.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

297

GASWorkS 9.0

GDI
Table Of Contents

Command Buttons
Cancel - A command button used to cancel the Plot routine. Depending on the status of the current plot
activities, the Plot routine may not be terminated immediately.
Plot - A command button used to execute the plot process.

Notes & Considerations


! Many printers and plotters have an internally set margin around the edges of the page. If the current margin
values are less than these preset values, a warning message will appear when trying to plot. If this occurs,
reset the margins to appropriate values.
! The Windows System Printer is used to plot the image. The image is scaled as specified and centered
within the margins of the currently selected page size and page orientation. The page size may be changed
by selecting the Setup command button.
! The line width, node size, and customer size values are used as the base value for plotting the associated
features. What this means, is that this size is used to plot all features where their size value is set to the
default size value. Features with other size values will be plotted proportional to the base value. For example,
if the default line width is 2, all pipes with a display width set at 2 or to default will be plotted at the
specified line width. If a pipe feature has a display width set at 1, it will be plotted at 1 divided by 2 (or 0.5)
times smaller than the specified line width. And if a pipe feature has a display width set at 3, it will be plotted
at 3 divided by 2 (or 1.5) times larger than the specified line width.
! An image can be plotted to PDF format if a third-party PDF printer is installed. To plot to a PDF printer,
select the printer from the printer list, select the Plot command button, enter a Filename when prompted. The
contents will be saved to the selected Filename.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

298

GASWorkS 9.0

GDI
Table Of Contents

Profile Options Screen


When the Show Route Profile command is selected, the Profile Options screen will be displayed. The screen
allows the various options associated with creating and displaying the route profile to be set by the User. The
features associated with the screen are described as follows.

Data Items
Items To Include - A panel used to display a list of the data items available for inclusion in the profile.
Select (check) the desired items.
Selection Style - A group of option buttons used to specify how the route will be identified. Select the
desired option.
Individual Graphical Selection - Allows the User to individually select the pipe segments to
include in the route profile using the cursor.
Trace Downstream - Allows the User to select a node location to start the trace at, all pipe segments
along the major flow path downstream of the selected location are included in the route.
Trace Upstream - Allows the User to select a node location to start the trace at, all pipe segments
along the major flow path upstream of the selected location are included in the route.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

299

GASWorkS 9.0

GDI
Table Of Contents

Command Buttons
Cancel - A command button used to close the screen without creating the route profile.
Create Profile - A command button used to close the screen, and create and display the route profile.
Depending on the route selection style, various prompts will appear to create the profile route.

Notes & Considerations


! When the Combined Profile (Combines All Selected Items) option is selected, one of the display tabs on
the Profile Display screen will contain a single profile with all of the selected data item values shown for the
selected route profile.
! When the pipe segments are displayed in the route profile, they are oriented so that the flow is from left
to right. That is, the pipe segments are oriented so that the upstream end is on the left and the downstream
end is on the right. When manually selecting individual pipes for a route, it is generally best to start by
selecting the most upstream segment then sequentially select segments working downstream from that
upstream segment. The pipes are displayed in the order that they are selected. If a pipe is inadvertently
selected, it can be unselected by clicking on it a second time. Only the highlighted pipes will be included in
the route profile.
! When using one of the trace methods to specify the route profile, if the highlight color is set to anything
other than Default, the selected pipes will be displayed and a prompt will appear before the route profile
is created. If the prompt appears, select the appropriate response to continue.
! The horizontal scale of the route profile represents the hydraulic distance along the route.
! The vertical scale of the profile is automatically computed based on the value range of the associated data
item.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

300

GASWorkS 9.0

GDI
Table Of Contents

Scale Factor Calculation Screen


When a BMP file is selected as a background image, and the Calculate Scale Factor command button on the
Background Image Settings screen is selected, the Scale Factor calculation screen will be displayed. The
features associated with the screen are described as follows.

Data Items
Image Resolution - A data field used to enter the resolution of the image contained in the BMP file.
Generally, the resolution is expressed in the number of dots (pixels) per inch. Enter a value by typing it into
the data field. Ensure that the value is expressed in terms of the selected dimensional unit.
Image Scale - A data field used to enter the scale of the image. Enter a value by typing it into the data field.
Ensure that the value is expressed in terms of the selected dimensional unit.

Calculated Items
Scale Factor - Displays the calculated scale factor, based on the image resolution and scale values. The item
is automatically calculated and cannot be changed by the User.

Command Buttons
Apply - A command button used to close the calculation screen and apply the calculated Scale Factor to the
Background Image Settings screen.
Close - A command button used to close the calculation screen without applying the calculated Scale Factor.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

301

GASWorkS 9.0

GDI
Table Of Contents

Notes & Considerations


! The bitmap Scale Factor (Coordinate To Pixel Ratio) establishes the "scale" for bitmap style images.
Bitmap images contain raster style images. Raster images are made up of small "dots" called pixels. The scale
tells the GDI how many coordinate units are represented by one pixel in the file - the width of the pixel in
coordinate units. For example, the number of Feet Per Pixel. To determine this value, divide the original
drawing or map scale by the image resolution in dots per inch (dots per centimeter). For example, the
Coordinate To Pixel Ratio for a 1 Inch equals 2000 Feet map scanned at 400 dots per inch would be: 2000
400 = 5 Feet/pixel.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

302

GASWorkS 9.0

GDI
Table Of Contents

Selected Route Profile Screen


The results of the Show Route Profile command are displayed on the Selected Route Profile screen. The
features associated with the screen are described as follows.

Command Buttons & Icons


Close - A command button used to close the screen.
Copy To Clipboard - An icon used to copy the contents of the screen to the Windows clipboard.
A message will appear when the data has been copied, select the OK command button to clear the
message. Once copied the contents may be pasted to another application.
Delete Pipe - An icon used to delete a User selected pipe segment from the route profile.

Maximize Window Size - An icon used to cause the screens window size to be increased to fill
the GASWorkS display screen.

Oops (Undelete) - An icon used to restore (undelete) a recently deleted pipe segment.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

303

GASWorkS 9.0

GDI
Table Of Contents

Print - An icon used to print the contents of the screen. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.
Reset Window Size - An icon used to cause the screens window size to be normalized or
reduced to its standard size.

Swap Segment - An icon used to re-orient (swap) the display order of the currently selected pipe
segments in the route profile.

Notes & Considerations


! Pipe segments are displayed in the route profile so that the flow direction is from left to right. That is, the
pipe segments are oriented so that the upstream end is on the left and the downstream end is on the right. The
orientation can be changed using the Swap Segment command button.
! Depending on the selected items, some tabs may not be enabled.
! The horizontal scale of the route profile represents the hydraulic distance along the route.
! The vertical scale of the route profile is automatically computed based on the value range of the associated
data items.
! To display pipe information about a profile segment, click midway on the desired profile segment (between
vertical lines), with the cursor.
! To display node information about a profile segment, click near the vertical line representing the desired
node location, with the cursor.
! The Profile Options Screen Description in the GDI section of this Manual provides additional information
about the Show Route Profile command and the profile creation process.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

304

GASWorkS 9.0

GDI
Table Of Contents

Set Display Colors Screen


The Set Display Colors screen is displayed by either selecting the Set Colors command, or clicking the Set
Colors command button located on the Display Controls Toolbar. The screen allows the display color of the
basic GDI features to be set by the User. Using this screen, colors may be set by three methods - by overall
default colors, by query selection of a specific data value, or by range assignment. The features associated
with the screen are described as follows.

Data Items
Color By Query - This section can be used to apply a highlight color to a selected set of customer, node, or
pipe features - based on a User specified selection criteria.
Color - A color box used to specify the color used to display the features found by the query
selection. To set a Color, click in the associated color box. The Color Palette will be displayed.
Select the desired color, then select the OK command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

305

GASWorkS 9.0

GDI
Table Of Contents

Color By Range - This section can be used to color code customer, node, and pipe features based on a User
specified range criteria. The section consists of a group of color boxes and range fields. Each color box is
associated with the adjacent value range. The range values may be manually set by the User or automatically
set using either the Allocate or Calculate method.
Color Boxes - A group of color boxes used to specify which colors are to be used to display and set
the color associated with the adjacent range. To set a Color, click in the associated color box. The
Color Palette will be displayed. Select the desired color, then select the OK command button.
From - A group of display boxes which are used to display the "From" value of the associated range.
The "To" value from the preceding range is automatically set as the "From" value for the following
range. The "From" values cannot be changed by the User.
Item - A drop-down list used to select which data item to associate with the specified ranges. Select
an item from the list.
To - A group of data fields used to display and edit the "To" value of the associated range. The "To"
values may be set by two methods. One is to automatically set the values using the Allocate and
Calculate methods. The other is to manually set the value by entering a value by typing it into the
data field.
Units - A drop-down list used to select the dimensional units to use during the Allocate or Calculate
methods. The Units list is only displayed when an appropriate item is selected from the Item list.
Select an item from the list.
Default Colors - This section can be used to set the default colors for the background display area, the
customer, node, and pipe features, and the symbols for non-pipe type elements.
Background - A color box used to specify the color for the background of the image display area
(work area). To set a Color, click in the associated color box. The Color Palette will be displayed.
Select the desired color, then select the OK command button.
Customer - A color box used to specify the default color used to display the customer features. To
set a Color, click in the associated color box. The Color Palette will be displayed. Select the desired
color, then select the OK command button.
Node - A color box used to specify the default color used to display the node features. To set a
Color, click in the associated color box. The Color Palette will be displayed. Select the desired color,
then select the OK command button.
Pipe - A color box used to specify the default color used to display the pipe features. To set a Color,
click in the associated color box. The Color Palette will be displayed. Select the desired color, then
select the OK command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

306

GASWorkS 9.0

GDI
Table Of Contents

Symbols - A color box used to specify the default color used to display the symbols for non-pipe
type elements. To set a Color, click in the associated color box. The Color Palette will be displayed.
Select the desired color, then select the OK command button.

Command Buttons
Allocate - A command button used to automatically establish the range values using the allocate method.
The Allocate method attempts to create ranges with approximately the same number of features in each range
group. The Allocate method does not always use all of the range colors.
Apply Default Colors - A command button used to apply the current default color settings to the displayed
image.
Apply Query Colors - A command button used to apply the current color to the selected features in the
query selection.
Apply Range Colors - A command button used to apply the color range values to the associated features.
Calculate - A command button used to automatically establish the range values using the calculate method.
The Calculate method creates eight evenly "spaced" ranges based on the overall value range of the selected
item.
Close - A command button used to close the screen.
Define Query Specification - A command button used to open the Query Specifications screen and define
the query specification. Using the Query Specifications screen, a selection set may be defined by specifying
which features to assign the specified color to. Enter and select the desired specification settings, then select
the Perform Query command button to create the selection set. See the Query Specifications Screen
Description in the Data Screens section of this Manual for a complete description of the screen.
Save Feature Colors - A command button used to save the currently displayed colors. Setting the feature
colors using the Display Color Legend command only temporarily applies those colors to the current display.
To "permanently" save the colors, select the Save Feature Colors command button.

Notes & Considerations


! Features are considered to be within a range if the value associated with the feature is greater than the
"From" value, and less than or equal to the "To" value for the range.
! After color coding, use the various Reset commands to reset the feature colors to the values currently
saved in the model data files.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

307

GASWorkS 9.0

GDI
Table Of Contents

Specify Shift Details Screen


The Shift Model Coordinates command allows a model to be graphically shifted, scaled, and rotated. The
command is controlled using the Specify Shift Details screen. The features associated with the screen are
described as follows.

Data Items
Rotation Angle - A data field used to enter the angle to rotate the image before it has been shifted. The
rotation angle is measured as degrees clockwise from 12 oclock (North). In terms of angle measurement,
North is at the top of the display. Enter a value by typing it into the data field.
Rotation Point X - A data field used to enter the east-west location of the pivot point for rotating the image.
The value is expressed in terms of the current GDI coordinate units. Enter a value by typing it into the data
field.
Rotation Point Y - A data field used to enter the north-south location of the pivot point for rotating the
image. The value is expressed in terms of the current GDI coordinate units. Enter a value by typing it into
the data field.
Scale - A data field used to enter the amount to increase or decrease all length and coordinate values by. The
value is expressed as a multiplying factor, not as a percentage. Values less than one (1) will decrease the
image size. Values greater than one (1) will increase the image size. Enter a value by typing it into the data
field.
Update Pipe Lengths - A checkbox used to indicate whether the length value of all pipe type elements will
be recalculated based on the new X and Y coordinate values of the nodes and vertices. Select (check) this
option if desired. If the original length values were entered manually and the original values are to be
maintained, do not select (do not check) this option.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

308

GASWorkS 9.0

GDI
Table Of Contents

X Shift - A data field used to enter the amount to move the image in the east-west direction. The value is
expressed in terms of the current GDI coordinate units. Positive values move the image east. Negative values
move the image west. Enter a value by typing it into the data field.
Y Shift - A data field used to enter the amount to move the image in the north-south direction. The value is
expressed in terms of the current GDI coordinate units. Positive values move the image north. Negative
values move the image south. Enter a value by typing it into the data field.

Command Buttons
Close - A command button used to close the screen.
Shift - A command button used to calculate the new coordinates. A message will appear when the
calculations are complete.

Notes & Considerations


! The new coordinates are calculated in the following order. First, the image is rotated about the specified
rotation location. Second, the scale factor is then applied. Last, the image is shifted by the specified amounts.
! This routine can be used to move models that were imported from another application where negative or
large coordinate values were supported. Or, where a different scale factor was used.
! This routine can be used to recalculate corrupt pipe length values by setting all of the shift specification
values to zero (0), except the scale factor. Set the scale to one (1), and ensure that the Update Pipe Lengths
item is selected (checked). When the shift is performed, the model will not move, however all of the length
values will be recalculated based on the current node and vertex coordinate values.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

309

GASWorkS 9.0

GDI
Table Of Contents

Text Display Options Screen


The Text Display Options screen will be displayed when the Set Text Options command is selected, or the
Set Text Options icon is selected from the Display Controls toolbar. The screen allows the text display colors
and options to be set by the User. The features associated with the screen are described as follows.

Data Items
Bold Font - A checkbox used to indicate whether all the text values will be displayed using a bold (heavy)
font style. Select (check) this option if desired.
Color Boxes - A group of color boxes used to specify the color used to display the associated data items. To
set a Color, click in the associated color box. The Color Palette will be displayed. Select the desired color,
then select the OK command button.
Customer Items - A checkbox used to indicate whether the Customer Items list will be enabled. Select
(check) this option if desired. The list displays Customer Items available for display. To display an item,
select (check) the box adjacent to the item.
Dimensional Units - A checkbox used to indicate whether the dimensional units are displayed as a suffix
to each data item, where appropriate. Select (check) this option if desired.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

310

GASWorkS 9.0

GDI
Table Of Contents

Display Limit - A data field used to enter the limit used to determine whether to display the text values or
not. When the diagonal distance across the GDI Window is less than the display limit, the text values are
displayed. When the diagonal distance is greater than the display limit, the text values are not displayed.
Enter a value by typing it into the data field. The value is expressed in terms of the current coordinate units.
To set the limit to the current display, double-click in the data field.
Node Items - A checkbox used to indicate whether the Node Items list will be enabled. Select (check) this
option if desired. The list displays Node Items available for display. To display an item, select (check) the
box adjacent to the item.
Pipe Items - A checkbox used to indicate whether the pipe item list will be enabled. Select (check) this
option if desired. The list displays Pipe Items available for display. To display an item, select (check) the box
adjacent to the item.
Text Rotation - A data field used to enter the rotation angle used to display the text values. Enter a value
by typing it into the data field. The rotation angle is measured as degrees clockwise from 12 oclock (North).
In terms of angle measurement, North is at the top of the display.
Text Size - A data field used to enter the size of the text used to display the data values. Enter a value by
typing it into the data field. The value is specified in printer points.
Transparent Font - A checkbox used to indicate whether the text background will be displayed
transparently, or whether the text background will be opaque and will blank out the image behind the text.
Select (check) this option if desired.
Variable Identifiers - A checkbox used to indicate whether the item identifiers will be displayed as a prefix
to each data item. For example, a P = prefix would be included when node pressure values are displayed.
Select (check) this option if desired.

Command Buttons
Apply - A command button used to close the screen, save any changes, and apply the current settings to the
displayed image.
Cancel - A command button used to close the screen without saving or applying any changes.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

311

GASWorkS 9.0

GDI
Table Of Contents

Tool Palette
The configuration of the icons on the Tool Palette can be arranged by the User, using the Tool Palette Edit
screen. To access the Tool Palette, select the Display Tool Palette icon from the upper-right corner of the
GDI Window. The features associated with the screen are described as follows.

The Tool Palette contains the command icons found on the various GDI toolbars. It also contains
an arrangement grid. The icons can be moved between grid locations by dragging and dropping
the icons with the mouse. When the icons have been arranged as desired. Select the Tool Palette
Close icon to exit the edit mode, and to resize the Tool Palette to the smallest size possible to
display all of icons. Once closed, the Tool Palette may be resized using standard Windows screen
manipulation methods.

Notes & Considerations


! To control the display of the Tool Palette, select the Display Tool Palette icon from the upper-right corner
of the GDI Window to turn the Tool Palette on or off, depending on its current status.
! The displayed location of the Tool Palette may be changed by dragging it with the mouse. The size of the
Tool Palette can be changed by dragging its edges or corners.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

312

GASWorkS 9.0

GDI
Table Of Contents

! When the Tool Palette is displayed, a command may be executed by clicking on the associated icon. When
the command is selected, the Tool Palette will be hidden until the command is complete. Once complete (or
canceled) the Tool Palette will be redisplayed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

313

GASWorkS 9.0

GDI
Table Of Contents

Trace Results
When the Create A Trace Results File option is selected (checked) from the Trace Specifications screen, the
results are stored in a file referred to as the Trace Results. The contents of the report are displayed using the
Trace Results screen. The features associated with the screen are described as follows.

Command Buttons & Icons


Close - A command button used to close the screen.
Maximize Window Size - An icon used to cause the reports window size to be increased to fill
the GASWorkS display screen.

Print - An icon used to print the contents of the report. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.
Reset Window Size - An icon used to cause the reports window size to be normalized or
reduced to its standard size.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

314

GASWorkS 9.0

GDI
Table Of Contents

Trace Specifications Screen


The Trace routine is controlled using the Trace Specifications screen. The screen is accessed by selecting
the Trace command or by selecting the Trace icon from the Graphic Utility Commands toolbar. The features
associated with the screen are described as follows.

Data Items
Create A Trace Results File - A checkbox used to indicate whether a Trace Results file will be created.
Select (check) this option if desired.
Highlight Customers - A checkbox used to indicate whether any customers found along the trace route will
be highlighted with the selected Trace Highlight Color. Select (check) this option if desired.
Reset Colors Before Tracing - A checkbox used to indicate whether the feature colors will be reset to their
currently saved values before the trace is performed. Select (check) this option if desired.
Report Customers Along Route - A checkbox used to indicate whether any customers found along the trace
route will be included in the Trace Results file. Select (check) this option if desired. This item is enabled
when the Create A Trace Results File option is selected.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

315

GASWorkS 9.0

GDI
Table Of Contents

Report Pipes Along Route - A checkbox used to indicate whether the pipes found along the trace route will
be included in the Trace Results file. Select (check) this option if desired. This item is enabled when the
Create A Trace Results File option is selected.
Report Summary Of Features Along Route - A checkbox used to indicate whether all the features found
along the trace route will be included in the Trace Results file. Select (check) this option if desired. This item
is enabled when the Create A Trace Results File option is selected.
Report Valves And Control Devices Along Route - A checkbox used to indicate whether any valves,
regulators, compressors, or turned off elements found along the trace route will be included in the Trace
Results file. Select (check) this option if desired. This item is enabled when the Create A Trace Results File
option is selected.
Start Trace At - A group of option buttons used to specify the type of feature to use as the starting point for
the trace. Select the desired option.
Trace Highlight Color - A color box used to specify the color to use when highlighting the pipes associated
with the trace. To set a Color, click in the associated color box. The Color Palette will be displayed. Select
the desired color, then select the OK command button.
Trace Style - A group of option buttons used to specify the style of the trace to be created. Select the desired
option.
Trace All Directions - Performs a trace in all directions, stopping only at pipes that are turned off.
All pipes which are connected to the specified starting feature will be highlighted.
Trace Downstream - Performs a downstream trace. All pipes which are fed (flow) from the
specified starting feature will be highlighted.
Trace To Valves - Performs a trace in all directions, stopping only at valves, regulators or
compressors, or pipes that are turned off. All pipes which are connected to the specified starting
feature will be highlighted until a valve, regulator, or compressor type element is encountered - or
until an attribute valve is encountered.
Trace Upstream - Performs an upstream trace. All pipes which feed (flow) toward the specified
starting feature will be highlighted

Command Buttons
Cancel - A command button used to close the screen without performing the trace.
Trace - A command button used to close the screen and perform the trace.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

316

GASWorkS 9.0

GDI
Table Of Contents

Notes & Considerations


! Using the Trace To Valves option, the trace will proceed from the start feature until a valve, regulator, or
compressor type element is encountered - or until an attribute valve is encountered. However, attribute valves
are only considered if the valves are displayed prior to executing the trace. A pipe with an attached attribute
valve may or may not be highlighted depending on the location of the attribute valve. If the valve is located
on the "upstream" end of the pipe, the pipe will be highlighted. If the valve is located on the "downstream"
end of the pipe, the pipe may not be highlighted. In this case, upstream and downstream refer to the relative
position from the trace origin.
! If the Create A Trace Results File option is selected (checked), a File Selection screen will be displayed
for entering the desired Filename for the results file. Enter the desired Filename, then select the Continue
command button. The trace results file can posses any valid name, and does not necessarily need to be named
similar to the model. A prompt will appear to indicate the starting position, select the appropriate feature to
create the trace.
! See the Using Attribute Valves topic in the Miscellaneous section of this Manual for a complete description
of attribute valves, their usage, and their relationship to the Trace routine.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

317

GASWorkS 9.0

GDI
Table Of Contents

Trace & Update Specification Screen


The Trace & Update routine is controlled using the Trace & Update Specification screen. To access the
screen select the Trace & Update command. The features associated with the screen are described as follows

Data Items
Equal To - Either a drop-down list or a data field used to specify the new value for the selected Set item.
Either select an item from the list, or enter a value by typing it into the data field.
Highlight Customers - A checkbox used to indicate whether any customers found along the trace route will
be highlighted using the selected Trace Highlight Color. Select (check) this option if desired.
Set - A drop-down list used to select which data item is to be updated. Select an item from the list.
Start Trace At - A group of option buttons used to specify the type of feature to use as the starting point for
the trace. Select the desired option.
Trace Highlight Color - A color box used to specify the color to use when highlighting the pipes associated
with the trace. To set a Color, click in the associated color box. The Color Palette will be displayed. Select
the desired color, then select the OK command button.
Trace Style - A group of option buttons used to specify the style of trace to be created. Select the desired
option.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

318

GASWorkS 9.0

GDI
Table Of Contents

Trace All Directions - Performs a trace in all directions, stopping only at pipes that are turned off.
All pipes which are connected to the specified starting feature will be highlighted.
Trace Downstream - Performs a downstream trace. All pipes which are fed (flow) from the
specified starting feature will be highlighted.
Trace To Valves - Performs a trace in all directions, stopping only at valves, regulators or
compressors, or pipes that are turned off. All pipes which are connected to the specified starting
feature will be highlighted until a valve, regulator, or compressor type element is encountered - or
until an attribute valve is encountered.
Trace Upstream - Performs an upstream trace. All pipes which feed (flow) toward the specified
starting feature will be highlighted.

Command Buttons
Cancel - A command button used to close the screen without performing the trace.
Trace & Update - A command button used to close the screen, perform the trace, and update the specified
item values. A prompt will appear to indicate the starting position, select the desired option.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

319

GASWorkS 9.0

GDI
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

320

GASWorkS 9.0

Property Tables
Table Of Contents

PROPERTY TABLES

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

321

GASWorkS 9.0

Property Tables
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

322

GASWorkS 9.0

Property Tables
Table Of Contents

This section describes the features associated with the various Property Tables and their report screens. It
also provides some suggestions on using the Property Tables to effectively manage common data associated
with the pipe features.

Using Property Tables


The Property Tables feature allows redundant pipe data to be included in a common file, and helps support
the modeling of non-pipe type elements. The Property Tables use relational data management techniques to
maintain a relation between the pipe data files and the Property Tables. A Property Table can be thought of
as a reference table. Information can be stored in the table and then referenced or "looked-up" based on a
common link value. The pipe data and the data contained in the Property Tables are said to be "related" by
these link values. Through this relation, GASWorkS can access the data found in the Property Tables as
needed, without storing all of the required data in the pipe data files.
Several items in the pipe data file can be linked to a single item in a Property Table. This feature allows
redundant data to be stored only once, reducing data storage and entry requirements. This feature also allows
mass changes to be made by changing the value one time in the Property Table, and automatically changing
all of the pipe features that are related to that particular table and item.
The Size/Type Code is used to establish the link between the pipe data files and the Property Tables.
To demonstrate how Property Tables can be used, consider the Pipe Property Table. This table contains
information about the dimensional properties of the pipes in the system. For each unique Size/Type Code,
the table stores the wall thickness, outside diameter, and calculated inside diameter of the pipe. The
Size/Type Code associated with the desired Property Table record may be entered as the Size/Type value
when a pipe size is required, instead of actual inside pipe diameters. For example, the code 2P (which
represents two-inch plastic) can be input for a pipe's Size/Type (diameter), instead of an actual inside
diameter value of "1.885". When an actual inside diameter for this pipe is required, the Pipe Property Table
will be searched for a Size/Type value equal to 2P". When a match is found, the value of the inside diameter
associated with that record is extracted from the associated Property Table.
There are several advantages to using the Property Tables to store the dimensional pipe data. First, it
eliminates the need for the User to remember the specific values of the actual inside pipe diameter for every
pipe in their system. By defining the Property Table using logical codes for the pipe types, like "2P" to
represent a two-inch plastic pipe, the User only needs to remember these easily identified codes. Second, the
use of Property Tables helps ensure the integrity of the model data. By maintaining the pipe sizes in a single
location, and by selecting the Size/Type Codes from the size list when entering data, entry errors can be
reduced and consistent size values can be assured.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

323

GASWorkS 9.0

Property Tables
Table Of Contents

"Standard" Property Tables are included when GASWorkS is installed. The content of the various tables can
be reviewed and modified as necessary to meet the Users specific needs. The Property Tables can be revised,
added to, or deleted from by the User. When choosing values to be used as the codes for the related items,
attempt to choose codes that are short and logical. If you choose codes that are long or hard to remember or
understand, you have defeated one of the biggest advantages of using the Property Table features.
To change the contents of the Property Tables, select the Property Tables menu item from the Report menu
list. The Property Table Report will be displayed. Each table is assigned a separate tab in the report. Select
the tab associated with the desired table.
The remainder of this section describes the Property Table Report screen.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

324

GASWorkS 9.0

Property Tables
Table Of Contents

Updating The Property Tables


The "standard" Property Tables provided when GASWorkS is installed, provide a basis for building your
own tables. The values contained in the standard tables may be modified, new items may be added, and nonapplicable items may be deleted. The various sizes, types, makes, and models included in the standard tables
are described in the associated description item found in the tables. The data values associated with each item
can be viewed or printed by selecting the Property Tables menu item from the Report menu list.
Note that items are continually added to the standard tables as Users request additional items. New and
revised Property Tables are posted on our website, www.b3pe.com, and can be downloaded to replace or
merge with existing property Tables.
Some Property Tables contain specific data for a particular group of related items. For example, one table
contains only size information for copper tubing. The User can select only the tables and items that are
appropriate for their type of system or work. Multiple tables can be combined to create a single
comprehensive table using the Merge routine found in the Property Table Report.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

325

GASWorkS 9.0

Property Tables
Table Of Contents

Property Table Report


The data contained in the various Property Tables can be viewed, printed, and edited using the Property
Table Report. The content displayed in the report will change depending on the selected table type. The
general features associated with the Property Table Report screen and the various tabs are described as
follows.

Command Buttons & Icons


The following command buttons are common to all tabs/sections of this report.
Add Record - An icon used to add a new record to the end of the currently displayed table. After
the new record is added, enter new data by clicking in the associated data cell. Either a data cell
or a data list will appear. Either type the desired value or select an item from the list. Press the
Enter key or click in another data cell to save any changes.
Close - A command button used to close the report. If changes have been made to any of the tables, a prompt
will appear to save the changes, respond appropriately.
Delete Record - An icon used to delete the currently selected (highlighted) record in the currently
displayed table.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

326

GASWorkS 9.0

Property Tables
Table Of Contents

Insert Record - An icon used to insert a new record just before the currently selected
(highlighted) record in the currently displayed table. After the new record is inserted, enter new
data by clicking in the associated data cell. Either a data cell or a data list will appear. Either type
the desired value or select an item from the list. Press the Enter key or click in another data cell
to save any changes.
Maximize Window Size - An icon used to cause the reports window size to be increased to fill
the GASWorkS display screen.

Merge A Table - An icon used to merge the contents of another table into the currently displayed
table. When selected, a prompt will appear asking whether to insert the new table data at the
currently selected (highlighted) record location or at the end of the current table - respond
appropriately. Then a File Selection screen will be displayed. Select the desired Filename, then
select the Continue command button.
Move Record - An icon used to move the currently selected (highlighted) record to a new
location in the currently displayed table. When selected, a warning message will appear to select
the new row location. Select the desired location, then select the Continue command button.
Open - An icon used to open a previously saved Property Table file. When selected, a File
Selection screen will be displayed. Enter or select the desired Filename, then select the Open
command button. Note - GASWorkS 7.0 Look-Up Tables can be opened by navigating to the
directory containing the desired files (generally in the \program files\gasworks 7\ini (or lookup)
directory), then enter *.lut in the Filename entry box - the Look-Up Tables will be listed. All version 7.0
Look-Up tables (Property Tables) end in a .lut extension. Select the desired file from the list. It will be
translated to a GASWorkS 9.0 format - save the file to a new name to save the results of the translation.
Print - An icon used to print the contents of the currently displayed table. When selected, the
Print Control screen will be displayed. Make any desired changes to the printer settings, then
select the Print command button.
Reset Window Size - An icon used to cause the reports window size to be normalized or
reduced to its standardize.

Restore Columns - An icon used to restore the display of all the columns (data items). When
selected, all of the columns associated with the table will now be displayed in the table

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

327

GASWorkS 9.0

Property Tables
Table Of Contents

Save - An icon used to save the contents of the currently table. The type of table to be saved is
controlled by the currently displayed table (tab). When selected, a File Selection screen will be
displayed. Enter or select the desired Filename, then select the Save command button. Once saved,
the table can be opened and used with other models.
Set Columns - An icon used to specify which columns (data items) to display in the table. When
selected, the Columns screen will be displayed. Select (check) the data items to be displayed, then
select the Apply command button. Note - Column display widths can be adjusted by dragging the
column separator lines.
Set As Current - An icon used to cause the currently displayed table to be set as the currently
assigned Property Table in the Preference Settings.

Sort Ascending - An icon used to cause the currently selected (highlighted) column to be sorted
in ascending (A to Z) order. If the table data is saved after the sort has been implemented, the
table will be permanently saved in the new order.
Sort Descending - An icon used to cause the currently selected (highlighted) column to be sorted
in descending (Z to A) order. If the table data is saved after the sort has been implemented, the
table will be permanently saved in the new order.
Swap Yes And No - An icon used to change all of the Yes values in the currently selected
(highlighted) column to No, and to change the No values to Yes.

Yes To No - An icon used to change all the values in the currently selected (highlighted) column
to No. This is useful to reset existing values, before making new selections.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

328

GASWorkS 9.0

Property Tables
Table Of Contents

Compressor Tab

Data Items
Description - A data cell used to display a brief description for the associated compressor. To enter a
description, click in the associated data cell, then type the desired description. The description can contain
up to eighty (80) alpha-numeric characters.
Display - A cell used to indicate whether the associated record will be included in the Size/Type selection
list when it is displayed. Only items where the value of the Display item is set to Yes will be displayed in
the data lists. To set a value, click in the associated data cell till the desired option is displayed.
Equation - A data list used to specify the power equation that will be used to describe the compressor's
power-pressure-flow characteristics. To select a value, click in the associated data cell, then select an item
from the list. See the Compressor Power Equations topic in the Appendix section of this Manual for a
complete description of the equations.
Fuel Consumption - A data cell used to display the fuel consumption rate for the current compressor. To
enter a value, click in the associated data cell, then type the desired value. Ensure the value is expressed in
terms of the selected dimensional unit.
Fuel Units - A data list used to specify the dimensional units for the fuel consumption values. To select a
value, click in the associated data cell, then select an item from the list.
Parameter 1 - The definition of this data cell varies depending on the selected power equation. To enter a
value, click in the associated data cell, then type the desired value. The following table summarizes the
definition of this item as associated with each of the individual power equations:

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

329

GASWorkS 9.0

Property Tables
Table Of Contents

Power Equation

Parameter 1 Definition

Empirical1

K1 - Equation Constant

Empirical2

Not Used

Theoretic

Not Used

Parameter 2 - The definition of this data cell varies depending on the selected power equation. To enter a
value, click in the associated data cell, then type the desired value. The following table summarizes the
definition of this item as associated with each of the individual power equations:
Power Equation

Parameter 2 Definition

Empirical1

K2 - Equation Constant

Empirical2

Not Used

Theoretic

Not Used

Parameter 3 - The definition of this data cell varies depending on the selected power equation. To enter a
value, click in the associated data cell, then type the desired value. The following table summarizes the
definition of this item as associated with each of the individual power equations:
Power Equation

Parameter 3 Definition

Empirical1

K3 - Equation Constant

Empirical2

Not Used

Theoretic

Not Used

Power Units - A data list used to specify the dimensional units for the rated power values. To select a value,
click in the associated data cell, then select an item from the list.
Rated Power - A data cell used to display the rated power of the current compressor. The Rated Power is
only used as a comparison value by the Report and Display routines. To enter a value, click in the associated
data cell, then type the desired value. Ensure the value is expressed in terms of the selected dimensional unit.
Record # - Refers to the position of the current record number in the regulator data file. The value is used
for reference only.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

330

GASWorkS 9.0

Property Tables
Table Of Contents

Reference - A data cell used to display the source for the entered information for the associated compressor.
To enter information, click in the associated data cell, then type the desired description. The reference can
contain up to eighty (80) alpha-numeric characters.
Size/Type -A data cell used to specify the current unique Size/Type Code. This item is used to relate the
Compressor Property Table to the pipe data files. The code can be any group of alphabetic, numeric, or
special characters up to twenty (20) characters in length. Use a logical code to identify the value. To enter
a value, click in the associated data cell, then type the desired value.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

331

GASWorkS 9.0

Property Tables
Table Of Contents

Fittings Tab

Data Items
Description - A data cell used to display a brief description for the associated fitting. The description can
contain up to eighty (80) alpha-numeric characters. To enter a value, click in the associated data cell, then
type the desired description.
Diameter, Roughness Units - A data list used to specify the dimensional units for the equivalent diameter
and roughness values. To select a value, click in the associated data cell, then select an item from the list.
Display - A cell used to indicate whether the associated record will be included in the Size/Type selection
list when it is displayed. Only items where the value of the Display item is set to Yes will be displayed in
the data lists. To set a value, click in the associated data cell till the desired option is displayed.
Efficiency - A data cell used to display the efficiency value to be used with the associated fitting. To enter
a value, click in the associated data cell, then type the desired value. Ensure the value is expressed in terms
of the assigned dimensional unit. See the following Notes & Considerations section for additional
information on the use of the efficiency value in the Solution routine.
Equivalent Diameter - A data cell used to display the value of the equivalent diameter for the associated
fitting. The equivalent diameter represents the inside diameter value that was used as the basis for calculating
the equivalent length value. To enter a value, click in the associated data cell, then type the desired value.
Ensure the value is expressed in terms of the selected dimensional unit.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

332

GASWorkS 9.0

Property Tables
Table Of Contents

Equivalent Length - A data cell used to display the value of the calculated equivalent length of the
associated fitting. To enter a value, click in the associated data cell, then type the desired value. Ensure the
value is expressed in terms of the selected dimensional unit.
Length Units - A data list used to specify the dimensional units for the equivalent length value. To select a
value, click in the associated data cell, then select an item from the list.
Maximum Pipe ID - This item is only used by the GASWorkS US Design Module software. See the
GASWorkS 9.0 US Design Module Guide documentation for the item description.
Minimum Pipe ID - This item is only used by the GASWorkS US Design Module software. See the
GASWorkS 9.0 US Design Module Guide documentation for the item description.
Record # - Refers to the position of the current record number in the regulator data file. The value is used
for reference only.
Reference - A data cell used to display the source for the entered information for the associated fitting. To
enter information, click in the associated data cell, then type the desired description. The reference can
contain up to eighty (80) alpha-numeric characters.
Roughness - A data cell used to display the value of the inside wall roughness to be used for the associated
fitting. To enter a value, click in the associated data cell, then type the desired value. Ensure the value is
expressed in terms of the selected dimensional unit.
Size/Type - A data cell used to display the current fittings unique Size/Type Code. This item is used to
relate the Fittings Property Table to the pipe data files. The code can be any group of alphabetic, numeric,
or special characters up to twenty (20) characters in length. Use a logical code to identify the value. For
example, 2 L-90 might represent a two-inch ninety-degree elbow. To enter a value, click in the associated
data cell, then type the desired value.
Sizing Group - This item is only used by the GASWorkS US Design Module software. See the GASWorkS
9.0 US Design Module Guide documentation for the item description.
Sizing Type - This item is only used by the GASWorkS US Design Module software. See the GASWorkS
9.0 US Design Module Guide documentation for the item description.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

333

GASWorkS 9.0

Property Tables
Table Of Contents

Pipe Tab

Data Items
Cost Per (Unit) Length - A data cell used to display the unit value of the pipe's installation cost. Any
currency unit may be used. To enter a value, click in the associated data cell, then type the desired value. The
value should be consistent with the length units used with the pipe segments. For example, if the length units
are Feet, the Cost Per (Unit) Length should be expressed in cost per foot.
Description - A data cell used to display a brief description for the associated pipe. The description can
contain up to eighty (80) alpha-numeric characters. To enter a value, click in the associated data cell, then
type the desired description.
Display - A cell used to indicate whether the associated record will be included in the Size/Type selection
list when it is displayed. Only items where the value of the Display item is set to Yes will be displayed in
the data lists. To set a value, click in the associated data cell till the desired option is displayed.
Display Color - A data list used to specify the color to be used to display the associated pipe size/type, when
the color value of an assigned pipe is set to Pipe Table. To set a Color, select the Click To Select Color
item from the list. The Color Palette will be displayed. Select the desired color, then select the OK command
button. Or, select Default from the list.
Display Line Style - A data list used to specify the line style to be used to display the associated pipe
size/type, when the line style value of an assigned pipe is set to Pipe Table. To select a value, click in the
associated data cell, then select an item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

334

GASWorkS 9.0

Property Tables
Table Of Contents

Display Line Width - A data list used to specify the line width to be used to display the associated pipe
size/type, when the line width value of an assigned pipe is set to Pipe Table. To select a value, click in the
associated data cell, then select an item from the list.
Efficiency - A data cell used to display the efficiency value to be used with the associated pipe. To enter a
value, click in the associated data cell, then type the desired value. Ensure the value is expressed in terms
of the assigned dimensional unit. See the following Notes & Considerations section for additional
information on the use of the efficiency in the Solution routine.
Outside Diameter - A data cell used to display the value of the outside diameter of the associated pipe. If
manufacturing tolerances are available, adjust the outside diameter to reflect the smallest possible diameter,
as this will result in a conservative inside diameter value. To enter a value, click in the associated data cell,
then type the desired value. Ensure the value is expressed in terms of the selected dimensional unit.
Record # - Refers to the position of the current record number in the regulator data file. The value is used
for reference only.
Reference - A data cell used to display the source for the entered information for the associated pipe. To
enter information, click in the associated data cell, then type the desired description. The reference can
contain up to eighty (80) alpha-numeric characters.
Roughness - A data cell used to display the value of the inside wall roughness to be used for the associated
pipe. To enter a value, click in the associated data cell, then type the desired value. Ensure the value is
expressed in terms of the select dimensional unit.
Size/Type - A data cell used to display the current pipes unique Size/Type Code. This item is used to relate
the Pipe Property Table to the pipe data files. The code can be any group of alphabetic, numeric, or special
characters up to twenty (20) characters in length. Use a logical code to identify the value. For example, 2P
might represent a two-inch plastic pipe. To enter a value, click in the associated data cell, then type the
desired value.
Sizing Group - A data list used to specify the sizing group to associate the current pipe with. Several sizes
can be assigned to a group - for example, plastic sizes could be assigned to one group and steel to another.
Each pipe segment can be assigned to a specific group. When using the Pipe Sizing routine, only pipe sizes
associated with the assigned group will be considered during the pipe selection. To select a value, click in
the associated data cell, then select an item from the list.
SMYS - A data cell used to display the Specified Minimum Yield Strength value to be used with the
associated pipe. To enter a value, click in the associated data cell, then type the desired value. Ensure the
value is expressed in terms of the selected dimensional unit. The SMYS value is used for reporting purposes
only.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

335

GASWorkS 9.0

Property Tables
Table Of Contents

Stress Units - A data list used to specify the dimensional units for the SMYS (Specified Minimum Yield
Strength) value. To select a value, click in the associated data cell, then select an item from the list.
T, D, R Units - A data list used to specify the dimensional units for the wall thickness (T), the outside and
inside diameters (D), and the roughness (R) values. To select a value, click in the associated data cell, then
select an item from the list.
Use When Sizing - A cell used to indicate whether the current pipe will be available for use when the
Calculate Pipe Sizes (Optimize) solution option is selected (checked). During the Optimization routine, only
pipe types identified for use, set to Yes, will be considered when finding the required pipe sizes for the
system being modeled. To set a value, click in the associated data cell till the desired option is displayed.
Wall Thickness - A data cell used to display the wall thickness value for the associated pipe. If
manufacturing tolerances are available, the pipe wall thickness should be adjusted so that it reflects the
greatest possible thickness, as this results in a conservative inside diameter value. To enter a value, click in
the associated data cell, then type the desired value. Ensure the value is expressed in terms of the selected
dimensional unit.

Calculated Values
Inside Diameter - Displays the calculated value of the inside diameter of the associated pipe. The value is
calculated using the wall thickness and outside diameter values. This value cannot be changed by the User.
To change the value of the inside diameter, modify the wall thickness or outside diameter values.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

336

GASWorkS 9.0

Property Tables
Table Of Contents

Regulator Tab

Data Items
Description - A data cell used to display a brief description for the associated regulator. The description can
contain up to eighty (80) alpha-numeric characters. To enter a value, click in the associated data cell, then
type the desired description.
Differential Units - A data list used to specify the dimensional units for the differential values. To select
a value, click in the associated data cell, then select an item from the list.
Display - A cell used to indicate whether the associated record will be included in the Size/Type selection
list when it is displayed. Only items where the value of the Display item is set to Yes will be displayed in
the data lists. To set a value, click in the associated data cell till the desired option is displayed.
Equation - A data list used to specify the flow equation that will be used to describe the regulator's pressureflow characteristics. To select a value, click in the associated data cell, then select an item from the list. See
the Regulator Flow Equations topic in the Appendix section of this Manual for a complete description of the
equations. The following table summarizes the available equations and their general application.
Manufacturer

Applicable Flow Equation

Equimeter

Rockwell

Fisher

Universal

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

337

GASWorkS 9.0

Property Tables
Table Of Contents

Manufacturer

Applicable Flow Equation

Grove - Models 900 & 83

Grove

Grove - Model 80 Flexflo

Grove80

Mooney

Universal

Rockwell

Rockwell

Minimum Differential - A data cell used to display the minimum differential (to achieve full opening) of
the associated regulator. To enter a value, click in the associated data cell, then type the desired value. Ensure
that the value is expressed in terms of the selected dimensional unit.
Parameter 1 - The definition of this data cell varies depending on the selected flow equation. To enter a
value, click in the associated data cell, then type the desired value. The following table summarizes the
definition of this item based on the various flow equations.
Flow Equation

Parameter 1 Definition

Grove

Not Used

Grove80

Tube Expansion Factor

Rockwell

Not Used

Universal

C1 - Valve Recovery Factor

Record # - Refers to the position of the current record number in the regulator data file. The value is used
for reference only.
Reference - A data cell used to display the source for the entered information for the associated regulator.
To enter information, click in the associated data cell, then type the desired description. The reference can
contain up to eighty (80) alpha-numeric characters.
Size/Type - A data cell used to display the current regulator's unique Size/Type Code. This item is used to
relate the Regulator Property Table to the pipe data files. The code can be any group of alphabetic, numeric,
or special characters up to twenty (20) characters in length. Use a logical code to identify the value. For
example, FC 1098EGR 1 could be used to represent a Fisher Controls 1" Model 1098EGR Regulator. To
enter a value, click in the associated data cell, then type the desired value.
Valve Factor - A data cell used to display the published "regulating" valve coefficient of the regulator. To
enter a value, click in the associated data cell, then type the desired value. The following table summarizes
the applicable values based on each specific flow equation.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

338

GASWorkS 9.0

Property Tables
Table Of Contents

Flow Equation

Applicable Coefficient

Grove

Cv - Valve Capacity Factor

Grove80

C1 - Critical Flow Factor

Rockwell

"K" Factor - Regulator Constant

Universal

Cg (Regulating) - Gas Sizing Coefficient

Wide-Open Factor - A data cell used to display the published wide-open valve coefficient of the
regulator. For some manufacturers this value is the same as the regulating valve coefficient. To enter a
value, click in the associated data cell, then type the desired value. The following table summarizes the
coefficient's definition, based on each specific flow equation.
Flow Equation

Applicable Coefficient

Grove

Cv - Valve Capacity Factor

Grove80

Cp - Valve Wide Open Capacity Coefficient

Rockwell

"K" Factor - Regulator Constant

Universal

Cg (Wide-Open) - Gas Sizing Coefficient

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

339

GASWorkS 9.0

Property Tables
Table Of Contents

Valve Tab

Data Items
Description - A data cell used to display a brief description for the associated relief valve. The description
can contain up to eighty (80) alpha-numeric characters. To enter a value, click in the associated data cell,
then type the desired description.
Diameter Units - A data list used to specify the dimensional units for the diameter values. To select a value,
click in the associated data cell, then select an item from the list.
Display - A cell used to indicate whether the associated record will be included in the Size/Type selection
list when it is displayed. Only items where the value of the Display item is set to Yes will be displayed in
the data lists. To set a value, click in the associated data cell till the desired option is displayed.
Equation - A data list used to specify the flow equation that will be used to describe the relief valve's
pressure-flow characteristics. To select a value, click in the associated data cell, then select an item from the
list. See the Valve Flow Equations topic in the Appendix section of this Manual for a complete description
of the equations. The following table summarizes the available equations and their general application.
Manufacturer

Applicable Flow Equation

Equimeter Regulator

RW-Reg

Fisher Regulator

Univ-Reg

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

340

GASWorkS 9.0

Property Tables
Table Of Contents

Manufacturer

Applicable Flow Equation

Generic Fittings, Valves, & Regulators

Crane

Grove Regulator

Grove-Reg

Mooney Regulator

Univ-Reg

Rockwell Regulator

RW-Reg

Rockwell Valve

Rockwell

Sensus Regulator

RW-Reg

Equivalent Diameter - A data cell used to display the equivalent diameter of the relief valve. The physical
definition of this item varies according to the selected flow equation. To enter a value, click in the associated
data cell, then type the desired value. Ensure that the value is expressed in terms of the selected dimensional
unit. The following table summarizes the item definition associated with each of the individual flow
equations.
Flow Equation

Applicable Parameter

Crane

Varies. See the Crane Publication No. 410 for a detailed description. For
approximate calculations use the inside diameter of the inlet pipe connection.

Grove-Reg

The inside diameter of the inlet pipe connection.

Rockwell

The inside diameter of the inlet pipe connection.

RW-Reg

The inside diameter of the inlet pipe connection.

Univ-Reg

The inside diameter of the inlet pipe connection.

Parameter 1 - The definition of this data cell varies depending on the selected flow equation. To enter a
value, click in the associated data cell, then type the desired value. The following table summarizes the
definition of this item based on the various flow equations.
Flow Equation

Parameter 1 Definition

Crane

Not Used

Grove-Reg

Fk - Specific Heat Ratio

Rockwell

Not Used

RW-Reg

Not Used

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

341

GASWorkS 9.0

Property Tables
Table Of Contents

Flow Equation

Parameter 1 Definition

Univ-Reg

C1 - Valve Recovery Factor

Record # - Refers to the position of the current record number in the regulator data file. The value is used
for reference only.
Reference - A data cell used to display the source for the entered information for the associated relief valve.
To enter information, click in the associated data cell, then type the desired description. The reference can
contain up to eighty (80) alpha-numeric characters.
Size/Type - A data cell used to display the current relief valve's unique Size/Type Code. This item is used
to relate the Valve Property Table to the pipe data files. The code can be any group of alphabetic, numeric,
or special characters up to twenty (20) characters in length. Use a logical code to identify the value. For
example, RW 250S 4 4 could be used to represent a Rockwell Model 250S 4-inch body 4-inch orifice relief
valve. To enter a value, click in the associated data cell, then type the desired value.
Valve Factor - A data cell used to display the published valve coefficient for the relief valve. The definition
of this item varies depending on the selected flow equation. To enter a value, click in the associated data cell,
then type the desired value. The following table summarizes the applicable values based on each specific
flow equation.
Flow Equation

Applicable Coefficient

Crane

K - Resistance Coefficient

Grove-Reg

Cv - Valve Capacity Factor

Rockwell

"F" Factor - Pressure Drop Factor

RW-Reg

"K" Factor - Regulator Constant

Univ-Reg

Cg (Wide-Open) - Gas Sizing Coefficient

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

342

GASWorkS 9.0

Property Tables
Table Of Contents

Well Tab

Data Items
Coefficient - A data cell used to display the value of the equation coefficient (constant) of the associated
well. To enter a value, click in the associated data cell, then type the desired value.
Description - A data cell used to display a brief description for the associated well. The description can
contain up to eighty (80) alpha-numeric characters. To enter a value, click in the associated data cell, then
type the desired description.
Display - A cell used to indicate whether the associated record will be included in the Size/Type selection
list when it is displayed. Only items where the value of the Display item is set to Yes will be displayed in
the data lists. To set a value, click in the associated data cell till the desired option is displayed.
Exponent - A data cell used to display the value of the equation exponent of the associated well. To enter
a value, click in the associated data cell, then type the desired value.
Record # - Refers to the position of the current record number in the regulator data file. The value is used
for reference only.
Reference - A data cell used to display the source for the entered information for the associated well. To
enter information, click in the associated data cell, then type the desired description. The reference can
contain up to eighty (80) alpha-numeric characters.
Well ID/Type - A data cell used to display the current well's unique identification code. This item is used
to relate the Well Property Table to the pipe data files. The code can be any group of alphabetic, numeric,
or special characters up to twenty (20) characters in length. Use a logical code to identify the value. To enter
a value, click in the associated data cell, then type the desired value.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

343

GASWorkS 9.0

Property Tables
Table Of Contents

Notes & Considerations


! The number of columns in the table will vary according to the selected table type.
! If the Property Table Report is too wide to print, reduce the column, set the printer to landscape mode, and
reduce the printer font and size. If the contents of the Property Table Report will not fit on a single page
width, multiple pages will be used to print the Property Table Report.
! The Equivalent Length value can be determined from manufacturer tables, or from a piping design
handbook. Most equivalent lengths are expressed in terms of the length of the standard wall thickness of the
pipe. It is important to know and correctly set the equivalent diameter value to correctly calculate the
equivalent length value.
! The dimensional units for the Equivalent Diameter and Equivalent Length items are independent of the
diameter and length units used for the pipes. In other words, the Property Table dimensional units can be
different from the units used for the pipes. For example, the Equivalent Diameter values could be expressed
in Inches and the pipe diameter values could be expressed in Centimeters. The appropriate unit
conversion will automatically take place when using and reporting the Property Table values.
! The dimensional units for the Outside Diameter and Wall Thickness items are independent of the diameter
units used for the pipes. In other words, the Property Table dimensional units can be different from the
diameter units used for the pipes. For example, the Property Table values could be expressed in Inches and
the pipe diameter values could be expressed in Centimeters. The appropriate unit conversion will
automatically take place when using and reporting the Property Table values.
! The values of the compressor parameters must be based on an equation whose dimensional units are
consistent with the following units:
Equation Parameter

Dimensional Units

Volumetric Flow Rate

Cfh

Pressure or Pressure Drop

Psia

Temperature

Rankine

! The "Fitting" type can be used to model any device for which an equivalent length can be calculated.
! Fittings are modeled as a segment of pipe using the Equivalent Length for the pipe's length and the
Equivalent Diameter for the pipe's diameter.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

344

GASWorkS 9.0

Property Tables
Table Of Contents

! During the solution, a total efficiency is computed for pipe and fitting type elements. This value is used
in the hydraulic calculations. The total efficiency value is computed as the product of the efficiency assigned
directly to the pipe segment, and the efficiency value found in the Pipe Property Table for the matching
Size/Type Code. If no matching record is found in the Pipe Property Table, only the assigned value is used.
To apply only the values in the Property Tables, set the pipe segment value to one (1). To apply only the pipe
segment value, set the associated Property Table value to one (1).
! The Cost Per (Unit) Length is used in the Summary Report to calculate the cost of the system. Costs of
various system configurations can be compared to determine the cost and benefits of the various scenarios.
! The Specified Minimum Yield Strength value is only truly applicable for steel pipe types. However, for
plastic pipe types, the Long Term Hydrostatic Strength can be used in place of the Specified Minimum Yield
Strength to estimate the hoop stress to strength ratio.
! Use the "Regulator" hydraulic type to model regulators operating in the "control" or "working monitor"
mode. To model a regulator in a "wide-open monitor" mode, or in an upset condition, model the regulator
as a "Valve" element.
! The values of the regulator parameters must be based on a flow equation whose dimensional units are
consistent with the following units:
Equation Parameter

Dimensional Units

Volumetric Flow Rate

Cfh

Pressure or Pressure Drop

Psia

Temperature

Rankine

! The "Valve" hydraulic type can also be used to model fittings (using the Crane Equation), or regulators
operating in the "wide-open monitor" mode, or in an upset condition (using the Crane or "Reg" equations).
! The values of the valve parameters must be based on an equation whose units are consistent with the
following units:
Equation Parameter

Dimensional Units

Volumetric Flow Rate

Cfh

Pressure or Pressure Drop

Psia

Temperature

Rankine

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

345

GASWorkS 9.0

Property Tables
Table Of Contents

! Only one well equation is supported, it is described in the Appendix section of this Manual. The equation
coefficient and equation exponent are well dependent. Their values are determined by performing a
multipoint curve fit of data derived from a standard performance test of the well.
! The Well Property Table is useful for maintaining generic or assumed well performance data for untested
or similar performing wells. The equation coefficient (constant) and exponent can also be uniquely entered
for an individual well feature without using the Property Table. To allow entry of unique values for a well
feature, select the Unique item from the Size/Type list in the pipe data for the well.
! The values of the well parameters must be based on an equation whose units are consistent with the
following units:
Equation Parameter

Dimensional Units

Volumetric Flow Rate

Cfh

Pressure or Pressure Drop

Psia

Temperature

Rankine

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

346

GASWorkS 9.0

Attribute Data
Table Of Contents

ATTRIBUTE DATA

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

347

GASWorkS 9.0

Attribute Data
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

348

GASWorkS 9.0

Attribute Data
Table Of Contents

GASWorkS allows non-model data to be attached to a model through the use of an external database. This
non-model data is referred to as Attribute Data. Attribute data can be attached to both the customer and pipe
features.
A customer attribute file might contain information about the customer address, customer classification, or
usage information. A pipe attribute file might contain information about the installation date, leak history,
or test data.
If the usage information in a customer file can be manipulated into a form suitable for use in the hydraulic
analysis, for example peak hour load, it can be used to assign load values to the associated customer features,
and subsequently to the nodes in the model.
Two styles of attribute files may be used with GASWorkS. One is called a linked style file, and is a file
that can be defined by the User, but is managed by GASWorkS. The other is a non-linked style file, and
is a file managed by a third party application, for example a dBase database, or Excel spreadsheet. When a
linked file is attached, GASWorkS adds and deletes records from the file as features are added and deleted
from the model. When a non-linked file is used, record maintenance must be handled by some means outside
of GASWorkS.
The records in an attached attribute file are linked to the associated model features using the Link ID
item. If a linked style database is attached, GASWorkS handles assignment of the Link ID values. If a
non-linked style database is attached, the User must manually assign the Link ID values. Generally, the
Link ID value should be unique within the database.
The Update External Loads routine causes the External Load item of the node data to be updated using the
values found in the specified field of an attached customer attribute file. The processing behavior of the
command varies depending on whether the model contains customer features or not. When customer features
are included in the model, and the Total Load field is assigned, the command looks for a matching record
in the attribute file, based on the Link ID value, for each customer feature in the model. If a match is made,
the customer load is updated with the value found in the attribute file. When all of the customer loads have
been updated, the node external loads are updated with the new customer loads, based on the node
application method assigned to each customer. When no customer features are present, and the Total Load
field is assigned, the command allows the load values contained in the attribute file to be assigned to either
nodes or pipes based on the Node Name or Pipe Link ID value. An additional specification screen will be
displayed when this method is used.
The remainder of this section describes the various routines and data screens associated with the attribute
data and external database functions.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

349

GASWorkS 9.0

Attribute Data
Table Of Contents

Customer Attribute Settings Screen


A linkedcustomer attribute file, or another external database file can be attached to the customer features
in a model. The attribute file settings are defined using the Customer Attribute Settings screen. The screen
is accessed by selecting the Attribute File menu item from the Customer Data submenu of the Utilities menu
list. The features associated with the screen are described as follows.

General Tab

Data Items
Address Field - A drop-down list used to select the name of the database field (in the attached attribute file)
which contains the customer address values. Select an item from the list. The address is used for certain
Reporting routines. This item is optional, if it is not used, leave the list empty.
Attribute File Type - A drop-down list used to select the type of the attached attribute file. Select an item
from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

350

GASWorkS 9.0

Attribute Data
Table Of Contents

Connection Status - A pair of option buttons used to specify the status of the connection between the model
and attribute file. Select the desired option. If the status is turned Off, the connection will be disabled until
turned back On.
Filename - A data field used to enter or display the Filename of the attached attribute file. Either enter a
Filename by typing it into the data field, or select the Browse command button.
Link ID Field - A drop-down list used to select the name of the database field (in the attached attribute file)
which contains the customer identification number. Select an item from the list. The Link ID is used to link
the customer features contained in the model, to the data contained in the attached attribute file.
Total Load Field - A drop-down list used to select the name of the database field (in the attached attribute
file) which contains the total load values. Select an item from the list. If this item is specified, it is assigned
to the Total Load value of the associated customer feature. This item is optional, if it is not used leave the
list empty.
Total Load Units - A drop-down list used to select the dimensional units for the total load values contained
in the attached attribute file. Select an item from the list. If the Total Load Field is specified, this item must
be assigned.
Use The Model Path Location For The Attribute File Location - A checkbox used to indicate whether
to look for the attribute file in the same path location as the model files. This item is useful when models are
frequently shared or moved. Select (check) this option if desired. When selected (checked), it eliminates the
need to reset the attribute file location each time the model is moved.

Command Buttons
Browse - A command button used to assign a database file. When selected, a File Selection screen will be
displayed. Select the desired Filename, then select the Continue command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

351

GASWorkS 9.0

Attribute Data
Table Of Contents

Other Tab
When a linked database is used, the Other data tab will be enabled - the data tab is disabled for all other
database types. The data tab is used to identify which data lists to assign to the various data fields. See the
Using Data Lists topic found later in this section of the Manual.

Data Items
Database Definition - A list box used to display the data fields in the current database definition. The list
only allows viewing of the contents of the definition. Select the Edit Database Definition command button
to edit or revise the definition.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

352

GASWorkS 9.0

Attribute Data
Table Of Contents

Edit Database Definition - A command button used to open the Linked Attribute Database Definition
screen. The contents of the Linked Attribute Database Definition screen are described later in this section
of the Manual.

Notes & Considerations


! The available attribute file types are described in the following table.
File Type

Description

dBase III

Select this item when the attribute data is contained in a dBase III format
file. The file does not need to contain a record for each customer feature.
Only records that match an existing customer feature will be available for
display. Customers are matched using the Link ID value.

dBase IV

Select this item when the attribute data is contained in a dBase IV format
file. The file does not need to contain a record for each customer feature.
Only records that match an existing customer feature will be available for
display. Customers are matched using the Link ID Number.

Excel 4.0
(XLS Worksheet)

Select this item when the attribute data is contained in a Excel 4.0
Worksheet format file. The file does not need to contain a record for each
customer feature. Only records that match an existing customer feature will
be available for display. Customers are matched using the Link ID value.

Excel 8.0
(XLS Workbook)

Select this item when the attribute data is contained in an Excel 8.0 SingleSheet Workbook format file. The file does not need to contain a record for
each customer feature. Only records that match an existing customer feature
will be available for display. Customers are matched using the Link ID
value. The file can contain only a single worksheet.

Linked Attribute

Select this item to use the GASWorkS linked attribute file features. When
this type of file is selected, GASWorkS creates a database file based on a
User specified definition, and manages the addition and deletion of records
associated with the file.

None

Use this item when no attribute file is attached.

! When an attribute file is attached, and turned on, the attribute data will be displayed by the various
Customer Display and Report routines. Depending on the attribute file type, the contents may be available
for manipulation with the various Edit Customer commands and SQL edit feature.
! After attaching or changing an attribute file, remember to update the node loads, as appropriate, using the
Update External Loads menu item from the Customer Data submenu of the Utilities menu list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

353

GASWorkS 9.0

Attribute Data
Table Of Contents

! When a linked attribute file is initially attached, GASWorkS creates a new dBase 4.0 format database
file possessing the same name as the model, with a .cdb extension. The contents of the file are specified
by the database definition. Once created, additional fields may be added to or removed from a linked
attribute file by revising the database definition. See the Linked Attribute Database Definition Screen topic
found later in this section of the Manual.
! Once a linked attribute file is attached and created, GASWorkS manages the addition and deletion of
the associated records. One database record is maintained for each customer data feature contained in the
model. Individual customers may be attached or unattached from the attribute file by appropriately
setting the Link To Attribute File Customer Data item.
! The contents of a linked attribute file may be manipulated by an outside application, however care
should be taken so that the Link ID value and its values are not corrupted. If changes are made by an outside
application, ensure that GASWorkS is not using the file when the changes are made. Do not add or remove
records from the file using a non-GASWorkS application.
! When an attribute file is attached, the model and database files are linked using the Link ID value. When
a function needs to display or report information contained in the attribute file, a search of the database is
performed. The first record in the database with a matching Link ID value is retrieved. Multiple customer
features may contain the same Link ID value, however only unique Link ID values should appear in the
attribute database.
! When an attribute file is attached, the model and database files are linked using the Link ID value. When
using a linked style database, the Link ID value is automatically managed by GASWorkS. Do not manually
change the Link ID value of a feature or database record when using a linked style attribute file.
! Depending on the size of the attached database, processor speed, and connection speed, the search
process may take some time to complete. If the connection is slow, and the information in the attribute file
is not required, the attribute file connection may be temporarily turned off using the Connection Status
item, at times, when the attribute data is not needed.
! When working with a linked style database, turning the Connection Status Off, does not prevent
records from being added to or deleted from the database file - it only suppresses the display of the attribute
data in the various Report and Display routines.
! Each database style has its own unique requirements for field name, size, and syntax. In general, keep the
field names short (less than ten (10) characters), do not include spaces in the name, (use an underscore (_)
character instead), and do not use special characters (like %, #, !, etc) in the field name.
! When a data list is used with a linked database, the assigned list will be displayed when the associated
data field is edited.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

354

GASWorkS 9.0

Attribute Data
Table Of Contents

Pipe Attribute Settings Screen


A linkedpipe attribute file, or another external database file can be attached to the pipe features in a model.
The attribute file settings are defined using the Pipe Attribute Settings screen. The screen is accessed by
selecting the Attribute File menu item from the Pipe Data submenu of the Utilities menu list. The features
associated with the screen are described as follows.

General Tab

Data Items
Address Field - A drop-down list used to select the name of the database field (in the attached attribute file)
which contains the pipe address values. Select an item from the list. The address is used for certain Reporting
routines. This item is optional, if it is not used, leave the field empty.
Attribute File Type - A drop-down list used to select the type of the attached attribute file. Select an item
from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

355

GASWorkS 9.0

Attribute Data
Table Of Contents

Connection Status - A pair of option buttons used to specify the status of the connection between the model
and attribute file. If the status is turned off, the connection will be disabled until turned back on. Select the
desired option.
Filename - A data field used to enter the name of the attached attribute file. Either enter a Filename by
typing it into the data field, or select the Browse command button. A File Selection screen will be displayed,
select the desired Filename, then select the Continue command button.
Link ID Field - A drop-down list used to select the name of the database field (in the attached attribute file)
which contains the pipe identification number. Select an item from the list. The Link ID is used to link the
pipe features contained in the model, to the data contained in the attached attribute file.
Use The Model Path Location For The Attribute File Location - A checkbox used to indicate whether
to look for the attribute file in the same path location as the model files. Select (check) this option if desired.
This item is useful when models are frequently shared or moved, eliminating the need to reset the attribute
file location each time the model is moved.

Command Buttons
Browse - A command button used to assign a database file. When selected, a File Selection screen will be
displayed. Select the desired Filename, then select the Continue command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

356

GASWorkS 9.0

Attribute Data
Table Of Contents

Other Tab
When a linked database is used, the Other data tab will be enabled - the data tab is disabled for all other
database types. The data tab is used to identify which data lists to assign to the various data fields. See the
Using Data Lists topic found later in this section of the Manual.

Data Items
Database Definition - A list box used to display the data fields in the current database definition. The list
only allows viewing of the contents of the definition. Select the Edit Database Definition command button
to edit or revise the definition.

Command Buttons
Cancel - A command button used to close the screen without saving any changes.
Close - A command button used to close the screen and save any changes.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

357

GASWorkS 9.0

Attribute Data
Table Of Contents

Edit Database Definition - A command button used to open the Linked Attribute Database Definition
screen. The contents of the Linked Attribute Database Definition screen are described later in this section
of the Manual.

Notes & Considerations


! The available attribute file types are described in the following table.
File Type

Description

dBase III

Select this item when the attribute data is contained in a dBase III format
file. The file does not need to contain a record for each pipe feature. Only
records that match an existing pipe feature will be available for display.
Pipes are matched using the Link ID value.

dBase IV

Select this item when the attribute data is contained in a dBase IV format
file. The file does not need to contain a record for each pipe feature. Only
records that match an existing pipe feature will be available for display.
Pipes are matched using the Link ID value.

Excel 4.0
(XLS Worksheet)

Select this item when the attribute data is contained in a Excel 4.0
Worksheet format file. The file does not need to contain a record for each
pipe feature. Only records that match an existing pipe feature will be
available for display. Pipes are matched using the Link ID value.

Excel 8.0
(XLS Workbook)

Select this item when the attribute data is contained in an Excel 8.0 SingleSheet Workbook format file. The file does not need to contain a record for
each customer feature. Only records that match an existing customer
feature will be available for display. Customers are matched using the Link
ID value. The file can contain only a single worksheet.

Linked Attribute

Select this item to use the GASWorkS linked attribute file features.
When this type of file is selected, GASWorkS creates a database file based
on a User specified definition, and manages the addition and deletion of
records associated with the file.

None

Use this item when no attribute file is attached.

! When an attribute file is attached, and turned on, the attribute data will be displayed by the various Pipe
Display and Report routines. Depending on the attribute file type, the contents may be available for
manipulation with the various Edit Pipe commands and SQL edit feature.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

358

GASWorkS 9.0

Attribute Data
Table Of Contents

! When a linked attribute file is initially attached, GASWorkS creates a new dBase 4.0 format database
file possessing the same name as the model, with a .pdb extension. The contents of the file are specified
by the database definition. Once created, additional fields may be added to or removed from a linked
attribute file by revising the database definition. See the Linked Attribute Database Definition Screen topic
found later in this section of the Manual.
! Once a linked attribute file is attached and created, GASWorkS manages the addition and deletion of
the associated records. One database record is maintained for each pipe data feature contained in the model.
Individual pipes may be attached or unattached from the attribute file by appropriately setting the Link
To The Attribute File Pipe Data item.
! The contents of a linked attribute file may be manipulated by an outside application, however care
should be taken so that the Link ID values are not corrupted. If changes are made by an outside application,
ensure that GASWorkS is not using the file when the changes are made. Do not add or remove records from
the file using a non-GASWorkS application.
! When an attribute file is attached, the model and database files are linked using the Link ID value. When
a function needs to display or report information contained in the attribute file, a search of the database is
performed. The first record in the database with a matching Link ID value is retrieved. Multiple pipe features
may contain the same Link ID value, however only unique Link ID values should appear in the Attribute
Database.
! When an attribute file is attached, the model and database files are linked using the Link ID value. When
using a linked style database, the Link ID value is automatically managed by GASWorkS. Do not manually
change the Link ID value of a feature or database record when using a linked style attribute file.
! Depending on the size of the attached database, processor speed, and connection speed, the search
process may take some time to complete. If the connection is slow, and the information in the attribute file
is not required, the attribute file connection may be temporarily turned off using the Connection Status
item, at times, when the attribute data is not needed.
! When working with a linked style database, turning the Connection Status Off, does not prevent
records from being added to or deleted from the database file - it only suppresses the display of attribute data
in the various Report and Display routines.
! Each database style has its own unique requirements for field name, size, and syntax. In general, keep the
field names short (less than ten (10) characters), do not include spaces in the name, (use an underscore (_)
character instead), do not use special characters (like %, #, !, etc) in the field name.
! When a data list is used with a linked database, the assigned list will be displayed when the associated
data field is edited.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

359

GASWorkS 9.0

Attribute Data
Table Of Contents

Updating External Loads


The node data contains an item known as the External Load. This value refers to loads that are assigned from
an external source using the Update External Loads routine. The routine is found in the Customer Data
submenu of the Utilities menu list.
The routine behaves differently depending on whether customer features are included in the model. When
customer features are included in the model and the Total Load value is assigned, the routine looks for a
matching record in the attribute file, based on the Link ID value, for each customer feature in the model. If
a match is made, the customer load is updated with the value found in the attribute file. When all of the
customer loads have been updated, the node external loads are updated with the new customer loads, based
on the node application method assigned to each customer. The load for customers where the Adjust Load
By Design Factor option is selected (checked), will be assigned to the External Load item. Where the option
is not selected (not checked), the load will be assigned to the Fixed External Load item.
When no customer features are present and the Total Load value is assigned, the routine allows the load
values contained in the attribute file to be assigned to either nodes or pipes based on Node Name or Pipe Link
ID value. The following additional specification screen will be displayed when this method is used. The
features associated with the screen are described as follows.

Update Options Screen

Data Items
Node 1 Name - A drop-down list used to select which data field contains the Node Name values of the first
node to assign the load to. Select an item from the list. This item is only displayed when the Using Node
Names option is selected. The load value is assigned one-half to both Node 1 and Node 2.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

360

GASWorkS 9.0

Attribute Data
Table Of Contents

Node 2 Name - A drop-down list used to select which data field contains the Node Name values of the
second node to assign the load to. Select an item from the list. This item is only displayed when the Using
Node Names option is selected. The load value is assigned one-half to both Node 1 and Node 2.
Pipe ID Value - A drop-down list used to select which data field contains the Pipe Link ID values. Select
an item from the list. This item is only displayed when the Using Pipe Link IDs option is selected.
Zero Loads Before Updating - A checkbox used to indicate whether this routine will reset all of the
External Load values to zero (0) before applying the update values. Select (check) this option if desired.

Command Buttons
Cancel - A command button used to close the screen without proceeding with the routine.
Update - A command button used to update the External Load values.

Notes & Considerations


! When the Zero Loads Before Updating option is selected (checked), all external loads are set to zero (0)
before updating. When the option is not selected (not checked), the update loads are added to the existing
load values.
! When the Using Node Names option is selected, one-half of the loads contained in the attribute file are
assigned (added) to the External Load value of the node matching the Node 1 and Node 2 name values. To
assign all of the load to a single node, select the same field for both the Node 1 Name and Node 2 Name
items.
! When the Using Pipe Link IDs option is selected, one-half of the loads contained in the attribute file are
assigned (added) to the External Load value of the nodes assigned to the pipe matching the Link ID value.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

361

GASWorkS 9.0

Attribute Data
Table Of Contents

Using Data Lists


When a linked customer or pipe attribute file is used, the data fields contained in the file may be specified
by the User. To make data entry for these data fields more efficient, a data list may be assigned to each data
field. Selection of a value from a data list is generally more efficient than entering a value by typing it into
the data field. Data fields that represent items that may be repeated many times in the database (like customer
type, or meter size/type) are good candidates for association with a data list. Generally, data fields that
represent a number or text value that may be unique or may not be used often are not good candidates for
association with data lists.
A data list is a simple ASCII text file which contains a list of data items and values. The format of the file
is as follows:
Data Item
Item Value
Data Item
Item Value
etc...
Where the Data Item represents the text or value to be displayed in the data list, and the Item Value
represents a value to associate with the Data Item. Usage of the Item Value will be explained later in this
section. Item Values can only be integer type numbers ranging from -32000 to 32000. An Item Value may
be zero (0) but a value must be entered.
The data list file can be created using a third party wordprocessor or text editor, like Windows Notepad. Each
pair of lines of text in the file represents a Data Item and its associated Item Value. To create a data list file:
! Open a wordprocessor or text editor. For example, open Windows Notepad.
! Create a new file.
! Enter the values that you want to include in the list - enter one Data Item on a line followed by its
Item Value on the next line. Press the Enter key at the end of each line.
! After you are done entering the desired values, save the file as an ASCII text file. Instead of a
.txt extension, use .lst for the Filename extension. The file should be saved in the current
Property Tables directory. The Property Tables menu item of the Preferences submenu of the File
menu can be used to determine the current path for the Property Tables.
After the data list has been created, it can be assigned to its associated data field using the Attribute File
menu item from the Customer Data or Pipe Data submenu of the Utilities menu list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

362

GASWorkS 9.0

Attribute Data
Table Of Contents

Once assigned, the data list will be displayed when the associated item is edited. The first item in the list will
be used as the default setting for new features.
The storage and memory required to store an item in the database can be reduced by using an numeric integer
code to represent the item, instead of its actual text value. For example, pipe coating types might be coded
so that 1" represents Polyethylene Plastic and 2" represents Fusion Bonded Epoxy. The storage
requirement for saving the code 2" is much less than storing the entire text string Fusion Bonded Epoxy
(2 bytes to store the integer code compared to 19 bytes to store the text string).
GASWorkS accommodates the use of item codes through the Item Value in the data list. When a field type
is set to a short integer field type, and a data list is associated with that field, the Data Item values are
displayed when the field is edited by one of the model Report or Edit routines, however when the item is
saved, the code specified by the associated Item Value is actually saved in the database. This allows a more
efficient, but slightly more complicated, method of storing text values that are appropriate for inclusion in
a data list.
There are two special types of data list files. One indicates that the contents of the selection list should be
based on a Property Table. The other indicates that the contents of the selection list should be based on a
GASWorkS dimensional units list.
To create a list that specifies that a Property Table should be used, a file must be created that contains two
lines of text. The first line must contain the value GW_PROPERTY_TABLE. The second line contains the
name of the table to use. Acceptable values for the second line are:
COMPRESSOR
PIPE
VALVE

FITTING
REGULATOR
WELL

When the list is displayed, it will contain the contents of the currently assigned Property Table, as specified
by the Property Tables Settings in the Preferences.
To create a list that specifies that a dimensional units list should be used, a file must be created that contains
two lines of text. The first line must contain the value GW_UNITS_LIST. The second line contains the
name of the unit type to use. Acceptable values for the second line are:
COORDINATE
DIAMETER
EFFICIENCY
ELEVATION
ENERGY
FLOW
FUEL
HEATING

Bradley B Bean PE

LENGTH
POWER
PRESSURE
TEMPERATURE
VELOCITY
VISCOSITY
VOLUME

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

363

GASWorkS 9.0

Attribute Data
Table Of Contents

When the list is displayed, it will contain the contents of the specified dimensional units list, as predefined
in the GASWorkS software.
A comment or remark can be included in a data list file by beginning the line with a pair of forward slashes
(//). The comment must immediately follow on the same line. Comments are not included when the list is
displayed in a data field.
Several sample data lists are included when GASWorkS is installed. You can open and view those files for
an example of how to arrange a data list file. The files all end in a .lst extension and are located in the
prop subdirectory of the main GASWorkS directory. A description of the files is included in the Appendix
section of this Manual.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

364

GASWorkS 9.0

Attribute Data
Table Of Contents

Using SQL To Update Attribute Data


GASWorkS provides a routine for updating data values contained in pipe and customer attribute files (not
all file types support SQL). This routine is particularly useful for modifying customer load data contained
in an attribute file. The modifications are defined by the use of a Standard Query Language (SQL) statement.
SQL is a special language used to control and define changes to supported format database files. A complete
discussion and review of SQL is beyond the scope of this document, however the Help System contains a
variety of examples which will provide some insight into using SQL to modify data in an attribute file. The
SQL Statement is entered and executed using the Define SQL Update Specification screen. The features
associated with the screen are described as follows.

Define SQL Update Specification Screen

Data Items
Saved Statements - A drop-down list used to select a previously saved SQL statement. Select an item from
the list.
SQL Statement - A data field used to enter the desired SQL statement. Enter a value by typing it into the
data field. Refer to the following Notes & Considerations section for further information about the statement
format requirements.

Command Buttons
Close - A command button used to close the screen without proceeding with the routine.
Delete Displayed Specification - A command button used to delete the currently displayed Saved Statement.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

365

GASWorkS 9.0

Attribute Data
Table Of Contents

Execute - A command button used to execute the specified SQL Statement.


Save Current Specification - A command button used to save the currently displayed SQL Statement.

Notes & Considerations


! The SQL Statement represents the Set and Where portions of a standard Update Statement. For
example, to increase the values in a field called TOTAL by ten percent (10%), the required SQL Statement
would be: SET TOTAL = TOTAL * 1.1.
! Changes made to the attribute file using this method are permanent. You may be able to undo a change
by immediately executing a reciprocal SQL Statement. For example, to undo the change described above,
the reciprocal SQL Statement would be: SET TOTAL = TOTAL / 1.1.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

366

GASWorkS 9.0

Attribute Data
Table Of Contents

Linked Attribute Database Definition Screen


When using the linked attribute database type, GASWorkS automatically creates and maintains a database
containing attribute data as defined in the associated database definition. The definition specifies various
information about the fields to include in the attribute files. Definitions may be saved and retrieved. A
definition may be pre-defined, and used and shared between models. The definition is manipulated using the
Linked Attribute Database Definition screen. The screen is accessed by selecting the Edit Database
Definition command button on the Customer or Pipe Attribute Settings screen.
When a linked attribute file is initially attached, a new dBase IV format database file possessing the same
name as the model, with a .cdb extension for customer data, or a .pdb extension for pipe data is created.
A basic definition is used to create the new file. Additional fields may be added to the file to meet the Users
preferences and requirements.
A database definition is modified using the Linked Attribute Database Definition screen. The features
associated with the screen are described as follows.

Data Items
Allow Edit - A cell used to indicate whether the data field values can be edited using the various Report or
Edit routines. To set a value, click in the associated data cell till the desired option is displayed.
Data List - A data list used to specify the name of the selection list to display when a data field is being
edited using one of the Report or Edit routines. To select a value, click in the associated data cell, then select
an item from the list. Press the Enter key to save.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

367

GASWorkS 9.0

Attribute Data
Table Of Contents

Display - A cell used to indicate whether the data field will be displayed in the various Report and Display
routines. To set a value, click in the associated data cell till the desired option is displayed.
Display Text - A data cell used to enter the text value to display when a data field is shown using the various
Report and Edit routines. To enter a value, click in the associated data cell, then type the desired value. Press
the Enter key to save.
Field Name - A cell used to display the name for the data field. Names must be no more than ten (10)
alpha-numeric characters and cannot contain spaces or special characters.
Field Type - A cell used to display the type of data that the data field will store. Text or a variety of numeric
types are supported.
Field Width - A cell used to enter or display the maximum number of characters to allow in the data field.
To select a value, click in the associated data cell, then select an item from the list. Press the Enter key to
save.

Command Buttons & Icons


Add Record - An icon used to add a new record to the end of the database definition. After the
new record is added, enter new data by clicking in the associated data cell. Either a data cell or
a data list will appear. Either type the desired value or select an item from the list. Press the Enter
key or click in another data cell to save any changes.
Apply - A command button used to close the screen and apply any changes.
Cancel - A command button used to close the screen without saving any changes.
Clear Fields - An icon used to clear or delete all fields except the LINK_ID and ADDRESS
fields.

Delete Record - An icon used to delete the currently selected (highlighted) record.

Insert Record - An icon used to insert a new record just before the currently selected
(highlighted) record. After the new record is inserted, enter new data by clicking in the associated
data cell. Either a data cell or a data list will appear. Either type the desired value or select an item
from the list. Press the Enter key or click in another data cell to save any changes.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

368

GASWorkS 9.0

Attribute Data
Table Of Contents

Maximize Window Size - An icon used to cause the screens window size to be increased to fill
the GASWorkS display screen.

Move Record - An icon used to move the currently selected (highlighted) item to a new location
in the database definition. When selected, a prompt will appear for the new location to move the
record to.
Open - An icon used to open a previously saved database definition file. When selected, a File
Selection screen will be displayed. Enter or select the desired Filename, then select the Open
command button.
Print - An icon used to print the contents of the screen. When selected, the Print Control screen
will be displayed. Make any desired changes to the printer settings, then select the Print command
button.
Reset Window Size - An icon used to cause the screens window size to be normalized or
reduced to its standard size.

Save - An icon used to save the contents of the currently displayed database definition. When
selected, a File Selection screen will be displayed. Enter or select the desired Filename, then
select the Save command button. Once saved, the database definition can be opened and used with
other models.

Notes & Considerations


! Each row in the Linked Attribute Database Definition represents a field in the attribute data file. The fields
are displayed in the order that they appear in the definition.
! The field names must be less than ten (10) characters. The field names cannot contain spaces or special
characters (like %, #, !). Use an underscore (_) character instead of a blank space for the field names.
! Additional fields may be added or removed from the attribute data file after its initial creation, by revising
the database definition. Revising the definition will require the attribute data file to be recreated. When the
file is recreated some data may be lost, if a field is removed, or a field name or type is changed. If a change
is made that results in an unexpected loss of a data field, close the model without saving the changes and the
old definition and values should be preserved. However, any model changes made during the current edit
session will be lost.
! No more than 255 fields may be included in the definition.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

369

GASWorkS 9.0

Attribute Data
Table Of Contents

! An outside application, such as Microsoft Excel may be used to edit the attribute data file. However, doing
so may corrupt the database definition used by GASWorkS and may result in a loss of data or connection
between GASWorkS and the attribute data file.
! When an attribute data file is attached, the model and database files are linked using the Link ID value.
When using a linked style database, the Link ID value is automatically managed by GASWorkS. Do not
change the Link ID value of a feature or database record when using a linked style attribute data file.
! When a new linked attribute data file is first attached, a basic database definition will be created. The
initial definition will contain a field named LINK_ID, and one named ADDRESS. Additional fields may
be added, or if a definition has been previously saved it may be opened and applied to the current model.
! The LINK_ID and ADDRESS fields are required by the customer and pipe attribute data files. Do not
remove these fields from the attribute database definition. Their display can be turned off in the database
definition, if you do not wish to view them.
! If a linked style attribute data file is to be used, the file should be attached and the database definition
should be created immediately after creating a new model, or the New Project routine should be used to
specify the database definition and automatically attach the attribute data file while creating the new model.
! Several sample database definitions are included when GASWorkS is installed. The files all end in a .ddf
extension and are located in the prop subdirectory of the main GASWorkS directory. A description of the
files is included in the Appendix section of this Manual.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

370

GASWorkS 9.0

Import & Export Routines


Table Of Contents

IMPORT & EXPORT


ROUTINES

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

371

GASWorkS 9.0

Import & Export Routines


Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

372

GASWorkS 9.0

Import & Export Routines


Table Of Contents

This section describes the features associated with the GASWorkS Import and Export routines, and provides
suggestions on using these features to effectively use GASWorkS with data from other applications.
GASWorkS provides Translation routines for importing or exporting data associated with several types of
file formats. Using the Import and Export routines, data contained in ASCII Text files, older versions of
GASWorkS files, database files, spreadsheet files, CAD files, and GIS files may be used with GASWorkS.
The following table describes the Import and Export features supported by GASWorkS.
File Type

Supports
Import

Export

Merge

Quick
Export

ASCII (Delimited) - Customer, Node, and Pipe Data

ASCII (Column) - Customer, Node, and Pipe Data

dBASE III (3.0) - Customer, Node, and Pipe Data

U
U

dBASE IV (4.0) - Customer, Node, and Pipe Data

dBASE V (5.0) - Customer, Node, and Pipe Data

DXF

GASWorkS 7.0

Microsoft Access
Microsoft Excel 4.0 Worksheet - Customer, Node,
and Pipe Data

U
U

Microsoft Excel 5.0 Workbook - Customer, Node,


and Pipe Data
Microsoft Excel 8.0 Workbook - Customer, Node,
and Pipe Data

MIF/MID (MapInfo)

Shape Attribute Valve

Shape (ESRI) - Customer, Node, and Pipe Data

Stoner PD/XY

X-Y Customer

X-Y Node

Bradley B Bean PE

U
U

U
U

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

373

GASWorkS 9.0

Import & Export Routines


Table Of Contents

File Type

X-Y Valve

Supports
Import

Export

Merge

Quick
Export

The Import and Export routines are accessed through the Import/Export menu item in the Utilities menu list.
When selected, the Import/Export screen will be displayed. All of the Import routines are controlled through
this screen. The features associated with the various import and export screens, along with the specific
requirements associated with each supported file type, are described in the following sections.
The Quick Export routines are accessed using the Quick Export submenu of the File menu list. The Quick
Export routines automatically export the customer, node, and pipe data contained in the model to a single
file or set of files in the specified format, depending on the Target data type. When using the Quick Export
routines, the contents of the data files associated with the currently open model are used to create the export
files - not the data contained in memory - save the model before exporting to include any changes that were
made after the model was opened or last saved.
Note - Files that are open by another application, like a database or spreadsheet application cannot
be processed by the Import or Export routines until they are closed by the outside application.
Note - When customer files are processed during an Import routine, the imported load value is
multiplied by -1 before being assigned to its GASWorkS variable. Values that indicate demands (gas
leaving the system) must be entered asa positive value in the file to be imported. In general, the load
value (in the import file) should represent the value in cfh dimensional units.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

374

GASWorkS 9.0

Import & Export Routines


Table Of Contents

Import/Export Screen
The Import routines are controlled by the Import/Export screen. The screen is accessed by selecting the
Import/Export menu item from the Utilities menu list. The features associated with the screen are described
as follows.

Data Items
File Type - A list box used to display the type of file to be imported. Select the desired type from the list.
When selected, the type will be highlighted in the File Type list and displayed in the Import/Export Log list.
Import/Export Log - A panel used to display the activity of the Import/Export routine.

Calculated Value
Processing Record - Displays the number of the record or line that is currently being processed.

Command Buttons
Cancel/Close - The function and caption of this command button varies depending on the current activity
and status of the Translation routine. When Close is displayed, it is a command button used to close the
screen without performing a translation. When Cancel is displayed, it is a command button used to stop the
translation activity.
Export - A command button used to translate a GASWorkS model into the selected file format. When
selected, the Import/Export File Selection screen will be displayed. Select the desired files, then select the
Continue command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

375

GASWorkS 9.0

Import & Export Routines


Table Of Contents

Import - A command button used to translate a file and create a new GASWorkS model. When selected, the
Import/Export File Selection screen will be displayed. Select the desired files, then select the Continue
command button.
Merge - A command button used to merge a file with an existing GASWorkS model. When selected, the
Import/Export File Selection screen will be displayed. Select the desired files, then select the Continue
command button.

Notes & Considerations


! The features associated with the Import/Export File Selection screen are described later in this section of
the Manual.
! Selecting certain file types may cause an additional screen to be displayed. These screens allow additional
translation specifications to be defined. These specifications screens are described later in this section of the
Manual.
! The Merge routine allows a file to be merged with an existing GASWorkS file. When using the routine,
the import (source) file is compared to the GASWorkS (target) file. Where matching records are found, only
the defined data fields are updated. If a matching record is not found in the target File, a new record is added
to the GASWorkS file.
! The Export routine creates a new set of files in the specified format, it does not change the format or
content of the GASWorkS model data files.
! The Import routine creates a new set of GASWorkS model data files. If existing model files are present,
they will be sent the Windows Recycle Bin before the Import routine is executed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

376

GASWorkS 9.0

Import & Export Routines


Table Of Contents

Import/Export File Selection Screen


When using the Import, Export, or Merge routines, the Source and Target Filenames are specified using the
Import/Export File Selection screen. The features associated with the screen are described as follows.

Data Items
The upper portion of the screen contains items associated with the source (input) file. The lower portion of
the screen contains items associated with the target (output) file.
Directories - A list box used to display the directory (folder) containing the desired files. Select the desired
directory from the list. When a directory has been selected, all files matching the specified extension or
search pattern will be displayed in the Files list box.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

377

GASWorkS 9.0

Import & Export Routines


Table Of Contents

Drives -A drop-down list used to select the disk drive containing the desired files. Select the desired drive
from the list. When a drive is selected, the directories contained on that drive will be listed in the Directories
list box. The directory that is current for the specified drive, will be at the top of the list.
Filename - A data field used enter or display the name of the currently selected file. The Filename can be
manually entered by typing it into the data field, or by selecting a file from the associated Files list.
Files - A list box used to display the source and target Files. To select a file, double-click on the desired file's
name, its name will be placed in the appropriate Filename data field.

Command Buttons
Cancel - A command button used to close the screen without proceeding with the routine.
Continue - A command button used to proceed with the routine.

Notes & Considerations


! When importing or merging a file, the file to be imported is referred to as the "Source" file, and the
GASWorkS model being imported into is referred to as the "Target" file. When exporting a file, the
GASWorkS model to be exported is referred to as the "Source" file, and the file being created is referred to
as the "Target" file.
! The Source and Target Filename items are linked to each other - when a file is entered or selected in the
Source Filename data field, a suggested name is also entered in the Target Filename data field. The Target
name can be changed by selecting a Filename from the associated Files list, or by manually entering a name
by typing a value in the data field.
! The Import routine will overwrite existing files. If a target file is named the same as an existing file, the
original contents of the file will be sent to the Windows Recycle Bin. A warning message will appear if an
existing file is about to be overwritten. When the message appears, select the appropriate option to proceed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

378

GASWorkS 9.0

Import Routines
Table Of Contents

IMPORT ROUTINES

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

379

GASWorkS 9.0

Import Routines
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

380

GASWorkS 9.0

Import Routines
Table Of Contents

Importing Files
This section of the Manual provides descriptions and requirements for importing data from the various
supported file formats. Where an additional data screen is used to further define the import specifications,
it will be described in the appropriate section. The Help System contains a variety of step-by-step examples
of importing the various data files.
When importing data files, ensure that the data values and dimensional units contained in the Source File are
compatible with the values supported by GASWorkS.
The import (source) file does not need to be completely inclusive. Items not included in the file will be set
to applicable default data values and may be revised after the import is complete, using the Mass Update or
Data Edit routines. The default data values can be set before importing a file using the Set Defaults menu
item from the Utilities menu list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

381

GASWorkS 9.0

Import Routines
Table Of Contents

Import ASCII (Column) Files


Fixed column format ASCII files can be used to import or merge customer, pipe, or node data into a
GASWorkS model. The Import or Merge routine for these type files is controlled by the Define ASCII File
Format specification screen. The layout of the source file must be defined using the screen before the file
can be processed.
The functionality of the specification screen is similar for each data type (customer, pipe, or node). The
specific contents of the screen changes with the selected File Format, either Column or Delimited, and data
type. The general features associated with the Column File Format specification screen are described as
follows.

Define ASCII Column File Format Screen

Data Items
End - A data field used to enter the ending position of the displayed (selected) data item in the source file.
Enter a value by typing it into the data field. The ending position is described as the number of characters
from the left of the file. The position of the first character is one (1). If an item is not contained in the source
file, its Start and End values should be empty.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

382

GASWorkS 9.0

Import Routines
Table Of Contents

File Format - A pair of option buttons used to specify the basic format of the data in the source file. Select
the Column option. A column file format refers to a file where the data is presented in uniform columns and
rows. Each column is associated with a specific data field, and each row is associated with an individual
record.
Item - Displays the currently selected (highlighted) data item. Once selected, the field assignment can be
made. To select an item, click on associated data item in the Item list box.
Item List - A list box used to display the various GASWorkS data items associated with the date type being
imported. In the list, adjacent to each data item, is the column assignment information. Click on an item name
to display its values in the Item, Start, and End data fields. Select the Enter command button to save the
specification values to the Item List.
Start - A data field used to enter the starting position of the displayed (selected) data item in the source file.
Enter a value by typing it into the data field. The starting position is described as the number of characters
from the left of the file. The position of the first character is one (1). If an item is not contained in the source
file, its Start and End values should be empty.

Command Buttons
Cancel - A command button used to close the screen without proceeding with the routine.
Clear All Settings - A command button used to clear (remove) all of the column specification information
for the data items shown in the Item list box.
Continue - A command button used to proceed with the routine.
Enter - A command button used to save the current item and column assignment values.

Notes & Considerations


! The Start and End data fields designate the beginning and ending character positions of the various data
items. The end position must always be equal to or greater than the start position. If a data item is not used,
leave the Start and End data fields empty.
! The Item list appearing directly below the Item, Start, and End data fields, displays the GASWorkS data
items associated with the data type being processed, along with their column assignments. If a data item is
assigned a column, the start and end positions will appear to the right of the item's name, separated by a
comma (","). Unassigned items appear by themselves.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

383

GASWorkS 9.0

Import Routines
Table Of Contents

! The import files can contain other non-related data, however no more than fifty (50) individual columns
may be present in the import record.
! Generally, customer data should be imported after the piping system has been created.
! When using the Merge routine with customer data, the Link ID Number data field must be assigned.
! When using the Merge routine with pipe data, the Link ID Number data field must be assigned.
! When importing pipe data, the From Node Name and To Node Name data fields must be assigned.
! After importing a customer file, when the model is first opened in the GDI, a message will appear asking
whether to create the service line assignments. Select the Yes command button to automatically create the
service lines. If the pipe assignments are not included in the imported data, the customers and service lines
will be assigned and attached to the geographically closest pipe. If the pipe assignments are included in the
imported data, the customers and service lines will be assigned and attached to the specified pipes. When
a service line is created, where possible, the location of the connection to the assigned pipe (main) is placed
at a point that would cause the service line to be perpendicular from the pipe to the center of the customer
location. After the customer assignments have been made and corrected, remember to update the model loads
by executing the Update External Loads routine found in the Customer Data submenu of the Utilities menu
list.
! When importing customer data, the negative of the imported load value is saved in the customer data. That
is, if the value contained in the source file is positive, the value saved in the target file will be negative.
Therefore, load values that represent demands, should be positive in the source file. Load values that
represent supplies, should be negative in the source file.
! Generally, it is not necessary to import node data. However, if node data is to be imported, the node data
should be imported before the pipe data.
! When importing or merging node data, a unique name (or number) must be included for each record.
! The node data must be imported before the pipe data is imported. If the associated node data file does not
already exist, an error message will appear.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

384

GASWorkS 9.0

Import Routines
Table Of Contents

Import ASCII (Delimited) Files


Character delimited (for example, comma separated) format ASCII files can be used to import or merge
customer, pipe, and node data into a GASWorkS model. The Import or Merge routine for these type files is
controlled by the Define ASCII File Format specification screen. The layout of the source file must be
defined using the screen before the file can be processed.
The functionality of the specification screen is similar for each data type (customer, pipe, or node). The
specific contents of the screen changes with the selected File Format, either Column or Delimited, and data
type. The general features associated with the Delimited File Format specification screen are described as
follows.

Define ASCII Delimited File Format Screen

Data Items
Delimiter - A data field used to enter the character used to separate the individual items in the data list. Enter
a value by typing it into the data field. A comma (,) is most commonly used, however most any unique
character can be used.
Field - A data field used to enter the field number for the displayed data item. Enter a value by typing it into
the data field. The field number represents the data item's position in the import list. The first item in the
import list is associated with field number one (1).

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

385

GASWorkS 9.0

Import Routines
Table Of Contents

File Format - A pair of option buttons used to specify the basic format of the data in the source file. Select
the Delimited option. A delimited format refers to a file where the data is presented in individual lists
containing data items separated by a delimiter (character). Each row contains one list, and each list represents
the data associated with an individual record.
Item - Displays the currently selected (highlighted) data item. Once selected, the field assignment can be
made. To select an item, click on associated data item in the Item list box.
Item List - A list box used to display the various GASWorkS data items associated with the date type being
imported. In the list, adjacent to each data item, is the field assignment information. Click on an item name
to display its values in the Item and Field data fields. Select the Enter command button to save the
specification values to the Item List.

Command Buttons
Cancel - A command button used to close the screen without proceeding with the routine.
Clear All Settings - A command button used to clear (remove) all of the column specification information
for the data items shown in the Item list box.
Continue - A command button used to proceed with the routine.
Enter - A command button used to save the current item and column assignment values.

Notes & Considerations


! The Field value designates the position in the import data list corresponding to the displayed data item.
If a data item is not used, leave the Field value empty.
! When using delimited files, if a space is used as the delimiter, ensure that extra spaces are not included
in any of the data fields.
! The Item list box appearing directly below the Item and Field data fields, displays the GASWorkS data
items associated with the data type being processed, along with their field assignments. If a data item is
assigned a field, the assigned value will appear to the right of the item's name. Unassigned items appear by
themselves.
! The import files can contain other non-related data, however no more than fifty (50) individual columns
may be present in the import record.
! Generally, customer data should be imported after the piping system has been created.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

386

GASWorkS 9.0

Import Routines
Table Of Contents

! When using the Merge routine with customer data, the Link ID Number must be assigned.
! After importing a customer file, when the model is first opened in the GDI, a message will appear asking
whether to create the service line assignments. Select the Yes command button to automatically create the
service lines. If the pipe assignments are not included in the imported data, the customers and service lines
will be assigned and attached to the geographically closest pipe. If the pipe assignments are included in the
imported data, the customers and service lines will be assigned and attached to the specified pipes. When
a service line is created, where possible, the location of the connection to the assigned pipe is placed at a
point that would cause the service line to be perpendicular from the pipe (main) to the center of the customer
location. After the customer assignments have been made and corrected, remember to update the model loads
by executing the Update External Loads routine found in the Customer Data submenu of the Utilities menu
list.
! When importing customer data, the negative of the imported load value is saved in the customer data. That
is, if the value contained in the source file is positive, the value saved in the target file will be negative.
Therefore, load values that represent demands, should be positive in the source file. Load values that
represent supplies, should be negative in the source file.
! Generally, it is not necessary to import node data. However, if node data is to be imported, the node data
should be imported before the pipe data.
! When importing or merging node data, a unique name (or number) must be included for each record.
! When importing pipe data, the From Node Name and To Node Name data fields must be assigned.
! When using the Merge routine with pipe data, the Link ID Number must be assigned.
! The node data must be imported before the pipe data is imported. If the associated node data file does not
already exist, an error message will appear.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

387

GASWorkS 9.0

Import Routines
Table Of Contents

Import dBASE Format Files


When importing a dBASE file, GASWorkS requires the User to specify the layout of the import file. The file
definition is described using the Database File Format screen. The functionality of the screen is similar for
each data type (customer, node, and pipe). The specific contents of the screen changes with the data type.
The features associated with the screen are described as follows.

Database File Format Screen

Data Items
Available Fields - A list box used to display the individual data fields found in the selected source file.
Double-click an available field to assign it to the currently selected (highlighted) data item.
Customer/Node/Pipe Items - A list box used to display the GASWorkS data items and their current field
assignments. To assign a field to a data item, first select (highlight) the data item in the associated Items list,
then assign the available field by double-clicking on the desired field in the Available Fields list. To unassign an item, double-click on it in the associated Items list.

Command Buttons
Cancel - A command button used to close the screen without proceeding with the routine.
Clear - A command button used to clear all field assignments.
Continue - A command button used to proceed with the routine.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

388

GASWorkS 9.0

Import Routines
Table Of Contents

Notes & Considerations


! GASWorkS expects the source file to be a dBASE III Plus format, however other versions of dBASE files,
and files created by other dBASE compatible applications may also be acceptable.
! The import files can contain other non-related data, however no more than fifty (50) individual data fields
may be present in the source file.
! Generally customer data should be imported after the piping system has been created.
! When using the Merge routine with customer data, the Link ID Number must be assigned.
! After importing a customer file, when the model is first opened in the GDI, a message will appear asking
whether to create the service line assignments. Select the Yes command button to automatically create the
service lines. If the pipe assignments are not included in the imported data, the customers and service lines
will be assigned and attached to the geographically closest pipe. If the pipe assignments are included in the
imported data, the customers and service lines will be assigned and attached to the specified pipes. When
a service line is created, where possible, the location of the connection to the assigned pipe is placed at a
point that would cause the service line to be perpendicular from the main to the center of the customer
location. After the customer assignments have been made and corrected, remember to update the model
loads, by executing the Update External Loads routine found in the Customer Data submenu of the Utilities
menu list.
! When importing customer data, the negative of the imported load value is saved in the customer data. That
is, if the value contained in the source file is positive, the value saved in the target file will be negative.
Therefore, load values that represent demands, should be positive in the source file. Load values that
represent supplies, should be negative in the source file.
! Generally, it is not necessary to import node data. However if node data is to be imported, the node data
should be imported before the pipe data.
! When importing or merging node data, a unique name (or number) must be included for each record.
! When importing pipe data, the From Node Name and To Node Name data fields must be assigned.
! When using the Merge routine with pipe data, the Link ID Number must be assigned.
! The node data must be imported before the pipe data is imported. If the associated node data file does not
already exist, an error message will appear.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

389

GASWorkS 9.0

Import Routines
Table Of Contents

Import DXF Files


When importing a DXF file, GASWorkS requires the User to specify certain information about the import
file. The file definition is specified using the DXF Import Specification screen. The features associated with
the screen are described as follows.

DXF Import Specification Screen - Pipe Settings Tab

Data Items
Arc Resolution - A data list used to enter or select the resolution to use when processing an arc from the
source file. Either select an item from the list or enter a value by typing it into the data field. If the value is
greater than zero (0), arc entities will be converted to polyline type pipes with a vertex placed according to
the resolution value. The value is expressed in terms of the degrees of arc.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

390

GASWorkS 9.0

Import Routines
Table Of Contents

Assign Entity Handle To Pipe Identification Number - A checkbox used to indicate whether the entity
handles in the drawing are assigned to the Link ID field for pipes processed during the Import routine. Select
(check) this option if desired.
Attribute Valve Layer - A drop-down list used to select whether attribute valves are to be processed during
the Import routine. If symbols (blocks) indicating the location of valves are present in the drawing, select the
associated layer from the list. If a layer is assigned, attribute valves will be processed during the Import
routine. If no layer is assigned, attribute valves will be ignored.
Fuzzy Tolerance - A data list used to enter or select the fuzzy tolerance to use when processing the source
file. Either select an item from the list or enter a value by typing it into the data field. Line ends that fall
within the fuzzy tolerance, are snapped together. The value is expressed in terms of the specified model
coordinate units.
Pipe Layers - A panel used to display the Pipe Size and Layer Assignments. To make an assignment - under
the Pipe Size column, click in the associated data cell. A drop-down list of pipe sizes will be displayed. Select
an item from the list. Click in the adjacent data cell under the Layer Assignment column. A drop-down list
of available drawing layers will be displayed, select an item from the list.
Pipe Length Units - A drop-down list used to select the length dimensional units for the imported pipes.
Select an item from the list. It is used to make the appropriate conversion between pipe lengths, drawing
coordinate units, and model coordinate units.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

391

GASWorkS 9.0

Import Routines
Table Of Contents

DXF Import Specification Screen - Other Settings Tab

Data Items
Allow Multiple Customers At Same Location - A checkbox used to indicate whether multiple customers
can be located at the same location. Select (check) this option if desired. When selected (checked), if multiple
customers are found at the same location in the source (drawing) file, they will be stacked in the model
at the same location. If the item is not selected (not checked), only one customer (the first customer
encountered) will be allowed within the fuzzy tolerance of a given location.
Assign Text Value To Customer Identification Number - If the Customer Entity Type is a Text
Location, this item is a checkbox used to indicate whether the entity value will be assigned as the Link ID
Number for the imported customer features. Select (check) this option if desired.
Customer Entity Type - A drop-down list used to select the entity type used to indicate the customer
locations in the drawing. Select an item from the list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

392

GASWorkS 9.0

Import Routines
Table Of Contents

Customer Layer - A drop-down list used to select whether customers are to be processed during the Import
routine. If customer locations are present in the drawing, select the desired layer from the list. If a layer is
assigned, customers will be processed during the Import routine. If no layer is assigned, customers will be
ignored.
Drawing Coordinate Units - A drop-down list used to select the dimensional unit for the coordinate values
in the source (drawing) file. Select an item from the list. It is used to make the appropriate conversion
between pipe lengths, drawing coordinate units, and model coordinate units.
Model Coordinate Units - A drop-down list used to select the dimensional unit for the coordinate values
in the target (model) file. Select an item from the list. It is used to make the appropriate conversion between
pipe lengths, drawing coordinate units, and model coordinate units.
Origin Shift - A pair of data fields used to enter the amount to shift the coordinate values during the import
process. Enter the associated values by typing them into the data fields. The X-value indicates the horizontal
(east-west) amount to shift the coordinates. The Y-value indicates the vertical (north-south) amount to shift
the coordinates. The values are expressed in terms of the drawing coordinate units.
Scale Factor - A data field used to enter the value to scale the imported coordinate values by. Enter a value
by typing it into the data field. This item is not used if the drawing dimensional units are specified.
User Text Layer - A drop-down list used to select whether text values will be imported as User Text
during the Import routine. If text values are present in the drawing, and it is desired to import these values
as GASWorkS User Text, select the desired layer from the list. If a layer is assigned, the text contained on
the assigned layer will be processed as User Text during the Import routine. If no layer is assigned, text
values will be ignored.

Command Buttons
Cancel - A command button used to close the screen without proceeding with the routine, or without saving
any changes.
Close - A command button used to close the screen without proceeding with the routine, and saving any
changes.
Continue - A command button used to proceed with the routine.
Retrieve Specification - A command button used to retrieve a previously saved set of specification values.
When selected, a File Specification screen will be displayed. Enter or select the desired Filename, then select
the Continue command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

393

GASWorkS 9.0

Import Routines
Table Of Contents

Save Specification - A command button used to save the current specification values to a file for use at a
later time. When selected, a File Specification screen will be displayed. Enter or select the desired Filename,
then select the Continue command button.
Set Default Values - A command button used to open the Default Data Values screen. Make any desired
changes, then select the Close command button.

Notes & Considerations


! The various Layer Assignment items designate the assigned layer in the source file. If a data item is not
used, leave the Layer Assignment value empty.
! GASWorkS expects the source file to be an AutoCAD (Release 2000 or older) Drawing Interchange File
format, however newer version files, and files created by other DXF compatible applications may also be
acceptable.
! The DXF Translation routine allows Drawing Interchange Files created by various CAD or other graphics
packages to be used to create a GASWorkS model. A complete model is created when the routine is used,
including a Header, Customer (if included), Node, and Pipe data file.
! GASWorkS constructs the new model by using the linear graphic features on the "Pipe" layers as the pipes
in the GASWorkS model. A pipe is created for each line, polyline, or arc feature found on the specific "Pipe"
layers. The geographic/scaled length value of the original feature is used as the length for the new pipe
element. The specified pipe size is assigned to pipes processed from the associated layer.
! A node is placed at the beginning and end of each pipe (linear feature).
! The GASWorkS GDI supports coordinates in the range from 0 to 9,999,999. If the DXF file contains
coordinates outside this range, they may be modified using the Calculate XYs routine after the file has been
imported. However, it is best to correct the original drawing and recreate the DXF so that the modifications
will not need to be done again, if the drawing is ever re-imported.
! Do not leave empty rows between entries in the Pipe Layers list. Do not include extraneous data on the
layers selected for importing. GASWorkS does not know the difference between a line intended to represent
a pipe, and a line intended to represent a street right-of-way. Or, a block representing a customer location
and a block representing a fire hydrant. Imported layers should contain only the graphics representing the
features for which they have been selected.
! The Translation routine cannot sense your intentions. The drawing used to create the DXF should
accurately reflect the intended topology (connectivity) of the model to be created. The following table lists
some common mistakes made when working with DXF files:

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

394

GASWorkS 9.0

Import Routines
Table Of Contents

Problem

Comments

Lines are not broken at


intersections in the drawing.

Nodes are only placed at the beginning and end of the linear
entities found on the designated Pipe Layers. Often a long single
unbroken line is drawn along several blocks of a street. The
laterals coming off this line will create nodes at their ends and
it will appear that there is a node at the intersection, however
because the line being connected to it is not broken at the
intersections, no nodes are placed at the lateral connections.
To remedy this problem by breaking all lines at all intersections
where a connection to another line is intended.

Nodes appear at locations


other than pipe intersections.

This often occurs because multi-segment lines are created using


a combination of several line and/or arc segments. These types
of lines should be constructed of polyline segments to accurately
reflect the model connectivity.
To remedy this problem convert and join the individual line
segments into a single multi-segment polyline which is
continuous between the intended pipe ends.

Many nodes appear around


valve and regulator symbols.

This occurs because the symbol is depicted by a small


drawing of the symbol and the line work representing the
symbol is contained on the designated Pipe Layer.
To remedy the problem use blocks to depict the symbols,
and/or move the line work representing the symbols to a
separate (unique and individual) layer.

The length of pipes in the


GASWorkS model are twelve
times longer than they were
in the original drawing.
(DXF from AutoCAD)

This occurs when using AutoCAD and architectural units are


used in the original drawing. When a DXF file is created from
a drawing with these units, the resulting coordinate values are
represented in Inches instead of the standard Feet units.
To remedy this problem, change the drawing units to
engineering and rescale the drawing. Or, set the appropriate
coordinate dimensional units when importing the file. Or,
rescale the model in GASWorkS after it has been imported - use
a scale factor of 0.08333 (1/12).

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

395

GASWorkS 9.0

Import Routines
Table Of Contents

Problem

Comments

The coordinate values in the


GASWorkS model are
different than the original
drawing. (DXF from
MicroStation)

This occurs when creating a DXF file from MicroStation.


MicroStation does not internally store the graphical
representation of the drawing in true coordinates, but uses
positional units to represent the drawing. When the DXF is
created, the positional units are reported in the file as opposed
to the true coordinates (working units).
To remedy this problem, set the Translation Units to Master
when exporting (creating) the DXF from MicroStation. Or,
rescale the model in GASWorkS after its has been imported.

! The GASWorkS GDI provides tools for repairing many of the problems listed in the previous table.
However, it is best to correct the original drawing and recreate the DXF so that the modifications will not
need to be done again, if the drawing is ever re-imported.
! After importing, the Flag Unbroken Intersections command can be used to find and mark locations where
the header pipe may not be broken (tapped) at a lateral intersection. Once flagged, the locations can be
reviewed and manually corrected using the Tap Pipe command, or automatically corrected using the Break
Flagged Intersections command.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

396

GASWorkS 9.0

Import Routines
Table Of Contents

Import MIF/MID Files


GASWorkS provides a routine for importing GIS files meeting the shape (MIF/MID) file format of MapInfo.
The files may be created by a MapInfo GIS package, or by another package supporting the MIF/MID file
format.
An advantage of using the MIF/MID file format is that the file contains both graphic and attribute
information. The MIF file portion of this format contains the geographic information. The MID portion
contains the attribute data in an ASCII format.
GASWorkS supports MIF/MID files containing pipe and customer data. A complete GASWorkS model can
be created from just a pipe file. Or, if customer data is available, it can be included to create a more
comprehensive model.
The file contents of the attribute data file must be defined before the file can be imported. During the import
process, the appropriate ASCII File Format screen will be displayed. Enter the appropriate definition, then
select the Continue command button to complete the translation.
The translations are performed as follows:
Import Type

Translation Description

Customer

The customer locations are taken from the geographic data file (MIF file). The
file must contain point type data features. After the customer locations have been
created, the attribute data is read from the attribute data file (MID file). See the
Import ASCII Files topic in this section of the Manual for information on
specifying the attribute data file definition and additional considerations.
When the Merge routine is chosen, matching between the existing model and the
new data is performed geographically. If an existing customer is found within the
fuzzy tolerance of a new customers X-Y location, a match is assumed.
The first time that the GDI is opened after the customer file is imported, a prompt
will appear asking whether to automatically assign the customers. Enter an
appropriate response. See the ASCII Import Files Notes & Considerations section
for additional information on this process.
Generally the customer data should be imported after the pipe data has been
created.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

397

GASWorkS 9.0

Import Routines
Table Of Contents

Import Type

Translation Description

Pipe

The pipe locations are taken from the geographic data file (MIF file). Only arc,
line, and polyline type data features will be processed into pipes. After the
pipe locations have been created, the attribute data is read from the attribute data
file (MID file). See the Import ASCII Files topic in this section of the Manual for
information on specifying the attribute data file definition and additional
considerations. If a node shape file is to be imported, perform the import prior
to importing the pipe file.
When the Merge routine is chosen, matching between the existing model and the
new data is performed geographically. If an existing pipes From and To Node
is found within the fuzzy tolerance of a new pipes node X-Y locations, a match
is assumed.
Arc type data features which do not represent true circular curves are processed
as a two-point line type.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

398

GASWorkS 9.0

Import Routines
Table Of Contents

Import Shape (SHP) Files


GASWorkS provides a routine for importing GIS files meeting the shape (SHP) file format of Environmental
Systems Research Institute (ESRI). The files may be created by an ESRI GIS package, or by another package
supporting the SHP file format.
An advantage of using the SHP file format is that the file contains both graphic and attribute information.
Actually a SHP file consists of at least three separate files. A shape file which ends in a .shp extension this file contains the geographic information. A data file which ends in a .dbf extension - this file contains
the attribute data in a dBASE III format. An index file which ends in an .shx extension - this file contains
relationship information that links the geographic and attribute data.
GASWorkS supports shape files containing node, pipe, customer, regulator, and attribute valve data. A
complete GASWorkS model can be created from just a pipe file. Or, if customer data is available, it can be
included to create a more comprehensive model. Generally a node file is not required or desired.
The file contents of the attribute data file must be defined before the file can be imported. During the import
process, the appropriate dBASE File Format screen will be displayed. Enter the appropriate definition, then
select the Continue command button to complete the translation.
The translations are performed as follows:
Import Type

Translation Description

Customer

The customer locations are taken from the geographic data file (SHP file). The
file must contain point type data features. After the customer locations have been
created, the attribute data is read from the attribute data file (DBF file). See the
Import dBASE Format Files topic in this section of the Manual for information
on specifying the attribute data file definition and additional considerations.
When the Merge routine is chosen, matching between the existing model and the
new data is performed geographically. If an existing customer is found within the
fuzzy tolerance of a new customers X-Y location, a match is assumed.
The first time that the GDI is opened after the customer file is imported, a prompt
will appear asking whether to automatically assign the customers. Enter an
appropriate response. See the Import dBASE Format Files Notes &
Considerations section for additional information on this process.
Generally the customer data should be imported after the pipe data has been
created.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

399

GASWorkS 9.0

Import Routines
Table Of Contents

Import Type

Translation Description

Node

The node locations are taken from the geographic data file (SHP file). The file
must contain point type data features. After the node locations have been created,
the attribute data is read from the attribute data file (DBF file). See the Import
dBASE Format Files topic in this section of the Manual for information on
specifying the attribute data file definition and additional considerations. If a
node shape file is to be imported, perform the import prior to importing the pipe
file.
When the Merge routine is chosen, matching between the existing model and the
new data is performed geographically. If an existing node is found within the
fuzzy tolerance of a new nodes X-Y location, a match is assumed.

Pipe

The pipe locations are taken from the geographic data file (SHP file). The file
must contain arc type data features. After the pipe locations have been created,
the attribute data is read from the attribute data file (DBF file). See the Import
dBASE Format Files topic in this section of the Manual for information on
specifying the attribute data file definition and additional considerations. If a
node shape file is to be imported, perform the import prior to importing the pipe
file.
When the merge option is selected, matching between the existing model and the
new data is performed geographically. If an existing pipes From and To Node
is found within the fuzzy tolerance of a new pipes node X-Y locations, a match
is assumed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

400

GASWorkS 9.0

Import Routines
Table Of Contents

Import Type

Translation Description

Regulator

Some special considerations need to be accommodated in order for the regulator


Import routine to work effectively. The data must be contained in a point type
SHP File and must contain a field which identifies the upstream and downstream
pipe Link Identification (Link ID) Numbers. This information establishes the
orientation of the regulator.
The regulator locations are read from the geographic data file (SHP file),
however they are not currently used as part of the import process. The location
of the regulator is automatically set by the Import routine as described below.
After the regulator locations have been read, the pipe Link ID and attribute data
is read from the attribute data file (DBF file). The Link ID data is used to
establish the upstream and downstream pipes. Once the upstream and
downstream pipes have been found, the regulator is inserted into the upstream
end of the downstream pipe. The common node between the upstream and
downstream pipes is used as the inlet (From) node of the regulator. A new node
is created one-quarter of the length of the downstream pipe, downstream of the
From node. The new node represents the To node of the regulator and end node
of downstream pipe. The original length of the downstream pipe is maintained.
For best results, the downstream pipe should be a two-point type line feature - a
line without vertices.
The Merge routine option for this data type is not supported for models that
already contain existing regulator features.

Valve
(Attribute)

The valve locations are taken from the geographic data file (SHP file). The file
must contain point type data features. After the valve locations have been
created, the attribute data is read from the attribute data file (DBF file).
When the Merge routine is chosen, matching between the existing model and the
new data is performed geographically. If an existing valve is found within the
fuzzy tolerance of a new valves X-Y locations, a match is assumed.
After importing the file, use the Assign Attribute Valves command to link the
valves to their associated mains.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

401

GASWorkS 9.0

Import Routines
Table Of Contents

When importing a set of SHP files, the general order for processing the various files is: Node data, Pipe
data, Regulator data, Customer data, Valve data. Generally a node file is not used or desired. At a minimum
a pipe file must be included. Regardless of which files are used, the first file should be imported, the
subsequent files should be merged. It is suggested that the model be reviewed after the pipe data has been
processed. Any configuration or connectivity issues should be resolved before processing additional data
types.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

402

GASWorkS 9.0

Import Routines
Table Of Contents

Import Stoner PD/XY Files


GASWorkS provides a routine for importing Stoner & Associates "PD" & XY format files. The files may
be created by a Stoner modeling package, or by another package supporting the PD file format. The routine
is based on our best knowledge of the Stoner files.
There is some variation in the PD file format, depending on the Stoner program version that created the file.
Some files may or may not import correctly.
Not all options supported by the Stoner modeling software are supported by GASWorkS - messages may
appear during the import process warning of unsupported options. After the import, you will need to correct
any inconsistencies resulting from unsupported options before attempting to solve the imported model.
If an XY file is detected during the Import routine, the graphical data contained in the XY file will be
assigned to the pipes and nodes imported from the PD file.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

403

GASWorkS 9.0

Import Routines
Table Of Contents

Import XLS Format Files


When importing an XLS format file, GASWorkS requires the User to specify the layout of the import file.
The file definition is described using the associated Database File Format screen. The screen contents and
functionality are the same as those described in the Import dBASE Format Files topic in this section of the
Manual.
Depending on the selected format, GASWorkS expects the source file to be in a Microsoft Excel version 4.0
Worksheet or Microsoft Excel version 8.0 Workbook format. Version 8.0 format files must contain a single
worksheet.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

404

GASWorkS 9.0

Import Routines
Table Of Contents

Import X-Y Customer Files


An X-Y Customer file is an ASCII format file which contains the X-Y coordinates for each customer
location. Each line in the file must contain an identification number, address, or alias value followed by the
X-coordinate value, then the Y-coordinate value. The identifier and coordinate values must be separated by
a comma (,). The match item is specified using the Customer X-Y Specification screen. The features
associated with the screen are described as follows.

Customer X-Y Specification Screen

Data Items
Match On Which Data Item - When merging, this item is a group of option buttons used to specify which
data item to attempt to match customers. Or, when importing, this item is a group of option buttons used to
specify which data item is included in the source file. Select the desired option.

Command Buttons
Cancel - A command button used to close the screen without proceeding with the routine.
Continue - A command button used to proceed with the routine.

Notes & Considerations


! The GASWorkS GDI supports coordinate values in the range from 0 to 9,999,999. If the X-Y file contains
coordinate values outside this range, they may be modified using the Calculate XYs routine after the file
has been imported.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

405

GASWorkS 9.0

Import Routines
Table Of Contents

! The import process reads each record in the X-Y file and will try to find a matching customer in the target
file. If a match is found, the coordinate values are assigned to the customer. The next time the model is
displayed in the GDI after importing the customer coordinates, the "service line" coordinates will be created.
! When merge is used, the routine will try to find an existing customer record which matches the specified
match item. If a match is found, the coordinate values for the matching record will be replaced with those
from the source file. The service line locations will be set to 0,0 if a match is found - this ensures that the
lines will be properly located in case that customer location has moved. If a match is not found, a new
customer feature will be added to the target file.
! When the model is opened in the GDI after the translation, a message will appear asking whether to create
the service line assignments. Select the Yes command button to automatically create the service lines. The
customers and service lines will be assigned and attached to the geographically closest pipe. When a service
line is created, where possible, the location of the connection to the assigned pipe is placed at a point that
would cause the service line to be perpendicular from the main to the center of the customer location. After
the customer assignments have been made and corrected, remember to update the model loads by executing
the Update External Loads routine found in the Customer Data submenu of the Utilities menu list.
! The Customer ID Number refers to the customer Link ID data item.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

406

GASWorkS 9.0

Import Routines
Table Of Contents

Import X-Y Node Files


An X-Y Node file is an ASCII format file which contains the X-Y coordinates for each node. Each line in
the file must contain a node name value followed by the X-coordinate value, then the Y-coordinate value.
The node name and coordinate values must be separated by a comma (,).
The GASWorkS GDI supports coordinate values in the range from 0 to 9,999,999. If the X-Y file contains
coordinate values outside this range, they may be modified using the Calculate XYs routine after the file
has been imported.
When the Merge routine is used, the import process reads each record in the X-Y file and will try to find a
matching node name in the target GASWorkS file. If a match is found, the coordinate values are assigned
to the node. If a match is not found, a new node feature will be added to the target file.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

407

GASWorkS 9.0

Import Routines
Table Of Contents

Import X-Y Valve Files


An X-Y Valve file is an ASCII format file which contains the X-Y coordinates for each valve. Each line in
the file must contain a valve number value followed by the X-coordinate value, then the Y-coordinate value.
The valve number and coordinate values must be separated by a comma (,).
The GASWorkS GDI supports coordinate values in the range from 0 to 9,999,999. The X-Y file must contain
coordinate values within this range.
When the Merge routine is chosen, matching between the existing model and the new data is performed
geographically. If an existing valve is found within the fuzzy tolerance of a new valves X-Y location, a
match is assumed.
After importing the file, use the Assign Attribute Valves command to link the valves to their associated mains.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

408

GASWorkS 9.0

Export Routines
Table Of Contents

EXPORT ROUTINES

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

409

GASWorkS 9.0

Export Routines
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

410

GASWorkS 9.0

Export Routines
Table Of Contents

Exporting Files
This section of the Manual provides descriptions and requirements for exporting data from GASWorkS into
a supported file format. Where an additional data screen is used to further define the export specifications,
it will be described in the associated section. The Help System contains a variety of step-by-step examples
of exporting various data files.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

411

GASWorkS 9.0

Export Routines
Table Of Contents

Export ASCII Customer Files


Individual customer files can be exported to an ASCII customer file. When exporting an ASCII Customer
file, a single comma delimited ASCII text file will be created.
The basic customer model data is always included in the exported file. If an attribute data file is attached,
the items contained in the attribute data file will also be included in the exported file.
A description of the various items included in the exported file are described in the following tables. Each
item is separated by a comma (,). Each line of the file represents one record from the customer data file.
String (character) values are enclosed between double quotes ( ).
ASCII Customer File Description - Model Data
Field #

Field Description

Internal Identification Number of the Customer

Link Identification Number of the Customer

Link Identification Number of the Supplying Pipe (Main)

Record Number in the Pipe Data File of the Supplying Pipe (Main)

Load Assignment indicator...


BOTH = Assigned (one-half) to both of the pipes nodes
FROM = Assigned to the pipes From Node
NEITHER = Not assigned
TO = Assigned to the pipes To Node
DIV-WET<76 = Diversified - Wet Central Heat - Pre 1977 type
DIV-WET>77 = Diversified - Wet Central Heat - Post 1976 type
DIV-NON_OLD = Diversified, non-central older construction type
DIV-NON_NEW = Diversified, non-central newer construction type

Per Unit Load

Per Unit Load dimensional unit

Unit Count

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

412

GASWorkS 9.0

Export Routines
Table Of Contents

ASCII Customer File Description - Model Data


Field #
9

Field Description
Load Status...
ON = Load is turned on
OFF = Load is turned off

10

X (horizontal) Coordinates of the Customers Location

11

Y (vertical) Coordinates of the Customers Location

12

X (horizontal) Coordinates of the Service Lines Connection to the Main

13

Y (vertical) Coordinates of the Service Lines Connection to the Main

14

Attribute Connection Status...


NO = Customer is not linked to the attribute data file (if present)
YES = Customer is linked to the attribute data file (if present)

15

Attribute Data items. If an attribute data file is attached and turned on, and the link
connection status is YES, the contents of the attribute data file associated with the
customer, will be included in the export file. The content of the attribute section varies
according to the content of the attached attribute data file.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

413

GASWorkS 9.0

Export Routines
Table Of Contents

Export ASCII Node Files


Individual node files can be exported to an ASCII node file. When exporting an ASCII Node file, a single
comma delimited ASCII text file will be created.
A description of the various items included in the exported file are described in the following table. Each
item is separated by a comma (,). Each line of the file represents one record from the node data file. String
(character) values are enclosed between double quotes ( ).
ASCII Node File Description
Field #

Field Description

Node Name

Pressure value

Pressure dimensional unit

Pressure Known indicator...


NO = Unknown
YES = Known

Base Load - This item represents the unadjusted Base Load for the node.

Base Load Known indicator...


NO = Unknown
YES = Known

Base Load Adjustment Flag...


NO = Do not adjust by Design Factor.
YES = Adjust by Design Factor.

Base Load Status...


OFF = The Base Load is turned off.
ON = The Base Load is turned on.

External Load - This item represents the unadjusted external load for the node.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

414

GASWorkS 9.0

Export Routines
Table Of Contents
ASCII Node File Description

Field #
10

Field Description
External Load Adjustment Flag...
NO = Do not adjust by Design Factor.
YES = Adjust by Design Factor.

11

External Load Status...


OFF = The Base Load is turned off.
ON = The Base Load is turned on.

12

Total Load - This item represents the Total Adjusted Load for the node.

13

Load dimensional unit

14

Average Flowing Temperature value

15

Average Flowing Temperature dimensional unit

16

Temperature Known indicator...


NO = Unknown
YES = Known

17

Elevation value

18

Elevation dimensional unit

19

Atmospheric Pressure value

20

Atmospheric Pressure dimensional unit

21

Specific Gravity value

22

Viscosity value

23

Viscosity dimensional unit

24

Heating Value

25

Heating Value dimensional unit

26

Specific Heat Ratio value

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

415

GASWorkS 9.0

Export Routines
Table Of Contents
ASCII Node File Description

Field #
27

Field Description
Gas Properties Known indicator...
NO = Unknown
YES = Known

28

X (east-west) Node Location

29

Y (north-south) Node Location

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

416

GASWorkS 9.0

Export Routines
Table Of Contents

Export ASCII Pipe Files


Individual pipe files can be exported to an ASCII pipe file. When exporting an ASCII Pipe file, a single
comma delimited ASCII text file will be created.
A description of the various items included in the exported file are described in the following table. Each
item is separated by a comma (,). Each line of the file represents one record from the pipe data file. String
(character) values are enclosed between double quotes ( ).
Items 1-15 are the same for all element types. Items 16 and higher vary according to element type.
Pipe Section Description
Field #

Field Description

Internal Identification Number of the Segment

Link Identification Number of the Segment

From Node Name

To Node Name

Hydraulic Type...
C = Compressor
F = Fitting
P = Pipe
R = Regulator
V = Valve
W = Well

Status
OFF = Segment is turned off.
ON = Segment is turned on.

Flow Rate - A negative value indicates that the flow direction is from the To Node
to the From Node.

Flow Rate dimensional unit

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

417

GASWorkS 9.0

Export Routines
Table Of Contents
Pipe Section Description

Maximum Velocity - This item is not reported for non-pipe element types.

10

Velocity dimensional unit

11

Linear Pressure Drop value

12

Linear Pressure Drop dimensional unit

13

Compressibility Factor value

14

Facility Type

15

Attribute Connection Status...


NO = Segment is not linked to the attribute data file (if present).
YES = Segment is linked to the attribute data file (if present).
Compressor Type Element

16

Size/Type Code

17

Set Pressure value

18

Set Pressure dimensional unit

19

Mechanical Efficiency
Fitting Type Element

16

Flow Equation name

17

Size/Type Code

18

Inside Diameter value

19

Inside Wall Roughness value

20

Diameter and Roughness dimensional unit

21

Length value

22

Length dimensional unit

23

Efficiency value

24

Efficiency dimensional unit

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

418

GASWorkS 9.0

Export Routines
Table Of Contents
Pipe Section Description
Pipe Type Element

16

Flow Equation name

17

Size/Type Code

18

Inside Diameter value

19

Inside Wall Roughness value

20

Diameter and Roughness dimensional unit

21

Length value

22

Length dimensional unit

23

Efficiency value

24

Efficiency dimensional unit

25

Allow Size Calculation indicator...


NO = Do not allow sizing of this segment.
YES = Allow the segment to be sized.

26

Attached Fitting Count

27

Equivalent Length of the attached fittings

28

Attached Customer Count


Regulator Type Element

16

Size/Type Code

17

Set Pressure value

18

Set Pressure dimensional unit


Valve Type Element

16

Size/Type Code

17

Open Position - Expressed as a percentage of full open

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

419

GASWorkS 9.0

Export Routines
Table Of Contents
Pipe Section Description
Well Type Element

18

Size/Type Code

19

Equation Coefficient value

20

Equation Exponent value


Attribute Data

...

Attribute Data items. If an attribute data file is attached and turned on, and the link
connection status is YES, the contents of the attribute data file associated with the
segment, will be included in the export file. The content of the attribute section varies
according to the content of the attached attribute data file.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

420

GASWorkS 9.0

Export Routines
Table Of Contents

Export dBASE Customer Files


Individual customer files can be exported to a dBASE customer file. When exporting to a dBASE Customer
file, a single dBASE III (3.0) database file will be created.
The basic customer model data is always included in the exported file. If an attribute data file is attached,
the items contained in the attribute data file will also be included in the exported file.
A description of the various items included in the exported file are described in the following table. Each
record in the database represents one record from the customer data file.
dBASE Customer File Description - Common Section
Field #

Field Name

GW_ID

Contents

Field Type

Internal Identification Number of the Customer

LINK_ID

Link Identification Number of the Customer

C,20

PIPE_ID

Link Identification of the Assigned Supply Pipe


(Main)

C,20

PIPE_NO

Record Number in the Pipe Data File of the Assigned


Supply Pipe (Main)

NODE_ASGN

Load Assignment indicator...

C,11

BOTH = Assigned (one-half) to both of the pipes


nodes
FROM = Assigned to the pipes From Node
NEITHER = Not assigned
TO = Assigned to the pipes To Node
DIV-WET<76 = Diversified, wet central pre 1976
type
DIV-WET>77 = Diversified, wet central post 1976
type
DIV-NON_OLD = Diversified, non-central older
construction type
DIV-NON_NEW = Diversified, non-central newer
construction type

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

421

GASWorkS 9.0

Export Routines
Table Of Contents

dBASE Customer File Description - Common Section


Field #

Field Name

Contents

TOT_LOAD

TQ_UNIT

COUNT

Unit Count

STATUS

Load Status...

Field Type

Per Unit Load

Per Unit Load dimensional unit

C,10
I
C,3

ON = Load is turned on
OFF = Load is turned off
10

X_COORD

X (east-west) Location of the Customer

11

Y_COORD

Y (north-south) Location of the Customer

12

SX_COORD

X (east-west) Location of the Service Line


Connection to the Main

13

SY_COORD

Y (north-south) Location of the Service Line


Connection to the Main

14

LINK_OK

Attribute Connection Status..

C,3

NO = Customer is not linked to the attribute data


file (if present)
YES = Customer is linked to the attribute data file (if
present)
15...

Varies

Attribute Data items. If an attribute data file is


attached and turned on, and the link connection
status is YES, the contents of the attribute data file
associated with the customer, will be included in the
export file. The content of the attribute section varies
according to the content of the attached attribute data
file.

Varies

Field Type Definitions


C,X = Character type, X characters wide
D = Double precision number, maximum 15 digits
I = Integer
L = Long integer
S = Single precision number, maximum 7 digits

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

422

GASWorkS 9.0

Export Routines
Table Of Contents

Export dBASE Node Files


Individual node files can be exported to a dBASE customer file. When exporting to a dBASE Customer file,
a single dBASE III (3.0) database file will be created.
A description of the various items included in the exported file are described in the following table. Each
record in the database represents one record from the node data file.
dBASE Node File Description
Field #

Field Name

NODENAME

PRESSURE

P_UNIT

PKNOWN

Contents

Field Type

Node Name

C,40

Pressure value

Pressure dimensional unit

C,10

Pressure Known indicator...

C,3

NO = Unknown
YES = Known
5

BASE_LOAD

BASE_KNOWN

Base Load - This item represents the Unadjusted


Base Load for the Node.
Base Load Known indicator...

S
C,3

NO = Unknown
YES = Known
7

BASE_DF

Base Load Adjustment Flag...

C,3

NO = Do not adjust by Design Factor.


YES = Adjust by Design Factor.
8

BASE_STAT

Base Load Status...

C,3

OFF = The Base Load is turned off.


ON = The Base Load is turned on.
9

EXT_LOAD

Bradley B Bean PE

External Load - This item represents the


Unadjusted External Base Load for the Node.

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

423

GASWorkS 9.0

Export Routines
Table Of Contents
dBASE Node File Description

Field #

Field Name

10

EXT_DF

Contents

Field Type

External Load Adjustment Flag...

C,3

NO = Do not adjust by Design Factor.


YES = Adjust by Design Factor.
11

EXT_STAT

External Load status...

C,3

OFF = The Base Load is turned off.


ON = The Base Load is turned on.
12

TOT_ADJ_Q

13

Q_UNIT

14

TEMP

15

T_UNIT

16

T_KNOWN

Total Load - This item represents the Total


Adjusted Load for the Node.
Load dimensional unit

S
C,10

Average Flowing Temperature value

Temperature dimensional unit

C,10

Temperature Known indicator...

C,3

NO = Unknown
YES = Known
17

ELEVATION

18

Z_UNIT

Elevation dimensional unit

C,10

19

P_ATM

Atmospheric Pressure value

20

PA_UNIT

21

SG

22

VISCOSITY

23

V_UNIT

24

HV

25

HV_UNIT

Heating Value dimensional unit

26

S_HEAT

Specific Heat Ratio value

Bradley B Bean PE

Elevation value

Atmospheric Pressure dimensional unit

C,10

Specific Gravity value

Viscosity value

Viscosity dimensional unit

C,10

Heating Value

S
C,10
S

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

424

GASWorkS 9.0

Export Routines
Table Of Contents
dBASE Node File Description

Field #

Field Name

27

GP_KNOWN

Contents
Gas Properties Known indicator...

Field Type
C,3

NO = Unknown
YES = Known
28

X_COORD

X (east-west) Node Location

29

Y_COORD

Y(north-south) Node Location

Field Type Definitions


C,X = Character type, X characters wide
D = Double precision number, maximum 15 digits
I = Integer
S = Single precision number, maximum 7 digits

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

425

GASWorkS 9.0

Export Routines
Table Of Contents

Export dBASE Pipe Files


Individual pipe files can be exported to a dBASE pipe file. When exporting to a dBASE pipe file, a single
dBASE III (3.0) database file will be created.
The basic pipe model data is always included in the exported file. If an attribute data file is attached, the
items contained in the attribute data file will also be included in the exported file.
A description of the various items included in the exported file are described in the following table. Each
record in the database represents one record from the pipe data file.
dBASE Pipe File Description
Field #

Field Name

GW_ID

LINK_ID

FROM_NODE

4
5

Contents

Field Type

Internal Identification Number for the Segment

Link Identification Number for the Segment

C,20

Name of the Segment's From Node

C,40

TO_NODE

Name of the Segment's To Node

C,40

HYD_TYPE

Hydraulic Type...

C,1

C = Compressor
F = Fitting
P = Pipe
R = Regulator
V = Valve
W = Well
6

STATUS

Operational Status

C,3

OFF = Segment is turned off.


ON = Segment is turned on.
7

FLOW

Q_UNIT

Bradley B Bean PE

Flow Rate - A negative value indicates that the flow


direction is from the To Node to the From Node.
Flow Rate dimensional unit

S
C,10

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

426

GASWorkS 9.0

Export Routines
Table Of Contents
dBASE Pipe File Description

Field #

Field Name

Contents

Field Type

VELOCITY

Maximum Velocity - This item is not reported for


non-pipe element types.

10

VEL_UNIT

Velocity dimensional unit

C,10

11

DP

Linear Pressure Drop value

12

P_UNIT

13

Z_FACTOR

Compressibility Factor value

14

FACILITY

Facility Type

C,20

15

LINK_OK

Attribute Connection Status...

C,3

Linear Pressure Drop dimensional unit

C,10
S

NO = Segment is not linked to the attribute data file


(if present).
YES = Segment is linked to the attribute data file
(if present).
16

EQUATION

Flow Equation name (Pipe & Fitting types only)

C,20

17

SIZE_TYPE

Size/Type Code

C,20

18

DIAMETER

Inside Diameter value (Pipe & Fitting types only)

19

ROUGHNESS

Internal Pipe Wall Roughness value (Pipe & Fitting


types only)

20

D_UNIT

Diameter dimensional unit (Pipe & Fitting types


only)

21

LENGTH

Length value (Pipe & Fitting types only)


Set Pressure value (Compressor & Regulator types
only)
Position (Valve type only)
Equation Coefficient (Well type only)

22

L_UNIT

Length dimensional unit (Pipe & Fitting types only)


Set Pressure dimensional unit (Compressor &
Regulator types only)

C,10

Bradley B Bean PE

C,10

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

427

GASWorkS 9.0

Export Routines
Table Of Contents
dBASE Pipe File Description

Field #

Field Name

Contents

Field Type

23

EFFICIENCY

Efficiency value (Compressor, Pipe & Fitting types


only)
Equation Exponent (Well type only)

24

E_UNIT

Efficiency dimensional unit (Compressor, Pipe &


Fitting types only)

C,10

25

SIZE_OK

Allow Size Calculation indicator...

C,3

NO = Do not allow sizing of this segment.


YES = Allow sizing of this segment.
26

FITTINGS

Attached Fitting Count

27

EQ_LENGTH

Equivalent Length of the Attached Fittings

27

CUSTOMERS

Attached Customer Count

...

Varies

Attribute Data items. If an attribute data file is


attached and turned on, and the link connection
status is YES, the contents of the attribute data file
associated with the pipe, will be included in the
export file. The content of the attribute section varies
according to the content of the attached attribute data
file.

Varies

Field Type Definitions


C,X = Character type, X characters wide
D = Double precision number, maximum 15 digits
I = Integer
L = Long integer
S = Single precision number, maximum 7 digits

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

428

GASWorkS 9.0

Export Routines
Table Of Contents

Export DXF Files


GASWorkS provides a routine for exporting a DXF file. The contents of the exported file can be specified
by the User. The export settings are specified using the DXF Export Options screen. The features associated
with the screen are described as follows.

DXF Export Options Screen

Data Items
Customer Items - A checkbox used to indicate whether the Customer Items list will be enabled. Select
(check) this option if desired. When enabled, select (check) the items to be included in the exported DXF
file.
Customer Symbol Size - A data field used to enter the size of the customer symbols in the exported DXF
file. Enter a value by typing it into the data field. The value is expressed in model coordinate units. Customer
symbols are represented in the DXF file by a block entity. The Customer Symbol Size value specifies the X
and Y scale for the block entity.
Data Text Size - A data field used to enter the size of the data text values in the exported DXF file. Enter
a value by typing it into the data field. The value is expressed in model coordinate units. This value only
applies to text values derived from pipe, node, or customer data values. It does not change the size of the
User Text features.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

429

GASWorkS 9.0

Export Routines
Table Of Contents

Dimensional Units - A checkbox used to indicate whether the dimensional units will be included in the
exported DXF file. Select (check) this option if desired. For example if selected (checked), pressure values
will be followed by their assigned pressure unit ("25 Psi").
Include Extended Entity Data - A checkbox used to indicate whether certain extended entity data will be
included in the exported DXF file. Select (check) this option if desired. See the following Notes &
Considerations section for additional information on this option.
Node Items - A checkbox used to indicate whether the Node Items list will be enabled. Select (check) this
option if desired. When enabled, select (check) the items to be included in the exported DXF file.
Node Size - A data field used to enter the size of the node symbols in the exported DXF file. Enter a value
by typing it into the data field. The value is expressed in model coordinate units. Node symbols are
represented in the DXF file by a block entity. The Node Size value specifies the X and Y scale for the block
entity.
Pipe Items - A checkbox used to indicate whether the Pipe Items list will be enabled. Select (check) this
option if desired. When enabled, select (check) the items to be included in the exported DXF file.
User Text - A checkbox used to indicate whether the User Text Features are to be included in the exported
DXF file. Select (check) this option if desired.
Variable Identifiers - A checkbox used to indicate whether the variable identifiers are to be included in the
exported DXF file. Select (check) this option if desired. For example if selected (checked), the pressure
values will be preceded by the string "P =".

Command Button
Cancel - A command button used to close the screen without proceeding with the routine.
Continue - A command button used to proceed with the routine.

Notes & Considerations


! The DXF Export routine creates a Drawing Interchange Format file. Once created, the file can be imported
into or used directly with a variety of CAD or graphics packages.
! GASWorkS attempts to match the colors found in the model with the colors supported in the DXF file.
Please be aware that matching is not always possible. Color values may need to be adjusted after the file has
been opened in its destination application.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

430

GASWorkS 9.0

Export Routines
Table Of Contents

! The contents of the exported file are described in the following table:
DXF Export File Description
Section Name

Contents

Header

Point size and mode definitions.

Tables

Layer Definitions for the various data layers. Node features are placed on the
GWNODE layer. Node name text is placed on the GWNODETX layer. Pipe
features are placed on the GWPIPE layer. And the Pipe Size text is placed on
the GWPIPETX layer. Other layers may be present.
Block definition for node and customer symbols.
Application definition for GW90DATA if the Include Extended Entities option
was selected.

Entities

Definitions for the node point and text features.


Definitions for the pipe (line) and text features.
Definitions for the customer location and text features.
Definitions for the User Text features.

! If the destination application does not read the header section of the DXF file, the layer, block, and
application information may not be processed correctly. If this occurs, the imported features may need to be
manually moved to the appropriate layers after importing into the destination application.
! If the Include Extended Entity Data option is selected (checked), an application named GW90DATA"
will be registered in the DXF file. In addition to the required graphic data, each pipe, node, or customer
feature will also include extended entity data which includes the features unique identification. For pipes and
customers, the identifier is the Internal Identification Number. For nodes, the identifier is the Node Name.
! Generally the Graphics or Graphic Symbols items should always be selected (checked) when including
Customer, Node, or Pipe Items. For pipes, Graphics refers to the graphic lines that show the pipe location.
For nodes, Graphic Symbols refers to the block symbols that show the node locations. For customers,
Graphic Symbols refers to the block symbols that show the customer locations.
! If the Individual Layers option in the Pipe Items list is selected (checked), pipes will be grouped on
layers representing each unique pipe size. For example, all pipes with a Size/Type Code equal to 2P, will
be placed on a layer named GWPIPE_2P in the DXF file.
! Select (check) the Attribute Valves option in the Pipe Items list to include attribute valves and their
associated number in the DXF file.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

431

GASWorkS 9.0

Export Routines
Table Of Contents

Export GASWorkS 7.0 Files


Older versions of the GASWorkS model files may be created using either the Export or Quick Export
routines. When exporting to a GASWorkS 7.0 file, a set of GASWorkS 7.0 compatible model files is created.
Because the older version of GASWorkS does not support all of the data fields supported by the newer
version, some data loss will occur when exporting to the older version.
Attribute data will not be exported when creating the older files.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

432

GASWorkS 9.0

Export Routines
Table Of Contents

Export Microsoft Access Files


GASWorkS provides a routine for creating a Microsoft Access database from a GASWorkS model. The
routine is only available using the Quick Export routine. When exporting to an Access file, an Access
compatible database (MDB extension) will be created. The file may be opened and manipulated using any
application which supports that format.
The contents of the exported file are similar to the items listed in the Export dBASE Customer, Node, and
Pipe Files sections. Refer to those sections for a description of the data items included in the file.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

433

GASWorkS 9.0

Export Routines
Table Of Contents

Export Microsoft Excel Files


GASWorkS provides a routine for creating Microsoft Excel spreadsheet files from a GASWorkS model. The
4.0 Worksheet format is supported by either the Export or the Quick Export routines. The 5.0 Workbook
format is only supported by the Quick Export routine. The 8.0 format is supported as a single sheet
Workbook format by the Export routine, or as a multi-sheet Workbook by the Quick Export routine.
When exporting to an Excel 4.0 or 8.0 using the Export routine, an individual worksheet (XLS extension)
will be created for the associated model feature. When the 4.0 format is exported using the Quick Export
routine, a set of worksheets is created - one sheet/file for each associated data feature. The files may be
opened and manipulated using any application which supports the associated Excel format.
When exporting to an Excel 5.0 or 8.0 Workbook, a single workbook (XLS extension) with multiple
worksheets, will be created. The file may be opened and manipulated using any application which supports
the associated Excel format.
The contents of the exported file are similar to the items listed in the Export dBASE Customer, Node, and
Pipe Files sections. Refer to those sections for a description of the data items included in the file.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

434

GASWorkS 9.0

Export Routines
Table Of Contents

Export Shape (SHP) Files


GASWorkS provides a routine for creating Shape (SHP) files from a GASWorkS model. The routine is
available using either the Export or the Quick Export routines.
When exporting to a SHP file using the Export routine, an individual set of shape files will be created for
the associated model feature. When exported using the Quick Export routine, a group of shape file sets is
created - one set for each associated data feature. The files may be opened and manipulated using any
application which supports the ESRI Shape format.
The shape file set includes a geographic file (SHP extension), an Attribute Database file (DBF extension),
and an index file (SHX extension). The contents of the Attribute Database files are similar to the items listed
in the Export dBASE Customer, Node, and Pipe Files sections. Refer to those sections for a description of
the data items included in the database file.
When using the Quick Export routine to create shape files, a prompt will appear requesting the selection of
the projection file. A projection file defines a set of parameters which define the coordinate system used
by the model (usually a state plane coordinate system). If a projection file is assigned, a projection file (PRJ
extension) will be included with the shape file set. The projection must already exist to be assigned. See the
appropriate ESRI documentation for the format and definition of the contents of the projection file.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

435

GASWorkS 9.0

Export Routines
Table Of Contents

Export Stoner Files


GASWorkS provides a routine for creating Stoner PD/XY files from a GASWorkS model. The PD file will
contain various chapters including a System, NCE, and Node chapter. If graphics are included in the model,
an XY file will also be created. The XY file will include both a Node and GNode chapter.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

436

GASWorkS 9.0

Export Routines
Table Of Contents

Export X-Y Customer Files


GASWorkS provides a routine for creating X-Y Customer files. The exported file contains a list of customer
Link Identification Numbers along with their associated X- and Y- coordinates. The file is in an ASCII
format, where each line represents the data for one customer. The data on each line is separated by commas
(,).

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

437

GASWorkS 9.0

Export Routines
Table Of Contents

Export X-Y Node Files


GASWorkS provides a routine for creating X-Y Node files. The exported file contains a list of Node Names
along with their associated X- and Y- coordinates. The file is in an ASCII format, where each line represents
the data for one node. The data on each line is separated by commas (,).

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

438

GASWorkS 9.0

Miscellaneous
Table Of Contents

MISCELLANEOUS

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

439

GASWorkS 9.0

Miscellaneous
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

440

GASWorkS 9.0

Miscellaneous
Table Of Contents

Personalizing GASWorkS
Many Users have their own preferences on how they like to do work and how they like the software to react
to certain actions. GASWorkS attempts to accommodate these personal preferences, by allowing a variety
of preference and behavior settings to be made by the User. Some of these settings are applied only to the
GASWorkS operating environment, others are applied and saved with the model data. The following table
lists some of these settings, what they do, how they are set, and whether they apply to the GASWorkS
operating environment or to the model data. Not all of the settings and options are included in the table.
Descriptions of other options are included with the program features that they are associated with.
Setting/Behavior

Description

Set Using

Operating Environment (Saved with GASWorkS)


Path (File) Locations
Initialization Files

Sets the location where the initialization files


are saved. This item is useful if multiple
Users are using GASWorkS in a network
environment. This item can be used to set a
location for saving initialization and
preference settings for each User.

The Path menu item of the


Preferences submenu of
the File menu list.

License File

Sets the location where GASWorkS looks for


the license file. This item is useful when
using GASWorkS in a network environment.

The Path menu item of the


Preferences submenu of
the File menu list.

Model Files

Sets the location where GASWorkS looks for


the model files. This item is useful if model
files are stored in multiple directories or
folders.

The Path menu item of the


Preferences submenu of
the File menu list.

Property Files

Sets the location where GASWorkS looks for


the assigned Property Tables. This item is
useful if multiple Property Tables are used.

The Path menu item of the


Preferences submenu of
the File menu list. Or the
Property Tables menu
item of the Preferences
submenu of the File menu
list.

Sets which Property Tables are used with the


model. A Property Table is required for each
supported hydraulic type.

The Property Tables


menu item of the
Preferences submenu of
the File menu list.

Property Tables

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

441

GASWorkS 9.0

Miscellaneous
Table Of Contents

Setting/Behavior

Description

Set Using

Allow Undo Of
Graphic/Data Changes

Establishes whether certain graphic and data


changes can be restored using the Undo
command. Allowing Undo slows down
Edit commands that support Undo.
Depending on the speed of the machine and
size of the change, the decline in
performance may or may not be noticeable.

The Settings menu item of


the Preferences submenu
of the File menu list.

Automatically Display
GDI Command List

Establishes whether the GDI Command List


is automatically displayed when the cursor is
moved over the associated icon. If the option
is not selected (not checked), the list is
displayed by clicking on the associated icon.

The Settings menu item of


the Preferences submenu
of the File menu list.

Automatically Open
GDI Window

Establishes whether the Graphic Data


Interface window is automatically displayed
when a model is opened. If the option is not
selected (not checked), the GDI can be
opened by selecting the View/Edit menu item
from the Graphics menu list.

The Settings menu item of


the Preferences submenu
of the File menu list.

Automatically Save
At Timed Increments

Establishes whether the model data is saved


at User specified time increments. This item
is useful to help prevent a loss of data in the
event of a system or software crash.

The Settings menu item of


the Preferences submenu
of the File menu list.

Display Reminders

Establishes whether various messages are


displayed during certain command
executions. For example, whether a message
is displayed when a command is done
processing.

The Settings menu item of


the Preferences submenu
of the File menu list.

Ignore Facility
Settings On Mass
Update

Establishes whether all data features are


updated when using the Mass Update
routine. If this option is not selected (not
checked), only data features assigned to an
active facility type will be updated when
using the Mass Update routine.

The Settings menu item of


the Preferences submenu
of the File menu list.

Options

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

442

GASWorkS 9.0

Miscellaneous
Table Of Contents

Setting/Behavior

Description

Set Using

Save Model Before


Solving

Establishes whether the model data is saved


each time before the model is solved, just
before the solution is executed. This item is
useful to prevent data loss in the event of a
system or software crash.

The Settings menu item of


the Preferences submenu
of the File menu list.

Show Tooltips

Establishes whether pop-up tooltips are


displayed when the cursor is left idle over a
command button, data field, or data list.

The Settings menu item of


the Preferences submenu
of the File menu list.

Use Command Alias


File

Establishes whether a command alias file is


used when processing commands entered on
the GDI Command Line. This item is useful
when it is desirable to use an alternative
spelling for commands typed on the
command, perhaps in a non-English
language.

The Settings menu item of


the Preferences submenu
of the File menu list.

Model Environment (Saved With Model)


Report Options
Displayed Data
Columns

Establishes which columns to include in the


Standard Pipe, Node, and Customer Data
Reports.

The Set Columns icon


found on the associated
report.

Indicate Which
Facilities To Include
In The Reports

Establishes which facility types are to be


reported. Only data features associated with
the selected facility types will be included in
the reports.

The Report Options menu


item of the Report menu
list. Or the Facility
Settings menu item of the
Edit menu list. Or the
Facility Settings menu
item of the Preferences
submenu of the File menu
list.

Indicate Which
Options To Include In
Exceptions Report

Establishes the types of errors to look for


and report when creating an Exceptions
Report. The Exceptions Report is optionally
included as part of the Solution Log.

The Report Options menu


item of the Report menu
list.

Number Of Decimals
To Display

Establishes the number of decimal places to


be displayed after the decimal point, when
displaying or reporting data values.

The Report Options menu


item of the Report menu
list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

443

GASWorkS 9.0

Miscellaneous
Table Of Contents

Setting/Behavior

Description

Set Using

Pressure Drop Per


XXX Length Units

Sets the value to be used as a basis for the


Pressure Drop Per Unit Length calculation.

The Report Options menu


item of the Report menu
list.

Printer Dimensional
Units

Sets the dimensional unit for the printer


measurement values, like page margins, etc.

The Report Options menu


item of the Report menu
list.

Sort All Reports


When Opened

Establishes whether the Standard Header,


Pipe, Node, and Customer Data Reports are
sorted by the selected method when they are
displayed. Select a method will cause a delay
in displaying the Standard Reports.
Depending on the size of the model and
speed of the machine, the decline in
performance may or may not be noticeable.

The Report Options menu


item of the Report menu
list.

Automatic Length
Update

Establishes whether pipe lengths are


automatically updated when certain Graphic
Edit commands are used. If this option is not
selected (not checked), a prompt will appear
each time a command is used that alters the
length of a pipe.

The Settings menu item of


the Graphics menu list.

Automatic Pan &


Zoom

Establishes whether certain mouse events can


be used to automatically execute certain Pan
and Zoom commands. See the Mouse
Events topic in the Graphic Data Interface
section of this Manual for more information.

The Settings menu item of


the Graphics menu list.

Automatic Repaint

Establishes whether the GDI Image is


automatically repainted after certain Edit
commands, the Mass Update routine, or the
Solution routine is executed. If this option is
not selected (not checked), the GDI Image
can be manually redrawn using the Repaint
Display command.

The Settings menu item of


the Graphics menu list.

Automatic Zoom On
Find

Establishes whether the GDI Image is


zoomed into the associated feature when a
Find command is used.

The Settings menu item of


the Graphics menu list.

Graphic Settings - Options

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

444

GASWorkS 9.0

Miscellaneous
Table Of Contents

Setting/Behavior

Description

Set Using

Display Flow Arrow


Once Per Polyline
Pipe

Establishes how many times a flow arrow is


displayed on polyline pipe segments. When
selected (checked), a flow arrow will be
displayed only once per polyline pipe, in the
middle of the segment.

The Settings menu item of


the Graphics menu list.

Display Panel
Outlines

Establishes whether the outline of the nondisplayed display panel is shown on the
displayed panel.

The Settings menu item of


the Graphics menu list.

Display Running
Length

Establishes whether the length of the pipe


segment will be displayed as the mouse is
moved when graphically adding new pipe
segments.

The Settings menu item of


the Graphics menu list.

Display Solid Pipe


Symbols

Establishes whether pipe symbols are drawn


using a solid shape or a hollow shape. When
selected (checked) the shapes are solid.

The Settings menu item of


the Graphics menu list.

Display UnSpecified
Facilities

Establishes which facility types are to be


displayed. Only data features associated with
the selected facility types will be displayed.

The Settings menu item of


the Graphics menu list. Or
the Facility Settings menu
item of the Edit menu list.
Or the Facility Settings
menu item of the
Preferences submenu of
the File menu list.

Display Vertex
Symbols

Establishes whether marker symbols are


displayed at each vertex on polyline pipe and
service features.

The Settings menu item of


the Graphics menu list.

Ignore Pipes Outside


Display

Establishes whether pipes whose ends fall


completely outside the current display region
are not displayed. Selecting (checking) this
option can increase display speed, but can
also suppress the display of pipe and
background features in some circumstances.

The Settings menu item of


the Graphics menu list.

Query During New


Feature Entry

Establishes whether the associated data edit


screen is displayed when new features are
added using the Add commands.

The Settings menu item of


the Graphics menu list.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

445

GASWorkS 9.0

Miscellaneous
Table Of Contents

Setting/Behavior

Description

Set Using

Show GDI Pop-Up


Menu On Right
Mouse Click

Establishes whether the GDI Pop-Up Menu


is displayed when the right mouse button is
clicked while the mouse is over the GDI
display area and no command is being
executed. See the Mouse Events topic in the
Graphic Data Interface section of this
Manual for more information.

The Settings menu item of


the Graphics menu list.

Show GDI Tooltip

Establishes whether the tooltip text is


displayed when the mouse is idle over the
GDI display area.

The Settings menu item of


the Graphics menu list.

Suppress Flow Arrow


Where Flow Is Less
Than Convergence
Factor

Establishes whether the flow arrows are


displayed on pipes with flow values less than
the convergence factor.

The Settings menu item of


the Graphics menu list.

Pan/Scroll Change
(Horizontal/Vertical)

Establishes the amount of shift in the GDI


Image when the Scroll icon is clicked.

The Settings menu item of


the Graphics menu list.

Refresh Increment

Establishes how often the GDI display area is


updated when redrawing (refreshing) the
image. A value of 100% means that the
display is not updated until the entire image
is refreshed in memory. A value of 10%
means that the display is updated after 1/10
of the features are refreshed in memory.
Using a value of 100% provides the greatest
performance, lower values decrease
performance, however lower values yield a
more User acceptable result.

The Settings menu item of


the Graphics menu list.

Zoom Ratio

Establishes the amount of change in the GDI


Image when the Zoom In and Zoom Out
commands are used. For example, a value of
2, increases the image size 2 times when
zooming in, or decreases the image size by
50% when zooming out.

The Settings menu item of


the Graphics menu list.

Graphic Settings - Settings

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

446

GASWorkS 9.0

Miscellaneous
Table Of Contents

Setting/Behavior

Description

Set Using

Facilities To Solve

Establishes which facility types are to be


included in the solution. Only data features
associated with the selected facility types
will be included in the Solution.

The Solution Data screen.


Select the Solve icon. Or
the Facility Settings menu
item of the Edit menu list.
Or the Facility Settings
menu item of the
Preferences submenu of
the File menu list.

Flag Large Error


Node Upon
Completion

Establishes whether a flag symbol is placed


at the location of the node with the largest
error (imbalance of flows into and out of the
node), upon completion of the Solution.

The Solution Data screen.


Select the Solve icon.

Include Exceptions In
Log Report

Establishes whether an Exceptions Report is


to be included in the Solution Log Report.

The Solution Data screen.


Select the Solve icon.

Update Color Coding

Establishes whether facility colors will be


updated based on the latest results, and the
last established range color specification.

The Solution Data screen.


Select the Solve icon.

Dimensional Units

Establishes the default and global


dimensional units for the various data values.

The Set Defaults menu


item of the Utilities menu
list.

Node Increment

Establishes the increment value used when


creating default names for new nodes.

The Set Defaults menu


item of the Utilities menu
list.

Solution Options

Default Data

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

447

GASWorkS 9.0

Miscellaneous
Table Of Contents

Using Non-Pipe Elements


The majority of most piping systems consist of pipe type elements. However, there are of course other
elements that can sometimes be found in a piping system - compressors, fittings, regulators, valves, and
wells. GASWorkS allows inclusion of these items in its models, in addition to the standard pipe type
elements. The following table describes some considerations that might be useful when including non-pipe
type elements in a model:
Element Type

Considerations

Compressor

When a compressor is included in a model, two requirements must be adhered


to for the element to function correctly.
The first requirement, is that the compressor element must be input so that the
From Node represents the upstream (suction) side of the compressor, and the
To Node represents the downstream (discharge) side of the compressor. When
the compressor symbol is drawn in the GDI, the large end is the suction side
or From Node end of the compressor. If the element is input backwards, use the
Swap Pipe Ends command to automatically change the elements input
direction.
The second requirement, is that a pressure must be known on one side of the
compressor.
GASWorkS models a compressor as a black box. It does not consider any of
the characteristics (power rating, etc.) of the compressor during the Solution.
The software only considers that the element is a compressor and as such
knows that the inlet pressure must be less than the outlet pressure.
If the downstream pressure is set as Unknown, the set pressure is used as a
check. If the upstream pressure is greater than the set pressure, the compressor
is set to free flow. In this mode the outlet pressure is set equivalent to the
inlet pressure.
The compressor operating characteristics are calculated and reported separate
of the Solution routine. The characteristics can be viewed using the Summary
Report.

Fitting

For systems where the pipe lengths are generally much longer than the
equivalent lengths of the fittings (distribution, gathering, and transmission type
systems), it is not really beneficial to include the fittings in the model. For
systems like these, the inclusion of fittings unnecessarily complicates the
model, while providing only a very little increase in the models accuracy.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

448

GASWorkS 9.0

Miscellaneous
Table Of Contents

Element Type

Considerations
For systems where the pipe lengths are generally comparable to the equivalent
lengths of the fittings (fuel piping, meter sets, regulator sets, and yard piping
systems), it is beneficial to include the fittings in the model. For systems like
these, the inclusion of fittings does tend to complicate the model, however in
this case their inclusion does provide a significant increase in the models
accuracy.
Inclusion of fittings can sometimes cause the number of iterations required to
solve the model to increase. This occurs because generally the pressure drop
across fittings is quite small, and elements with small pressure drops tend to
take longer to solve or balance.
An alternative to including fitting hydraulic type elements in a model, is to
include the equivalent length of the fittings in the length of the associated pipe
segments. Or, attach fittings directly to the associated pipe segment. The latter
method is the easiest way to handle fittings.

Regulator

When a regulator is included in a model, the regulator element must be input


so that the From Node is the upstream (high pressure) side of the regulator, and
the To Node is the downstream (low pressure) side of the regulator. When the
regulator symbol is drawn in the GDI, the upstream or From Node side of the
regulator is always shown to the left of the control head, when the head is
pointing up. If the element is input backwards, use the Swap Pipe Ends
command to automatically change the elements input direction.
GASWorkS models regulators in two different manners. If the downstream
pressure is set as Known, the regulator is modeled as a black box. It does
not consider any of the characteristics (valve coefficient, etc.) of the regulator
during the Solution. In this case the software only considers that the element
is a regulator and as such knows that the inlet pressure must be greater than the
outlet pressure - the outlet pressure is also maintained at the set pressure.
If the downstream pressure is set as Unknown, the regulator is modeled as
follows. If the inlet pressure is greater than the set pressure, the element is
considered to be controlling or regulating - the outlet pressure of the regulator
is maintained at the set pressure. If the inlet pressure is less than the set
pressure, the regulator operating characteristics (valve coefficient, etc.) are
used to calculate the outlet pressure of the regulator. In this case the outlet
pressure will always be less than the set pressure.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

449

GASWorkS 9.0

Miscellaneous
Table Of Contents

Element Type

Considerations
When the outlet pressure is set to Unknown, and the inlet pressure is less
than the set pressure, the flow and pressure drop across the regulator element
will be calculated similar to that of a valve. In this case the pressure drop
across the regulator may be quite small, and will tend to cause the solution to
take more iterations to converge - especially when the resulting outlet pressure
is very close to the set pressure.
The regulator operating characteristics are calculated and reported separate of
the Solution routine. The characteristics can be viewed using the Summary
Report.

Valve

For systems where the pipe lengths are generally much longer than the
equivalent lengths of the valves (distribution, gathering, and transmission type
systems), it is not really beneficial to include the valves in the model. For
systems like these, the inclusion of valves unnecessarily complicates the
model, while providing only a very little increase in the models accuracy.
For systems where the pipe lengths are generally comparable to the equivalent
lengths of the valves (fuel piping, meter sets, regulator sets, and yard piping
systems), it is beneficial to include the valves in the model. For systems like
these, the inclusion of the valves does tend to complicate the model, however
in this case their inclusion does provide a significant increase in the models
accuracy.
Inclusion of valves can sometimes cause the number of iterations required to
solve the model to increase. This occurs because generally the pressure drop
across valves (especially valves the same size as the associated pipe) is quite
small, and elements with small pressure drops tend to take longer to solve or
balance.
Use the %-Open parameter to account for partially open valves. Set the
status to Off to turn a valve completely off. Note that any flow element may
be turned off using the Status parameter.
An alternative to including valves as hydraulic elements in a model, is to
include the equivalent length of the valves in the length of the associated pipe
segments. Or, attach the valve as a fitting directly to the associated pipe
segment. The latter method is the easiest way to handle valves.
For tracing purposes, an alternative to including hydraulic valves is to include
them using attribute type valves. Attribute valves are not included in the flow
(hydraulic) model, but can be used for designing and checking emergency
isolation areas.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

450

GASWorkS 9.0

Miscellaneous
Table Of Contents

Element Type

Considerations

Well

GASWorkS allows inclusion of wells as flow elements, provided that the well
performance characteristics are available. To include a well as a flow element,
the equation coefficient and exponent must be calculated from a multi-point
flow test of the well. This data is not always available and if it is available, it
is generally only valid for the earlier life of the well. Unless retested, this data
is seldom valid for a mature well.
The advantage of including a well as a flow element is that the wells flow rate
will behave more realistically in the model. As the downstream system
pressure increases, the well flow decreases. And as the downstream system
pressure decreases, the well flow increases.
As an alternative to including wells as flow elements in the model, a well can
be modeled as a node with a known supply (positive load).

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

451

GASWorkS 9.0

Miscellaneous
Table Of Contents

Using The Relate Features


The relate features supported by GASWorkS allow individual independent models to be linked through
common related nodes. Nodes in different models are linked by identifying the name of the related model
and the name of the related node. During the solution, when a node is encountered that has a related model
attached, the related model is referenced and the load and/or pressure values for the related node is retrieved.
For convention, the term "current model" refers to the model using the relate information, and the "related
model" refers to the model sharing the information. Information can only be shared from the related model
to the current model.
The relate features allow sharing of load and/or pressure data. The common nodes are generally identified
at or near regulators that feed from the current model to the related model, or other supply locations.
However, there are no restrictions on where a relate may occur in a model. The relate information must only
be identified in the current model. The relate information must not be identified or repeated in the related
model.
As an example of how the relate features might be applied,
consider modeling a system comprised of individual
pressure districts being supplied by a higher pressure
transmission system. To effectively use the relate features
to model this type of system, first create an independent
model for each pressure district. Then create a model of the
transmission system, relating the load value of the nodes at
the outlet of the regulator stations serving each pressure
district, to the nodes representing the station connections in
the districts. When the transmission system is solved,
GASWorkS will determine the loads at the related nodes by
retrieving the appropriate values from the related models.
There are several advantages to using the relate features provided in GASWorkS. These features allow the
system models to be generated in logical and manageably sized "sub-models". For example, an independent
model may be created for each pressure district, and for the transmission system that supplies them. By
breaking a large system into smaller pieces the overall model is easier to create, check, and maintain. Each
independent model can have its own identity. The design factor, base pressure, and base temperature may
be independently defined for each individual model. Additionally, each individual model may be solved
independently. For example, you may make changes to one of the sub-models and re-run its solution without
the need to re-run the solution for the entire system. However because of the relate features, when the
transmission system model is re-solved, the flow data associated with the related nodes will be automatically
updated.
The customer diversity calculations are not supported by the relate features. In general, do not use the relate
feature if Diversified is selected as the node application option for any of the customers in the model.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

452

GASWorkS 9.0

Miscellaneous
Table Of Contents

Using Run Files


The Run File feature allows models to be solved in a pseudo batch mode. Using the run file feature, models
may be automatically solved based on the instructions contained in the run file data. This feature
compliments the relate features by allowing the User to specify a group of models to be solved and the order
in which to solve them. For example, consider the previously described system containing many pressure
districts supplied by a single transmission line. It might be desirable to solve all of the pressure district
models before executing the solution of the transmission system. To do that you could manually solve each
individual pressure district model, and then solve the transmission model. Or, you could create a run file that
would automatically execute the solution of each of the pressure district models, and then solve the
transmission system model.
In addition to supporting the relate features, a run file can also be used to execute the solution of a group of
unrelated models, in batch mode. For example, if for some reason you were interested in consecutively
executing several models, you could create a run file containing the names of the models to be solved. Then
execute the run file to solve the specified models. To create, edit, or view a run file, select the Run File menu
item from the Edit menu list.
The results of the analysis can be saved to a model different than the source model. This is helpful when you
may want to use a base model and run it at different design factors. By specifying a different output model
name, the original base model is not affected.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

453

GASWorkS 9.0

Miscellaneous
Table Of Contents

Using The Pipe Sizing (Optimization) Features


GASWorkS provides a feature for determining the required pipe sizes based on certain User defined criteria.
The process involved in finding these sizes is referred to as Optimizing. The Optimization process involves
three separate steps to implement.
The first two steps involve identifying which pipes are to be sized in the model, and identifying which pipe
sizes and types can be used from the Pipe Property Table. The third step, the actual Pipe Sizing routine, is
implemented as part of the Solution routine. When the Calculate Pipe Sizes (Optimize) solution option is
selected (checked), the Solution routine will attempt to minimize the size or cost of the system being
modeled, by attempting to find the least size or least cost combination of pipes that will satisfy the User
specified pressure requirements. Pipe sizes and cost values are extracted from the Pipe Property Table. Only
pipe sizes and types in the Pipe Property Table, where the Use When Sizing item is set to Yes, will be
considered or used during the Optimization. In the model, only pipes where the Allow Size Calculation item
has been selected (checked) will be sized.
The Summary Report compliments the Optimize routine by allowing the cost and size totals to be quickly
estimated and compared between varying design scenarios. By comparing the total cost of the various
designs, the most cost effective design can be easily identified. The cost values are calculated by multiplying
the pipe lengths by the Cost Per Length values contained in the Pipe Property Table. For example, the cost
of a 1000 Feet long segment of pipe with a unit cost of 8 would be, 8 times 1000 or 8000.
The Optimize routine may be used to size an entire system, or to size only a single pipe segment. It is
especially useful when designing a new system or designing replacement or renewal facilities for an existing
system. The Optimization process is iterative. The number of iterations required to complete the process
depends on the size of the system being modeled, and the number of pipe segments identified for inclusion
in the Optimization process.
As part of the optimization set-up, the User establishes certain conditions that they wish to maintain. The
Optimization process attempts to maintain those conditions while minimizing the pipe sizes or costs of the
system. Various types of conditions may be set:
! A pressure limit may be established for the entire system.
! A pressure limit may be established at certain node locations (referred to as condition nodes). Up
to ten (10) locations may be specified, each with a different pressure value.
! The pressure limits may be set to either maximum or minimum values.
! A Maximum Velocity value may be established.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

454

GASWorkS 9.0

Miscellaneous
Table Of Contents

For example, consider a system that contains an industrial customer who has a minimum inlet pressure
requirement of 10 Psig. The node representing that customer could be identified as a Condition Node, and
the Condition Pressure would be set at 10. The system pressure condition is used to establish an overall
limiting system pressure. This condition specifies that no pressure in the system may be either higher or
lower than the specified system pressure, depending on whether the pressure represents maximum or
minimum values. If the Condition Node is not identified, only the overall system pressure is used when sizing
the system.
As an example of how these two conditions are used in the Optimization process, consider the industrial
customer described above. In addition to the customers pressure requirements, let's add the condition that
the minimum system pressure is 5 Psig. The Optimization routine would attempt to find the minimum size
pipes that could supply at least 10 Psig to the industrial customer, while ensuring that no other pressure in
the system is less than 5 Psig.
In all cases the velocity would be limited to, at, or below the specified limit value.
The general process for determining pipe sizes is as follows:
! Depending on the value of the Reset Diameters To Minimum Sizes solution option, all of the pipes
identified for sizing will be set to the minimum allowed pipe size.
! The model is solved and the condition pressures are checked until the conditions are satisfied.
During the check process, if the current value is less than the specified value, the specified
processing method is used to identify which pipes to modify.
! The size of the identified pipes are increased one size larger. The model solution and check
process is continued until all of the condition pressures are satisfied. Once the condition pressure
conditions are satisfied, a similar solve and check process is used to check the systems pressures.
! Finally the velocity values are checked and the pipe sizes are adjusted accordingly.
! The previous steps result in an acceptable set of pipe sizes, meeting the various sizing
requirements. A final review of the preliminary results is performed to determine if any of the
resized pipes may be downsized, while still maintaining the specified sizing requirements. Changes
are made accordingly until the final set of pipe sizes is selected.
The key to the pipe sizing process, is to determine which pipe segments to change. The pipe selection process
is controlled by the selected Path Processing method. The various processing methods are described in the
following table:

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

455

GASWorkS 9.0

Miscellaneous
Table Of Contents

Path Processing Method

Description

Alternate Processing

This method alternates using the smallest and largest Flow


processing methods.

Flow-Pressure Drop
Processing

This method uses pipe flow rates to determine the path, and
then uses a ratio of the pressure drop and pipe length to
determine which segments to modify. This method generally
results in a graduated size trunk and branch type system that
most designers are accustomed to.
The Flow-Pressure Drop Processing method can be tuned
using the Pressure Drop Path Factor and Length Path Factor
values on the Other Settings tab on the Solution Data screen.
Raising or lowering one of the values, causes it to have more or
less influence on the resistance portion of the processing
routine.
When computing the pressure drop/pipe length ratio, the
pressure drop and pipe lengths are raised to their respective
factors. The product of the flow rate and the ratio is used to
select the pipes to be modified.

Flow Processing Only

This method use the pipe flow rates to determine the path, and
then uses the pipe resistance values to determine which
segments to modify. This method generally results in a
graduated size trunk and branch type system that most
designers are accustomed to.
The Flow Processing Only method can be tuned using the
Diameter Path Factor and Length Path Factor values on the
Other Settings tab on the Solution Data screen. Raising or
lowering one of the values, causes it to have more or less
influence on the resistance portion of the processing routine.
The pipe resistance as used by this routine is represented by the
ratio of the length to the diameter, both raised to their respective
factors. The product of the flow rate and resistance is used to
select the pipes to be modified.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

456

GASWorkS 9.0

Miscellaneous
Table Of Contents

Path Processing Method

Description

No Path Processing

This method ignores any flow relationships and focuses on


finding the pipes with the highest pressure drop. These pipes are
then identified for change. Basically the process assumes that
any of the pipes in the model can affect the pressure at any of
the nodes.

Process Along Largest Flow

This method finds the upstream path from the check location,
with the largest flow rates, and finds the pipes with the highest
pressure drop. These pipes are then identified for change.

Process Along Smallest Flow

This method finds the upstream path from the check location,
with the smallest flow rates, and finds the pipes with the highest
pressure drop. These pipes are then identified for change.

The Optimization routine provides a very powerful tool for the system designer. However, it cannot replace
the intuition, knowledge, and discretion of an experienced designer. The results of the Optimization routine
will provide a good start to the design process. However, these results should not be considered to be a "final
design". The optimization results should always be reviewed and revised as required to complete the design
process.
Note - During the pipe sizing process, only pipe style hydraulic elements where the Use When Sizing
option is selected (checked) will be considered for a new pipe size. The size of fitting and valve type
elements are not changed. It is best to exclude these type of elements from the model when using the
Pipe Sizing routine. If they are included, they will need to be manually changed as appropriate, after
the Pipe Sizing routine is complete. The Pipe Sizing routine may need to be re-executed after
changing them.
Note - The maximum velocity that can be physically achieved in a pipe segment is equivalent to the
speed of sound under the conditions found in the pipe segment. When sonic velocity is achieved, the
flow is said to be choked. At choked flow, the flow rate cannot be increased, without an increase
in inlet pressure - an additional lowering of the outlet pressure does not increase the flow rate. This
is similar to what happens in a regulator at critical flow. The most common case of choked flow
in a gas piping system would be found in flare or relief valve stack piping. Vary rarely is choked
flow achieved in other portions of a normal gas piping system.
It would make sense that there needs to be some practical limit for gas velocity in design calculations,
however there seems to be many opinions on what is an appropriate velocity for gas flow. Values range from
20 ft/sec to about 200 ft/sec. There are two general criteria cited for limiting velocity: One to reduce noise
levels in above ground piping. And two, to reduce the movement and abrasion caused by dust and debris in
the piping system. It is up to the User to select an appropriate limit, however inappropriately limiting the
velocity, tends to increase pipe size and cost of a system, without providing any real hydraulic design
benefits.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

457

GASWorkS 9.0

Miscellaneous
Table Of Contents

Using The Query Features


The Mass Update routine is controlled, the content of the Standard Report is modified, and the GDI can be
color-coded or items can be flagged using a User defined query specification. A query specification is
merely a means of telling GASWorkS which records to display or modify. Only records which meet the
specification are used, while records that do not match the specification are ignored. When used with the
Mass Update or Color Coding routine, the query specification tells GASWorkS which records to change.
When used with the Standard Reports, the query specification tells GASWorkS which records to include in
the report.
A specification can be saved and retrieved for later use. When used with the Standard Reports, multiple
queries can be sequentially implemented.
The following table summarizes the GASWorkS query features.
Desired Operation

Applicable Query Operator

Find records equal to a


specific value.

Use the equal "=" operator. For example, Size/Type = 4P. This
would find all records where the Size/Type value equals "4P".

Find records not equal to a


specific value.

Use the not equal "< >" operator. For example, Size/Type < >
4P. This would find all records where the Size/Type value is not
equal to "4P".

Find records less than a


specific value.

Use the less than "<" operator. For example, Pressure < 10. This
would find all records where the Pressure value is less than 10.

Find records greater than a


specific value.

Use the greater than ">" operator. For example, Pressure > 10.
This would find all records where the Pressure value is greater
than 10.

Find records less than or


equal to a specific value.

Use the less than or equal to "<=" operator. For example,


Pressure <= 10. This would find all records where the Pressure
value is less than or equal to 10.

Find records greater than or


equal to a specific value.

Use the greater than or equal to ">=" operator. For example,


Pressure >= 10. This would find all records where the Pressure
value is greater than or equal to 10.

Find all records.

Use the "ALL" operator.

Find records similar to a


string value.

Use the "LIKE" operator. For example, Address LIKE Main St.
This would find the records where the address values contain
the string "Main St".

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

458

GASWorkS 9.0

Miscellaneous
Table Of Contents

Desired Operation

Applicable Query Operator

Find records not similar to a


string value.

Use the "NOT LIKE" operator. For example, Address NOT


LIKE Main St. This would find the records where the address
values do not contain the string "Main St".

Find records with the


smallest values.

Use the minimum "MIN" operator. For example, Pressure MIN


10. This would find the records associated with the ten lowest
pressure values.

Find records with the largest


values.

Use the maximum "MAX" operator. For example, Pressure


MAX 10. This would find the records associated with the ten
highest pressure values.

Find records that start with a


certain string value.

Use the STARTS WITH operator. For example, Node Name


STARTS WITH HP. This would find all node records where
the Node Name starts with the string HP.

Find records that end with a


certain string value.

Use the ENDS WITH operator. For example, Pipe Size/Type


ENDS WITH PE. This would find all pipe records where the
Pipe Size/Type value ends with the string PE.

Note - Not all operators can be used with all data items.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

459

GASWorkS 9.0

Miscellaneous
Table Of Contents

Using Attribute Valves


GASWorkS allows valves to be considered by various methods. Valves may be included in the model as a
"Valve" type hydraulic element, as a "Fitting" type hydraulic element, as an attached fitting, or as an attribute
valve attached to a pipe. An attribute valve is associated with a pipe element, but is not actually considered
a part of the hydraulic model. Attribute valves are used only for display and when performing a "valve" style
trace.
In most cases, the additional restriction which may be associated with a valve may be effectively accounted
for by slightly adjusting the associated pipe's length. Or, by attaching a valve type fitting directly to the
pipe segment. Generally, where the pipe lengths are long compared to the equivalent length of the valves,
omission of system valves in the actual model data has a negligible influence on the results of the analysis.
Because of this, system valves are often left out of the hydraulic model. However, it might be desirable to
keep track of a valve's location for non-modeling purposes (such as tracing) - this is the purpose and designed
use of the attribute valve features.
The model creation process can be greatly simplified by maintaining valves as attributes to their associated
pipe, as opposed to including them as actual flow elements in the model. A pipe can have up to two attribute
valves assigned to it - one near the From Node and one near the To Node. When the valve is "added",
GASWorkS determines which pipe end the valve is nearest to, then assigns it as either a From or To Node
valve.
The attribute valve data consists of an index file which keeps track of the pipe to which the valve is assigned,
the valve's location, and a twenty (20) character alpha-numeric identification number. The valve data is
stored in a file ending in a ".vdx" extension.
The location of an attribute valve is displayed using a "bow-tie" symbol. The symbols can be assigned a User
specified size and color to help differentiate them from the "Valve" type pipe element symbols. All of the
symbols are displayed using a common size.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

460

GASWorkS 9.0

Miscellaneous
Table Of Contents

Using The Extract Routine


GASWorkS allows a portion of an existing model to be extracted into a new model. The extract process
involves selecting a set of pipes or customers by various means. Once selected, the extracted data will be
stored in a new model of a specified name. Optionally, the data in the existing model can be deleted once the
new model has been created.
The new model will contain the selected pipes and customers (if selected for inclusion). The existing
hydraulic and graphic data will be included in the new model, however any attribute data associated with the
original model will not be included in the new model.
Generally certain data values will need to be set before the extracted model can be solved. Specifically, at
least one supply point must be identified (pressure set as Known, and load set as Unknown).
Care must be taken when working with an extracted model. Realize that changes made to the extracted model
will not be reflected in the original model. If the load (demand) in the extracted model changes, and the
supply pressures are taken from the original model, the values may not be appropriate for use with the
extracted model.
An extracted model may be added to another existing model using the Append routine found in the File menu
list.
If the original data is accidently deleted during the extract process, the Oops command can be used to
restore the data.
Either a pipe or customer selection set may be used as the basis for the extraction. If a pipe set is used, the
connected customers can be optionally included. If a customer set is used, only the customers will be
extracted. The selection sets may be created using the Edit Multiple Customers or Edit Multiple Pipes
command in the GDI, or using the Query routine in the Customer Data or Pipe Data Report.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

461

GASWorkS 9.0

Miscellaneous
Table Of Contents

Working With Gas Properties


When different supply sources have different gas property values, GASWorkS allows the gas properties from
the different flow streams to be mixed at intersections. Only the gas properties (specific gravity, viscosity,
heating value, and specific heat ratio) are mixed. Mixing of the gas composition is not supported.
Mixing is performed based on a proration of the volumetric flow rate of each stream. The gas mixing
calculation is performed based on upstream flow values. That is the mixing at a node is based on the
properties of the volumetric flow rates of the pipes flowing into a node. The gas properties of the outlet flow
or load leaving the system, reflect the mixed value.
Some special requirements must be considered when preparing a model to use gas property mixing:
! Because the gas mixing is performed based on upstream flow values, the gas properties of each
supply point must be known. Generally the gas properties are set as Unknown for all other node
locations. The gas properties known flag setting can be changed individually or in mass using the
Edit Multiple Nodes command.
! When gas mixing is used, each node with known gas properties must be at the terminus end of a
one-way segment.
! The gas properties for known locations can be calculated from a known gas composition using the
Calculate Gas Properties routine found in the Analysis menu list.
! Once the data values and known/unknown settings have been correctly set in the model, the
Calculate Gas Mixing solution option on the Solution Data screen must be selected (checked) to
calculate the mixed gas property values when solving the model.
! If a compressibility method is being used, a gas properties file for the model must be created.
When the gas composition varies throughout the system, as when mixing is being used, the gas
properties file should represent an average composition for the gas in the system. The gas
properties file must be named the same as the model. The file can be created using the Calculate Gas
Properties routine.
! The number of iterations required to solve a model using gas mixing and/or calculating
compressibility will be greater for a model where these options are not used. The maximum iteration
limit may need to be increased to allow convergence.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

462

GASWorkS 9.0

Miscellaneous
Table Of Contents

Calculating Gas Temperatures


GASWorkS supports the modeling of varying gas temperatures in the piping system. When the gas flowing
temperature varies in a system, the change in temperature can be calculated along the pipe segments, and the
mixed temperature can be calculated at intersections.
Temperature change is calculated based on a User selected heat transfer method. Gas cooling due to pressure
drop (Joule-Thomson effect) is estimated based on a general rule-of-thumb method and is only valid for gas
compositions similar to a standard natural gas composition.
Mixing is performed based on a proration of the volumetric flow rate of each stream. The temperature mixing
calculation is performed based on upstream flow values. That is the mixing at a node is based on the
temperature of the volumetric flow rates of the pipes flowing into the node. The temperature of the outlet
flow or load leaving the system, reflects the mixed value.
Some special requirements must be considered when preparing a model to calculate temperature values and
mixing:
! Because the temperature mixing is performed based on upstream flow values, the gas temperature
of each supply point, and generally the outlet of regulators and compressors must be known.
Generally, the temperature is set as Unknown for all other node locations. The temperature known
flag setting can be changed in mass using the Edit Multiple Nodes routine.
! The heat transfer data is set for the entire model. This data is accessed using the Solution Data
screen. The various values and options are described in the Data Screen description section of this
Manual. The values must be set appropriately to achieve reasonable results. If actual field values are
known, the data values can be adjusted to calibrate the model to match the field results.
! Once the data values and known/unknown settings have been correctly set in the model, the
Calculate Temperature Values solution option and optionally the Calculate Gas Mixing solution
option, on the Solution Data screen, must be selected (checked) to calculate the temperature values
when solving the model.
! The number of iterations required to solve a model using temperature calculation and/or gas
mixing will be greater for a model where these options are not used. The maximum iteration limit
may need to be increased to allow convergence.
! When the Calculate Temperature Values solution option is selected (checked), the overall heat
transfer coefficient is calculated for each pipe segment during the solution. These values are reported
with the pipe data.
! The Show Route Profile command can be used to graphically display the temperature profile along
a selected path.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

463

GASWorkS 9.0

Miscellaneous
Table Of Contents

Using Diversified Customer Loads


GASWorkS provides a routine for handling diversified customer loads per The Institution of Gas Engineers
Guide - IGE/GL/1. The following describes how these requirements are implemented in the software.
GASWorkS uses the computation methods described in Appendix A5.1.5 to compute the diversified load
associated with a combination of varied heating type customers. In the GASWorkS implementation, each
customer is assumed to represent a unique group of one. Using this assumption the total load for a group of
customers can be reduced to:

This value is computed for each node, considering the customers served downstream of the node. All
customers along a pipe segment are assumed to be served at the downstream node end of the segment.

Implementation Notes
Using the above relationship as a foundation, GASWorkS implements diversity into its solution algorithm
as follows:
1) An initial set of customer counts is calculated for each pipe segment based on the customers
assigned to each individual segment.
2) A set of node loads are computed from the pipe customer counts using the relationship shown
above.
3) The model is solved.
4) A new set of customer counts is computed by finding null flow nodes (nodes where all pipe flows
are into the node). The flow path is then traced towards the source until a branch or a source is
encountered. A new set of pipe customer counts are computed along the flow path by allocating the
downstream customer counts to the upstream pipes at each node, based on a proration of the
incoming pipe flows.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

464

GASWorkS 9.0

Miscellaneous
Table Of Contents

5) After the new customer counts are computed for all of the pipe segments, a new set of node flows
are computed. The new values are checked against the old values. If each new value is within the
convergence tolerance of the old value, the diversified flows are balanced - the solution and
diversity calculation are complete. If any value falls outside the check value, the process is repeated
starting at Step 3 until the diversified loads are balanced or the Maximum Iterations limit is reached.

Model Considerations
The following should be considered when developing a model for use with the Diversity routine.
1) Enter or import the piping network as with any GASWorkS model.
2) Customer data features must be present when using the Diversity routine. Use the GDI customer
entry commands to enter customers and indicate their supply main. When adding a customer:
! Select the Diversified option for the Load Application method.
! Select the desired heating type from the list that appears.
! Enter the desired annual heating value for the Per Unit Load. Select the desired
dimensional units for the heating value.
! Customers with similar heating types, located along a common pipe segment, can be
represented by a single customer feature, by entering the desired value for the Unit Count.
For example, if there are ten (10) identical customers along a pipe segment - ten (10)
individual customer features may be added along the pipe segment - or one customer with
the unit count set to ten (10), could be used.
3) A model may consist of both diversified and non-diversified customer loads by appropriately
setting the Load Application method.
4) Set the supply pressure values, and known/unknown values as with any GASWorkS model. Once
the model entry is complete, the model can be solved.
5) To implement the Diversity routine during the solution process, select (check) the Calculate
Diversity solution option on the Solution Data screen when solving the model. The solution will
perform multiple iterations as described previously until a solution is reached or until the iteration
limits are reached. The more complex the piping configuration is, the more diversity iterations are
required to complete the solution. Check the last line of the Solution Log to ensure that the solution
has been successfully completed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

465

GASWorkS 9.0

Miscellaneous
Table Of Contents

Previous GASWorkS models, using diversified loads, are not directly compatible with the new diversity
calculations. To use older models with the new software, customer features must be assigned to each pipe
and the appropriate annual heating value must be assigned. After assigning the new customers it is
recommended that the Update External Loads routine be executed from the Customer Data submenu of the
Utilities menu list.
The customer diversity calculations are not supported by the relate features. In general, do not use the relate
feature if Diversified is selected as the Node Application option for any of the customers in the model.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

466

GASWorkS 9.0

Miscellaneous
Table Of Contents

Using The Facility Type Item


Each pipe feature can be assigned a facility type. The associated nodes and assigned customers inherit the
facility setting of the pipe/main. The facility value is intended to allow pipes and customers to be grouped
together based on the facility value. The facility type is similar to the layering scheme used in many CAD
or GIS systems. The facility type can represent any group identification, as it is presented in the standard
installation of GASWorkS, the facility represents general construction and pressure type. For example, an
existing or proposed facility associated with a general operating pressure. The User may revise the contents
of the standard facility list as required to meet their unique needs.
Once assigned a facility type, the associated pipes can be manipulated using their facility type setting. For
example, the Mass Update or Report routines can use the facility to create a selection set. The Facility
Settings routine can be used to indicate which pipes can be edited, reported, displayed, or solved. The display
style of the pipes (display color, line type, line width) can be controlled by the Facility Settings.
The Active facility settings item identifies which pipes can be edited. It is useful when using automatic
manipulation commands such as the Assign Customer Service Lines or Flag Unbroken Intersections. For
example, if a model contains both high pressure and medium pressure systems, and all or the majority of the
customers are connected to the medium pressure system, the high pressure portions of the system could be
assigned to the High Pressure facility type, the medium pressure portions could be assigned to the Medium
Pressure facility type. Before executing the Assign Customer Service Lines command, the Medium Pressure
facility type could be set to Active and the High Pressure portion could be set to inactive. Only pipes
assigned to an active facility type can be edited or modified, so the Assign Customer Service Lines command
would only try to assign customers to the active facility types, in this case only pipes assigned to the Medium
Pressure facility type. Similar settings could be used to prevent the Flag Unbroken Intersections command
from identifying connections between high and medium pressure portions of the system.
The Report and Display facility settings items can be used to identify which pipe (nodes and customers)
features will be included in the various reports, and which features will be included in the graphic display.
The Solve facility settings item can be used to indicate which pipes to include when the Solution routine is
executed. However, care must be taken to ensure that a solvable configuration, appropriate knowns,
unknowns, and supply pressures, exist when excluding features from the solution.
To control the graphic display style of pipes using the settings in the facility settings, assign the pipes Line
Color, Line Style, and Line Width data items to Facility Table. The values can be set using the Mass Update
routine, Edit Multiple Pipes command, or the individual pipe edit routines.
Select the Facility Settings menu item from the Edit menu list to access the facility type list and settings
associated with the current model. Facility settings can be saved and retrieved for use with other models, and
a specific group of settings can be saved as the default for all new models.
The facility type can also be set and similarly used for User Graphic and Text features.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

467

GASWorkS 9.0

Miscellaneous
Table Of Contents

Convergence Problems
Maximum Error Bounces From Small To Large
This error can occur for several reasons, the most common reasons are listed below.
! The Upper Dampening Factor may be too large, try setting it to zero (0). The affect of the Upper
Dampening Factor varies depending on the flow equation and on the pressure values. The Upper
Dampening Factor is used to limit the pressure adjustment for nodes where the node error is larger
than the Upper Dampening Factor times the Convergence Factor. This helps reduce over-shoot and
under-shoot of the solution, some equations converge quicker when this reduction is applied to all
nodes. When the Upper Dampening Factor is set to zero (0), the reduction is applied to all of the
nodes.
! If regulators are present, and the outlet pressure of one or more of the regulators is set to
Unknown, the bounce may occur because the regulator is constantly switching between regular
flow mode and droop mode. Try setting the outlet pressure of the regulator to Known. When the
outlet pressure of the regulator is set to Unknown, the operating mode of the regulator can be
automatically changed by the solution to accommodate for low inlet pressures, or for high outlet
pressures. If the inlet pressure drops below the set pressure for the regulator, the outlet pressure is
reduced using the regulators flow equation. If the pressure of the downstream piping is higher than
the set pressure, the regulator is turned off.
! The system could be running out of gas. This refers to the condition when the calculated
pressures are less than zero (0). This occurs because the capacity of the system is less than the
amount of flow that is trying to be passed through it. If this condition occurs (and it is not supposed
to) try decreasing the design factor, increasing the pipe efficiencies, or increasing the supply
pressures.

Zero Diagonal Possible Discontinuity From Supply Node(s)


This error generally occurs because a portion of the system is disconnected from the remainder of the system,
and the disconnected portion does not contain a node with a known pressure. The discontinuity can be the
result of a connectivity error, from a turned off piping element, or from an incorrectly installed regulator
or compressor.
If this error occurs, and the model can be displayed graphically, try the following to resolve the problem:
! Note the indicated node Record Number.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

468

GASWorkS 9.0

Miscellaneous
Table Of Contents

! Use the Find Node By Record Number command to locate the affected node.
! Use the Trace command to trace all directions from the affected node.
! Follow the highlighted pipe segments to determine the point of discontinuity.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

469

GASWorkS 9.0

Miscellaneous
Table Of Contents

Using A Command Alias File


The GDI allows User defined command names to be used to execute a command on the GDI Command Line.
A User defined command name is known as a command alias. These values are assigned using the
Command Alias File. The Command Alias File is a specially named ASCII text file which contains the alias
and command assignments. The file can be created using any word processing application that supports the
ASCII text format.
The file must be named gwcmd.txt and must be located in the currently set Initialization File directory
(path).
The contents of the file describes the alias to command assignments, one assignment is contained on each
line of the file in the following format:
ALIAS, COMMAND NAME
ALIAS, COMMAND NAME
For example:
+PIPE, ADDPIPE
-PIPE, DELPIPE
The alias can contain most alpha-numeric characters except commas (,). The case (upper or lower) of the
alias or command name are not significant.
The Use Command Alias File preference option must be selected (checked) to direct GASWorkS to load and
use the file. When processing a command entered on the GDI Command Line, the alias assignments are
processed before the standard command names are processed.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

470

GASWorkS 9.0

Miscellaneous
Table Of Contents

Program Limitations
GASWorkS is a very powerful tool for modeling flow in gas piping systems. However, it does have some
limitations. The node and pipe limitations are related to the capacity of the particular version purchased, the
remaining limitations apply to all versions. The limitations of GASWorkS are:
Data Types
The Data Limitations table refers to a variety of data types. In the context of the descriptions contained
in that table, the following data type definitions will apply.
Double Precision Number - Allows up to 15 significant digits. Unless otherwise specified, values of this
type can range from -1.7*10308 to1.7*10308.
Integer Number - Allows up to 5 significant digits. Unless otherwise specified, values of this type can
range from -32000 to 32000.
Long Integer Number - Allows up to 10 significant digits. Unless otherwise specified, values of this type
can range from -2.1*109 to 2.1*109.
Single Precision Number - Allows up to 7 significant digits. Unless otherwise specified, values of this type
can range from -3.4*1038 to 3.4*1038.

Data Limitations
The contents of this table lists the absolute minimum and maximum values allowed by the various
parameters used in GASWorkS.
Node Capacity - Version and memory dependent.
Pipe Capacity - Version and memory dependent.
Node Names must be no more than forty (40) alpha-numeric characters in length. Special characters are
allowed.
Pressure values may be any floating point number in the range from minus one atmosphere, to the
maximum allowed single precision number.
Node Load values may be any valid single precision number.
Pipe Diameter, Wall Thickness, and Roughness values may be any valid positive single precision number.
Pipe Lengths may be any valid positive single precision number.
The value of the Maximum Number Of Iterations must be any valid positive integer value.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

471

GASWorkS 9.0

Miscellaneous
Table Of Contents
Data Limitations

The Design Factor may be any valid single precision number.


The Convergence Factor may be any valid positive single precision number.
The Upper & Lower Dampening Factor may be any valid positive single precision number.
The Diameter & Length Path Factors may be any valid positive single precision number.
Gas Properties may be any valid positive single precision number.
Temperatures may be any valid single precision number.
Elevation values may be any valid integer value.
Node Coordinate values must be any valid double precision number in the range, 0 to 9,999,999.
Customer Coordinate values must be any valid single precision number in the range, 0 to 9,999,999.
Attribute Valve Numbers must be no more than twenty (20) alpha-numeric characters in length. Special
characters are allowed.
User Text may contain no more than 32,000 characters.

Model Restrictions
A regulator or compressor element cannot be preceded or followed by another regulator or compressor.
No more than six (6) pipes may be connected to an individual node.
At least one node parameter (pressure or load value) must be known for each node.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

472

GASWorkS 9.0

Appendix
Table Of Contents

APPENDIX

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

473

GASWorkS 9.0

Appendix
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

474

GASWorkS 9.0

Appendix
Table Of Contents

Network Primer
The examples used in this discussion often refer to distribution type piping systems, however the general
concepts described in this section apply to all types of piping systems. Hopefully the User will be able to
make the analogies between the cited examples and their particular application. Additional notes are provided
for working with other types of systems, at the end of this section.

About Network Modeling


The following provides a brief description of network modeling, the benefits derived from modeling, and
some general information concerning gas networks. It assumes that you have a working knowledge of the
design, analysis, and operation of gas systems and the terms normally associated with the field. If you are
not completely familiar with all of the terms or concepts you encounter, you may want to refer to an industry
handbook or guide.
For our discussion here, a model is a mathematical representation of a gas system. It is created by defining
a group of interconnected nodes and pipes. A node represents the beginning or ending point of a pipe. Nodes
are connected by pipes. Load is brought into the system or taken out of the system through nodes. Nodes not
only represent pipe connections, but can also represent customer connections and supply points.
Pipes carry gas between the nodes. The
sum of the pipe flows going into a
specific node must equal the sum of
the flow leaving the node through the
connected pipes, plus the flow leaving
the system through the node. Similarly,
the sum of the flow coming into the
system through a node, must equal the
sum of the flow leaving the node
through the connected pipes. In steadystate modeling, neither nodes or pipes can store flow.
A further characteristic of steady-state network behavior, requires that the sum of the pressure drops from
one point to another, along any path, must be same. In other words, a node point can possess only one
pressure value.
Flow in a pipe moves from the higher pressure end of the pipe to the lower pressure end. That is, flow always
moves in the direction of the lower pressure node. Like a ball rolling downhill, gas flows from high to low.
Flow is created by a difference in pressure and consequently flow causes frictional pressure losses.
Generally, as the flow increases the frictional losses also increases. The greater the pressure difference, the
greater the flow rate. And the greater the flow rate, the greater the frictional pressure losses.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

475

GASWorkS 9.0

Appendix
Table Of Contents

Because of the nature of the equations that describe the pressure-flow relationship in a gas network, the
pressure and flow values in a gas system cannot always be directly calculated. The values must usually be
determined by recursive calculation. To control this recursive process, an attempt is made to balance the flow
into and out of all nodes in the model. When the imbalance of these flows is within the specified tolerance,
the model is said to be "balanced". However, it is unusual for the solution of a model to result in an
imbalance exactly equal to zero (0) at all nodes. To account for this behavior, a convergence tolerance is used
to check the balance condition.
The convergence tolerance represents the amount of imbalance that is acceptable for a particular analysis.
The tolerance is analysis specific and should be based on certain peculiarities of the model being analyzed.
When establishing the convergence tolerance, consideration should be given to several factors:
! The coarseness of the model data, that is, how accurately is the model data known.
! The magnitude of the total flow into the system being modeled.
! And the intended use of the results from the analysis.
An acceptable convergence tolerance is usually less than one percent of the total anticipated flow into the
system being modeled.
A "flow equation" is required to describe the relationship between the flow in the pipes and pressures at the
nodes. Most flow equations require the definition of certain parameters describing the gas in the system, and
the physical properties of the pipes. A friction factor may be inherently assumed by the equation, or may be
calculated depending on the equation format. There are many equations available for modeling the conditions
normally encountered in gas distribution, transmission, and gathering systems. The challenge is selecting the
one that best suits your specific application.
A model is only as good as the data that is used to build it. Analysis based on incorrect values will yield
incorrect results. The analysis results should be evaluated with the proper weight. In most gas distribution
models, customer usage and load distribution will be the most critical parameter in the analysis. With the
physical system configuration being the second most critical group of data.

The Benefits of Modeling


There are several benefits derived from creating and analyzing computer models of a gas system. Some of
these are:
! The ability to anticipate operating conditions within the system.
! The ability to identify problem areas and trouble-shoot problems before they become serious.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

476

GASWorkS 9.0

Appendix
Table Of Contents

! The ability to efficiently size new and replacement segments to the system.
! The ability to estimate the impact on the system of adding new customers or supplies.
! The ability to analyze "what if" scenarios without physical manipulation of the gas system or
actual operating settings.
Modeling of a system helps prevent potentially unnecessary expense by allowing design and operating ideas
to be tested using the model, as opposed to the potentially costly method of testing the ideas in the field.
Computer modeling allows alternatives to be tested and refined before implementing them. It can help avoid
construction of improperly sized facilities, and avoid making modifications to the system or operations that
could adversely affect its serviceability.

About Networks
A network is any system of interconnected or interrelated components. In a network each component, to
some extent, affects every other component in the network. A gas system can be considered as a network.
In a gas system, the components of the network are the pipes, valves, fittings, connections, and regulators
that make up the physical configuration of the system - and the customers attached to the system.
As an example of how individual components of a gas network might affect the other components in the
network, consider the following:
! The outlet pressure of a regulator supplying the system is reduced. To a certain extent, the pressure
in the entire system might be changed - the pressures upstream of the regulator will likely increase
and pressures downstream of the regulator will decrease. If more than one regulator supplies the
portion downstream of the regulator, flows will be redistributed.
! An additional regulator is added to the system, the flow from the other regulators will be changed.
The flow through the pipes will be redistributed to accommodate the change in flow from the
regulators.
! A valve in the system is closed. Flow in the system must be redistributed to accommodate the
changes caused by the valve closure. The flow and pressure in all of the pipes will be changed, to
a certain extent. Flow will decrease in the mains to which the valve was attached and increase in
mains that might provide flow around the valve. When flows change in the system, so do the
pressures in the system.
! A large load is connected to the system. The flow in the portions of the system supplying that load
will be increased. The increase in flow will affect the pressures in the system and the flow required
of the supplying regulators.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

477

GASWorkS 9.0

Appendix
Table Of Contents

These few examples demonstrate the fundamental concept of a network - that within a network, every
member of the network is essentially connected to and affected by every other member in the network. A
network can be thought of as a large machine with each component working together with the other
components to make the machine operate.

Flow In Gas Networks


If you refer to the previous definition of a gas network, you will recall that the network consisted of pipes,
fittings, regulators, and customers. Customer usage is normally what causes flow in a gas system. When it
is cold, the customers' furnaces operate quite frequently, creating a demand on the gas system. The flow in
the gas system might be very high to satisfy this demand. When it is warm, generally only pilot lights are
operating, and their demand is quite low. Consequently, the flow in the system is very low at that time. Let's
look at this phenomena closer. What happens in this process that actually causes the gas to flow through the
system?
Consider a system that is comprised of a single customer, a single segment of main, and a single supplying
regulator. When the customer's home gets cold, the thermostat in the house reaches a point where it turns on
the furnace. When the furnace is turned on, the gas valve on the furnace opens allowing gas to enter the
furnace. On a conventional furnace the absolute pressure inside the furnace is the same as the atmospheric
pressure. That is the gas is released to the atmosphere. This is true because the combustion chamber of the
furnace is open to the atmosphere through the flue and the inlet air valves. The gauge pressure then, at the
end of this network of regulator, main, and customer, is zero (0). In other words, if a pressure gauge were
held in the combustion chamber of the furnace, the gauge would read zero (0).
If the network had no source of supply and the furnace continued to operate, the pressure in the main
supplying the customer would decrease over time. Eventually, the pressure in the main would be reduced to
the same pressure as the combustion chamber of the furnace, zero (0).
This system, however, has a source of supply, the regulator. Initially when the furnace is off, the regulator
is closed. There is no gas coming into the system. As the furnace continues to use the gas from the main, the
pressure in the main begins to decrease. The regulator will eventually sense this decrease and open slightly
to attempt to maintain the pressure in the main. The regulator will continue to open as required to satisfy the
demand imposed by the consumption of the furnace. In theory the amount of gas supplied by the regulator
will eventually equal the amount of gas consumed by the furnace. When this happens, the condition in the
system is said to be at steady-state.
In summary, the demand for gas by the furnace in the customer's home causes gas to flow through the system
to satisfy that demand. When the supply through the system is equivalent to the demand on the system, the
condition of the system is said to be steady-state.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

478

GASWorkS 9.0

Appendix
Table Of Contents

Let's look at the conditions occurring in the system during steady-state flow. The pressure at the end of the
system (the customer's furnace) is zero (0). Let's assume the pressure at the regulator supplying the system
is 20. The pressure in the main that connects the customer to the regulator, therefore, varies from 20 at the
regulator to 0 at the furnace. This difference in pressures causes gas to flow through the main line. The
amount of gas flowing through the main exactly equals the amount of gas entering the system at the regulator,
and exactly equals the amount of gas leaving the system through the furnace. The flows and pressures are
unchanging (steady), therefore the system conditions are steady-state.
When the furnace turns off, the customer end of the system will no longer be open to the atmosphere.
However for a time, a pressure difference will exist in the system and the gas will continue to enter the
system through the regulator, but no gas is leaving through the furnace. During this time, the flow in the main
equals the flow entering through the regulator but does not equal the flow leaving through the furnace (which
is zero (0)). Further, as the gas continues to enter the system the pressure at the furnace end will continue to
increase. The flow into the system does not equal the flow leaving the system, and the pressures are
changing. These conditions are referred to as unsteady, or transient. Eventually, the pressure in the system
will equalize (no pressure difference) and the flow will cease. When this occurs the system will again be in
a steady-state condition.
When gas is flowing it causes frictional pressure losses to occur along the pipe segments. The magnitude of
the frictional pressure losses are affected by several factors. A decrease in pipe size, restrictions in the system
such as valves or debris, and increased roughness of the inside pipe wall will cause the magnitude of the
frictional losses to increase. The composition and physical properties of the gas also affects the magnitude
of the frictional losses. For a given flow rate, an increase in specific gravity, the flowing temperature, or the
viscosity generally causes the magnitude of the frictional losses to increase.

Determining Model Loads


As mentioned in the previous section, the demand or load placed on a gas system is a function of its
customers' usage characteristics. In order to model a gas system, an estimate of the customers' loads must be
determined. This is probably the most critical piece of data that will be used in the model. Unfortunately, this
is generally the least known piece of the required data.
There are two general methods for determining the value of these loads. The first method attempts to
determine actual usage values (generally peak-hour usage values). The other attempts to determine the total
connected load (TCL) for each customer, and then applies a usage (design) factor to the TCL. Either method
is acceptable if applied correctly and judiciously.
One method which can be used to determine the actual usage of each customer can be described as a
"proration" method. The steps required to determine the customers' peak-hour loads by this method are:

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

479

GASWorkS 9.0

Appendix
Table Of Contents

1) Determine the historical peak-hour flow rate for the entire system being modeled. Usually this
occurs coincidently with the peak-day event, but not always. If hourly flow values are not available,
obtain the metering charts for the period covering the peak-day occurrence. If the meter is an orifice
meter, find the maximum differential pressure recorded during the peak-day. Using the AGA Report
Number 3 (or other applicable reference) calculate the hourly flow rate corresponding to the
maximum differential pressure. If more than one meter run was operational, sum the loads for all of
the runs to obtain a total for the system.
If the meter is not an orifice meter, and the meter chart records volume as opposed to differential
pressure, find the thinnest "scallop" recorded for the peak-day period. Divide the scallop volume by
its duration (in hours) to determine an "average" peak-hour. Be sure to correct the recorded volume
for pressure and temperature, as appropriate.
If only daily or monthly demands are available, an appropriate factor may be applied to estimate the
hourly demand. Generally peak-day to peak-hour conversion factors range from 1/12 to 1/18.
2) Determine the average usage of each customer during the peak demand period. The data should
include some type of customer identifier (address, facility ID, premise ID, etc), and the usage or
billing values over the month(s) representing the peak period. Calculate the average usage for each
customer and the portion of the total load used by each customer.
To determine each customer's portion of the total load, sum the average usage values for all of the
customers. Then divide each customer's average usage by the total usage, the result represents the
customer's portion of the total usage.
Note - If the above calculations are performed using a spreadsheet, it may be possible to link the
resulting database to GASWorkS and use the external database features to automatically update
the model loads.
3) Finally prorate the total peak-hour value determined in Step 1 to each customer. To prorate the
flow, multiply the total peak-hour value by the prorated usage (determined in Step 2) for each
customer. This result will approximate the peak-hour usage of each customer. When properly applied
to the model, these loads may be used to estimate the peak-hour performance of the system being
modeled.
This method can also be used for off-peak periods by using an appropriate total hourly value.
Note - When using this method, generally the customer loads are input as the usage factors computed
in Step 2, and the design factor is set to the peak-hour value computed in Step 1, or another hourly
total as suggested in Step 3.
Another method for estimating customer loads is referred to as the TCL method. The following discusses
the use of this method:

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

480

GASWorkS 9.0

Appendix
Table Of Contents

! There are several methods to determine the customers' total connected load. The best method is
to survey each customer location to determine the input rating of each of their appliances. However,
this is not always practical. A compromise method is to visit only the commercial and industrial type
customers and a portion of the residential customers. Collect the individual loads for each
commercial customer visited, then select a random sampling of residential customers. Collect their
loads and calculate an "average" residential load based on the collected data. Apply this average to
the remaining residential customers.
! If there is great dispersion of residential construction types and ages, group the residential
customers into classes and calculate an average for each class. For example, homes built before
1940, homes built between 1940 and 1950, or homes built in the 1960's, might represent classes of
residential customers. Another good way to group residential customers is by subdivision or
development. Often homes built by a particular developer will have similar sized appliances and
construction types. Of course, if resources permit, the most accurate way to determine the loads of
your customers, is to visit each home and collect the data.
! Once estimated or collected, the customer loads may be applied to the model. However, the loads
will need to be adjusted during the analysis by a usage factor. A usage factor can be estimated by
dividing the peak-hour flow rate by the sum of the customer loads. This factor can then be applied
during the solution by setting the design factor equal to the usage factor. The value of the Design
Factor ranges greatly depending on the number of customers being served and the climate in the area
where the system is located.
Regardless of the method used to determine the customer loads, it is time consuming. Try to avoid the
temptation to be lax in your efforts to complete this task. Remember the model will be used to make very
expensive and critical decisions, therefore the model must be as accurate as practical - the loads are one of
the most critical pieces of the model's data. You will find that a little extra effort spent accurately determining
the customer loads now, will be resources well spent in the future.

Creating Gas Network Models


To accurately model a gas system, it is necessary to determine two fundamental types of data. The first is
to determine the physical configuration of the system. That is, it is necessary to determine the size and length
of each main segment, how and where each main is connected to the other mains, the location of any flow
or pressure controlling devices (regulators, compressors, or closed valves), and the location of the supply and
demand points for the system.
Usually the system configuration can be determined from system maps or system records. If the records are
incomplete or inaccurate, it is often helpful to interview the field personnel responsible for maintaining and
operating the system. Their insight can be quite useful in determining the actual configuration of the system.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

481

GASWorkS 9.0

Appendix
Table Of Contents

Secondly, the system's load (demands and supplies) must be determined. Use one of the previously described
methods to estimate the loads associated with the system being modeled.
Once all of the data is collected, it can be directly used to create the model, or it can be used to create an
intermediate schematic of the system. A schematic is a depiction or drawing showing the configuration of
the piping system. The schematic might be an actual paper drawing, or it might be created using the
GASWorkS Graphic Data Interface or a drawing created using a CAD or GIS system. In the schematic, show
each main and its connection to each other main. The schematic does not have to be to scale (however, it is
best if it is), but it should accurately reflect the way in which the system is configured.
The detail required of a model varies on its intended use, the complexity of the model, and the data available
to create the model. Rarely is a node placed at every customer location, or at every valve location, or every
pipe size or type change included in a model. The model configuration is defined by its node placement.
When considering how to construct the model and where to place nodes consider the following placement
criteria. Generally a node should be placed at the following locations:
! At each location where two or more mains intersect and are connected.
! At each location where a main changes size.
! At each supply point into the system.
! At each main termination.
! At large demand locations. Normally, customer loads can be generalized at the piping connection
nodes. However, additional nodes should be placed at any location where a large customer connects
to the system, or locations where the distance from the closest piping node and the point at which
the customer's physical connection to the system is substantial.
In order to compensate for fluctuations in atmospheric pressure, the elevation of each node will need to be
determined. Or if the total variation in elevation across the system is less than about 1000 Feet, determine
the average elevation of the system being modeled and apply the average value to each node.
If the schematic is created using a paper or CAD drawing, include the size and length of main segments on
the schematic as well as any significant node names. If the schematic was not created using the GASWorkS
GDI tools, the data will now need to be either manually entered, digitized, or imported into GASWorkS using
the appropriate method.
Once the system configuration has been entered and checked, the next task is to assign the customer loads.
There are several methods used for assigning customer loads. The methods that we most commonly
recommend are described as follows.
! Manually allocate loads for customers dispersed along a pipe segment (not using customer data
features):

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

482

GASWorkS 9.0

Appendix
Table Of Contents

1) Sum the load along each main segment connected to an individual node.
2) Divide this sum by two.
3) Apply the resulting value to the pipes node.
This method works well when working with looped, "two-way" flow configurations. When working
with a "one-way" flow (skeleton type system) you might consider applying all of the load along a
segment to the downstream node of that segment. This will result in conservative pressure drop
values. To be slightly less conservative, apply 2/3 of the segment's load to the downstream node and
1/3 to the upstream node.
! Automatically allocate loads along a main using customer data features:
1) Place and attach customer features along the main segments as appropriate.
2) Enter each customers specific load or enter a generic load for the associated customer
type.
3) Unless the customer represents a very large load, apply the load to both nodes. For
large loads, apply the load to the appropriate From or To Node.
Regardless of which assignment method is employed, discretion should always be used when applying the
loads. Large loads may warrant that a specific node be placed at their point of connection. GASWorkS
convention requires that a demand (a flow leaving the system) be indicated by a negative value, and that a
supply (a flow entering the system) be indicated by a positive value.
Now that the physical configuration of the distribution system has been defined and the customer demands
have been determined and allocated, information about the gas that will be flowing through the system and
a few other parameters need to be determined. These items are:
! A gas composition analysis for the gas taken around the period being modeled. Or if that is not
available, the specific gravity of the gas compared to dry air and the absolute viscosity of the gas.
! The average flowing temperature of the gas during the season to be modeled.
! The base pressure and temperature used to state volumes. These values represent the basis for
measuring the gas - they are usually the same as the billing pressure and temperature.
The gas analysis (or properties) can usually be obtained from the gas supplier. If an analysis is available, use
the Calculate Gas Properties routine to compute the required gas property values.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

483

GASWorkS 9.0

Appendix
Table Of Contents

To complete the mathematical model, a correct flow equation needs to be determined. The operating
pressure and system characteristics must be considered when selecting the appropriate flow equation. There
are a variety of equations available to model gas pressures and flows. You will need to select the equation
that best suits your specific application. Refer to the Equation Application Reference topic in the Appendix
section of this Manual for discussion and suggestions on selecting an appropriate flow equation.
Finally, the known operating conditions of the system need to be input. In general, GASWorkS requires that
either the pressure or load be known at each node point - but not both. There are exceptions to this rule at
regulators and compressors. Generally the pressure value will be set as Known at each node point
representing a supply, and the load value will be set as Known at nodes representing a demand - the flow
or pressure is set as Unknown as appropriate. Nodes that represent a connection with no flow entering or
leaving a system (node at a pipe size change or tee) are generally set so that the load is Known and zero
(0), and the pressure is set as Unknown. All unknown values are computed during the analysis process.
Sometimes, especially at supply points, both the flow and pressure values might be known - the normal
tendency would be to set both these values as Known - where as this is possible to do, it generally results
in an over-constrained model that will not solve or will yield unusual results. In these cases, it is generally
best to set one of the values as Known (usually the load) and let GASWorkS solve for it. This unconstrains the model and lets it solve, and also provides a check for the model accuracy.
The culmination of the above data represents the basis for the "model". This data is used to develop the
mathematical model used by GASWorkS. As mentioned earlier, the data can be directly entered into
GASWorkS or imported using one of its Import routines or using a combination of these methods. Once
entered, the model can then be manipulated and revised as necessary to correct, test, and verify the model.
Whenever possible, when working with an existing system, the solution results should be checked against
actual field data - the model should be calibrated to accurately reflect field conditions. This can be done
by comparing GASWorkS generated pressure and flow values with field collected data. Always check at
several locations in both the system and the model. A model can always be forced to match a single specific
value at a single specific point. However, the proof of a model is in the ability to match values at several
locations in the system being modeled. To calibrate a model, model results can be forced to match field
conditions by adjusting the pipe efficiencies as necessary to make a match.

Working With Gathering Systems


When working with gathering systems, a few basic issues should be considered. A gathering system is
essentially a backwards distribution system. It generally has one demand point and many supply points,
as opposed to a basic distribution system with one supply and many demands. The supply point on a
distribution system usually is equipped with a regulator, the demand point for a gathering system is generally
equipped with a compressor. Construction of the basic piping model is essentially the same as for a
distribution system - the application of the loads and settings vary however.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

484

GASWorkS 9.0

Appendix
Table Of Contents

For existing systems, there is generally quite a bit of information known about the systems operation - flow
and pressure rates at every well and possibly a flow rate and suction or discharge pressure at the compressor
(demand point) are known. GASWorkS generally requires that either the pressure or load value be set as
Unknown at each node. When working with a gathering system, where much data is known, it can be
challenging to decide which values should be fixed (Known) and which should be allowed to be calculated
(Unknown). In a gathering system, there are two ways to address this issue - set the well pressures as
Known and let the flow rates be calculated, or set the well flows as Known and let the pressures be
calculated. How the knowns and unknowns are set up at the well nodes, depends on what information is
known, and how the wells are operated (whether flow or pressure control is present).
When the well pressures are fixed (Known), the flow rates are calculated - the results from an analysis
setup in this manner will provide the estimated flow rates from the wells, while holding the well outlet
pressures at a fixed value. If a new well is added to a model using this configuration, generally the flow rates
in the other wells will be reduced because of the increased downstream pressure, attributable to the new well.
This type of analysis would provide an estimate of how much the existing well production might be reduced
by the addition of the new well.
When the well flows are fixed (Known), the pressure values are calculated - the results from an analysis
setup in this manner will provide the estimated pressures at the wells, while holding the well flow rates fixed.
If a new well is added to a model using this configuration, generally the pressures at the other wells will be
increased because of the increased downstream pressure attributable to the new well. This type of analysis
would provide an estimate of how much the existing well pressures would need to be increased to maintain
their previous production.
GASWorkS allows wells to be modeled by two different methods. The most often used method uses a single
node to represent the well location. With this method the node basically represents the well head, or if
processing or control equipment is present, the downstream connection to the equipment, or the point of flow
and pressure measurement. The other method models the well as a hydraulic element. This method requires
that the operating characteristics of the well be known or estimated. These factors are usually determined
from a multi-point flow test - which is not often available.
At the compressor end of the system, the compressor can be modeled as a hydraulic element, or the system
model can end at the suction side of the compressor. When a compressor element is present, generally the
load on the inlet (suction) side of the compressor is set as Known and zero (0). If the well pressures are
set as Known and the loads as Unknown, the inlet (suction) pressure is generally set as Unknown. If
the well flows are set as Known and the pressures as Unknown, the inlet (suction) pressure must be set
as Known. The downstream (discharge) pressure is generally set as Known. When entering a compressor
element, the From Node must represent the inlet (suction) side of the compressor, and the To Node must
represent the outlet (discharge) pressure of the compressor.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

485

GASWorkS 9.0

Appendix
Table Of Contents

Often the reason to model a gathering system is to identify bottle necks, or restrictive pipe segments. The
results produced by GASWorkS can be used to identify these locations by two methods - first and most
obvious, is by reviewing the reported segment pressure drops. The other is to attempt to calibrate the model
by adjusting the pipe efficiencies to force the model results to match the field recorded values - usually
pressure values. Pipes that require very low efficiency values (less than 75%) indicate problem areas, usually
a result of liquid build up.
Be careful when comparing pressure values between field measurement equipment and GASWorkS. Often
flow meter or flow computer data are reported in absolute pressure values, while all node pressure values
reported in GASWorkS are gauge values.
The Weymouth equation has been traditionally used to design gathering systems, however due to its
conservative nature, it does not tend to match field results very well. Depending on pipe sizes and operating
pressures, the IGT-Improved equation tends to match field results with good repeatability.
GASWorkS provides three compressor equations. Two require empirical data from a compressor operating
curve. One, the Theoretic, uses only theoretic compression characteristics. The Theoretic equation will
provide good rule-of-thumb values when used judiciously. GASWorkS models all compressors as a blackbox and does not use any of the compressor characteristics in the hydraulic analysis.

Working With Plant (Fuel Piping) Systems


When working with plant or fuel piping systems (systems downstream of the gas meter) a few basic issues
should be considered. These type of systems basically represent a small (or not so small) distribution system.
Generally these systems have one source of supply and do not contain internal looping (interconnected
supplies). Construction of the basic piping model is essentially the same as for a distribution system - the
application of the loads and settings vary however.
Instead of customers, these type of systems are generally connected directly to the demand (equipment).
For this reason, a node is generally placed at each equipment connection. The rated load of the equipment
is generally known and the supply pressure is nearly allows known.
When modeling a distribution system, it is seldom considered that all of the demands will be in service at
the same time. However, with fuel piping systems, depending on the number and nature of the equipment
that is attached, it is not unusual for all of the demands supplied by a fuel piping system to be on at the same
time. The fewer the number of appliances or equipment supplied by the system, the greater the chance that
all of the devices will be on at the same point in time.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

486

GASWorkS 9.0

Appendix
Table Of Contents

When setting up a model of a fuel piping system, generally a node is placed at each appliance or equipment
connection. The load is usually set as Known, and the pressure set as Unknown at these locations. A
node is placed at the supply point, and the pressure is set as Known and equal to the delivery value. The
appliance nodes generally represent the connection to the appliance control valve or regulator. The supply
node generally represents the outlet of meter or the service regulator, whichever is further downstream.
GASWorkS provides two pipe flow equations specifically applicable to modeling fuel piping systems - the
IMC-HP and IMC-LP equations. These equations are recognized by most mechanical and fuel gas codes. The
Oliphant equation is often cited as applicable to plant piping operating at pressures ranging from vacuum
to 100 Psig.

Working With Transmission Systems


When working with transmission systems, a few basic issues should be considered. For this discussion a
transmission system is basically considered as that portion of the overall gas system that carries gas from a
gathering system or group of systems to a processing plant, distribution system, or another transmission
system - or from another transmission line or plant to a distribution system. It characteristically contains
larger diameter pipe, operating at comparably high pressure, has long distances between connections or
interconnections, and may contain one or more compressor stations. Construction of the basic piping model
is essentially the same as for any system - the application of the loads and settings vary however.
The steady-state nature of the GASWorkS Solution routine is suitable for modeling a transmission system
with those characteristics - steady, non-transitory operating conditions. GASWorkS is not suitable for
modeling transient conditions.
Transmission systems generally have a few sources of supply and a few demand points, often with
compressors between the two. A supply point is generally modeled as a node point with a known pressure
and unknown load. Demand points are generally modeled as a node point with a known load value and an
unknown pressure value.
When including compressors, generally the load on the inlet (suction) and outlet (discharge) side of the
compressor is set as Known and zero (0) - and the outlet (discharge) pressure is set as Unknown. When
entering a compressor element, the From Node must represent the inlet (suction) side of the compressor, and
the To Node must represent the outlet (discharge) side of the compressor. A pressure must be known between
each section of the model separated by a compressor.
GASWorkS provides three compressor equations. Two require empirical data from a compressor operating
curve. One, the Theoretic, uses only theoretic compression characteristics. The Theoretic equation will
provide good rule-of-thumb values when used judiciously. GASWorkS models all compressors as a blackbox and does not use any of the compressor characteristics in the hydraulic analysis.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

487

GASWorkS 9.0

Appendix
Table Of Contents

Various flow equations are available for modeling transmission style systems. The operating pressure and
system characteristics must be considered when selecting the appropriate flow equation. There are a variety
of equations available to model gas pressures and flows. You will need to select the equation that best suits
your specific application. Refer to the Equation Application Reference topic in the Appendix section of this
Manual for discussion and suggestions on selecting an appropriate flow equation.
Often transmission systems operate at pressure values sufficient to include the affect of compressibility in
the pipe flow calculations. GASWorkS provides several methods for including the effect of compressibility.
Several of the equations require that a gas composition be present in order to support the calculation. These
values are saved in a gas properties file. Use the Calculate Gas Properties menu item in the Analysis menu
list to create and save a gas properties file. The file must be named the same as the model it is to be used
with. Currently the most accurate method of representing compressibility supported by GASWorkS is the
AGA Detailed method. The worst method is the GPSA method. Using the GPSA method will yield
unconservative results at pressure ranges over about 400 Psig. Ignoring compressibility all together, will yield
conservative results. Sometimes compressibility will be ignored during design analysis, to yield conservative
results - but will be included when trying to match existing conditions. Use of compressibility will slow
down the solution process and will increase the number of iterations required to reach solution.
Many of the pipe flow equations ignore or assume and the internal pipe wall roughness value. However, the
pipe wall roughness is actually used by some of the transmission style equations. Recommended values for
pipe wall roughness vary widely. The values included in the standard GASWorkS Pipe Property Table are
as recommended by the American Gas Association, System Design Handbook, Book D-1. The User may
revise any of the standard values as desired. Pipe diameters must be entered as a Size/Type Code included
in the Pipe Property Table, in order for the roughness values to be used during the various computation
routines.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

488

GASWorkS 9.0

Appendix
Table Of Contents

GASWorkS Data Items


GASWorkS uses a propriety database to maintain its files. The database is made up of a number of various
data files, with each file containing a set of data fields or items. The basic items contained in the customer,
node, and pipe data files are listed in the following tables.
Customer Data Items
Item Name

Item Description

Item Type

ATTRIBUTE
CONNECTION
STATUS

Attribute Connection Status

Boolean

BRANCH ID

Identifies the ID Number of a Trunk or Branch


Customer

Numeric - long integer

ID

Internal Identification Number of the Customer

Numeric - long integer

LINK ID

Link Identification Number of the Customer

Alpha-numeric up to
20 characters

LOAD

Per Unit Load

Numeric - single
precision

LOAD
ADJUSTMENT

Design Factor adjustment identifier

Boolean

LOAD STATUS

Load Status

Boolean

LOAD UNITS

Dimensional Unit for the Per Unit Load value

Dimensional Unit

NODE

Load Assignment indicator

Boolean

PIPE LINK ID

Link Identification Number of the supplying Pipe


(Main)

Alpha-numeric up to
20 characters

TAP X
COORDINATE

X (horizontal) Coordinates of the service lines


connection to the main

Numeric - single
precision

TAP Y
COORDINATE

Y (vertical) Coordinates of the service lines


connection to the main

Numeric - single
precision

UNIT COUNT

Unit Count

Numeric - short integer

X COORDINATE

X (horizontal) Coordinates of the customers


location

Numeric - single
precision

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

489

GASWorkS 9.0

Appendix
Table Of Contents
Customer Data Items

Item Name

Item Description

Item Type

Y COORDINATE

Y (vertical) Coordinates of the customers location

Numeric - single
precision

Node Data Items


Item Name

Item Description

Item Type

ATMOSPHERIC
PRESSURE

Calculated Atmospheric Pressure value associated


with the Nodes Elevation value

Numeric - single
precision

BASE LOAD

Calculated or Set Load Value

Numeric - single
precision

BASE LOAD
ADJUSTMENT

Design Factor Adjustment identifier

Boolean

BASE LOAD
KNOWN

Known/unknown identifier for Base Load value

Boolean

BASE LOAD
STATUS

On/off identifier for Base Load value

Boolean

ELEVATION

Height above sea level at the Node Location

Numeric - single
precision

EXTERNAL LOAD

The portion of the Load value from attached


customers that can be adjusted by the Design Factor

Numeric - single
precision

EXTERNAL LOAD
(FIXED)

The portion of the Load value from attached


customers that cannot be adjusted by the Design
Factor

Numeric - single
precision

EXTERNAL
LOAD
ADJUSTMENT

Design Factor Adjustment identifier

Boolean

EXTERNAL LOAD
STATUS

On/off identifier for External Load value

Boolean

HEATING VALUE

Calculated or Set Heating value at the Node


Location

Numeric - single
precision

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

490

GASWorkS 9.0

Appendix
Table Of Contents
Node Data Items

Item Name

Item Description

Item Type

LOAD UNITS

Dimensional unit for Base and External Load values

Dimensional Unit

NODE NAME

Descriptive identifier/name

Alpha-numeric up to
40 characters

PRESSURE

Calculated or Set Pressure value

Numeric - single
precision

PRESSURE KNOWN

Known/unknown identifier for Pressure value

Boolean

PRESSURE UNITS

Dimensional unit for Pressure value item

Dimensional Unit

TEMPERATURE

Calculated or Set Average Flowing Temperature at


the Node Location

Numeric - single
precision

TEMPERATURE
KNOWN

Known/unknown identifier for Base Load value

Boolean

SPECIFIC GRAVITY

Calculated or Set Specific Gravity value at the


Node Location

Numeric - single
precision

SPECIFIC HEAT
RATIO

Calculated or Set Specific Heat Ratio value at the


Node Location

Numeric - single
precision

VISCOSITY

Calculated or Set Dynamic Viscosity Gravity


value at the Node Location

Numeric - single
precision

X (horizontal) Coordinates of the Node Location

Numeric - double
precision

Y (vertical) Coordinates of the Node Location

Numeric - double
precision

Pipe Data Items


Item Name

Item Description

Item Type

ALLOW SIZING

Allow Sizing indicator for pipe type elements

Boolean

ATTRIBUTE
CONNECTION

Attribute Connection status

Boolean

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

491

GASWorkS 9.0

Appendix
Table Of Contents
Pipe Data Items

Item Name

Item Description

Item Type

COMPRESSIBILITY

Average Compressibility Factor associated with


the segment

Numeric - single
precision

CUSTOMER
COUNT

Number of Customers attached to (supplied by)


the segment

Numeric - short integer

DIAMETER UNITS

Dimensional unit for Size/Type item

Dimensional Unit

EFFICIENCY

Hydraulic Efficiency for pipes and fittings.


Mechanical Efficiency for compressor type
elements.

Numeric - single
precision

EQUATION
COEFFICIENT

Performance Equation Coefficient for well type


elements

Numeric - single
precision

EQUATION
EXPONENT

Performance Equation Exponent for well type


elements

Numeric - single
precision

EQUIVALENT
LENGTH

Equivalent Length of attached fittings for pipe


type elements

Numeric - single
precision

FACILITY TYPE

Facility Type assignment

Boolean

FITTING COUNT

Number of attached fittings for pipe type elements

Numeric - short integer

FLOW

Volumetric Flow Rate through the segment, at


base conditions

Numeric - single
precision

FLOW EQUATION

Pipe Flow Equation for pipe and fitting type


elements.

Equation Name

FLOW UNITS

Dimensional unit for Flow Rate

Dimensional Unit

FROM NODE

Name of From Node of the segment

Alpha-numeric up to
40 characters

HYDRAULIC TYPE

Hydraulic element type

Boolean

ID

Internal Identification Number of the segment

Numeric - long integer

LENGTH

Hydraulic Length for the segment

Numeric - single
precision

LENGTH UNITS

Dimensional unit for the Length value

Dimensional Unit

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

492

GASWorkS 9.0

Appendix
Table Of Contents
Pipe Data Items

Item Name

Item Description

Item Type

LINK ID

Link Identification Number of the segment

Alpha-numeric up to
20 characters

PRESSURE DROP

Linear Pressure Drop across the segment

Numeric - single
precision

SET PRESSURE

Set Pressure for regulator and compressor


hydraulic type elements

Numeric - single
precision

SET PRESSURE
UNITS

Dimensional unit for Set Pressure values

Dimensional Unit

SIZE/TYPE

Size and Type description for the segment. Inside


Diameter Value for pipes if not selected from
associated data list.

Alpha-numeric up to
20 characters

STATUS

On/off indicator for the segment

Boolean

TO NODE

Name of To Node of the segment

Alpha-numeric up to
40 characters

VALVE POSITION

Open Position for valve type elements

Numeric - single
precision

VELOCITY

Maximum Velocity associated with the flow


through the segment

Numeric - single
precision

Data Item Type Descriptions


Item Type

Description

Alpha-numeric up to
20 characters

Represents a group of alphabetic (A - Z) characters and numeric (0 - 10)


characters, and some special characters up to twenty (20) characters in length.

Alpha-numeric up to
40 characters

Represents a group of alphabetic (A - Z) characters and numeric (0 - 10)


characters, and some special characters up to forty (40) characters in length.

Boolean

Represents an either/or type value, such as on or off, yes or no.

Dimensional Unit

Represents one of the standard dimensional units supported by GASWorkS.

Equation Name

Represents one of the standard pipe flow equations supported by GASWorkS.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

493

GASWorkS 9.0

Appendix
Table Of Contents
Data Item Type Descriptions

Item Type

Description

Numeric - double
precision

Represents a decimal number. See the Program Limitations topic in the


Miscellaneous section of this Manual for additional information.

Numeric - long
integer

Represents a non-decimal (whole) number. See the Program Limitations topic


in the Miscellaneous section of this Manual for additional information.

Numeric - short
integer

Represents a non-decimal (whole) number. See the Program Limitations topic


in the Miscellaneous section of this Manual for additional information.

Numeric - single
precision

Represents a decimal number. See the Program Limitations topic in the


Miscellaneous section of this Manual for additional information.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

494

GASWorkS 9.0

Appendix
Table Of Contents

Supported Dimensional Units


GASWorkS uses a standard set of dimensional units for its internal calculations. When a value expressed
in a different unit is encountered, it is converted internally for use by GASWorkS. The following table lists
the supported dimensional units and the conversion factors used for internal use.
Unit Group

Supported Types

Conversion Factor

Coordinates

Centimeter, cm

N/A - No Calculation

Feet, ft

N/A - No Calculation

Inches, in

N/A - No Calculation

Meters, Metres, m

N/A - No Calculation

Centimeter, cm

0.3937

Feet, ft

12

Inches, in

Meters, Metres, m

39.37

Microns

0.00003937

Millimeter, mm

0.03937

Efficiency (Pipe)
(Base Units = Decimal)

Decimal

Percent, %, Percent - %

0.01

Elevation (Pipe)
(Base Units = Feet)

Feet, ft

Meters, Metres, m

3.281

Energy
(Base Units = Therms)

Btu

0.00001

kWh (thousands of watt hours)

0.03142

Mbtu (thousands of British Thermal Units)

0.01

MMBtu (millions of British Thermal


Units)

0.1

Therms

Diameter, Roughness (Pipe)


(Base Units = Inches)

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

495

GASWorkS 9.0

Appendix
Table Of Contents

Unit Group

Supported Types

Conversion Factor

Flow Rate - Load (Customer,


Node), Pipe Flow Rate
(Base Units = Cfh)

Btu/hr

See Support Equations


topic in this section of
the Manual for more
information.

Ccf/mo (hundred cubic feet per month)

0.13689

Cfd (cubic feet per day)

0.041667

Cfh (cubic feet per hour)

Cfm (cubic feet per minute)

60

Kilowatts, kW

See Support Equations


topic in this section of
the Manual for more
information.

Liters/min (liters per minute)

2.1186

M3/d, M3d (cubic meters per day)

1.47125

M^3/hr, M3/hr, M3h (cubic meters per


hour)

35.31

MBtu/hr

See Support Equations


topic in this section of
the Manual for more
information.

Mcfd (thousands of cubic feet per day)

41.667

Mcfh (thousands of cubic feet per hour)

1000

Mcf/mo (thousands of cubic feet per month)

1.3689

Mm3/d, Mm3d (thousands of cubic meters


per day)

1471.25

Mm3h (thousands of cubic meters per hour)

35310

MMcfd (millions of cubic feet per day)

41667

MMm3/d, MMm3d (millions of cubic


meters per day)

1471250

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

496

GASWorkS 9.0

Appendix
Table Of Contents

Unit Group

Heating Value
(Base Units = Btu/cf)

Length (Pipe)
(Base Units = Feet)

Pressure, Pressure Drop


(Node, Others)
(Base Units = Psi)

Bradley B Bean PE

Supported Types

Conversion Factor

MMcfh (millions of cubic feet per hour)

1000000

Btu/cf (British Thermal Units per cubic foot)

Btu/m^3 (British Thermal Units per cubic


meter)

0.028321

Joules/cf (Joules per cubic foot)

0.00094805

Joules/m^3 (Joules per cubic meter)

0.000026849

kJoules/cf, kJ/cf (thousands of Joules per


cubic foot)

0.94805

kJoule/m^3, kJ/m^3 (thousands of Joules


per cubic meter)

0.026849

MBtu/m^3 (thousands of British Thermal


Units per cubic meter)

0.00002832

MJoule/m^3, MJ/m^3 (thousands of


Joules per cubic meter)

26.849

Centimeter, cm

0.03281

Feet, ft

Inches, in

1/12

Kilometers, km

3281

Meters, Metres, m

3.281

Miles, mi

5280

Atmosphere, atm

14.7

Bar

14.504

Feet H2O, ft-wc

0.4335

Inches H20, in-wc (inches of water column)

0.03092

Inches HG, in-HG (inches of mercury)

0.491154

Kg/cm^2 (kilograms per square centimeters)

14.22

Kg/m^2 (kilograms per square meters)

0.001422

KPa (thousands of Pascals)

0.14504

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

497

GASWorkS 9.0

Appendix
Table Of Contents

Unit Group

Temperature (Node, Other)


(Base Units = Rankine)

Velocity
(Base Units = Feet/sec)

Viscosity
(Base Units = Lbm/Ft-sec)

Bradley B Bean PE

Supported Types

Conversion Factor

Millibar, mBar

0.014504

mm-H20 (millimeters of water column)

0.0014209

mm-Hg (millimeters of mercury)

0.0193367

MPa (millions of Pascals)

14504

Osi (ounces per square inch)

0.0625

Pascals, pa

0.00014504

Psi (pounds per square inch)

Celsius, C

EC * 1.8 + 491.67

Fahrenheit, F

EF + 459.67

Kelvin, K

EK * 1.8

Rankine, R

Feet/sec, Ft/sec, Fps (feet per second)

KMeters/hr, KMh (kilometers per hour)

0.91139

Meters/sec, Metres/sec, Mps (meters per


second)

3.281

Miles/hr, Mph (miles per hour)

1.4667

Centipoise, cpoise, cp

0.000672

Lbf-sec/Ft^2 (pound force second per


square foot)

32.2

Lbm/Ft-sec (pound mass per foot second)

Micropoise

6.72 E-08

Pascal-sec, pa-sec (Pascals per second)

0.672

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

498

GASWorkS 9.0

Appendix
Table Of Contents

Standard Dimensional Units


The following table describes the standard or "native" units used by GASWorkS in its Solution and
Calculation routines. All other units are converted to these native units during the computations, then
converted back to the original units when the computation is complete.
Parameter Type

Standard Dimensional Unit

Customer Loads

Cfh

Energy

Therms

Heating Value

Btu/cf

Node Pressure

Psi

Node Load

Cfh

Node Elevation

Feet

Node Temperature

Rankine

Other Temperatures

Rankine

Other Pressures

Psi

Pipe Diameter

Inches

Pipe Roughness

Inches

Pipe Length

Feet

Pipe Efficiency

Decimal

Pipe Flow Rate

Cfh

Pressure Drop

Psi

Viscosity

Lbm/ft-sec

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

499

GASWorkS 9.0

Appendix
Table Of Contents

Pipe Flow Equations


GASWorkS supports numerous industry standard pipe flow equations which are used to calculate the flow
and pressure drop of "Pipe" and "Fitting" type elements. Each equation is unique and may have individual
limitations associated with its use. The various equations supported by GASWorkS are described as follows.
The User must determine the appropriate equation to use for the application being analyzed. Unless noted
otherwise, the following base units and variable assignments apply to each equation description. Descriptions
for Regulator, Valve, Compressor, Well, and various supporting equations are described later in the Appendix
section of this Manual.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Pipe Flow Equations section:
D = Inside Pipe Diameter, Inches
= Internal Pipe Wall Roughness, Inches
E = Pipe Efficiency, percent / 100
E1 = Pipe Inlet (upstream) Elevation, Feet
E2 = Pipe Outlet (downstream) Elevation, Feet
f = Fanning Friction Factor, Dimensionless
L = Pipe Length, Feet
P = Pressure Drop across a pipe segment, Psia squared or Psia
P1 = Pipe Inlet (upstream) Pressure, Psia
P2 = Pipe Outlet (downstream) Pressure, Psia
PATM = Average Atmospheric Pressure, Psia
PAVE = Average Pressure along the pipe segment, Psia
Pb = Base Pressure, Psia
Q = Volumetric Flow Rate at the specified base pressure and temperature, Cfh
Re = Reynolds Number, Dimensionless
S = Elevation Compensation Factor, Dimensionless
SG = Specific Gravity, Dimensionless
Tb = Base Temperature, Rankine
Tf = Average Gas Flowing Temperature, Rankine
= Absolute Viscosity, Lbm/Ft-sec
Z = Compressibility Factor, Dimensionless
P1 = P1_GAUGE + PATM
P2 = P2_GAUGE + PATM
PATM = Average Atmospheric Pressure, Psia
P1_GAUGE = Gauge Pressure at inlet, Psig
P2_GAUGE = Gauge Pressure at outlet, Psig

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

500

GASWorkS 9.0

Appendix
Table Of Contents

Adjustment For Elevation


Where an elevation difference exists between the inlet and outlet of a pipe segment, and the normal pressure
difference (P) is a function of the difference of the squared inlet pressure and the squared outlet pressure
(P = P12 - P22), the pressure difference (P) term in the flow equation is replaced with the following:

Reference: American Gas Association, Steady Flow In Gas Pipelines

AGA-Fully Turbulent
The American Gas Association Fully Turbulent (AGA-Fully Turb) flow equation used by GASWorkS is
described as follows:

Reference: Gas Processors Suppliers Association, Engineering Data Book, Eleventh Edition - FPS, 1998.
Note - This equation is similar to the AGA-Turbulent equation.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

501

GASWorkS 9.0

Appendix
Table Of Contents

AGA-Partially Turbulent
The American Gas Association Partially Turbulent (AGA-Partially Turb) flow equation used by GASWorkS
is described as follows:

Reference: Gas Processors Suppliers Association, Engineering Data Book, Eleventh Edition - FPS, 1998.

AGA-Turbulent
The American Gas Association Turbulent (AGA-Turbulent) flow equation used by GASWorkS is described
as follows:

Reference: Industrial Press, Gas Engineers Handbook, 1965.


Note - This equation is similar to the AGA-Fully Turbulent equation.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

502

GASWorkS 9.0

Appendix
Table Of Contents

Colebrook
The Colebrook (White) flow equation used by GASWorkS is described as follows:

Reference: Gas Processors Suppliers Association, Engineering Data Book, Eleventh Edition - FPS, 1998.

IAPMO-High Pressure
The International Association of Plumbing and Mechanical Officials - High Pressure (IAPMO-HP) flow
equation used by GASWorkS is described as follows:

Reference: International Association of Plumbing and Mechanical Officials, Uniform Mechanical Code /
Uniform Plumbing Code, 2006.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

503

GASWorkS 9.0

Appendix
Table Of Contents

IAPMO-Low Pressure
The International Association of Plumbing and Mechanical Officials - Low Pressure (IAPMO-LP) flow
equation used by GASWorkS is described as follows:

Reference: International Association of Plumbing and Mechanical Officials, Uniform Mechanical Code /
Uniform Plumbing Code, 2006.

IGE-TD3 General
The Institution of Gas Engineers Recommendation 3 - General (IGE-TD3 General) flow equation used by
GASWorkS is described as follows:

Reference: (British) Institute Of Gas Engineers Standard - IGE/TD/3


Note - This equation is similar to the IGE3-MP equation.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

504

GASWorkS 9.0

Appendix
Table Of Contents

IGE3-Low Pressure
The Institution of Gas Engineers Recommendation 3 - Low Pressure (IGE3-LP) flow equation used by
GASWorkS is described as follows:

Reference: (British) Institute Of Gas Engineers Standard - IGE/TD/3, 2003.

IGE3-Medium Pressure
The Institution of Gas Engineers Recommendation 3 - Medium Pressure (IGE3-MP) flow equation used by
GASWorkS is described as follows:

Reference: (British) Institute Of Gas Engineers Standard - IGE/TD/3, 2003.


Note - This equation is similar to the IGE3-General equation.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

505

GASWorkS 9.0

Appendix
Table Of Contents

IGT-Improved
The Institute of Gas Technology - Improved (IGT-Improved) flow equation used by GASWorkS is described
as follows:

Reference: Gas Age Magazine, Gas Behavior In Distribution Systems, May 1967.

IMC-High Pressure
The International Mechanical Code - High Pressure (IMC-HP) flow equation used by GASWorkS is
described as follows:

Reference: International Code Council, International Mechanical Code, 1996.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

506

GASWorkS 9.0

Appendix
Table Of Contents

IMC-Low Pressure
The International Mechanical Code - Low Pressure (IMC-LP) flow equation used by GASWorkS is described
as follows:

Reference: International Code Council, International Mechanical Code, 1996.

Mueller-High Pressure
The Mueller High Pressure (Mueller-HP) flow equation used by GASWorkS is described as follows:

Reference: American Gas Association, Gas Engineering and Operating Practices - System Design,
GEOP Series Book D-1, 1990.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

507

GASWorkS 9.0

Appendix
Table Of Contents

Mueller-Low Pressure
The Mueller Low Pressure (Mueller-LP) flow equation used by GASWorkS is described as follows:

Reference: American Gas Association, Gas Engineering and Operating Practices - System Design,
GEOP Series Book D-1, 1990.

Oliphant
The Oliphant flow equation used by GASWorkS is described as follows:

Reference: Gas Processors Suppliers Association, Engineering Data Book, Eleventh Edition - FPS, 1998.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

508

GASWorkS 9.0

Appendix
Table Of Contents

Panhandle-A
The Panhandle-A flow equation used by GASWorkS is described as follows:

Reference: Gas Processors Suppliers Association, Engineering Data Book, Eleventh Edition - FPS, 1998.

Panhandle-B
The Panhandle-B flow equation used by GASWorkS is described as follows:

Reference: Gas Processors Suppliers Association, Engineering Data Book, Eleventh Edition - FPS, 1998.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

509

GASWorkS 9.0

Appendix
Table Of Contents

Pole-Low Pressure
The Pole Low Pressure (Pole-LP) flow equation used by GASWorkS is described as follows:

Reference: Industrial Press, Gas Engineers Handbook, 1965.

Spitzglass-High Pressure
The Spitzglass High Pressure (Spitzglass-HP) flow equation used by GASWorkS is described as follows:

Reference: Industrial Press, Gas Engineers Handbook, 1965.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

510

GASWorkS 9.0

Appendix
Table Of Contents

Spitzglass-Low Pressure
The Spitzglass Low Pressure (Spitzglass- LP) flow equation used by GASWorkS is described as follows:

Reference: Industrial Press, Gas Engineers Handbook, 1965.

Weymouth
The Weymouth flow equation used by GASWorkS is described as follows:

Reference: Gas Processors Suppliers Association, Engineering Data Book, Eleventh Edition - FPS, 1998.

Equation Application Reference


The following table provides application notes and comments for each of the equations supported by
GASWorkS. This table represents only a portion of the full collection of equations available for calculating
pressure and flow in gas piping systems. Equations are added to GASWorkS based on User requests. If a
User requires a specific equation and the equation can be documented, we may be willing to add the equation
to the software.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

511

GASWorkS 9.0

Appendix
Table Of Contents

Equation Name

Application Comments

AGA-Fully Turbulent
(AGA-Fully Turb)

Applicable to transmission systems with fully turbulent flow conditions.


Accounts for relative pipe roughness using rough pipe law. This form of the
equation allows input of the pipe wall roughness value. Depending on the
pipe wall roughness, yields moderately conservative results compared to
other transmission style equations.

AGA-Partially Turbulent
(AGA-Partially Turb)

Applicable to transmission systems with partially turbulent flow conditions.


Accounts for relative pipe roughness using the smooth pipe law. Moderately
conservative compared to other transmission style equations.

AGA-Turbulent

Applicable to transmission systems with fully turbulent flow conditions. Uses


a fixed relative pipe roughness with the rough pipe law. Moderately
conservative compared to other transmission style equations.

Colebrook

Applicable to transmission systems. Applies the Moody friction factor to the


Fundamental Gas Flow equation, using the Colebrook-White approximation.
Results vary based on value of roughness.

IAPMO - High Pressure


(IAPMO-HP)

Applicable to fuel piping systems operating at 1.5 Psig (10 kPa) and above.
A high pressure version of the Polyflo equation adopted by the International
Association of Plumbing and Mechanical Officials.

IAPMO - Low Pressure


(IAPMO-LP)

Applicable to fuel piping systems operating at less than 1.5 Psig (10 kPa). A
low pressure version of the Polyflo equation adopted by the International
Association of Plumbing and Mechanical Officials.

IGE3 - General
(IGE-TD3 General)

Applicable to general distribution systems. Developed by the British Gas


Engineers Institute. Recommended for pressures less than or equal to 101.5
Psig (7 Bar).

IGE3 - Low Pressure


(IGE3-LP)

Applicable to low pressure distribution systems. Developed by the British


Gas Engineers Institute. A modified version of the IGE3 - General equation
for use at pressures less than or equal to 1.1 Psig (75 mBar).

IGE3 - Medium Pressure


(IGE3-MP)

Applicable to medium pressure distribution systems. Developed by the


British Gas Engineers Institute. A modified version of the IGE3 - General
equation for use at pressures greater than 1.1 Psig (75 mBar) and less than or
equal to 29 Psig (2 Bar).

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

512

GASWorkS 9.0

Appendix
Table Of Contents

Equation Name

Application Comments

IGT-Improved

Applicable to distribution systems, though often used for all types of systems
operating between 1 to 500 Psig. Yields moderate results. Developed in the
1960's.
The Gas Engineers Handbook notes that this equation is widely used for ten
inch water column to sixty Psig systems for two inch and larger diameter
pipe.
The AGA GEOP text reports that this equation is applicable to distribution
systems where the Reynolds numbers range between 16000 and 3000000
with 2% deviation from the smooth pipe law, and for 3 to 30 Inch diameter
pipe operating at inches water column, 1.5 to 20 Inch diameter pipe operating
between 2 and 20 Psig, and 0.75 to 120 Inch diameter pipe operating between
20 and 100 Psig.
Reynolds number dependent.

IMC-High Pressure
(IMC-HP)

Applicable to fuel piping systems operating at 1.5 Psig (10 kPa) and higher.
A high pressure version of the Polyflo equation adopted by the International
Code Council.

IMC-Low Pressure
(IMC-LP)

Applicable to fuel piping systems operating at less 1.5 Psig (10 kPa). A low
pressure version of the Polyflo equation adopted by the International Code
Council.

Mueller High Pressure


(Mueller-HP)

Applicable to distribution systems. Yields non-conservative results.


The Gas Engineers Handbook reports that the equation is accurate in low
pressure systems for up to eight inch pipe, and in medium pressures for up
to two inch pipe.
The AGA GEOP text reports that this equation is applicable to distribution
systems where the Reynolds numbers range between 2000 and 125000 with
2% deviation from the smooth pipe law, and for 0.375 to 6 Inch diameter pipe
operating at inches water column, 0.375 to 2 Inch diameter pipe operating
between 2 and 20 Psig, and 0.375 to 1.5 Inch diameter pipe operating
between 20 and 100 Psig.
Reynolds number dependent.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

513

GASWorkS 9.0

Appendix
Table Of Contents

Equation Name

Application Comments

Mueller Low Pressure


(Mueller-LP)

Applicable to distribution systems. Yields non-conservative results.


Derived from Mueller - High Pressure equation as outlined in AGA GEOP
text.
Reynolds number dependent.

Oliphant

Applicable to plant piping and gathering systems operating between vacuum


and 100 Psig. Yields conservative results.
Not Reynolds number dependent - diameter dependent.

Panhandle-A

Applicable to transmission systems. Yields moderate results. Developed in


the 1940's.
The Gas Engineers Handbook reports that the equation is applicable for large
diameter transmission piping where the Reynolds numbers range between 5
and 20 million. The Handbook also suggests an average efficiency for steel
pipelines of 0.92 for this equation.
The GPSA Data Book reports that this equation is intended to reflect flow of
gas through smooth pipes. When used with an efficiency of 0.90 the equation
reasonably approximates the partially turbulent general flow equation. The
equation becomes less accurate as the flow rate increases. An efficiency of
0.92 is often used with this equation.
The AGA GEOP text reports that this equation is applicable to distribution
systems where the Reynolds numbers range between 1300000 and 75000000
with 2% deviation from the smooth pipe law. And 16 Inch and larger
diameter pipe operating for 20 Psig and higher.
Reynolds number dependent.

Panhandle-B

Applicable to transmission systems. A revised version of Panhandle-A,


published in 1956. Depending on the flow rate, it can be the least
conservative transmission equation.
The Gas Engineers Handbook notes that the equation is applicable for large
diameter transmission piping where the Reynolds numbers range between 5
and 20 million. The Handbook suggests an average efficiency for steel
pipelines of 0.90 for this equation.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

514

GASWorkS 9.0

Appendix
Table Of Contents

Equation Name

Application Comments
The GPSA Data Book notes that this equation more nearly approximates the
fully turbulent general flow equation. The equation will under-estimate flow
rates at low flow rates, and over estimate flow rates at high flow rates.
Efficiency factors of 0.88 to 0.94 are often used with this equation.
Reynolds number dependent.

Pole Low Pressure


(Pole-LP)

Applicable to fuel and yard line piping operating below 3 Psig. Yields
conservative results.
The Gas Engineers Handbook notes that this equation is widely used for four
to ten water column pressure systems for two to four inch diameter pipe. The
equation is applicable with effective pipe roughness values of up to ten times
that of clean steel pipe.
Not Reynolds number dependent - constant friction/transmission factor.

Spitzglass High Pressure


(Spitzglass-HP)

Applicable to distribution systems operating below 100 Psig. Yields


conservative results.
The Gas Engineers Handbook reports that this equation is widely used for up
to 10 Inch diameter pipe, and is applicable with effective pipe roughness
values of up to ten times that of clean steel pipe.
Not Reynolds number dependent - diameter dependent.

Spitzglass Low Pressure


(Spitzglass-LP)

Applicable to low pressure distribution systems operating below 3 Psig.


Yields moderate results.
The Gas Engineers Handbook reports that this equation is widely used for
systems operating under 1 Psig.
The AGA GEOP text reports that this equation was developed from flow tests
on large diameter cast iron pipe operated at inches water column pressures
and partially turbulent flow conditions. The equation was originally used in
flow calculations in low pressure cast iron systems. The text also reports that
the equation yields extremely conservative results for 16 Inch and larger
diameter pipes, and yields un-conservative results for pipes sizes less than 16
Inch.
Not Reynolds number dependent - diameter dependent.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

515

GASWorkS 9.0

Appendix
Table Of Contents

Equation Name

Application Comments

Weymouth

Applicable to transmission systems, though often used for distribution,


gathering, and transmission. The equation yields conservative results. It was
published in 1912.
The Gas Engineers Handbook reports that this equation provides a reasonable
approximation of the general rough pipe equation for diameter equal to 10
Inch, and effective pipe wall roughness equal to 0.002 Inches. The Handbook
also suggests that the equation is widely used for 3 to 20 Psig systems. Also,
the Handbook suggests an average efficiency for steel pipelines of 1.10 for
this equation.
The GPSA Data Book reports that for short pipelines and gathering systems
this equation agrees closely with metered volumes. However, the degree of
error increases with pressure.
The AGA GEOP text reports that the applicable efficiency factor for this
equation is 1.00 for 36 Inch diameter pipe and can range from 1.10 to 2.00 for
30 Inch and smaller pipe in transmission service. The text suggests that the
efficiency factor ranges between 1.1 and 1.2 for 2 to 6 Inch diameter pipe in
distribution service. And the text further suggests that the equation is not
applicable to calculations in distribution systems.
Not a Reynolds number dependent equation.

References
American Gas Association, Gas Engineering and Operating Practices - System Design, GEOP
Series Book D-1, 1990.
American Gas Association, Steady Flow In Gas Pipelines, Technical Report No. 10.
British Gas Engineers Institute, Standard IGE/TD/3, Recommendations On Transmission And
Distribution Practice, Edition 4, 2003.
Crane Technical Paper No. 410, Flow Of Fluids Through Valves, Fittings, And Pipe.
Gas Processors Suppliers Association, Engineering Data Book, Volume II.
Gulf Publishing Company, Pipeline Rules of Thumb Handbook.
Industrial Press, Gas Engineers Handbook, 1965.
International Association of Plumbing and Mechanical Officials, Uniform Mechanical Code, 2006.
International Code Council, International Mechanical Code, 1996.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

516

GASWorkS 9.0

Appendix
Table Of Contents

Recommendations
As can be seen by the number and variety of flow equations listed in the previous table, there seems to be
no certain flow equation that accurately reflects all of the conditions that can be present in all types of gas
piping systems. Obviously there is not one equation that meets all requirements, or there wouldnt be such
a variety to choose from. For that reason, the User must ultimately compare their specific application to each
equations performance and select an appropriate equation. Further, it is extremely difficult to recommend
a flow equation because of the variety of applications that Users might encounter. However, generally we
make the following recommendations - use at your own risk:
Application

Equation

Low Pressure Distribution


(less than 3 Psig)

Spitzglass LP

Medium and High Pressure Distribution


(3 to 100 Psig)

IGT-Improved

Low Pressure Transmission


(100 to 300 Psig)

IGT-Improved

High Pressure Transmission


(300 Psig and greater)

Panhandle-A

Vacuum Gathering

Oliphant

Low Pressure Gathering


(less than 100 Psig)

IGT-Improved

High Pressure Gathering


(100 Psig and greater)

IGT-Improved
Weymouth

Vacuum Plant Piping

Oliphant

Low Pressure Plant or Fuel Piping


(less than 1.5 Psig)

IAPMO-LP
IMC-LP

Medium Pressure Plant or Fuel Piping


(1.5 to 10 Psig)

IAPMO-HP
IGT-Improved
IMC-HP

High Pressure Plant or Fuel Piping


(10 to 100 Psig)

IGT-Improved
Oliphant

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

517

GASWorkS 9.0

Appendix
Table Of Contents

Regulator Flow Equations


GASWorkS supports the calculation of the various values associated with the flow through a regulator using
a variety of industry and manufacturer equations. The various equations supported by GASWorkS are
described as follows.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Regulator Flow Equations section:
k = Specific Heat Ratio, Dimensionless
P1 = Pipe Inlet (upstream) Pressure, Psia
P2 = Pipe Outlet (downstream) Pressure, Psia
Q = Volumetric Flow Rate at the specified Base Pressure and Temperature, Cfh
SG = Specific Gravity, Dimensionless
Tf = Average Gas Flowing Temperature, Rankine
Z = Compressibility Factor, dimensionless
P1 = P1_GAUGE + PATM
P2 = P2_GAUGE + PATM
PATM = Average Atmospheric Pressure, Psia
P1_GAUGE = Gauge Pressure at inlet, Psig
P2_GAUGE = Gauge Pressure at outlet, Psig

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

518

GASWorkS 9.0

Appendix
Table Of Contents

Grove
The Grove Regulator flow equation used by GASWorkS is described as follows:

Reference: Grove Bulletin No. 900TE/S, Sizing The Grove Model 900 TE

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

519

GASWorkS 9.0

Appendix
Table Of Contents

Grove 80
The Grove 80 (Grove80) flow equation used by GASWorkS is described as follows:

Reference: Grove Publication Sk-4-149, Grove Model 80 Flexflo.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

520

GASWorkS 9.0

Appendix
Table Of Contents

Rockwell
The Rockwell flow equation used by GASWorkS is described as follows:

Reference: Equimeter Inc, Bulletin Model 441-57S, R-1360 Rev 4. Rockwell International, Bulletin
Model 441-57S, R 1360 Rev 3.

Universal
The Universal flow equation used by GASWorkS is described as follows:

Reference: Mooney Controls, Sizing - Compressible Gases

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

521

GASWorkS 9.0

Appendix
Table Of Contents

Valve Flow Equations


GASWorkS supports the calculation of the various values associated with the flow through a relief valve
using a variety of industry and manufacturer equations. The various equations supported by GASWorkS are
described as follows.

Equation Variables
Unless noted otherwise, the following base units and variable definitions apply to all of the methods and
equations described in the Valve Flow Equations section:
Ev = Throttling Factor Value, Dimensionless
P1 = Pipe Inlet (upstream) Pressure, Psia
P2 = Pipe Outlet (downstream) Pressure, Psia
Q = Volumetric Flow Rate at the specified Base Pressure and Temperature, Cfh
SG = Specific Gravity, Dimensionless
Tf = Average Gas Flowing Temperature, Rankine
Z = Compressibility Factor, Dimensionless
P1 = P1_GAUGE + PATM
P2 = P2_GAUGE + PATM
PATM = Average Atmospheric Pressure, Psia
P1_GAUGE = Gauge Pressure at inlet, Psig
P2_GAUGE = Gauge Pressure at outlet, Psig

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

522

GASWorkS 9.0

Appendix
Table Of Contents

Crane
The Crane valve flow equation used by GASWorkS is described as follows:

Reference: Crane Technical Paper No. 410, Flow of Fluids Through Valves, Fittings, and Pipe.

Grove-Regulator
When modeling wide-open or otherwise upset regulators using the Grove (Grove-Reg) flow equation,
GASWorkS uses the following flow-pressure relationship:

Reference: Grove Bulletin No. 900TE/S, Sizing The Grove Model 900 TE.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

523

GASWorkS 9.0

Appendix
Table Of Contents

Rockwell
The values associated with the flow through a relief valve using the Rockwell flow equation are computed
using the following formulas. The equation is suitable for use with certain models of Rockwell relief valves.

Reference: Rockwell Publication V-117-R3, Flow Characteristics of Rockwell Plug Valves.

Rockwell-Regulator
When modeling wide-open or otherwise upset regulators using the Rockwell Regulator (RW-Reg) flow
equation, GASWorkS uses the following flow-pressure relationship:

Reference: Rockwell Regulator Bulletins

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

524

GASWorkS 9.0

Appendix
Table Of Contents

Universal-Regulator
Note that the Universal Regulator equation is an approximation of the "standard" Universal Valve Sizing
equation. When modeling wide-open or otherwise upset regulators using the Universal Regulator (Univ-Reg)
flow equation, GASWorkS uses the following flow-pressure relationship:

Reference: None

Valve Throttling Factor


The following table summarizes the values of the Throttling Factor, based on the specified %-Open value.
This relationship actually only applies to venturi type plug valves, however in the absence of information
for other valve types, it is used by GASWorkS as an approximate value for all valve types.
%-Open Value

Bradley B Bean PE

Throttling Factor Value, Ev

100

1.0

90

1.0

80

0.55

70

0.33

60

0.21

50

0.12

40

0.06

30

0.04

20

0.03

10

0.02

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

525

GASWorkS 9.0

Appendix
Table Of Contents

Reference: Rockwell Publication V-117-R3, Flow Characteristics of Rockwell Plug Valves

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

526

GASWorkS 9.0

Appendix
Table Of Contents

Compressor Power Equations


The equations used by GASWorkS to estimate compressor power requirements are described as follows.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Compressor Power Equations section:
Em = Compressor Efficiency, percent / 100
HP = Power, Horsepower
k = Specific Heat Ratio, Dimensionless
P1 = Pipe Inlet (upstream) Pressure, Psia
P2 = Pipe Outlet (downstream) Pressure, Psia
Pb = Base Pressure, Psia
Q = Volumetric Flow Rate at the specified Base Pressure and Temperature, Cfh
R = Compression Ratio, Dimensionless
Tb = Base Temperature, Rankine
Tf = Average Flowing Temperature, Rankine
Zf = Compressibility Factor at P1, Dimensionless
P1 = P1_GAUGE + P1_ATM
P2 = P2_GAUGE + P2_ATM
P1_GAUGE = Gauge Pressure at first conditions, Psig
P2_GAUGE = Gauge Pressure at second conditions, Psig
P1_ATM = Atmospheric Pressure at first conditions, Psia
P2_ATM = Atmospheric Pressure at second conditions, Psia

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

527

GASWorkS 9.0

Appendix
Table Of Contents

Empirical 1
The Empirical 1" (Empirical1) compressor power equation used by GASWorkS is described as follows:

Reference: None - Hand-me-down

Empirical 2
The Empirical 2" (Empirical2) compressor power equation used by GASWorkS is described as follows:

Reference: Gulf Publishing Company, Pipe Line Rules Of Thumb Handbook, McAllister, Fourth Edition,
1998.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

528

GASWorkS 9.0

Appendix
Table Of Contents

Theoretic
The Theoretic compressor power equation used by GASWorkS is described as follows:

Reference: McGraw-Hill Book Company, De Laval Engineering Handbook, Third Edition, 1970.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

529

GASWorkS 9.0

Appendix
Table Of Contents

Well Equation
GASWorkS supports only one well equation, it is described as follows. The equation constants are calculated
from a multi-point fit of the well's performance curve.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Well Equation section:
C = Performance Coefficient
E = Performance Factor
n = Equation Exponent
N = Number of Wells represented
P1 = Shut-in or Static Top Hole Pressure, Psia
P2 = Flowing Top Hole Pressure, Psia
Q = Top Hole Volumetric Flow Rate at the specified Base Pressure and Temperature, Cfh

Reference: Industrial Press, Gas Engineers Handbook, 1965.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

530

GASWorkS 9.0

Appendix
Table Of Contents

Support Equations
GASWorkS uses several equations to support its various flow, pressure drop, and power equations. These
support equations are described as follows.

Atmospheric Pressure
As used by GASWorkS, the atmospheric pressure refers to the pressure that the atmosphere exerts on an
object at a given elevation. It is similar to barometric pressure, but not the same. As used in most analysis
in the gas industry, the atmospheric pressure represents the pressure associated with a standard
atmosphere, not the actual atmosphere (which changes constantly). The atmosphere extends from the surface
of the earth to the edge of outer space. The approximate depth (or height) of the atmosphere is 25 Miles
(132,000 Feet). At sea level the atmospheric pressure is about 14.7 Psia, this is the pressure exerted on an
object at sea level. It represents the weight of the 25 Miles of atmosphere above the object. As an object is
elevated, the amount of atmosphere above it, and therefore the weight upon it is reduced. Because the weight
of the atmosphere upon the object at its new elevation is reduced, the amount of pressure exerted on the
elevated object is also reduced.
The same holds true for changes in the geographic elevation of a gas piping system. As the elevation of the
system increases, the atmospheric pressure decreases. Gas is a compressible fluid, as such its physical
properties are affected by the amount of pressure exerted on it. As an example, a cubic foot of gas collected
in a balloon at 6000 Feet, will contract to a volume less than the original one cubic foot when transported
to a lower elevation. Why? Because it is a compressible fluid and at the decreased elevation, the pressure
exerted on the balloon is greater than its original collection elevation, compressing the gas in the balloon.
The inverse holds true for an increase in elevation. If the balloon were to be elevated, the original cubic foot
of gas would expand because of a decrease in the atmospheric pressure at the new, higher elevation.
Because changes in atmospheric pressure affect the properties of the gas and the absolute pressure values,
they need to be compensated for when modeling a system. GASWorkS uses the node elevation values to
calculate the atmospheric pressure for each node. Where significant elevation changes are present in the
system, the elevation for each node should be determined and applied. Where elevation changes are not
significant, an average elevation may be determined and applied to all nodes.
Unfortunately there are several methods available to estimate the atmospheric pressure at elevated heights
above sea level. Each method provides different values and disagree on the value at sea level. Fortunately,
in most pipe flow calculations, the actual absolute value of the atmospheric pressure generally is not critical,
so long as the relative differences between the various elevation values are representative. The atmospheric
pressure equations supported by GASWorkS are described as follows.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

531

GASWorkS 9.0

Appendix
Table Of Contents

AGA Method
The Atmospheric Pressure as calculated by the American Gas Association (AGA) method is described as
follows:

Reference: American Gas Association, Measurement, GEOP Series Book M-1, 1993.

Handbook Of Chemistry & Physics Method


The Atmospheric Pressure as calculated by the Handbook Of Chemistry & Physics method is described as
follows:

Reference: CRC Press, CRC Handbook Of Chemistry & Physics, 73rd Edition, 1992.

ISHM Method
The Atmospheric Pressure as calculated by the International School of HydroCarbon Measurement (ISHM)
method is described as follows:

Reference: International School of Hydrocarbon Measurement, Practical Methods, Report 4, 1976.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Atmospheric Pressure section.
E1 = Pipe Inlet (upstream) Elevation, Feet
E2 = Pipe Outlet (downstream) Elevation, Feet
ELEV = Average Elevation (E1 + E2)/2, Feet
PATM = Average Atmospheric Pressure, Psia

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

532

GASWorkS 9.0

Appendix
Table Of Contents

Average Pressure
Some computations made by GASWorkS require the determination of the average pressure value along a
pipe segment. When required, the average pressure is calculated as follows:

Reference: Gas Processors Suppliers Association, Engineering Data Book, 1998.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Average Pressure section.
P1 = Pipe Inlet (upstream) Pressure or first specified pressure, Psia
P2 = Pipe Outlet (downstream) Pressure or second specified pressure, Psia
PAVE = Average Pressure value, Psia
P1 = P1_GAUGE + P1_ATM
P1_ATM = Atmospheric Pressure at first conditions, Psia
P1_GAUGE = Gauge Pressure at first conditions, Psig
P2 = P2_GAUGE + P2_ATM
P2_ATM = Atmospheric Pressure at second conditions, Psia
P2_GAUGE = Gauge Pressure at second conditions, Psig

Energy To Volume Conversion


When load values are entered in energy type units (Kilowatt, Btu/hr, etc) they are converted to volumetric
flow rates as follows:

Reference: None - Derived

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

533

GASWorkS 9.0

Appendix
Table Of Contents

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Energy To Volume Comparison section.
QE = Energy Usage Rate, Dimensional Unit Varies
HV = Volumetric Heating Value of the Gas, Btu/cf.
X = Unit Conversion Factor,
Kilowatt = 3415.2
Btu/hr = 1
Mbtu/hr = 1,000

Pipe Flow Velocity


The pipe flow velocities reported by GASWorkS are calculated as follows:

Reference: None - Derived

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Pipe Flow Velocity section:
D = Inside Diameter of Tap Opening, Inches
P = Lowest Pressure along the Pipe for Maximum Velocity values
P = Average Pressure along the Pipe for Average Velocity values
Pb = Base Pressure, Psia
Q = Volumetric Flow Rate at the specified Base Pressure and Temperature, Cfh
TAVE = Average Gas Flowing Temperature, Rankine
Tb = Base Temperature, Rankine

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

534

GASWorkS 9.0

Appendix
Table Of Contents

Pipe Hoop Stress


The pipe hoop stress reported by GASWorkS is calculated as follows:

Reference: None - Derived

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Pipe Hoop Stress section:
D = Diameter of the Pipe Segment, Inches
P = Operating Pressure of the Pipe Segment, Psig
SHOOP = Hoop Stress on the Pipe Segment, Psi
t = Wall Thickness for the Pipe Segment, Inches

Pipe Volume
The pipe volume reported by GASWorkS is calculated as follows:

Reference: Gas Processors Suppliers Association, Engineering Data Book, 1998.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Pipe Volume section:
D = Inside Diameter or Equivalent Diameter of the Pipe Segment(s), Inches
L = Length or Equivalent Length of the Pipe Segment(s), Feet
= 3.141592
PAVE = Average Pressure, Psia
Pb = Base Pressure, Psia

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

535

GASWorkS 9.0

Appendix
Table Of Contents

Tb = Base Temperature, Rankine


TAVE = Average Temperature, Rankine
V = Amount of Gas contained in the Segment(s) at the Average Pressure and Temperature, adjusted
to the Base Pressure and Temperature, Cf
ZAVE = Average Compressibility, Dimensionless
PAVE = PAVE_GAUGE + PATM
PATM = Average Atmospheric Pressure, Psia
PAVE_GAUGE = Average Gauge Pressure, Psig

Reynolds Number
The Reynolds Number as used by GASWorkS is described as follows:

Reference: American Gas Association, Gas Engineering and Operating Practices - System Design,
GEOP Series Book D-1, 1990.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Reynolds Number section:
D = Inside Diameter of Tap Opening, Inches
Pb = Base Pressure, Psia
Re = Reynolds Number, Dimensionless
Q = Volumetric Flow Rate at the specified Base Pressure and Temperature, Cfh
SG = Specific Gravity, Dimensionless
Tb = Base Temperature, Rankine
= Absolute Viscosity, Lbm/ft-sec

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

536

GASWorkS 9.0

Appendix
Table Of Contents

Specific Heat Values


Some computations made by GASWorkS require the use of either the specific heat ratio or an individual
specific heat values. When required, these values are calculated as follows:

Reference: McGraw-Hill, De Laval Engineering Handbook

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Specific Heat Values section.
CP = Specific Heat at Constant Pressure, Btu/Lbm-degree Fahrenheit
CV = Specific Heat at Constant Volume, Btu/Lbm-degree Fahrenheit
k = Specific Heat Ratio, Dimensionless
SG = Specific Gravity, Dimensionless

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

537

GASWorkS 9.0

Appendix
Table Of Contents

Compressibility Methods
Natural gas mixtures represent a real gas and deviate from the ideal gas laws. This deviation becomes more
pronounced at elevated pressures. The compressibility factor is used to accommodate for these deviations.
GASWorkS allows selection of one of several methods to calculate the compressibility factor when
applicable. These support equations are described as follows.

AGA8-92-Detailed
This method uses the procedures outlined in the American Gas Association Report No. 8, "Compressibility
Factors of Natural Gas and Other Related Hydrocarbon Gases", Second Edition, November 1992, Second
Printing July 1994 for the "Detailed Characterization Method". This method is based on the mole fraction
values of each component in the associated gas composition. The full details of this method are too extensive
to include in this document, refer to Reference 1 for further information on the calculation of the
compressibility using this method.
To use this method a common gas properties file must be assigned to the model. Select the Calculate Gas
Properties menu item from the Analysis menu list to create and save the required gas property file. This
method requires a complete description of all of the components found in the gas mixture.

AGA8-92-Gross-1
This method uses the procedures outlined in the American Gas Association Report No. 8, "Compressibility
Factors of Natural Gas and Other Related Hydrocarbon Gases", Second Edition, November 1992, Second
Printing July 1994 for the"Gross Characterization Method - Method 1". This method is based on the
volumetric gross heating value, relative density (specific gravity) value, and the mole fraction of the carbon
dioxide component of the associated gas composition. The full details of this method are too extensive to
include in this document, refer to Reference 1 for complete information on the calculation of the
compressibility using this method.
To use this method a common gas properties file must be assigned to the model. Select the Calculate Gas
Properties menu item from the Analysis menu list to create and save the required gas property file. This
method requires that the heating value, specific gravity, and the carbon dioxide component of the gas mixture
be identified.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

538

GASWorkS 9.0

Appendix
Table Of Contents

AGA8-92-Gross-2
This method uses the procedures outlined in the American Gas Association Report No. 8, "Compressibility
Factors of Natural Gas and Other Related Hydrocarbon Gases", Second Edition, November 1992, Second
Printing July 1994 for the "Gross Characterization Method - Method 2". This method is based on the relative
density (specific gravity) value, and the mole fractions of the carbon dioxide and nitrogen components of the
associated gas composition. The full details of this method are too extensive to include in this document,
refer to Reference 1 for complete information on the calculation of the compressibility using this method.
To use this method a common gas properties file must be assigned to the model. Select the Calculate Gas
Properties menu item from the Analysis menu list to create and save the required gas property file. This
method requires that specific gravity, and the carbon dioxide and nitrogen components of the gas mixture
be identified.

References
1. American Gas Association, AGA Report No 8, Compressibility of Natural Gas and Other Related
Hydrocarbon Gases, 1992.

GPSA
The GPSA compressibility method used by GASWorkS is calculated as follows:

Reference: Gas Processors Suppliers Association, Engineering Data Book, Eleventh Edition - FPS, 1998.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

539

GASWorkS 9.0

Appendix
Table Of Contents

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Compressibility Methods section:
P1 = Pressure at First Conditions, Psia
P2 = Pressure at Second Conditions, Psia
PAVE = Average Pressure at Flowing Conditions, Psia
SG = Specific Gravity of the gas mixture, Dimensionless
Tf = Temperature at Flowing Conditions, Rankine
Z = Compressibility Factor, Dimensionless

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

540

GASWorkS 9.0

Appendix
Table Of Contents

Temperature Calculations
GASWorkS uses several equations to support its various temperature (thermal) calculations. These support
equations are described as follows.

Average Temperature
Often computations made by GASWorkS require the determination of the average temperature value along
a pipe segment. When required, the average temperature is calculated as follows:

Reference: None - Derived

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Average Temperature section:
T1 = Pipe Inlet (upstream) Temperature or first specified temperature, Rankine
T2 = Pipe Outlet (downstream) Temperature or second specified temperature, Rankine
TAVE = Average Temperature value, Rankine

Outlet Temperature - Compressor


The outlet temperature of a compressor is estimated as follows:

Reference: Gulf Publishing Company, Pipe Line Rules Of Thumb Handbook, McAllister, Fourth Edition,
1998.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

541

GASWorkS 9.0

Appendix
Table Of Contents

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Compressor Outlet Temperature section:
k = Specific Heat Ratio, Dimensionless
P1 = Pipe Inlet (upstream) Pressure, Psia
P2 = Pipe Outlet (downstream) Pressure, Psia
R = Compression Ratio, Dimensionless
T1 = Inlet Gas Flowing Temperature, Rankine
T2 = Outlet Gas Flowing Temperature, Rankine
P1 = P1_GAUGE + P1_ATM
P2 = P2_GAUGE + P2_ATM
P1_ATM = Atmospheric Pressure at First Conditions, Psia
P2_ATM = Atmospheric Pressure at Second Conditions, Psia
P1_GAUGE = Gauge Pressure at First Conditions, Psig
P2_GAUGE = Gauge Pressure at Second Conditions, Psig

Joule-Thomson Temperature Drop


The temperature drop across regulators and along pipe segments is estimated by the following relationship.
Note that this is an approximate equation and is only valid for natural gas mixtures composed largely of
methane.

Reference: Gulf Publishing Company, Pipe Line Rules of Thumb Handbook, Fourth Edition, 1998.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Joule-Thomson Temperature Drop section:
P1 = Inlet Pressure, Psia
P2 = Outlet Pressure, Psia
PATM = Average Atmospheric Pressure, Psia
T = Temperature Change, Fahrenheit

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

542

GASWorkS 9.0

Appendix
Table Of Contents

Pipe Temperature Change - Overall Transfer Coefficient


The outlet temperature of the gas flowing through a pipe segment based on an overall heat transfer
coefficient is calculated as follows. This method predicts the outlet temperature of a pipe segment by using
an overall heat transfer coefficient between the gas and the environment.

Reference: Gas Processors Suppliers Association, Engineering Data Book, Eleventh Edition - FPS, 1998.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Pipe Temperature Change - Overall Transfer Coefficient section:
CP = Constant Pressure Specific Heat, Dimensionless
D = Inside Diameter, Inches
e = Napierian Constant, 2.71828
L = Physical Length, Feet
= 3.141592
Q = Volumetric Flow Rate, Ft^3/Hr
= Average Gas Density, Lbm/Ft^3
T1 = Inlet Temperature, Fahrenheit
T2 = Outlet Temperature, Fahrenheit
Tamb = Ambient Temperature, Fahrenheit
U = Overall Heat Transfer Coefficient, Btu/(Hr-Ft^2-F)

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

543

GASWorkS 9.0

Appendix
Table Of Contents

Pipe Temperature Change - Convection


The outlet temperature of the gas flowing through a pipe segment based on convection (film) heat transfer
is calculated using the following equation. The method was derived from various sources including the noted
references. This method predicts the outlet temperature of a pipe segment by assuming that the heat transfer
occurs by convection between the flowing gas and the inner pipe wall. The pipe wall temperature is assumed
to remain constant along the length of the pipe segment.

Reference: Industrial Press, Gas Engineers Handbook, 1965. CRC Press - Taylor & Francis, Gas
Pipeline Hydraulics, 2005.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Pipe Temperature Change - Convection section:
CP = Constant Pressure Specific Heat, Dimensionless
D = Inside Diameter, Inches
e = Napierian Constant, 2.71828
L = Physical Length, Feet
= 3.141592
Q = Volumetric Flow Rate, Ft^3/Hr
= Average Gas Density, Lbm/Ft^3
T1 = Inlet Temperature, Fahrenheit
T2 = Outlet Temperature, Fahrenheit
TW = Pipe Wall Temperature, Fahrenheit
V = Average Gas Velocity,~Ft/sec

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

544

GASWorkS 9.0

Appendix
Table Of Contents

Pipe Temperature Change - Convection & Conduction


The outlet temperature of the gas flowing through a pipe segment based on both convection (film) and
conduction heat transfer is calculated using the following equation. The method was derived from various
sources including the noted references. This method predicts the outlet temperature of a pipe segment by
assuming that the heat transfer occurs by convection between the flowing gas and the pipe wall, and by
conduction through the pipe wall, insulation, and environment surrounding the pipe and insulation. The
environment is only assumed to conduct to the extent of the influence zone. The influence zone is assumed
to radially extend from the axis of the pipe outward to the edge of the influence zone. The size of the
influence zone is computed as the product of the influence factor times the outside diameter. The
environment represents the environment surrounding pipe, it can be soil, air, or a liquid.

Reference: Pipeline And Gas Journal, May, 1974.

Equation Variables
Unless otherwise noted, the following base units and variable definitions apply to all of the methods and
equations described in the Pipe Temperature Change - Convection & Conduction section:
CP = Constant Pressure Specific Heat, Dimensionless
D = Inside Diameter, Inches
e = Napierian Constant, 2.71828
KI = Thermal Conductivity of Insulation Material, Btu/(Hr-Ft-F)
KP = Thermal Conductivity of Pipe Wall Material, Btu/(Hr-Ft-F)
KS = Thermal Conductivity of Soil surrounding Pipe, Btu/(Hr-Ft-F)
L = Physical Length, Feet

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

545

GASWorkS 9.0

Appendix
Table Of Contents

= 3.141592
Q = Volumetric Flow Rate, Ft^3/Hr
= Average Gas Density, Lbm/Ft^3
tI = Thickness of Insulation, Inches
T1 = Inlet Temperature, Fahrenheit
T2 = Outlet Temperature, Fahrenheit
TS = Temperature of the Soil at the edge of the Influence Zone, Fahrenheit
XS = Influence Factor

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

546

GASWorkS 9.0

Appendix
Table Of Contents

GASWorkS Files
The following table describes the various files used by GASWorkS. Depending on the nature and features
included in a specific model, and the routines used, some of these files may not always be present.
Category

Filename

Description

Program Files

gw90.exe

The GASWorkS Program file

gwgdi.dll

Contains The GASWorkS Graphic Data Interface functions.

gws.dll

Contains the GASWorkS solution functions.

gwlic.dll

Contains the GASWorkS license information.

*.hdr

Header Data file

*.cdt

Customer Model Data file

*.ndt

Node Data file

*.pdt

Pipe Data file

*.cdb

Linked Customer Attribute Data file

*.fac

Facility List and Settings

*.ftg

Attached Fitting information

*.gtx

User Text file

*.nts

Model Notes file

*.pdb

Linked Pipe/Main Attribute Data file

*.prp

Gas Properties file

*.run

Run File file

*.ugd

User Graphics file

*.vdt

Attribute Valve file

*.vtx

Vertex Location file

Model Data Files

Non-Model Data
Files

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

547

GASWorkS 9.0

Appendix
Table Of Contents

Category

Filename

Description

Property Tables

*.cpf

Compressor Property Table

*.fpf

Fittings Property Table

*.ppf

Pipe Property Table

*.rpf

Regulator Property Table

*.vpf

Valve Property Table

*.wpf

Well Property Table

*.cat

Customer Attribute Data file settings

*.chk

Data Check error file

*.dck

Data Check settings

*.ddf

Saved Database Definition

*.dfs

Saved Default Data settings

*.dft

Default Data settings

*.err, *.etp

Node Error file

*.exc

Solution Exceptions file

*.fck

Temporary file used by some File Management routines.

*.grf

Graphic Settings file

*.img

Background Image Settings file

*.pat

Pipe Attribute Data file settings

*.pfs

Preference Settings file

*.prj

Project Specification file

*.prp

Gas Properties file

*.pvw

Model Graphic Preview file

*.qry

Saved Query Specification

*.slg

Solution Log file

*.sum

Summary Report settings

*.tmp

Used by various routines to store temporary data.

Support Files

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

548

GASWorkS 9.0

Appendix
Table Of Contents

Category

Screen Initialization
Files

Back-Up Files

Filename

Description

*.trc

Trace Results file

*.unq.txt

Unassigned Customer file. Created during execution of the


Update External Loads routine.

.vew

Saved Graphic View file

gw_cfg.ini

Contains GASWorkS Settings and Default Data values.

gw_gcfg.ini

Contains Graphics Screen settings

*.ini

Contains Default Data values for various GASWorkS routines.

*.*.bak

Back-Up Data file

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

549

GASWorkS 9.0

Appendix
Table Of Contents

Standard Property Tables


The "standard" Property Tables included in the GASWorkS software provide a basis for building your own
Property Tables. The values contained in the Property Tables may be modified or new items may be added,
and the individual tables can be combined to create a custom Property Table. The general contents of the
various standard Property Tables are described in the following tables. The specific description and source
reference for each Property Table item is included in the associated Property Tables Data Screen description.
Note that new items and Property Tables are occasionally added as Users request new or additional items.
The Property Tables and content included with your version of the software may vary from the Property
Tables described on the following pages. New and revised Property Tables can be download from our
website, www.b3pe.com.

Compressor Property Table


Table Name

Content

compressor.cpf

Contains definitions for generic compressor types.

Fittings Property Table


Table Name

Content

fitting.fpf

Contains a comprehensive list of definitions for fittings and valves


ranging from " to 60 in size.

fitting_efv_dresser.fpf

Contains definitions for excess flow valves provided by Dresser Inc.

fitting_efv_prefection.fpf

Contains definitions for excess flow valves provided by Perfection


Corporation.

fitting_large_us.fpf

Contains a list of definitions for fittings and valves ranging from 14" to
60 in size.

fitting_pe_punch_tee.fpf

Contains a list of definitions for polyethylene punch tees.

fitting_small_us.fpf

Contains a list of definitions for fittings and valves ranging from " to
12 in size.

uk_fitting.fpf

Contains a list of definitions for plastic and steel fittings commonly used
in the UK.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

550

GASWorkS 9.0

Appendix
Table Of Contents

Pipe Property Table


Table Name

Content

pipe.ppf

Contains a comprehensive list of definitions for plastic and steel pipes


from " to 48" in size.

pipe_cts_acr_nfgc.ppf

Contains a list of definitions for copper tubing based on the ACR sizing
system as listed in the AGA/NFPA National Fuel Gas Code.

pipe_cts_k&l_nfgc.ppf

Contains a list of definitions for copper tubing based on the K&L sizing
system as listed in the AGA/NFPA National Fuel Gas Code.

pipe_pe_nfgc.ppf

Contains a list of definitions for polyethylene pipe based on sizes listed


in the AGA/NFPA National Fuel Gas Code.

pipe_pe_uk.ppf

Contains a list of definitions for polyethylene pipe based on common


UK sizing specifications.

pipe_pe_us.ppf

Contains a list of definitions for polyethylene pipe based on common US


sizing specifications.

pipe_steel_large_us.ppf

Contains a list of definitions for steel pipe based on common US sizing


specifications for sizes 14" to 42".

pipe_steel_nfgc.ppf

Contains a list of definitions for steel pipe as listed in the AGA/NFPA


National Fuel Gas Code.

pipe_steel_small_us.ppf

Contains a list of definitions for steel pipe based on common US sizing


specifications for sizes " to 12".

uk_pipe.ppf

Contains a list of definitions for plastic, steel, cast, ductile, and spun iron
pipe commonly used in the UK.

Regulator Property Table


Table Name

Contents

regulator.rpf

Contains a list of definitions for generic models and specific data for a
selected group of models from a variety of manufacturers.

regulator_fisher.rpf

Contains a list of definitions for a selected group of Fisher regulators.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

551

GASWorkS 9.0

Appendix
Table Of Contents

Table Name

Contents

regulator_generic.rpf

Contains a list of definitions for generic models based on various


manufacturers flow equations.

regulator_grove.rpf

Contains a list of definitions for a selected group of Grove regulators.

regulator_mooney.rpf

Contains a list of definitions for a selected group of Mooney regulators.

regulator_rockwell.rpf

Contains a list of definitions for a selected group of Rockwell regulators.

Valve Property Table


Table Name

Contents

valve.vpf

Contains a list of definitions for generic models and specific data for a
selected group of models from a variety of manufacturers.

Well Property Table


Table Name

Contents

well.wpf

Contains a definition for a single example/sample well.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

552

GASWorkS 9.0

Appendix
Table Of Contents

Database Definition Files


The following table describes the various Database Definition files included when GASWorkS is installed.
The files can be modified or revised as appropriate to meet the Users specific needs. All database definition
files end in a .ddf extension.
Filename

Description

gasbase 4x customer

Contains definitions similar to the fields contained in the customer portion of the
various versions of the GASBase 4 database. Use this definition if converting an
older version of GASWorkS which has a GASBase database attached.

gasbase 4x main

Contains definitions similar to the fields contained in the mains portion of the
various versions of the GASBase 4 database. Use this definition if converting an
older version of GASWorkS which has a GASBase database attached.

gasbase 50 customer

Contains definitions similar to the fields contained in the gasbase 4x customer


file, however several of the fields are coded as integer fields. The use of the
integer code fields results in a more efficient and flexible database. Use this
definition to create a new model with customer attributes similar to GASBase.

gasbase 50 main

Contains definitions similar to the fields contained in the gasbase 4x main file,
however several of the fields are coded as integer fields. The use of the integer
code fields results in a more efficient and flexible database. Use this definition
to create a new model with main attributes similar to GASBase.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

553

GASWorkS 9.0

Appendix
Table Of Contents

Data List Files


The following table describes the various data list files included when GASWorkS is installed. The files can
be modified or revised as appropriate to meet the Users specific needs. All data list files end in a .lst
extension.
Filename

Description

class_location

Contains a list of class locations based on the US DOT 192 code.

class_other

Contains a list of class locations exceptions based on the US DOT 192 code.

efficiency_units

Contains a list of GASWorkS efficiency dimensional units.

flow_units

Contains a list of GASWorkS flow dimensional units.

meter_size_type

Contains a list of common meter sizes and types.

pipe_coating

Contains a list of common pipe coating types.

pipe_material

Contains a list of common pipe material types.

pipe_size_type

Contains a list of GASWorkS pipe sizes and types.

pipe_specification

Contains a list of common pipe specification types.

pressure_units

Contains a list of GASWorkS pressure dimensional units.

regulator_op_more

Contains a list of regulator operational types.

regulator_size_type

Contains a list of GASWorkS regulator sizes and types.

size_group

Contains a list of GASWorkS pipe sizing groups.

test_medium

Contains a list of common test medium types.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

554

GASWorkS 9.0

Glossary
Table Of Contents

GLOSSARY

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

555

GASWorkS 9.0

Glossary
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

556

GASWorkS 9.0

Glossary
Table Of Contents

Glossary
The following table describes some of the terms associated with the GASWorkS modeling environment. If
you cannot find the term you are looking for in these definitions, use the Help System Find routine to
locate topics containing the associated term.
Term

Definition

2-Point Pipe

A single segment pipe. The pipe extends directly between the From and To
Node locations.

Alphanumeric Characters

Refers to the group of characters ranging from A to Z, and 0 to 9. The


characters can be combined in any order.

Arc Pipe

A curved pipe segment.

Atmospheric Pressure

The pressure exerted on an object by the atmosphere. Defined in the


Support Equations topic in the Appendix section of this Manual.

Attribute Data

Refers to non-model data associated with pipe and customer data. Nonmodel data values do not affect the calculation of the pressure and flow
values in the system.

Balanced

Refers to a condition where all of the node errors are within the specified
tolerance (convergence factor).

Base Pressure

Refers to the pressure used as the basis for stating a load or flow rate.
When used with a customer load, the base pressure usually refers to the
billing pressure.

Base Temperature

Refers to the temperature used as the basis for stating a load or flow rate.
When used with a customer load, the base temperature usually refers to the
billing temperature.

Checkbox

A box used to specify an option, condition, or


preference. A check mark (U) will appear in
the box when it is selected. The Allow Size
Calculation item on the Pipe Data screen is an example of a checkbox.

Column

Refers to a vertical group of data in a spreadsheet style report.

Command Button

A control "button" used to execute a command. Command


buttons appear on data screens, reports, and message boxes.
The OK button found on many message boxes is an
example of a command button.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

557

GASWorkS 9.0

Glossary
Table Of Contents

Term

Definition

Convergence Tolerance

A setting used to indicate when the solution is "close enough". Sometimes


referred to as the Convergence Factor, or Tolerance.

Copyright Notice

The first screen that is displayed when GASWorkS is executed. Informs


the User of the Copyright status and owner.

Cursor

Refers to the screen position indicator for the keyboard or the mouse.

Data Field

May refer to an item in a GASWorkS data file, an item in an external data


file, an entry position on a data screen, or a data cell in a grid report.

Data File

A file used to store the information used by GASWorkS to define and


support its network modeling activities.

Diameter

Refers to the Size/Type Code or inside diameter of a pipe segment.

Distribution Disk

Refers to the CD or other media which contains the source GASWorkS


program files.

Drop-Down List

A list used to display and select data items. Initially the list is "collapsed"
and displays only the currently selected item. The list is activated (dropped
down) by clicking on the arrow symbol to the right of the list. See List
Box" for an example.

Element

A "pipe" - a hydraulic element connecting two nodes.

Element Type

Specifies the element type - for example pipe, valve, or regulator.

From Node

The beginning node of a pipe element.

GDI

An acronym (abbreviation) for the GASWorkS Graphic Data Interface.

Header Data

The common data for the model such as base pressure and base
temperature, and solution control values.

Icon

A small simple image which represents a command or routine.


Select the icon to execute the associated command. The printer
image used by many of the Report routines is an example of a
icon.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

558

GASWorkS 9.0

Glossary
Table Of Contents

Term

Definition

List Box

A list of items which can be selected by clicking the


mouse on the desired item. List boxes can either be
permanently displayed, or may "drop-down" when
selected. The dimensional unit values are commonly
associated with list boxes.

Load

A flow leaving the system at a node. Opposite of a supply. A negative (-)


load value.

Menu Item

An item appearing in a menu list. Selecting a menu item causes the


associated routine or command to be executed.

Menu List

A list of functional topics and commands grouped under a common menu


heading.

Message Box

A simple form that provides a warning or message to the User. The box is
cleared by selecting the OK command button, or choosing one of its
options (if more than one command button is present).

Model

The header, node, pipe, and customer data that defines the system being
modeled.

Mouse Pointer

The cursor image which is controlled by movement of the pointing device


or mouse.

Node

The end of a pipe, or connection between multiple pipe ends.

Node Data File

A data file that contains the information associated with the node features
in a model.

Option Button

A circular button used to specify a condition or


preference. The Status item found on many of the data
screens is an example of an option button.

Pipe

Same as an "element" - a pipe that connects two nodes.

Pipe Data File

A data file that contains the information associated with the pipe features
in a model.

Polyline Pipe

A multi-segment pipe. The end of each segment is referred to as a vertex.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

559

GASWorkS 9.0

Glossary
Table Of Contents

Term

Definition

Property Table

A set of data files which contain common data associated with the various
pipe, devices, and fittings used by GASWorkS. Each table contains
specific information about the type it represents. For instance, the Pipe
Property Table contains information on the pipe type elements such as
inside diameter.

Related Model

A GASWorkS model that is referenced by the current model. Node loads


in a related model can be shared with the referencing (current) model.

Related Node

A node contained in a related model, the load associated with the related
node is shared with the referencing node in the current model.

Run File

A data file that contains instructions for performing "batch" style


execution of model solutions.

Schematic

A line representation of the system being modeled.

Screen

A window object used to access various data fields. May also be referred
to as a data screen, form, message, or window.

Scroll Bar

A horizontal or vertical slider that can be positioned to change a value, or


to browse a report.

Supply

A flow entering the system at a node. Opposite of a load. A positive (+)


load value.

To Node

The ending node of a pipe element.

User Graphics

A graphic line or symbol feature input by the User.

User Text

Text features input and defined by the User.

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

560

GASWorkS 9.0

Index
Table Of Contents

INDEX

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

561

GASWorkS 9.0

Index
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

562

GASWorkS 9.0

Index
Table Of Contents

2-Point Pipe
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Alphanumeric Characters
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Analysis Menu List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Calculate Gas Properties.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Execute Run File.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
GASCalc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Solve Single Model.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Append
Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Application Limit.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii
Arc Pipe
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Adjust. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Convert To Polyline Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Arrange
Screen Icons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Screens. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
ASCII Files
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412, 414, 417
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382, 385
Atmospheric Pressure
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Atmospheric Pressure Equation.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
AGA Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Handbook Of Chemistry & Physics Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
ISHM Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Atmospheric Pressure Method
Solution Option.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Attribute Data
Customer, Attach. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57, 143, 350
Database Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Pipe, Attach.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58, 143, 355
SQL Statement, Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58, 59
SQL Statement, Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Attribute File
Customer, Attach. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57, 143
Data List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Include In Bundle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Pipe, Attach.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58, 143

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

563

GASWorkS 9.0

Index
Table Of Contents

Attribute Valve
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193, 195
Assign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202, 203
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Attribute Valve Commands Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Add Attribute Valve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Delete Attribute Valve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Display Attribute Valve Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Display Attribute Valves. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Edit Attribute Valve Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Move Attribute Valve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Move Attribute Valve Text.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Set Attribute Valve Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Set Attribute Valve Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Attribute Valve Data
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Attribute Valve Symbols
Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Attribute Valve Text
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Average Pressure
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Average Temperature
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Background Image
BMP File.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
DXF File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Include In Bundle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Remove. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Scale. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54, 241
SHP File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Background Image Settings
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Base Pressure
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

564

GASWorkS 9.0

Index
Table Of Contents

Base Temperature
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
BMP Image
Scale Factor, Calculate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54, 241
Branch Customer
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Bundle
Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36, 71
Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Bundle Specifications
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Calculate
Delta P (Linear). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Delta P (Squared). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Efficiency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Gas Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46, 110
Scale Factor.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Temperature Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
XY Coordinates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61, 182, 199
Calculated Value
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Calibrate
Digitizing Tablet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Cancel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Checkbox
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20, 557
Close
GDI Window.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Color
By Query.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
By Range.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Coding.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305, 306
Coding, Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Color Legend
Convert To User Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Column
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Display, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

565

GASWorkS 9.0

Index
Table Of Contents

Command Alias File


How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Preferences, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Command Button
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Compressibility Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
AGA-92-Detailed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
AGA-92-Gross-1.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
AGA-92-Gross-2.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
GPSA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Solution Option.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Compressor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Insert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Outlet Temperature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Power Equations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Compressor Power Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Empirical 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Empirical 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Theoretic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Compressor Property Table
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Standard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Connectivity
Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50, 73
Connectivity Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Contact Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25, 65
Convection
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Convection & Conduction
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
Convergence Problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Convergence Tolerance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Solution Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Coordinates
Calculate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61, 182, 199
Dimensional Units, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98, 265
Enter, GDI Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

566

GASWorkS 9.0

Index
Table Of Contents

GDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Rotate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Scale. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Shift.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231, 308
Copy
Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Copy Protection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Copyright. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i, 558
Cost
Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Create
New Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Crosshairs
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Current View
Save.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Cursor
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Customer
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194-196, 225
Attribute Data, Attach.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57, 350
Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Count, Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79, 203
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208, 269
Find. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79, 210, 237
Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214-216
Graphic Properties, Match. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Pipe ID Numbers, Reassign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Pipe Link ID Assignments, Reset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Purge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Reassign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Report Invalid Coordinates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Service Line, Assign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Undelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79, 224, 233, 237
Customer Attribute Settings
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Customer Data
ASCII Files, Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Attribute Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78, 255
Attribute Values, Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

567

GASWorkS 9.0

Index
Table Of Contents

Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207, 250
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
External Loads, Update.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Graphic Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Hydraulic Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80, 256
Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 75
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
SQL Statement, Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Customer Data Commands Toolbar.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Add Branch Customer.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Add Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Add Customer - Auto-Assign Main. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Add Multiple Customers - Auto-Assign Main. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Add Polyline Service Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Add Service Line Vertex. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Clear Customer Find Flag.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Create Branch Customer.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Delete Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Delete Customer Symbols.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Delete Service Line Vertex.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Edit Multiple Customers.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Edit/View Customer Data.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Find Customer.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Move Branch Service Tap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Move Customer Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Move Customer Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Move Service Line Vertex. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Move Service Tap Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Oops Customer (Undelete Customer).. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Reassign Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Set Customer Color.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Customer Data Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Customer Flag
Clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199, 200
Customer Loads
Diversified, How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Multiply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

568

GASWorkS 9.0

Index
Table Of Contents

Customer Symbols
Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227, 229, 253, 254, 306
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230, 253, 265
Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253, 265
Customer Text
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Options, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Customer X-Y Specification
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Data
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Data Check
Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60, 84
Data Check Report.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Data Check Specifications
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Data Edit Commands Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Clear Node Find Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Clear Pipe Find Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Edit Multiple Nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Edit Multiple Pipes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Edit/View Node Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Edit/View Pipe Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Find Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Find Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Move Node Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Move Pipe Text.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Data Field
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21, 558
Data File
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Data Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Data List
Files.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Data Screens
Arrange. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

569

GASWorkS 9.0

Index
Table Of Contents

Open List.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Data Values
Defaults, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56, 94
Database Definition
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Files.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Database File Format
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
dBASE Files
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421, 423, 426
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Decimals
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Default Data Values
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56, 94
Define ASCII File Format
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382, 385
Define SQL Update Specification
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Delete
Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Nodes, Unused. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132, 303
Demonstration Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Design Factor
Solution Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Diameter
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Digitizing Tablet
Calibrate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Toggle On/Off.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Dimensional Units
Defaults, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23, 98, 447
International Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Standard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Supported. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Display Controls Toolbar.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Display Background Image.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Display Color Legend. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Display Flow Arrows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

570

GASWorkS 9.0

Index
Table Of Contents

Display Node Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206


Display Pipe Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Set Colors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Set Text Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Distance
Measure.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Divergence Limit
Solution Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Drop-Down List
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21, 558
DXF Export Options
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
DXF Files
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
DXF Flag
Clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
DXF Image
Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54, 243
DXF Import Specification
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
DXF Layer
Highlight. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Turn Off. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Turn On/Off. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
DXF Text
Find. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212, 237
Edit Graphic Data Values
Lines, Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Symbols, Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Edit Menu List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Facility Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Mass Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Model Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Property Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Run File.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Edit Text Values
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Efficiency
Calculate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Element
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

571

GASWorkS 9.0

Index
Table Of Contents

Element Type
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Elevation
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Energy Conversion
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Equation
Atmospheric Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Average Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Compressor Power. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Energy Conversion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Pipe Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Pipe Flow Velocity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Pipe Hoop Stress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Pipe Volume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Regulator Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Reynolds Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Specific Heat.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Valve Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Well.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Error Flags
Clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Exceptions Report
Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Execute
Functions.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
GDI Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Run File.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
SQL Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58, 59
Exit
Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Export
ASCII Files, Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
ASCII Files, Node.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
ASCII Files, Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
dBASE Files, Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
dBASE Files, Node.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
dBASE Files, Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
DXF Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Files.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
GASWorkS 7.0 File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Microsoft Access Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

572

GASWorkS 9.0

Index
Table Of Contents

Microsoft Excel Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434


Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Quick.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
SHP Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Stoner PD/XY Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
X-Y Customer Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
X-Y Node Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
XLS Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
External Loads
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Options, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57, 360
Extract Routine
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Facility Settings
Default Type, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39, 43
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Preferences, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137, 264
Report Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102, 445
Feature Colors
Defaults, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Reset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Save.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228, 307
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229, 265
File
Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Import/Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Model Data, Sort.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Select.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 105
File Menu List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Append. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Bundle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Close. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Exit GASWorkS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
New. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
New Project.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Open. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

573

GASWorkS 9.0

Index
Table Of Contents

Purge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Quick Export.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Rename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Restore A Model.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Restore Samples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Save.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Save As. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
File Selection
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Find. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Zoom, Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263, 444
Fitting.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Fittings Property Table
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Standard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Flag
Clear All. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Data Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Unbroken Intersections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Flagged Intersections
Break. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Flow Arrows
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206, 264, 265, 445, 446
Symbol, Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Symbol, Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Flow Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Flow Equations
Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Regulator.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Valve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
From Node
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Fuel Piping Systems
About. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Functions
Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Fuzzy Tolerance.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

574

GASWorkS 9.0

Index
Table Of Contents

Gas Network
About. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Gas Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Calculate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46, 110, 274
Default Values, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
GASCalc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
GASWorkS
About. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Data Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Files.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
How To Start.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Install. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Personalize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
Program Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
GASWorkS 7.0 File
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Gathering Systems
About. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
GDI
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
GDI Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Add Compressor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Add Customer - Unassigned. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Add Duplicate Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Add Hydraulic Valve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Add Legend As Text.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Add Multiple 2-Point Pipes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Add Multiple Attribute Valves. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Add Multiple Customers.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Add Multiple Polyline Pipes.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Add Regulator.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Add Well.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Adjust Arc.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Assign Attribute Valves. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Assign Customer Service Lines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Break Flagged Intersections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Calculate Delta P (Linear). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Calculate Delta P (Squared). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

575

GASWorkS 9.0

Index
Table Of Contents

Calculate Efficiency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199


Calculate XY's From Lat/Long.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Calibrate Digitizing Tablet (2-Point). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Calibrate Digitizing Tablet (X-Point).. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Cancel Current. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Clear All Customer Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Clear All Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Clear All Node Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Clear All Pipe Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Clear Customer Item Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Clear DXF Find Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Clear Error Flags.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Clear Intersection Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Clear Node Item Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Clear Pipe Item Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Clear Supply Flags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Clear User Text Find Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Convert All Arcs To Polyline Pipes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Convert Arc To Polyline Pipe.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Copy Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Copy User Text.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Delete All Attribute Valves. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Delete All Customers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Delete All Marked Views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Delete Legend Text.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Delete Marked View.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Delete Zero Length Pipes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Display Tool Palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Display Vertex Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Edit Customer Data By Pipe Selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Edit External Load. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Edit External Load (Fixed). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Edit Pipe Customer Count. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Find Customer By Address. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Find Customer By Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Find Customer By ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Find Customer By Link ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Find Customer By Record Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Find DXF Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Find Node By Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Find Node By Record Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Find Pipe By Address. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Find Pipe By Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

576

GASWorkS 9.0

Index
Table Of Contents

Find Pipe By ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Find Pipe By Link ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Find Pipe By Record Number.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flag Customers By Item Value.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flag Customers With Bad Link ID Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flag Customers With Redundant Link ID Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flag Nodes By Item Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flag Pipes By Item Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flag Supply Nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flag Unassigned Customers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flag Unbroken Intersections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Highlight DXF Layer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Highlight Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Insert Compressor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Insert Regulator.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Insert Valve.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Make User Text From Legend. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match Customer Graphic Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match Node Graphic Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match Node Hydraulic Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match Node Properties (All). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match Pipe Facility.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match Pipe Graphic Properties.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match Pipe Hydraulic Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match Pipe Properties (All). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match User Graphic Line Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match User Graphic Symbol Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Match User Text Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Move Background Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Move Customer - Reassign Main. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Move Legend Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multiply Customer Loads. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multiply Node Loads. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Paste CID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Paste CID Auto. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Purge Customers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Purge User Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reassign Customer Pipe ID Numbers.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reduce Nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report Customers With No Coordinates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reset Colors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reset Customer Colors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reset Customer Pipe Link ID Assignments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reset GDI Command List Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Bradley B Bean PE

213
214
214
214
215
215
215
215
216
216
216
217
217
217
217
217
218
218
218
218
218
219
219
219
219
219
219
220
220
221
221
223
223
225
225
225
226
226
226
227
227
227
227
227

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

577

GASWorkS 9.0

Index
Table Of Contents

Reset Node Colors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228


Reset Pipe Colors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Reset Pipe Link ID Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Save Feature Colors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Scale Background Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Segment A Pipe.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Set Customer Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Set Pipe Symbol Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Set User Graphic Symbol Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Set/Unset Intersection Flag.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Shift Model Coordinates.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Show Route Profile.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Snap Loose Pipe Ends.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Snap Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Solve Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Trace & Update.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Turn Off DXF Layer.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Undelete Customer (Oops). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Undelete Pipe (Oops). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Undelete User Graphic (Oops). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Undelete User Text (Oops).. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Undo Last Data/Graphic Change. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Update Customer Count. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Zoom Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
GDI Command Line.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188, 192
GDI Command List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188, 192
Display, Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
GDI Coordinates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
GDI Icons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191, 192
GDI Image
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Pan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225, 444
Plot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Repaint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Repaint, Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263, 444
Save.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Zoom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
GDI Pop-Up Menu.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Show. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264, 446
GDI Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188, 190
Attribute Valve Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Customer Data Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Data Edit Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

578

GASWorkS 9.0

Index
Table Of Contents

Display Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic Construction Commands.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic Edit Commands.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic Utility Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic Window Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User Graphic Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User Text Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
View Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GDI Window
Background Color, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Command Line. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Command List.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Coordinates, Enter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Key Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Maximize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mouse Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Open, Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Refresh Increment.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Resize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GDI Window Icons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cancel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GDI Command List.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Scroll.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Solve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tool Palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Undo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic Construction Commands Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Add 2-Point Pipe.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Add Arc Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Add Polyline Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delete Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Node Snap.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Oops Pipe (Undelete Pipe). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic Data Interface
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Preferences, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Graphic Edit Commands Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Add Polyline Vertex. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delete Polyline Vertex. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Join Adjacent Pipes.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Bradley B Bean PE

191
191
191
191
191
191
191
191
306
188
188
237
237
220
235
136
266
228
187
263
188
189
189
189
189
189
189
190
191
193
193
196
203
224
224
558
136
187
191
196
204
218

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

579

GASWorkS 9.0

Index
Table Of Contents

Move Node Locations.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221


Move Pipe Ends. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Move Pipe Vertex. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Swap Pipe Ends. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Tap Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Graphic Settings.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Graphic Utility Commands Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Arrange Tool Palette.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Measure Distance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Plot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Toggle Digitizing Tablet On/Off. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Trace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
View Trace Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Graphic Window Controls Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Close Graphics Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Display Crosshairs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Maximize Graphics Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Regenerate Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Repaint Display.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Resize Graphics Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Graphics Menu List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Background Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Save Display As Bitmap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Save Display To Clipboard.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
View/Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Guarantee. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii
Header Data
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 113
Header Data Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Heating Value
Calculate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Help
Contact Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25, 65
Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Guide.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24, 65
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Help Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24, 65

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

580

GASWorkS 9.0

Index
Table Of Contents

Help Menu List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64


About GASWorkS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Technical Support.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Using Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
View Demonstration Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
View Help Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
View User's Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Help System
Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Hoop Stress
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Hydraulic Data
Default, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94, 100
Icon
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21, 558
Import
ASCII Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382, 385
dBASE Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
DXF Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Files.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
Microsoft Excel Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
MIF/MID Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
SHP Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Stoner PD/XY Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
X-Y Customer Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
X-Y Node Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
X-Y Valve Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
XLS Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Import/Export
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Import/Export File Selection
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Initialization File
Path, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 126, 441
Install Software
From A CD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
From An Electronically Received File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
General Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
International Users
Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

581

GASWorkS 9.0

Index
Table Of Contents

Intersection Flag
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Unset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Joule-Thomson Temperature Drop
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
Legend Text
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Length
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
License Agreement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
License File
Path, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 126, 441
Linked Attribute Database Definition
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
List Box
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Load
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Determine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Proration Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Share With Related Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
TCL Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Mass Update
Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42, 115
Preferences, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Mass Update Specifications
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Maximum Iterations
Solution Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Menu
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Menu Items
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Menu List.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Analysis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Graphics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

582

GASWorkS 9.0

Index
Table Of Contents

Help.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Window.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Message Box
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Microsoft Access Files
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
Microsoft Excel Files
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
MIF/MID Files
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Model
Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Append. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Close. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29, 30, 481
Data Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Dimensional Units. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495, 499
Extract.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Load. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Network Primer.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42, 118
Open. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Related. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Sample, Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Save, Set Preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Solve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45, 231
System Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Zoom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Model Data
Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60, 84
Connectivity Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29, 30
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Import/Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Mass Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42, 115
Regenerate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Rename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

583

GASWorkS 9.0

Index
Table Of Contents

Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48, 49
Save As. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Save Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Sort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Model Data Files
Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Sort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Model Files
Append. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Bundle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36, 71
Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Include In Bundle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Path, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 126, 441
Purge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Unbundle.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Unzip.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Zip. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Model Notes
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42, 114
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Solution Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Mouse Pointer
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Multiple Edit Specifications
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Network Modeling
About. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
New Project
Specifications, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Node
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19, 559
Delete, Unused. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208, 270
Find. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122, 212, 237
Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Graphic Properties, Match. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Hydraulic Properties, Match. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

584

GASWorkS 9.0

Index
Table Of Contents

Number Increment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151


Properties, Match All. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Reduce. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Related. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Renumber. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61, 151
Node Data
ASCII Files, Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Calculated Data.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119, 209, 271
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Gas Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Graphic Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Hydraulic Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122, 278
Related Model.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 119
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Node Data File
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Node Data Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Node Flag
Clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200, 201
Node Loads
Multiply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Node Name
Increment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100, 447
Renumber. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Node Pressure
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Node Snap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Ratio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Tolerance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Node Symbols
Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228, 275, 306
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265, 275
Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266, 276
Node Text
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

585

GASWorkS 9.0

Index
Table Of Contents

Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Options, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Non-Pipe Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Open
Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Optimization
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Option Button
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21, 559
Outlet Temperature
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Overall Heat Transfer
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Pan
Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Increment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266, 446
Path Settings
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Paths
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 125
Pipe
2-Point.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193, 195, 196
Attribute Data, Attach.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58, 355
Customer Count, Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19, 559
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132, 203, 303
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209, 270
Facility, Match. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Find. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133, 213, 214, 237
Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Flow Equations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Graphic Properties, Match. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Highlight. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Hydraulic Properties, Match. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Join Adjacent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Length. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264, 444
Link ID Values, Reset.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Polyline. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Properties, Match All. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Segment.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Tap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

586

GASWorkS 9.0

Index
Table Of Contents

Undelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133, 224, 233, 237, 303


Zero Lengths, Delete.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Pipe Attribute Settings
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Pipe Data
ASCII Files, Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Attribute Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131, 286
Attribute Values, Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Calculated Data.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209, 279
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Fitting Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Graphic Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Hydraulic Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127, 279
Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133, 291
Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 127
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
SQL Statement, Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Pipe Data File
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Pipe Data Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Pipe End
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Snap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Swap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Pipe Flag
Clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200, 201
Pipe Flow Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
AGA-Fully Turbulent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
AGA-Partially Turbulent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
AGA-Turbulent.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
Application Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Colebrook. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
Default, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Elevation Adjustment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
IAPMO-High Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
IAPMO-Low Pressure.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
IGE-TD3 General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

587

GASWorkS 9.0

Index
Table Of Contents

IGE3-Low Pressure.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505


IGE3-Medium Pressure.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
IGT-Improved. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
IMC-High Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
IMC-Low Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Mueller-High Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Mueller-Low Pressure.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
Oliphant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
Panhandle-A. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Panhandle-B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Pole-Low Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Recommendations.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
Spitzglass-High Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Spitzglass-Low Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Weymouth.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Pipe Flow Rate
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Pipe Property Table
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Standard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Pipe Sizing
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Pipe Sizing Group
Default, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Pipe Symbols
Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228, 284, 306
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206, 264, 445
Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230, 266
Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266, 284
Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266, 284
Pipe Text
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Options, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Pipe Volume Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Plant Piping Systems
About. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Plot Settings
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Polyline Pipe
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

588

GASWorkS 9.0

Index
Table Of Contents

Polyline Vertex
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Preference Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Command Alias File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137, 443
Default Path, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 125
Display Reminders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137, 442
Extended Desktop Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Facility Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137, 442
GDI Command List, Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136, 442
GDI Window, Open Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136, 442
Options, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Retrieve.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Save.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Save Increment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Save Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137, 443
Save, Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136, 442
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Tooltips. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137, 443
Undo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136, 442
Preferences.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Facility Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Paths. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 125
Property Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Retrieve Saved Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Save Current Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 136
Pressure Data
Share With Related Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Pressure Drop
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Print
Dimensional Units, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138, 141
Print Control
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138, 141
Profile Options
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Project
Create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Project Specifications
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

589

GASWorkS 9.0

Index
Table Of Contents

Property Table Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50


Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Property Table Settings
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Property Tables
Compressor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Default, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 146
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Fittings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Include In Bundle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Merge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Path, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38, 126, 146, 441
Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Regulator.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Save.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328, 441
Standard Contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Valve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Well.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Purge
Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Query Features
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Query Specifications
Define. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Refresh
Increment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Registration Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6, 66
Regulator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Flow Equations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Insert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Regulator Flow Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Grove.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
Grove 80. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Rockwell. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Universal.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

590

GASWorkS 9.0

Index
Table Of Contents

Regulator Property Table


Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Standard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Relate Features
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Related Model
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Related Node
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Release Notes.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Rename
Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Renumbering Specifications
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Report
Connectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50, 73
Customer Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 75
Data Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Error. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Header Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 113
Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Node Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 119
Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51, 152
Pipe Data.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 127
Property Table.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50, 326
Solution Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Standard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49, 176
Report Menu List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Connectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Data Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Property Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Report Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Solution Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Standard (All). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Standard (Select).. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Report Options
Decimals, Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152, 443
Exceptions Report.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154, 443
Facility Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153, 443
Pressure Drop, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155, 444
Print, Dimensional Units Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155, 444

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

591

GASWorkS 9.0

Index
Table Of Contents

Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152


Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Sort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155, 444
Restore
Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Sample Models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Results
User's Responsibility.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Retrieve
Preference Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Reynolds Number
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Route Profile
Create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Show. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231, 303
Run File
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
How To Use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Run File Specifications
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Sample Files
Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Sample Models
Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Save
Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
GDI Image.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
GDI Image To Clipboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Increment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Preference Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Save As
Model Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Saved View
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Zoom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Scale Factor
Calculate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242, 301
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

592

GASWorkS 9.0

Index
Table Of Contents

Schematic
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Screen
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Screen Icons
Arrange. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Scroll
Increment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266, 446
Scroll Bar
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21, 560
Selected Route Profile
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Selection Set
Make. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Service Line Vertex
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Service Tap
Branch, Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Set Display Colors
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
SHP Files
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
SHP Image
Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54, 245
Snap
Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Pipe Ends. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Software
About. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Application Limit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii
Copy Protection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Copyright. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Guarantee. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii
Hardware Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Install. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
License Agreement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Program Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Register. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

593

GASWorkS 9.0

Index
Table Of Contents

Registration Number.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Trademark Notice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
USB Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Solution
Balanced. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476, 557
Convergence Problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Run File.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Tolerance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Solution Data
Atmospheric Pressure Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Base Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Base Temperature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Calculation Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Compressibility Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Condition Nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Condition Pressure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Convergence Tolerance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Design Factor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Diameter Path Factor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Divergence Limit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Heat Exchange Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Include Joule-Thomson Effect For Pipes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Length Path Factor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Lower Dampening. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Maximum Iterations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Maximum Velocity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Model Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Optimize By. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Pass Limit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Path Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Pipe Size Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Pressure Drop Path Factor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Pressure Values.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Reset Diameters To Minimum Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
System Pressure Units. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
System Pressures.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Upper Dampening.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Solution Log.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45, 51
Report Exceptions.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

594

GASWorkS 9.0

Index
Table Of Contents

Solution Log Report


Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Solution Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Apply Design Factor To External Loads. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Calculate Diversity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Calculate Gas Mixing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Calculate Pipe Sizes (Optimize). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Calculate Temperature Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Flag Large Error Node Upon Completion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162, 447
Ignore Elevation Differences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Include Exceptions In Log Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162, 447
Report Exceptions.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Reset Unknown Node Pressures To Zero. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Smart Processing Of One-Way Segments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Solve Unspecified Facilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Update Color Coding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162, 447
Solve
Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45, 231
Sort
Model Data Files.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Sort Specifications
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Specific Gravity
Calculate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Specific Heat
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
Specific Heat Ratio
Calculate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Specify Shift Details
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
SQL Statement
Attribute Data, Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Execute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58, 59
Standard Property Tables.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Compressor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Fittings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Regulator.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Valve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
Well.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
Standard Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48, 113, 119, 127
Select.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Sort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

595

GASWorkS 9.0

Index
Table Of Contents

Stoner PD/XY Files


Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Compressor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Regulator.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Supply Nodes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
System.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Summary Report Options
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Supply
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Supply Flag
Clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Supply Main
Reassign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Supply Nodes
Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Tab
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25, 65
Temperature
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Temperature Calculations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463, 541
Average Temperature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Convection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Convection & Conduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
Joule-Thomson Temperature Drop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
Outlet Temperature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Overall Heat Transfer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Text
Options, Set.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230, 310
Text Display Options
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
To Node
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Tool Palette
Arrange. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

596

GASWorkS 9.0

Index
Table Of Contents

Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Tooltips
Show. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137, 264, 446
Trace
Create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232, 316
Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Trace & Update Specification
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Trace Report
View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Trace Results
Create. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Print.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Trace Specifications
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Trademark Notice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Transmission Systems
About. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
Unbroken Intersections
Flag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Unbundle
Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Undelete
Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133, 303
Undo.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190, 233, 237
Allow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136, 442
Unzip
Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Update
External Loads. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57, 360
Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Update Options
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
USB Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
User Graphic Commands Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Add User Graphic Line.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Add User Graphic Symbol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Delete User Graphic Line. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Delete User Graphic Symbol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

597

GASWorkS 9.0

Index
Table Of Contents

Display User Graphics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207


Edit User Graphic Line. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Edit User Graphic Symbol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Move User Graphic Line End. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Move User Graphic Symbol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Oops User Graphic Symbol/Line (Undelete Graphic). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
User Graphic Line
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210, 257
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Properties, Match. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Undelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224, 233
User Graphic Symbol
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210, 259
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Properties, Match. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230, 266
Undelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224, 233
User Graphics
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Undelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
User Text
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Delete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210, 261
Find. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214, 237
Find Flag, Clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Properties, Match. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Purge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Undelete. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225, 233, 237
User Text Commands Toolbar.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Add User Text.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Delete User Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Display User Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

598

GASWorkS 9.0

Index
Table Of Contents

Edit User Text.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210


Find User Text Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Move User Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Oops User Text (Undelete Text).. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Set User Text Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
User's Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
User's Responsibility
Results.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Utilities Menu List.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Customer Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Data Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Import/Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Miscellaneous. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Pipe Data.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Set Defaults.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Valve. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Flow Equations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Insert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Valve Flow Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Crane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Grove-Regulator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Rockwell. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
Rockwell-Regulator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
Universal-Regulator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Valve Throttling Factor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Valve Property Table
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Standard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
Velocity
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Vertex Symbols
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207, 264, 445
View Controls Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Delete Saved View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Go To XY Coordinates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Pan Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Save Current View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Zoom All.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Zoom By Scale. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Zoom In.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

599

GASWorkS 9.0

Index
Table Of Contents

Zoom Next. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234


Zoom Out. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Zoom Previous. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Zoom To Saved View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Zoom Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Viscosity
Calculate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Dimensional Units, Set Default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Well. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
Add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Well Equation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Well Property Table
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Standard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
Window
Open List.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Window Menu List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Arrange Icons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Arrange Screens. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Windows List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Windows Clipboard
Save GDI Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
X-Y Customer Files
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
X-Y Node Files
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
X-Y Valve Files
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
XLS Files
Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
XY Calculation
Screen Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
XY Coordinates
Calculate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61, 182, 199
Go To. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Zip
Model Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Zoom
All. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

600

GASWorkS 9.0

Index
Table Of Contents

Automatically. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Next.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Out. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Previous. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Ratio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266, 446
Saved View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Scale Factor.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Window.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

601

GASWorkS 9.0

Index
Table Of Contents

Bradley B Bean PE

ENGINEERING & SOFTWARE


Revision - 001, Copyright 2015, All Rights Reserved.

602

You might also like