SPS

Stoner Pipeline Simulator (SPS) 9.5 Help and Reference

EditionThis edition applies to the Stoner Pipeline Simulator (SPS) 9.5 software release version and to subsequent releases and modifications until otherwise indicated in new editions.

Restricted rights, warranties, and liabilitiesThe software discussed in this document is provided under a Software License Agreement and may be used or copied only in accordance with the terms of that license. All warranties given by Advantica Inc. concerning Advantica asset software are set forth in the Software License Agreement between Advantica, Inc. and the licensee. Advantica, Inc. assumes no responsibility for any errors that may appear in this document. We reserve the right to change our software and documentation without notice. Use, duplication, or disclosure by the U.S. Government is subject to the restrictions defined as "Rights specified in the license" as set forth in subdivisions (a) and (b) of the DFARS clause 227.7202-3 entitled Rights in Commercial Computer Software and Commercial Computer Software Documentation.

Copyright notice 2005 Advantica, Inc. 1170 Harrisburg Pike Carlisle, PA 17013 +1 717 243 1900 www.advantica.biz

3

Introduction to Stoner Pipeline SimulatorWhat can you do with SPS? ............................................................................................................ 21 SPS documentation ......................................................................................................................... 22 What is in this Help and Reference ........................................................................................... 22 Documentation conventions ...................................................................................................... 23 Example Documentation Conventions ................................................................................ 23 Contacting Advantica ..................................................................................................................... 24 To display Advantica contact information ............................................................................... 24 To determine the current version of SPS ................................................................................. 24 To email SPS Support .............................................................................................................. 24

Whats New in SPS 9.5?Model Builder ................................................................................................................................. 25 Modeling ......................................................................................................................................... 33 Environment ................................................................................................................................... 33 Online modeling ............................................................................................................................. 34 Data set changes ............................................................................................................................. 35

SPS Programs and FilesRelationship of SPS programs and files ......................................................................................... 37 SPS files .......................................................................................................................................... 38 Input files .................................................................................................................................. 38 Output files ................................................................................................................................ 39 File naming conventions ........................................................................................................... 39 Input syntax ............................................................................................................................... 39 Device keyletters ................................................................................................................. 39 Spacing ................................................................................................................................ 39 Continuation ........................................................................................................................ 39 Comments ........................................................................................................................... 40 Default values ...................................................................................................................... 40 Numerical fields .................................................................................................................. 41 Element and node names ..................................................................................................... 41 Case-sensitivity ................................................................................................................... 41 Abbreviations ...................................................................................................................... 41 Wildcards ............................................................................................................................ 41 Overview of PREPR ....................................................................................................................... 43 HTML OUTPRP reports ........................................................................................................... 43 Overview of TRANS ...................................................................................................................... 44 Relationship of TRANS and related files ................................................................................. 44 Modes of running TRANS ........................................................................................................ 44 Preparing to run TRANS interactively ................................................................................ 45 Shared memory ......................................................................................................................... 45 Overview of TPORT ....................................................................................................................... 46 Preparing to use TPORT ........................................................................................................... 46 Network TPORT ....................................................................................................................... 47 Setting up the Server machine for network TPORT ........................................................... 47 To prepare an INTRAN file to run network TPORT ..................................................... 47 To set up the CORBA server to run network TPORT ................................................... 48 Setting up the Client machine for network TPORT ............................................................ 48 Running network TPORT ................................................................................................... 49

Stoner Pipeline Simulator (SPS) 9.5

Help and Reference

4

Overview of GRAFR ...................................................................................................................... 50 Preparing to run GRAFR .......................................................................................................... 50 Running GRAFR on Windows ........................................................................................... 50 Running SPS programs from the command line ............................................................................ 51 PREPR ..................................................................................................................................... 52 TRANS .................................................................................................................................... 54 TPORT ..................................................................................................................................... 58 GRAFR .................................................................................................................................... 61

