SHC
SHC
SHC
with the
version 2.3.2
Table of Contents
Introduction......................................................................................................................................4 Starting the Simple Hydraulic Calculator........................................................................................8 File Properties..................................................................................................................................9
Project (tab)............................................................................................................................................9 System (tab)..........................................................................................................................................10 Calculations (tab)..................................................................................................................................11
Units......................................................................................................................................11 BS EN 12845 Mode..............................................................................................................11 Calculation and Advanced Calculation Options...................................................................12 Friction Formula...................................................................................................................12
Naming (tab).........................................................................................................................................13 Default Properties.................................................................................................................................14
Page 2 of 81
BS EN 12845 Mode.......................................................................................................................50
Enabling...............................................................................................................................................50 Remote Area.........................................................................................................................................51 Results Window....................................................................................................................................52 Report Settings.....................................................................................................................................53 Autopeak..............................................................................................................................................54 Summary..............................................................................................................................................54
Insert Menu....................................................................................................................................75
Commands............................................................................................................................................77 Example................................................................................................................................................78
Page 3 of 81
Introduction
Introduction
Welcome to the Simple Hydraulic Calculator (SHC for short). SHC is a full featured hydraulic calculation program designed from the ground up for automatic sprinkler system designers and engineers by an automatic sprinkler system designer / computer engineer. SHC is a command based data entry program. This approach to data entry provides industry leading flexibility and speed for anyone willing to learn a few simple commands. And SHC's advanced data editor will help. Many of SHC's useful capabilities and program features are: New in Version 2.3 Simple Hydraulic Calculator's ability to successfully find a solution has been measurably enhanced. Simple Hydraulic Calculator's editor has gained the following abilities: Quickly change selected Node commands to Head commands (menu item Edit Change node to Head). Quickly change selected Head commands to Node commands (menu item Edit Change head to Node). Quickly comment / uncomment selected lines (menu item Edit Change toggle comment).
Philosophical SHC is shareware. Try it before you buy it - anonymously - we want you to! SHC does not expire and uses plain text data files. What this means for you NO ANNUAL FEES! NO VENDER LOCK-IN! Have you ever been forced to pay a quarterly or annual maintenance fee or risk losing access to YOUR data files? Some vendors try this trick. Not Igneus Incorporated. We're on your side!
Page 4 of 81
Introduction Advanced Hydraulic Calculation Engine Hazen-Williams friction loss formula Darcy-Weisbach friction loss formula BS EN 12845 mode Simultaneous Hazen/Darcy mixed formula system calculations. Demand calculations (start with the system demand) Supply calculation (start with the water supply to the system) with optional safety margin Calculate loop, tree, grid, and completely custom piping configurations Powerful equivalent k-factor calculator/editor fully integrated with data editor and hydraulic calculation report. Suitable for many suppression system designs including wet, dry, pre-action, deluge, antifreeze, low, medium and high pressure mist, foam-water, foam concentrate and more! Multiple water sources fully supported Multiple fire pumps supported. Multiple backflow prevention and fixed loss devices supported Can adjust water supply and demand to the bottom of riser node for accurate hydraulic demand graphs. No artificial limit on number of pipes and nodes ( greater than 2000 permitted )
Customizable Reports NFPA 13-07/10 (the fire sprinkler installation standard) compliance capable Automatically adapts to paper size Customizable report page header text Customizable node analysis information Customizable pipe information Graphs and text use color to aid readability (optional). Export as pdf, html, or plain text - why mess around with inconvenient custom viewing programs?
Page 5 of 81
Introduction Advanced Syntax Highlighting Data Entry Editor Real time error checking Automatic "proposals" for fast entry Descriptive node and pipe names up to 8 characters long "LiveLook" information bar for quick system evaluation Robust U.S. and SI unit support even mixed U.S. and SI units are supported Group editing of selected values by type (size, length, elevation, k-factor, etc.) Multiple undo/redo "Popup" helpers for remembering/using material codes, fitting codes, etc. Undefined and unused node list User selectable font User selectable highlighting colors Results Window All system, node, and pipe calculated information displayed in tabular format for comprehensive system analysis Pipe and node information sortable by any value User selectable pipe-information columns Fully resizable window, displays as much information as it can Persistent you may keep this window open and in view while editing input data! Pipe Material Editor View properties and internal diameters of any defined material Edit properties and internal diameters of any material (except default schedule 40 steel piping material) Enter entirely new pipe materials Fitting Equivalent Length Editor View equivalent lengths for any defined fitting code Edit equivalent lengths of any defined fitting code Create new global and material specific fitting codes
Page 6 of 81
Introduction Liquid Properties Editor (Darcy-Weisbach formula) View properties of any defined liquid Edit properties of any defined liquid Define new liquids Equivalent K-factor Calculator Uses the full power of SHC's solver including Hazen-Williams, Darcy-Weisbach, velocity pressures, k-factor adjustment, and more. Can model simple sprigs and drops or entire dead-end branchlines. Familiar data input style similar to SHC's data editor helpers included. Full integration in the hydraulic calculation report. DXF Files Import DXF files the format supported by most CAD applications. Automatically define pipes and nodes from drawing's line and lwpolyline ACAD entities Automatically searches text entities for nominal pipe sizes Full preview of generated commands before committing them to the input data Update the DXF file Update nominal pipe size text entities to match SHC's data file Add text for node and pipe labels Add text for node discharge (available after a calculation) Add text for pipe flow rates (available after a calculation) Add pipe flow direction arrows (available after a calculation) Additional Quick Start wizards for fast creation of basic tree and gridded systems with water supply View hydraulic demand graph and save as jpg, wmf, or bmp file View flow diagram and save as jpg, wmf, or bmp file Easily and quickly convert existing files to different units Backflow prevention device database for easy insertion in the data input file
Page 7 of 81
To begin the Simple Hydraulic Calculator, double-click the program icon on your Window's desktop. - or Click the Window's start button located on the bottom taskbar.
When the start menu appears, select All Programs SHC SHC.
Page 8 of 81
File Properties
File Properties
When first started (or whenever a new file is created) SHC presents the File Properties screen, with the page-tabs Project, System, Calculations and Naming.
Project (tab)
Use the Project page (shown above) to enter project details for inclusion on the hydraulic calculation report summary page. Note that none of this information affects hydraulic calculation results and can be safely left for later entry. Report Header text will be shown centered at the top of every report page except for the summary page. Hint The Contractor field is not part of NFPA 13's mandatory summary page layout. If your AHJ requires strict compliance with the 2007 edition report layout then leave this field blank and it will not be shown.
Page 9 of 81
File Properties
System (tab)
The System page allows entry of important sprinkler system design information. What you enter here, will be included on the hydraulic calculation report's Summary page.
One item on this page can affect reported demand. When a valid node name is entered here a node actually used in your file SHC will adjust water supply and sprinkler demand graph to this node. This will be illustrated in the Your First System section of this guide. Hint Use this option whenever possible. An accurate hydraulic demand graph requires the water supply and system demand to be adjusted to the bottom of the sprinkler system riser. But if your AHJ requires strict compliance with the NFPA 13 report layout then leave this field blank and it will not be shown on the report summary page.
Page 10 of 81
File Properties
Calculations (tab)
The Calculations page gives you complete control over how SHC interprets values and hydraulically calculates your sprinkler system. It is important to get these settings correct. Let's take it one section at a time:
Units
Default unit for every value type may be selected here. Whenever SHC sees a value with no unit modifier, like 123, it will use the unit specified here. Any combination of supported units are permitted even mixed U.S. and SI. If continuing on to the tutorial, select all U.S. units as shown above.
BS EN 12845 Mode
BS EN 12845 mode may be enabled when compliance with this UK/European standard is required. For instruction on using this mode see the BS EN 12845 section of this guide.
Page 11 of 81
File Properties
Friction Formula
Click Hazen-Williams formula. Most automatic sprinkler systems require the Hazen-Williams friction loss formula. Need to use the Darcy-Weisbach equation? Using a liquid other than water (ie: like antifreeze solution or foam concentrate)? We'll cover this and the other shaded options in Calculating with Darcy later in this guide.
Page 12 of 81
File Properties
Naming (tab)
The Naming page controls the system helper commands naming (labeling) of automatically generated pipes and nodes.
We will discuss this more in the Your First System, Version 2 section of this guide.
Page 13 of 81
File Properties
Default Properties
Now is a good time to save these settings as your new file defaults. This way, units and normal calculation options will always be set when you begin a new file. Make sure the Use these settings check box is checked.
Now click the Save Changes button to close the file properties dialog.
Hint Next time you use the File Properties dialog uncheck the Use these settings box. This will avoid inadvertently changing your file default values when you don't want to. If you want to do this now select the menu item File Properties to re-open the File Properties dialog. Uncheck the Use these settings check box and click the Keep Changes button. All done!
Page 14 of 81
Page 15 of 81
Editor (tab)
The Editor page allows changes to SHC's editor behavior and appearance. By default, SHC uses a 10 point fixed spaced font. If this font is too small or unappealing, use the SHC Editor Font box to change it. The Popup Helper box controls the behavior of this helpful editor feature. Leave these settings alone for now. (The next section, Your First System, will show this in action.) SHC uses a modern syntax-highlighting editor for entering sprinkler system models. By default only commands, comments, warnings and errors are highlighted. But SHC has the ability to highlight many other value types. For now, leave the Highlighting Colors alone. When you gain experience with using SHC, you may want to revisit these settings and change to meet your needs.
Page 16 of 81
Reports (tab)
SHC also provides much control over its printed report output. These options are shown on the Reports page. By default, SHC is set for strict compliance with NFPA 13-07. Let's examine each option box individually.
Sections
Select which report sections to include in printed reports here. Order of sections may not be changed. SHC's default settings are shown at left. Flow Diagram will only print when your file uses the grid helper commands. In this guide, see First System Version 2 for instruction on using the grid helper commands. Check device graphs to include backflow preventer and pump flow curve graphs at the end of the report.
Pipe Information
This area controls what information and what columns are included in the Pipe Information section of reports. Many options here enable a more comprehensive and/or efficient display of individual pipe characteristics than NFPA 13 offers. When checked, velocity pressure and Darcy information will only add columns to the report when velocity pressures or the Darcy-Weisbach equation are actually used in the hydraulic calculation. SHC will display required information in the Notes column of the report when a dedicated column for the information is not available.
Node Analysis
SHC also provides some options for the node analysis section of the report. When checked Pn and Pv will add columns for these values to the node analysis section only when velocity pressures are used. Check req q column to include a column for information about the minimum discharge required at each sprinkler head node.
Page 17 of 81
Options
Check Use Color and SHC will differentiate between labels and values by color while also enhancing the graphs and flow diagram with color. Most monochrome printers will still make a satisfying print with color turned on. Shade Lines lightly shades every other line in the report's node analysis and pipe information sections. Check Pipe and Node Comments to display comments on the same data file line as Pipe, Water, Node, and Head commands in the report. Sort Nodes will sort the node analysis report section by node name. Sort Pipe sorts pipe information by pipe name. Group pipe by path arranges the pipe information according to the actual calculation paths SHC used. When sorting is not used, pipe and/or node information is reported in the same order as defined in your data file.
Quick Settings
Experiment with report options until you have the report style you want. And do not worry about remembering the exact combinations required for a strict NFPA 13 report. Simply click the Change 2007 report button to quickly set node analysis and pipe information options back to default. Fans of SHC's original version 1.x report style may simply click the classic SHC style report button to quickly set the pipe information and node analysis options.
Finished
Now that SHC's options are set, click the Keep Changes button to save them and close the SHC Options dialog.
Page 18 of 81
PRINT THIS PAGE! (select 'current page' in your print dialog box)
Page 19 of 81
Introduction
The Simple Hydraulic Calculator can hydraulically calculate any system configuration with only a handful of different commands! And so you'll never have trouble remembering how to begin, SHC will remind you of the five core commands each time it starts:
Page 20 of 81
Use Command
Did you print the basic tree system drawing? If not, please do so now. This tutorial will be referencing that system drawing. To begin, SHC needs to know the piping material. Piping material is specified by the Use command. Type Use in the SHC editor now.
Notice that valid commands are highlighted in blue. This is called syntax highlighting. Visual clues like these help you know when commands and parameters are valid and when there is a problem (ie a different color displays). Now look at the bottom of the SHC window.
When a valid command is entered, this status bar will show expected and optional parameters with your current position shown in bold. The Use command requires a pipe material code (pipeType parameter) and a C-factor value. Since we are beginning at the water source, we need to know the pipe material code for cement lined ductile iron. SHC can help. Press the space bar in preparation for pipeType entry and wait a couple of seconds for the Popup Helper.
Page 21 of 81
This is the Popup Helper. Use your keyboard's up and down arrow keys to scroll through the window or use your mouse. When CDI is highlighted, press the ENTER key or double-click using the mouse. SHC types the material code in for you. Press the space bar again. Either type 140 for the c-factor or wait and use the Popup Helper again. A command and it's parameters must always be on the same editor line. Individual parameters must be separated by at least one space. Only one command is allowed per editor line. (The only exception is the comment command which may follow the parameters on another command's editor line.) Try commenting your command by pressing the SPACEBAR. Then type // with your comment following. Press the ENTER key to move to the next line. The editor should look similar to this following:
At any time during data entry, if you see RED, instead of blue or black, it indicates there has been a mistake:
In the above example a typo has been made entering the c-factor. Hint Liberally comment your data file (use the // command). You will be very thankful when changes are needed months down the road!
Page 22 of 81
Pipe Command
Pipes are defined with the Pipe command. Type Pipe on a new line and look at the status bar. The Pipe command requires five parameters in the following order: name A unique label for this pipe - eight characters maximum. sNode Starting node name (label) eight characters maximum. eNode End node name (label) eight characters maximum. Physical length of pipe. (SHC assumes the value is in the default unit unless unit modifiers are present. For example 5'10 will always be five feet ten inches and 1525mm will length always be 1525 millimeters. However 7.625 will be 7.625 of whichever unit is selected on the calculations page of the file properties dialog window.) Nominal size of pipe. (See the length entry for a note on size units.) After these five values, any number of fitting codes may be entered. Now we are ready to enter all the underground piping. Use a pipe command to enter the pipe from read-hydrant to underground tap. Use a pipe name of City and the node names shown on the drawing. But what is this? This is a proposal. Whenever SHC thinks it can help you type a proposal will appear. If it is what you want, press the ENTER key to accept it. Otherwise keep typing and it will be ignored. In this case, you don't want it, so just keep typing and it will disappear. SHC will make better guesses when we get to the overhead piping. Finish typing in the pipe command. When done it should look like this: Hint Descriptive pipe and node names (labels) make your data file much easier to read and understand.
Page 23 of 81
Your First System Now enter the underground lead-in pipe. Remember to add the length of the spigot to the length of the underground for a total of 29'0. SHC will also accept 22'0+7'0 as a valid length value. Note that this pipe contains two fittings. A tee with a flow turn and an elbow. After typing in the nominal pipe size, press SPACEBAR and let the popup helper help you out with the fittings!
Fitting codes must have a space between them. When done, the SHC editor should look similar to this: Continue entering the sprinkler system by creating pipe commands for the backflow preventer piping and the system riser. I'll use rpz and riser for the pipe names (labels). Don't forget the use command to change piping material to schedule 10 steel. The use command must precede the pipe command(s) to which it is to apply.
Hint A numeral suffix may be included on a fitting code to denote more than one. For example 3E would indicate three elbows.
Page 24 of 81
how do we handle pressure loss through the backflow preventer? SHC has a command specifically for fixed pressure loss devices. Even better, SHC has a built-in database of many common backflow prevention devices. On SHC's menu bar, click Insert Backflow Reduced Pressure Detector Ames C500 Butterfly Valves 4 (100mm) Vertical When the prompt appears, type the pipe name for the pipe in which the backflow preventer is located (ie: rpz) ...
Page 25 of 81
Your First System SHC inserts the command and automatically inserts a comment line directly into your file.
Use the UP ARROW key to move the caret onto the BFP command's line. Notice the format for the BFP command in the status bar. The BFP command requires, in this order, an existing pipe's name, flow rate, and pressure loss at the flow rate. Additional flow, pressure pairs may be entered to define a loss that varies with flow rate. The BFP command interpolates pressure loss between each defined flow, pressure pair, linearly. Published pressure loss for a backflow preventer includes the complete assembly (including valves). Let's take advantage of this by modifying pipe Rpz. First remove the fitting codes. Next, shorten the pipe's length by the device's take-out dimensions (see drawing). When done, the modified Pipe command should look as shown.
Crossmain
With the underground supply and riser now entered, it is time to work on the crossmain. Start with a pipe name of M1 and increment for each pipe. Pipe M1 should go from node TR all the way to node M1. Continue entering all main piping. Since we are using sequential pipe and node names, the proposal system should help you much more than earlier. In fact you should only need to repeatably tap the ENTER key to create all of the last two crossmain Pipe command entries!
Page 26 of 81
Branchlines
Now enter pipe for all flowing branchlines. As with the crossmain piping, the proposal system should significantly help your input speed. While node and pipe names ultimately are completely up to you, stick with the naming shown at right for this example. Since the riser nipple and starter piece are the same nominal size, we use one Pipe command to model both pipes as L1-1, as shown (then input pipes L1-2, L1-3, etc.). Also be sure to include the Use command for schedule 40 steel pipe or all branchline internal diameters will be wrong. Any pipe creating command (such as Pipe) will use material specified in the nearest, preceding, Use command. All done? Looks like the example to the right? Fantastic. You have typed in a lot of pipe! But you are not quite done yet.
Page 27 of 81
Water Command
The Water command defines a node as a water source node. On this project, the 'read hydrant' location, on the plan, is our water source node name Src. Type in Water on a blank line below the backflow preventer command (Bfp). Then check the command's format in the status bar. Water expects a node name, elevation, and static pressure. Additionally, flow and residual pressure value pairs may be entered to define the source's supply curve. The Water command interpolates pressure based upon log 1.85 as required by NFPA 13. Using information available on the drawing, type in all parameters for the Water command. Include the measured flow rate and the residual pressure (from the flow test) as shown below.
Now that node Src is now defined, so it should no longer appear in the undefined nodes list. Hint SHC does not care in what order you define nodes and pipes. Do you normally want to define all the nodes first? Fine. Want to define some nodes, then some pipe, then some more nodes? Fine. SHC does not impose artificial limits on how you like to work.
Page 28 of 81
Node Command
To define any node that is not a sprinkler head nor a water source use the Node command. Below the Water command, type Node to study the command's format in the status bar. Node requires a unique node name and the node's elevation. Optionally, a fixed discharge may be specified (good for a node with a hose allowance discharge). And if discharge is given, an optional minimum pressure may also be entered (good for standpipe system calculations). This sprinkler system is designed to meet ordinary hazard group II occupancy requirements. Therefore we need to include 250 gpm of outside hose allowance in the calculations. Define a node Tap with a 250 gpm discharge (shown at right). Use Node commands to define the nodes Spg, Bor, and Tor. Then move your cursor below the crossmain's Pipe commands and define the crossmain nodes:
Hint Its a good idea to keep your pipe and node commands together, in the same general area of your input easier to read your input data.
Page 29 of 81
Your First System Next, move your cursor below the branchlines' Pipe commands and enter nodes L1-1 through L1-5. Remember, this branchline runs uphill so each node should be 10 inches higher than the previous one.
But notice that node L1-6 is in the remote area. How do we define a discharging sprinkler head node? Use the Head command (not a node command).
Head Command
Type Head in SHC's editor and examine the status bar. The Head command requires a node name, elevation, required minimum discharge, and sprinkler head k-factor.
Complete the Head command entry using information from the drawing (density of 0.2 gpm/sq.ft. and standard orifice heads). Continue defining the remaining sprinkler nodes, as shown. The Undefined Node List should progressively disappear until finished. We are now ready to calculate the system!
Page 30 of 81
Calculating
There are three ways to initiate the hydraulic calculations. Select the menu item File Calculate, or press F4 on the keyboard, or click the calculator button on the toolbar. If SHC can not calculate the sprinkler system, the message and warning area (at the bottom of SHC's window) will display an appropriate error message. In the example below, the c-factor parameter was inadvertently omitted from a Use command.
Double-click the error message to highlight the command or parameter containing the error (its up in your data file). In this case, the entire line is highlighted since a parameter is missing. When a specific parameter has an invalid value, only that parameter will be highlighted. Some errors do not correspond directly to a command. Double-clicking these messages will not highlight anything.
Page 31 of 81
Results Window
After every successful calculation, the Calculation Results window appears. This window is your primary tool for evaluating your sprinkler system design.
All relevant pipe, node, and system information is displayed here in easily navigable tables. Can't see enough? Use your mouse to resize the window. The Pipe Information table even supports a customized column layout. Right-Click anywhere on this table to see a pop-up menu of selectable columns to display (add the Pf/x column now). Click and hold a Pipe Information table heading to drag it into a new position. SHC remembers how you set this window between program sessions. Don't know what the heading means? Pause your mouse cursor over any heading to see a description of its values. Click any node or pipe heading to sort the table by that value. Click the same heading again to reverse the sort.
Page 32 of 81
Changes
Check the sprinkler system's safety margin in the calculation summary table. The 'negative' margin indicates some design changes are necessary. Click the Pf/ft heading in the pipe information table to sort the pipe by friction loss per foot from low to high. Click it once more to reverse the sort. Pipe with largest friction loss per foot are now shown first.
It looks like the first piece of 1 on each branchline is too constricting. Want some corroboration of the Pf/ft information? Look at the Pf column or add the Velocity column to the pipe information table. Both values useful when evaluating a system design in a logical manner. Let's try changing the 1 branchline pipe. Move the Calculation Results window out of the way and click on the SHC Editor window (or close the results window). Locate the Pipe commands for pipes L1-5, L2-5, L3-5, and L45. Change all their nominal sizes to 1 and recalculate (press F4). Now we are getting close! Close the Calculation Results window. Move the SHC Editor window's cursor up to the first crossmain Pipe command. Toward the top of SHC's editor window is the LiveLook bar. This bar is perfect for quick checks of safety margin and individual pipe and node characteristics. Any command or parameter that SHC can show information for will be shown when the mouse pointer crosses it or the editor's cursor is moved to it. Some information, such as fitting equivalent length, is even available before calculating.
Page 33 of 81
By moving the editor's cursor, as shown above, we can see the crossmain's pressure loss is high. But don't start editing yet! Select all four commands you used to previously define the crossmain. You may do this by holding the mouse's left button and dragging or by holding the SHIFT key down while using the keyboard's arrow keys. Once all are selected, release the left mouse button and right-click anywhere in the SHC's editor window.
When the prompt appears, use the combo box to select or type in a 4 nominal size. Click the Change button when done.
Page 34 of 81
All four commands should now have a 4 nominal pipe size as shown.
Recalculate by pressing the F4 key on your keyboard (or select the menu item File Calculate). You now have a suitable safety margin.
Report
To preview the hydraulic calculation report, select the menu item Report Preview (or press F5 on the keyboard). The Report menu item also provides for printing the report and saving the report in plain text, html, and pdf formats. When done, save your data file! We will be editing this data file in the next section, Your First System Version 2. On the menu bar, select File Save. Hint Don't wait until you are finished to save. No one likes to lose even 5 minutes of work. Save often by pressing the CTRL+S keys on your keyboard (or select the menu item File Save). It is a good habit.
Page 35 of 81
Conclusion
During this tutorial you have learned SHC's basic commands for entering sprinkler system data. These commands can be used to enter ANY sprinkler system piping configuration. Let's review: Use - select pipe material Pipe - define a length of pipe Water - define a node as a water source Head - define a node as a discharging sprinkler head node Node - define a node Bfp - define a fixed pressure loss such as a backflow preventer You should now also be familiar with the SHC Editor and calculation results windows. If you are not, please review this section again before moving on to Your First System Version 2.
Page 36 of 81
Main Command
In the Your First System tutorial, the crossmain and branchlines were defined with twenty-eight Pipe commands. Now, we are going to enter all the branchline and crossmain pipe with just four commands! To begin, type Main in the SHC Editor window and look at the status bar. The Main command can be used to define an entire crossmain. It requires the nominal size, number of branchlines, and spacing between branchlines. Finish typing in the Main command using the system drawing (ie: 4 main, 8 BL's, 10' o/c). NOTE: Related commands you may wish to look up in the Simple Hydraulic Calculator Reference Manual include MainV and MainCont.
Page 37 of 81
MainElev Command
Every Main command requires a matching MainElev command. Type MainElev on a new editor line and study the status bar. The MainElev command requires a starting Elevation. An optional ending elevation can be entered to slope the main in one direction. And if an end elevation is given, an offset distance (from first branchline on main) to a peaked elevation, and the peaked elevation (offsetElev) may be entered. Finish typing in the MainElev command. That is all there is to it! Two commands and the crossmain is defined! Think of the Main command as the Pipe command for a whole crossmain. And the MainElev command is the Node command for a whole crossmain.
TreeLeft Command
SHC provides three commands for defining branchline piping TreeLeft, TreeRight, and Line. For this example, we will use the TreeLeft command. TreeLeft defines dead-end branchlines connected to the first crossmain (the first Main command that was entered). After typing in a Use command for schedule 40 steel pipe, type TreeLeft on a new line and look at the status bar. TreeLeft requires the number of heads on each branchline, starter pipe length (startLength), and branchline nominal size. Additional length and size values (ie: data pairs) may be entered to define a branchline with variable head spacing and/or variable nominal sizes as you proceed with data entry from the crossmain to the end sprinkler on the branchline. Finish typing in the TreeLeft command using pipe sizes initially used in Your First System.
The length / size pairs may be confusing at first glance but keep in mind this one command just defined the pipe for all eight branchlines.
LineElev Command
Just as mains have the MainElev command, branchlines have the LineElev Page 38 of 81
Your First System, Version 2 command. Type LineElev on a new line and examine it's parameters format.
The startElev for this sprinkler system will be the end of the branchline. Why? When pipes and nodes are automatically created using the system helper commands, SHC treats direction similar to traditional x-y graphs branchlines are layed out from left to right on the x-axis, mains from bottom to top on the yaxis. The first Main command creates the leftmost main. The last Main command is the rightmost main. TreeLeft creates branchlines connected to the left side of the leftmost main. Because the branchlines are layed out from left to right, SHC uses the left end of the branchline as the branchline's starting point, so our data input will have to conform to this programmed-in methodology. TreeRight creates branchlines connected to the right side of the rightmost main. We could have used a TreeRight command to model our branchlines. Then SHC would consider the actual end of the branchlines as the end point. Why didn't we? It would hydraulically calculate the same (mirrored or rotated systems are hydraulically the same). But there is less risk of making mistakes when you and SHC think alike in this respect. This drawing has dead-end lines extending to the left so we use the TreeLeft command. This will also get SHC to draw the flow diagram in the same orientation as our sprinkler system plan. Complete the LineElev command. Keep in mind that the EndElev will be the branchline's elevation at the crossmain, not the elevation at the first head from the crossmain.
All branchline pipes and nodes are defined with just these three commands.
Page 39 of 81
Remote Area
The Flow command defines the remote area when using the system helper commands to input a sprinkler system. Type Flow on a new line to check this command's requirements in the status bar. Flow wants coordinates for two opposite corners of a rectangular region of sprinkler heads leftbottom and right-top. Recall from the previous LineElev discussion how SHC views branchline and main piping. SHC always views branchlines as starting left and going right. SHC always views crossmains as starting low and going up. Given this, it is easy to determine the coordinates for the remote area (1,1) and (5,3). After the flowing rectangle's coordinates, Flow requires the minimum required sprinkler discharge (minDischarge) and the sprinkler k-factor.
Using the diagram above, define the L-shaped remote area as the sum of two rectangular areas, with two Flow commands.
Page 40 of 81
Here is where the automatic naming of pipes and nodes is controlled. By default the first crossmain node is M1-1 (at the 'bottom' of the crossmain). SHC will simply increment this for the second node, third node, and so on. Since we are connecting to the main at the same place as the last of eight branchlines, this will be node M1-8 (at the 'top' of the crossmain). Notice that a second crossmain name is also displayed. Is SHC limited to two crossmains? No. SHC will guess a starting name for the third, fourth, fifth, etc. crossmains based upon the first two crossmains' names. With the defaults shown above, SHC is smart enough to begin the 3rd crossmain with node name M3-1.
Page 41 of 81
Your First System, Version 2 Enter a Pipe command for the length of pipe from node TOR to node M1-8.
Now calculate. The results should be the same as the Your First System tutorial. But you accomplished entry of this system using forty-nine fewer commands! Plus SHC can now automatically generate a flow diagram. On the menu bar, select View Flow Diagram. Use the flow diagram to check remote area size and location. Also check crossmain node names to ensure you have connected the feedmain pipe to the correct node.
Flow diagrams are only available when the system helper commands are used.
Page 42 of 81
and need to verify the hydraulic calculations. This is a simple edit with the previous Your First System data file which defined the crossmain with Pipe commands. This is also an easy modification when using the system helper ChangePipe command. First use the flow diagram to find the affected pipe's name (m1-2). Now type ChangePipe on any blank line in the SHC Editor. ChangePipe is nearly identical to the Pipe command. The only difference is ChangePipe does not need starting and ending node names. ChangePipe modifies the length and/or size and/or fittings of an existing pipe. SHC already knows the node names for the pipe this command is changing. Use the ChangePipe command to modify the system and calculate. You should still have a suitable safety margin. Don't forget to save your file! Page 43 of 81
Page 44 of 81
Lastly we must change the dead-end tree branchlines to gridded branchlines. Delete the TreeLeft command and type the system helper Line command in it's place.
Hint After completing this tutorial, try changing the Your First System, Version 2 file on your own. Try entering the new floater main as the 2nd (right) crossmain. It requires fewer changes.
Page 45 of 81
Gridded Branchlines
For each crossmain created with the system helper commands after the first crossmain, a Line command is required to define the gridded branchlines. Line needs the following branchline information: number of heads per branchline, nominal pipe size, length from left main to closest head (startLength), length from right crossmain to closest head (endLength), and typical spacing between heads. Additional spacing lengths can be entered to define a pattern. Use the system drawing to complete the Line command. Remember, we are viewing the system left to right. The startLength will be the starter pipe length from the floater main. Now the starting elevation in the LineElev command needs changed. The new branchlines begin 2 higher since they start 2'6 farther left.
When done, the system helper commands in your file should look like this.
Calculate the file. If you have any errors review this section and correct them. When done, you should see a hefty safety margin.
Page 46 of 81
Mistakes
Let's open the flow diagram and check for mistakes. Check the pipe name for the ChangePipe command. Now notice the flow values at the top of the diagram.
Should the floater main have over six times the flow of the feed main? NO! When we modified the file we forgot to change the bulk main pipe that connects to the grid. Our water source is connected to the floater main! Get the correct node name from the flow diagram and change the Pipe Bulk ... command. Calculate and check the new safety margin. That simple mistake cost over three psi! Always double check changes to data files!
Page 47 of 81
Reduce Command
Large tree and gridded systems can generate hundreds of pipes and nodes. To help shorten printed reports, SHC has the Reduce command. Reduce removes non-flowing dead-end branchlines from the calculation. Reduce also combines all the individual pipes in a gridded branchline into one pipe when there are no discharging heads on the branchline. Type Reduce on any blank line in your file. Now recalculate and view the flow diagram. Notice how the first four branchlines are modeled as one pipe each.
This saves twenty-four pipe and twenty-four node entries in the printed report and this is a small system!
Page 48 of 81
Automatic Peaking
SHC can automatically peak systems entered with the system helper commands. Type Autopeak on any blank line in your file and calculate.
After a calculation, the message and warning area at the bottom of the SHC Editor window displays remote area information. In this case, the Flow commands are entered correctly. But even if the file's remote area is incorrectly placed, SHC's results represent the hydraulically most demanding position. Autopeak works by shifting the remote area heads (defined with Flow commands) to every position they fit across all branchlines. But when Reduce is used, AutoPeak only shifts the remote area left and right along the original branchlines. This can greatly speed up automatic peaking of large gridded systems - another good reason to use the Reduce command.
Page 49 of 81
BS EN 12845 Mode
BS EN 12845 Mode
By now, you should have some experience with using SHC's editor for entering sprinkler system models. All tutorials up to this point, however, have used the NFPA rules. SHC may also be used with the BS EN 12845 rules for fire sprinkler system design. This mode must be explicitly activated and some data entry parameters are different. This section will highlight SHC's differences when entering a sprinkler system using BS EN 12845 mode.
Enabling
Begin by opening the Your First System Version 2 data file. This file can be found in the SHC Examples folder installed on your computer's desktop. Now save the file with a different name by selecting the menu item File Save as. Open the file properties dialog and click on the calculations tab. In the BS EN 12845 mode section, check Enabled and select units for density and sprinkler head area. Also change the other units to standard SI values, as shown below. SHC will convert the file's parameter values to the selected units when you click the Save Changes button.
Page 50 of 81
BS EN 12845 Mode
Remote Area
When in 12845 mode, Head and Flow commands require a sprinkler head area parameter instead of a minimum required discharge parameter. Locate the Flow commands and change the area/head parameter to 9.3 (3.048m head spacing X 3.048m line spacing). Also change the converted k-factor parameter value 80.73 to the standard value of 80 as shown. A head area parameter alone is not enough information for SHC to calculate sprinkler head discharge. For this reason, the Density command must be used when 12845 mode is enabled. Head and flow commands will use the closest preceding Density command to calculate the required minimum discharge from a sprinkler head. Insert Density above the Flow commands and look at the status bar:
The Density command requires a minimum density parameter and allows an optional minimum head pressure parameter. Complete the Density command using OH2 hazard class values of 5.0 mm/min for density and 0.35 bar for minimum required head pressure. When done, your command should be similar to the command shown at right. Finally, let's change the Flow commands to represent an EN 12845 compliant shape. Sixteen discharging heads are needed to meet the required 144m 2 area of operation. This requires two entire branchlines plus four more heads on a third branchline:
Hint Make sure to enter a value for the Density command's minimum head pressure parameter whenever a sprinkler head's area of coverage is small enough to result in a discharge pressure below the code required minimum head pressure.
Page 51 of 81
BS EN 12845 Mode
Results Window
Calculate the system by pressing the F4 key or by selecting menu item File Calculate. In the summary table, note that the bor node is considered the control valve gauge 'C' node when in BS EN 1284 mode. This node may be specified in the file properties dialog.
The node information section contains three new columns for head area, required density, and calculated density. Nodes that are part of the most remote four adjacent head area have their names/labels prefixed with an asterisk (*). Finally note that SHC is maintaining the minimum head pressure specified in the Density command although this results in a slightly higher delivered density than required.
Hint If SHC improperly determines adjacency, the FourHeads command may be used to manually select the most remote adjacent heads. The FourHeads command may be abbreviated FH.
Page 52 of 81
BS EN 12845 Mode
Report Settings
Open the report options dialog by selecting menu item Report Options. Select the recommended report options shown below.
Most importantly, insure the pipe information option comprehensive pressure summary is selected or flow velocity will not always be included in the hydraulic calculation report. Also, the node analysis section of the report will always include columns for sprinkler head area, required density, and calculated density when BS EN 12845 mode is enabled. Preview the hydraulic calculation report by pressing F5 on the keyboard or selecting menu item Report Preview. Between the report's Supply Analysis and Node Analysis sections, SHC will include a four head analysis section when in BS EN 12845 mode.
Page 53 of 81
BS EN 12845 Mode
Autopeak
The Autopeak command works to find the most unfavourable area. (See the Your First System version 3 tutorial.) When in BS EN 12845 mode, however, Autopeak may be modified to find the most favourable area by using the Favourable command. Let's use these two commands to find the most favourable remote area in the data file. Start by commenting out the existing Flow commands since we need a differently shaped remote area. By commenting out the commands instead of deleting them we can quickly revert to the most unfavourable remote area when needed. The most square-like shape we can achieve for the 16 head remote area is four branchlines flowing four heads each. Type in a new Flow command for this remote area shape. Remember, SHC will automatically peak the system for you so enter the remote area anywhere. Shown below is a Flow command with the remote area defined at the most unfavourable position. Now enter the Autopeak and Favourable commands in the SHC editor. The Favourable command may be abbreviated Fav as shown. Calculate the system. The message and warning area (at the bottom of SHC's window) will display a hint on how the remote area was shifted. You can verify the final calculated position with the flow diagram (menu item View Flow Diagram).
Summary
SHC's BS EN 12845 mode will help you create code compliant reports whenever the BS EN 12845 rule set is required for automatic sprinkler system design. Please keep the following items in mind when using this mode: A Density command must precede any Head or Flow commands in the SHC editor. Multiple Density commands may be used. Head and Flow commands have a head area parameter instead of a minimum discharge parameter. The FourHeads command may be used to manually select the four most unfavorable adjacent sprinkler heads. The Favourable command may be used with Autopeak. Clean installations (not upgrades) of SHC version 2.2 or later have equivalent lengths from table 23 of EN 12845:2004+A2:2009 entered for material codes BSM, BSH, ENM, and ENH. Page 54 of 81
Velocity Pressures
Velocity Pressures
Adjusting branching flows and head discharge for velocity pressure may make a large difference in the system calculations. To make these calculation adjustments, SHC must know where to use velocity pressures. Open the Your First System data file. On any blank line, type Vel. The Vel command instructs SHC to calculate using velocity pressures regardless of the file properties settings (menu item File Properties, Calculations tab). Locate the first Pipe command for the first branchline and add the fitting code VB. VB instructs SHC to adjust flow at the start node (Velocity Beginning) for velocity pressures. Conversely, SHC can be instructed to adjust flow at the ending node with the VE fitting code (Velocity Ending). Since each branchline that splits the crossmain flow should be adjusted using velocity pressures, add the VB fitting code to the first pipe of each branchline except the last. The last branchline does not split the flow so no adjustment is required. If you do add the fitting code VB on this pipe it will have no affect. Calculate the file. Safety margin should rise from 6.36 psi to 7.22 psi. When using the system helper commands, SHC places VB and VE codes where needed on automatically generated pipes. But you must always place these fitting codes where needed on pipes defined with the Pipe command. Load the Your First System, Version 2 file, add the Vel command, and calculate. This file should yield an identical safety margin of 7.22 psi with no further work.
Hint Velocity pressures make it harder for SHC to converge on a solution. If you get a convergence error message try calculating without velocity pressures.
Page 55 of 81
Equivalent K-factors
Equivalent K-factors
Introduction
The Equivalent K-factor Editor window may be used to create, view, and edit equivalent k-factor definitions. Equivalent K-factors can speed up data entry, increase the clarity of your data file, and shorten printed hydraulic calculation reports. The Equivalent K-factor Editor may be opened by selecting Edit Equivalent K-factors on SHC's menu bar.
Tutorial
In this tutorial, you are going to learn how to model an entire branchline using an equivalent k-factor. To begin, open the Your First System data file. (If you have not done this previous tutorial, you may find the data file in the SHC Examples folder installed on Window's desktop.) Three typical remote area branchlines on this system each feed five discharging sprinkler heads. Open the Equivalent K-factor Editor window (menu item Edit Equivalent K-factors) and move it so the SHC data file editor is still visible.
The K-factor Codes list displays all equivalent k-factor codes that have been defined for the current data file. This list is empty since no equivalent k-factors Page 56 of 81
Equivalent K-factors have been defined yet. Click the New button and type in a unique name of six characters or less. For this example, use BrLine, as shown. Then click the Create new button. Now you may enter a description for this equivalent k-factor name and define it. The equivalent k-factor name may be used for any Head or Flow command's kfactor parameter.
Page 57 of 81
Equivalent K-factors When done, the equivalent k-factor editor should look similar to this.
Now you have reached the position of the first discharging sprinkler head on the branchline. A discharging sprinkler head is entered using the Head command. Study the Head command format. The equivalent k-factor's Head command does not use a node name parameter. Also, the elevation parameter is relative to the node to which the equivalent k-factor is to be applied. In this example, the node(s) the equivalent k-factor is applied to will use the elevation of the highest discharging sprinkler head. The head we are defining now is 40'0 horizontally from the highest (last) head and the line is pitched one inch per foot. Therefore, this head is 40 inches below the highest head. Complete the Head command using -40 for the elevation parameter. Copy minDischarge (20) and k-factor (5.6) parameters from the SHC data file. Finish the equivalent k-factor definition by entering the remainder of the branchline. Note that each discharging head will be ten inches higher than the previous one.
Page 58 of 81
Equivalent K-factors
Whenever you stop typing for a short period of time, SHC will attempt to calculate the equivalent k-factor. If successful, the equivalent k-factor is displayed on the highlighted bar as shown above. If the calculation fails an error message will be displayed here. Once your equivalent k-factor is successfully calculated, as shown above, click the Close button to exit the Equivalent K-factor Editor.
Page 59 of 81
Equivalent K-factors
First, delete the branchline pipe definitions we will model with equivalent k-factors ...
then delete the branchline node definitions that are no longer needed.
Page 60 of 81
Equivalent K-factors Last, Change the three crossmain Node definitions to Head commands where the branchlines connect. Change their elevation to the elevation of the highest discharging sprinkler head (23'7). Use the discharge calculated by the equivalent k-factor editor for the minDischarge parameter. Use your k-factor's name (BrLine) for the k-factor parameter, as shown below.
After entering the Head commands, verify the minimum discharge value used by placing the editor's cursor or mouse pointer over the BrLine k-factor parameter and checking the LiveLook bar. Always use the calculated discharge value when modeling multiple sprinkler heads with a singe equivalent k-factor. Calculate by pressing F4 on the keyboard or selecting the menu item File Calculate. Results are nearly identical to the Your First System data file. Congratulations you've now learned how to enter and define equivalent kfactors with Simple Hydraulic Calculator!
Page 61 of 81
Equivalent K-factors
Summary
When used correctly, equivalent k-factors can speed up input, increase the clarity of your data file, and shorten printed hydraulic calculation reports. Use the Equivalent K-factor Editor to create as many equivalent k-factors as needed for your data file. Use previously defined equivalent k-factors to create more complex equivalent kfactors (as shown at right). When using an equivalent k-factor modeling multiple head discharge (as shown above) in a Head or Flow command, use the calculated discharge value for the command's minimum discharge parameter. Do not add up minimum discharge required from each head! There must always be at least one Pipe command between any two Head commands in the equivalent k-factor definition. (You may use a zero length pipe to separate two sprinkler heads attached at the same point.) Use the actual head elevation (not main or branchline elevation) and place it on the node the equivalent k-factor attaches to. Make sure equivalent k-factor calculations are included in the report. Display the Report Options page by selecting Report Options on SHC's menu bar. Verify the equiv Kfactor information report section item is checked (as shown at right).
Page 62 of 81
To edit an existing material select it in the Defined Pipe Materials list box. Then edit values in the Internal Diameters grid. For this example we will create a new pipe material for schedule 7 steel pipe. Click the Create New Material button.
Type s7 in the edit box. This is the material code that will be associated with our new pipe material.
Page 63 of 81
Pipe Material Editor Ensure the new material is selected in the Defined Pipe Materials list box. Then proceed to fill out the required information for this new pipe material as shown below.
After entering the correct values click the Keep Changes button and the pipe material is permanently added to SHC's material database. Open the Your First System, Version 2 data file. Change the Use command so all 4 pipe will use the new schedule 7 material: Calculate the file. Safety margin rises from 5.53 psi to 5.66 psi. Internal diameters may be verified in the Calculation Results window. If an internal diameter is wrong, open the Pipe Diameter Editor and correct.
Page 64 of 81
Fitting Editor
Fitting Editor
Now that schedule 7 steel pipe is defined we will enter a fitting just for this material. Use the menu bar to select Tools Materials Fittings. This is the Fitting Equivalent Length Editor.
We are going to define a 90 grooved elbow fitting. There are two ways to do this. First, a new fitting code could be created for the schedule 40 steel pipe material. Then the fitting code would be available for use with any pipe material. It's equivalent length would be adjusted in accordance with NFPA 13 for internal diameters different then schedule 40 steel pipe and c-factors other than 120. The disadvantage to this method involves the system helper commands. These commands create pipe using the T and E fitting codes only. A new GE or EG code would not be used by Main, Line, or related commands. Instead of doing this we will add a fitting code just for use with the new schedule 7 steel pipe material entered in the previous section.
Page 65 of 81
Fitting Editor Select s7 in the Select Piping Material list box. Then click the Create New Fitting button.
Type e in the edit box and click the Create New Fitting button. Ensure s7 pipe and e fitting code are selected. Now fill in the description and equivalent length information (from your fitting manufacturer's data sheet). Note that many data sheets list equivalent length based upon schedule 40 steel pipe diameters. SHC expects the equivalent length entered for a material specific fitting code be accurate for that specific material no adjustment for internal diameter will be made. If your data is for schedule 40 steel pipe equivalent length you must adjust it for the internal diameter of schedule 7 pipe before entering. My data sheet indicates 6.5 feet equivalent length for a 4 grooved elbow. You could adjust the length manually using the following formula from NFPA 13:
4.87
But SHC has an easier way. Enter the unadjusted 6.5 feet value in the equivalent length grid. Then click the Adjust lengths for I.D. button.
SHC will prompt you to make sure you want to do this. Click Yes and all values for the current fitting are adjusted according to the NFPA formula above.
Page 66 of 81
Fitting Editor The 6.5 value should be changed to 9.06 as shown below. Click the Save Changes button to keep your new fitting definition.
SHC will use this equivalent length whenever the e fitting code is used with 4 schedule 7 pipe. If any size is used that does not have an equivalent length, the equivalent length for the e fitting code of schedule 40 steel pipe is used and adjusted for the internal diameter. Open the Your First System, Version 2 data file. Change the Use command so all 4 pipe will use the schedule 7 material and calculate.
The four elbows used in the ChangePipe command accurately equate to an equivalent length of 36'3. Hint Only use the Adjust length for I.D. button once for each fitting after entering equivalent lengths for all desired pipe sizes. Don't accidentally adjust an equivalent length twice!
Page 67 of 81
File Properties
Open the file properties dialog by selecting File Properties on the menu bar. Click on the Calculations tab.
As shown above, select Darcy-Weisbach for friction loss formula, NFPA 750 equation for friction factor (f), and Water 60F for the Liquid. This is the fastest and easiest way to change a file from the Hazen-Williams formula to the Darcy-Weisbach equation. Click the Save Changes button then calculate the file. The change in formula is apparent with the new safety margin.
Page 68 of 81
Page 69 of 81
Page 70 of 81
Calculating with Darcy Calculate the file. When the Results Window appears, right-click on the pipe information area and add the Friction Formula column. You may also wish to add columns for Reynolds number and Darcy friction factor. Verify the correct formula is used for each pipe.
SHC is not limited to one marked section, either. Multiple Hazen/Darcy command pairs may be used to mark multiple sections of a data file for HazenWilliams friction loss formula. Of course, this calculation is using water at 60F. Let's define a new antifreeze solution liquid to use instead.
Liquids
Open the Liquid Editor by selecting Tools Materials Liquids on the menu bar.
Page 71 of 81
Calculating with Darcy For this example we will define a 50% glycerinewater solution at -10C. Type a meaningful description in the dialog box and click the Create new liquid button. Fill out all required values for this liquid. Then click the Save Changes button. If you have a specific gravity value, multiply by 62.4 lbs/ft3 to obtain a mass density value. In this example 50% glycerine has a specific gravity of 1.145. Multipied by 62.4 this yields a mass density of 71.45 lbs/ft3. To use this liquid for the calculation, reopen the file properties dialog (File Properties). Click on the calculations tab and select Glycerine 50% ... as the Darcy-Weisbach formula's liquid. Make sure the adjust sprinkler head k-factors for liquid box is checked then click the Calculate adjustment button. Keep the SHC computed adjustment of 0.939 for this example. Click the Save Changes button when done.
Page 72 of 81
Results of the new liquid are readily apparent. System demand has risen over 16 psi and the k-factor values are properly adjusted. Preview the hydraulic calculation report. SHC will automatically add important calculation notes to the summary page when needed.
The correct way to make this system work is to change pipe sizes. But now is a good time to illustrate fire pump input.
Page 73 of 81
Fire Pump
On any blank line type BP and look at the status bar. The BP command (booster pump) requires a pipe name, churn pressure, rated flow, and rated pressure. Additional flow and pressure pairs may be entered to define the curve. Log 1.85 interpolation is used to determine pressure gain between given flows. Complete the command using a 400 gpm at 30 psi fire pump with a 37 psi churn pressure. Notice that SHC's proposal system will help you enter an additional flow/pressure pair for 150% flow at 65% pressure. All rated fire pumps must meet this requirement but many flow better than this. Always use manufacturer's data for additional flow points when available. Recalculate. Safety margin is now over 20 psi. In the hydraulic calculation report the BP command is reported as a device loss (negative for gains) in the pipe information notes column. In this example device loss for both the fire pump and backflow preventer will be reported for pipe Rpz. Use the Pump command to model the fire pump as a standalone independent device. See the reference manual for details of the Pump command.
Page 74 of 81
Insert Menu
Insert Menu
The insert menu is a great place to store commonly used commands for easy reuse. When you select an item from the insert menu one, or more, commands are placed in the SHC Editor window at the caret's location. But you are not limited to the items provided at program installation. The insert menu may be modified to add items and commands you commonly use. The insert menu is defined by the file insert.txt located in your computer's public documents folder. To guard against mistakes, make a copy of this file before editing. If you need to, delete the file and the original will be restored next time SHC starts.
Since insert.txt is a plain text file, you may open it with any text editor you are familiar with. You may also launch your default text editor with this file by selecting Insert Edit Insert Menu on SHC's menu bar.
Page 75 of 81
The first thing you may notice is the file is command based just like SHC files. Also like SHC files, // may be used to leave a comment. Unlike SHC, comments must be on their own line not appended to another command's line. See the following table for a complete list of commands supported by the Insert menu.
Page 76 of 81
Insert Menu
Commands
Command
SUB any text END NAME any text HINT any text
Description
Begin a new sub menu. The new sub menu's label is any text. All following menu item definitions (NAME command) will be placed in the sub menu. End the sub menu created by the closest previous SUB command. Start a menu item definition. The menu item's label is any text. Set the menu item's hint text. Any text will also be inserted into the editor as a comment (// any text) when the menu item is selected. Display a data entry dialog box to the user. The prompt is displayed with an edit box. Whatever the user enters into the edit box will replace the text in each PUT command that matches var. Multiple SET commands may be used. To have SHC mask user input by value type, use any of the following SET command derivations: SETE Elevation (supports unit modifiers) SETF Flow (zero or positive real number)
SETI Integer (zero or positive) SETK K-factor (positive real number) SETL Length (supports unit modifiers) SETN Name (8 character limit enforced) SETP Pressure (real number) SETR zero or positive Real number SETS nominal pipe Size (supports unit modifiers) Set the variable equal to expression. Variable may then be used in subsequent ASSIGN, IF, and PUT commands. Example ASSIGN %HeadsPerLine Ceil(1.2*1500/%Spacing) Executes trailing PUT command if ConditionalExpression is true. ConditionalExpression supports > (greater than), < (less than), and = (equal) comparisons. Example IF %NumHeads>(%FullLines*%HeadsPerLine) Define a SHC command that will be inserted into the editor when the menu item is selected. When a SET command is used, matching text will be replaced by the user's input. Assume command values are in U.S. units. Assume command values are in metric units
IF ConditionalExpression
Page 77 of 81
Insert Menu Expressions, including the right and left sides of ConditionalExpressions support the following operators. Operator + * / ^ Ceil Floor Round Add Subtract Multiply Divide Power Raise to nearest whole number. Lower to nearest whole number. Round to nearest whole number. Description Example 6+5 6-5 6*5 6/5 6^5 Ceil(3.01) Floor(3.9) Round(7.5*3.25)
Multiple operators may be used in an expression. But there should be no spaces in an expression.
Example
Let's add a menu item that inserts a fire pump. Move to the end of the insert.txt file and begin a sub menu.
SUB My Stuff
Now gather the information about the pump from the user.
SETN %Name pump is in pipe named: SETP %Churn churn pressure: SETF %Flow rated flow: SETP %Pressure pressure at rated flow:
Page 78 of 81
Insert Menu
The end of the insert.txt file should now look similar to this. While indenting is not required, indenting based upon your sub menu depth aids readability and is considered good practice. Save the modified insert.txt file and restart the Simple Hydraulic Calculator. The insert menu should now contain your new sub menu. Try it out!
Page 79 of 81
Add fire pump pressure gain as standPUMP inNode outNode elev churn flow pressure [flow pressure ...] alone device. Pipe must connect to inNode and outNode. Mixed Formula Calculations Hazen c-factor Darcy c-factor/roughness BS EN 12845 Mode Density density [minPressure] FourHeads head1 [head2] [head3] [head4] Head name elevation headArea k-factor Set density of discharge for following head and flow commands. Optionally set minimum required head discharge pressure. Specify the 1-4 most unfavorable adjacent heads. Only needed if SHC selects adjacent heads incorrectly. Enter sprinkler head area instead of minimum required discharge when in BS EN 12845 mode. Begin using Hazen-Williams friction loss formula. Only valid when doing a Darcy calculation. End using Hazen-Williams friction loss formula. Only valid when doing a Darcy calculation.