sps 10.1.0 help and reference

SAFER, SMARTER, GREENER

HELP AND REFERENCE

SPS 10.1.0Stoner Pipeline Simulator

July 2014DNV GL - Software

EditionThis edition applies to the SPS 10.1.0 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 GL Noble Denton, Inc. concerning GL Noble Denton (GL) asset software are set forth in the Software License Agreement between GL Noble Denton and the licensee.

GL Noble Denton 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 2014 GL Noble Denton, Inc.

600 Bent Creek Blvd., Suite 100Mechanicsburg, PA 17050 USA+1 717 724 1900

www.dnvgl.com

Stoner Pipeline Simulator (SPS) 10.1 User Guide

TABLE OF CONTENTS

Introduction to Stoner Pipeline SimulatorWhat can you do with SPS? .............................................................................. 31SPS documentation ......................................................................................... 32What is in this Help and Reference .................................................................... 32Documentation conventions ............................................................................. 33Displaying the SPS version number ................................................................... 34Copyright information ..................................................................................... 34Contacting Technical Support ........................................................................... 35

SPS Programs and FilesSPS files ........................................................................................................ 38

File naming conventions .............................................................................. 39Input syntax .............................................................................................. 39

Device keyletters ................................................................................... 39Spacing ................................................................................................ 39Continuation ......................................................................................... 39Comments ............................................................................................ 40Default values ....................................................................................... 40Numerical fields ..................................................................................... 41Element and node names ........................................................................ 41Case-sensitivity ..................................................................................... 41Abbreviations ........................................................................................ 41Wildcards ............................................................................................. 41

CSV input syntax ....................................................................................... 44Overview of Prepr ........................................................................................... 45

HTML OUTPRP reports ................................................................................. 45Overview of Trans ........................................................................................... 47

Relationship of Trans and related files ........................................................... 47Modes of running Trans ............................................................................... 47

Preparing to run Trans interactively .......................................................... 48Shared memory ......................................................................................... 48

Overview of Tport ........................................................................................... 49Preparing to use Tport ................................................................................ 49Network Tport ........................................................................................... 50

Setting up the Server and Client machines for network Tport ....................... 50Preparing an INTRAN file to run network Tport ........................................... 51Running network Tport ........................................................................... 51SPS Network Lexicon ............................................................................. 52

Running SPS programs from command line ........................................................ 54Running Prepr from the command line ......................................................... 56

Description ........................................................................................... 56Example input ....................................................................................... 57

Running Trans from the command line ......................................................... 58Description ........................................................................................... 60Example input ....................................................................................... 61

Running Tport from the command line ......................................................... 62Description ........................................................................................... 64Take note ............................................................................................. 64Example input ....................................................................................... 64

Running DRTU from the command line ......................................................... 65

4User Guide Stoner Pipeline Simulator (SPS) 10.1

Description ........................................................................................... 66Take note ............................................................................................. 66Example input ....................................................................................... 66

Running COMPRESS_RTU from the command line .......................................... 68Description ........................................................................................... 69Take note ............................................................................................. 69Example input ....................................................................................... 69

Running CTOREVIEW from the command line ................................................ 71Description ........................................................................................... 71Take note ............................................................................................. 71Example input ....................................................................................... 71

Running RTUMERGE from the command line ................................................. 73Description ........................................................................................... 73Take note ............................................................................................. 74Example input ....................................................................................... 74

Running RTUFILT from the command line ..................................................... 75Description ........................................................................................... 75

The SPS EnvironmentUsing the SPS for Windows environment ............................................................ 77

SPS Startup Window ................................................................................... 77Running SPS programs from the SPS Startup Window ................................. 78

To start SPS on Windows .................................................................... 78To select a case in the SPS Startup Window .......................................... 78To run Prepr from the SPS Startup Window ........................................... 79To run Trans from the SPS Startup Window ........................................... 79To run Viewport from the SPS Startup Window ...................................... 79To run Tport from the SPS Startup Window ........................................... 79

Trans/Tport window .................................................................................... 80The Trans/Tport toolbar .......................................................................... 81The Trans/Tport status bar ...................................................................... 81The command line in the Trans/Tport window ............................................ 81