The SPS EnvironmentUsing the SPS for Windows environment ...................................................................................... 63 SPS startup window .................................................................................................................. 63 Running SPS programs from the SPS startup window ....................................................... 64 To start SPS on Windows .............................................................................................. 64 To select a case in the SPS startup window ................................................................... 64 To run PREPR from the SPS startup window ............................................................... 64 To run TRANS from the SPS startup window .............................................................. 65 To run TPORT from the SPS startup window ............................................................... 65 To run GRAFR on Windows ......................................................................................... 65 TRANS/TPORT window .......................................................................................................... 66 The TRANS/TPORT toolbar ............................................................................................... 66 The TRANS/TPORT status bar ........................................................................................... 67 The command line in the TRANS/TPORT window ........................................................... 67 SPS environment settings ............................................................................................................... 67 List of SPS settings ................................................................................................................... 68 Priority of settings ..................................................................................................................... 70 sps.settings files ........................................................................................................................ 70 General syntax rules for an sps.settings file ........................................................................ 71 Specifying settings for an individual module ...................................................................... 71 Memory allocation .............................................................................................................. 72 Fonts .................................................................................................................................... 72 Display colors ...................................................................................................................... 73 Display directory (DREMPATH_DSP) ............................................................................... 73 Time zone ............................................................................................................................ 74 Sample sps.settings file ....................................................................................................... 76 Environment variables .............................................................................................................. 77 To set environment variables in Windows .......................................................................... 77 To set environment variables from the command line (system prompt) ............................. 78 To set environment variables from the SPS command line ................................................ 78 Cases ......................................................................................................................................... 78 To manage a case on Windows ........................................................................................... 79 Setting preferences in the SPS startup window ........................................................................ 79 Setting preferences for the display through the SPS startup window ................................. 79 Allocating memory through the SPS startup window ......................................................... 79 Choosing the font for displays ............................................................................................ 80

Modeling the Physical SystemBefore you build a model ............................................................................................................... 81 Model data requirements ........................................................................................................... 81 Components to ignore when building a model ......................................................................... 83 Model options ................................................................................................................................. 86

Help and Reference

Stoner Pipeline Simulator (SPS) 9.5

5

Phase selection .......................................................................................................................... 87 Equations of state ...................................................................................................................... 87 Thermal modes .......................................................................................................................... 88 Units .......................................................................................................................................... 88 Units derived from user units .............................................................................................. 89 Gauge pressure and elevation .............................................................................................. 89 Units handling in the REVIEW file .................................................................................... 90 Units handling in GRAFR ................................................................................................... 91 Default units ........................................................................................................................ 91 Units for composition .......................................................................................................... 92 Built-in units ........................................................................................................................ 93 Modeling equipment, supplies, and deliveries ............................................................................... 99 Planning the simulation ............................................................................................................. 99 Literal or idealized simulation .................................................................................................. 99 Supplies and deliveries ............................................................................................................. 99 Nodes versus externals ........................................................................................................ 99 Regulating pressure or flow at nodes/externals ................................................................ 100 Setting composition at inflows .......................................................................................... 100 Setting temperature at inflows .......................................................................................... 101 Controlling pressure, flow, or heat rate at nodes, SALES, and TAKES ........................... 102 Pipes ........................................................................................................................................ 103 Valves and regulators .............................................................................................................. 104 Compressors ............................................................................................................................ 105 Pumps ...................................................................................................................................... 105 Control elements ..................................................................................................................... 105 Spans ............................................................................................................................................. 106 Fluid Flow ..................................................................................................................................... 106 Flow direction and connections .............................................................................................. 106 Acoustic velocity .................................................................................................................... 107 Node capacitance .................................................................................................................... 108 Column separation (liquid only) ............................................................................................. 108 Slack line flow ........................................................................................................................ 109 Batch and composition tracking .............................................................................................. 110 Displaying batches on a distance plot ............................................................................... 110 Displaying batches on a Show window ............................................................................ 110 Displaying batches in a text display ........................................................................................ 112

Controlling the SimulationWriting control logic ..................................................................................................................... 113 Preparing to run a simulation ........................................................................................................ 113 Zero flow initialization ........................................................................................................... 114 Active steady-state initialization ............................................................................................. 114 Steady-state initialization (from SynerGEE or SPS) .............................................................. 115 Loading a steady state file ................................................................................................. 115 Showing steady state data ................................................................................................. 116 Saving steady-state data .................................................................................................... 117 LOAD.STATUS initialization ................................................................................................. 117 To archive the simulation .................................................................................................. 117 To load an archive ............................................................................................................. 117 Running the simulation ................................................................................................................. 118

Stoner Pipeline Simulator (SPS) 9.5

Help and Reference

6

To run the simulation ............................................................................................................. 118 To run for one time step ......................................................................................................... 118 To perform a restricted run .................................................................................................... 118 To pause the simulation ......................................................................................................... 119 Entering interactive commands .................................................................................................... 119 Entering commands from the SPS command line .................................................................. 119 Editing data and variables through SPS for Windows ............................................................ 119 To edit a variable ............................................................................................................... 119 To edit variables from a Show .......................................................................................... 119 To edit variables from a Report ......................................................................................... 120 To open and close block valves ......................................................................................... 120 To start/stop Compressor and Pump units ......................................................................... 120 To submit a sequence ........................................................................................................ 120 Ending a simulation ...................................................................................................................... 121 To quit a simulation ............................................................................................................... 121 To exit SPS ............................................................................................................................. 121

Displaying and Printing DataWorking with displays .................................................................................................................. 123 To open a previously saved display in the Trans/Tport window ........................................... 123 To open a previously saved display from the command line ................................................. 124 To open a display that is currently in memory from the command line ................................ 124 To automatically open a display when you run TRANS ...................................................... 124 To save a plot or report from the command line .................................................................... 124 To edit the current plot or report from the command line ...................................................... 124 To edit axes settings from the command line ......................................................................... 124 To refresh the display ............................................................................................................. 125 Plot overrides .......................................................................................................................... 125 Compressor/pump map plots ........................................................................................................ 125 To create a Compressor/Pump Map Plot ............................................................................... 126 To open a Compressor/Pump Map Plot ................................................................................. 127 To edit the current Compressor/Pump Map Plot .................................................................... 127 To change the Compressor/Pump Map settings ..................................................................... 127 To save a Compressor/Pump Map Plot .................................................................................. 127 To set the Compressor/Pump Map curve attributes ............................................................... 128 To add a curve to the Compressor/Pump Map ....................................................................... 128 To remove a curve from the Compressor/Pump Map ............................................................ 128 To change the figure attributes of a Compressor/Pump Map ................................................ 128 To display input points on a Compressor/Pump Map ............................................................ 129 Distance plots ................................................................................................................................ 129 To create a new distance plot from the command line ........................................................... 129 To create a Distance Plot ........................................................................................................ 129 To open a Distance Plot ......................................................................................................... 130 To edit the current Distance Plot ............................................................................................ 130 Distance plot items .................................................................................................................. 131 Time plots ..................................................................................................................................... 133 To create a Time Plot from the Trans/Tport window ............................................................. 133 To create a Time Plot from a Report ...................................................................................... 134 To create a Time Plot from a Show ........................................................................................ 134 To create a Time Plot from the Edit Variable dialog box ....................................................... 134

Help and Reference

Stoner Pipeline Simulator (SPS) 9.5

7

To open a Time Plot ............................................................................................................... 135 To edit the current Time Plot ................................................................................................. 135 Sliding trends .......................................................................................................................... 135 Reports .......................................................................................................................................... 136 To create a Report .................................................................................................................. 136 To open a Report .................................................................................................................... 137 To edit the current Report ...................................................................................................... 137 To sort data in a Report .......................................................................................................... 138 To copy data in a Report to the Windows clipboard .............................................................. 138 To update the display in a Report window ............................................................................. 138 Text displays ................................................................................................................................. 138 Aliasing expressions in text displays ($ALIAS) ..................................................................... 140 Show windows .............................................................................................................................. 141 To open a Show window ........................................................................................................ 142 To open a Show window from the command line ................................................................. 142 To change the display in a Show window .............................................................................. 143 To show a device connected to the current device in the Show window ............................... 143 To show a device previously displayed in the Show window ............................................... 143 Printing ......................................................................................................................................... 143 To print to a file ...................................................................................................................... 143

Validating, Troubleshooting and TuningTroubleshooting during the model build process ......................................................................... 145 Tips for troubleshooting an input file ..................................................................................... 145 Performance tuning ....................................................................................................................... 146 OUTTRN error messages ....................................................................................................... 146 TRENDLISTs ......................................................................................................................... 146 SHARELISTs .......................................................................................................................... 147 Element post-mortems ............................................................................................................ 147 Knot spacing and pipes ........................................................................................................... 147 Batch size ................................................................................................................................ 148 TPORT CPU use ..................................................................................................................... 148 Clearing semaphores on UNIX ............................................................................................... 148 Calculation intervals ..................................................................................................................... 149 Time steps ............................................................................................................................... 149 Knot spacing ........................................................................................................................... 149 Overriding time steps and knot spacing .................................................................................. 150 Tuning knot spacing and time steps ........................................................................................ 150 Simulation time ............................................................................................................................. 150 Elapsed time versus clock format ........................................................................................... 151 Elapsed time ...................................................................................................................... 151 Clock format ...................................................................................................................... 151 Display of simulation time on displays and reports ................................................................ 152 Display of elapsed time ..................................................................................................... 152 Display of clock format ..................................................................................................... 152 Error tolerance .............................................................................................................................. 153 Boundary conditions ..................................................................................................................... 154