Tasks Requiring Administrator Privilege .............................................................. 82SPS Environment Settings ............................................................................... 82

List of SPS settings .................................................................................... 83Priority of settings ...................................................................................... 86sps.settings files ........................................................................................ 86

General syntax rules for an sps.settings file ............................................... 86Specifying settings for an individual module .............................................. 87Memory allocation .................................................................................. 88Fonts ................................................................................................... 88Display colors ........................................................................................ 88Display directory (DREMPATH_DSP) ......................................................... 89Time zone ............................................................................................. 90Sample sps.settings file .......................................................................... 91

Environment variables ................................................................................ 92To set environment variables in Windows .................................................. 93To set environment variables from the command line (system prompt) ......... 93To set environment variables from the SPS command line ........................... 93

Cases ....................................................................................................... 94To manage a case on Windows ................................................................ 94

Setting preferences in the SPS Startup Window .............................................. 94Setting preferences for the display through the SPS Startup Window ............ 95Allocating memory through the SPS Startup Window .................................. 95Choosing the font for displays ................................................................. 95

Running Multiple SPS Versions .......................................................................... 96

Stoner Software Services

5Stoner Pipeline Simulator (SPS) 10.1 User Guide

Using the Stoner Software Services Window ....................................................... 99The Stoner Software Services Window Toolbar ............................................... 99About OPC Connections ............................................................................... 99

Adding an OPC Connection .................................................................... 100Configuring OPC connection properties ............................................... 101

Adding a Model Service ............................................................................. 102Configuring Model Service Properties ...................................................... 103

Managing Model Services .......................................................................... 107To start a model service ........................................................................ 107To pause a model service ...................................................................... 108To stop a model service ........................................................................ 108To resume a model service .................................................................... 108To restart a model service ..................................................................... 108To add a model .................................................................................... 108Adding a Model Service Process ............................................................. 109

Using the Actions Pane .............................................................................. 111To start a model service from the Actions pane ........................................ 112To stop a model service from the Actions pane ......................................... 112To restart a model service from the Actions pane ..................................... 113To delete a model service from the Actions pane ...................................... 113To add a process from the Actions pane .................................................. 113To apply changes to a model service from the Actions pane ....................... 113To reset the last edit action for a model service from the Actions pane ........ 113To restore model service defaults from the Actions pane ........................... 113

Customizing the Stoner Software Services Window ....................................... 113Customizing Columns ........................................................................... 114

Managing the Stoner Services Window ........................................................ 115Viewing the Stoner Services Event Viewer Log ............................................. 116

Service timeout messages .................................................................... 116

Modeling the Physical SystemBefore you build a model ............................................................................... 117

Model data requirements ........................................................................... 117Components to ignore when building a model .............................................. 119

Model options .............................................................................................. 121Phase selection ........................................................................................ 122Equations of state .................................................................................... 122Thermal modes ........................................................................................ 123Units ...................................................................................................... 124

Units derived from user units ................................................................ 124Gauge pressure and elevation ............................................................... 125Units handling in the REVIEW file ........................................................... 125

Units used for user-defined variables ................................................. 125Control system input and output units ................................................ 126

Default units ....................................................................................... 126Units for composition ........................................................................... 128Built-in units ....................................................................................... 128

Modeling equipment, supplies, and deliveries ................................................... 135Planning the simulation ............................................................................. 135Literal or idealized simulation ..................................................................... 136Supplies and deliveries ............................................................................. 136

Nodes versus externals ......................................................................... 136Regulating pressure or flow at nodes/externals ........................................ 137Setting composition at inflows ............................................................... 137Setting temperature at inflows .............................................................. 138Controlling pressure, flow, or heat rate at nodes, SALES, and TAKES .......... 138

Multiple pressure, flow, and/or heat rate control at a node .................... 139Pipes ...................................................................................................... 139


Valves and regulators ............................................................................... 141Compressors ........................................................................................... 142Pumps .................................................................................................... 142Control elements ...................................................................................... 143

Spans ......................................................................................................... 143Fluid Flow .................................................................................................... 143

Flow direction and connections ................................................................... 144Acoustic velocity ...................................................................................... 144Node capacitance ..................................................................................... 145Column separation (liquid only) .................................................................. 145Slack line flow ......................................................................................... 146Batch and composition tracking .................................................................. 147

Displaying batches on a distance plot ..................................................... 147Displaying batches on a Show window .................................................... 148

Displaying batches in a text display ............................................................ 149

Controlling the SimulationWriting control logic ...................................................................................... 151Preparing to run a simulation ......................................................................... 151

Zero flow initialization ............................................................................... 152Steady-state initialization (from SynerGEE or SPS) ....................................... 152

Loading a steady state file .................................................................... 152Showing steady state data .................................................................... 153Saving steady-state data ...................................................................... 154

LOAD.STATUS initialization ........................................................................ 154To archive the simulation ...................................................................... 154To load an archive ................................................................................ 155

Running the simulation .................................................................................. 155To run the simulation ............................................................................... 155To run for one time step ........................................................................... 155To perform a restricted run ....................................................................... 155To pause the simulation ........................................................................... 156

Entering interactive commands ....................................................................... 156Entering commands from the SPS command line .......................................... 156Editing data and variables through SPS for Windows ..................................... 156

To edit a variable ................................................................................. 156To edit variables from a Show ................................................................ 157To edit variables from a Report .............................................................. 157To open and close block valves from a Trans/Tport window ........................ 158To open and close block valves from a Show window ................................ 158To start/stop Compressor and Pump units from a Trans/Tport window ......... 158To start/stop Compressor and Pump units from a Show window ................. 158To submit a sequence ........................................................................... 158

Ending a simulation ...................................................................................... 158To quit a simulation ................................................................................. 158To exit SPS ............................................................................................. 159

Displaying and Printing DataWorking with displays ................................................................................... 161

To open a previously saved display in the Trans/Tport window ....................... 161To open a previously saved display from the command line ........................... 162To open a display that is currently in memory from the command line ............ 162To automatically open a display when you run Trans .................................... 162To save a plot or report from the command line ........................................... 162To edit the current plot or report from the command line .............................. 162To edit axes settings from the command line ............................................... 162To refresh the display .............................................................................. 163Plot overrides .......................................................................................... 163


Compressor/pump map plots ......................................................................... 163To create a compressor/pump map plot ...................................................... 164To open a compressor/pump map plot ....................................................... 165To edit a compressor/pump map plot ......................................................... 165To change the history duration for a compressor/pump map plot ................... 165To add or remove curves in a compressor/pump map plot ............................. 166To edit curve line styles, colors, and labels in a compressor/pump map plot .... 166To edit the axis settings for a compressor/pump map plot ............................. 166To display input points on a compressor/pump map plot ............................... 167To save a compressor/pump map plot ........................................................ 167

Distance plots .............................................................................................. 167To create a new distance plot from the command line .................................. 167To create a distance plot using the Trans/Tport window ................................ 168To open a distance plot ............................................................................ 169To edit the current distance plot ................................................................ 169Distance plot items ................................................................................... 170

Time plots ................................................................................................... 172To create a time plot from the Trans/Tport window ...................................... 173To create a time plot from a Report ........................................................... 174To create a time plot from a Show ............................................................. 175To create a time plot from the Edit Variable dialog box ................................. 175To open a time plot ................................................................................. 175To edit the current time plot ..................................................................... 175Sliding trends .......................................................................................... 176

Reports ....................................................................................................... 176To create or edit a Report ......................................................................... 177To open an existing Report ....................................................................... 179To edit the current Report ........................................................................ 179To sort data in a Report ............................................................................ 179To copy data in a Report to the Windows clipboard ....................................... 180To display a Report in a text-based format .................................................. 180To update the display in a Report window ................................................... 180To print a report ...................................................................................... 180

Text displays ................................................................................................ 180Aliasing expressions in text displays ($ALIAS) .............................................. 182

Show windows ............................................................................................. 182To open a Show window ........................................................................... 183To open a Show window from the command line .......................................... 184To change the display in a Show window .................................................... 184To show a device connected to the current device in the Show window ........... 184To display a Show window in a text-based format ........................................ 184To show a device previously displayed in the Show window ........................... 184