The INPREP fileRequired input for the INPREP file .............................................................................................. 155

Stoner Pipeline Simulator (SPS) 9.5

Help and Reference

8

INPREP file input ......................................................................................................................... 155 Sample INPREP file ..................................................................................................................... 158 TITLE .......................................................................................................................................... 159 SELECT (INPREP) ..................................................................................................................... 160 GAS ............................................................................................................................................. 162 LIQUID ........................................................................................................................................ 163 CUSTODY .................................................................................................................................. 164 PIPEPARMS ................................................................................................................................ 165 ACTIVE ....................................................................................................................................... 167 NOTRACK .................................................................................................................................. 168 SET.LIMIT .................................................................................................................................. 169 STATE AGA ................................................................................................................................ 171 STATE BWRS ............................................................................................................................. 174 STATE CNGA ............................................................................................................................. 178 STATE SCL ................................................................................................................................. 179 VISCOSITY (non-Newtonian) .................................................................................................... 188 WAX ............................................................................................................................................ 190 STATE TABLE ............................................................................................................................ 193 ISOTHERMAL ............................................................................................................................ 195 THERMAL .................................................................................................................................. 196 TRANSTHERMAL ..................................................................................................................... 197 ENGLISH .................................................................................................................................... 202 METRIC ...................................................................................................................................... 203 DEFUNITS .................................................................................................................................. 204 USEUNITS .................................................................................................................................. 206 =EQUIPMENT ............................................................................................................................ 208 General pipe - transient (GP) ....................................................................................................... 209 Transfer line - transient (T) .......................................................................................................... 211 Header (H) ................................................................................................................................... 220 FLOWMETER ............................................................................................................................ 223 Heat exchanger (HE) ................................................................................................................... 225 NODE .......................................................................................................................................... 227 E SALE/TAKE ............................................................................................................................ 230 E P-CONTROL ........................................................................................................................... 233 E Q-CONTROL ........................................................................................................................... 235 E P(Q) .......................................................................................................................................... 237 E SURGETANK .......................................................................................................................... 239 Tank (TK) .................................................................................................................................... 242 Block valve (BV) ......................................................................................................................... 245 Block valve (B) ............................................................................................................................ 247 Check valve (CV) ........................................................................................................................ 250 Check valve (BC) ........................................................................................................................ 252 Control valve (V) ......................................................................................................................... 255 Relief valve (RV) ......................................................................................................................... 260 Grove G887 relief valve (V G887) .............................................................................................. 263 General regulator (RG) ................................................................................................................ 268

Help and Reference

Stoner Pipeline Simulator (SPS) 9.5

9

Idealized regulator - control valve (RE) ...................................................................................... Compressor TABLE .................................................................................................................... Compressor fuel ........................................................................................................................... Centrifugal compressor (CC) ....................................................................................................... General compressor (GC) ............................................................................................................ Idealized controllable centrifugal compressor (KC) .................................................................... Theoretical horsepower-flow compressor (KP) ........................................................................... Variable guide vane compressor (KV) ......................................................................................... Reciprocating compressor (RC) .................................................................................................. Pump (P) ...................................................................................................................................... Sensor (S) ..................................................................................................................................... Input reference (I) (INPREP) ....................................................................................................... P-I-D Controller (C) .................................................................................................................... Actuator (A) ................................................................................................................................. HI/LO Select Relay (Y HI/LO) ................................................................................................... Derivative Relay (Y DERIV) ...................................................................................................... Multiply Relay (Y MULTIPLY) .................................................................................................. Integrator Relay (Y INTEG) ........................................................................................................ Feedback Relay (Y FEEDBACK) ............................................................................................... Switch Relay (Y SWITCH) ......................................................................................................... Noise Relay (Y NOISE) .............................................................................................................. Time-averaging Relay (Y AVERAGE) ....................................................................................... Data curve (D) ............................................................................................................................. STATION ..................................................................................................................................... X and Y coordinates .................................................................................................................... POKE and RAMP ........................................................................................................................

269 273 275 277 280 283 295 300 307 318 325 328 331 335 337 338 340 342 344 346 348 350 351 354 355 356