Overview of SimPlot ...................................................................................... 185Printing ....................................................................................................... 185

Validating, Troubleshooting, and TuningTroubleshooting during the model build process ................................................ 187

Tips for troubleshooting an input file ........................................................... 187Performance tuning ...................................................................................... 188

OUTTRN error messages ........................................................................... 188TRENDLISTs ............................................................................................ 188SHARELISTs ............................................................................................ 189Element post-mortems ............................................................................. 189Knot spacing and pipes ............................................................................. 189Batch size ............................................................................................... 190Tport CPU use ......................................................................................... 190

Calculation intervals ...................................................................................... 190Time steps .............................................................................................. 191


Knot spacing ........................................................................................... 191Overriding time steps and knot spacing ....................................................... 191Tuning knot spacing and time steps ............................................................ 192

Simulation time ............................................................................................ 192Elapsed time versus clock format ............................................................... 192

Elapsed time ....................................................................................... 193Clock format ....................................................................................... 193

Display of simulation time on displays and reports ........................................ 193Display of elapsed time ........................................................................ 194Display of clock format ......................................................................... 194

Viewport time zone considerations .............................................................. 195Error tolerance ............................................................................................. 195Boundary conditions ..................................................................................... 196Leak Analysis checklist .................................................................................. 196

The INPREP FileRequired input for the INPREP file ................................................................... 197INPREP file input .......................................................................................... 197Sample INPREP file ....................................................................................... 200TITLE ......................................................................................................... 201

Description .............................................................................................. 201Example input ......................................................................................... 201

SELECT (INPREP) ........................................................................................ 202Description .............................................................................................. 202Example input ......................................................................................... 203

GAS ........................................................................................................... 204Description .............................................................................................. 204Example input ......................................................................................... 204

LIQUID ...................................................................................................... 205Description .............................................................................................. 205Example input ......................................................................................... 205

CUSTODY ................................................................................................... 206Description .............................................................................................. 206Example input ......................................................................................... 206

PIPEPARMS ................................................................................................. 207Description .............................................................................................. 207Take note ................................................................................................ 207Example input ......................................................................................... 207

DEFINE.DRA ............................................................................................... 209Description .............................................................................................. 209Take note ................................................................................................ 209

NOTRACK ................................................................................................... 211Description .............................................................................................. 211Take note ................................................................................................ 211Example input ......................................................................................... 211

SET.LIMIT ................................................................................................... 212Description .............................................................................................. 212Example input ......................................................................................... 213

STATE AGA ................................................................................................. 214Description .............................................................................................. 214Take note ................................................................................................ 214Example input ......................................................................................... 216

STATE BWRS ............................................................................................... 217Description .............................................................................................. 217Take note ................................................................................................ 219Example input ......................................................................................... 220

STATE CNGA ............................................................................................... 221Description .............................................................................................. 221


Take note ................................................................................................ 221Example input ......................................................................................... 221

STATE SCL .................................................................................................. 223Description .............................................................................................. 225Take note ................................................................................................ 225Example input ......................................................................................... 231

VISCOSITY (non-Newtonian) ......................................................................... 232Description .............................................................................................. 233Take note ................................................................................................ 233Example input ......................................................................................... 234

WAX .......................................................................................................... 235Description .............................................................................................. 235Example input ......................................................................................... 236

STATE TABLE .............................................................................................. 238Description .............................................................................................. 238Take note ................................................................................................ 239Example input ......................................................................................... 239

ISOTHERMAL .............................................................................................. 240Description .............................................................................................. 240Example input ......................................................................................... 240

THERMAL ................................................................................................... 241Description .............................................................................................. 241Example input ......................................................................................... 241

TRANSTHERMAL .......................................................................................... 242Description .............................................................................................. 243Take note ................................................................................................ 243Example input ......................................................................................... 245

ENGLISH .................................................................................................... 247Description .............................................................................................. 247Example input ......................................................................................... 247

METRIC ...................................................................................................... 248Description .............................................................................................. 248Example input ......................................................................................... 248