The INTRAN fileRequired input for the INTRAN file ............................................................................................ 357 INTRAN file input ........................................................................................................................ 357 Sample INTRAN file .................................................................................................................... 359 ALARM ....................................................................................................................................... 360 ALARM.CATEGORY ................................................................................................................. 362 ARCHIVE .................................................................................................................................... 363 BEGIN ......................................................................................................................................... 365 CALL.SEQUENCE ..................................................................................................................... 367 CLOSE ......................................................................................................................................... 369 COLSEP ...................................................................................................................................... 371 Command list ............................................................................................................................... 373 DEFINE.FUNCTION .................................................................................................................. 374 DEFINE.SEQUENCE ................................................................................................................. 377 DEFINE.TIMETABLE ................................................................................................................ 379 DO.INTERACTIVE .................................................................................................................... 381 External (Named Fluid) ............................................................................................................... 382 FORMAT ..................................................................................................................................... 384 IF .................................................................................................................................................. 386 Input reference (I) (INTRAN) ..................................................................................................... 389

Stoner Pipeline Simulator (SPS) 9.5

Help and Reference

10

INTERACTIVE ........................................................................................................................... LINE.FILL ................................................................................................................................... LOAD.INPUT ............................................................................................................................. LOAD.STATUS ........................................................................................................................... LOAD.STEADY ......................................................................................................................... MAXMIN .................................................................................................................................... OPEN ........................................................................................................................................... OUTLIST ..................................................................................................................................... POKE ........................................................................................................................................... POKEALL ................................................................................................................................... PRINT .......................................................................................................................................... PROFILE (INTRAN) .................................................................................................................. RAMP .......................................................................................................................................... REOPEN ...................................................................................................................................... REVIEW SIZE ............................................................................................................................ SAVE.LINE.FILL ........................................................................................................................ SAVE.STATUS ............................................................................................................................ SAVE.STEADY ........................................................................................................................... SELECT (INTRAN) .................................................................................................................... SET .............................................................................................................................................. SETLIST ...................................................................................................................................... SHARE ........................................................................................................................................ SHOW.STEADY ......................................................................................................................... START ......................................................................................................................................... STOP ............................................................................................................................................ SUBMIT.SEQUENCE ................................................................................................................. TIMEPAGE ................................................................................................................................. TRENDLIST ................................................................................................................................ WAIT, WAIT.UNTIL ................................................................................................................... WHENEVER ...............................................................................................................................

391 392 395 396 401 404 414 416 417 421 423 426 427 431 433 434 436 438 439 440 443 445 448 449 451 454 456 457 461 462 467 468 469 470 471 472 473 474 475 478 480 481 482 483

Interactive CommandsBACKGROUND ......................................................................................................................... DISTPLOT .................................................................................................................................. FLIP ............................................................................................................................................. HALT/QUIT ................................................................................................................................ HELP ........................................................................................................................................... PRINTALL .................................................................................................................................. REPORT (Interactive) ................................................................................................................. REREAD ..................................................................................................................................... RUN, RUN UNTIL, RUN WHILE, RUN FOR .......................................................................... SHOW .......................................................................................................................................... SPAWN ........................................................................................................................................ TIMEPLOT .................................................................................................................................. TYPE ........................................................................................................................................... ZZSTICK .....................................................................................................................................

The INGRAF fileHelp and Reference Stoner Pipeline Simulator (SPS) 9.5

11

Required input for the INGRAF file ............................................................................................. 485 INGRAF file input ........................................................................................................................ 485 Syntax rules for the INGRAF file ................................................................................................. 486 Sample INGRAF file .................................................................................................................... 487 DEFAULT .................................................................................................................................... 488 DRAW ......................................................................................................................................... 491 FIGURE ....................................................................................................................................... 494 LINKGROUP .............................................................................................................................. 498 PROFILE (INGRAF) ................................................................................................................... 500 REPORT (INGRAF) .................................................................................................................... 504 TREND ........................................................................................................................................ 508 UNITS .......................................................................................................................................... 511 VECTOR ..................................................................................................................................... 513

Expressions, Operators, and FunctionsExpressions ................................................................................................................................... 515 Conditional logic ..................................................................................................................... 515 Multiple colon syntax ............................................................................................................. 516 Relational and logical operators .............................................................................................. 516 Mathematical operators ..................................................................................................... 516 Relational operators .......................................................................................................... 516 Logical operators ............................................................................................................... 517 String operators ................................................................................................................. 517 Examples of expressions ......................................................................................................... 517 Functions ...................................................................................................................................... 519 ABS ............................................................................................................................................. 521 AVG ............................................................................................................................................. 522 CEIL ............................................................................................................................................ 523 COUNT ........................................................................................................................................ 524 DELTA_ENTHALPY .................................................................................................................. 525 DENS ........................................................................................................................................... 526 DENS_DDP ................................................................................................................................. 527 DENS_DDT ................................................................................................................................. 528 DESCRIPTION ............................................................................................................................ 529 DEVICELIST .............................................................................................................................. 530 FLOOR ........................................................................................................................................ 532 HEAT_CAPA ............................................................................................................................... 533 HISTORY .................................................................................................................................... 534 INT ............................................................................................................................................... 535 INTEGRATE ............................................................................................................................... 536 INTERNAL ................................................................................................................................. 537 ISPEEK ........................................................................................................................................ 538 LN ................................................................................................................................................ 539 LOOKBACK ............................................................................................................................... 540 MAX ............................................................................................................................................ 541 MAXDIFF ................................................................................................................................... 542 MIN .............................................................................................................................................. 543

Stoner Pipeline Simulator (SPS) 9.5

Help and Reference

12

MOD ............................................................................................................................................ PEEKLIST ................................................................................................................................... PREV ........................................................................................................................................... SCRAPER ................................................................................................................................... STDV ........................................................................................................................................... SUM ............................................................................................................................................. SUMA .......................................................................................................................................... TAVE ........................................................................................................................................... TAYLOR1 .................................................................................................................................... TAYLOR2 .................................................................................................................................... Time function operators ............................................................................................................... TIME_HISTORY ........................................................................................................................ TINT ............................................................................................................................................ TOSTR ......................................................................................................................................... TRUNC ........................................................................................................................................ UNITS ..........................................................................................................................................

544 545 547 548 550 551 552 553 554 555 556 557 558 559 560 561

User-defined Variables, Macros, and Include FilesUser-defined variables .................................................................................................................. 563 DEFINE ................................................................................................................................. 564 DEFINE.PATH ....................................................................................................................... 567 INCLUDE .................................................................................................................................... 569 Macros .......................................................................................................................................... 571 IFELSE .................................................................................................................................. 572 IFISMACRO .......................................................................................................................... 575 MACRO ................................................................................................................................. 576 TESTMACRO ....................................................................................................................... 580 SPS_VERSION ...................................................................................................................... 581 Expanding files that contain macros and include statements ....................................................... 582 To DEMAC a file ................................................................................................................... 582

Peek and Poke Keyletters and AttributesCommon peek and poke attributes ............................................................................................... 585 Actuator (A) attributes .................................................................................................................. 586 Alarm name (AL) attributes .......................................................................................................... 586 Alarm category (AC) attributes .................................................................................................... 586 AUDIT (AU) attributes ................................................................................................................. 586 Batch tracking (BT) attributes ...................................................................................................... 587 Block valve (B) attributes ............................................................................................................. 589 Block valve (BV) attributes .......................................................................................................... 590 Centrifugal compressor (CC) attributes ........................................................................................ 590 Centrifugal compressor (KC) attributes ........................................................................................ 592 Check valve (BC) attributes .......................................................................................................... 593 Check valve (CV) attributes ......................................................................................................... 594 Control valve (V) attributes .......................................................................................................... 595 Controller (C) attributes ................................................................................................................ 596 Data curve (D, D2, D3) attributes ................................................................................................. 596 DEFINE (DE) attributes ............................................................................................................... 597

Help and Reference

Stoner Pipeline Simulator (SPS) 9.5

13