DEFUNITS .................................................................................................. 249Description .............................................................................................. 249Take note ................................................................................................ 249Example input ......................................................................................... 249

USEUNITS .................................................................................................. 251Description .............................................................................................. 251Take note ................................................................................................ 251Example input ......................................................................................... 251

=EQUIPMENT .............................................................................................. 253Description .............................................................................................. 253Example input ......................................................................................... 253

General pipe - transient (GP) ........................................................................ 254Description .............................................................................................. 254Take note ................................................................................................ 254Example input ......................................................................................... 255

Transfer line - transient (T) ........................................................................... 256Description .............................................................................................. 259Take note ................................................................................................ 259Example input ......................................................................................... 266

Calculating DRAD values ................................................................................ 267Header (H) ................................................................................................. 269

Description .............................................................................................. 270Take note ................................................................................................ 270Example input ......................................................................................... 271

FLOWMETER ............................................................................................... 272Description .............................................................................................. 272

10

User Guide Stoner Pipeline Simulator (SPS) 10.1

Take note ................................................................................................ 272Example input ......................................................................................... 273

Heat exchanger (HE) .................................................................................... 274Description .............................................................................................. 274Take note ................................................................................................ 274Example input ......................................................................................... 275

NODE ........................................................................................................ 276Description .............................................................................................. 277Take note ................................................................................................ 277Example input ......................................................................................... 278

E SALE/TAKE ............................................................................................... 280Description .............................................................................................. 281Take note ................................................................................................ 281Example input ......................................................................................... 282

E P-CONTROL ............................................................................................. 284Description .............................................................................................. 284Take note ................................................................................................ 284Example input ......................................................................................... 285

E Q-CONTROL ............................................................................................. 286Description .............................................................................................. 286Take note ................................................................................................ 286Example input ......................................................................................... 287

E Q(P) ....................................................................................................... 288Description .............................................................................................. 288Take note ................................................................................................ 288Example input ......................................................................................... 289

E AIR-INLET Valve ....................................................................................... 290Description .............................................................................................. 290Take note ................................................................................................ 290Example input ......................................................................................... 291

E SURGETANK ............................................................................................. 292Description .............................................................................................. 292Take note ................................................................................................ 292Example input ......................................................................................... 294

Tank (TK) ................................................................................................... 295Description .............................................................................................. 296Take note ................................................................................................ 297Example input ......................................................................................... 297

Block valve (BV) .......................................................................................... 298Description .............................................................................................. 298Take note ................................................................................................ 298Example input ......................................................................................... 299

Block valve (B) ............................................................................................ 300Description .............................................................................................. 300Take note ................................................................................................ 300Example input ......................................................................................... 302

Check valve (CV) ......................................................................................... 304Description .............................................................................................. 304Take note ................................................................................................ 305Example input ......................................................................................... 305

Check valve (BC) ......................................................................................... 306Description .............................................................................................. 306Take note ................................................................................................ 306Example input ......................................................................................... 308

Control valve (V) ......................................................................................... 309Description .............................................................................................. 310Take note ................................................................................................ 310Example input ......................................................................................... 313

Relief valve (RV) ......................................................................................... 315

11



Grove G887 relief valve (V G887) .................................................................. 318Description .............................................................................................. 318Take note ................................................................................................ 319Example input ......................................................................................... 321

General regulator (RG) ................................................................................. 322Description .............................................................................................. 322Take note ................................................................................................ 323

Idealized regulator - control valve (RE) ........................................................... 324Description .............................................................................................. 324Take note ................................................................................................ 325Example input ......................................................................................... 328

Compressor TABLE ....................................................................................... 329Description .............................................................................................. 330Example input ......................................................................................... 330

Compressor fuel .......................................................................................... 331Description .............................................................................................. 331

Centrifugal compressor (CC) ......................................................................... 333Description .............................................................................................. 335Take note ................................................................................................ 335

General compressor (GC) ............................................................................. 337Description .............................................................................................. 338Take note ................................................................................................ 338Example input ......................................................................................... 339

Idealized controllable centrifugal compressor (KC) ........................................... 340Description .............................................................................................. 343Take note ................................................................................................ 344Example input ......................................................................................... 349

Theoretical horsepower-flow compressor (KP) ................................................. 353Description .............................................................................................. 355Take note ................................................................................................ 355Example input ......................................................................................... 357

Variable guide vane compressor (KV) ............................................................. 358Description .............................................................................................. 360Take note ................................................................................................ 360Example input ......................................................................................... 364

Reciprocating compressor (RC) ...................................................................... 365Description .............................................................................................. 369Take note ................................................................................................ 373Example input ......................................................................................... 375

Pump (P) .................................................................................................... 377Description .............................................................................................. 379Take note ................................................................................................ 379Example input ......................................................................................... 382

Sensor (S) .................................................................................................. 385Description .............................................................................................. 385Take note ................................................................................................ 386Example input ......................................................................................... 387

Input reference (I) (INPREP) ......................................................................... 389Description .............................................................................................. 389Take note ................................................................................................ 389Example input ......................................................................................... 390

P-I-D Controller (C) ..................................................................................... 391Description .............................................................................................. 391Take note ................................................................................................ 391Example input ......................................................................................... 394

Actuator (A) ............................................................................................... 395

12



HI/LO Select Relay (Y HI/LO) ........................................................................ 398Description .............................................................................................. 398Take note ................................................................................................ 398Example input ......................................................................................... 398

Derivative Relay (Y DERIV) ........................................................................... 400Description .............................................................................................. 400Take note ................................................................................................ 400Example input ......................................................................................... 400

Multiply Relay (Y MULTIPLY) .......................................................................... 402Description .............................................................................................. 402Take note ................................................................................................ 402Example input ......................................................................................... 402

Integrator Relay (Y INTEG) ........................................................................... 404Description .............................................................................................. 404Take note ................................................................................................ 404Example input ......................................................................................... 405

Feedback Relay (Y FEEDBACK) ...................................................................... 406Description .............................................................................................. 406Take note ................................................................................................ 406Example input ......................................................................................... 407

Switch Relay (Y SWITCH) ............................................................................. 408Description .............................................................................................. 408Take note ................................................................................................ 408Example input ......................................................................................... 409

Noise Relay (Y NOISE) ................................................................................. 410Description .............................................................................................. 410Take note ................................................................................................ 410Example input ......................................................................................... 411

Time-Averaging Relay (Y AVERAGE) ............................................................... 412Description .............................................................................................. 412Take note ................................................................................................ 412Example input ......................................................................................... 412

Data curve (D) ............................................................................................ 413Description .............................................................................................. 414Example input ......................................................................................... 415

STATION .................................................................................................... 416Description .............................................................................................. 416Take note ................................................................................................ 416Example input ......................................................................................... 416

X and Y coordinates ..................................................................................... 417Description .............................................................................................. 417

POKE and RAMP .......................................................................................... 418Description .............................................................................................. 418

The INTRAN FileRequired input for the INTRAN file .................................................................. 419INTRAN file input .......................................................................................... 419Sample INTRAN file ...................................................................................... 421ALARM ....................................................................................................... 422


ALARM.CATEGORY ....................................................................................... 424Description .............................................................................................. 424Take note ................................................................................................ 424Example input ......................................................................................... 424

13


ARCHIVE .................................................................................................... 425Description .............................................................................................. 425Example input ......................................................................................... 425

BEGIN ........................................................................................................ 427Description .............................................................................................. 427Example input ......................................................................................... 428

CALL.SEQUENCE ......................................................................................... 429Description .............................................................................................. 429Example input ......................................................................................... 430

CLOSE ....................................................................................................... 431Description .............................................................................................. 431Take note ................................................................................................ 432Example input ......................................................................................... 433

COLSEP ...................................................................................................... 434Description .............................................................................................. 434Take note ................................................................................................ 434Example input ......................................................................................... 435

Command list ............................................................................................. 436Description .............................................................................................. 436Example input ......................................................................................... 436

DEFINE.FUNCTION ....................................................................................... 437Description .............................................................................................. 437Take note ................................................................................................ 438Example input ......................................................................................... 439