DEFINE.FUNCTION (DF) attributes .......................................................................................... 597 DEFINE.PATH (DP) attributes ..................................................................................................... 597 DEFINE.SEQUENCE (DS) attributes .......................................................................................... 598 DEFINE.TIMETABLE (TT) attributes ........................................................................................ 598 Derivative relay (Y) attributes ...................................................................................................... 599 External (P-CONTROL/Q-CONTROL/P(Q)) (E) attributes ........................................................ 599 External (SALE/TAKE) (E) attributes .......................................................................................... 600 Feedback relay (Y) attributes ........................................................................................................ 604 Flow meter (FM) attributes ........................................................................................................... 604 Fluid name (FL) attributes ............................................................................................................ 605 General compressor (GC) attributes ............................................................................................. 605 General pipe (GP) attributes ......................................................................................................... 607 GLOBALS (GB) attributes ........................................................................................................... 607 Grove G887 relief valve (V) attributes ......................................................................................... 609 Guide vane compressor (KV) attributes ....................................................................................... 610 Header (H) attributes .................................................................................................................... 612 Heat exchanger (HE) attributes .................................................................................................... 613 HI/LO select relay (Y) attributes .................................................................................................. 613 Idealized regulator (RE) attributes ................................................................................................ 614 Idealized regulator (RG) attributes ............................................................................................... 615 Input reference (I) attributes ......................................................................................................... 616 Integrator relay (Y) attributes ....................................................................................................... 616 MAXMIN (MM) attributes ........................................................................................................... 616 Multiply relay (Y) attributes ......................................................................................................... 616 Node (NO) attributes .................................................................................................................... 617 Noise relay (Y) attributes .............................................................................................................. 621 Plot limits (PL) attributes ............................................................................................................. 621 Pump (P) attributes ....................................................................................................................... 621 Reciprocating compressor (RC) attributes .................................................................................... 623 Relief valve (RV) attributes .......................................................................................................... 624 Sensor (S) attributes ...................................................................................................................... 625 Shared memory (SH) attributes .................................................................................................... 626 Station (ST) attributes ................................................................................................................... 626 Span (SP) attributes ...................................................................................................................... 627 Surge tank (E) attributes ............................................................................................................... 628 Switch relay (Y) attributes ............................................................................................................ 630 Tank (TK) attributes ..................................................................................................................... 630 Theoretical horsepower flow compressor (KP) attributes ............................................................ 631 Time-averaging relay (Y) attributes ............................................................................................. 633 Transfer line (T) attributes ............................................................................................................ 633 TRANSTHERMAL (TR) attributes ............................................................................................. 635 Wax deposition (WX) attributes ................................................................................................... 636

Model BuilderBefore using Model Builder ......................................................................................................... 637 Steps for using Model Builder ...................................................................................................... 638 Model Builder environment .......................................................................................................... 638

Stoner Pipeline Simulator (SPS) 9.5

Help and Reference

14

The Model Builder window .................................................................................................... 638 Schematic view ....................................................................................................................... 639 Model explorer ........................................................................................................................ 639 Other parts of the Model Builder window .............................................................................. 640 Layouts .................................................................................................................................... 641 Setting program options and preferences ..................................................................................... 641 Backup tabPreferences editor ............................................................................................. 641 Dependencies tabPreferences editor ................................................................................... 641 Files tabPreferences editor .................................................................................................. 642 Settings tabPreferences editor ............................................................................................. 642 Colors tabPreferences editor ............................................................................................... 642 Creating a new model ................................................................................................................... 643 Importing an existing model ......................................................................................................... 643 Setting model options ................................................................................................................... 643 Global Settings editor ............................................................................................................. 643 Equation of State editor .......................................................................................................... 643 Thermal Modes editor ............................................................................................................. 644 Select editor ............................................................................................................................ 644 Chosen Units editor ................................................................................................................. 644 Defined Units editor ................................................................................................................ 645 To view details on a currently defined unit ....................................................................... 646 To define a new unit .......................................................................................................... 646 To edit, rename, or delete a user-defined unit ................................................................... 646 Fluids editor ............................................................................................................................ 646 Viscosity table editor ............................................................................................................... 646 Limits editor ............................................................................................................................ 647 Building a model .......................................................................................................................... 647 To insert a new element ......................................................................................................... 647 To move an element ............................................................................................................... 648 To delete an item from the model .......................................................................................... 648 Element editors ....................................................................................................................... 649 Other model items ................................................................................................................... 650 Curves editor ..................................................................................................................... 650 Defines editor .................................................................................................................... 651 Paths editor ........................................................................................................................ 651 Stations editor .................................................................................................................... 651 Cutting, copying, and pasting ................................................................................................. 651 Copying elements .............................................................................................................. 652 To copy and paste an element in the schematic ........................................................... 652 To copy and paste items in the model explorer ........................................................... 652 Viewing data and navigating in Model Builder ............................................................................ 653 Zooming and navigation ......................................................................................................... 653 Selecting items ........................................................................................................................ 654 Finding model items ............................................................................................................... 655 To find an element ............................................................................................................. 655 Viewing device relationships .................................................................................................. 655 Viewing model data as text ..................................................................................................... 655 To show INPREP syntax for an element ........................................................................... 655 To open a model data file as text ....................................................................................... 656

Help and Reference

Stoner Pipeline Simulator (SPS) 9.5

15