DEFINE.SEQUENCE ...................................................................................... 441Description .............................................................................................. 441Example input ......................................................................................... 441

DEFINE.TIMETABLE ...................................................................................... 443Description .............................................................................................. 443Example input ......................................................................................... 444

DO.INTERACTIVE ........................................................................................ 445Description .............................................................................................. 445Example input ......................................................................................... 445

External (Named Fluid) ................................................................................ 446Description .............................................................................................. 446Example input ......................................................................................... 447

FORMAT ..................................................................................................... 449Description .............................................................................................. 449Take note ................................................................................................ 449Example input ......................................................................................... 449

IF .............................................................................................................. 451Description .............................................................................................. 451Take note ................................................................................................ 452Example input ......................................................................................... 452

Input reference (I) (INTRAN) ........................................................................ 454Description .............................................................................................. 454Take note ................................................................................................ 454Example input ......................................................................................... 455

INTERACTIVE .............................................................................................. 456Description .............................................................................................. 457Example input ......................................................................................... 457

LINE.FILL ................................................................................................... 458Description .............................................................................................. 459Take note ................................................................................................ 460Example input ......................................................................................... 460

LOAD.INPUT ............................................................................................... 462Description .............................................................................................. 462Take note ................................................................................................ 462Example input ......................................................................................... 463

14


LOAD.STATUS ............................................................................................. 464Description .............................................................................................. 464Take note ................................................................................................ 467Example input ......................................................................................... 468

LOAD.STEADY ............................................................................................. 470Description .............................................................................................. 471

MAXMIN ..................................................................................................... 473Description .............................................................................................. 473Take note ................................................................................................ 480Example input ......................................................................................... 482

NOSHARE ................................................................................................... 483Description .............................................................................................. 483

OPEN ......................................................................................................... 484Description .............................................................................................. 484Take note ................................................................................................ 485Example input ......................................................................................... 486

OUTLIST .................................................................................................... 487Description .............................................................................................. 487

POKE ......................................................................................................... 488Description .............................................................................................. 488Take note ................................................................................................ 489Example input ......................................................................................... 491

POKEALL .................................................................................................... 492Description .............................................................................................. 493Take note ................................................................................................ 493Example input ......................................................................................... 493

PRINT ........................................................................................................ 494Description .............................................................................................. 494Take note ................................................................................................ 495Example input ......................................................................................... 495

PROFILE (INTRAN) ....................................................................................... 497Description .............................................................................................. 497Take note ................................................................................................ 498Example input ......................................................................................... 498

RAMP ......................................................................................................... 499Description .............................................................................................. 501Take note ................................................................................................ 502Example input ......................................................................................... 503

REOPEN ..................................................................................................... 507Description .............................................................................................. 507Take note ................................................................................................ 507Example input ......................................................................................... 507

REVIEW SIZE .............................................................................................. 509Description .............................................................................................. 509Example input ......................................................................................... 509

SAVE.LINE.FILL ........................................................................................... 510Description .............................................................................................. 510Take note ................................................................................................ 510Example input ......................................................................................... 511

SAVE.STATUS .............................................................................................. 512Description .............................................................................................. 512Example input ......................................................................................... 513

SAVE.STEADY ............................................................................................. 514Description .............................................................................................. 514

SELECT (INTRAN) ........................................................................................ 515Description .............................................................................................. 515Take note ................................................................................................ 515Example input ......................................................................................... 515

SET ........................................................................................................... 516

15



SETLIST ..................................................................................................... 520Description .............................................................................................. 520Take note ................................................................................................ 520Example input ......................................................................................... 521

SHARE ....................................................................................................... 522Description .............................................................................................. 522Take note ................................................................................................ 523Example input ......................................................................................... 523

SHOW.STEADY ............................................................................................ 525Description .............................................................................................. 525

START ........................................................................................................ 526Description .............................................................................................. 526Take note ................................................................................................ 527Example input ......................................................................................... 528

STOP ......................................................................................................... 529Description .............................................................................................. 529Take note ................................................................................................ 530Example input ......................................................................................... 531

SUBMIT.SEQUENCE ...................................................................................... 532Description .............................................................................................. 532Take note ................................................................................................ 533Example input ......................................................................................... 533