Printing .................................................................................................................................... 656 Editing data through Model Builder ............................................................................................. 656 To edit model options and other data in Model Builder ........................................................ 656 To edit an element .................................................................................................................. 656 Types of editors ....................................................................................................................... 656 Symbols in Model Builder editors .......................................................................................... 657 Buttons in Model Builder editors ............................................................................................ 657 Setting defaults, limits, and other attribute properties ............................................................ 657 Editing multiple items ............................................................................................................. 658 Other special editors ............................................................................................................... 659 Curve Selection editor ....................................................................................................... 659 Poke/Ramp editor .............................................................................................................. 659 Pipe Distance editor .......................................................................................................... 659 Workbook mode ...................................................................................................................... 659 Customizing the schematic ........................................................................................................... 659 Schematic properties ............................................................................................................... 659 Setting grid properties ............................................................................................................. 660 Viewing data on the schematic ............................................................................................... 660 Marking up the schematic ....................................................................................................... 661 To add a shape ................................................................................................................... 661 To move a shape ................................................................................................................ 661 To move vertices on a shape ............................................................................................. 661 To set properties on a shape .............................................................................................. 662 To delete a shape ............................................................................................................... 662 To insert text in the schematic ........................................................................................... 662 To insert an image in the schematic .................................................................................. 662 Positioning objects in the schematic ....................................................................................... 662 To group objects ................................................................................................................ 662 To rotate a single object .................................................................................................... 662 To rotate multiple objects in a group ................................................................................. 662 To move an object ............................................................................................................. 663 To align objects ................................................................................................................. 663 To evenly space objects ..................................................................................................... 663 To order objects ................................................................................................................. 663 Running an SPS module ............................................................................................................... 663 Validating the model from Model Builder .............................................................................. 663 Running PREPR from Model Builder .................................................................................... 663 Running TRANS from Model Builder ................................................................................... 664 Accessing a Show window from Model Builder .................................................................... 664 Running TPORT from Model Builder .................................................................................... 665 Running GRAFR from Model Builder ................................................................................... 665 Saving model data from Model Builder ....................................................................................... 665 Maintaining Include files ........................................................................................................ 666 Preserving or overwriting include files ............................................................................. 666 To edit the overwrite status for an include file ............................................................ 666 To assign an include file for INPREP data .................................................................. 666 To overwrite selected include files when saving ......................................................... 667 To overwrite all include files when saving .................................................................. 667 Incorporating include file data into the main model ......................................................... 667

Stoner Pipeline Simulator (SPS) 9.5

Help and Reference

16

To flatten include files ................................................................................................. 667 Preserving INPREP sequence using line numbers .................................................................. 667 Model Builder utilities .................................................................................................................. 669 To find conversion factors in Model Builder ......................................................................... 669

Statefinder and LeakfinderOn-line products ........................................................................................................................... 671 Statefinder ............................................................................................................................... 671 Leakfinder ............................................................................................................................... 672 Predictor .................................................................................................................................. 672 Features of Statefinder and Leakfinder ................................................................................... 672 Relationship of TRANS and the SCADA system ................................................................... 673 Differences between off-line and online models .................................................................... 673 Solution technique for online modeling ....................................................................................... 674 State Estimation ...................................................................................................................... 674 Pressure drop forces (PDFs) .............................................................................................. 677 Diagnostic flows (DFs) ..................................................................................................... 679 Node capacitance .............................................................................................................. 679 Leak Analysis .......................................................................................................................... 679 Leaks ................................................................................................................................. 679 Injections ........................................................................................................................... 680 Circulations ....................................................................................................................... 680 Leak analysis alarms ......................................................................................................... 680 Error bounds ...................................................................................................................... 681 Autocalibration of pressure drop errors .................................................................................. 681 Autocalibration requirements ............................................................................................ 682 Autocalibration control and display .................................................................................. 682 Expected results from autocalibration ............................................................................... 683 Batch tracking in online models ............................................................................................. 683 Batch tracking algorithm ................................................................................................... 684 Tuning an online model ..................................................................................................... 685 Differences in simulation time for online and off-line models ............................................... 689 Time zones and Daylight Savings Time ............................................................................ 689 INPREP file input for online modeling ........................................................................................ 690 Composition controller .......................................................................................................... 691 Header flow (HF) ................................................................................................................... 698 Interface alignment (IA) ........................................................................................................ 701 E MON ................................................................................................................................... 713 FLOWMETER for online modeling ...................................................................................... 714 PROPERTY ........................................................................................................................... 715 SCADA .................................................................................................................................. 718 Slightly compressible liquid equation of state (STATE SCL) ............................................... 734 General pipe - transient (GP) for online modeling ................................................................ 736 Transfer line - transient (T) for online modeling ................................................................... 737 INTRAN file input for online modeling ....................................................................................... 738 GENERATE.SCHEDULE ..................................................................................................... 739 USE.SCHEDULE .................................................................................................................. 741 Interactive commands for online modeling .........................