TIMEPAGE .................................................................................................. 534Description .............................................................................................. 534

TRENDLIST ................................................................................................. 535Description .............................................................................................. 535Take note ................................................................................................ 536Example input ......................................................................................... 536

WAIT, WAIT.UNTIL ....................................................................................... 539Description .............................................................................................. 539Example input ......................................................................................... 539

WHENEVER ................................................................................................. 540Description .............................................................................................. 540Take note ................................................................................................ 540Example input ......................................................................................... 541

Interactive CommandsBACKGROUND ............................................................................................. 544


DISTPLOT ................................................................................................... 545Description .............................................................................................. 545Example input ......................................................................................... 545

FLIP ........................................................................................................... 546Description .............................................................................................. 546Example input ......................................................................................... 546

HALT/QUIT ................................................................................................. 547Description .............................................................................................. 547Take note ................................................................................................ 547Example input ......................................................................................... 547

HELP .......................................................................................................... 548Description .............................................................................................. 548

PRINTALL ................................................................................................... 549Description .............................................................................................. 549Take note ................................................................................................ 549

16


Example input ......................................................................................... 549REPORT (Interactive) ................................................................................... 551


REREAD ..................................................................................................... 552Description .............................................................................................. 552Example input ......................................................................................... 552

RUN, RUN UNTIL, RUN WHILE, RUN FOR ......................................................... 553Description .............................................................................................. 553Take note ................................................................................................ 554Example input ......................................................................................... 554

SHOW ........................................................................................................ 556Description .............................................................................................. 556Take note ................................................................................................ 557Example input ......................................................................................... 557

SPAWN ...................................................................................................... 559Description .............................................................................................. 559Take note ................................................................................................ 559Example input ......................................................................................... 559

TIMEPLOT ................................................................................................... 560Description .............................................................................................. 560Example input ......................................................................................... 560

TYPE .......................................................................................................... 561Description .............................................................................................. 561Example input ......................................................................................... 561

ZZSTICK .................................................................................................... 563Description .............................................................................................. 563Example input ......................................................................................... 563

User-defined Variables, Macros, and Include FilesUser-defined variables ................................................................................... 565

DEFINE .................................................................................................. 566Description ......................................................................................... 566Take note ........................................................................................... 566Example input ..................................................................................... 567

DEFINE.PATH .......................................................................................... 569Description ......................................................................................... 569Take note ........................................................................................... 569Example input ..................................................................................... 569

INCLUDE .................................................................................................... 571Description .............................................................................................. 571Take note ................................................................................................ 571Example input ......................................................................................... 572

Macros ........................................................................................................ 573IFELSE .................................................................................................. 574

Description ......................................................................................... 574Take note ........................................................................................... 575Example input ..................................................................................... 575

IFISMACRO ............................................................................................ 577Description ......................................................................................... 577Take note ........................................................................................... 577

MACRO .................................................................................................. 578Description ......................................................................................... 578Take note ........................................................................................... 578Example input ..................................................................................... 579

TESTMACRO ........................................................................................... 582Description ......................................................................................... 582Take note ........................................................................................... 582

17


SPS_VERSION ........................................................................................ 583Description ......................................................................................... 583Example input ..................................................................................... 583

Expanding files that contain macros and include statements ............................... 583

Expressions, Operators, and FunctionsExpressions ................................................................................................. 585

Conditional logic ...................................................................................... 585Multiple colon syntax ................................................................................ 586Examples of expressions ........................................................................... 586

Relational and logical operators ...................................................................... 588Mathematical operators ............................................................................. 588Relational operators ................................................................................. 588Logical operators ...................................................................................... 589String operators ....................................................................................... 589

Functions .................................................................................................... 589ABS ...................................................................................................... 592

Description ......................................................................................... 592Example input ..................................................................................... 592

AVG ...................................................................................................... 593Description ......................................................................................... 593Example input .............................................................................

sps 10.1.0 help and reference

Documents

sps documentation

software license agreement

liabilitiesthe software

software release version

sps programs

pipeline simulator sps

sps version number

documentation conventions