Nexus Keyword Document

Nexus® Keyword Document
©2008 Landmark Graphics Corporation
R5000.0.1
© 2008 Landmark Graphics Corporation
All Rights Reserved Worldwide
This publication has been provided pursuant to an agreement containing restrictions on its use. The publication is also
protected by Federal copyright law. No part of this publication may be copied or distributed, transmitted, transcribed,
stored in a retrieval system, or translated into any human or computer language, in any form or by any means,
electronic, magnetic, manual, or otherwise, or disclosed to third parties without the express written permission of:
Landmark Graphics Corporation

2107 CityWest Blvd, Building 2, Houston, Texas 77042-3051, USA
P.O. Box 42806, Houston, Texas 77242, USA
Phone:713-839-2000
FAX: 713-839-2015
Internet: www.halliburton.com/landmark
Trademark Notice
3D Drill View, 3D Drill View KM, 3DFS, 3D Surveillance, 3DView, Active Field Surveillance, Active Reservoir Surveillance, ADC, Advanced
Data Transfer, ARIES, ARIES DecisionSuite, Asset Decision Solution, Asset Development Center, Asset Journal, AssetLink, AssetLink Advisor,
AssetLink Director, AssetLink Observer, Asset Performance, AssetPlanner, AssetSolver, AssetSolver Online, AssetView, BLITZPAK, CasingSeat,
COMPASS, Corporate Data Archiver, Corporate Data Store, Data Analyzer, DataManager, DataStar, DBPlot, DecisionSpace, DecisionsSpace 3D
Drill View KM, DecisionSpace AssetLink, DecisionSpace AssetPlanner, DecisionSpace AssetSolver, DecisionSpace AssetView 2D,
DecisionSpace AssetView 3D, DecisionSpace Atomic Meshing, DecisionSpace Decision Management Systems(DMS), DecisionSpace for
Production, DecisionSpace Nexus, DecisionSpace PowerGrid, DecisionSpace PowerModel, DecisionSpace PrecisionTarget, DecisionSpace
Reservoir, DecisionSpace TracPlanner, DecisionSpace Well Seismic Fusion, DecisionSpace WellSolver, DecisionSuite, DepthTeam, DepthTeam
Explorer, DepthTeam Express, DepthTeam Extreme, DepthTeam Interpreter, Desktop Navigator, DESKTOP-PVT, DESKTOP-VIP, DEX, DIMS,
Discovery, Discovery Asset, Discovery PowerStation, DMS, Drillability Suite, Drilling Desktop, DrillModel, Drill-to-the-Earth Model, DSS,
Dynamic Reservoir Management, Dynamic Surveillance System, EarthCube, EDM, EDT, eLandmark, Engineer’s Data Model, Engineer's
Desktop, Engineer’s Link, ESP, Event Similarity Prediction, Executive Assistant, ezFault, ezSurface, ezTracker, FastTrack, FG+, FieldPlan,
FZAP!, GeoAtlas, GeoDataLoad, GeoGraphix, GeoGraphix Exploration System, GeoLink, GeoProbe, GeoProbe GF DataServer, GES,
GESXplorer, GMAplus, GMI Imager, GRIDGENR, Handheld Field Operator, HHFO, I2 Enterprise, iDIMS, IsoMap, iWellFile, Landmark,
Landmark Decision Center, Landmark & Design, Landmark Logo and Design, Landscape, Lattix, LeaseMap, LMK Resources, LogEdit, LogM,
LogPrep, Magic Earth, MagicDesk, Make Great Decisions, MathPack, MIMIC, MIMIC+, Model Builder, MyLandmark, Nexus, Object MP,
OpenBooks, Open Explorer, OpenJournal, OpenSGM, OpenVision, OpenWells, OpenWire, OpenWorks, OpenWorks Development Kit,
OpenWorks Well File, OpenWorks Production, PAL, Parallel-VIP, PetroBank, PetroBank Master Data Store, PetroWorks, PetroWorks Asset,
PetroWorks Pro, PetroWorks ULTRA, PlotView, Point Gridding Plus, Pointing Dispatcher, PostStack, PostStack ESP, PostStack Family,
PowerCalculator, PowerExplorer, PowerExplorer Connect, PowerGrid, PowerHub, Power Interpretation, PowerJournal, PowerModel, PowerView,
PrecisionTarget, Presgraf, PRIZM, Production Asset Manager, PROFILE, Project Administrator, ProMAGIC, ProMAGIC Connect, ProMAGIC
Server, ProMAX, ProMAX 2D, ProMAX 3D, ProMAX 3DPSDM, ProMax 4D, ProMax Family, ProMAX MVA, ProMAX VSP, pSTAx, Query
Builder, Quick, Quick+, QUICKDIF, QuickWell, QuickWell+, QUIKDIG, QUIKRAY, QUIKSHOT, QUIKVSP, RAVE, RAYMAP, RAYMAP+,
Real Freedom, Real Time Asset Management Center, Real Time Decision Center, Real Time Operations Center, Real Time Production
Surveillance, Real Time Surveillance, Real-Time View, Reference Data Manager, RESev, ResMap, RightTime, RTOC, SCAN, SeisCube,
SeisMap, SeisModel, SeisSpace, SeisVision, SeisWell, SeisWorks, SeisWorks 2D, SeisWorks 3D, SeisWorks PowerCalculator, SeisWorks
PowerJournal, SeisWorks PowerView, SeisXchange, Semblance Computation and Analysis, Sierra Family, SigmaView, SimConnect, SimConvert,
SimDataStudio,SimResults, SimResults+, SimResults+3D, SIVA, SIVA+, StreamCalc, smartSECTION, Spatializer, SpecDecomp, StrataAmp,
StrataMap, StrataModel, StrataSim, StratWorks, StrataWorks 3D, StressCheck, STRUCT, Structure Cube, Surf & Connect, SynTool, SystemStart,
SystemStart for Clients, SystemStart for Servers, SystemStart for Storage, Tanks & Tubes, TDQ, Team Workspace, TERAS, The Engineer’s
Desktop, Total Drilling Performance, TOW/cs, TOW/cs Revenue Interface, TracPlanner, Trend Form Gridding, Turbo Synthetics, VESPA,
VESPA+, VIP, VIP-COMP, VIP-CORE, VIPDataStudio, VIP-DUAL, VIP-ENCORE, VIP-EXECUTIVE, VIP-Local Grid Refinement, VIP-
THERM, WavX, Web Editor, Wellbase, Wellbore Planner, Wellbore Planner Connect, WELLCAT, WELLPLAN, Well Seismic Fusion,
WellSolver, WellXchange, WOW, Xsection, You're in Control. Experience the difference, ZAP!, and Z-MAP Plus are trademarks, registered
trademarks or service marks of Landmark Graphics Corporation.
All other trademarks, service marks and product or service names are the trademarks or names of their respective owners.
Note
The information contained in this document is subject to change without notice and should not be construed as a commitment by
Landmark Graphics Corporation. Landmark Graphics Corporation assumes no responsibility for any error that may appear in this
manual. Some states or jurisdictions do not allow disclaimer of expressed or implied warranties in certain transactions; therefore,
this statement may not apply to you. .
Landmark Nexus Keyword® Document
Table of Contents
Table of Contents............................................................................................................ iii
The Case File .................................................................................................................... 13

In This Chapter ................................................................................................................... 13
Case File ............................................................................................................................. 14
Multiple Reservoir Case File .............................................................................................. 27
ASCII Structured Grid Case File ........................................................................................ 31
Units Systems .................................................................................................................. 37

In This Chapter ................................................................................................................... 37
Unit System Rules .............................................................................................................. 38
Units Table.......................................................................................................................... 39
Keyword Format .............................................................................................................. 41

In This Chapter ................................................................................................................... 41
General Input Rules ............................................................................................................ 42
Tabular Input....................................................................................................................... 43
Tree Structured Input .......................................................................................................... 44
Common Input Data............................................................................................................ 46
Common Input Data............................................................................................................ 48
Use of the Wildcard Character (*) ...................................................................................... 49
Output Files ....................................................................................................................... 51

In This Chapter ................................................................................................................... 51
Output Files......................................................................................................................... 52
Description of Max File Entries.......................................................................................... 54
Array Data ........................................................................................................................... 57

In This Chapter ................................................................................................................... 57
Array Data Input ................................................................................................................ 58
Array Data Requirements ................................................................................................... 60
Connection Data.............................................................................................................. 63
In This Chapter ................................................................................................................... 63
Connection Data Input ........................................................................................................ 64
R5000.0.1 iii
Nexus Keyword® Document Landmark
Pseudo Transfer Function ......................................................................................... 67

In This Chapter ................................................................................................................... 67
Aquifer Connection Data ............................................................................................ 69

In This Chapter ................................................................................................................... 69
Aquifer Connection Data (AQCONNS) Input.................................................................... 70
Options Data...................................................................................................................... 71
In This Chapter ................................................................................................................... 71
Standard Temperature and Pressure ................................................................................... 72
Temperature ................................................................................................................. 72
Pressure ........................................................................................................................ 73
Reservoir Temperature ....................................................................................................... 75
Region Fluids In Place Method .......................................................................................... 76
Region Names, Separator and PVT Methods (REGDATA) .............................................. 77
Compositional Residual Oil................................................................................................ 79
Structured Grid Data ........................................................................................................... 80
Assigning Grids to Processes.............................................................................................. 82
Water Properties ............................................................................................................. 85

In This Chapter ................................................................................................................... 85
Water Properties (without Hydrocarbon Solubility)........................................................... 86
Water Properties (with Hydrocarbon Solubility)................................................................ 89
Hydrocarbon PVT Properties ................................................................................... 93

In This Chapter ................................................................................................................... 93
Black Oil Fluid Systems ..................................................................................................... 95
Water Oil Fluid Systems..................................................................................................... 96
Gas Water Fluid Systems.................................................................................................... 97
Saturated Oil and Gas Table ............................................................................................... 98
Oil Table ............................................................................................................................. 100
Gas Table ............................................................................................................................ 102
Undersaturated Oil Table................................................................................................... 104
Undersaturated Gas Table................................................................................................... 106
Negative Compressibility Check ........................................................................................ 108
Consistency of Gas/Oil and Oil/Gas Ratio Data................................................................. 109
API Tables .......................................................................................................................... 111
APIGROUP ........................................................................................................................ 112
Temperature-Dependent Black Oil Tables ......................................................................... 113
Examples of Black Oil Fluid System Input ........................................................................ 114
EOS PVT Data.................................................................................................................... 116
System Definition Data ................................................................................................ 118
iv R5000.0.1
Units Selection ............................................................................................................. 119

Optional Parameters ..................................................................................................... 120
EOS Component Property Data .......................................................................................... 127
EOS Component Coefficients for Ideal Gas Cp ................................................................. 130
EOS Binary Interaction Data .............................................................................................. 131
Examples of EOS Fluid System Input ................................................................................ 133
Separator Methods ........................................................................................................ 135

In This Chapter ................................................................................................................... 135
EOS Multistage Separator Tables....................................................................................... 136
Gas Plant Data .................................................................................................................... 138
Key Component Definition .......................................................................................... 138
Auxiliary Conditions and Data for Gas Plant Effluent Molar Volume Calculations .. 139
Black Oil Separator Tables ................................................................................................. 142
API Separators .................................................................................................................... 144
Relative Permeability and Capillary Pressure ................................................ 147

In This Chapter ................................................................................................................... 147
Three-Phase Relative Permeability Parameters .................................................................. 149
Water-Oil Relative Permeability Table .............................................................................. 150
Gas-Oil Relative Permeability Table .................................................................................. 152
Gas-Water Relative Permeability Table ............................................................................. 154
Gas-Water Relative Permeability from Three Phase Data ................................................. 156
Hysteresis Parameters ......................................................................................................... 157
Water-Oil Imbibition Relative Permeability Table for Hysteresis (User Option).............. 160
Gas Imbibition Relative Permeability Table for Hysteresis (User Option)........................ 161
J-Function Adjustment of Capillary Pressure ..................................................................... 162
Endpoint Scaling................................................................................................................. 164
Endpoint Scaling Tabular Output ....................................................................................... 166
Vertical Equilibrium Options.............................................................................................. 170
IFT Adjustment of Capillary Pressure and Gas/Oil Relative Permeability ........................ 172
Gas-Dependent Water Relative Permeability ..................................................................... 174
Gas-Dependent Water Relative Permeability Table .................................................... 174
Water Three-Phase Relative Permeability Parameters ................................................ 175
Special Performance-Related Data Options ....................................................................... 177
SPLINE ........................................................................................................................ 177
Capillary Pressure Freeze Options ............................................................................... 181
Rock Properties ............................................................................................................... 183

In This Chapter ................................................................................................................... 183
Rock Compressibility Data ................................................................................................. 184
Pressure-Dependent Permeability Multipliers .................................................................... 185
Rock Compaction Tabular Data ........................................................................................ 186
R5000.0.1 v
Rock Compaction Options (Specified by Method)............................................................. 187

Water-Induced Rock Compaction Tabular Data................................................................. 188
Water-Induced Rock Compaction Options (Specified by Method).................................... 190
Coordination of Rock Options ............................................................................................ 191
Rules for Combining Options ...................................................................................... 191
Calculation Details.............................................................................................................. 193
Pore Volume Adjustment ....................................................................................... 193
Transmissibility and Well KH Adjustment ........................................................... 195
Implicitness of Calculations ................................................................................... 197
Output Information Available............................................................................................. 198
Equilibration Data ........................................................................................................... 199

In This Chapter ................................................................................................................... 199
Basic Datum Initialization .................................................................................................. 200
Integrated Saturation Initialization Options (INTSAT)...................................................... 203
Black Oil Variation with Depth .......................................................................................... 204
Oil- and Gas-Zone Composition (Single Input Anchor-Point)........................................... 205
Compositional Variation with Depth (Multiple Input Anchor Points) ............................... 207
Supercritical Initialization................................................................................................... 210
Saturation and Pressure Overreads ..................................................................................... 211
Equilibration examples ....................................................................................................... 213
Tracer Initialization ........................................................................................................ 215

In This Chapter ................................................................................................................... 215
Tracer Initialization with Depth.......................................................................................... 216
Aquifer Data ....................................................................................................................... 217

In This Chapter ................................................................................................................... 217
Carter-Tracy Analytic Aquifers .......................................................................................... 218
Fetkovich Analytic Aquifers.............................................................................................. 223
Run Control........................................................................................................................ 227

In This Chapter ................................................................................................................... 227
Simulation Start Date.......................................................................................................... 229
Setting Controls by Grid or Field ....................................................................................... 230
Time Step Control Data ..................................................................................................... 231
Time Step Control Using Impes Stability Criteria.............................................................. 234
Convergence Tolerances..................................................................................................... 237
Maximum Allowed Changes in Implicit Iterations ............................................................ 238
Implicit Mass Balance Option ............................................................................................ 241
Surface Network Constraint Overshoot .............................................................................. 242
Output Data at Start of Run ................................................................................................ 244
Output Control Data............................................................................................................ 245
vi R5000.0.1
Output Dual Porosity Data.................................................................................................. 251

Spreadsheet Control Data ................................................................................................... 253
Debug Output...................................................................................................................... 255
Array and Map Output Specification.................................................................................. 256
Region Output Specification............................................................................................... 259
Output File Formats ............................................................................................................ 261
Solver Parameters (SOLVER) ........................................................................................... 262
Minimum and Maximum Run Pressure.............................................................................. 267
Timestepping Method ......................................................................................................... 268
DRSDT Option ................................................................................................................... 269
EOS Options ....................................................................................................................... 270
Time Data ........................................................................................................................... 274
Include files......................................................................................................................... 275
Example Run Control File .................................................................................................. 276
Well Specification Data ............................................................................................... 277

In This Chapter ................................................................................................................... 277
Well Specification Data ...................................................................................................... 278
Requirements ............................................................................................................... 278
Calculation of the Wellbore Constant for each completion ......................................... 278
Wellbore Sub-Network Configuration ......................................................................... 279
Well Specification Table (WELLSPEC) ............................................................................ 280
Relative Permeability Scaling (WELLSPEC continued)................................................... 285
Well Modification Data ..................................................................................................... 289
Include files......................................................................................................................... 291
Time Data ........................................................................................................................... 292
Example well file ................................................................................................................ 293
Surface Network .............................................................................................................. 295

In This Chapter ................................................................................................................... 295
Surface Network Description.............................................................................................. 298
Assumptions ................................................................................................................. 300
Requirements ............................................................................................................... 301
Network Configuration ................................................................................................ 303
Example 1 .................................................................................................................... 305
Example 2 .................................................................................................................... 308
Network Fluid System ........................................................................................................ 310
Stream Composition Specification (STREAMS) ............................................................... 311
Default Network Temperature (NETTEMP) ...................................................................... 313
Dependency of Density on Temperature (DEN_TEMP).................................................... 314
Multi-Reservoir Input (RESV) ........................................................................................... 315
NODE Definition Data (NODES) ...................................................................................... 317
Default Connection Data (CONDEFAULTS) .................................................................... 319
Default Injection Well Mobility Treatment ........................................................................ 324
R5000.0.1 vii
Default Crossflow Treatment (CROSSFLOW) .................................................................. 325

Default Treatment for Datum Pressure Constraints (DATUM) ......................................... 327
Well Connection Data (WELLS)........................................................................................ 328
Wellhead Data (WELLHEAD)........................................................................................... 338
Wellbore Data (WELLBORE)............................................................................................ 343
Wellnode Data (WELLNODE) .......................................................................................... 347
Node Connection Data (NODECON)................................................................................. 351
Tree Structured Network Data (GROUP).......................................................................... 357
Combining Wells in a Multi-Reservoir Run (COMBINEWELLS) ................................... 362
Rig Data (RIG).................................................................................................................... 366
Drillsite Data (DRILLSITE) ............................................................................................... 367
Reinjection Streams (REINJECTION) ............................................................................... 368
Stream Tracers (STREAM_TRACER) .............................................................................. 370
Pressure Drop Correlation Data (PDCORR) ...................................................................... 372
Elevation Profiles (ELEVPR) ............................................................................................. 374
Temperature Profiles (TEMPPR) ....................................................................................... 376
Temperature Gradient Profiles (TEMPGR)........................................................................ 378
Hydraulics Options (HYDRAULICS)................................................................................ 379
Fluid Gradient Calculation Data (GRADIENT) ................................................................. 380
Separation and Stream Splitting Node Data (SEPNODES) ............................................... 382
Commingled Production (COMMINGLE)......................................................................... 387
Simplified Heat Transfer (HEATTR) ................................................................................. 388
Well Lists (WELLLIST)..................................................................................................... 390
Connection Lists (CONLIST)............................................................................................. 392
Node Lists (NODELIST).................................................................................................... 395
Rig Lists (RIGLIST) .......................................................................................................... 397
Drill Parameters (DRILL)................................................................................................... 398
2D Array of Connections (CONLIST_2D) ........................................................................ 399
Network Rate Constraints (CONSTRAINTS).................................................................... 400
Network Pressure Constraints (CONSTRAINTS) ............................................................. 405
Network Drawdown/Buildup Constraints (CONSTRAINTS) ........................................... 408
Minimum Rate Limits (CONSTRAINTS) ......................................................................... 411
Well and Perforation Limits (CONSTRAINTS) ................................................................ 415
Fuel Shrinkage and Constraints (CONSTRAINTS) ........................................................... 420
Miscellaneous Constraint Data (CONSTRAINTS) ............................................................ 422
Multiple Rate Data (QMULT) ............................................................................................ 425
Production and Injection Targets (TARGET) .................................................................... 427
Connection Rate Data for Targets (TGTCON)................................................................... 439
Guide Rate Formula (GUIDERATE) ................................................................................. 442
Remote Control of Well Constraints (WELLCONTROL)................................................. 446
Remote Control of Constraints (CONTROL)..................................................................... 448
Gas Lift Ontime (GLIFT) ................................................................................................... 453
Gas Lift Optimization Parameters (GLIFTOPT)................................................................ 454
Activating and Deactivating Connections (ACTIVATE/DEACTIVATE) ........................ 456
Water-Alternating-Gas (WAG) Wells ................................................................................ 458
Connection Shut In Parameters (CONPARAM) ................................................................ 460
viii R5000.0.1
Valve Procedure Parameters (CONPARAM)..................................................................... 463

Reopening Shut-in Connections and Restarting Shut Off Pumps (TEST) ......................... 466
Wells Included in RFT Report (RFTWELLS) ................................................................... 470
Include Files (INCLUDE) .................................................................................................. 471
Skipping Data for Multifield Runs (SKIP) ......................................................................... 472
Time Data (TIME) .............................................................................................................. 473
Examples of Surface Network Files ................................................................................... 474
Procedures ......................................................................................................................... 481

In This Chapter ................................................................................................................... 481
Introduction......................................................................................................................... 482
Procedure Array Constants ................................................................................................. 483
Procedure Data Input .......................................................................................................... 485
Variable Declaration and Initialization............................................................................... 486
Operators............................................................................................................................. 489
IF statements ....................................................................................................................... 491
DO Loops............................................................................................................................ 492
Predefined Variables........................................................................................................... 493
Functions and the Use of masks ......................................................................................... 495
Description of Functions..................................................................................................... 497
Basic Functions ............................................................................................................ 497
Functions to Manipulate Lists ...................................................................................... 507
Functions to Retrieve Network Data ........................................................................... 510
Functions to Change Network Data ............................................................................. 533
Other Functions ............................................................................................................ 583
Examples............................................................................................................................. 585
Hydraulics Data ............................................................................................................... 591

In This Chapter ................................................................................................................... 591
Hydraulics Data Table Using Oil Rates With Gas-Oil Ratios............................................ 592
Hydraulics Data Table Using Oil Rates With Gas-Liquid Ratios ...................................... 596
Hydraulics Data Table Using Liquid Rates With Gas-Liquid Ratios................................. 600
Hydraulics Data Table Using Liquid Rates With Gas-Oil Ratios ...................................... 604
Hydraulics Data Table Using Gas Rates............................................................................. 608
Hydraulics Data Table Using Water Rates ......................................................................... 612
Hydraulics Data Table Using Wet Gas Rates and Mean Molecular Weights .................... 616
Hydraulics Table Extrapolation Limits............................................................................... 620
Water Injection Hydraulics Correlation Data ..................................................................... 621
Valve and Choke Data .................................................................................................. 623

In This Chapter ................................................................................................................... 623
Valve Coefficient Data ....................................................................................................... 624
Choke Coefficient Data ...................................................................................................... 626
R5000.0.1 ix
Pump Data .......................................................................................................................... 627

In This Chapter ................................................................................................................... 627
Pump Data........................................................................................................................... 628
Compressor Data ............................................................................................................ 633

In This Chapter ................................................................................................................... 633
Compressor Data................................................................................................................. 634
Gaslift Data ......................................................................................................................... 639

In This Chapter ................................................................................................................... 639
Optimal Gaslift Data ........................................................................................................... 640
Override Data .................................................................................................................... 645

In This Chapter ................................................................................................................... 645
Array and Transmissibility Override in a Region............................................................... 646
Transmissibility Override across an Interface .................................................................... 650
Pressure Threshold for Limiting Gridblock-to-Gridblock Flow......................................... 653
Time Data ........................................................................................................................... 655
Default EOS Properties ............................................................................................... 657

In This Chapter ................................................................................................................... 657
Default properties ............................................................................................................... 658
Default EOS Options .......................................................................................................... 659
Default EOS Component Property Data ............................................................................. 664
Default EOS Component Coefficients for Ideal Gas Cp .................................................... 667
Default EOS Binary Interaction Data ................................................................................. 668
Standard Components ......................................................................................................... 669
Task Guides ....................................................................................................................... 673

ASCII Structured Grid Case File ........................................................................................ 673
Required File Structure ................................................................................................ 673
Dual Porosity Modeling...................................................................................................... 675
In this Chapter .............................................................................................................. 676
Example ....................................................................................................................... 676
Vertical Equilibrium Options ....................................................................................... 677
Transfer Function Options ........................................................................................... 677
Array and Map Output ................................................................................................. 678
Well Specification ........................................................................................................ 678
Structured Grid Data ..................................................................................................... 679

Introduction......................................................................................................................... 679
x R5000.0.1
Grid Definition and Utility Data ......................................................................................... 680

Grid Definition ............................................................................................................. 680
Grid Utility Data .......................................................................................................... 682
Map File/VDB Control ................................................................................................ 686
Domain Decomposition and Parallel Runs .................................................................. 687
DUAL Arrays .............................................................................................................. 688
Grid Arrays ......................................................................................................................... 689
Arrays ........................................................................................................................... 689
Grid Geometry ............................................................................................................. 699
Grid Physical Properties .............................................................................................. 704
Integer Arrays .............................................................................................................. 705
Region Definition Arrays ............................................................................................. 707
Rock Arrays ................................................................................................................. 708
User Initialization Arrays ............................................................................................. 709
Multiplier Arrays ......................................................................................................... 709
Functions for Arrays .................................................................................................... 710
Array Propagation Rules .............................................................................................. 716
Grid Modifiers .................................................................................................................... 717
Arbitrary Gridblock Connections (FTRANS) ............................................................. 717
Connection Transmissibility Modification (MULT) ................................................... 719
Inter/Intra Region Transmissibility Multiplier (MULTIR) ......................................... 721
Grid Override Options (OVER) ................................................................................... 722
Value Override Option (VOVER) ............................................................................... 724
Named Fault Region Transmissibility Multiplier (MULTFL) .................................... 726
Grid Coarsening (COARSEN) ..................................................................................... 727
Aquifer Connections (INFLUX) .................................................................................. 729
Structured Grid Example .................................................................................................... 732
Keyword Index ................................................................................................................. 735
Subject Index .................................................................................................................... 763
R5000.0.1 xi
xii R5000.0.1
The Case File
In This Chapter
The following data input is described in this chapter:
• The main file (the Case File) which specifies the data input files used in a simulation run.
• A special form of the Case File used for multiple reservoir runs.
• A special form of the Case File for running modular tests.
• A special form of the Case File using the structured grid option as an ASCII alternative or as
input to various decision management applications.
R5000.0.1 The Case File: In This Chapter 13

Case File
The parameters are specified as follows:
DESC description
RUN_UNITS ENGLISH or METRIC or METKG/CM2 or METBAR or LAB
DEFAULT_UNITS ENGLISH or METRIC or METKG/CM2 or METBAR or LAB
DATEFORMAT MM/DD/YYYY or DD/MM/YYYY
RESTART TIME time restartDirectory
Or LAST restartDirectory
Or TIMESTEP itime restartDirectory
REPORT
INITIALIZE_ONLY (MAPVDB or MAPFORM or MAPBINARY)
ALL_KEYWORDS
EOS_DEFAULTS filename
PROPERTY_FILES
CONNECTIONS (conopts) SET is filename
PV (options) SET is filename
IRELPM (options) SET is filename
IPVT (options) SET is filename
IWATER (options) SET is filename
IEQUIL (options) SET is filename
DEPTH (options) SET is filename
IROCK (options) SET is filename
ITRACER (options)) SET is filename
ITRAN (options) SET is filename
IXFER SET is filename
GLOBALCELL (options) SET is filename
ACTIVE (options) SET is filename
IGRID (options) SET is filename
POROSITY SET is filename
KX SET is filename
KY SET is filename
KZ SET is filename
XINDEX SET is filename
YINDEX SET is filename
ZINDEX SET is filename
COMPR (options) SET is filename
KPMULT (options) SET is filename
NCORNER SET is filename
XCORNER SET is filename
YCORNER SET is filename
ZCORNER SET is filename
IREGION reg_grp_name (options) SET is filename
AQCONNS (options) SET is filename
CSORM (options) SET is filename
OPTIONS filename
INITIALIZATION_FILES
14 The Case File: Case File R5000.0.1

EQUIL METHOD is filename

PRESSURE (options) SET is filename
SW (options) SET is filename
SG (options) SET is filename
PSAT (options) SET is filename
API (options) SET is filename
TEMPERATURE SET is filename
MOLEFRACTION cptname (options) SET is filename
CONCENTRATION cptname tracername (options)SET is filename
TRACER_INIT METHOD is filename
ROCK_ARRAY_FILES
SWL (options) SET is filename
SWR (options) SET is filename
SWU (options) SET is filename
SGL (options) SET is filename
SGR (options) SET is filename
SGU (options) SET is filename
SWRO (options) SET is filename
SGRO (options) SET is filename
SGRW (options) SET is filename
SWLPC (options) SET is filename
SGLPC (options) SET is filename
KRW_SWRO (options) SET is filename
KRW_SWU (options) SET is filename
KRG_SGRO (options) SET is filename
KRG_SGU (options) SET is filename
KRO_SWL (options) SET is filename
KRO_SWR (options) SET is filename
KRO_SGL (options) SET is filename
KRO_SGR (options) SET is filename
KRW_SGL (options) SET is filename
KRW_SGR (options) SET is filename
KRG_SGRW (options) SET is filename
SGTR (options) SET is filename
SOTR (options) SET is filename
ROCK_FILES
RELPM METHOD is filename
ROCK METHOD is filename
PVT_FILES
PVT METHOD is filename
WATER METHOD is filename
SEPARATOR METHOD is filename
AQUIFER_FILES
AQUIFER METHOD is filename
RECURRENT_FILES
SURFACE NETWORK is filename
RUNCONTROL filename
WELLS SET is filename
OVERRIDE (options) filename
IREGION reg_grp_name (options) TIME time SET is filename
R5000.0.1 The Case File: Case File 15

NET_METHOD_FILES
HYD METHOD is filename
VALVE METHOD is filename
GASLIFT METHOD is filename
PUMP METHOD is filename
COMPRESSOR METHOD is filename
where:
DESC Introduces a line describing the input in the file. DESC can appear
as many times as desired. All other input on the line following
DESC is the description.
RUN_UNITS Introduces the units system that the run will use. All data will be
converted to this unit system, and all output from the run will be in
this unit system. The default is ENGLISH).
DEFAULT_UNITS Introduces the default units system. If the units system is not
specified in an input file, the data will be assumed to be in this unit
system. (The default is ENGLISH).
ENGLISH Specifies that the data in this file English Oilfield units.
METRIC Specifies that the data in this file uses metric units with Kpa for
pressures.
METKG/CM2 Specifies that the data in this file uses metric units with Kg/cm2 for
pressures.
METBAR Specifies that the data in this file uses metric units with Bars for
pressures.
LAB Specifies that the data in this file uses laboratory units.
DATEFORMAT Introduces the format used for input of dates. If the date format is
not specified in an input file, this format will be assumed. This also
sets the format used for dates in the output files. The default is
MM/DD/YYYY.
MM/DD/YYYY Specifies that dates will be entered in the MM/DD/YYYY format.

Note that leading zeroes are not required in the MM and DD fields.
E.g. 1/25/2001. (This is the default)
DD/MM/YYYY Specifies that dates will be entered in the dd/mm/yyyy format.

E.g. 25/1/2001.
RESTART Introduces restart input. This is followed by the TIME, LAST, or

TIMESTEP keyword, and the restart directory name.

The keyword TIME may be followed by a time in days (or hours

for LAB units) or a date to indicate the time at which the restart
commences. The time is measured as elapsed time from the start
date. The keyword LAST indicates that the restart will begin at the
last restart record written. The keyword TIMESTEP is followed by
an integer specifying the time step for the restart.
The restart directory name is the name of the restart directory

created by the initial run, which is named casename.rst, where
casename is the casename specified for the initial run. If the .rst
extension is not present, the program will first check for the
existence of the restart data using the restartDirectory name as
input, and if it does not find restart data, it will add the .rst
extension and check again. The RESTART keyword is only present
if the run is a restart. (Default: Not a restart run)
REPORT Specifies that a report of the input will be output to the

casename.rpt file. If this keyword is present, all the keyword input
files will be (re)compiled. (Default: REPORT.)
INITIALIZE_ONLY Specifies that the simulation will terminate immediately after

initialization. Initial saturations, pressures, etc. will be output to the
.map file. This can be followed by the optional keywords,
MAPVDB, MAPFORM or MAPBINARY, which specify that the
map data should be written to the VDB, written as a formatted map
file, or as a binary map file. The default is MAPVDB.
NOREPORT Specifies that a report of the input will not be output to the
casename.rpt file. (Default: REPORT.)
ALL_KEYWORDS Specifies that all keywords, including keywords that are not yet
functional in the Nexus® software, will be allowed. By default,
keywords which are not yet functional in the Nexus software will
generate a FATAL error.
EOS_DEFAULTS Introduces the name of the file that contains default EOS properties.
(Default: no EOS_DEFAULTS file.)
PROPERTY_FILES Introduces data input for the following reservoir properties.
The following three keywords are applicable to dual porosity only. Dual porosity inheritance rules
are described in “Notes” on page 25. Options may be MATRIX or FRAC. Conopts may also be
MATRIXFRAC. Dual Porosity modeling is explained in more detail in the Task Guide section
“Dual Porosity Modeling” on page 675.
Important: Dual porosity and permeability models are not yet commercially supported. Informa-

tion relating to these options is included in the manual for ongoing testing and pilots.
MATRIX Keyword qualifier indicating that this file applies to matrix porosity
data. MATRIX is the default.
FRAC Keyword qualifier indicating that this file applies to fracture

porosity data.
MATRIXFRAC Keyword qualifier indicating that this file applies to matrix-fracture

connection data. This is a connections keyword qualifier only.
CONNECTIONS Introduces a file containing cell to cell connection data. This is

followed by the keyword SET and a number which can have a
value from 1 to the number of connection data sets. (Required).
PV Introduces a file containing cell pore volume data. This is followed

by the keyword SET and a number which can have a value from 1
to the number of sets of array data. (Required)
IRELPM Introduces a file containing relative permeability method cell

assignments. This is followed by the keyword SET and a number
which can have a value from 1 to the number of sets of array data.
(Default: all cells assigned to method 1).
IPVT Introduces a file containing PVT method cell assignments. This is

value from 1 to the number of sets of array data. (Default: all cells
assigned to method 1)
IWATER Introduces a file containing water PVT method cell assignments.

This is followed by the keyword SET and a number which can
have a value from 1 to the number of sets of array data. (Default:
all cells assigned to method 1)
IEQUIL Introduces a file containing equilibration method cell assignments.

all cells assigned to method 1)
DEPTH Introduces a file containing cell depths. This is followed by the

keyword SET and a number which can have a value from 1 to the
number of sets of array data. (Required)
IROCK Introduces a file containing rock method (compressibility) cell

(Default: all cells assigned to method 1)

ITRACER Introduces a file containing the tracer initialization method

assigned to each grid cell. This is followed by the keyword SET
and a number which can have a value from 1 to the number of sets
of array data. In conjunction with the data in the TRACER_INIT
file, the data in the ITRACER file is used to assign tracer
concentrations to grid cells.
ITRAN Introduces a file containing transmissibility region cell

assignments. This is followed by the keyword SET and a number,
(Default: all cells assigned to transmissibility region 1).
IXFER Introduces a file containing transfer function method cell

Note: this only applicable to Dual. (Default: all cells assigned to
method 1).
GLOBALCELL Introduces a file containing the global cell number. This is

value from 1 to the number of sets of array data. (Default: cells are
numbered from 1 to the number of cells)
ACTIVE Introduces a file containing a value of 1 for an active cell, 0 for an

inactive cell. This is followed by the keyword SET and a number
Cells with zero pore volume are inactive, regardless of the value
input in this array. (Default: all cells are active)
IGRID Introduces a file containing the computational grid assignments.

all cells are assigned to a single computational grid)
POROSITY Introduces a file containing the cell porosities.

have a value from 1 to the number of sets of array data. Used for J-
Functions. (Default: Not used)
KX Introduces a file containing the cell x-direction permeabilities. This

is followed by the keyword SET and a number which can have a
value from 1 to the number of sets of array data. Used for J-
KY Introduces a file containing the cell y-direction permeabilities. This



KY Introduces a file containing the cell z-direction permeabilities. This

COMPR Introduces a file containing the rock compressibility of each cell.

have a value from 1 to the number of sets of array data. Used if the
Rock Method data file specifies the COMPR method. (Default: Not
used)
KPMULT Introduces a file containing the permeability multiplier of each cell.

have a value from 1 to the number of sets of array data. Used if the
Rock Method data file specifies the KPMULT method. (Default:
Not used)
XINDEX Introduces a file containing an x direction index value (real) for the
cell. This is followed by the keyword SET and a number which
can have a value from 1 to the number of sets of array data.
Required if override data is input. (Default: none)
YINDEX Introduces a file containing an y direction index value (real) for the
ZINDEX Introduces a file containing an z direction index value (real) for the
IREGION Introduces a file containing the cell region assignments. This is

followed by a name for this group of region assignments, then the
number of sets of array data. (Default: None)
NCORNER Introduces a file containing the number of corners for each grid
block. This is followed by the keyword SET and a number which
(Default: All grid blocks have 8 corners)
XCORNER Introduces a file containing x direction location of each corner of

each grid block. This is followed by the keyword SET and a

number which can have a value from 1 to the number of sets of

array data. (Default: Not used)
YCORNER Introduces a file containing y direction location of each corner of

each grid block. This is followed by the keyword SET and a
number which can have a value from 1 to the number of sets of
ZCORNER Introduces a file containing z direction location (depth) of each

corner of each grid block. This is followed by the keyword SET and
a number which can have a value from 1 to the number of sets of
AQCONNS Introduces a file containing cell to aquifer connection data. This is

value from 1 to the number of aquifer connection data sets.
(Required when using aquifers).
CSORM Introduces a file containing the residual oil saturation due to

compositional effects for each cell. This is followed by the
number of sets of array data. (Default: not used)
OPTIONS Introduces a file containing options used in the run.
INITIALIZATION_FILES Introduces data input for the following initial properties.
EQUIL Introduces a file containing an equilibration method. This is

followed by the keyword METHOD and a number which can have
a value from 1 to the number of equilibration methods. (Required
for capillary-gravity equilibration).
PRESSURE Introduces a file containing the initial cell pressures. This is

value from 1 to the number of sets of array data. (Required if
capillary-gravity equilibration is not used)
SW Introduces a file containing the initial cell water saturations. This is

capillary-gravity equilibration is not used)
SG Introduces a file containing the initial cell gas saturations. This is

capillary-gravity equilibration is not used, and the fluid system is
BLACKOIL).

PSAT Introduces a file containing the initial cell saturation pressures.

have a value from 1 to the number of sets of array data. (Required
if capillary-gravity equilibration is not used, and the fluid system is
BLACKOIL).
API Introduces a file containing the API Gravity of the oil in each
gridblock. This is followed by the keyword SET and a number
(Required if capillary-gravity equilibration is not used, and the fluid
system is API).
TEMPERATURE Introduces a file containing the initial temperatures. This is

value from 1 to the number of sets of array data.
MOLEFRACTION Introduces a file containing the initial cell component mole

fractions. This is followed by the component name, then the
number of sets of array data. Mole fractions must be specified for
every hydrocarbon component, and they must sum to 1.0.
(Required if capillary-gravity equilibration is not used, and the fluid
system is EOS.)
CONCENTRATION Introduces a file containing the initial tracer concentrations. The

keyword is followed by a component name (cptname) and a tracer
name (tracername), then the keyword SET and a number which can
have a value from 1 to the number of sets of array data. Salinity
grid data input is a special case of the CONCENTRATION input
with component name WATER and tracer name SALT.
Concentrations should be between 0 and 1, except for the special
case of salt tracer and water component. Then, the concentrations
should have values that correspond to salinity units. The same
tracer name can be used for different components. For multiple
field runs, a component tracer will convert to a tracer with the same
name in the transformed component(s). A superset of components
will be created so that tracers present in one reservoir will be
tracked if they end up in another reservoir. For example, if
reservoir 1 contains an API fluid, a tracer named tracer1 assigned to
both components oil1 and oil2, and reservoir 2 contains a black oil
fluid with a tracer named tracer2 assigned to the oil component,
then both reservoirs and the surface network will end up with
tracers tracer1 and tracer2 assigned to all oil components.
TRACER_INIT Introduces a file containing a table of tracer concentrations versus

depth. The keyword is followed by the keyword METHOD and a
number which can range from 1 to the number of tracer

initialization methods. The depth ranges in this table do not have to

be the same as those found in the EQUIL method tables.
ROCK_ARRAY_FILES Introduces data input for the cell relative permeability endpoint
data. All of the following keywords are followed by the keyword
SET and a number which can have a value from 1 to the number of
sets of array data. No endpoint data is required. If any of the
relative permeability methods used specify endpoint scaling, the
default values will be taken from the method endpoints.
SWL Minimum water saturation.
SWR Residual water saturation.
SWU Maximum water saturation.
SGL Minimum gas saturation.
SGR Residual gas saturation.
SGU Maximum gas saturation.
SWRO Water saturation at residual oil to water.
SGRO Gas saturation at residual oil to gas.
SGRW Gas saturation at residual water (GASWATER fluid systems only).
SWLPC Minimum water saturation for PCWO curve (2PT Scaling only).
This will not affect relative permeability scaling and allows
independent scaling of capillary pressure curve.
SGLPC Minimum gas saturation for PCGO/PCGW curves (2PT Scaling

only). This will not affect relative permeability scaling and allows
independent scaling of capillary pressure curve.
KRW_SWRO Krw at Swro.
KRW_SWU Krw at Swu.
KRG_SGRO Krg at Sgro.
KRG_SGU Krg at Sgu.
KRO_SWL Kro at Swl.
KRO_SWR Kro at Swr.
KRO_SGL Kro at Sgl (Must equal KRO_SWL if Sgl = 0).

KRO_SGR Kro at Sgr.
KRW_SGL Krw at Sgl (GASWATER only).
KRW_SGR Krw at Sgr (GASWATER only).
KRG_SGRW Krw at Sgrw (GASWATER only).
SGTR Maximum Trapped gas saturation (KRG Hysteresis)
SOTR Maximum Trapped oil saturation (KROW Hysteresis)
ROCK_FILES Introduces data input for the following rock properties.
RELPM Introduces a file containing a relative permeability method. This is

a value from 1 to the number of methods. (Required).
ROCK Introduces a file containing a rock compressibility method. This is

PVT_FILES Introduces data input for the following PVT properties.
PVT Introduces a file containing a hydrocarbon PVT method. This is

WATER Introduces a file containing a water PVT method. This is followed

by the keyword METHOD and a number which can have a value
from 1 to the number of methods. (Required).
SEPARATOR Introduces a file containing a SEPARATOR method. This is

a value from 1 to the number of methods.
AQUIFER_FILES Introduces data input for the following AQUIFER properties.
AQUIFER Introduces a file containing an AQUIFER method. This is followed

from 1 to the number of methods. (Required when using aquifers).
RECURRENT_FILES Introduces data input for the following time varying data.
SURFACE Introduces a file containing a surface network. This is followed by

the keyword NETWORK and a number which can have a value
from 1 to the number of networks. (Required).

WELLS Introduces a file containing a well data. This is followed by the

number of well data files. (Required).
RUNCONTROL Introduces the file containing run control data. (Required).
OVERRIDE Introduces the file containing override data.
IREGION Introduces a file containing the cell region assignments. This is

followed by a name for this group of region assignments, the
keyword TIME followed by the time when the assignments are
applied, then the keyword SET and a number which can have a
value from 1 to the sets of array data.
NET_METHOD_FILES Introduces data input for methods used by the surface network.
HYD Introduces a file containing a hydraulics method. This is followed

from 1 to the number of methods.
VALVE Introduces a file containing a valve method. This is followed by the

keyword METHOD, and a number which can have a value from 1
to the number of methods.
GASLIFT Introduces a file containing an optimal gaslift method. This is

followed by the keyword METHOD, and a number which can have
PUMP Introduces a file containing a pump method. This is followed by the

COMPRESSOR Introduces a file containing a compressor method. This is followed

by the keyword METHOD, and a number which can have a value
Notes:
1. If a file name contains spaces, then it should be enclosed in quotes. E.g. “c:\data\rel
perm.dat”
2. The files can be ascii keyword files, or Nexus binary files.
3. The file names can give the absolute path of the file, or the path relative to the location of the
case file.
4. The dual porosity input affects the data in the following areas:

Dual Porosity Inheritance Rules:
• The following quantities not specified with a FRAC designation will be inherited from
the associated MATRIX quantities:
IPVT, IEQUIL, IWATER, IREGION, ACTIVE, ITRAN, and ITRACER
• The following quantities not specified with a FRAC designation WILL NOT BE
inherited from the associated MATRIX quantities:
PV, IRELPM, DEPTH, THICKNESS, NETTHICKNESS, POROSITY, KX,

KY,KZ, IROCK, GLOBALCELL,COMPR, (ALL ENDPOINTS).
• Quantities specified by FRAC designation are not inherited by any associated missing
MATRIX quantities
Example:
DESC Small Impes Black Oil Dataset

RUN_UNITS ENGLISH
DATEFORMAT MM/DD/YYYY
REPORT
DEFAULT_UNITS ENGLISH
PROPERTY_FILES
PV Set 1 c:\Data\pv.fbin
CONNECTIONS Set 1 c:\Data\connections.fbin
IRELPM Set 1 c:\Data\isat.dat
DEPTH Set 1 c:\Data\depth.dat
IREGION Layers Set 1 c:\Data\layers.dat
IGRID Set 1 c:\Data\igrid.dat
SW Set 1 c:\Data\sw.dat
SG Set 1 c:\Data\sg.dat
PRESSURE Set 1 c:\Data\pressure.dat
PSAT Set 1 c:\Data\psat.dat
ROCK_ARRAY_FILES
SWL Set 1 c:\Data\swmin.dat
ROCK_FILES
ROCK Method 1 c:\Data\cr.dat
RELPM Method 1 c:\Data\small_impes_rp.dat
PVT_FILES
PVT Method 1 c:\Data\pvt.dat
WATER Method 1 c:\Data\water.dat
RECURRENT_FILES
SURFACE Network 1 c:\Data\small_impes.spn
WELLS Set 1 c:\Data\small_impes_wells.dat
RUNCONTROL c:\Data\control.dat
IREGION Leases 10.0 Set 1 c:\Data\leases.dat

Multiple Reservoir Case File
A multiple reservoir allows the input data for several individual reservoirs to be combined, with-
out requiring any changes to the data for the individual reservoirs
DESC description
RESTART TIME time filename
REPORT
ALL_KEYWORDS
COMBINE_GRIDS
RESERVOIR reservoir_name casefilename
PVT_FILES PVT METHOD in filename
WATER METHOD in filename
SEPARATOR METHOD in filename
RECURRENT_FILES SURFACE NETWORK in filename
RUNCONTROL filename
NET_METHOD_FILES HYD METHOD in filename
VALVE METHOD is filename
where:
this unit system. This will override the RUN_UNITS input in the
individual reservoir case files. (The default is ENGLISH).
system. All individual reservoir case files should use the same
DEFAULT_UNITS. (The default is ENGLISH).
pressures.
R5000.0.1 The Case File: Multiple Reservoir Case File 27

pressures.
pressures.
DATEFORMAT DATEFORMAT Introduces the format used for input of dates. If

the date format is not specified in an input file, this format will be
assumed. This also sets the format used for dates in the output files.
The DATEFORMAT in all the individual reservoir case files must
be the same as the DATEFORMAT specified in the multireservoir
case file. The default is MM/DD/YYYY.


E.g. 25/1/2001.
RESTART Introduces restart input. This is followed by the TIME for the start
of the restart run, and the name of the restart directory output by the
run from which this case will be restarted. Only present if the case
is a restart. (Default: not a restart run). The individual reservoir
cases can not be restarts.

files will be (re)compiled. (Default: REPORT).

initialization. Initial saturations, pressures, etc. will be output as
map data. This data can be followed by the optional keywords,
functional in the Nexus software, will be allowed. By default,
28 The Case File: Multiple Reservoir Case File R5000.0.1

COMBINE_GRIDS Specifies that all grids will be combined into a single grid.
All individual reservoir case files should use the same
EOS_DEFAULTS. (Default: no EOS_DEFAULTS file.)
RESERVOIR Introduces the data for each individual reservoir.
Reservoir_name A name given to an individual reservoir.
Casefilename The name of a case file for an individual reservoir case.




from 1 to the number of networks.
RUNCONTROL Introduces the file containing run control data. The individual
reservoir run control data files will be ignored.(Required).


GASLIFT Introduces a file containing an optimal gaslift method. This is

R5000.0.1 The Case File: Multiple Reservoir Case File 29



Notes:
1. If a file name contains spaces, then it should be enclosed in quotes. E.g. “c:\data\my pvt.dat”
2. The files can be ascii keyword files, or Nexus binary files.
3. The file names can give the absolute path of the file, or the path relative to the location of the
case file.
4. The surface network will be the combination of the individual reservoir surface networks,
and any additional network data specified in this network file. The individual network con-
nections can be redefined in this network file to connect the individual networks into a com-
bined network. The node and connection names used in the network files must be unique. If
no PVT, WATER, SEPARATOR or HYD files are present in the multiple reservoir case file,
then network method assignment numbers will refer to the methods specified for the first res-
ervoir. If they are present, then the network method assignment numbers will refer to the
methods in the multiple reservoir case file.
5. The network file input in the multiple reservoir case file must use names and not numbers in
the CONSTRAINTS table. The numbers for nodes, connections and wells (if used) in the
individual reservoir network files need not be unique.
6. The fluid system must be the same in every network file.
Example:
DESC Multiple Reservoir Case

RUN_UNITS ENGLISH
DATEFORMAT MM/DD/YYYY
REPORT
DEFAULT_UNITS ENGLISH
RESERVOIR resv1 c:\resv1.fcs
RESERVOIR resv2 c:\resv2.fcs
RECURRENT_FILES
SURFACE Network 1 c:\Data\multiple_reservoir.spn
RUNCONTROL c:\Data\control.dat
30 The Case File: Multiple Reservoir Case File R5000.0.1

ASCII Structured Grid Case File
The structured grid Case File is an alternate form for the case file, in which the
PROPERTY_FILES section is replaced by a GRID_FILES section. This section contains only
STRUCTURED_GRID files, or OPTIONS files. In addition, the only valid
INITIALIZATION_FILES would be EQUIL files. This Case file alternative is used to create
ASCII files for sensitivity analysis or as input to various decision management applications. The
parameters are specified as follows:
DESC description
RESTART TIME time filename
REPORT
ALL_KEYWORDS
EOS_DEFAULTS
GRID_FILES
STRUCTURED_GRID filename
OPTIONS filename
EQUIL METHOD is filename
TRACER_INIT METHOD is filename
ROCK_FILES
RELPM METHOD is filename
ROCK METHOD is filename
PVT_FILES
PVT METHOD is filename
WATER METHOD is filename
SEPARATOR METHOD is filename
AQUIFER_FILES
AQUIFER METHOD is filename
RECURRENT_FILES
SURFACE NETWORK is filename
RUNCONTROL filename
WELLS SET is filename
NET_METHOD_FILES
HYD METHOD is filename
VALVE MEHOD is filename
R5000.0.1 The Case File: ASCII Structured Grid Case File 31


where:
GRID_FILES Introduces data input in STRUCTURED_GRID format.
STRUCTURED_GRID Replaces the PROPERTY_FILES section. This section contains

structured grid data using VIP formats
this unit system. The default is ENGLISH).
system. (The default is ENGLISH).
pressures.
pressures.
pressures.
DATEFORMAT Introduces the format used for input of dates. If the date format is
not specified in an input file, this format will be assumed. This also
sets the format used for dates in the output files. The default is
MM/DD/YYYY.

32 The Case File: ASCII Structured Grid Case File R5000.0.1


E.g. 25/1/2001.
RESTART Introduces restart input. This is followed by the TIME for the start
of the restart run, and the name of the restart directory output by the
run from which this case will be restarted. Only present if the case
is a restart. (Default: not a restart run).

files will be (re)compiled. (Default: REPORT.)

initialization. Initial saturations, pressures, etc. will be output to the
.map file. This can be followed by the optional keywords,
functional in the Nexus software, will be allowed. By default,
(Default: no EOS_DEFAULTS file.)
OPTIONS Introduces a file containing options used in the run.
INITIALIZATION_FILES Introduces data input for the following initial properties.
EQUIL Introduces a file containing an equilibration method. This is

a value from 1 to the number of equilibration methods. (Required
for capillary-gravity equilibration).
TRACER_INIT Introduces a file containing a table of tracer concentrations versus

depth. The keyword is followed by the keyword METHOD and a
number which can range from 1 to the number of tracer
initialization methods. The depth ranges in this table do not have to
be the same as those found in the EQUIL method tables.
ROCK_FILES Introduces data input for the following rock properties.

RELPM Introduces a file containing a relative permeability method. This is

ROCK Introduces a file containing a rock compressibility method. This is



from 1 to the number of methods. (Required).

AQUIFER_FILES Introduces data input for the following AQUIFER properties.
AQUIFER Introduces a file containing an AQUIFER method. This is followed

from 1 to the number of methods. (Required when using aquifers).
NOTE: The AQCONNS input (in the PROPERTY_FILES section)
is part of the STRUCTURED_GRID file.

from 1 to the number of networks. (Required).
RUNCONTROL Introduces the file containing run control data. (Required).
WELLS Introduces a file containing a well data. This is followed by the

number of well data files. (Required).



GASLIFT Introduces a file containing an optimal Gaslift method. This is





Units Systems
In This Chapter
• Unit System Rules.
• Units Table.
R5000.0.1 Units Systems: In This Chapter 37

Unit System Rules
1. Five main systems of units will be supported: English oilfield units, metric units using kPa,
metric units using Kg/cm2, metric units using bars, and lab units.
2. In the preprocessor input, a system of units will be defined for the simulator project. By
default, the unit system will be English oilfield units. Unless otherwise indicated, all the
input data for all cases of the project will use the project units. The output of all cases will
use the project units, unless the case units are redefined.
3. The default system of units for each individual case may be redefined to be different than
those of the project. All input data for the case will use these units unless otherwise speci-
fied. All output for the case will use the case units.
4. Individual data files for a case may use any supported units. The range of supported units
will depend on the data type. For all data types, the units defined for the five unit systems
will be supported. In some cases, additional units will be supported. A keyword in the data
file will indicate the units of the input data.
5. All data from the preprocessor will be passed onto the simulator in the system of units chosen
for the case. The suffix of the file used to pass information to the simulator will have a units
indicator.
6. The simulator will use the system of units chosen for the case for its internal calculations.
The simulator will set constants and strings based on the selected input system.
38 Units Systems: Unit System Rules R5000.0.1

Units Table
Variable English oil- metric units metric units metric lab units
field units kPa Kg/cm2 units
bars
Angle degrees degrees degrees degrees degrees
Area ft2 m2 m2 m2 cm2
Compressibility psi-1 kPa-1 Kg/cm2-1 bars-1 psi-1
Critical pressure psia kPaa Kg/cm2a barsa psia
Critical temperature degrees F degrees C degrees C degrees C degrees C

Density lb/ft3 kg/m3 kg/m3 kg/m3 gm/cc
Formation volume RB/STB m3/STM3 m3/STM3 m3/STM3 cc/stcc

factor (oil)
Formation volume RB/MSCF m3/STM3 m3/STM3 m3/STM3 cc/stcc
factor (gas)
Gas-liquid Ratio MSCF/STB SM3/STM3 SM3/STM3 SM3/STM3 stcc/stcc
Gravity gradient psi/ft kPa/m Kg/cm2/m bars/m psi/cm
Length feet meters meters meters cm

Moles lb-moles kg-moles kg-moles kg-moles gm-moles
Molar density lb-moles/ft3 kg-moles/m3 kg-moles/m3 kg-moles/ gm-moles/
m3 cm3
Molar rates lb-moles/day kg-moles/day kg-moles/day kg-moles/ gm-moles/
day hour
Permeability md md md md md
Pressure psia kPa Kg/cm2 bars psia
Reservoir rates RB/Day m3/Day m3/Day m3/Day cc/hour
Saturation fraction fraction fraction fraction fraction

Solution gas-oil ratio MSCF/STB SM3/STM3 SM3/STM3 SM3/STM3 stcc/stcc
Surface rates (liquid) STB/Day STM3/Day STM3/Day STM3/Day stcc/hour
Surface rates (gas) MSCF/Day SM3/Day SM3/Day SM3/Day stcc/hour
Surface volumes (gas) MSCF STM3 STM3 STM3 stcc
R5000.0.1 Units Systems: Units Table 39

Surface volumes (liq- STB STM3 STM3 STM3 stcc

uid)
Temperature degrees F degrees C degrees C degrees C degrees C
Time days days days days hours
Transmissibility ft3-cp/day/psi m3-cp/day/ m3-cp/day/ m3-cp/day/ cc-cp/
kPa bars hour/psi
Kg/cm2
Viscosity cp cp cp cp cp
Volume ft3 m3 m3 m3 cc
40 Units Systems: Units Table R5000.0.1

Keyword Format
In This Chapter
• General rules for keyword input.
• Tabular input
• Tree structured input
• Common keywords used in most keyword input files.
• Using the wildcard character (*) to specify input for multiple named items.
R5000.0.1 Keyword Format: In This Chapter 41

General Input Rules
1. Data entry is free-format. Multiple items on the same line are parsed by the presence of
spaces.
2. All data after (and including) the comment character “!” is ignored by the simulator.
3. All data enclosed by square brackets ([ ... ]), are ignored.
4. Blank lines are ignored
5. Input is generally organized as tables, or in a “tree” structure.
6. Except for tabular input and procedure input, the end of a line is the same as a space. I.e. all
data for a particular option can be input on as many lines as desired. For tables and proce-
dures, lines can be continued using the “&” character.
7. Data items need to be in the first 1000 columns of a line.
8. Keyword input is case insensitive. I.e. you can type a keyword in either upper or lower case.
42 Keyword Format: General Input Rules R5000.0.1

Tabular Input
Usually, the column order for tabular entries is not important. (The input description will indicate
if a column is required to be in a particular position). Data will be read in the order indicated by
the column headers. Each row of data for a table must be on a separate line, except that lines can
be continued using the “&” character. Where noted in the input description, table entries might
have a default value. If so, the default value can be specified using the “#” character. If the table
entries include keywords, then the table will be terminated with a keyword.
Examples:
WELLSPEC well1
CELL KH SKIN RADW RADB DEPTH
18 432.1 0.0 0.5 3.71 #
23l 364.2 0.0 0.5 3.71 5015
468 295.4 0.0 0.5 3.71 #
The # entries indicate that the default value should be used. In this case, the default value is the
depth of the cell.
NODECON
NAME NODEIN NODEOUT IPVT IWAT TYPE METHOD
sink1 node1 sink 2 1 NA NA
con2 node2 node1 3 1 PIPE &
GRADCALC
con3 node3 node2 1 2 PIPEGRAD 0.43
ENDNODECON
Because the table contains keywords, it is terminated with the ENDNODECON keyword. The
second row of the table is continued using the & character.
R5000.0.1 Keyword Format: Tabular Input 43

Tree Structured Input
Tree structured input is used when there are a lot of possible options, but only a few are likely to
be chosen. For this style of input, a primary keyword can be followed by a secondary keyword,
each of which may be followed by a tertiary keyword etc. The description of tree-structured input
lists the keywords in columns, with the primary keyword(s) in the first column, followed by the
secondary keywords in the second column etc. Each keyword can be followed by as many
instances of the next level keyword as desired (if only one of the options can be active, the last
one specified will be used). Any of the keywords may have associated values. Each secondary
keyword might not have the same set of tertiary keywords. This is indicated in the input descrip-
tion by leaving gaps in the secondary keyword column (see the EOSOPTIONS example below).
Examples:
The input to specify the frequency at which output is written has the following structure.
Primary Keywords Secondary Keywords Tertiary Keywords
OUTPUT ARRAYS OFF

RESTART DT dt
WELLS DTTOL dttol
PERFS TIMES
NETWORK TNEXT
WELLPLOT FREQ freq
PERFPLOT MONTHLY
NETPLOT QUARTERLY
FIELDPLOT YEARLY
REGIONS
MAPS
ITERATIONS
RFT
RFTFILE
AQUIFERS
ENDOUTPUT
The following is an example usage.
OUTPUT MAPS MONTHLY

TNEXT
PERFS YEARLY
WELLS FREQ 5
YEARLY
NETWORK OFF
ENDOUTPUT
Here the secondary and tertiary keywords are only input on separate lines to improve readability.
If desired, the entire input could be entered on one line, or each keyword could be entered on a
separate line.
44 Keyword Format: Tree Structured Input R5000.0.1

The options used by the EOS flash are specified as follows.
Primary Secondary Tertiary Quaternary

EOSOPTIONS PR or PR_OLD or SRK or RK
ZGIBBS
MCO2 mco2
TOL tol
TRANSITION NEIGHBOR or
TEST or
ALL
TRANS_TEST GIBBS or
INCRP PHASEFRAC frac or
PSAT
FUGERR fugerr
PHASEID PREVIOUS or
DENSITY THRESHOLD threshold or
FLASH or
OIL or
GAS or
PSAT
INIT_SINGLE OIL or
GAS or
V
ALPHAMU alphamu
VSHIFTOFF
STKATZOFF
The following is an example usage.
EOSOPTIONS PR
TRANS_TEST INCRP PHASEFRAC 0.1
PHASE1D FLASH
In this case, at most one tertiary keyword should follow a secondary keyword. If more than one is
input, the last one input will be used.
R5000.0.1 Keyword Format: Tree Structured Input 45

Common Input Data
All input files can have the following keywords:
DESC description
ENGLISH or METRIC or METKG/CM2 or METBAR or LAB
Files which have temperature input can also have the following keywords:
KELVIN or RANKINE or FAHR or CELSIUS
Files which have TIME entries (i.e have data that depend on time), can also have the following
keywords:
where
pressures.
pressures.
pressures.
KELVIN Specifies that the temperatures are specified in degrees kelvin.
RANKINE Specifies that the temperatures are specified in degrees rankine.
FAHR Specifies that the temperatures are specified in degrees fahrenheit.

Default for ENGLISH units.
CELSIUS Specifies that the temperatures are specified in degrees celsius.

Default for METRIC, METBAR or LAB units.
DATEFORMAT Introduces the format used for input of dates.
46 Keyword Format: Common Input Data R5000.0.1

MM/DD/YYYY Specifies that dates will be entered in the mm/dd/yyyy format, e.g.
1/25/2001
DD/MM/YYYY Specifies that dates will be entered in the dd/mm/yyyy format, e.g.
25/1/2001
Examples:
DESC This is the first line of a description

DESC This is the second line of a description
METRIC
DATEFORMAT DD/MM/YYYY
R5000.0.1 Keyword Format: Common Input Data 47

Common Input Data
In the surface network section, an asterisk (*) may be used as a wildcard character when specify-
ing names network components. In this case, all names which match the specified name, except
for an arbitrary string of characters in the location of the *, are selected for input, with the excep-
tion of names containing a %. There may be more than one * specified in the input name. For
example, if the input required the name of a well, then P* would select all wells whose names
began with P. Wells may not contain the character %, so the restriction that the names not contain
a % does not apply.
Similarly, if the input required the name of a connection, then P* would select all connections
whose name began with P, but which did not contain a %. A connection name will only contain a
% if it is automatically created by the program. In particular, well bottom hole connections are
named well_name%bh. This is the reason for the restriction that the name not contain an %, oth-
erwise the input would always select the well, and its bottom hole connection. If it is desired to
use the * to specify multiple bottom hole connections, then the % must be part of the string input.
For example, P*%* would select all connections starting with P and containing %, so this would
select the bottom hole connections for all wells starting with P.
Example:
CONSTRAINTS
P* QOSMAX 1000
ENDCONSTRAINTS
Sets a maximum surface oil rate of 1000 for all well connections whose name starts with P.
48 Keyword Format: Common Input Data R5000.0.1

Use of the Wildcard Character (*)
In the surface network section, an asterisk (*)may be used as a wildcard character when specify-
ing names network components. In this case, all names which match the specified name, except
for an arbitrary string of characters in the location of the *, are selected for input, with the excep-
tion of names containing a %. There may be more than one * specified in the input name. For
example, if the input required the name of a well, then P* would select all wells whose names
began with P. Wells may not contain the character %, so the restriction that the names not contain
a % does not apply.
Similarly, if the input required the name of a connection, then P* would select all connections
whose name began with P, but which did not contain a %. A connection name will only contain a
% if it is automatically created by the program. In particular, well bottom hole connections are
named well_name%bh. This is the reason for the restriction that the name not contain an %, oth-
erwise the input would always select the well, and its bottom hole connection. If it is desired to
use the * to specify multiple bottom hole connections, then the % must be part of the string input.
For example, P*%* would select all connections starting with P and containing %, so this would
select the bottom hole connections for all wells starting with P.
Example:
CONSTRAINTS
P* QOSMAX 1000
ENDCONSTRAINTS
Sets a maximum surface oil rate of 1000 for all well connections whose name starts with P.
R5000.0.1 Keyword Format: Use of the Wildcard Character (*) 49

50 Keyword Format: Use of the Wildcard Character (*) R5000.0.1

Output Files
In This Chapter
• A description of the contents of the output files produced by the Nexus® software.
R5000.0.1 Output Files: In This Chapter 51

Output Files
The output files produced by the Nexus software are named using the case name followed by a
suffix -- e.g., case_name.out. The exception is the vdb file, which uses the study name. By
default, the study name is the same as the case name. The main output files and their content are
described below.
.rpt This is the ascii output file produced when the keywords are parsed
and the data checked for consistency. It contains a report of the
data read, error and warning messages.
.err This is an ascii output file produced when the keywords are parsed
and the data checked for consistency. In the event that the data is
generating large numbers of warning messages, the first few
warnings are output to the .rpt file, and the remainder to the .err file.
.out This is the main ascii output file from the simulator. It contains
field summary data, region reports, recurrent data input reports,
well, perforation, network, etc., reports (if requested by the
OUTPUT keyword in the runcontrol file). The field summary
output is also written to the .sum file.
.sum This file reports the field production/injection summary (one line
per time step). The field production/injection is obtained by
summing the production/injection from all the perforations in each
well, and flashing them through the separator assigned to each well.
The rates and cumulatives calculated in this manner should agree
with the sum of the well rates and cumulatives, but may be different
than what is ultimately produced/injected at the network sinks/
sources.
.netsum This file reports the field production/injection summary (one line
per time step), obtained by summing the production/injection at the
network sinks/source. This file is only present if NETSUM is
specified in the run control file. The volumes reported in the
.netsum file may be different from those reported in the .sum file
for various reasons, which include mixing of fluids in the network,
separation or gas plant nodes in the network and different pvt/
separator methods used in different parts of the network.
.tssum This file reports a information on how the time step size was
determined by the simulator.
.vdb Database file containing map and plot data. Map and plot data is
output in this format unless a different format is specified. (See the
Run Control, Output File Formats section). The plot data written is
52 Output Files: Output Files R5000.0.1

controlled by the OUTPUT keyword, and the map data by the

MAPOUT keyword. (See the Run Control section.)
.plt This file contains plot data if the plot format is specified as
PLOTFORM or PLOTBINARY. The plot data written is controlled
by the OUTPUT keyword in the Run Control file.
.map This file contains map data. The file is created if the map format is
specified as MAPFORM or MAPBINARY. The map data written
is controlled by the MAPOUT keyword in the Run Control file.
Note: The Nexus software will always write map data. Where it
gets written depends on what the user specifies (MAPFORM,
MAPBINARY or MAPVDB) and whether the vdb with the init
class data already exists. If the user specifies MAPVDB, but a .vdb
with the INIT class does not already exist, the map data will be
written to a binary .map file.
.max This file contains a summary of maximum changes and damping

for each Newton iteration. Refer to “Description of Max File
Entries” on page 54 for an explanation of the entries in this report.
.maxijk This file contains a summary of maximum changes and damping

for each Newton iteration, with i, j, k locations of grid blocks. This
is only available if structured map data is input.
runlog This file contains a log of events that have occurred in the network,
such as wells shutting in or reopening, actions taken as a result of
procedures etc.
.wrn This file contains warning messages that may be output by the
simulator.
.rft This file contains any rft output that has been requested.
.dbg This file contains debug output, if debug output has been requested.
See the DEBUG keyword in the Run Control section.
.hyd This file contains hydraulics output if requested. See the OUTPUT
HYDRAULICS keywords in the Run Control Section.
.ss_field, .ss_network, .ss_regions, .ss_targets, .ss_wells
These files contain output from the simulator. Output is requested

using the keyword in the Run Control Section.
R5000.0.1 Output Files: Output Files 53

Description of Max File Entries
The .max file contains a summary of the maximum changes and damping that occurred for each
Newton iteration. The columns of data in the .max file are described below.
The Damp/Rpt Reason column has the reason why the time step was damped or repeated. It
could be a grid-based damp, such as:
DPMAX Maximum pressure change in a grid block

DVMAX Maximum volume error in a grid block
DSMAX Maximum saturation change in a grid block
DZMAX Maximum mass or mole fraction change in a grid block
MOBILITY Maximum mobility change in a grid block
Kr or Kr Incr Damping on relative permeability changes
Gas.Sat Damping on emerging gas saturation
Sat < 0 Damping when the linearized saturation tries to decrease
below 0
Sat > 1 Damping when the linearized saturation tries to increase above
1
FlowRev Damping because of flow reversals
Sgc Damping when crossing critical gas saturation
SgcPerf Damping when crossing critical gas saturation in a perforated
grid block
VolErr This is not a damp. It just indicates that the reason the time step
has not yet converged is that the volume error is too large
These damps can be controlled by the input described in the Run Control File under “Maximum
Allowed Changes in Implicit Iterations” on page 238.
There may also be damping caused by the network. These are:
Target A target was violated

Hyd An inactive hydraulics equation was violated. (The hydraulics
equation was not imposed implicitly because some other equa-
tion, such as a rate constraint, was more violated at the start of
the Newton).
54 Output Files: Description of Max File Entries R5000.0.1

Cell_DP Maximum pressure change in a perforated grid block

Perf_Rev Flow reversal in a perforation
Conn_Rev Flow reversal in a connection
Perf_Open Perforation was opened to flow
Well_Rev Flow reversal in a well
Qmax An inactive maximum rate constraint was violated. The maxi-
mum rate constraint was not imposed implicitly, because some
other equation, such as a hydraulics equation, was more vio-
lated at the start of the Newton).
NetDpMax Maximum pressure change at a network node.
Net_Pmax An inactive maximum pressure constraint was violated. The
maximum pressure constraint was not imposed implicitly,
because some other equation, such as a maximum rate con-
straint, was more violated at the start of the Newton).
Net_Pmin An inactive minimum pressure constraint was violated. The
minimum pressure constraint was not imposed implicitly,
because some other equation, such as a maximum rate con-
straint, was more violated at the start of the Newton).
The reason for a time step repeat could be:
Solver Solver failed

DCMAX Too large a change in composition
Neg Mass Too large a negative mass
Pmax Maximum pressure exceeded
Pmin Minimum pressure exceeded
CFL_Limit CFL limit violated
BadNet Too many newtons failed because of bad network solutions,
like Conn_Rev etc
For other columns containing the following:
Network Itns The total number of Newton iterations taken to solve the
Total network at fixed reservoir conditions
R5000.0.1 Output Files: Description of Max File Entries 55

Network Itns The number of network Newton iterations that required

Bad adjustment to the solution because of conditions such as flow
reversals. (This is for the network solve at fixed reservoir
conditions).
Solver Itns Gbl The number of global solver iterations, for the combined
reservoir network linear solve. This will be 0 for Impes grids,
which only have pressure solves.
Solver Itns Press The number of solver iterations for the pressure solve in
Implicit runs.
DCmax The maximum mass/mole fraction change for the time step.
RVOLmax Maximum volume error in any grid block. This is the primary
convergence criteria.
RMBEmax Maximum material balance error, plus linearized perforation
equation error.
Dpmax Maximum pressure change in any grid block.
DVmax Maximum linearized volume change in any grid block
DSmax Maximum linearized saturation change in any grid block
DZmax Maximum linearized mass or mole fraction change in any grid
block
DMmax Maximum mass change in any grid block
In the above table, the term “linearized” (like the maximum linearized saturation change) means
that it is computed from the derivatives of that quantity. In the Nexus software, the primary vari-
ables are mass and pressure, so the change in any other variable is a linear approximation. For
example, the saturation for the k+1 newton iteration is linearized as
k k+1 k k+1
S k + 1 = S k + Σ i = 1, nc ( dS ⁄ dm i ) × dm i + ( dS ⁄ dP ) × dP
Until the masses are updated and a flash is done, only this linear approximation of the new satura-
tion is available. So the damping, which is done before the masses are updated, damps according
to the linearized changes. This sometimes causes apparently large maximum saturation changes,
which simply means that the saturations are very non-linear in that grid block.
56 Output Files: Description of Max File Entries R5000.0.1

Array Data
In This Chapter
• Array Data Input.
• Array Data Requirements
Array data files are included in a case in the PROPERTY_FILES, INITIALIZATION_FILES,

ROCK_ARRAY_FILES or RECURRENT_FILES sections. Arrays are used to input grid proper-
ties (e.g. Pore Volume), method assignments (e.g. IRELPM which determines which relative per-
meability method is used by each cell), grid assignments (IGRID assigns each cell to a particular
grid), initial values (e.g. Pressure), endpoints for relative permeability scaling (e.g. Swro), and
region assignments.
For example, pore volumes are input as follows:
PROPERTY_FILES
PV set 1 filename1
PV set 2 filename2
....
Arrays can be input in pieces (sets). If more than one set is used, the cells in each set should cor-
respond for every array input.
R5000.0.1 Array Data: In This Chapter 57

Array Data Input
Array data is input as a series of numbers, each number corresponding to the array value for each
grid block. There must either be as many numbers as grid blocks, or a single number representing
a constant value for the array. For grid block corner locations (XCORNER, YCORNER and
ZCORNER), there should be as many values as the total number of grid block corners.
The Nexus® software has a default minimum and maximum value that it will check for each type
of array. This can be overridden by inputting the keyword MIN or MAX, followed by a number.
Note:
The number of grid blocks is determined from the pore volume array. If the pore volume array is
in binary format, then it has been compressed to remove zero pore volume grid blocks, and any
formatted array input should not include values for zero pore volume grid blocks. The pore vol-
ume array can not contain a single number unless there is only one grid block in the simulation.
Each array is input in a separate file, and the type of array is identified in the Case File.
Note:
If the units of the input data are different from the default input units, then the units should be
specified using one of the keywords ENGLISH, METRIC, METKG/CM2, METBAR or LAB. In
addition, for temperatures, the temperature unit can be specified using one of the keywords
KELVIN, RANKINE, FAHR or CELSIUS.
Note:
A value of -1 for any of the relative permeability array elements instructs the simulator to fill the
given cell with the applicable table value. This may be convenient if not all cells need scaling.
Also, using a value of -1 will be considered the same as if the table value had been entered as an
array element. This may be relevant under certain circumstances when inconsistent data has been
entered.
Examples:
Example 1
5.61 4.32 9.55 6.25 3.1
Example 2
MIN -1.0
4*2.75 -1.0 5.0
58 Array Data: Array Data Input R5000.0.1

Example 3 (Not valid for a Pore Volume array)
2.75
R5000.0.1 Array Data: Array Data Input 59

Array Data Requirements
Array Purpose Required Default Units

ACTIVE Designating active cells No All cells None
with non-
zero PV are
active
API Initial API gravity If no gravity and None None
fluid is API
COMPOSITION Composition of a tracer No None None
attached to a compo-
nent by cell.
COMPR Rock Compressibility If using COMPR Not used psi-1, kPa-1,
of grid block method for rock
kg/cm2-1 , bar-1,
compressibility
psi-1
CSORM Residual oil saturation No None Fraction
due to compositional
effects
DEPTH Cell depths Always None ft, m, m, m, cm
FVEGO Application of VEGO No 1 = fracture integer
by cell. (Dual only) 0 = matrix
FVEWO Application of VEWO 0 or integer
by cell. (Dual only)
GLOBALCELL Global Cell Index used No Natural None
for connections and Cell Order
well cells
IEQUIL Assigning Equilibration No 1 None
Methods
IGRID Assigning cells to grids No 1 None
IPVT Assigning PVT meth- No 1 None
ods
IREGION Assigning cells to No No regions None
regions
IRELPM Assigning relative per- No 1 None
meability methods
IROCK Assigning Rock Com- No 1 None
pressibility methods
60 Array Data: Array Data Requirements R5000.0.1

IWATER Assigning Water PVT No 1 None

methods
IXFER Assigning transfer No (dual only) 1 None
function methods
KPMULT Rock permeability mul- No Not used psi-1, kPa-1,
tiplier
kg/cm2-1 , bar-1,
psi-1
KRW_SWRO, Relative permeability No Endpoints Fraction
KRW_SWU, endpoints of relative
KRG_SGRO, permeabil-
KRG_SGU, ity methods
KRO_SWL,
KRO_SWR,
KRO_SGL,
KRO_SGR,
KRW_SGL,
KRW_SGR,
KRG_SGRW
KX Cell X-direction perme- If J-Functions used None md, md, md, md,
ability md
KY Cell Y-direction perme- If J-Functions used None md, md, md, md,
ability md
LZ Matrix block size in X Matrix only. Dual None ft (m)
direction only.
MOLEFRAC- Initial mole fractions For an EOS run if None Fraction
TION no equilibration
NCORNER Number of grid block For INTSAT equili- All grid None
corners bration if grid blocks have
blocks do not all 8 corners
have 8 corners
POROSITY Cell porosity If J-Functions used None Fraction
PRESSURE Initial cell pressure If no equilibration None psi, kPa, Kg/cm2,
bar, psi
PSAT Initial saturation pres- If no equilibration, Initial cell psi, kPa, Kg/cm2,
sure and not an EOS run pressure bar, psi
PV Cell pore volumes Always None ft3, m3, m3, m3, cc
SG Initial gas saturation If no equilibration, 0 Fraction
and not an EOS run
SW Initial water saturation If no equilibration None Fraction
R5000.0.1 Array Data: Array Data Requirements 61

SWL, SWR, Relative permeability No Endpoints Fraction

SWRO, SWU; endpoints of relative
SGL, SGR, permeabil-
SGRO, SGU; ity methods
SGRW; SWLPC,
SGLPC
TEMPERA- Reservoir temperature For variable tem- Tempera- F, C, C, C, C
TURE perature in an EOS ture of EOS
run method
XCORNER X location of grid block None ft, m, m, m, cm
corners
XINDEX X direction index for If overriding array None None
overrides or transmissibility
data
YCORNER Y location of grid block None ft, m, m, m, cm
corners
YINDEX Y direction index for If overriding array None None
data
ZCORNER Z location (depth) of For INTSAT equili- None ft, m, m, m, cm
grid block corners bration option
ZINDEX Z direction index for If overriding array None None
data
62 Array Data: Array Data Requirements R5000.0.1

Connection Data
In This Chapter
• Connection Data (CONNECTIONS) Input.
Connection data files are included in a case in the PROPERTY_FILES section as follows:
PROPERTY_FILES
CONNECTIONS set 1 filename1
CONNECTIONS set 2 filename2
....
Multiple sets of connections can be input. All connections in all the sets will be used in the simu-
lation run.
R5000.0.1 Connection Data: In This Chapter 63

Connection Data Input
CELL1 CELL2 TRANS (DIR) FLT) (IRELPM1) (IRELPM2) (IXFER)

cell1(1) cell2(1) trans(1) (dir(1)) (flt(1)) (isat1(1)) (isat2(1)) (ixfer(1))
cell1(2) cell2(2) trans(2) (dir(2)) (flt(2)) (isat1(2)) (isat2(2)) (ixfer(2))
. . . . . . . .
. . . . . . . .
cell1(ncon) cell2(ncon) trans(ncon(dir(ncon))(flt(ncon))(isat1(ncon))(isat2(ncon))(ixfer(ncon))
where:
CELL1 The column heading keyword for the global index of the first cell in
the connection.
CELL2 The column heading keyword for the global index of the second
cell in the connection.
TRANS The column heading keyword for the transmissibility between cell1
and cell2. (ft3-cp/day/pai, m3-cp/day/kPa, m3-cp/day/bar, cc-cp/
day/psi)
DIR The optional column heading keyword for the direction of the
connection. The entries in this column should be either X, Y, Z or
NA.
Default: NA
FLT The optional column heading keyword for an identifying name for
the connection, or the keywords STD or NONSTD. Typically, this
would be the name of a fault, and all connections which span the
fault would be given the same name. If STD or NA is entered, the
connection is a local connection. I.e. not a fault connection. If
NONSTD is entered, the connection is a fault connection, but the
fault is not named. Fault names can be used to simplify
modification of fault properties, such as fault threshold pressure.
(See the section on Pressure Threshold for Limiting Grid Block to
Grid Block Flow).
Default: STD
IRELPM1 The optional column heading keyword for specifying the relative
permeability method number for the Cell1 side of a connection.
Usually these data are only entered if there is variation over the
connections of cells. The IRELPM array data are still entered (or
defaulted to method 1) for initialization and default perforation
64 Connection Data: Connection Data Input R5000.0.1

method assignment. If used, the IRELPM2 column heading

keyword must also be used.
Default: All connections of a given node use the same relative

permeability method number assigned by IRELPM array.
IRELPM2 The optional column heading keyword for specifying the relative
permeability method number for the Cell2 side of a connection.
Usually these data are only entered if there is variation over the
connections of cells. The IRELPM array data are still entered (or
defaulted to method 1) for initialization and default perforation
method assignment. If used, the IRELPM1 column heading
keyword must also be used.
Default: All connections of a given node use the same relative

permeability method number assigned by IRELPM array.
IXFER The column heading keyword specifying the transfer method to be

used for this connection. This header is only appropriate in dual-
porosity cases and only for inter-porosity connection files.
ncon The number of connections.
Notes:
Columns DIR and FLT can not be the first column in the table.
Example:
CELL1 CELL2 TRANS

1 2 10.0
2 3 10.0
R5000.0.1 Connection Data: Connection Data Input 65

66 Connection Data: Connection Data Input R5000.0.1

Pseudo Transfer Function
In This Chapter
The pseudo XFER option is specified using one or more of the following keywords:
PSEUDO (GO_ONLY) (WO_ONLY) (NCOL ncol) (NSMTAB nsmtab) (INTSW) (PRINT)
where:
PSEUDO Activates the PSEUDO option calculations for both gas-oil and
water-oil tables. If this keyword is absent, the XFER method will
default to simply using the applicable rock curves unchanged.
GO_ONLY Specifies that the special PSEUDO tables will only be built and
used for gas-oil application. Without this keyword the default is to
build and perform calculations for gas-oil and water-oil application.
WO_ONLY Specifies that the special PSEUDO tables will only be built and
used for water-oil application. Without this keyword the default is
to build and perform calculations for gas-oil and water-oil
application.
NCOL Keyword introducing the number of stacked columns which will be

used during the construction of PSEUDO tables. The default is 1
column. The advantage of increasing this number should be to
smooth out the constructed Pc curves at the small, one-time,
expense of more computations.
NSMTAB Number of saturation entries in the pseudo-capillary tables.

Default is 10.
INTSW Integrate water-oil capillary pressure over matrix blocks above the
water-oil contact. Default SW = SWC above water-oil contact.
Gas-oil capillary pressure is always integrated above the gas-oil
contact.
PRINT Print to the standard output file (.out) the internally generated
pseudo-capillary pressures that are used in the matrix-fracture flow.
Default is not the print the pseudo-capillary pressure tables.
R5000.0.1 Pseudo Transfer Function: In This Chapter 67

Note
1. The LZ array and ZCORNER data must be entered for the PSEUDO option.
68 Pseudo Transfer Function: In This Chapter R5000.0.1

Aquifer Connection Data
In This Chapter
• Aquifer connection Data (AQCONNS) Input.
Aquifer connection data files are included in a case in the PROPERTY_FILES section as follows:
PROPERTY_FILES
AQCONNS set 1 filename1
AQCONNS set 2 filename2
....
Multiple sets of aquifer connections can be input. All aquifer connections in all the sets will be
used in the simulation run.
R5000.0.1 Aquifer Connection Data: In This Chapter 69

Aquifer Connection Data (AQCONNS) Input
CELL AQUIFER STRENGTH_FACTOR

cell (1) aquifer(1) strength_factor(1)
cell(2) aquifer(2) strength_factor (2)
. . .
. . .
cell(ncon) aquifer(ncon) strength_factor (ncon)
where:
CELL The column heading keyword for the global index of the cell
making connection with aquifer listed in the AQUIFER column.
AQUIFER The column heading keyword for the aquifer making connection
with cell listed in the CELL column.
STRENGTH_FACTOR The column heading keyword for the relative strength factor for
this connection between cell and aquifer (dimensionless).
ncon The number of connections.
Example:
CELL AQUIFER STRENGTH_FACTOR

901 1 4
902 1 1
903 1 1
904 1 1
Note:
A cell-to-aquifer association may be listed more than once. The effect is cumulative.
Strength_factors are normalized when applied by the simulator.
70 Aquifer Connection Data: Aquifer Connection Data (AQCONNS) Input R5000.0.1

Options Data
In This Chapter
• Standard temperature and pressure
• Reservoir temperatures
• Region Fluids In Place Method
• Region Names, Separator and PVT methods
• Compositional Residual Oil (CSORM)
• Structured Grid Data for Creation of Structured VDB Files
• Assigning Grids to Processes
The OPTIONS data file is included in a case in the PROPERTY_FILES section as follows:
PROPERTY_FILES
OPTIONS filename
R5000.0.1 Options Data: In This Chapter 71

Standard Temperature and Pressure
The standard temperature and pressure can be overwritten.
Temperature
TSTD ALL tstd
ADDITIONAL
where:
TSTD Indicates that the standard temperature is to be entered.
ALL Option only applies to the master case of a multireservoir case.

Specifies that the standard temperature of all reservoirs will be set
to tstd.
ADDITIONAL Option only applies to the master case of a multireservoir case.

Specifies that only the nodes added to the network for the master
case will have their standard temperatures set to tstd.
tstd The standard temperature (degrees F, degrees C, degrees C, degrees

C). The default values are 60 degrees F or 15 degrees C.
72 Options Data: Temperature Standard Temperature and Pressure R5000.0.1

Pressure
PSTD ALL pstd
ADDITIONAL
where:
PSTD Indicates that the standard pressure is to be entered.
ALL Option only applies to the master case of a multireservoir case.

Specifies that the standard pressure of all reservoirs will be set to
pstd.
ADDITIONAL Option only applies to the master case of a multireservoir case.

Specifies that only the nodes added to the network for the master
case will have their standard pressures set to pstd.
pstd The standard pressure (psia, kpa, Kg/cm2, bars, psia). The default
values are 14.65 psia, or 101.325 kPa or 1.03321 kg/cm2 or 1.01325
bars.
Notes:
The simulator uses the rules described below to synchronize last stage separator conditions and
standard conditions.
Technically, standard volumes reported as products of a separator are volumes calculated at stan-
dard conditions. The separator calculation uses the moles of the components collected at the out-
let streams and calculates the volume that these moles occupy at standard conditions. A
discrepancy can arise if the last stage of the separator is not at standard conditions because the
phase split of the components will not be necessarily at equilibrium at the standard conditions
reported. Also, an additional calculation of the molar oil density is required at standard condi-
tions if the last stage conditions are not at standard conditions.
The simulator attempts to reconcile small differences in standard conditions and last stage separa-
tor conditions to avoid calculation discrepancy and to save calculation time. If the discrepancy
between conditions is large, the simulator assumes that the user did not want to set the last condi-
tion at standard conditions. However, it issues a warning because of the potential calculation dis-
crepancy.
The following set of rules applies to both the standard temperature and standard pressure.
• If a standard condition of the reservoir has been explicitly set in the options file, then that
standard condition is honored for that reservoir. (Note: Use of TSTD or PSTD keywords for
the individual reservoirs will set the standard conditions for that reservoir. The standard
condition can also be set by the use of TSTD ALL or PSTD ALL in the master case options
file.). The last stage condition of each separator belonging to that reservoir is checked
R5000.0.1 Options Data: Pressure Standard Temperature and Pressure 73

against the standard condition. If the difference is within a tolerance, the last stage condition
of the separator is reset to the standard condition. If the difference is greater than the
tolerance, a warning message is issued.
• If the standard condition of the reservoir has not been set, then the condition of the last stage
of each separator in the reservoir is checked and the following action taken:
• If the conditions are all identical, and the difference between the common condition and
the default standard condition is within a tolerance, then the standard condition is reset to
the common last stage separator condition.
• If the conditions are all identical but the difference is not within the tolerance of the
default standard condition, a warning is issued.
• If the conditions are not all identical, then the last stage condition of each separator is
checked against the default standard condition and the following action taken:
• If the difference is within the tolerance, the last condition of the separator is reset to
the default standard condition.
• If the difference is not within the tolerance, a warning is issued.
• If for the master case, the standard condition has not been explicitly set with the keyword in
the options file, and the standard condition of all the reservoirs is the same, then the standard
condition of the master case is set to the common value.
In the above rules, the following set of tolerances applies:
• For standard temperature, and field units, the tolerance is 1.0 degrees F.
• For standard temperature and all other unit systems, the tolerance is 0.5 degrees C.
• For standard pressure and field or lab units, the tolerance is 1.0 psia.
• For standard pressure and metric units, the possible tolerances are 7.0d0 kPa, 0.07 kg/cm2,
and 0.07 bars.
• The default standard temperature is 60 degrees F in field units, and 15 degrees C for all other
unit systems.
• The default standard pressures are 14.696 psia for field and lab units, and 101.325 kPa or
1.03321 kg/cm2 or 1.01325 bars for the various metric unit systems.
74 Options Data: Pressure Standard Temperature and Pressure R5000.0.1

Reservoir Temperature
This keyword sets the reservoir temperature.
RES_TEMP res_temp
Where:
RES_TEMP Indicates that the reservoir temperature is to be read in. The

reservoir temperature can be overridden by the temperatures
provided in equilibrium region input. However, the reservoir
temperature does supersede any temperatures provided in the EOS
data files. (degrees F., degrees C., degrees C., degrees C, degrees C)
R5000.0.1 Options Data: Pressure Reservoir Temperature 75

Region Fluids In Place Method
The method used to calculate the fluids in place for each region group is specified as follows.
REGBLK
Region_grp_name1
Region_grp_name2
…..
ENDREGBLK
where:
REGBLK Introduces the region groups which will have their fluids in place
determined by flashing each grid block individually. For region
groups which are not input, the fluids in place will be determined
by summing the mass of each component for all grid blocks in each
region, then flashing the result of the sum.
Region_grp_name The name of a region group. The region assignments for this region
group should be specified in the PROPERTY_FILES (or
RECURRENT_FILES) section of the case file, using the IREGION
keyword. The default region (which contains all grid blocks), can
be specified using the keyword FIELD.
ENDREGBLK Terminates REGBLK data.
Notes:
1. The flash uses the separator specified by the REGDATA data. If no REGDATA data is input,
the default is separator method 1.
2. A default region group, which contains all grid blocks, is automatically created and named
FIELD.
Example:
REGBLK
Region1
ENDREGBLK
76 Options Data: Pressure Region Fluids In Place Method R5000.0.1

Region Names, Separator and PVT Methods (REGDATA)
Regions are assigned names, separator, PVT and water PVT methods as follows.
REGDATA reg_grp_name
NUMBER (NAME) (IBAT) (IPVT) (IWAT)
n (regname) (ibat) (ipvt) (iwat)
. . . . .
ENDREGDATA
where:
REGDATA Keyword indicating the start of the REGNAME table.
Reg_grp_name A region group name, specified by IREGION input in the case file.
NUMBER Column heading keyword indicating that the entries in this location
on the following lines specify the region number (the cell
assignment in the IREGION input).
NAME Column heading keyword indicating that the entries in this location
on the following lines specify a name for the region. Default: Same
as number
IBAT A number referring to a separator method. This should correspond

to a method number specified for a SEPARATOR method in the
PVT_FILES section of the case file. The IBAT specification only
affects EOS simulations. Default: IBAT 1.
IPVT A number referring to a PVT method. This should correspond to a

method number specified for a PVT method in the PVT_FILES
section of the case file. The IPVT method only affects black oil
simulations. Default: PVT method used by first grid block in the
region.
IWAT A number referring to a water PVT method. This should

correspond to a method number specified for a WATER method in
the PVT_FILES section of the case file. The IWAT method affects
both EOS simulations and black oil simulations. Default: Water
PVT method used by first grid block in the region
ENDREGDATA Alpha label indicating the end of the REGDATA data.
Notes:
1. Region names are used in reporting, and to identify parts of the reservoir for production and
injection targeting. See TARGET in the surface network section.
R5000.0.1 Options Data: Pressure Region Names, Separator and PVT Methods (REGDATA) 77
2. IBAT is used to determine region fluids in place for EOS runs and for black oil and API runs
when separator data is input.
3. IBAT, IPVT and IWAT input is used by the network targeting logic to calculate fluid vol-
umes. See TARGET in the surface network section.
4. A default region group, which contains all grid blocks, is automatically created and named
FIELD.
5. The values of NAME, IBAT, IPVT and IWAT for region number 1 of the FIELD region
group are used for calculations involving the whole field.
Example:
REGDATA
NAME NUMBER IBAT
Reg1 1 2
Reg2 2 2
ENDREGDATA
78 Options Data: Pressure Region Names, Separator and PVT Methods (REGDATA) R5000.0.1
Compositional Residual Oil
Using this option sets aside a portion of the residual oil that cannot be recovered in compositional
processes. Without this option, it is possible for all the oil in a gridblock to be recovered through
vaporization and/or displacement.
Reasons to invoke this option include:
• The existence of oil that exists in non-accessible pore space.
• Gravity override occurring so that some of the oil in thick gridblocks cannot be contacted.
• Poor sweep efficiency due to high mobility ratios.
The oil that is isolated is not allowed to participate in equilibrium calculations. However it is
allowed to compress or expand with pressure.
This option can be used with EOS, black oil, and API fluid models.
The option is activated with the following keywords:
CSORM (MATRIX) csorm

(FRACTURE)
(VUG)
(ALL)
Where:
CSORM The keyword to introduce residual oil saturation.
MATRIX Optional keyword that indicates the CSORM value only applies to
the matrix porosity system of this reservoir.
FRACTURE Optional keyword that indicates the CSORM value only applies to
the fracture porosity system of this reservoir.
VUG Optional keyword that indicates the CSORM value only applies to
the vug porosity system of this reservoir.
csorm The residual oil saturation.
Note:
If no optional keywords follow the CSORM keyword, the numerical value of csorm will apply to
all porosity systems of this reservoir. Therefore, not using any optional keyword is equivalent to
using the ALL optional keyword.
R5000.0.1 Options Data: Pressure Compositional Residual Oil 79

Structured Grid Data
If the simulation grid(s) used to create the Nexus® simulation model were constructed in a struc-
tured (I,J,K) format, the Nexus software may be instructed to write results maps corresponding to
the original structured grid(s) instead of the unstructured Nexus grid. This allows the map results
to be viewed in mapping packages such as 3DView with each grid in a structured NX*NY*NZ
format as opposed to the standard NB*1*1 format which exists in an unstructured Nexus grid.
The structured grids are defined as follows:
STRUCTURED_MAPS
NAME NUMBER NX NY NZ
name(1) number(1) nx(1) ny(1) nz(1)
name(2) number(2) nx(2) ny(2) nz(2)
. . . . .
. . . . .
name(ngrid) number(ngrid)nx(ngrid) ny(ngrid) nz(ngrid)
ENDSTRUCTURED_MAPS
where:
STRUCTURED_MAPS Introduces the structured grid data
NAME The column heading keyword for the name of each grid
NUMBER The column heading for the number of each grid. This number
corresponds to the computational grid assignments input in the
IGRID file(s)
NX The column heading for the NX dimension of each grid
NY The column heading for the NY dimension of each grid
NZ The column heading for the NZ dimension of each grid
ENDSTRUCTURED_MAPS Terminates the structured grid data
Notes:
1. Each set of grid NAME, NUMBER, and dimensions must correspond to grids already
defined in a VDB file or in a map file containing physical grid description data (CORP, etc.).
If the above data does not exactly correspond to the existing grid data the map results will not
be loaded into the VDB file. The existing VDB file must not be packed.
2. The 1st grid should always be named ‘ROOT’ and numbered ‘1’.
3. This data must be entered at the beginning of the model simulation and cannot be changed.
80 Options Data: Pressure Structured Grid Data R5000.0.1

All map results will be either structured for the entire model run or unstructured for the entire
model run.
4. This structured Grid option should not be used for decision management input files. Refer
instead to “ASCII Structured Grid Case File” on page 31.
Examples:
1. The structured model consists of a single grid with dimensions 20x15x10
STRUCTURED_MAPS
ROOT 1 20 15 10
ENDSTRUCTURED_MAPS
2. The structured model consists of a main 30x30x10 grid with 2 locally refined grids of dimen-
sions 50x50x20 and 25x25x30 respectively
STRUCTURED_MAPS
ROOT 1 30 30 10
LGR1 2 50 50 20
LGR2 3 25 25 30
ENDSTRUCTURED_MAPS
R5000.0.1 Options Data: Pressure Structured Grid Data 81

Assigning Grids to Processes
The Nexus software automatically assigns grids to processes for parallel runs (except for dual
cases), but the automatic assignment can be overridden by manually assigning grids to processes
as follows:
GRIDTOPROC
GRID PROCESS (RESERVOIR)
Grid(1) proc(1) (resv(1))
Grid(2) proc(2) (resv(2))
….
Grid(n) proc(n) (resv(n))
ENDGRIDTOPROC
Or for Dual Cases:
GRIDTOPROC
GRID PROCESS (RESERVOIR)PORTYPE
Grid(1) proc(1) (resv(1)) portype(1)
….
Grid(n) proc(n) (resv(n)) portype(n)
Grid(n) proc(n) (resv(n)) portype(n)
ENDGRIDTOPROC
where:
GRIDTOPROC Introduces the grid to process assignment data.
GRID The column heading keyword for the grid number corresponding to
the grid assignment specified by the IGRID array in the case file.
PROCESS The process to which the grid will be assigned. Processes are
numbered from 1 to the total number of processes specified for the
run.
Default: 1
RESERVOIR Column heading keyword. The entries in this column should be the
name of a reservoir. This column should only be present for
multifield cases.
82 Options Data: Pressure Assigning Grids to Processes R5000.0.1

PORTYPE Column heading keyword. The entries in this column should be the
porosity types. Legal porosity types are MATRIX and FRAC. All
associated grids must be assigned to the same processor.
Associated grids are grids of different porosity type which are
connected (share the same physical space). The same number of
grids may not be present in all porosity types since some reservoirs
may not be dual or more grids may be defined for one porosity type
than another.
ENDGRIDTOPROC Terminates the grid to process assignment data
Notes:
1. For good parallel performance, at least two grids should be assigned to each process, and the
grids belonging to the same process should not have connections to the same grid on any
other process. For example, if grid 1 on process 2 has connections to grid 2 on process 1, then
grid 2 on process 2 should not have any connections to grid 2 on process 1.
Note that a linear decomposition satisfies this criterion, as shown in the following figure.
In a single field run, the RESERVOIR column should not be present. In multifield runs, the
resv(1) … should correspond to the reservoir names for each reservoir referenced in the mul-
tifield case file. Grid(1) … are the grid assignments given in the IGRID array for each reser-
voir. Proc(1) .. are the process that each grid will be assigned to. The input must be
complete, so all grids in every reservoir must be assigned to a process. In the multifield
OPTIONS file, the GRIDTOPROC table is the only data that is valid. Any other data in this
file will be flagged as a fatal error. For multifield runs, if there is a GRIDTOPROC table
present in the individual reservoir cases, it will be ignored.
2. The input must be complete, so all grids in every reservoir must be assigned to a process.
3. In the multifield OPTIONS file, the GRIDTOPROC table is the only data that is valid. Any
other data in this file will be flagged as a fatal error. For multifield runs, if there is a GRID-
TOPROC table present in the individual reservoir cases, it will be ignored.
Examples:
GRIDTOPROC
R5000.0.1 Options Data: Pressure Assigning Grids to Processes 83

GRID PROCESS RESERVOIR

1 1 plutonio
2 1 plutonio
3 2 plutonio
4 2 plutonio
1 3 galio
2 3 galio
3 4 galio
4 4 galio
ENDGRIDTOPROC
GRIDTOPROC
GRID PROCESS RESERVOIR PORTYPE
1 1 westtexdualMATRIX
1 1 westtexdualFRAC
2 2 westtexdualMATRIX
2 2 westtexdualFRAC
3 3 westtex MATRIX
4 3 westtex MATRIX
ENDGRIDTOPROC
84 Options Data: Pressure Assigning Grids to Processes R5000.0.1

Water Properties
In This Chapter
• Water Properties.
All the data for a water PVT method is input in a single file. Water PVT files are included in a
case in the PVT_FILES section as follows:
PVT_FILES
WATER method 1 filename1
WATER method 2 filename2
....
The water PVT method to be used by each cell is specified in the PROPERTY_FILES section of
the case file using the IWATER keyword. By default, all cells use method 1.
There are two main categories of input: without hydrocarbon solubility (the most common case)
or with limited hydrocarbon solubility. All the methods in a case must belong to the same cate-
gory. That is, all methods must allow hydrocarbon solubility or not allow hydrocarbon solubility.
Hydrocarbon solubility is only allowed in conjunction with EOS hydrocarbon PVT methods.
R5000.0.1 Water Properties: In This Chapter 85

Water Properties (without Hydrocarbon Solubility)
(TEMP temperature1)
(SALINITY salinity1)
DENW denw
CW cw
BW bw
VISW visw
PREF pref
(CVW) (cvw)
DENW denw
CW cw
BW bw
VISW visw
PREF pref
(CVW) (cvw)
(TEMP temperature2)
DENW denw
CW cw
BW bw
VISW visw
PREF pref
(CVW) (cvw)
DENW denw
CW cw
BW bw
VISW visw
PREF pref
(CVW) (cvw)
(SALINITY salinity)
DENW denw
CW cw
BW bw
86 Water Properties: Water Properties (without Hydrocarbon Solubility) R5000.0.1

VISW visw
PREF pref
where:
TEMP Specifies the temperature. (degrees F., degrees C., degrees C.,
degrees C., degrees C.).
SALINITY Specifies the water salinity. Units are at the discretion of the user as
long as they are consistent
DENW Specifies the water density at standard conditions (lbm/ft3, kg/m3,

kg/m3, kg/m3, gm/cc).
CW Specifies the water compressibility (1/psia, 1/kPa, 1/(Kg/cm2),

1/bars, 1/psia).
BW Specifies the water formation volume factor at reservoir

temperature and pressure pref (rvb/stb, m3/m3, m3/m3, m3/m3, cc/
cc).
VISW Specifies the water viscosity at reservoir conditions (cp, cp, cp, cp,
cp).
PREF Specifies the reference pressure (psia, kPa, Kg/cm2, bars, psia) for
BW.
1- dμ
⎛ ----- w⎞
CVW Specifies the water viscosity compressibility ⎝ μ ---------
- .
⎠
w dp
By default, water viscosity is constant. (1/psia, 1/kPa, 1/(Kg/cm2),

1/bars, 1/psia). Optional.
Notes:
1. Only one set of data is required. Temperature and salinity are optional inputs for a single set.
2. TEMP and SALINITY keywords are optional and may be repeated as many times as neces-
sary. For each temperature, there can be multiple salinity inputs, but the same salinities must
be input for each temperature.
3. TEMP keywords can be used without SALINITY keywords and vice versa.
4. DENW can be different for different salinities, but should have the same value for data input
at the same densities and different temperatures. Only the first density input for a salinity
value will be used.
5. For solubility tables, data for each soluble component must exist at each combination of tem-
perature and salinity input.
R5000.0.1 Water Properties: Water Properties (without Hydrocarbon Solubility) 87

6. Only one PREF keyword is allowed.
Example:
DENW 62.4 CW 3.4 VISW 0.7 BW 1.04
88 Water Properties: Water Properties (without Hydrocarbon Solubility) R5000.0.1

Water Properties (with Hydrocarbon Solubility)
Limited solubility of hydrocarbon components is allowed. One to all of the hydrocarbon compo-
nents are allowed to dissolve in the aqueous phase. Solubility should be limited to components
which exist as gases at atmospheric conditions, such as CO2, N2, H2S, and hydrocarbons lighter
than pentane. The combined solubility of all non-water components should be small. This
method becomes less accurate as the solubility percentage increases past a few percentage points.
(TEMP temperature1)
DENW denw
SOLUBILITY
COMP comp1
(UNITS MASS
STD)
PSAT RSW BW CW VISW (CVW)
psat1 rsw1 bw1 cw1 visw1 (cvw1)
… … … … … …
psatn rswn bwn cwn viswn (cvwn)
SOLUBILITY
COMP comp2
(UNITS MASS
STD)
… … … … … …
DENW denw
SOLUBILITY
COMP comp1
(UNITS MASS
STD)
… … … … … …
SOLUBILITY
COMP comp2
R5000.0.1 Water Properties: Water Properties (with Hydrocarbon Solubility) 89

(UNITS MASS
STD)
… … … … … …
(TEMP temperature2)
SOLUBILITY
COMP comp1
(UNITS MASS
STD)
… … … … … …
SOLUBILITY
COMP comp2
(UNITS MASS
STD)
… … … … … …
SOLUBILITY
COMP comp1
(UNITS MASS
STD)
… … … … … …
SOLUBILITY
COMP comp2
90 Water Properties: Water Properties (with Hydrocarbon Solubility) R5000.0.1

(UNITS MASS
STD)
… … … … … …
where:
TEMP Specifies the temperature. (degrees F., degrees C., degrees C.,
degrees C., degrees C.).
SALINITY Specifies the water salinity. Units are at the discretion of the user as
long as they are consistent.
SOLUBILITY Signals the start of the solubility data table.
COMP The name of the component that is soluble within the aqueous
phase.
UNITS Keyword specifies that the unit system of the gas solubility will be
set by the next keyword. (Optional)
MASS Specifies that unit of input for gas solubility is mass of component/
mass of 100 units of water component. (Default)
STD Specifies that unit of input for gas solubility is standard volume of
component/standard volume of water phase. (SCF/STB, m3/m3,
m3/m3, m3/m3, cm3/cm3)
PSAT Column header for saturation pressure data (psia, kPa, bars, kg/
cm2, psia).
RSW Column header for gas solubility data, using the units input by the
UNITS keyword.
BW Column header for the water formation volume factor (SCF/STB,

m3/m3, m3/m3, m3/m3, cm3/cm3).
CW Column header for water compressibility (1/psia, 1/kPa, 1/bars, 1/

(kg/m3), 1/psia)
VISW Column header for the water viscosity(cp, cp, cp, cp, cp).
1 dμ w
CVW Column header for water viscosity compressibility ⎛ ------ ---------- ⎞ .
⎝ μ w dp ⎠
By default, water viscosity is does not vary with pressure. (1/psia,
1/kPa, 1/(Kg/cm2), 1/bars, 1/psia). Optional.
R5000.0.1 Water Properties: Water Properties (with Hydrocarbon Solubility) 91

Notes
1. Only one set of data is required. Temperature and salinity are optional inputs for a single set.
2. TEMP and SALINITY keywords are optional and may be repeated as many times as neces-
sary. For each temperature, there can be multiple salinity inputs, but the same salinities must
be input for each temperature.
3. TEMP keywords can be used without SALINITY keywords and vice versa.
4. DENW can be different for different salinities, but should have the same value for data input
at the same densities and different temperatures. Only the first density input for a salinity
value will be used.
5. For solubility tables, data for each soluble component must exist at each combination of tem-
perature and salinity input.
92 Water Properties: Water Properties (with Hydrocarbon Solubility) R5000.0.1

Hydrocarbon PVT Properties
In This Chapter
• Black Oil Fluid Systems

• Water Oil Fluid Systems
• Gas Water Fluid Systems
• Saturated Oil and Gas Table
• Oil Table
• Gas Table
• Undersaturated Oil Table
• Undersaturated Gas Table
• Negative Compressibility Check
• Consistency of Gas/Oil and Oil/Gas Ratio Data
• API Tables
• Temperature-dependent Black Oil Tables
• Examples of Black Oil Fluid System Input
• EOS PVT Data
• EOS Component Property Data
• EOS Component Coefficients for Ideal Gas Cp
• Default EOS Component Property Data
• Default EOS Component Coefficients for Ideal Gas Cp
• EOS Binary Interaction Data
• Examples of EOS Fluid System Input
All the data for a hydrocarbon PVT method is input in a single file. Hydrocarbon PVT files are
included in a case in the PVT_FILES section as follows:
PVT_FILES
PVT method 1 filename1
PVT method 2 filename2
....
The hydrocarbon PVT method to be used by each cell is specified in the PROPERTY_FILES sec-
R5000.0.1 Hydrocarbon PVT Properties: In This Chapter 93

tion of the case file using the IPVT keyword. By default, all cells use method 1.
Currently , if the API method is used for any reservoir or the network, then all reservoirs and the
network must use the API method. In addition to this restriction, methods can be mixed only if
they use the same number of components.
94 Hydrocarbon PVT Properties: In This Chapter R5000.0.1

Black Oil Fluid Systems
BLACKOIL DENOIL denoil or API api

DENGAS dengas or SPECG specg
where:
BLACKOIL Introduces data for a black oil fluid system. A BLACKOIL fluid
system will require the following tables. Either a SATURATED
table, or an OIL and a GAS table, and at least one UNSATOIL
table. If Rv data is input in the SATURATED or GAS tables, then at
least one UNSATGAS table is also required.
DENOIL Specifies the oil density at standard conditions (lbm/ft3, kg/m3, kg/
m3, kg/m3, gm/cc).
DENGAS Specifies the gas density at standard conditions (lbm/ft3, kg/m3,

API Specifies the API gravity of the oil (API units).
SPECG Specifies the gas specific gravity (dimensionless).
Examples:
BLACKOIL API 30.0 SPECG 0.6
R5000.0.1 Hydrocarbon PVT Properties: Black Oil Fluid Systems 95

Water Oil Fluid Systems
WATEROIL DENOIL denoil or API api

(GOR gor)
(DENGAS dengas) or (SPECG specg)
where:
WATEROIL Introduces data for a dead oil fluid system. A WATEROIL fluid
system requires one OIL table.
m3, kg/m3, gm/cc).
API Specifies the API gravity of the oil (API units).
GOR Gas/Oil ratio at surface conditions (MSCF/STB, m3/m3, m3/m3,

m3/m3, cc/cc).
Default: 0

kg/m3, kg/m3, cc/cc). DENGAS or SPECG are only required if a
non-zero GOR is input.
SPECG Specifies the gas specific gravity (dimensionless). DENGAS or

SPECG are only required if a non-zero GOR is input.
Examples:
WATEROIL API 25.0
96 Hydrocarbon PVT Properties: Water Oil Fluid Systems R5000.0.1

Gas Water Fluid Systems
GASWATER DENGAS dengas or SPECG specg

(OGR ogr)
(DENOIL denoil) or (API api)
where:
GASWATER Introduces data for a dry gas fluid system. A GASWATER fluid
system requires one GAS table.

SPECG Specifies the gas specific gravity (dimensionless).
OGR Oil/Gas ratio at surface conditions (STB/MSCF, m3/m3, m3/m3,

m3/m3, cc/cc).
Default: 0
m3, kg/m3, gm/cc). DENOIL or API are only required if a non-zero
OGR is input.
API Specifies the API gravity of the oil (API units). DENOIL or API are
only required if a non-zero OGR is input.
Examples:
GASWATER SPECG 0.6
R5000.0.1 Hydrocarbon PVT Properties: Gas Water Fluid Systems 97

Saturated Oil and Gas Table
The table is specified as follows:
SATURATED
PRES BO VO RS BG VG (RV) (CV CP ZG)
p1 bo1 vo1 rs1 bg1 vg1 (rv1) (cv1 cp1 zg1)
p2 bo2 vo2 rs2 bg2 vg2 (rv2) (cv2 cp2 zg2)
. . . . . . . . . .
. . . . . . . . . .
pn bon von rsn bgn vgn (rvn) (cvn cpn zgn)
where:
SATURATED Introduces the table of saturated oil and gas PVT data. There
should be only one saturated table. Alternatively, the saturated oil
and gas tables can be input separately using the OIL and GAS table
formats.
PRES The column heading keyword for pressure (psia, kPa, Kg/cm2 ,
bars, psia). The pressures should either monotonically increase, or
monotonically decrease in the table.
BO The column heading keyword for the oil formation volume factor
(rvb/stb, rm3/sm3, rm3/sm3, rm3/sm3, rcc/scc).
BG The column heading keyword for the gas formation volume factor
(rvb/mcf, rm3/sm3, rm3/sm3, rm3/sm3, rcc/scc).
RS The column heading keyword for the solution gas-oil ratio (mcf/
stb, sm3/sm3, sm3/sm3, sm3/sm3, scc/scc).
VO The column heading keyword for the oil viscosity (cp, cp, cp, cp,
cp).
VG The column heading keyword for the gas viscosity (cp, cp, cp, cp,
cp).
RV The column heading keyword for the oil-gas ratio for oil in the
vapor phase (stb/mcf, sm3/sm3, sm3/sm3, sm3/sm3, scc/scc). If this
column is present, and the values entered are non-zero, then at least
one UNSATGAS table is required.
CV The column heading keyword for the gas heat capacity at constant
volume (Btu/lb-F, KJ/Kg-K, KJ/Kg-K, KJ/Kg-K, J/g-K)
98 Hydrocarbon PVT Properties: Saturated Oil and Gas Table R5000.0.1

CP The column heading keyword for the gas heat capacity at constant
pressure (Btu/lb-F, KJ/Kg-K, KJ/Kg-K, KJ/Kg-K, J/g-K) (Note:
1 KJ/Kg-K = 1 J/g-K)
ZG The column heading keyword for the gas compressibility ratio.

(Dimensionless)
Example:
SATURATED
PRES BO BG RS VO VG
14.7 1.05 225.0 0.005 3.93 0.0105
115. 1.08 25.0 0.045 2.78 0.0109
2515 1.25 1.089 0.505 0.99 0.0193
3515 1.33 0.787 0.69 0.79 0.0193
Notes
1. The compressor model requires input of all three of Cp, Cv and Zg.
2. The input value of Zg must be < 3.0.
R5000.0.1 Hydrocarbon PVT Properties: Saturated Oil and Gas Table 99

Oil Table
OIL
PRES BO VO (RS)
p1 bo1 vo1 (rs1)
p2 bo2 vo2 (rs2)
. . . .
. . . .
pn bon von (rsn)
where:
OIL Introduces the table of saturated oil PVT data.
PRES The column heading keyword for pressure (psia, kPa, Kg/cm2, bars,
psia). The pressures should either monotonically increase, or
cp).
RS The column heading keyword for the solution gas-oil ratio (mcf/
stb, sm3/sm3, sm3/sm3, sm3/sm3, scc/scc). For a WATEROIL fluid
system, this column should not be present.
Notes:
• When used in conjunction with the BLACKOIL option, the data in the OIL table reflects the
affect of an increasing amount of gas dissolved in the oil (i.e., saturated oil) as the pressure
increases. Therefore, the RS column will be present with non-zero values. Also, with
increasing pressure, BO will increase, and VO will decrease.
• When used in conjunction with the WATEROIL option, the data in the OIL table reflects the
affect of a constant amount of gas dissolved in the oil (i.e. undersaturated oil). Therefore, the
RS column is not used. Also, with increasing pressure, BO will decrease, and VO will
increase.
100 Hydrocarbon PVT Properties: Oil Table R5000.0.1

Example:
OIL
PRES BO RS VO
14.7 1.05 0.005 3.93
115. 1.08 0.045 2.78
2515 1.25 0.505 0.99
3515 1.33 0.69 0.79
R5000.0.1 Hydrocarbon PVT Properties: Oil Table 101

Gas Table
GAS
PRES BG VG (RV) (CV CP ZG)
p1 bg1 vg1 (rv1) (cv1 cp1 zg1)
p2 bg2 vg2 (rv2) (cv2 cp2 zg2)
. . . . . . .
. . . . . . .
pn bgn vgn (rvn) (cvn cpn zgn)
where
GAS Introduces the table of saturated gas PVT data.
cp).
vapor phase (stb/mcf, sm3/sm3, sm3/sm3, sm3/sm3, scc/scc). If this
column is present, and the values entered are non-zero, then at least
one UNSATGAS table is required.

(Dimensionless)
Example:
GAS
PRES BG VG
14.7 225.0 0.0105
102 Hydrocarbon PVT Properties: Gas Table R5000.0.1

115. 25.0 0.0109

2515 1.089 0.0193
3515 0.787 0.0193
Notes
1. The compressor model requires input of all three of Cp, Cv, and Zg.
2. The input value of Zg must be < 3.0.
R5000.0.1 Hydrocarbon PVT Properties: Gas Table 103

Undersaturated Oil Table
UNSATOIL PSAT psat or RSSAT rs

PRES BO VO
or DP or BOFAC or VOFAC
p1 bo1 vo1
p2 bo2 vo2
. . .
. . .
pn bon von
where:
UNSATOIL Introduces the table of undersaturated oil PVT data.
PSAT The pressure (psia, kPa, Kg/cm2, bars, psia) where the
undersaturated table intersects the saturated table. If there are
multiple UNSATOIL tables, PSAT must be monotonically
increasing or decreasing.
RSSAT The solution gas/oil ratio(MSCF/STB, sm3/sm3, sm3/sm3, sm3/sm3,

scc/scc) where the undersaturated oil table intersects the saturated
oil table. If there are multiple UNSATOIL tables, RSSAT must be
monotonically increasing or decreasing.
monotonically decrease in the table. All pressures in the
UNSATOIL table should be greater than psat, or the pressure
corresponding to rssat.
DP The column heading keyword for values of pressure (psia, kPa,

Kg/cm2, bars, psia) relative to the corresponding saturation
pressure. The values must monotonically increase or
monotonically decrease.
cp).
BOFAC The column heading keyword for values of oil formation volume
factor relative to the volume factor at the saturation pressure.
[bo(p)/bo(psat)] (dimensionless).
104 Hydrocarbon PVT Properties: Undersaturated Oil Table R5000.0.1

VOFAC The column heading keyword for values of oil viscosity factor
relative to the viscosity at the saturation pressure. [vo(p)/vo(psat)]
(dimensionless).
Example:
UNSATOIL PSAT 2000.0

PRES BO VO
2515 1.25 0.99
3515 1.24 0.98
R5000.0.1 Hydrocarbon PVT Properties: Undersaturated Oil Table 105

Undersaturated Gas Table
UNSATGAS PRES pres

RV BG VG (CV CP ZG)
or BGFAC or VGFAC
rv1 bg1 vg1 (cv1 cp1 zg1)
rv 2 bg2 vg2 (cv2 cp2 zg2)
. . . . . .
. . . . . .
rv n bgn vgn (cvn cpn zgn)
where
UNSATGAS Introduces the table of undersaturated gas PVT data.
PRES The pressure (psia, kPa, Kg/cm2, bars, psia) for the table. If there
are multiple UNSATGAS tables, PRES must be monotically
increasing or decreasing.
vapor phase (stb/mcf, sm3/sm3, sm3/sm3, sm3/sm3, scc/scc). The
values of Rv should be monotonically increasing or decreasing.
All the values of Rv should be less than the value of Rv at pressure
psat in the OIL or SATURATED table.
cp).
BGFAC The column heading keyword for values of gas formation volume
factor relative to the volume factor at the saturation pressure.
[bg(p)/bg(pres)] (dimensionless).
VGFAC The column heading keyword for values of gas viscosity factor
relative to the viscosity at the saturation pressure. [vg(p)/vg(pres)]
(dimensionless).
106 Hydrocarbon PVT Properties: Undersaturated Gas Table R5000.0.1


(Dimensionless)
Example:
UNSATGAS PRES 3515.0

RV BG VG
0.0 0.787 0.0193
Notes
1. The compressor model requires input of all three of Cp, Cv and Zg.
2. 2.The input value of Zg must be < 3.0.
R5000.0.1 Hydrocarbon PVT Properties: Undersaturated Gas Table 107

Negative Compressibility Check
Black oil and volatile oil PVT is checked for negative compressibility. If negative compressibility
is encountered over the range of pressures input, a FATAL error will be generated, unless the fol-
lowing keyword is input:
NOCHK
where:
NOCHK Specifies that Negative Compressibility messages will be warnings.
Notes:
For black oil, the negative compressibility check is:
∂R s ∂B o
B g ⎛ --------⎞ – ⎛ ---------⎞ > 0
⎝ dp ⎠ ⎝ dp ⎠
Which states that for an increase in pressure, the reduction in total volume due to gas going into
solution must be greater than the increase due to oil swelling.
For volative oil, the negative compressibility checks are:
∂R s ∂B o
( B g – R v B o ) -------- – ( 1 – R s R v ) --------- > 0
dp dp
∂R v ∂B g
( B o – R s B g ) --------- – ( 1 – R s R v ) --------- > 0
dp dp
Example:
NOCHK
108 Hydrocarbon PVT Properties: Negative Compressibility Check R5000.0.1

Consistency of Gas/Oil and Oil/Gas Ratio Data
The solution gas/oil ratio data ( Rs ) that can be entered in the saturated table or the oil table must
be consistent with the solution oil/gas ratio data ( Rv ) that can be entered in the saturated table or
the gas table.
Specifically, the mass ratio of gas component to oil component for the saturated oil phase must be
less than the mass ratio for the saturated gas phase at the same pressure.
The mass gas-oil ratio for the saturated liquid phase is calculated by the equation:
Rs ρ gs
GORmass ,liquid = Cliquid
ρos
where
GORmass ,liquid = the gas//oil mass ratio in the liquid phase
Rs = the volumetric solution gas/oil ratio.
ρos = the surface oil density
ρgs = the surface oil density in the same units as ρos
Cliquid = a unit systems dependent conversion constant.
The mass oil-gas ratio for the saturated vapor phase is calculated by the equation:
Rv ρos
OGRmass ,vapor = Cvapor
ρ gs
where
OGRmass ,vapor = the oil/gass mass ratio in the vapor phase
Rv = the volumetric solution oil/gas ratio.
Cvapor = a unit systems dependent conversion constant.
R5000.0.1 Hydrocarbon PVT Properties: Consistency of Gas/Oil and Oil/Gas Ratio Data 109
The values of the constants for different unit systems are tabulated below:
Units
Rs Units Rv Units
System Cliquid Cvapor
Field MSCF/STB STB/MSCF 5.61458e-3 178.1077

Metric (kPa, Sm3/Sm3 Sm3/Sm3 1.0 1.0
bars, or kg/
cm2
Lab Scc/Scc Scc/Scc 1.0 1.0
The consistency check is that at each pressure,
1
GORmass ,liquid < OGRmass ,vapor
110 Hydrocarbon PVT Properties: Consistency of Gas/Oil and Oil/Gas Ratio Data R5000.0.1
API Tables
Black oil tables can be grouped together to form a set of API tables. Each table is associated with
an API value. Black oil properties will be determined by interpolation using standard density as
the parameter, between sets of black oil tables.
At least two PVT methods must be in the list, and each PVT method must be a black oil method,
and none of the API numbers (or equivalently standard oil densities) of the tables can be the same.
The Nexus® software assumes that when more than one black oil methods are input as a single
PVT method, then this group of tables comprise an API method
R5000.0.1 Hydrocarbon PVT Properties: API Tables 111

APIGROUP
Alternatively, an API method can be created by the use of the APIGROUP keyword. The user
lists provides a list of the PVT methods which comprise the tables within a grouping of API
tables.
At least two PVT methods must be in the list, and each PVT method must be a black oil method,
and none of the API numbers (or equivalently standard oil densities) of the tables can be the same.
This method is not recommended because it creates a dependency on the method numbering of
the black oil tables, which makes it difficult to reuse the same PVT data for multiple cases.
APIGROUP
First_number .... Last_Number
APIDEFAULT
(api_default_number)
where:
First_number The first PVT method number in the list of API. Numbers can be
in any order.
Last_number The last PVT method number in the list of API.
APIDEFAULT Used to set the table used for gas property lookup if no oil
components exist at a point in space and time. If the
APIDEFAULT table is not specified, the first table number in the
list is used.
api_default_number The table number used as the default for gas phase lookup
properties.
Example:
APIGROUP
4 1 2 6 ! Group together PVT methods 4, 1, 2, and 6 into one APIGROUP.
112 Hydrocarbon PVT Properties: APIGROUP R5000.0.1

Temperature-Dependent Black Oil Tables
Water-oil, gas-water, black-oil, and API tables can be temperature-dependent. This is accom-
plished by placing a TEMP keyword and temperature value in front of each set of tables.
For gas-water systems, a TEMP entry would appear in front of each GASWATER keyword.
However, the parameters for each GASWATER keyword must be the same. That is, the surface
densities and solution oil-gas ratios must be constant for this group of tables.
For water-oil systems, a TEMP entry would appear in front of each WATEROIL keyword. How-
ever, the parameters for each WATEROIL keyword must be the same. That is, the surface densi-
ties and solution oil-gas ratios must be constant for this group of tables.
For black-oil systems, a TEMP entry would appear in front of each BLACKOIL keyword. How-
ever, the parameters for each BLACKOIL keyword must be the same. That is, the surface densi-
ties and solution oil-gas ratios must be constant for this group of tables.
For API systems, a TEMP entry would be placed in front of a group of BLACKOIL table entries.
That is, several BLACKOIL tables can be grouped under one temperature, Also, the set of
BLACKOIL table entries for each temperature input must have the same set of API values.
Temperature-dependent input for API systems cannot be used with the use of the APIGROUP
keyword to create API groups.
R5000.0.1 Hydrocarbon PVT Properties: Temperature-Dependent Black Oil Tables 113

Examples of Black Oil Fluid System Input
Example 1. Black oil fluid system.

SATURATED
PRES BO BG RS VO VG
14.7 1.05 225.0 0.005 3.93 0.0105
115. 1.08 25.0 0.045 2.78 0.0109
2515 1.25 1.089 0.505 0.99 0.0193
3515 1.33 0.787 0.69 0.79 0.0193

PRES BO VO
2515 1.25 0.99
3515 1.24 0.98
An equivalent way of inputting this data is:

OIL
PRES BO RS VO
14.7 1.05 0.005 3.93
115. 1.08 0.045 2.78
2515 1.25 0.505 0.99
3515 1.33 0.69 0.79
GAS
PRES BG VG
14.7 225.0 0.0105
115. 25.0 0.0109
2515 1.089 0.0193
3515 0.787 0.0193

PRES BO VO
2515 1.25 0.99
3515 1.24 0.98
114 Hydrocarbon PVT Properties: Examples of Black Oil Fluid System Input R5000.0.1
Example 2. Water oil system.
WATEROIL API 28.5

OIL
PRES BO VO
2515 1.38 0.90
3515 1.35 0.95
4015 1.33 0.99
Example 3. Volatile oil system.

SATURATED
PRES BO BG RS VO VG RV
14.7 1.05 225.0 0.005 3.93 0.0105 0.043
115. 1.08 25.0 0.045 2.78 0.0109 0.039
2515 1.25 1.089 0.505 0.99 0.0193 0.041
3515 1.33 0.787 0.69 0.79 0.0193 0.045

PRES BO VO
2515 1.25 0.99
3515 1.24 0.98
UNSATGAS PRES 3515.0

RV BG VG
0.0 0.787 0.0193
Example 4. Gas Water System
GASWATER SPECG 0.75
GAS
PRES BG VG
14.7 225.0 0.0105
115. 25.0 0.0109
2515 1.089 0.0193
3515 0.787 0.0193
R5000.0.1 Hydrocarbon PVT Properties: Examples of Black Oil Fluid System Input 115
EOS PVT Data
The following parameters are required:
EOS NHC nhc

COMPONENTS cptname1 cptname2 ..... cptnamenhc
TEMP temp
The following parameters are optional:
LABEL label
EOSOPTIONS PR or PR_OLD or SRK or RK
ZGIBBS
ZGIBBS_OFF
FLASH_GIBBS_ON
FLASH_GIBBS_OFF
MCO2 mco2
TOL tol
TOLSS tolss
TOLCRIT tolcrit
TRANSITION NEIGHBOR or
TEST or
DELTA (TCRIT tcrit)(TDELZ tdelz) (TDELP tdelp) or
B (TDELZ tdelz) (TDELP tdelp)or
ALL
TRANS_TEST GIBBS or
PSAT
FUGERR fugerr
PHASEID PREVIOUS or
FLASH or
OIL or
GAS or
PSAT
ALPHAMU alphamu
VSHIFTOFF
STKATZOFF
LBC1 lbc1
LBC2 lbc2
LBC3 lbc3
LBC4 lbc4
LBC5 lbc5
VISPE
VISKJ
INDEX COEFF
116 Hydrocarbon PVT Properties: EOS PVT Data R5000.0.1

1 viskj1
2 viskj2
3 viskj3
4 viskj4
5 viskj5
6 viskj6
7 viskj7
ENDVISKJ
VISKK
INDEX COEFF
1 viskj1
2 viskj2
3 viskj3
4 viskj4
5 viskj5
6 viskj6
7 viskj7
ENDVISKK
VISKKIJ
COMP1 COMP2 COEFF
comp1 comp2 coeff
… … …
… … …
ENDVISKKIJ
The above keywords are described in greater detail below:
R5000.0.1 Hydrocarbon PVT Properties: EOS PVT Data 117

System Definition Data

EOS Introduces data for a compositional fluid system.
NHC Specifies the number of hydrocarbon components. NHC must be

entered before the component names.
COMPONENTS Specifies the component names. This keyword should be followed

by nhc component names, starting with an alpha character.
TEMP Specifies the default temperature for the EOS method. If this is not
overridden by other temperature input, this temperature will be
used for fluid properties.
LABEL Specifies a label for this method. Must start with an alpha
character. This must be present if the EOS properties will be
modified with time.

Units Selection
ENGLISH Specifies that the input is in English oilfield units.
METRIC Specifies that the input is in metric units, with pressures in kPa.
pressures.
METBAR Specifies that the input is in metric units, with pressures in bars.
LAB Specifies that the input is in laboratory units.
KELVIN Specifies that the temperature is specified in degrees kelvin.
RANKINE Specifies that the temperatures is specified in degrees rankine.
FAHR Specifies that the temperatures is specified in degrees fahrenheit.

Default for ENGLISH units.
CELSIUS Specifies that the temperatures is specified in degrees celsius.

Default for METRIC, METBAR or LAB units.

Optional Parameters
EOSOPTIONS Introduces various options used in EOS calculations.
PR Modified Peng-Robinson method (Default).
PR_OLD Original Peng-Robinson method.
SRK Soave-Redlich-Kwong method.
RK Redlich-Kwong method.
ZGIBBS Enables ZGIBBS option. If this option is enabled, during the Z-

factor selection process, the Z-factor that provides the lowest Gibbs
free energy for the phase is selected. Normally, this option is off,
and the lowest Z-factor is selected for the liquid phase, and the
largest Z-factor is selected for the vapor phase.
ZGIBBS_OFF Turns the ZGIBBS option off if it was previously turned on.
FLASH_GIBBS_ON Specifies that the flash calculation is performed by Gibbs

minimization. By default, the flash calculation is performed by a
successive substitution algorithm followed by a Newton algorithm.
FLASH_GIBBS_OFF Specifies that the flash calculation is performed by the default

method of a successive substitution algorithm followed by a
Newton algorithm.
VISPE Turns on Pedersen viscosity in an equation of state.
The Pedersen viscosities can be modified by adjusting any of three

sets of data: j coefficients, k coefficients, and interaction
coefficients.
The j coefficients are input in the VISKJ table. There are seven
different coefficients. The table form is as follows, with the default
values shown.
VISKJ
INDEX COEFF
1 -10.35060586
2 17.571599671
3 -3019.3918656
4 188.73011594
5 0.042903609488
6 145.29023444

7 6127.6818706
ENDVISKJ
The table form of the k coefficients is as follows with the default

values shown.
VISKK
INDEX COEFF
1 9.74602
2 18.0834
3 4126.66
4 44.6055
5 0.976544
6 81.8134
7 15649.9
ENDVISKK
The interaction parameters are input by specifying the component

pair names and the value. The default values for all interaction
coefficients is zero. Most values should be zero, so it is only
necessary to input the few that are non-zero. The interaction
coefficients are symmetrical, and specifying the component pair
names in either order will give the same result. The interaction
coefficient of a component with itself must be zero.
For example,
VISKKIJ
COMP1 COMP2 COEFF
CH4 C10 0.01

CO2 PSEUDO1 -0.025
ENDVISKKIJ
VIP® Keyword Conversion Notes
The VISKK table corresponds to the VISK table in the VIP

software.
VISKKIJ corresponds to the VISKJ table in the VIP software.
The VIP software does not allow input of the VISKJ data as defined
in the Nexus software.

MCO2 Identifies component number that is the CO2 component. Required

because CO2 is often treated differently than other components,
especially in terms of water solubility. (Default 0)
TOL Flash tolerance. The flash calculation converges when:
FUGERR
⎛ 1 – f------
2
v, i⎞
Σ ⎝ f ⎠
- < TOL
i=1 l, i
(Default 1.0e-4)
TOLSS The flash tolerance used for the successive substitution flash. The
successive substitution flash is performed as a precursor to the
Newton flash, because it is more robust. However, it becomes very
slow as the solution is approached, so the flash switches to a
Newton flash. The flash tolerance for the successive substitution
flash should be greater than that of the Newton flash.
(Default 1.0e-2)
TOLCRIT In two phase gridblocks, the phase equilibrium solution is first

calculated by using information from the outer iteration Newton.
This is equivalent to performing a single Newton flash iteration.
When this technique is used, the phase derivatives are not updated.
The full two phase flash is performed if the following condition is
met.
n
Σ ( x i – y i ) 2 < TOLCRIT
i=1
(Default 0.005)
FUGERR Number of components to use for fugacity equality convergence

criteria. This may be useful if resolution of the fugacity equality of
trace components is slowing the convergence of the flash
calculations.(Default nhc)
TRANS_TEST Selects the method used to detect the transition from a single-phase
state to a two-phase state. The user may select GIBBS or INCRP
(default) or PSAT.

GIBBS. Phase transition (1 hydrocarbon phase to 2 hydrocarbon

phases) determined by Gibbs stability test. A second phase
emerges if its introduction results in the lowering of the Gibbs free
energy of the system. (Use instead of INCRP or PSAT)
INCRP. Phase transition (1 hydrocarbon phase to 2 hydrocarbon

phases) determined by increasing pressure method. In this method,
a series of 8 flashes are performed, starting at 90% of the grid-block
pressure, and increasing to the grid-block pressure. At each stage,
the K-values are extrapolated to the next higher pressure. It is
possible that a second loop of increasing pressures calculations are
performed. The second loop consists of a sequence of 5 flashes,
starting at 99.93% of the grid-block pressure and increasing to the
grid-block pressure. The PHASEFRAC keyword described below
controls the criteria for entering the second loop. (Default, can be
overridden by GIBBS or PSAT keyword.)
PHASEFRAC. The second increasing loop is entered if the first

loop fails on the last increment and the mole phase fraction is
within PHASEFRAC of the phase boundary. For example, if a
liquid fails to evolve a vapor phase on the last step, and the vapor
mole fraction is less than PHASEFRAC at the second last step, then
the second loop would be entered. The second loop uses much
smaller pressure increments so as to not mistakenly miss the
emergence of the new phase. (Default 0.05)
PSAT. Phase transition (1 hydrocarbon phase to 2 hydrocarbon

phases) determined by saturation pressure test. A second phase
emerges if the grid-block pressure is lower than the calculated
saturation pressure. (Use instead of INCRP or GIBBS)
TRANSITION Option for controlling how phase transition calculations are

performed. Possible options are NEIGHBOR, TEST or ALL.
NEIGHBOR. All single phase grid blocks which neighbor a two

phase grid block (except well grid blocks) will use K-values from
the neighbor block as the starting point to test for the emergence of
a second phase. Well grid blocks will use the increasing pressure
method. Single phase blocks which are adjacent to other single
phase blocks which are not of the same phase are also tested. The
increasing pressure method is also used in single phase blocks.
TEST. The same grid blocks that are tested in the NEIGHBOR
option are tested, but initial K-values are generated internally in the
block The test used depends on the method selected by the
TRANSITION_TEST keyword. If no test is specified, the
increasing pressure method is used. (Default)

DELTA. All single phase gridblocks which meet any one of the fol-
lowing criteria are tested.
Any gridblocks which are adjacent to two phase gridblocks and sin-
gle phase blocks of another phase.
Any gridblocks with well perforations.
Any gridblocks where the pressure decreases by more than
tdelp*gridblock pressure. (tdelp default = 0.05)
Any gridblocks where any overall mole fraction changes by more
than tdelz. (tdelz default = 0.001)
Any gridblocks where
nc
∑ ( xi – yi )xi
i--------------------------------
= 1
nc
< tcrit
2
∑ xi
i= 1
The default value of tcrit is 0.15.
B. Any single phase gridblocks which meet any one of the follow-
ing criteria are tested.
Any gridblocks which are adjacent to two phase gridblocks, or sin-
gle phase blocks of another phase.
Any gridblock with well perforations.
Any gridblocks where b is negative.
Any gridblocks where the pressure decreases by more than
tdelp*gridblock pressure*b. The default value of tdelp used in con-
junction with b is 0.1
Any gridblocks where any overall mole fraction changes by more
than tdelz*b. The default value of tdelz used in conjunction with b
is 0.1
Note: b is a thermodynamic quantity that is zero at the critical
point, and grows in size as the square of the distance from the criti-
cal point increases. Therefore, the criteria for change is automati-
cally scaled by the proximity to the critical point.
ALL. All single phase grid blocks are tested for the emergence of a
second phase using the increasing pressure method.

PHASEID Selects criteria to label single phase systems. Possible options are
PREVIOUS, DENSITY, FLASH, OIL, GAS, or PSAT.
PREVIOUS. Use label applied during previous timestep.
DENSITY. Base label on whether the mass density of a phase is

above or below the specified THRESHOLD value. Fluids with
density above the threshold value are labeled as oil, while fluids
with density below the threshold value are labeled as gas.
FLASH. Base the phase label on the vapor mole fraction calculated
from a set of increasing pressure flash calculations.
OIL. Always label a single phase fluid as an oil.
GAS. Always label a single phase fluid as a gas.
PSAT. Label a single phase fluid based on the result of a saturation

pressure calculation. A bubble point fluid is labeled as an oil, while
a dew point fluid is labeled as a gas.
If the transition test is the increasing pressure method, then the

result of the two-phase flash at a pressure closest to the gridblock
pressure is used to label the phase.
If the flash has a vapor mole fraction greater than 0.5, the phase is
labeled a gas; otherwise, it is labeled a liquid.
If the transition test is the saturation pressure method, then the fluid
is labeled a gas if a dew point is found, and a liquid if a bubble point
is found.
If the transition test is the Gibbs method, then the Gibbs method is
used to set the phase label. If the Gibbs method cannot determine
the phase label, the increasing method is used.
ALPHAMU Critical volume correction factor applied to CO2 during Thodos

viscosity calculation. (Default 0.0)
VSHIFTOFF Specifies that the simulator will ignore VSHIFT input (In EOS
Component Properties Table).
STKATZOFF Specifies that the simulator will ignore STKATZ input (In EOS
LBC1 Modifies the first constant of the Lohrenz-Bray-Clark viscosity

calculation. (Default 0.1023)

LBC2 Modifies the second constant of the Lohrenz-Bray-Clark viscosity

calculation (Default 0.023364)
LBC3 Modifies the third constant of the Lohrenz-Bray-Clark viscosity

LBC4 Modifies the fourth constant of the Lohrenz-Bray-Clark viscosity

calculation (Default -0.040758)
LBC5 Modifies the fifth constant of the Lohrenz-Bray-Clark viscosity

Example
EOS NHC 5
COMPONENTS C1 C2 C3-4 C5-6 C7+
LABEL Test1
ENGLISH RANKINE
EOSOPTIONS PR
ZGIBBS

EOS Component Property Data
PROPS
COMPONENT MOLWT OMEGAA OMEGAB TC PC VC or ZC ACENTR (VSHIFT) (STKATZ)

name(1) mw(1) oma(1) omb(1) t(1) p(1) v/z(1) actr(1) (vs(1)) (sktz(1
name(2) mw(2) oma(2) omb(2) t(2) p(2) v/z(2) actr(2) (vs(2)) (sktz(2))
. . . . . . . . . .
. . . . . . . . . .
Additional Columns
(PARACHOR) (STK_C1N2) (STK_CO2) (STK_C2) (BP)

(parachor(1)) stk_c1n2(1) stk_co2(1) stk_c2(1) bp(1)
(parachor(2)) stk_c1n2(2) stk_co2(2) stk_c2(2) bp(2)
. . . . .
. . . . .
ENDPROPS
Associated EOSOPTIONS:
VSHIFTOFF
STKATZOFF
where:
PROPS Introduces the component property table.
ENDPROPS Specifies the end of the component property table.
COMPONENT Column heading keyword for component names.
MOLWT Molecular weight of component.
OMEGAA Ω a EOS parameter of component.
OMEGAB Ω b EOS parameter of component.
TC Critical temperature of component (degrees F, C, C, C, C).
PC Critical pressure of component (psia, kPa, Kg/cm2, bars, psia).
VC Critical volume of component (ft3/lbmole, m3/kgmole, m3/kgmole,

m3/kgmole, cc/gmole). Used for Thodos viscosity calculation.
Only one of VC or ZC should be entered.
ZC Critical gas compressibility factor of component (dimensionless).

Used for Thodos viscosity calculation. Only one of VC or ZC
should be entered.
R5000.0.1 Hydrocarbon PVT Properties: EOS Component Property Data 127

ACENTR Acentric factor of component (dimensionless).
VSHIFT Volume shift parameter of component (dimensionless).
STKATZ Standing-Katz factor for density calculation (dimensionless).
PARACHOR Parachor of component.
STK_C1N2 The portion of this component which should be assigned to the C1-
N2 grouping for purposes of calculating the density using the
Standing-Katz procedure. The values should be between 0 and 1.
STK_CO2 The portion of this component which should be assigned to the

CO2 grouping for purposes of calculating the density using the
BP Normal boiling point of the component (at 1 atmosphere pressure).

(degrees F, C, C, C, C). This value is used for calculation of the
ideal gas state Cp as a function of temperature using the Kesler and
Lee correlation (Ref. Edmister, Applied Hydrocarbon
Thermodynamics, Vol 1, P. 132). The Kesler and Lee correlation is
superseded for a component if ideal gas Cp coefficients are entered
in the IGS_CP table. It is permissible to enter NA as an entry for
BP if the coefficients are to be entered in the IGS_CP table. Also,
any value of boiling point with a numerical value less than -1000
will be ignored.
VSHIFTOFF Specifies that the simulator will ignore VSHIFT input.
STKATZOFF Specifies that the simulator will ignore STKATZ input.
Notes:
1. The component names must match the names in the COMPONENT list.
2. The number of components must be less than or equal to the number of names in the COM-
PONENT list.
3. Names cannot be repeated.
4. Names can be excluded if they match one of the standard names.
5. If names match one of the standard names, a # can be used in place of the actual value to indi-
cate use of a default value. Values for OMEGAA and OMEGAB can be defaulted using # for
any component name.
128 Hydrocarbon PVT Properties: EOS Component Property Data R5000.0.1

6. VSHIFT is an optional column heading that indicates volume shift will be used to calculate
densities.
7. STKATZ is an optional column heading that indicates Standing-Katz will be used to calculate
surface densities.
8. PARACHOR is an optional column heading that is required for IFT calculations.
9. In simulation runs including compressor model and thermal modeling, the Cp of the gas
phase is required. That in turn requires Cp in the ideal gas state for each component. For this
purpose, each component should be defined either in PROPS section or exists in the DEF-
PROPS section. In either section, the definition must have an input of either BP or the five
coefficients igs_cp_coeff in the IGS_CP section.
Examples:
Example 1
PROPS
COMPONENT MOLWT OMEGAA OMEGAB TC PC VC ACENTR STKATZ
N2 28.01 0.3744242 0.0950082 -232.47 493.1 1.44 0.0403 0.53
C1 16.04 0.4360211 0.0891481 -116.67 666.7 1.59 0.0111 0.2996
PS1 44.01 0.4377642 0.0888581 87.93 1070.7 1.51 0.2310 0.8172
C2 30.07 0.4209492 0.0855049 90.13 707.8 2.37 0.0990 0.3558
PS2 44.01 0.4336163 0.0879712 206.03 616.0 3.20 0.1523 0.5069
PS3 58.12 0.4161404 0.0806266 296.23 500.0 4.11 0.1700 0.5772
PS4 110.10 0.4436153 0.0746199 550.33 400.0 7.00 0.4700 0.7500
PS5 226.03 0.4696730 0.0670398 870.33 250.4 14.0 0.6500 0.8655
PS6 345.43 0.4655944 0.0540930 1105.33 175.2 21.00 0.9750 0.9800
ENDPROPS
Example 2
PROPS
COMPONENT MOLWT OMEGAA OMEGAB TC PC ZC ACENTR VSHIFT
C1 16.04 0.4572355 0.0777961 343.0 667.8 0.290 0.0130 0.0
C3 44.10 0.4572355 0.0777961 665.7 616.3 0.277 0.1524 0.0
C10 142.29 0.4572355 0.0777961 1111.8 304.0 0.257 0.4885 0.0
C18 254.50 0.4572355 0.0777961 1346.4 174.0 0.250 0.7900 0.0
C20 282.00 0.4572355 0.0777961 1380.0 162.0 0.235 0.8500 0.0
(PROPS CONTINUED)
BP
NA
-1.0e10
805.10
1061.1
1100.0
ENDPROPS
R5000.0.1 Hydrocarbon PVT Properties: EOS Component Property Data 129

EOS Component Coefficients for Ideal Gas Cp
IGS_CP
name(1) coeff(1,1)coeff(2,1) coeff(3,1) coeff(4,1) coeff(5,1)
name(2) coeff(1,2)coeff(2,2) coeff(3,2) coeff(4,2) coeff(5,2)
…
…
ENDIGS_CP
where
Name(i) = component name
coeff (j,i), j, i=1,5 Coefficients in a 4th order polynomial in T that defines the ideal gas
state Cp (specific heat at constant pressure) of the component at
temperature T. All 5 values must be input for each component.
(Default values for these coefficients for standard components are
obtained from Passut-Danner Ideal Gas State Enthalpy
Coefficients) (The units are BTU/Lb-Ri, KJ/Kg-Ki, KJ/Kg-Ki, J/
gm- Ki).
The ideal gas specific heat at constant pressure (Cp0) for a

component at temperature T is calculated in using the following
formula:
CP_IGS(i) = coeff (1,i) + Σj=2,5 coeff (j,i)*Tj-1
Notes:
1. Coefficients have already been defined by default for the standard components CO2, H2S,
N2, C1, C2, C3, NC4, IC4, NC5, IC5, NC6, and C6. Coefficients for these components may
be modified in the DEFAULT EOS file. Standard coefficients may be added for other com-
ponents in the DEFAULT_EOS file.
2. Components that do not have valid values of BP defined in the PROPS table should have an
entry in this table, unless it is a standard component for which ideal gas coefficients have
already been defined.
Example
IGS_CP
C10 0.22911 -0.0d-4 4.52784d-7 -25.23180d-11 47.48019d-15
ENDIGS_CP
130 Hydrocarbon PVT Properties: EOS Component Coefficients for Ideal Gas Cp R5000.0.1
EOS Binary Interaction Data
Binary interaction coefficient tables are input as follows:
BINA
COMPONENT comp1 comp2 ........................................compn-1
comp2 a21
comp3 a31 a32
comp4 a41 a42 a43
....
...
compn an1 an2 an3 ...................................an,n-1
ENDBINA
BINB
COMPONENT comp1 comp2 ........................................compn-1
comp2 b21
comp3 b31 b32
comp4 b41 b42 b43
....
...
compn bn1 bn2 bn3 ................................... bn,n-1
ENDBINB
where:
BINA Introduces binary interaction coefficient data for the A term

(dimensionless).
ENDBINA Terminates the BINA table.
BINB Introduces binary interaction coefficient data for the B term

(dimensionless).
ENDBINB Terminates the BINB table.
Notes:
1. A binary interaction coefficient table for the A-term is not required if all the coefficients are
default values.
2. Default values for the A-term are specified for pairs of standard components. The default for
pairs of non-standard components and for the B-term is zero.
3. A binary interaction coefficient table for the B-term is not required if all the coefficients are
zero.
R5000.0.1 Hydrocarbon PVT Properties: EOS Binary Interaction Data 131

Example:
BINA
COMPONENT N2 C1 PS1 C2 PS2 PS3 PS4 PS5
C1 0.028
PS1 0.17 0.0
C2 0.061 0.005 0.0
PS2 0.17 0.0 0.0 0.0
PS3 0.17 0.0 0.0 0.0 0.0
PS4 0.12033 0.02 0.0 0.0 0.0 0.0
PS5 0.06014 0.023 0.0 0.0 0.0 0.0 0.0
PS6 0.0 0.045 0.0 0.0 0.0 0.0 0.0 0.0
ENDBINA
132 Hydrocarbon PVT Properties: EOS Binary Interaction Data R5000.0.1

Examples of EOS Fluid System Input
Example 1 (For use without Cp, Cv related inputs.)
DESC SPE 5
EOS NHC 6
COMPONENTS C1 C3 C6 C10 C15 C20
ENGLISH FAHR
TEMP 160.0
EOSOPTIONS PR
PROPS
COMPONENT MOLWT OMEGAA OMEGAB TC PC VC ACENTR
C1 16.04 0.4572355 0.0777961 -116.67 667.8 1.598 0.0130
C3 44.01 0.4572355 0.0777961 206.03 616.3 3.129 0.1524
C6 86.18 0.4572355 0.0777961 453.73 436.99 5.922 0.3007
C10 142.29 0.4572355 0.0777961 652.13 304.0 10.09 0.4885
C15 206.00 0.4572355 0.0777961 810.33 200.0 16.69 0.6500
C20 282.00 0.4572355 0.0777961 920.33 162.0 21.48 0.8500
ENDPROPS
BINA
COMPONENT C1 C3 C6 C10 C15
C3 0.0
C6 0.0 0.0
C10 0.0 0.0 0.0
C15 0.05 0.005 0.0 0.0
C20 0.05 0.005 0.0 0.0 0.0
Example 2 (For use with compressor model, with Cp, Cv inputs.)
EOS NHC 7
COMPONENTS N2 C1 C3 C6 C10 C18 C20
TEMP 620
ENGLISH RANKINE
EOSOPTIONS PR
TRANS_TEST GIBBS
PROPS
COMPONENT MOLWT OMEGAA OMEGAB TC PC ZC ACENTR VSHIFT
C1 16.04 0.4572355 0.0777961 343.0 667.8 0.290 0.0130 0.0
C3 44.10 0.4572355 0.0777961 665.7 616.3 0.277 0.1524 0.0
C10 142.29 0.4572355 0.0777961 1111.8 304.0 0.257 0.4885 0.0
C18 254.50 0.4572355 0.0777961 1346.4 174.0 0.250 0.7900 0.0
C20 282.00 0.4572355 0.0777961 1380.0 162.0 0.235 0.8500 0.0
R5000.0.1 Hydrocarbon PVT Properties: Examples of EOS Fluid System Input 133
(PROPS continued)
BP
NA
NA
NA
1061.1
1100.0
ENDPROPS
IGS_CP
C10 0.22911 -0.0d-4 4.52784d-7 -25.23180d-11 47.48019d-15
ENDIGS_CP
BINA
COMPONENT N2 C1 C3 C6 C10 C18
C1 0.0
C3 0.0 0.000
C6 0.0 0.000 0.000
C10 0.0 0.000 0.000 0.000
C18 0.0 0.050 0.005 0.000 0.000
C20 0.0 0.050 0.005 0.000 0.000 0.000
ENDBINA
134 Hydrocarbon PVT Properties: Examples of EOS Fluid System Input R5000.0.1
Separator Methods
In This Chapter
• EOS Multistage separator tables
• Gas plant EOS separator
• Black oil separator
• API separators
All the data for a separator method is input in a single file. Separator files are included in a case in
the PVT_FILES section as follows:
PVT_FILES
SEPARATOR method 1 filename1
SEPARATOR method 2 filename2
....
The separator methods are used by the network to calculate “surface” volumes for connections,
wells and separator nodes. They are also used by SEPNODES to determine the total effluent
phase rates by flashing the inflow through the battery method. The IBAT keyword is used to
assign separator methods to connections in the NODECON or GROUP table, to wells in the
WELL input, to separator nodes in the CONSTRAINTS table and to SEPNODES.
Gas Plant data are a special case of separator data for EOS cases and as such can be used any-
where that a conventional Separator Table is applied; however, it will usually be applied to
SEPNODES.
Separators can also be applied to black oil cases, but the inputs are different. (See
BOSEP.0334010820)
R5000.0.1 Separator Methods: In This Chapter 135

EOS Multistage Separator Tables
Separator tables are input as follows:
STAGE TEMP PRES METHOD IDL1 IDL2 IDV1 IDV2 FDL1 FDV1
Stage1 temp1 pres1 method1 idl11 idl21 idv11 idv21 fdl11 fdv11
Stage2 temp2 pres2 method2 idl12 idl22 idv12 idv22 fdl12 fdv12
. . . . . . . . .
. . . . . . . . .
Stagen tempn presn methodn idl1n idl2n idv1n idv2n fdl1n fdv1n
where:
STAGE Column heading keyword for stage number (must be an integer)

(Optional)
TEMP Column heading keyword for separator stage temperatures. (F, C,

C, C, C) (Required)
PRES Column heading keyword for separator stage pressures. (psia, kPa,
Kg/cm2, bars, psia) (Required)
METHOD Column heading keyword for separator stage EOS method.

(Required)
IDL1 Column heading for the first destination of the liquid output stream
of stage j. This input is optional. By default, for all stages except
the last stage, IDL1 will be set to the following stage, i.e. j +1. By
default, the last stage liquid stream output will be directed to oil
production, indicated by the OIL keyword.
IDL2 Column heading for the second destination of the liquid output
stream of stage j. Possible values are other downstream stages or
the OIL keyword. This input is optional. By default, there will only
be a single destination of the liquid stream. If the destination does
not exist, NA or 0 can be entered.
IDV1 Column heading for the first destination of the vapor output stream
of stage j. Possible values are other downstream stages or the GAS
keyword or the VENT keyword. This input is optional. By default,
the vapor stream will be set to gas production indicated by the GAS
keyword.
IDV2 Column heading for the second destination of the vapor output
the GAS keyword or the VENT keyword. This input is optional.
136 Separator Methods: EOS Multistage Separator Tables R5000.0.1

By default, there will only be a single destination of the vapor

stream. If the destination does not exist, NA or 0 can be entered.
FDL1 Column heading for the fraction of the first liquid output stream
that will be sent to the destination specified by IDL1. The input
must be between 0 and 1. The remaining fraction will go to the
second liquid destination for this stage. This column is optional. If
it is missing, all the liquid production will be sent to the destination
specified by idl1.
FDV1 Column heading for the fraction of the first vapor output stream
that will be sent to the destination specified by IDV1. The input
second vapor destination for this stage. This column is optional. If
it is missing, all the vapor production will be sent to the destination
specified by idv1.
Example with required input:
TEMP PRES METHOD

150.0 500.0 1
60.0 14.7 2
Equivalent input with all columns:
STAGE METHOD PRES TEMP IDL1 IDL2 IDV1 IDV2 FDL1 FDV1
1 1 500. 150. 2. NA GAS NA 1. 1.
2 2 14.7 60. OIL NA VENT NA 1. 1.
R5000.0.1 Separator Methods: EOS Multistage Separator Tables 137

Gas Plant Data
There are three parts to the data required to define a Gas Plant: (1) The list of key component plus
components, (2) Auxiliary conditions and data necessary to calculate molar volumes of the efflu-
ent liquid and gas streams, and (3) Gas Plant Liquid Recovery factors.
Key Component Definition

KEYCPTLIST keycptname(1) keycptname(2) …. keycptname(nkey)
where:
KEYCPTLIST Keyword indicating input for a list of ‘Key’ component names will
follow. Only component names in this list will be used to compute
the key-component-plus mole fractions. This keyword must be
entered.
Example:
KEYCPTLIST C8 C10 PS1 PS2
138 Separator Methods: Key Component Definition Gas Plant Data R5000.0.1
Auxiliary Conditions and Data for Gas Plant Effluent Molar Volume
Calculations
PRES_STD (optional) The pressure at which the effluent gas and oil stream molar
volumes will be determined. By default, the gasplant will use the
standard pressure defined for the reservoir.(psia, kPa, Kg/cm2, bars,
psia)
TEMP_STD (optional) The temperature at which the effluent gas and oil stream molar
volumes will be determined. By default, the gasplant will use the
standard temperature defined for the reservoir. (F, C, C, C, C)
EOSMETHOD The PVT eosmethod used to calculate the effluent gas and oil
stream molar volumes.
WATERMETHOD The WATER method used to calculate the molar volume of water.
Example:
PRES_STD 20
TEMP_STD 100
EOSMETHOD 1
WATERMETHOD 5
Liquid recover factor table is specified as follow:
RECFAC_TABLE
KEYCPTMF molefracKey(1) molefracKey (2) … molefracKey (n)
cptname(1) rec_fac(1,1) rec_fac(1,2) …. rec_fac(1,n)
cptname(2) rec_fac(2,1) rec_fac(2,2) …. rec_fac(2,n)
. . . .
cptname(nc) rec_fac(nc,1) rec_fac(nc,2) …. rec_fac(nc,n)
ENDREFRAC_TABLE
where:
RECFAC_TABLE Keyword indicating that a Gas Plant liquid fraction table is to be

entered.
KEYCPTMF Table keyword header for the column of key-component-plus mole

fractions. Recovery factors are looked based on this column.
cptname(i) The i-th component name in the relevant EOS component set. All
nc (hydrocarbon) component names must appear in this column and
be in the order that they were entered in the relevant EOS
component set.
R5000.0.1Separator Methods: Auxiliary Conditions and Data for Gas Plant Effluent Molar Volume Calcula-
molefracKey (i) Key-component plus mole fraction. Data must be entered for at
least two of these values. The order of values for these data does not
matter as they will be sorted from minimum to maximum internally.
rec_fac(i,j) Liquid recovery factor for i-th hydrocarbon component at the j-th
key-component plus mole fraction. These values are multiplied by
the overall gas plant feed molar rates to obtain the separated liquid
molar rates. The separated gas molar rates are obtained by
multiplying the gas plant feed molar rates by (1 – the liquid
recovery factors).
Note:
• This liquid recovery factor table may only be applied where the same EOS component set is
defined.
• See diagram below for calculation of effluent stream compositions.
140 Separator Methods: Auxiliary Conditions and Data for Gas Plant Effluent Molar Volume Calcu-
Example:
RECFAC_TABLE
KEYCPTMF 0 0.25 0.50 0.75 0.95
C1 0.005 0.012 0.031 0.049 0.05
C2 0.001 0.002 0.002 0.003 0.004
C3 0.008 0.020 0.052 0.075 0.08
C4 0.030 0.050 0.078 0.11 0.15
C5 0.090 0.130 0.22 0.44 0.55
C7 1.0 1.0 1.0 1.0 1.0
C10 1.0 1.0 1.0 1.0 1.0
ENDREFRAC_TABLE
Black Oil Separator Tables
Black oil separator tables are identified with a BOSEP keyword.:
BOSEP
MWOIL
MGAS
ZLIG
STAGE KVOIL KVGAS IDL1 IDL2 IDV1 IDV2 FDL1 FDV1
Stage1 kvoil1 kvgas1 idl11 idl21 idv11 idv21 fdl11 fdv11
Stage2 kvoil2 kvgas2 idl12 idl22 idv12 idv22 fdl12 fdv12
. . . . . . . . .
. . . . . . . . .
Stagen kvoiln kvgasn idl1n idl2n idv1n idv2n fdl1n fdv1n
where:
BOSEP Keyword indicating the following table is black oil separator data.
MWOIL Keyword indicating the next number is the molecular weight of the
oil component. (Required)
MWGAS Keyword indicating that the next number is the molecular weight of
the gas component. (Required)
ZLIQ Keyword indicating that the next number is the Z-factor of the oil
output stream from the separator. (Required.)

(Optional)
KVOIL Column heading keyword for K-value of the oil component

(Required)
KVGAS Column heading keyword for K-value of the gas component

(Required)
the last stage, IDL1 will be set to the following stage, i.e. j +1, By
the OIL keyword. This input is optional. By default, there will
only be a single destination of the liquid stream. If the destination

does not exist, NA or 0 can be entered.
keyword.
specified by idl1.
specified by idv1.
API Separators
API separator tables are identified with an APISEP keyword. There is a separator table for every
corresponding black oil table within an API group of tables. The format is as follows:
APISEP
MWOIL_L mwoil_l
MWOIL_H mwoil_h
MWGAS mwgas
METHOD pvt_method
BEGIN_API
API api1
ZOIL zoil1
STAGE KVOIL_L KVOIL_H KVGAS IDL1 IDL2 IDV1 IDV2 FDL1 FDV1
Stage1 kvoil_l1,1 kvoil_h1,1 kvgas1,1 idl11 idl21 idv11 idv21 fdl11 fdv11
. . . . . . . . . .
. . . . . . . . . .
Stagen kvoil_ln,1 kvoil_hn,1 kvgasn,1 idl1n idl2n idv1n idv2n fdl1n fdv1n
END_API
.
.
.
BEGIN_API
API api2
ZOIL zoil2
. . . . . . . . . .
. . . . . . . . . .
Stagen kvoil_ln,2 kvoil_hn,2 kvgasn,2 idl1n idl2n idv1n idv2n fdl1n fdv1n
END_API
.
.
.
BEGIN_API
API apim
ZOIL zoilm
Stage1 kvoil_l1,m kvoil_h1,m kvgas1,1 idl11 idl21 idv11 idv21 fdl11 fdv11
Stage2 kvoil_l2,m kvoil_h2,m kvgas2,m idl12 idl22 idv12 idv22 fdl12 fdv12
. . . . . . . . . .
. . . . . . . . . .
Stagen kvoil_ln,m kvoil_hn,m kvgasn,m idl1n idl2n idv1n idv2n fdl1n fdv1n
END_API
where:
n Subscript which refers to the number of stages, which must be the

same for each API value.
m Subscript which refers to the number of different API tables.
MWOIL _L Keyword indicating the next number is the molecular weight of the
light oil component. (Required)
MWOIL _H Keyword indicating the next number is the molecular weight of the
heavy oil component. (Required)
MWGAS Keyword indicating that the next number is the molecular weight of
the gas component. (Required)
METHOD Keyword indicating that the separator is based on the specified

PVT method. (Required)
BEGIN_API Keyword indicating the beginning of a new set of data for with a
different API value.
END_API Keyword indicating the end of a set of data for a particular API
value.
ZOIL Keyword indicating that the next number is the Z-factor of the oil
output stream from the separator. (Required)
API Keyword indicating the following separator stage information

applies to the black oil table with this API value

(Optional column)
KVOIL_L Column heading keyword for K-value of the light oil component.
(Required column)
KVOIL_H Column heading keyword for K-value of the heavy oil component.
(Required column)
KVGAS Column heading keyword for K-value of the gas component.

(Required column)
the last stage, IDL1 will be set to the following stage, i.e. j +1, By
the OIL keyword. This input is optional. By default, there will
only be a single destination of the liquid stream. If the destination
does not exist, NA or 0 can be entered.
keyword.
specified by idl1.
specified by idv1.
Relative Permeability and Capillary Pressure
In This Chapter
• Three-phase relative permeability parameters
• Water-oil relative permeability tables
• Gas-oil relative permeability tables
• Gas-oil relative permeability tables for three-phase
• Gas-water relative permeability tables
• Hysteresis parameters
• Water-oil imbibition relative permeability table for hysteresis (user option)
• Gas imbibition relative permeability table for hysteresis (user option)
• J-function adjustment of capillary pressure
• Endpoint scaling
• Endpoint scaling tabular output
• Vertical equilibrium options
• IFT adjustments of capillary pressure and relative permeability
• Gas-dependent water relative permeability
• Special performance-related data options
All the data for a relative permeability/capillary pressure method is input in a single file. Relative
permeability/capillary pressure files are included in a case in the ROCK_FILES section as fol-
lows:
ROCK_FILES
RELPM method 1 filename1
R5000.0.1 Relative Permeability and Capillary Pressure: 147

RELPM method 2 filename2

....
The Relative permeability/capillary pressure method to be used by each cell is specified in the
PROPERTY_FILES section of the case file using the IRELPM keyword. By default, all cells use
method 1.
148 Relative Permeability and Capillary Pressure: R5000.0.1

Three-Phase Relative Permeability Parameters
STONE1 SOMOPT1
SOMOPT2 som
or
STONE2
or
KROINT
where:
STONE1 Specifies that the Stone 1 method will be used.
STONE2 Specifies that the Stone 2 method will be used. This is the default.
SOMOPT1 Specifies the three-phase Stone 1 residual oil method. This is the
default if STONE1 is specified.
SOMOPT2 Specifies the three-phase Stone 1 residual oil method.
som The three-phase Stone 1 residual oil saturation for SOMOPT2.
KROINT Specifies that the saturation-weighted interpolation three-phase

option will be used.
Examples:
STONE1 SOMOPT2 0.05

Water-Oil Relative Permeability Table
Water-Oil relative permeability tables are specified as follows:
WOTABLE
SW KROW KRW (PCWO)
Sw1 Krow1 Krw1 (Pcwo1)
. . . .
. . . .
Swn Krown Krwn (Pcwon)
where:
WOTABLE Introduces data for a water oil relative permeability table
SW Column heading keyword for water saturation.
KROW Column heading keyword for oil relative permeability to water.
KRW Column heading keyword for water relative permeability.
PCWO Column heading keyword for water-oil capillary pressure (psia,

kPa, Kg/cm2, bars, psia). A value for Pcwo is required for the first
and last Sw values. If Pcwo is not specified for other water
saturations, it will be linearly interpolated.
Notes:
WOTABLE data cannot be entered for Gas-Water systems.
SW Values
• The minimum (connate) water saturation, Swl, is the first value of Sw.
• The maximum water saturation, Swn, is the last value of Sw.
• The residual water saturation, Swr, is given by the smallest value of Sw for which krw is
0.0.
• Values must be monotonically increasing.
Residual Oil Saturation to Water
• Sorw is given by (1.0 - Sw, the smallest value of Sw for which krow is 0.0)

KRW Values
• First value of krw must be 0.0
• Values of krw must not decrease with increasing Sw
KROW
• Last value of krow must be 0.0
• Values of krow must not increase with increasing Sw
• The value of krow at Swl must be the same as the value of krog at Sgl in the gas-oil table.
PCWO
• PCWO must decrease with increasing Sw, or it must be constant.
Examples:
WOTABLE
SW KROW KRW PCWO
0.20 1.0 0.0 1.0
0.225 0.8574 0.00006
0.250 0.7290 0.0005
0.300 0.5120 0.0040
0.350 0.3430 0.0135
0.400 0.2160 0.0320
0.425 0.1664 0.0456 0.2
0.450 0.1250 0.0625
0.500 0.0640 0.1080
0.550 0.0270 0.1715
0.600 0.0080 0.2560
0.650 0.0010 0.3645
0.675 0.00012 0.4287
0.700 0.0000 0.5000 0.0

Gas-Oil Relative Permeability Table
Gas-Oil relative permeability tables are specified as follows:
GOTABLE
SG KROG KRG (PCGO)
Sg1 Krog1 Krg1 (Pcgo1)
Sg2 Krog2 Krg2 (Pcgo2)
. . . .
. . . .
Sgn Krogn Krgn (Pcgon)
where:
GOTABLE Introduces data for a gas oil relative permeability table
SG Column heading keyword for gas saturation.
KROG Column heading keyword for oil relative permeability to gas.
KRG Column heading keyword for gas relative permeability.
PCGO Column heading keyword for gas-oil capillary pressure (psia, kPa,
Kg/cm2, bars, psia). A value for Pcgo is required for the first and
last Sg values. If Pcgo is not specified for other gas saturations, it
will be linearly interpolated.
Notes:
GOTABLE data cannot be entered for Water-Oil or Gas-Water systems.
SG Values
• The minimum gas saturation, Sgl, is the first value of Sg.
• The maximum gas saturation, Sgn, is the last value of Sg.
• The residual (critical) gas saturation, Sgr, is given by the smallest value of Sg for which
krg is 0.0.
• Values must be monotonically increasing
Connate Water Saturation
• Swc is given by (1.0 – Sgn). Swc must agree with the value determined from the water-oil
table, Swl.

Residual Oil Saturation to Gas
• Sorg is given by (1.0 - Swc - Sgr, the smallest value of Sg for which krog is 0.0)
KRG Values
• First value of krg must be 0.0
• Values of krg must not decrease with increasing Sg
KROG
• Last value of krog must be 0.0
• Values of krog must not increase with increasing Sg
• The value of krog at Sgl must be the same as the value of krow at Swl in the water-oil table.
PCGO
• PCGO must increase with increasing Sg, or it must be constant.
Examples:
GOTABLE
SG KROG KRG PCGO
0.00000 1.0000 0.00000 0.0
0.02500 0.8574 0.00098
0.05000 0.7290 0.00390
0.10000 0.5120 0.01560
0.20000 0.2160 0.06250
0.25000 0.1250 0.09770
0.30000 0.0640 0.1406
0.35000 0.0270 0.1914
0.40000 0.0080 0.2500 1.0
0.42500 0.0034 0.2822
0.45000 0.0010 0.3164
0.50000 0.00 0.3906
0.55000 0.00 0.4727
0.60000 0.00 0.5625
0.65000 0.00 0.6602
0.70000 0.00 0.7656
0.75000 0.00 0.8789
0.80000 0.00 1.0000 5.0

Gas-Water Relative Permeability Table
Gas-Water relative permeability is typically entered as a GWTABLE and is specified as follows.

The exception is for working 3-phase models described in the next section.
GWTABLE
SG KRWG KRG (PCGW)
Sg1 Krwg1 Krg1 (Pcgw1)
Sg2 Krwg2 Krg2 (Pcgw2)
. . . .
. . . .
Sgn Krwgn Krgn (Pcgwn)
where:
GWTABLE Introduces data for a gas water relative permeability table
KRWG Column heading keyword for water relative permeability to gas.
PCGW Column heading keyword for gas-water capillary pressure (psia,

kPa, Kg/cm2, bars, psia). A value for Pcgw is required for the first
and last Sg values. If Pcgw is not specified for other gas
saturations, it will be linearly interpolated.
Notes:
GWTABLE data can only be entered for Gas-Water systems.
SG Values
• The minimum gas saturation, Sgl, is the first value of Sg.
• The maximum gas saturation, Sgn, is the last value of Sg.
• The residual (critical) gas saturation, Sgr, is given by the smallest value of Sg for which
krg is 0.0.
• Values must be monotonically increasing
Connate Water Saturation
• Swc is given by (1.0 – Sgn).

KRG Values
• Values of krg must not decrease with increasing Sg
KRWG
• Last value of krwg must be 0.0
• Values of krwg must not increase with increasing Sg
PCGW
• PCGW must increase with increasing Sg, or it must be constant.
Examples:
GWTABLE
SG KRWG KRG PCGW
0.00000 1.0000 0.00000 0.0
0.02500 0.8574 0.00098
0.05000 0.7290 0.00390
0.10000 0.5120 0.01560
0.20000 0.2160 0.06250
0.25000 0.125 0.09770
0.30000 0.0640 0.1406
0.35000 0.0270 0.1914
0.40000 0.0080 0.2500 1.0
0.42500 0.0034 .3164
0.50000 0.00 0.3906
0.55000 0.00 0.4727
0.60000 0.00 0.5625
0.65000 0.00 0.6602
0.70000 0.00 0.7656
0.75000 0.00 0.8789

Gas-Water Relative Permeability from Three Phase Data
For a gas-water system, it is expected that a GWTABLE will be entered. However, it is possible to
use the combination of a WOTABLE and a GOTABLE if the GW3PHASE keyword has been
added to the METHOD file. When the GW3PHASE keyword is used, a synthetic GWTABLE will
be constructed by Standalone and the simulator will behave as if a GWTABLE had been entered
directly.
GW3PHASE
Where:
GW3PHASE Specifies that a gas-water table will be constructed from the water-
oil and gas-oil tables.
Example:
GW3PHASE

Hysteresis Parameters
HYSTERESIS NONE
KRW USER
KRG LINEAR MAXTRAP Sgtr
SCALED MAXTRAP Sgtr
CARLSON MAXTRAP Sgtr
USER
KROW LINEAR MAXTRAP Sotr
SCALED MAXTRAP Sotr
CARLSON MAXTRAP Sotr
USER
PCWO ETA eta MAXSW maxsw IMBW
TOLREV tolrev TOLHYS tolhys
where:
HYSTERESIS Introduces hysteresis parameters.
NONE Specifies that hysteresis will not be active (default).
KRW Specifies that water transition hysteresis will be active.
KRG Specifies that gas phase hysteresis will be active.
KROW Specifies that oil hysteresis will be active.
PCWO Specifies that water-oil capillary pressure hysteresis will be active.

This option requires that imbibition water-oil capillary pressure
data have been entered (WOTABLE_IMB). The default is not to
perform water-oil capillary pressure hysteresis.
LINEAR This option applies only to KRG and KROW phase hysteresis. The
intermediate imbibition-drainage curves are constructed by linear
interpolation between the historical maximum (Sg or So for KRG
and KROW, respectively) and the current trapped saturation (Sgtrp
or Sotrp, for KRG and KROW, respectively - where the trapped
saturations are derived from Land’s equations.
SCALED This option applies only to KRG and KROW phase hysteresis. The
intermediate imbibition-drainage curves are constructed by scaling
that portion of the drainage curve between Sgc (or Swro) and
Sgmax (or Somax) to fit between Sgtrp (or Sotrp) and Sgmax( or
Somax) for gas hysteresis (oil hysteresis) – where the trapped
saturations are derived from Land’s equations.

CARLSON This option applies only to KRG and KROW phase hysteresis. The
intermediate imbibition-drainage curves are constructed by
evaluating the drainage curve at the current “free” saturation value.
The “free” saturation is determined from the theory of Carlson.
USER This option is available to all relative permeability hysteresis

phases. It is the only option for KRW. Imbibition data must be
entered in the WOTABLE_IMB or GOTABLE_IMB for this
option. Intermediate drainage-imbibition curves are generated by
evaluating the imbibition curve at a scaled saturation. The scaling
domain for the imbibition curve is determined by doing an inverse
lookup at the relative permeability at the historical (Swmin, Sgmax,
Somax) evaluated on the drainage curve.
MAXTRAP Introduces the maximum trapped saturation. This data is required

for the LINEAR, SCALED and CARLSON options. There is no
default. Array input of SOTR or SGTR is also possible within the
ROCK_ARRAY_FILES section of the case file (See the Array
Data Chapter. Note that while these arrays are entered in the
endpoint section endpoint scaling need not be active to use these
arrays.
TOLREV Saturation fraction by which the phase saturation must be below the
historical maximum phase saturation before hysteresis calculations
are performed. The imbibition curve is constructed starting at the
phase saturation equal to historical maximum phase saturation
minus tolrev. The default value is 0.02.
TOLHYS Used for gas relative permeability hysteresis, only. This is the
incremental gas saturation by which the adjusted historical
maximum gas saturation (historical maximum gas saturation minus
tolrev) must exceed the critical gas saturation before hysteresis
calculations are performed. The default value is 0.05.
MAXSW The maximum water saturation for which PCWO hysteresis

calculations will be performed.
Notes:
1. All combinations of hysteresis types may be active. For example, KRW, KROW, KRG and
PCWO may be turned on.
2. The PCWO hysteresis methodology is equivalent to the “simple” VIP® method where no
interior scanning loops are generated.

Example:
HYSTERESIS KRG CARLSON MAXTRAP 0.2

Water-Oil Imbibition Relative Permeability Table for

Hysteresis (User Option)
Water-Oil imbibition relative permeability tables are specified as follows:
WOTABLE_IMB
SW KROW KRW (PCWO)
. . . .
. . . .
Swn Krown Krwn (Pcwon)
where:
WOTABLE_IMB Introduces data for a water oil imbibition relative permeability table
SW Column heading keyword for water saturation.
KROW Column heading keyword for oil relative permeability to water.
KRW Column heading keyword for water relative permeability.
PCWO Column heading keyword for water-oil capillary pressure (psia, kPa, Kg/
cm2, bars, psia). A value for Pcwo is required for the first and last Sw
values. If Pcwo is not specified for other water saturations, it will be
linearly interpolated.
Notes:
The rules for data in this table are the same as those in the primary drainage table (WOTABLE)
except for the following additions:
• The krow at Swl must match the value given in the primary drainage table.
• The krow data at equivalent Sw must be less than or equal to their values on the primary
drainage curve. This requirement is only enforced if KROW hysteresis is active.
• The krw data at equivalent Sw must be greater than or equal to their values on the primary
drainage curve. This requirement is only enforced if KRW hysteresis is active.
• PCWO data must be less than or equal to the values on the primary drainage table at the same
saturations. This requirement is only enforced if PCWO hysteresis is active.

Gas Imbibition Relative Permeability Table for Hysteresis

(User Option)
The bounding imbibition gas relative permeability is required for the HYSTERESIS GAS USER
option. The table is specified as follows:
GOTABLE_IMB
SG KRG
Sg1 Krg1
Sg2 Krg2
. .
. .
Sgn Krgn
where:
GOTABLE_IMB Introduces data for the bounding imbibition gas relative

permeability.
Notes:
SG values
• The imbibition maximum gas saturation, iSgu, is the last value of Sg.
• The imbibition residual gas saturation, iSgr, is given by the largest value of Sg for which
krg is 0.0.
• Values must be monotonically increasing.
KRG values
PCGO values
• This header is not valid because there is no gas-oil capillary hysteresis option available.
KROG values
• This header is not valid because only the water-oil hysteresis is considered for the
KROW hysteresis option.

J-Function Adjustment of Capillary Pressure
JFUNC (KX or KY or KXKY)

(PERMBASIS permbasis)
(PORBASIS porbasis)
where:
JFUNC Invokes J-Function Option.
KX Use KX as gridblock permeability for scaling
KY Use KY as gridblock permeability for scaling
KXKY Use square root of product of KX and KY for scaling (default.)
PERMBASIS Specifies permeability basis used in equations below (md, md, md,
md, md). If this is entered then PORBASIS must also be entered
and user should not adjust measured capillary pressure data.
PORBASIS Specifies porosity basis used in equations below (fraction). If this is

entered then PERMBASIS must also be entered and user should not
adjust measured capillary pressure data.
Formulae:
The J-Function is defined as follows:

meas
Pc ( S k ) K Basis
J ( Sk ) = ------------------------------ --------------
-
σ Basis cos θ c φ Basis
where:
J ( Sk ) is the dimensionless J-function.
meas
Pc ( Sk ) is the measured capillary pressure.
K Basis is the permeability of sample for which the capillary pressure was
measured.
φ Basis is the porosity of sample for which the capillary pressure was
measured.

For convenience there are two ways to use this option. They result in the same adjustment.
Method(A) - Enter the KBasis and φBasis data. The i-th gridblock capillary pressure is then calcu-
lated by the formula:
K Basis
----------------
meas φ Basis
P ci ( S k ) = P c (S k ) ---------------------
Ki
-----
φi
Method(B) - Don’t enter KBasisand φBasis data, adjust the capillary pressure entries in the tables
as follows:
adj meas K Basis

Pc ( Sk ) = Pc ( S k ) --------------
-
φ Basis
and the gridblock capillary pressure is calculated by the formula:

adj
Pc ( Sk )
P ci ( S k ) = ----------------------
Ki
-----
φi
Notes:
1. The K i values appearing in the above formulae depend on the option selected. Either KX,
KY or the square root of the KX and KY product.
2. There is no accounting for compaction affecting permeability or porosity after initialization.
3. The IFT and contact angle terms of the J-function definition do not appear in the above for-
mulae because they are not being scaled by this option. IFT will affect capillary pressure
through the IFT option.

Endpoint Scaling
SCALING NONE
TWOPOINT
THREEPOINT
NOCHK
where:
SCALING Introduces endpoint scaling parameters.
NONE Specifies that endpoint scaling will not be used (Default).
TWOPOINT Endpoint scaling will be done by scaling the entire length of the
curve (from residual/ irreducible saturation to the saturation at
which it attains a maximum), honoring only the minimum/
maximum values of the curve. Capillary pressure is scaled across
the entire range of saturations from minimum to maximum without
consideration of residual values
THREEPOINT Endpoint scaling will also honor the residual values within the table
(for example, the water-oil table will be scaled from irreducible
water saturation to water saturation at residual oil (SWR to SWOR)
and from water saturation at residual oil to the maximum water
saturation (SWOR to SWU)). Capillary pressure scaling occurs
over the following three saturation domains of the input tables: (1)
from the minimum saturation (Swl, Sgl) to residual saturation (Swr,
Sgr), (2) from the residual saturation (Swr, Sgr) to the saturation at
residual of the other phase (Swro, Sgro, Sgrw), (3) from (Swro,
Sgro, Sgrw) to the maximum saturation (Swu, Sgu)
NOCHK The endpoint arrays are checked to make sure that they are
consistent. If NOCHK is specified, the condition Sgu >= 1- Swl,
will not be a FATAL error if it is violated.
Notes:
1. To summarize, the following arrays are available for endpoint scaling: SWL, SWR, SWRO,
SWU (WOTABLE); SGL, SGR, SGRO, SGL (GOTABLE); SGL, SGR, SGRW, SGU
(GWTABLE); and SWLPC, SGLPC (Capillary pressure scaling). See the Array Data Section
for more information.

2. If either of SWLPC or SGLPC are input then the capillary pressure curves, PCWO (SWLPC)
or PCGO/PCGW(SGLPC) will be scaled independently of any relative permeability scaling.
The SWLPC and SGLPC arrays may only be used with two-point scaling. When SWLPC is
entered a SGUPC is calculated (1 – SWLPC). Similarly, when SGLPC is entered SWUPC is
calculated (1 – SGLPC). This is done to maintain consistency, especially during initializa-
tion. To repeat, relative permeability curves are scaled as usual and are not affected by
SWLPC or SGLPC.
Example:
SCALING TWOPOINT

Endpoint Scaling Tabular Output
This feature enables the user to see the impact of endpoint scaling when applied to the generic rel-
ative permeability table input. It is useful as a diagnostic tool, but it will have no impact on the
simulation results. The user may input any number of hypothetical sets of endpoints (saturation
and relative permeability) and the resulting scaled tables will be output in a special file with the
name casename.prstab.
PRSTAB (SWL) (SWLPC) (SWR) (SWRO) (SWU) (SGL) (SGLPC) (SGR) (SGRO) (SGU)
(swl1) (swlpc1)(swr1) (swro1) (swu1) (sgl1) (sglpc1) (sgr1) (sgro1) (sgu1)
(swl2) (swlpc2)(swr2) (swro2) (swu2) (sgl2) (sglpc2) (sgr2) (sgro2) (sgu2)
............
(swln) (swlpcn)(swrn)(swron) (swun) (sgln) (sglpcn)(sgrn)(sgron) (sgun)
Additional Columns
(SGRW) (KRW_SWRO) (KRW_SWU) (KRG_SGRO) (KRG_SGU) (KRO_SWL)(KRO_SWR)

(sgrw1)(krw_swro1)(krw_swu1)(krg_sgro1)(krg_sgu1)(kro_swl1)kro_swr1)
(sgrw2)(krw_swro2)(krw_swu2)(krg_sgro2)(krg_sgu2)(kro_swl2)kro_swr2)
............
(sgrwn)(krw_swron)(krw_swun)(krg_sgron)(krg_sgun)(kro_swln)kro_swrn)
Additional Columns
(KRO_SGL) (KRO_SGR) (KRW_SGL) (KRW_SGR) (KRG_SGRW)

(kro_sgl1) (kro_sgr1) (krw_sgl1) (krw_sgr1) (krg_sgrw1)
(kro_sgl2) (kro_sgr2) (krw_sgl2) (krw_sgr2) (krg_sgrw2)
............
(kro_sgln) (kro_sgrn) (krw_sgln) (krw_sgrn) (krg_sgrwn)
where
PRSTAB Introduces endpoint scaling tabular output parameters.
SWL Header for the lowest water saturation value. Only applicable to
three-phase and water-oil fluid types. This value is not required
and will default to table value.

SWLPC Header for the lowest water saturation value for capillary pressure
situations only. This keyword only affects capillary pressure scaling
and is only applicable to three-phase and water-oil fluid types. May
only be used with two-point scaling. This value is not required and
will default to the table value.
SWR Header for the highest water saturation value where the water
relative permeability is zero. Only applicable to three-phase and
water-oil fluid types. This value is not required and will default to
the table value.
SWRO Header for the water saturation value at residue oil. Only applicable
to three-phase and water-oil fluid types. This value is not required
and will default to the table value.
SWU Header for the maximum water saturation. Only applicable to three-
phase and water-oil fluid types. This value is not required and will
default to the table value.
SGL Header for the lowest gas saturation value (Ordinarily the value is
zero). Only applicable to three-phase and gas-water fluid types.
This value is not required and will default to table value).
SGLPC Header for the lowest gas saturation value for capillary pressure
situations only. Only applicable to three-phase and gas-water fluid
types. This keyword only affects the capillary pressure scaling.
May only be used with two-point scaling. This value is not required
and will default to the table value.
SGR Header for the highest gas saturation value where the gas relative
permeability is zero. Only applicable to three-phase and gas-water
fluid types. This value is not required and will default to the table
value.
SGRO Header for the gas saturation value at residue oil saturation. Only
applicable to three-phase and gas-water fluid types. This value is
not required and will default to the table value.
SGU Header for the maximum gas saturation. Only applicable to three-
phase and gas-water fluid types. This value is not required and will
default to the table value
SGRW Header for the gas saturation at residual water saturation. Only
applicable to gas-water fluid types. This value is not required and
will default to the table value

KRW_SWRO Header for the relative permeability to water at the residual oil
saturation. Only applicable to three-phase and water-oil fluid types.
This value is not required and will default to the table value.
KRW_SWU Header for the relative permeability to water at the maximum water
saturation. Only applicable to three-phase and water-oil fluid types.
KRG_SGRO Header for the relative permeability to gas at the residual oil
saturation. Only applicable to three-phase fluid types. This value is
KRG_SGU Header for the relative permeability to gas at the maximum gas
saturation. Only applicable to three-phase fluid types or gas-water
fluid types. This value is not required and will default to the table
value.
KRO_SWL Header for the relative permeability to oil at the minimum water
saturation. Only applicable to three-phase or water-oil fluid types.
KRO_SWR Header for the relative permeability to oil at the residual water
saturation. Only applicable to three-phase or water-oil fluid types.
KRO_SGL Header for the relative permeability to oil at the minimum gas
saturation. Only applicable to three-phase. This value is not
required and will default to the table value.
KRO_SGR Header for the relative permeability to oil at the residual gas
saturation. Only applicable to three-phase fluid types. This value is
KRW_SGL Header for the relative permeability to water at the minimum gas
saturation. Only applicable to gas-water fluid types. This value is
KRW_SGR Header for the relative permeability to water at the residual gas
KRG_SGRW Header for the relative permeability to gas at the residual water
Notes:
1. All of the endpoint entries are optional. Default values will be taken from the applicable

table.
2. A scaling method must be active. It can be two-point or three-point.
3. This option may not be used with any vertical equilibrium option or any PSEUDO relative
permeability feature.
4. Data checks are made to ensure that the entered saturation and relative-permeability end-
points are monotonic.
5. Neither user-entered hysteresis tables nor gas-dependent water relative permeability tables
are supported
Example:
PRSTAB SWL SWR SWRO SWU KRO_SWL

0.100 0.200 0.600 1.0000 0.55
0.1500 0.250 0.700 0.900 0.65

Vertical Equilibrium Options
The following parameters for Vertical Equilibrium application are entered in the relative perme-
ability method file where it is desired that the option applies. ZCORNER data must be entered for
any of the options.
VEGO (VEGO_PC)
VEWO (VEWO_PC)
DRELPM drpfrc
where:
VEGO Activates gas-oil vertical equilibrium calculations for this relative

permeability method. The default is to not perform these
calculations. If the integer array FVEGO (FRAC) (MATRIX) is
entered any cells with values of 0 will not have gas-oil vertical
equilibrium calculations preformed.
VEWO Activates water-oil vertical equilibrium calculations for this relative

permeability method. The default is to not perform these
calculations. If the integer array FVEWO (FRAC) (MATRIX) is
entered any cells with values of 0 will not have gas-oil vertical
equilibrium calculations preformed.
VEGO_PC Activates gas-oil vertical equilibrium calculations for capillary

pressure only for this relative permeability type. If the integer array
FVEGO (FRAC) (MATRIX) is entered any cells with values of 0
will not have gas-oil capillary pressure calculations performed.
This option is useful for compatibility with the VIP software since
this action is automatically taken in the VIP software when the
capillary pressure is zero.
VEWO_PC Activates water-oil vertical equilibrium calculations for capillary

pressure only for this relative permeability type. If the integer array
FVEWO (FRAC) (MATRIX) is entered any cells with values of 0
will not have water-oil capillary pressure calculations performed.
This option is useful for compatibility with the VIP software since
this action is automatically taken in the VIP software when the
capillary pressure is zero.
DRELPM Specifies that VE calculations performed for vertical connections

will use only a fraction of the cell height as specified by the
mandatory drpfrc value following this keyword. Use of this
keyword activates directional relative permeability calculations and
will only be applied to vertical connections which have the DIR

label of Z. The default is to assign the same relative permeability to

vertical connections as calculated for areal connections.
drpfrc Fraction of cell (from top or bottom as appropriate) to be used for

vertical connection VE calculations.
When VE is defined, FVEGO and FVEWO rock array files modify the behavior of vertical equi-
librium where it is active as follows:
FVEGO Degree of gas-oil VE in each gridblock. One signifies 100% VE

and zero signifies 100% rock values. Valid only if VEGO is
defined. (Fraction between 0 and 1.)
FVEWO Degree of water-oil VE in each gridblock. One signifies 100% VE

and zero signifies 100% rock values. Valid only if VEGO is
defined. (Fraction between 0 and 1.)
The FVEGO and FVEWO arrays allow values of VE to vary by block from 0 to 1. A value of 1
indicates that VE calculations will be made for this cell (if they are called for by the relative per-
meability method). Otherwise, a value of 0 indicates that no VE calculations will be made for this
cell. The result for that cell is the same as if VEGO or VEWO had not been entered in the relative
permeability method.

IFT Adjustment of Capillary Pressure and Gas/Oil Relative

Permeability
EOS type fluid grids may model the adjustment of gas-oil capillary pressure and relative perme-
ability with reduction of interfacial tension.
The relative keywords are:
IFT
TENTHR tenthr
XEX xex
TENI teni
where:
IFT Turns on the option. (Required.)
TENTHR Specifies the threshold interfacial tension for relative permeability

adjustment (dynes/cm, dynes/cm, dynes/cm, dynes/cm). This is not
required. Default is 0.01 dynes/cm.)
XEX Specifies functional exponent used in the adjustment of relative

permeability (Dimensionless). (Not required. Default is 0.25.)
TENI Specifies the reference interfacial used for capillary pressure

adjustment (dynes/cm, dynes/cm, dynes/cm, dynes/cm). Default is
defined as the gas-oil interfacial tension at the gas-oil contact of the
first EOS equilibration region.
In a miscible displacement simulation, some gridblocks of a model may go through a composi-

tional path that leads to the critical point of the hydrocarbon mixture. In a gridblock near the criti-
cal point, when a hydrocarbon mixture splits into two phases, the compositions of the phases are
similar. For this reason, interfacial tension and capillary pressure between the phases become
small and approach zero, the oil and gas residual saturations decrease, and the gas and oil relative
permeability curves approach straight lines near the critical point.
The Nexus® software has a special option that automatically adjusts relative permeabilities and
gas-oil capillary pressure in near-critical blocks. The adjustment correlates these rock properties
to gas-oil interfacial tension as follows:
r S o – S org f ( γ )
k ro = f ( γ )k ro + [ 1 – f ( γ ) ]k m ( S w ) ------------------------------------------
1 – S w – S org f ( γ )

r S g – S gc f ( γ )
k rg = f ( γ )k rg + [ 1 – f ( γ ) ]k m ( S w ) ----------------------------------------
1 – S w – S gc f ( γ )
r γ
P cgo = P cgo --------
γ ref
where kro, krg, Pcgo are the adjusted relative permeabilities to oil, gas, and gas-oil capillary pres-
r r r
sure, respectively; k ro , k rg , P cgo are the nonadjusted respective values as calculated by the Nexus
software from the rock curves; and km(Sw) is the relative permeability to miscible hydrocarbon
fluid near the critical point. This value is a function of water saturation only. Also, Sorg is the
residual oil saturation to gas, γ is the gas-oil interfacial tension, γref is the reference interfacial ten-
r
sion of the gas-oil system on which the capillary pressure rock curve P cgo has been measured,
and f(γ) is a function of the interfacial tension defined as:
e
⎛γ ⎞
f ( γ ) = ⎜ ----*⎟ .
⎝γ ⎠
Here, γ* is the threshold interfacial tension below which the above relative permeability adjust-
ment is used. For interfacial tensions greater than the threshold value, f(γ) is assigned a value of
one. Exponent e is a positive number generally in the range from 0.1 to 0.25.
The relative permeability to miscible hydrocarbon fluid, km(Sw), is defined as the following arith-
metical average:
1 r r
k m ( S w ) = --- [ k ro ( S 0 =1 – S w, S g =0 ) + k rg ( S g =1 – S w, S o =0 ) ]
2
The gas-oil interfacial tension depends on the oil and gas compositions and is calculated from the
correlation:
i=n c
1⁄4
γ = ∑ Pchi ( ρo xi – ρg yi )
i=1
where Pchi is the parachor of component i, and ρo, ρg are molar densities in gram-moles per cubic
centimeter.

Gas-Dependent Water Relative Permeability
This option is useful for intermediate wettability cases. As is done with the oil relative permeabil-
ity, this option causes the water relative permeability to be treated as a function of water and gas
saturations. Additional input data is required through a special gas-water table. Also, a three-
phase model is used to combine the two-phase results. By default, the same three-phase model
(Stone1, Stone2, or Krwint) is used for the water as was designated or defaulted for the oil phase.
Gas-Dependent Water Relative Permeability Table

GDWTABLE
SG KRWG
Sg1 Krwg1
Sg2 Krwg2
. .
. .
Sgn Krwgn
where:
GDWTABLE Introduces data for a gas-dependent water relative permeability

table
KRWG Column heading keyword for water relative permeability to gas.
Notes:
1. The presence of this table activates this option.
2. The option may only be used with three-phase systems.
3. The first value of Sg must be match the Sgl value input in the GOTABLE.
4. The last value of Sg must be greater than or equal to Sgrw. (See Note 5.)
5. The Sgrw is given by the smallest value of Sg for which Krwg is 0.0 (that is, where water
174 Relative Permeability and Capillary Pressure: Gas-Dependent Water Relative Permeability Ta-
becomes immobile).
6. The SG values must be monotonically increasing while the KRWG values must be monoton-
ically decreasing.
7. For endpoint scaling, the only relevant arrays are Sgl (the same value as used for the gas-oil
table) and Krw_sgl.
8. This option may not be combined with the VE or IFT options.
Water Three-Phase Relative Permeability Parameters
If you want to use a different water three-phase relative permeability method than is in effect for
the oil three-phase method, use the following keywords. Otherwise the water three-phase method
will default to the oil three-phase method. (An exception to the preceding statement will occur if
the STONE1 SOMOPT2 option is used for oil. In this case, the water method will default to
STONE1 SOMOPT1 since the swm parameter can not be defaulted.)
STONE1_WAT SWMOPT1
SWMOPT2 swm
or
STONE2_WAT
or
KRWINT
where:
STONE1_WAT Specifies that the Stone 1 method will be used.
STONE2_WAT Specifies that the Stone 2 method will be used. This is the default
unless an oil method is explicitly input in which case the water
method will default to the input oil method.
SWMOPT1 Specifies the three-phase Stone 1 residual water method. This is the
default if STONE1_WAT is specified or defaulted from the oil
method.
R5000.0.1 Relative Permeability and Capillary Pressure: Water Three-Phase Relative Permeability Param-
SWMOPT2 Specifies the three-phase Stone 1 residual water method. This must
be specified or the SWMOPT1 options will be used regardless
which option is used for oil.
swm The three-phase Stone 1 residual water saturation for SWMOPT2.
KRWINT Specifies that the saturation-weighted interpolation three-phase

option will be used.
Examples:
STONE1_WAT
176 Relative Permeability and Capillary Pressure: Water Three-Phase Relative Permeability Pa-
Special Performance-Related Data Options
SPLINE
The following Spline options slightly modify the input relative permeability in order to gain a per-
formance benefit (possibly significant). These options are potentially most useful in cases of
straight-line relative permeability (for example, fracture tables in DUAL data models) or where
the kr-derivatives w.r.t. saturation are unusually high at their residual saturations. With unadjusted
data these cases frequently give rise to severe damping. The Spline options insert new data near
the residual saturations to smoothly reduce the kr-derivatives near the residuals and blend to the
input-data-derivatives at the other end of the inserted data segment.
The Spline keywords are:
USE_SPLINE SGR NSPLINE TOL
SWR
SWRO
SGRO
SGRW
ALL
where:
USE_SPLINE Indicates that the spline option will be active subject to the
keywords to follow. (Required.) One of SGR, SWR, SWRO,
SGRO, SGRW, ALL must follow this keyword.
SGR Turns on the spline option for the SGR region of the GOTABLE or
GWTABLE.
(Required if this is desired)
SWR Turns on the spline option for the SWR region of the WOTABLE.
R5000.0.1 Relative Permeability and Capillary Pressure: SPLINE 177

SWRO Turns on the spline option for the SWRO region of the WOTABLE.
SGRO Turns on the spline option for the SGRO region of the GOTABLE.
SGRW Turns on the spline option for the SGRW region of the GWTABLE.
ALL Turns on the spline option for all of the above.
NSPLINE Number of new data points to be inserted within the region. Applies
to whichever option (SGR, SWR, SWRO, SGRO, SGRW, ALL)
preceded it.
(Default is 20)
TOL Saturation interval to insert new data. Extends from specified

residual (SGR, SWR, SWRO, SGRO, GRW).
(Default is 0.10)
178 Relative Permeability and Capillary Pressure: SPLINE R5000.0.1

Notes:
1. To specify different parameters (NSPLINE or TOL) to individual residuals (SWR, SGR,

SWRO, SGRO, SGRW), use the USE_SPLINE keyword multiple times.
2. The figure below illustrates how the spline points are added.
Original Input Datum Points

kr (1st and 2nd Non-Zero Kr Points)
TOL
Boundary Point
Sr Spline Points
Saturation
A boundary point saturation is determined from the residual saturation, Sr, and the input
TOL. If the boundary point is coincident with the 1st non-zero input point, then the boundary
derivative is taken as the value between the 1st and 2nd non-zero points. Otherwise, the
boundary derivative is that of the line segment between Sr and the 1st point. Once the bound-
ary derivative is known, the boundary kr is determined. A cubic spline is then calculated with
the constraint that the derivative at Sr equals zero and at the boundary point equals the bound-
ary derivative above. In some situations, spline coefficients determined this way will yield a
curve that will pass through negative kr values. Whether this passage through negative kr val-
ues will occur can be predetermined by looking for min/max in the first derivative of the
spline and then checking if, at these saturations, the function is in negative space. When the
curve passes through negative space, the boundary derivative is incrementally reduced until
the problem is eliminated.
3. Certain situations will cause the input TOL values to be modified. First, if the tolerance win-
dow encompasses an existing datum point, then that data point will be honored and the toler-
ance will be reset to be exactly the distance from the residual to that data point. The closest
datum point will control if more than one is within the original window. If the tolerance
exceeds the distance between, say, Sgr and Sgro, then the tolerance is reduced or if both types
of spline options are active, then their values are proportionately reduced. The input and
actual values used are reported in the .rpt output file.
R5000.0.1 Relative Permeability and Capillary Pressure: SPLINE 179

4. This option is not currently available for the gas-dependent water relative permeability option
nor for any hysteresis tables.
Example:
The original data:
GOTABLE
SG KROG KRG PCGO
0.010000 1.000000 0.000000 0.00000
0.999000 0.000000 0.999000 0.00000
1.000000 0.000000 1.000000 0.00000
USE_SPLINE SGR TOL 0.30

USE_SPLINE SGRO TOL 0.10
180 Relative Permeability and Capillary Pressure: SPLINE R5000.0.1

Capillary Pressure Freeze Options
This option will hold constant (freeze) the desired capillary pressures of a given method at the
values in effect when the option is activated. Usually, this will be at initialization, but the option
can be invoked or deactivated at anytime. The user is cautioned that this option could cause the
results to be substantially different from those without the option active. However, past experi-
ence has shown that there are cases where the results are only minimally impacted, yet the time-
stepping performance is dramatically enhanced.
The Capillary Freeze keywords are:
FREEZE_PCGO
FREEZE_PCWO
FREEZE_PCGW
where:
FREEZE_PCGO Turns on the freeze option for the GOTABLE. (Required.)
FREEZE_PCWO Turns on the freeze option for the WOTABLE. (Required.)
FREEZE_PCGW Turns on the freeze option for the GWTABLE. (Required.)
Notes:
1. To invoke this option at a time other than initialization, the user must edit the target relative
permeability method file and invoke the edited file from the case file at the time of a restart.
The user can deactivate the option by reversing the edits in the invoked method file. It is rec-
ommended that the file name be changed when this is done to avoid confusion.
R5000.0.1 Relative Permeability and Capillary Pressure: Capillary Pressure Freeze Options 181
182 Relative Permeability and Capillary Pressure: Capillary Pressure Freeze Options R5000.0.1
Rock Properties
In This Chapter
• Rock compressibility data
• Pressure-dependent permeability multipliers
• Rock compaction tabular data
• Rock compaction options (specified by method)
• Water-induced rock compaction tabular data
• Water-induced rock compaction options (specified by method)
• Coordination of rock options
• Calculation details
• Output information available
All the data for a rock property method is input in a single file. Rock property files are included
in a case in the ROCK_FILES section as follows:
ROCK_FILES
ROCK method 1 filename1
ROCK method 2 filename2
....
The rock property method to be used by each cell is specified in the PROPERTY_FILES section
of the case file using the IROCK keyword. By default, all cells use method 1.
R5000.0.1 Rock Properties: In This Chapter 183

Rock Compressibility Data
CR cr or COMPR
PREF pref
where:
CR Introduces the rock compressibility (psia-1, kPa-1, (Kg/cm2)-1, bars-

1, psia-1).
COMPR Indicates that the values used for rock compressibility will be
obtained from the value given in the COMPR array (Input in the
PROPERTY_FILES section of the case file) for each cell.
PREF Introduces the reference pressure (psia, kPa, Kg/cm2, bars, psia).
Notes:
Alternatively, rock compressibility can be entered through the pore volume multiplier (PVMULT)
column of the compaction Table (CMT) described below. Either CR or COMPR may be used
while the PVMULT column of a CMT table is active.
Examples:
CR 3.0E-6 PREF 2000.0

COMPR PREF 2000.0
184 Rock Properties: Rock Compressibility Data R5000.0.1

Pressure-Dependent Permeability Multipliers
KP kp or KPMULT
PREF pref
where:
KP Introduces the rock permeability-compressibility (psia-1, kPa-1,

(Kg/cm2)-1, bars-1, psia-1).
KPMULT Indicates that the values used for permeability multipliers will be
obtained from the value given in the KPMULT array (input in the
PROPERTY_FILES section of the case file) for each cell.
PREF Introduces the reference pressure (psia, kPa, Kg/cm2, bars, psia).
This is the same reference used for CR options (only enter if not
already entered).
Notes:
The permeability multipliers are applied to the interblock transmissibility and well KH. Technical
details are provided below.
Alternatively, the equivalent transmissibility multipliers can be entered through (TAMULT) col-
umn of the compaction table (CMT) described below. Neither KP nor KPMULT may be used
while the TAMULT column of a CMT table is active.
Examples:
KP 3.0E-3 PREF 2000.0
KPMULT PREF 2000.0
R5000.0.1 Rock Properties: Pressure-Dependent Permeability Multipliers 185

Rock Compaction Tabular Data
Pore volume and transmissibility multipliers may be entered as a function of pressure using the
format:
CMT
P PVMULT TAMULT
p1 pvmult1 tamult1
p2 pvmult2 tamult2
.
.
pn pvmultn tamultn
(At least two rows of data are required.)
where:
CMT Introduces data for a compaction table.
P Column heading keyword for pressure (psia, kPa, Kg/cm2, bars,

psia).
PVMULT Column heading keyword for pore volume multiplier (psia-1, kPa-1,
(Kg/cm2)-1, bars-1, psia-1).
TAMULT Column heading keyword for transmissibility multiplier (psia-1,

kPa-1, (Kg/cm2)-1, bars-1, psia-1).
(P values must be greater than zero and increasing.)
186 Rock Properties: Rock Compaction Tabular Data R5000.0.1

Rock Compaction Options (Specified by Method)
The following keywords activate options for determination of pore-volume and transmissibility
multipliers:
REVERSIBLE (CMT)
IRREVERSIBLE (CMT)
TOLREV_P
CR_REPRESSURE
KP_REPRESSURE
REVERSIBLE Specifies that the tabular pressure lookup is based on the current
gridblock pressure. Use of REVERSIBLE by itself will also set this
option for any WIRCT tables that are active within this method
(See below for default).
REVERSIBLE CMT Specifies that the tabular pressure lookup is based on the current
gridblock pressure. Use of CMT signifies that this option does not
apply to any WIRCT tables that are active within this method (See
below for default).
IRREVERSIBLE Specifies that the tabular pressure lookup is based on the historical
minimum gridblock pressure. (This is the default.) Use of
IRREVERSIBLE by itself will also set this option for any WIRCT
tables that are active within this method.
IRREVERSIBLE CMT Specifies that the tabular pressure lookup is based on the historical
minimum gridblock pressure. Use of CMT signifies that this option
does not apply to any WIRCT tables that are active within this
method.
TOLREV_P Tolerance pressure for determining whether enough

repressurization has occurred to switch to the repressurization
branch when the IRREVERSIBLE option is in effect (psia, kPa,
Kg/cm2, bars, psia). Default is 5 psia.
CR_REPRESSURE Rock compressibility used while on repressurization branch (psia-1,

kPa-1, (Kg/cm2)-1, bars-1, psia-1). Default is 0 psia-1.
KP_REPRESSURE Rock permeability compressibility used while on repressurization

branch (psia-1, kPa-1, (Kg/cm2)-1, bars-1, psia-1). Default is 0 psia-1.
R5000.0.1 Rock Properties: Rock Compaction Options (Specified by Method) 187

Water-Induced Rock Compaction Tabular Data
Pore volume and transmissibility multipliers may be entered using the format outlined below.
Note that the multipliers are supplied as a series of tables with each pertaining to a given initial
cell water saturation. Within each table the multipliers are entered as function of change-from-
initial water saturation.
WIRCT
SWINIT swinit1
DSW PVMULT TAMULT
dsw11 pvmult11 tamult11
. . .
. . .
dsw1n pvmult1n tamult1n
SWINIT swinit2
DSW PVMULT TAMULT
. . .
. . .
dsw2n pvmult2n tamult2n
SWINIT swinitm
DSW PVMULT TAMULT
dswm1 pvmultm1 tamultm1
dswm2 pvmultm2 tamultm2
. . .
. . .
dswmn pvmultmn tamultmn
(At least two rows of data per SWINIT are required.)
where:
WIRCT Introduces data for a water-induced compaction table.
SWINIT Introduces data for initial water saturation.
DSW Column heading keyword for water saturation.
188 Rock Properties: Water-Induced Rock Compaction Tabular Data R5000.0.1

PVMULT Column heading keyword for pore volume multiplier

(dimensionless).
TAMULT Column heading keyword for transmissibility multiplier

(dimensionless).
Notes:
1. There need not be more than one initial water saturation table, but multiple tables must be
provided in increasing initial water saturation.
2. For any given initial water saturation there must be a least two data rows.
3. DSW values must be greater than zero and increasing.
4. The first row of data must have DSW = 0 and the multipliers equal to 1.
R5000.0.1 Rock Properties: Water-Induced Rock Compaction Tabular Data 189

Water-Induced Rock Compaction Options (Specified by

Method)
The following keywords activate options for determination of pore-volume and transmissibility
multipliers:
REVERSIBLE (WIRCT)
IRREVERSIBLE (WIRCT)
REVERSIBLE Specifies that the tabular water-induced rock compaction lookup is

based on the current water saturation and the initial water saturation
only. Use of REVERSIBLE by itself will also set this option for any
CMT tables that are active within this method. (The default is
IRREVERSIBLE.)
REVERSIBLE WIRCT Specifies that the tabular water-induced rock compaction lookup is
based on the current water saturation and the initial water saturation
only. Use of WIRCT signifies that this option does not apply to any
CMT tables that are active within this method. (The default is
IRREVERSIBLE.)
IRREVERSIBLE Specifies that the tabular water-induced rock compaction lookup is

based on the historical maximum gridblock water saturation and the
initial water saturation only. (This is the default.) Use of
IRREVERSIBLE by itself will also set this option for any CMT
tables that are active within this method.
IRREVERSIBLE WIRCT Specifies that the tabular water-induced rock compaction lookup is
based on the historical maximum gridblock water saturation and the
initial water saturation only. Use of WIRCT signifies that this
option does not apply to any CMT tables that are active within this
method.
TOLREV_SW Tolerance water saturation for determining whether enough

reduction in water saturation has occurred to switch to the
desaturation branch when the IRREVERSIBLE option is in effect.
Default is 0.
190 Rock Properties: Water-Induced Rock Compaction Options (Specified by Method) R5000.0.1
Coordination of Rock Options
In summary, a rock method may simultaneously have the following: pressure-based pore vol-
ume adjustment (CR or COMPR and CMT(PVMULT)); one type of pressure-based permeability/
transmissibility adjustment (KP or KPMULT or CMT(TAMULT)); a water-induced pore volume
and transmissibility adjustment. Note also that reversibility is specified by rock method and may
be different for the CMT and WIRCT tables.
Rules for Combining Options
At least one rock method must be specified.
Within the method files, the following rules must be observed.
Rules for Pore Volume Multiplier
1. The following possibilities exist for Pore volume multipliers: CR, COMPR,
CMT(PVMULT), WIRCT(PVMULT).
2. Only the following combinations are allowed:
a. CR
b. COMPR
c. CR and CMT(PVMULT)
d. COMPR and CMT(PVMULT)
e. CMT(PVMULT)
f. WIRCT(PVMULT)
g. CMT(PVMULT) + WIRCT(PVMULT)
h. CR + CMT(PVMULT) + WIRCT(PVMULT)
i. COMPR and CMT(PVMULT) + WIRCT(PVMULT)
Notes:
The result of combinations c, d, g, h and i are multiplicative. That is, the effective pore volume
multiplier is the product of however many multipliers result from the data entered.
Unlike the transmissibility multipliers below, one of the above options must be used.
R5000.0.1 Rock Properties: Rules for Combining Options Coordination of Rock Options 191
Rules for Transmissibility Multipliers
1. The following possibilities exist for Trans multipliers: KP KPMULT CMT(TAMULT)

WIRCT(TAMULT)
2. Only the following combinations are allowed:
a. Use of none of these
b. KP
c. KPMULT
d. CMT(TAMULT)
e. WIRCT(TAMULT)
f. KP and WIRCT(TAMULT)
g. KPMULT and WIRCT(TAMULT)
Notes:
CMT(TAMULT) is not allowed with KP or KPMULT.
In the case of combinations f and g, the factors applied are described in the following section
(“Calculation Details” ).
192 Rock Properties: Rules for Combining Options Coordination of Rock Options R5000.0.1
Calculation Details
Pore Volume Adjustment
The pore volume may be modified by a pressure-dependent factor, MPi, and a water saturation dependent factor,
MSWi
o
PV i = PV i ⋅ M Pi ⋅ M SWi ,
o
where PV i is the i-th cell's resulting pore volume and PV i is the specified reference cell volume.
The multipliers default to 1 if not applicable to a given case. When using a constant or spatial
varying cr, the formula is:
M Pi = 1 + cr i ⋅ ( P i – P refi )
where P i is the current gridblock pressure and – P refi is the gridblock reference pressure.
If pressure-dependent compaction tables are in effect:
For reversible cases,
M Pi = CMT { P i }
where CMT { P i } signifies an evaluation of the compaction table at a pressure P i
For irreversible cases,
M Pi = CMT { P i }
when P i – P tolrev ≤ P mini
Where Ptolrev is a user controllable tolerance and Pmini is the historic minimum gridblock pres-
sure,
and when P- Ptolrev > Pmini
M Pi = [ 1 + cr repressure ⋅ ( P i – P mini – P tolrev ) ] ⋅ CMT { P mini – P tolrev }
Where cr repressure is a user controllable repressurization compressibility and
R5000.0.1 Rock Properties: Rules for Combining Options Calculation Details 193
CMT { P mini – P tolrev } is an evaluation of the compaction table at a pressure { P mini – P tolrev } .
If water-induced compaction tables are in effect:
M Swi = WIRTC { S wi – S winnit }
where WIRTC { S wi – S winnit } is an evaluation of the water-induced compaction tables at

S wi – S winnit , where S wi is the current gridblock water saturation and S winnit is the initial water
saturation.
M Swi = WIRTC { S wi – S winnit }
when S wi + S wtolrev ≥ S wmaxi , where S wtolrev is a user controllable tolerance and S wmaxi is the
historic maximum gridblock water saturation,
and when S wi + S wtolrev < S wmaxi then
M Swi = WIRTC { S wmaxi – S wtolrev – S winnit }
194 Rock Properties: Rules for Combining Options Calculation Details R5000.0.1
Transmissibility and Well KH Adjustment
The ij-th interblock connection transmissibility, FTRij may be modified by block pressure depen-
dent factors TPi, TPj or a water saturation dependent factor TSwi, TSwj.
o T Pi ⋅ T Swi + T Pj ⋅ T Swj
. FTR ij = FTRij ⋅ ----------------------------------------------------
2
o
where FTR ij is the input reference interblock transmissibility. Similarly, perforation KH values
in block “i” are adjusted according to the formula,
o
KH i = KH i ⋅ T Pi ⋅ T Swi
o
where, KH i is the unadjusted input KH value for the i-th perforation. The multipliers default to 1
if not applicable to a given case.
T pi = CMT { p i }
where CMT { p i } signifies an evaluation of the compaction table at a pressure p i .
T pi = CMT { p i }
when P i – P tolrev ≤ P mini
where – P tolrev is a user controllable tolerance and P mini is the historic minimum gridblock pres-
sure,
and when P i – P tolrev > P mini
T Pi = [ 1 + kp repressure ⋅ ( P i – P mini – P tolrev ) ] ⋅ CMT { P mini – P tolrev }
Where kp repressure is a user controllable repressurization compressibility and

CMT { P mini – P tolrev } is an evaluation of the compaction table at a pressure P mini – P tolrev .
If water-induced compaction tables are in effect:
T Swi = WIRTC { S wi – S winnit }
Where WIRTC { S wi – S winnit } is an evaluation of the water-induced compaction tables at

S wi – S winnit , where S wi is the current gridblock water saturation and S winnit is the initial water
saturation.
T Swi = WIRTC { S wi – S winnit }
when S wi + S wtolrev ≥ S wmaxi , where S wtolrev is a user controllable tolerance and S wmaxi is the historic max-
imum gridblock water saturation,
and when S wi + S wtolrev < S wmaxi then
T Swi = WIRTC { S wmaxi – S wtolrev – S winnit }
196 Rock Properties: Rules for Combining Options Calculation Details R5000.0.1
Implicitness of Calculations
Interblock transmissibility adjustment (Pressure and water saturation) is done explicitly for
IMPES and is fully implicit for IMPLICIT. Well KH adjustment is treated implicitly for both
solution methods.
Output Information Available
The pore volume multipliers described above for pressure and water saturation may be viewed as
output arrays. (See run control section of this manual, PVMLT P SW.) Permeability multipliers
are similarly available. (See KMCMT P SW.)
198 Rock Properties: Rules for Combining Options Output Information Available R5000.0.1
Equilibration Data
In This Chapter
• Basic Datum Initialization data.
• Integrated Saturation Initialization Options (INTSAT)
• Black-Oil variation with depth.
• Oil- and Gas-Zone Composition (Single Input Anchor-Point)
• Compositional Variation with Depth (Multiple Input Anchor Points)
• Supercritical Initialization
• Saturation and Pressure Overreads
• Equilibration examples
All the data for a equilibration method is input in a single file. Equilibration files are included in
a case in the INITIALIZATION_FILES section as follows:
EQUIL method 1 filename1
EQUIL method 2 filename2
....
The equilibration method to be used by each cell is specified in the PROPERTY_FILES section
of the case file using the IEQUIL keyword. By default, all cells use method 1.
Very detailed initialization reports are available using the OUTSTART and/or DEBUG reports
described in the “Run Control” on page 227.
R5000.0.1 Equilibration Data: In This Chapter 199

Basic Datum Initialization
The basic datum initialization data are specified as follows :
PINIT pinit
DINIT dinit
TINIT tinit
GOC goc
WOC woc
PCGOC pcgoc
PCWOC pcwoc
PSAT psat
API api
GWC gwc
PCGWC pcgwc
(SALINITY) (salinity)
where:
PINIT Introduces the initial pressure at datum depth (psia, kPa,

Kg/cm2, bars, psia). If the GOC depth is specified and within the
reservoir or within 100 feet of reservoir midpoint, then this data is
ignored, and pinit is set to psat. An exception to this is when the
CRINIT option is used where the GOC depth is used as an initial
estimate for the undersaturated GOC condition.
DINIT Introduces the datum depth (ft, m, m, cm). If the GOC depth is
specified, then this data is ignored, and dinit is set to goc.
TINIT TINIT Sets the temperature of the equilibrium region to the

equilibrium value. (degrees F, degrees C, degrees C, degrees C)
GOC Introduces the depth of the gas-oil contact (ft, m, m, cm). Program
can be made to search for GOC. See notes below.
WOC Introduces the depth of the water-oil contact (ft, m, m, cm).

Required.
PCGOC Introduces the gas-oil capillary pressure at the gas-oil contact (psia,
kPa, Kg/cm2, bars, psia). Default: 0
PCWOC Introduces the water-oil capillary pressure at the water-oil contact

(psia, kPa, Kg/cm2, bars, psia). Default: 0
PSAT Introduces the saturation pressure at the gas-oil contact, or

throughout the oil column of no GOC is specified (psia, kPa,
200 Equilibration Data: Basic Datum Initialization R5000.0.1

Kg/cm2, bars, psia). This is not used if a DEPTHVAR table is

specified. Default: pinit
INTSAT Specifies that the integrated saturation initialization algorithm will

be used. In this case, the initial saturations are calculated based
upon the actual fluid distribution throughout the gridblock, by
integrating the capillary pressure on the block thickness. Default:
Grid block center initialization
API Introduces the API gravity of the oil at the gas-oil contact. This is
not used if a DEPTHVAR table is used (API units).
GWC Introduces the depth of the gas-water contact. Used for

GASWATER PVT type fluid regions (ft, m, m, cm).
Default: 0.
PCGWC Introduces the gas-water capillary pressure at the gas-water contact.

Used for GASWATER PVT type fluid regions (psia, kPa, Kg/cm2,
bars, psia).
Default: 0.
(SALINITY) Column heading keyword for salinity Units are the choice of the
user as long as they are consistent. (optional).
Notes:
1. If there is no gas-oil contact present, then the datum depth can be specified anywhere within
the oil column or water zone. If the datum depth is within the water zone, then pinit is inter-
preted as water pressure.
2. If the gas-oil contact is the same as the water-oil contact, then the datum depth may be any-
where in the water zone or gas zone. In this case, pinit is interpreted as water pressure in the
water zone, or gas pressure in the gas zone.
3. If DINIT is in the water ZONE then PSAT must be specified.
4. If the input GOC is more than 5000 feet above the top of the formation, a theoretical GOC
equal to a depth 5000 feet above the formation will be used.
5. Omission of GOC data will cause the program to search for the condition at which pressure =
PSAT. If that search results in a GOC within the reservoir, then the program will adopt that
GOC and proceed as though it had been entered with usual consequences related to PSAT,
GOC and DINIT.
6. Specification of GOC above the reservoir (and at least within 100 feet above midpoint) will
cause adjustment of PSAT within the reservoir if P falls below PSAT.
R5000.0.1 Equilibration Data: Basic Datum Initialization 201

Examples:
PINT 3600 DINIT 9035 GOC 8800 WOC 9950 PSAT 3600
202 Equilibration Data: Basic Datum Initialization R5000.0.1

Integrated Saturation Initialization Options (INTSAT)
The integrated saturation initialization option is specified as follows:
INTSAT (MOBILE) (SORWMN sorwmn) (SORGMN sorgmn) (SGCMN sgcmn)
where:
INTSAT Activates the “integrated saturation option. This method averages

capillary pressure vs. saturation lookup over grid block depth. The
Default is to use grid block center for inverse table lookup.
Options:
MOBILE Optional keyword to activate the ‘Mobile Fluid Correc-

tion’ option.
SORWMN Optional keyword introducing a minimum calcu-
lated value of oil residual to water.
SORGMN Optional keyword introducing a minimum calcu-
lated value of oil residual to gas.
SGCMN Optional keyword introducing a minimum calcu-
lated critical gas saturation.
Note: The calculation of mobile oil is not accurate when gas-oil contacts are present and the gas-
oil transition zone thicknesses are not negligible compared to the gridblock thickness.
Therefore, the option is only applicable to cases of small or zero gas-oil capillary pressure
when gas-oil contacts are present.
R5000.0.1 Equilibration Data: Integrated Saturation Initialization Options (INTSAT) 203

Black Oil Variation with Depth
Black Oil variation with depth are specified as follows:
DEPTHVAR
DEPTH PSAT (TEMP) (API) (SALINITY)
depth1 psat1 (temp1) (API1) (salinity1)
depth2 psat2 (temp2) (API2) (salinity2)
. . . . .
. . . . .
depthn psatn (tempn) (APIn) (salinity3)
where:
DEPTH Column heading keyword for depth. Depths must be

monotonically increasing (ft, m, m, cm).
PSAT Column heading keyword for saturation pressure (psia, kPa,

Kg/cm2, bars, psia).
(TEMP) Column heading for reservoir temperature (F, C, C, C, C)

(optional).
(API) Column heading keyword for API gravity (API Units).
(SALINITY) Column heading keyword for salinity Units are the choice of the
user as long as they are consistent. (optional)
Notes:
1. Only valid for black oil runs.
2. The API input is only used with the API fluid option.
Examples:
DEPTHVAR
DEPTH PSAT
2000.0 1000.0
2500.0 1175.0
3000.0 1200.0
204 Equilibration Data: Black Oil Variation with Depth R5000.0.1

Oil- and Gas-Zone Composition (Single Input Anchor-Point)
Initial oil- and gas- zone composition using a single input composition is specified as follows:
OILMF
cpt1 cpt2 ..... cptnc
x1 x2 ...... xnc
or
GASMF
cpt1 cpt2 ..... cptnc
y1 y2 ........ ync
SEDIMENTATION
MATCHVIPPRES
NOMATCHVIPPRES
where:
OILMF Sets oil as the primary phase for initialization purposes, and
introduces the initial oil phase composition.
GASMF Sets gas as the primary phase for initialization purposes, and
introduces the initial gas phase composition.
cpti Component name
xi Liquid (oil) phase mole fractions.
yi Gas phase mole fractions.
SEDIMENTATION Specifies that the Gibbs Sedimentation methodology will be used to

calculate compositional variation with depth depth (> ~100 ft.).
This option can produce significant compositional variation if the
depth variation of a reservoir is appreciable.
MATCHVIPPRES Adopts VIP® assumptions for phase compositions during phase

pressure vs. depth table construction. Results in closer pressure
match when compared to initializations from the VIP software .
NOMATCHVIPPRES Adopts the same compositional assumptions during table build as

are applied later during gridblock composition assignment. Results
in discrepancies when compared to the VIP software, but may
reduce non-equilibrium potentials after initialization. This is the
default.
R5000.0.1 Equilibration Data: Oil- and Gas-Zone Composition (Single Input Anchor-Point) 205
Notes:
1. Only one of OILMF or GASMF may be entered. The choice of OILMF or GASMF is a mat-
ter of convenience since the program will determine the incipient composition of the phase
not input as it is necessary as described in note 2 below.
2. If SEDIMENTATION is NOT specified, the initial compositions will be uniform, except in

the following situations:
a. In a oil-gas transition-zone, gas- and oil- phase compositions will vary. Their
compositions are determined by flashing (at the gridblock pressure and temperature)
either the input GASMF composition or the incipient gas composition if OILMF is
provided.
b. Above a GWC, if for the input GASMF composition or the incipient gas composition
(OILMF input) a gridblock’s pressure would be less than its saturation pressure then its
actual composition is determined by flash. That is, the input GASMF or incipient gas
(OILMF) composition is flashed at gridblock pressure and temperature.
c. In the oil zone, (below the GOC) oil composition will vary so that the gridblock pressure
does not fall below the saturation pressure. The required oil composition is determined
by flashing the OILMF composition or the incipient liquid (GASMF) composition at
gridblock pressure and temperature.
Examples:
OILMF
P1 P2 P3 P4 P5
0.5627000E+00 0.2429000E+00 0.9667200E-01 0.8423200E-01 0.1349600E-01
206 Equilibration Data: Oil- and Gas-Zone Composition (Single Input Anchor-Point) R5000.0.1
Compositional Variation with Depth (Multiple Input Anchor

Points)
Composition as a function of depth is specified as follows:
COMPOSITION
DEPTH PSAT (TEMP) cpt1 ... cptn (SALINITY)
d1 ps1 (t1) z1,1 …… z1,nc (salinity1)
. . . . . .
. . . . . .
dn psn (tn) zn,1 …… zn,nc (salinity2)
where:
COMPOSITION Introduces the table.
DEPTH Column heading for depth (ft, m, m, cm).
PSAT Column heading for saturation pressure (psia, kPa, Kg/cm2, bars,
psia).
(TEMP) Column heading for reservoir temperature (F,C,C,C) (optional).
cpti Column heading for mole fraction of component i. cpti is the

component name.
(SALINITY) Column heading keyword for salinity. Units are the choice of the
user as long as they are consistent. (optional)
Notes:
1. The TEMP column is optional. The default temperature units are Rankine for ENGLISH
units, and Kelvin for all other unit systems.
2. PSAT is an initial estimate of the saturation pressure.
3. Compositions for depths above the GOC are gas phase compositions. Compositions at or
below the GOC are oil phase compositions.
4. If a gas-oil contact is present in the reservoir, there must be an entry at the gas-oil contact
depth unless one of the AUTOGOC_COMP options other that NONE (described below) is
active. If CRINIT (Supercritical Option) is active then a simple interpolation is performed
automatically and AUTOGOC_COMP is neither required nor used.
Example:
COMPOSITION
R5000.0.1Equilibration Data: Compositional Variation with Depth (Multiple Input Anchor Points) 207
DEPTH PSAT P1 P2 P3 P4 P5
8000 4162.31 0.65017616 0.22628505 0.07745331 0.04386671 0.00221875
8500 4343.34 0.61013746 0.23568379 0.08750492 0.06114384 0.00552997
8600 4371.29 0.59902413 0.23777305 0.08994521 0.06632521 0.00693238
8700 4390.07 0.58689589 0.23978295 0.09241198 0.07214558 0.00876357
The following options are available to automatically generate a table value at the GOC depth:
AUTOGOC_COMP USE_CLOSEST_OIL
EXTRAPOLATE_OIL
USE_CLOSEST_GAS
EXTRAPOLATE_GAS
NONE
where:
AUTOGOC_COMP Introduces one of the options.
USE_CLOSEST_OIL Establishes as the GOC composition the component values at the

closest depth below the GOC contact.
EXTRAPOLATE_OIL Establishes the GOC composition by extrapolating the component

composition at the two closest depths below the GOC contact.
USE_CLOSEST_GAS First determines the gas composition and the GOC by using the
component values at the closest depth above the GOC contact.
Then, establishes the oil GOC composition by performing a PSAT
calculation and using the incipient oil phase composition.
EXTRAPOLATE_GAS First determines the gas composition by extrapolating the

component compositions at the two closest depths above the GOC
contact. Then, establishes the oil GOC composition by performing
a PSAT calculation and using the incipient oil phase composition.
NONE Performs no automatic GOC composition generation (Default).
Notes:
1. The USE_CLOSEST_OIL and EXTRAPOLATE_OIL options are performed in Standalone

and reported in the output of Standalone.
2. The USE_CLOSEST_GAS and EXTRAPOLATE_GAS options are performed by the Simu-

lator since they require a PSAT calculation and knowing the applicable PVT method of which
there may be more than one per defined equilibrium method. The results of these determina-
tions are output as an Augmented Composition Table in the .out file.
3. Extrapolations which generate negative compositions cause a reset to the USE_CLOSEST

method.
208 Equilibration Data: Compositional Variation with Depth (Multiple Input Anchor Points)
4. Options selected where insufficient data relative to the GOC exist default to another method
or terminate the run as appropriate.
5. Supercritical cases where the GOC depth (undersatured; Tres = Tcrit) is missing automati-
cally generate the data by interpolation using the surrounding compositions except at the
extremes where the closest composition is used. Those cases do not use the
AUTOGOC_COMP keywords.
6. The user is warned that the options may result in dramatically different results depending on
the spacing of their data. One should always inspect the results of the automatic GOC compo-
sition generation and consider using one of the other methods if not satisfactory.
R5000.0.1Equilibration Data: Compositional Variation with Depth (Multiple Input Anchor Points) 209
Supercritical Initialization
This term applies to situations where the fluid type transitions with increasing depth from an
undersaturated gas to an undersaturated liquid . No classic GOC occurs because the reservoir
pressure always exceeds the saturation. There is, however, an ‘undersaturated’ GOC condition
above which the fluid exhibits a dew point and below which a bubble point. At this undersaturated
GOC the reservoir temperature equals the mixture’s critical temperature and the reservoir pres-
sure exceeds the critical pressure.
The supercritical initialization option is invoked by the keyword:
CRINIT
Notes:
1. The CRINIT option must be used with the COMPOSITION data or with the SEDIMENTA-
TION option.
2. The program will terminate if a saturated GOC is found when CRINIT is in effect.
210 Equilibration Data: Supercritical Initialization R5000.0.1

Saturation and Pressure Overreads
Overreading of the saturations and pressures is enabled as follows:
OVERREAD PRESSURE
SW
SG
NONEQ
where:
OVERREAD Introduces the properties which may be overread (psia, kPa,

PRESSURE Specifies that pressures may be overread .
SW Specifies that water saturations may be overread.
SG Specifies that gas saturations may be overread.
NONEQ Specifies that no capillary pressure adjustment will be applied

due to any non-equilibrium effects introduced by any overread data.
Without this keyword, any non-equilibrium effects introduced by
overread data are nullified by a capillary pressure adjustment
determined on a gridblock basis. Warning: the capillary adjustment
is applied at initialization and for the entire length of a run. If only
PRESSURE is overread no capillary pressure adjustment will be
constructed regardless of the NONEQ card.
Notes:
1. If overread data are present, then after performing equilibration, any pressures and or satura-
tions input as an array will replace the calculated values. If no pressure or saturation arrays
are input, then this has no effect.
2. Either or both Sw and Sg may be overread.
3. If Sw only is overread the following rules apply where ‘*’ indicates ‘overread’ data and ‘+’ is
capillary-gravity-equilibrium-based result:
• Sw = Sw*
• If (1 – Sw*) <= Sg+ , then Sg = (1 – Sw*) and So = 0.
• If (1 – Sw*) > Sg+ , then Sg = Sg+ and So = (1 – Sw* - Sg+).
R5000.0.1 Equilibration Data: Saturation and Pressure Overreads 211

4. Similarly, if only Sg is overread the following rules apply where ‘*’ indicates ‘overread’ data
and ‘+’ is capillary-gravity-equilibrium-based result:
• Sg = Sg*
• If (1 – Sg*) <= Sw+ , then Sw = (1 – Sg*) and So = 0.
• If (1 – Sg*) > Sw+ , then Sw = Sw+ and So = (1 – Sg* - Sw+).
Examples:
OVERREAD PRESSURE
212 Equilibration Data: Saturation and Pressure Overreads R5000.0.1

Equilibration examples
Example 1. Compositional equilibration using single anchor point
PINIT 3550 DINIT 7500 GOC 7500 WOC 7500

PCGOC 0 PCWOC 0 PSAT 3400
GASMF
P1 P2 P3 P4 P5 P6 P7
0.679300 0.099000 0.110800 0.045000 0.052966 0.011941 0.000993
Example 2. Compositional equilibration with compositional variation with depth
COMPOSITION
DEPTH PSAT P1 P2 P3 P4 P5 P6 P7
7300.0 3416.79 0.680597 0.098991 0.110558 0.044760 0.052486 0.011698 0.000909
7350.0 3443.80 0.679300 0.099000 0.110800 0.045000 0.052966 0.011941 0.000993
7400.0 3443.80 0.679300 0.099000 0.110800 0.045000 0.052966 0.011941 0.000993
7450.0 3437.02 0.679613 0.098998 0.110742 0.044943 0.052851 0.011882 0.000971
7500.0 3400.00 0.679300 0.099000 0.110800 0.045000 0.052966 0.011941 0.000993
PINIT 3550 DINIT 7500 GOC 7500 WOC 7500 PCGOC 0 PCWOC 0 PSAT 3400
R5000.0.1 Equilibration Data: Equilibration examples 213

214 Equilibration Data: Equilibration examples R5000.0.1

Tracer Initialization
In This Chapter
• Tracer initialization by depth table.
The tracer initialization method can be used to assign concentrations to gridblocks through use of
a concentration versus depth table. The simulator uses the midpoint depth of the gridblock to per-
form a table look-up. Concentration values are linearly interpolated from the table. This can be
used instead of specifying the concentration on a gridblock-by-gridlbock basis in a CONCEN-
TRATION array. However, gridblocks will retain the value provided by the CONCENTRATION
array if the concentration in the array is greater than 0.
Each set of tracer initialization data is entered in a data file that is grouped under the
INITIALIZATION_FILES section as follows:
TRACER_INIT method 1 filename1
TRACER_INIT method 2 filename2
....
The TRACER_INIT method to be used by each cell is specified in the PROPERTY_FILES sec-
tion of the case file using the ITRACER keyword. By default, all cells use method 1.
Salinity input (which is a SALT tracer attached to the WATER component) cannot be input with
the TRACER_INIT tables. Depth versus salinity input can be input as a column in the DEPTH-
VAR table for black oil cases, or the COMPOSITIONAL table for equation of state cases.
R5000.0.1 Tracer Initialization: In This Chapter 215

Tracer Initialization with Depth
Tracer concentration versus depth data is specified as shown below:
COMPONENT component_name
DEPTH tracer_name1 tracer_name2…
depth1 conc11 conc21 …
depth2 conc12 conc22 …
….
where:
COMPONENT This is the component name.
DEPTH Column heading for depth (feet, m, m, m, cm)
tracer_name1 Column heading for tracer concentration.
conc Concentration of tracer at depth.
Notes:
1. Each depth entry must be greater than or equal to the previous depth entry.
2. The sum of concentrations must be less than or equal to 1.
3. A table should be input for every component which has tracers.
4. Salinity cannot be input in this table.
Example:
COMPONENT C1
DEPTH TRACER1 TRACER2
2000.0 0.1 0.05
2500.0 0.11 0.03
3000.0 0.15 0.01
COMPONENT C2
DEPTH TRACER1
2000.0 1.0
2500.0 1.0
3000.0 1.0
216 Tracer Initialization: Tracer Initialization with Depth R5000.0.1

Aquifer Data
In This Chapter
• Carter-Tracy Analytic Aquifer Parameters.
• Fetkovich Analytic Aquifer Parameters.
• Numerical Aquifer specification (Not Implemented Yet).
All the data for an aquifer method is input in a single file in the AQUIFER_FILES section as fol-
lows:
AQUIFER_FILES
AQUIFER method 1 filename1
AQUIFER method 2 filename2
....
The aquifer method (if any) to be used by each cell is specified in the PROPERTY_FILES section
of the case file using the AQCONNS keyword (see Aquifer Connection Section of this docu-
ment). By default, no cells are connected to any aquifer. There are two reports that may be gener-
ated to track results of aquifer influx- the first is a summary report given by aquifer, the second is
a detailed influx report given by grid in which individual cell pressures and influx data are pro-
vided. See the output section of this document and the keywords: AQUIFERS, AQUIFERSFILE
for information on how to generate these reports.
R5000.0.1 Aquifer Data: In This Chapter 217

Carter-Tracy Analytic Aquifers
CARTER_TRACY
LABEL label
RADIAL or LINEAR
BAQ baq or CT ct
POR por
H h
RO re
S s
W w
L l
TC tc or CT ct
POR por
VISC visc
K k
L l
RO re
PAQI paqi
DAQI daqi
ITDPD itdpd
or
TDPD
TD PD
td1 pd1
td2 pd2
..
tdn pdn
TRACER
NAME CONCENTRATION
Name1 conc1
Name2 conc2
….. …..
ENDTRACER
218 Aquifer Data: Carter-Tracy Analytic Aquifers R5000.0.1

Where:
CARTER_TRACY Specifies that the aquifer ‘type’ is Carter-Tracy (Required).
LABEL Specifies label for aquifer, not required.
RADIAL Specifies that the aquifer is a ‘radial’ type. This is the default.
LINEAR Specifies that the aquifer is a ‘linear’ type. Optional, not the
default.
BAQ Carter-Tracy constant (rb/psia, cm/kPa, cm/(Kg/cm2), cm/bars, cc/

psia) ,
2
2 πφ c t hr e S
baq = -------------------------
- radial
α1
wLh φ c
baq = -------------------t linear
α1
Where:
φ= Average aquifer porosity expressed as a frac-
tion.
ct = Total compressibility of aquifer (psi-1, kPa-
1, (Kg/cm2)-1, bars -1, psi-1).
h = Net of aquifer (ft, m, m, m, cm).
re = Radius to the perimeter of aquifer (boundary
between the reservoir and aquifer) (ft, m, m,
m, cm).
S = Fraction of circle that the boundary between
the reservoir and the aquifer completes (ft,
m, m, m, cm).
w = Width of aquifer (ft, m, m, m, cm).
L = Length of aquifer (ft, m, m, m, cm).
α1 = Units-dependent constant, 5.61458 or 1.0
(cf/rb, cm/cm, cm/cm, cm/cm, cc/cc).
There is no default. Required unless all CT, H, RE, S are entered as
described below.
R5000.0.1 Aquifer Data: Carter-Tracy Analytic Aquifers 219

CT Total compressibility, c t (psi-1, kPa-1, (Kg/cm2)-1, bars-1, psi-1).

No default, only input and required if not entering BAQ or TC.
POR Average aquifer porosity expressed as a fraction. No default, only

input and required if not entering BAQ.
H Aquifer thickness, h (ft, m, m, m, cm). No default, only input and

required if not entering BAQ.
RO Radius to the perimeter of aquifer (Boundary between the reservoir

and aquifer) (ft, m, m, m, cm). No default, only input and required
for “radial” aquifers if not entering BAQ or not entering TC.
S Fraction of circle that the boundary between the reservoir and the
aquifer completes (dimensionless). No default, only input and
required for “radial” aquifers if not entering BAQ.
W Width of “linear” aquifer (ft, m, m, m, cm). No default, only input

and required for “linear” aquifers if not entering BAQ.
L Length of “linear” aquifer (ft, m, m, m, cm). No default, only input

and required for “linear” aquifers if not entering BAQ or not
entering TC.
TC Factor to convert time to dimensionless time (days-1, days-1,

days-1, days-1, hours-1),
α2 k
t c = ------------------
- radial
2
c t φμre
α2 k
t c = ----------------
-
2 linear
c t φμL
Where:
k = Average aquifer permeability (md, md, md,
md, md).
ct = Total compressibility of aquifer (psi-1, kPa-1,
(Kg/cm2)-1, kbars-1, psi-1).
φ = Average aquifer porosity expressed as a frac-
tion.
μ = Aquifer viscosity (cP, cP, cP, cP, cP).
re = Radius to the perimeter of aquifer (boundary

between the reservoir and aquifer) (ft, m, m,

m, cm).
L = Length of aquifer (ft, m, m, m, cm).
α2 = Units-dependent constant,
(6.3283E-3 cP-sf/md-psi/day,
8.5270E-5 cP-sm/md-kPa/day,
8.3622E-3 cP-sm/md-(Kg/cm2)/day,
8.5270E-3 cP-sm/md-bars/day,
2.4496E-1 cP-sc/md-psi/hours).
There is no default. Required unless all CT, H, RE or L, S are
entered as described above and below.
K Aquifer permeability, k (md, md, md, md, md). No default, only

entered and required if not entering TC.
PHI Aquifer porosity expressed as a fraction, φ (dimensionless). No

default, only entered and required if not entering TC.
VISC Aquifer viscosity expressed as a fraction, μ (cP, cP, cP, cP, cP).
No default, only entered and required if not entering TC.
Note: CT, RE and L are described above and are only entered once
if both BAQ and TC are not input.
PAQI Initial aquifer pressure (psia, kPa, Kg/cm2, bars, psia) at the
reference depth, daqi. Default is to use gridblock pressure.
DAQI Datum depth (ft, m, m, m, cm) for initial aquifer pressure paqi.
ITDPD Integer table number which specifies which library dimensionless

Pd vs. Td table to use for calculations. Default is 1. This is the
infinite radial aquifer table. Currently this is the only predefined
library table. Do not enter if entering TDPD table as shown below.
or
TDPD Specifies that a user-supplied Pd vs. Td table will be input. The first
data card must have values for TD and PD equal to zero. Enough
values should be entered to extend to dimensionless times beyond
time to be simulated or until a linear extrapolation of the last two
values will provide satisfactory results.
TD Header for dimensionless time of Pd vs. Td table.
PD Header for dimensionless pressure of Pd vs. Td table.
R5000.0.1 Aquifer Data: Carter-Tracy Analytic Aquifers 221

SALINITY A constant salinity for the aquifer.
TRACER Tracer assigned to the aquifer.
Examples:
User elects to calculate BAQ and TC, default to the infinite radial aquifer table and specify the
initial aquifer pressure at datum.
CARTER_TRACY
NAME SOUTH FLANK
BAQ 20
TC 100
PAQI 4800
DAQI 9600
Specify constituent values for BAQ and TC and enter user-defined Pd vs. Td table. Default initial
aquifer pressure to gridblock value.
CARTER_TRACY
CT 1E-6
H 50
RO 5000
S 0.3333
TC 400
! User Supplied Table
TDPD
TD PD
0.0 0.0
0.01 0.115
0.05 0.242
0.10 0.350
0.15 0.390
0.20 0.472
….
Specify linear Carter-Tracy aquifer.
CARTER_TRACY
LABEL LINEAR_AQ1
BAQ 20
TC 1.1
LINEAR

Fetkovich Analytic Aquifers
FETKOVICH
LABEL label
RADIAL or LINEAR
PI pi or K k
H h
VISC visc
S s ! Radial Only
RO h ! Radial Only
RE re ! Radial Only
L l ! Linear Only
NOFLOW
CONSTP
WEI wei or WAQI waqi

CT ct
PAQI paqi
PAQI paqi
DAQI daqi
TRACER
NAME CONCENTRATION
Name1 conc1
Name2 conc2
….. …..
ENDTRACER
Where:
FETKOVICH Specifies that the aquifer ‘type’ is FETKOVICH. This is required.
LABEL Specifies label for aquifer, not required.
RADIAL Specifies that the aquifer is a ‘radial’ type. This is the default.
LINEAR Specifies that the aquifer is a ‘linear’ type. Optional, not the
default.
R5000.0.1 Aquifer Data: Fetkovich Analytic Aquifers 223

PI Aquifer productivity index (rb/day/psia, cm/day/kPa, cm/day/(Kg/

cm2), cm/day/bars, cc/hour/psia) ,
α 1 2 π skh
pi = -------------------------------------
-
r
μ ⎛ 1n ⎛ ----⎞ – β 1⎞
e
⎝ ⎝ r o⎠ ⎠
α 1 β 2 khw
pi = ----------------------
-
μL
Where:
k = Average aquifer permeability (md, md, md,
md, md).
h = Net of aquifer (ft, m, m, m, cm).
ro = Radius to the inner perimeter of aquifer
(Boundary between the reservoir and aqui-
fer) (ft, m, m, m, cm).
re = Radius to the exterior perimeter of aquifer
(Boundary between the reservoir and aqui-
fer) (ft, m, m, m, cm).
s = Fraction of circle that the boundary between
the reservoir and the aquifer completes
(dimensionless).
w = Width of “linear” aquifer (ft, m, m, m, cm).
L = Length of “linear” aquifer (ft, m, m, m, cm).
α1 = Units-dependent constant,
1.1271E-3 (rb/day/psia-ft),
8.5270E-5 (m3/day/kPa-m),
8.3622E-3 (m3/day/(Kg/cm2)-m),
8.5270E-3 (m3/day/bars-m),
2.4496E-1 (cc/hour/psia-cm)
β1 = Boundary condition constant for “radial”
aquifers, 0.75 if no-flow and 0.0 if constant
pressure (dimensionless).
β2 = Boundary condition constant for “linear”
aquifers, 3.0 if no-flow and 1.0 if constant
pressure (dimensionless).
224 Aquifer Data: Fetkovich Analytic Aquifers R5000.0.1

There is no default. Required unless all S, K, H, VISC, NOFLOW/

CONSTP for “radial” aquifers or all K, H, W, VISC, L,
NOFLOW/CONSTP for “linear” aquifers are entered as described
below.
K Aquifer permeability, k (md, md, md, md, md). No default, only

entered and required if not entering PI.
H Aquifer thickness, h (ft, m, m, m, cm). No default, only input and

required if not entering PI.
RO Radius to the perimeter of aquifer (Boundary between the reservoir

and aquifer) (ft, m, m, m, cm). No default, only input and required
for “radial” aquifers if not entering PI.
RE Radius to the exterior perimeter of aquifer (ft, m, m, m, cm). No

default, only input and required for “radial” aquifers if not entering
PI.
S Fraction of circle that the boundary between the reservoir and the
aquifer completes (ft, m, m, m, cm). No default, only input and
required for “radial” aquifers if not entering PI.
W Width of “linear” aquifer (ft, m, m, m, cm). No default, only input

and required for “linear” aquifers if not entering PI.
L Length of “linear” aquifer (ft, m, m, m, cm). No default, only

input and required for “linear” aquifers if not entering PI.
PAQI Initial aquifer pressure (psia, kPa, Kg/cm2, bars, psia) at the
reference depth, daqi. Default is to use gridblock pressure.
Required if not entering directly VWE as described below.
PAQI is only used when WAQI is not directly input. If WAQI is not
input, but CT and WEI are, then a default PAQI will be used if it is
not entered. This default is the gridblock pressure at the first WOC
for a given reservoir.
DAQI Datum depth (ft, m, m, m, cm) for initial aquifer pressure PAQI.
See above discussion. Required if PAQI entered.
R5000.0.1 Aquifer Data: Fetkovich Analytic Aquifers 225

WEI Initial volume of encroachable water in the aquifer, w ei (rb, cm, cm,
cm, cc). No default, required to entered this quantity or all of CT,
WAQI, PAQI. WEI is calculated from,
W ei = C t W aqi P aqi
Where
Ct = Total compressibility of aquifer (psia-1,

kPa-1, (Kg/cm2) -1, bars -1, psia-1).
W aqi = Volume of aquifer water initially in place (rb,
cm, cm, cm, cc).
P aqi = Initial aquifer pressure at datum (psia, kPa,
CT Total compressibility, c t (psi-1, kPa-1, (Kg/cm2) -1, bars-1, psi-1).

No default, only input and required if not entering VWE.
WAQI Volume of aquifer water initially in place, vwiip (rb, cm, cm, cm,
cc). No default, only input and required if not entering WEI.
SALINITY A constant salinity for the aquifer. Units are the choice of the user
as long as they are consistent..
TRACER Tracer assigned to the aquifer.
226 Aquifer Data: Fetkovich Analytic Aquifers R5000.0.1

Run Control
In This Chapter
• Simulation Start Date

• Setting Controls by Grid or Field
• Time Step Control Data
• Time Step Control Using Impes Stability Criteria
• Time Step Convergence Tolerances
• Maximum Allowed Changes in Implicit Iterations
• Surface Network Constraint Overshoot
• Output Data at Start of Run.
• Output Control Data.
• Output Dual Porosity Data
• Spreadsheet Control Data.
• Debug Output
• Array and Map Output Specification.
• Region Output Specification.
• Output File Formats.
• Solver parameters.
• Maximum Run Pressure
• Time Stepping Method
• DRSDT Option
• EOS Options
• Time Data
R5000.0.1 Run Control: In This Chapter 227

• INCLUDE Files
• Example run control file
All the data for run control is input in a single file. The run control file is included in a case in the
RECURRENT_FILES section as follows:
RECURRENT_FILES
RUNCONTROL filename
228 Run Control: In This Chapter R5000.0.1

Simulation Start Date
START date
where:
START Introduces the start date for the simulation. All times specified in
days will be relative to this start date.
date The start date for the simulation. The date can be specified in the
format mm/dd/yyyy or mm/dd/yyyy(hh:mm:ss). If the time
(hh:mm:ss) is not given, it will be taken to be (0:0:0) I.e midnight
of the previous day.
Notes:
START must be input before the first TIME input.
Example:
START 12/31/1999
R5000.0.1 Run Control: Simulation Start Date 229

Setting Controls by Grid or Field
Some input parameters can controlled by grid, (or by field in a multi-field run). The grids (or res-
ervoirs) to which the input applies are set as follows:
GRIDS (RESERVOIR resv_name) i1 i2 …

Other input data
ENDGRIDS
where:
GRIDS Introduces grids data.
RESERVOIR Introduces a reservoir name. This is only used in multi-field case,

and the reservoir name must be the same as one of the reservoir
names specified in the case (.fcs) file. Default: All reservoirs
i1 i2… Grid numbers corresponding to values in the Grid Assignment

array. Default: All grids
Other input data Any input which can be set by grid. This includes:
DCMAX, DCRPT, DRSDT, IMPSTAB, DVOLLIM, DZLIM,

DSLIM, DPLIM, DMOBLI M, DSGLIM, NEGFLOWLIM,
METHOD IMPES or IMPLICIT and GRIDSOLVER.
ENDGRIDS Terminates the input of parameters by grid.
Example:
GRIDS 1 3
DCMAX IMPES 0.1
ENDGRIDS
230 Run Control: Setting Controls by Grid or Field R5000.0.1

Time Step Control Data
DT CON dtime
AUTO dtime
MIN dtmin
MAX dtmax
QMAXPROD dtqmaxprod
QMAXINJ dtqmaxinj
MAXINCREASE dtmaxincr
ADJUSTTOTIME nadj
WCYCLE dtwcycle
GCYCLE dtgcycle
DCMAX IMPES dmax_impes

IMPLICIT dmax_implicit
ALL dmax
DCRPT dcrpt
VOLRPT volrpt
MAXNEWTONS max_newtons
MAXBADNETS max_bad_nets
where:
DT Introduces time step size data.
CON Specifies a constant time step size dtime. (days, days, days, hours)
AUTO Specifies the initial time step size dtime. The time step size for
subsequent time steps will be calculated by the simulator. (days,
days, days, hours)
MIN Specifies the minimum time step size. (days, days, days, hours).
Default: 0.001
MAX Specifies the maximum time step size. (days, days, days, hours)
Default: 1000
QMAXPROD Specifies the time step size, dtqmaxprod, which will be used when
a connection QMAX constraint changes from zero or inactive to a
positive value in a production subnetwork. (days, days, days,
hours). Default: 1.0e30 days
R5000.0.1 Run Control: Time Step Control Data 231

QMAXINJ Specifies the time step size, dtqmaxinj, which will be used when a
connection QMAX constraint changes from zero or inactive to a
positive value in an injection subnetwork. (days, days, days, hours).
Default: 1.0 days
MAXINCREASE The maximum increase in time step size allowed, specified as a

multiple of the current time step size. Default: 2.0
ADJUSTTOTIME Specifies that the time step size will be adjusted nadj time steps
before the next TIME input. When the simulation time is within
nadj*delt of the next TIME input (where delt is the time step size),
the Nexus® software will start adjusting the time step to try to
exactly hit the time specified on the TIME input. It does this so that
it will not need to use a very small time step in order to exactly hit
the specified time. Default: 5
WCYCLE Specifies the initial time step size after a WAG well switches to a
water cycle. (days, days, days, hours).
GCYCLE Specifies the initial time step size after a WAG well switches to a
gas cycle. (days, days, days, hours).
DCMAX Introduces the maximum mass/mole fraction change. A value of 0

will result in the default being used. DCMAX can be set by grid.
See the section “Setting Controls by Grid or Reservoir”. (Fraction).
Default: 0.05
IMPES Specifies that the maximum mole fraction change applies to IMPES
grids only.
IMPLICIT Specifies that the maximum mole fraction change applies to

IMPLICIT grids only.
ALL Specifies that the maximum mole fraction change applies to both
IMPES and IMPLICIT grids.
DCRPT Introduces the ratio by which the maximum mass/mole fraction

change can be exceeded before the time step is repeated (IMPES
grids only). The minimum valid value is 1.0. DCRPT can be set by
grid. See the section “Setting Controls by Grid or Field”. Default:
2.0 for IMPES grids, 10 for IMPLICIT grids
VOLRPT Introduces the maximum volume error. Only for non-EOS fluids. If
this volume error is exceeded, the time step is repeated. VOLRPT
can be set by grid. See the section “Setting Controls by Grid or
Field”. (Fraction).
Default: 1.0 for IMPES grids, 0.20 for IMPLICIT grids
232 Run Control: Time Step Control Data R5000.0.1

MAXNEWTONS Maximum number of newton iterations in a time step. Default: 10

for IMPES, 20 for IMPLICIT
MAXBADNETS Maximum number of iterations caused by the network. These

include damping due to perforation flow reversals (Perf_Rev),
maximum perforation cell pressure change (Cell_Dp), network
pressure constraint violation (Net_Pmax) and bad network
solutions (Bad Net). The terms in parentheses are printed in the
casename.max file for each Newton iteration. Default: 10
Notes:
1. DCMAX, DCRPT, and VOLRPT can be set by grid or field by enclosing the input between
the GRIDS … ENDGRIDS input. See the section “Setting Controls by Grid or Field”.
Examples:
DT CON 0.1
TIME 10.0
DT AUTO 0.1 MIN 0.01 MAX 10.0
DCMAX IMPES 0.05 IMPLICIT 0.05
TIME 100.0
GRIDS 1 3
DCMAX IMPES 0.1
ENDGRIDS
GRIDS RESERVOIR reservoir1 1 2

DCMAX IMPES 0.1
ENDGRIDS
R5000.0.1 Run Control: Time Step Control Data 233

Time Step Control Using Impes Stability Criteria
IMPSTAB ON or OFF
TARGETCFL targetcfl
LIMITCFL limitcfl
MAXCUTS mxcuts or NOCUTS
COATS or PEACEMAN
SKIPMASSCFL or USEMASSCFL
SKIPBLOCKDCMAX skipblockdcmax
where:
IMPSTAB Introduces Impes stability data. All IMPSTAB data can be set by
grid. See the section “Setting Controls by Grid or Field”.
ON Turns on IMPSTAB calculations. Default: OFF
OFF Turns off IMPSTAB calculations. Default: OFF
TARGETCFL Specifies the CFL number (fraction or multiple) to use in

calculating the stable time step size. Default: 0.9
LIMITCFL Specifies the limiting CFL number. If, during any Newton
iteration, the current potentials applied in the stability criteria cause
the CFL number to exceed this number, then the time step size is
scaled back to match the targetcfl and repeated. (Dimensionless).
Default: 1.0
NOCUTS Causes the program to ignore violations of limitcfl.
MAXCUTS Specifies the maximum number of times that a time step reduction
can occur over a single time step. If this is exceeded, the run will
stop. Default: 3
COATS Causes the K. Coats stability criteria to be used. Default: COATS
PEACEMAN Causes the D. Peaceman stability criteria to be used. Default:

COATS
SKIPMASSCFL Causes the stability algorithm to skip mass CFL check.
USEMASSCFL Causes the stability algorithm to do the mass CFL check. (Default.)
SKIPBLOCKDCMAX Specifies dcmax criteria to be applied for skipping calculations on

certain blocks to save computation time. If a block dcmax changes
234 Run Control: Time Step Control Using Impes Stability Criteria R5000.0.1
by less than specified amount IMPSTAB calculations are skipped

for this block. The default is to not skip any blocks. Specifying a
value activates the option. A reasonable value to try is 1/10 to 1/50
of the active dcmax value. Test is applied each Newton, if CFL
arrays are printed the skipped blocks are given a value of -5.0.
Notes:
qF ′Δ t
1. The CFL number in this context is defined as -------------- , where:
Vp
q is the total volumetric flow rate,

Δ t is the time step size
V p is a grid block pore volume
F ′ is generated by stability formulae.
qf w′Δ t
Neglecting gravity and capillary effects, for 1D, oil-water flow, this reduces to -------------- ,
Vp
where:
f w′is derivative of water fractional flow w.r.t. water.
2. ′ and Fcomp
In the general case, the F ′ term is the minimum of F sat ′ which come from separate
analysis of the limits imposed by the explicit treatment of mobility with respect to saturation
and composition.
3. The time step size will be determined by the most restrictive of the IMPSTAB criterion and
any other time step controls (such as DCMAX).
4. The IMPSTAB keyword must be used for each set of grids which have different parameters.
5. All IMPSTAB data can be set by grid or field by enclosing the input between the GRIDS …
ENDGRIDS input. See the section “Setting Controls by Grid or Field” on page 230”.
6. You can set IMPSTAB parameters by individual grid using the Other Input Data option
described in the “Setting Controls by Grid or Field” on page 230.
Example 1:
IMPSTAB ON
Example 2:
IMPSTAB ON SKIPBLOCKDCMAX 0.005
R5000.0.1 Run Control: Time Step Control Using Impes Stability Criteria 235
Example 3:
IMPSTAB ON TARGETCFL 1.0 LIMITCFL 1.5
236 Run Control: Time Step Control Using Impes Stability Criteria R5000.0.1
Convergence Tolerances
The tolerances used in the run are specified as follows:
TOLS VOLCON volcon

MASS mass
PERF perf
PERFREV ALLOW or DISALLOW
where:
TOLS Introduces tolerance data
VOLCON Introduces the volume constraint tolerance. A timestep is completed when

the maximum volume error is less than this value. A value of 0 will result
in the default being used. (Fraction)
Default: 0.005
MASS Introduces the material balance equation tolerance. A timestep is com-

pleted when the material balance equation residual is less than this value.
Only used for IMPLICIT grids. A value of 0 will result in the default being
used. (Fraction)
Default: 100 (i.e., not used)
PERF Introduces the perf equation tolerance. A timestep is completed when the
perf equation residual is less than this value. Should only be used for
debugging simulator. A value of 0 will result in the default being used.
(Fraction)
Default: Inactive
PERFREV Specifies whether or not convergence is allowed if a perforation has com-

ponent rates with opposite signs (Counter current component flow).
Allowing such non-physical solutions can improve performance in some
cases, and has been observed to have little effect on total well production
and injection. However, it may cause inconsistencies in the reported per-
foration rates. For example, a perforation might be producing water and
injecting gas. Default: DISALLOW
Examples:
TOLS VOLCON 0.001
R5000.0.1 Run Control: Convergence Tolerances 237

Maximum Allowed Changes in Implicit Iterations
To improve convergence for implicit timestepping, the maximum changes in various variables
may be specified. If greater changes occur during a newton iteration for any of these variables,
the solution for that iteration will be damped. The maximum changes that can occur during an
implicit newton iteration are specified as follows.
DVOLLIM dvollim
DZLIM dzlim
DSLIM dslim
DPLIM dplim
DMOBLIM dmoblim
DSGLIM dsglim
NEGFLOWLIM negflowlim or OFF
KRDAMP ON or OFF
VOLERR_PREV ON or OFF
SGCTOL sgctol
SGCPERFTOL sgcperftol
LINE_SEARCH ON or OFF
where:
DVOLLIM Introduces the fluid volume change allowed for each newton
iteration. A value of 0 will result in the default being used.
DVOLLIM can be set by grid. See the section “Setting Controls by
Grid or Field” on page 230. (Fraction). Default: 0.03
DZLIM Introduces the maximum phase mass/mole fraction change allowed

for each newton iteration. A value of 0 will result in the default
being used. DZLIM can be set by grid. See the section “Setting
Controls by Grid or Field” on page 230. (Fraction). Default: 0.1
DSLIM Introduces the maximum saturation change allowed for each

newton iteration. A value of 0 will result in the default being used.
DSLIM can be set by grid. See the section See the section “Setting
Controls by Grid or Field” on page 230. (Fraction). Default: 0.15
DPLIM Introduces the maximum pressure change allowed for each newton
iteration. A value of 0 will result in the default being used. DPLIM
can be set by grid. See the section “Setting Controls by Grid or
Field” on page 230. (psi, kPa, Kg/cm2, bar, psi. Default: 500 psi
DMOBLIM Introduces the maximum fractional change in phase mobility

allowed for each newton iteration. A value of 0 will result in the
default being used. DMOBLIM can be set by grid. See the section
238 Run Control: Maximum Allowed Changes in Implicit Iterations R5000.0.1

“Setting Controls by Grid or Field” on page 230. (Fraction).

Default: 7.0
DSGLIM Introduces the maximum emerging gas saturation allowed for each
newton iteration. A value of 0 will result in the default being used.
DSGLIM can be set by grid. See the section “Setting Controls by
Grid or Field” on page 230. (Fraction). Default: 0.1
NEGFLOWLIM Introduces the maximum flow allowed out of a cell with zero
mobility (specified as a fraction of the mass in place). The iteration
will be damped if this is exceeded. Flow out of a zero mobility cell
can occur if the flow direction changes during the iteration. If this
is followed by the keyword OFF, this option is inactive.
NEGFLOWLIM can be set by grid. See the section “Setting
Controls by Grid or Field” on page 230. (Fraction). Default: OFF
KRDAMP Specifies whether relative permeability damping is used. Default:

ON
VOLERR_PREV Specifies whether the volume error from the previous iteration is
accounted for when calculating the saturation change damping.
Default: OFF.
SGCTOL Specifies the saturation tolerance to use for grid blocks whose gas
saturation crosses Sgc during a Newton. A tolerance of 0 disables
this option. A positive value damps the gas saturation change, so
that it does not cross Sgc by more than the tolerance. (Fraction).
Default: Not used.
SGCPERFTOL Specifies the saturation tolerance to use for perforated grid blocks
whose gas saturation crosses Sgc during a Newton. A tolerance of
0 disables this option. A positive value damps the gas saturation
change, so that it does not cross Sgc by more than the tolerance.
(Fraction). Default: Not used.
LINE_SEARCH Specifies whether the line search algorithm should be used to

improve implicit convergence. Must be followed by the keyword
ON or OFF. The line search algorithm rescales the solution if the
mass balance residuals get worse after a Newton iteration. Default:
OFF.
Notes:
1. These parameters only affect grids which use implicit timestepping.
2. DVOLLIM, DZLIM, DSLIM, DPLIM, DMOBLIM, DSGLIM AND NEGFLOWLIM can be

set by grid or field by enclosing the input between the GRIDS … ENDGRIDS input. See the
R5000.0.1 Run Control: Maximum Allowed Changes in Implicit Iterations 239

section “Setting Controls by Grid or Field”.
Example:
DVOLLIM 0.05 DSLIM 0.1

TIME 100.0
240 Run Control: Maximum Allowed Changes in Implicit Iterations R5000.0.1

Implicit Mass Balance Option
Mass balance errors arise in implicit simulations, because the iterative linear solver does not solve
the equations exactly, but only within a specified tolerance. The implicit mass balance option per-
forms an adjustment to the mass solution to eliminate mass errors. The input is as follows:
IMPLICITMBAL ON/OFF
Where
IMPLICITMBAL Introduces input for the implicit mass balance option.
ON Specifies that the implicit mass balance option will be used. This is
the default.
OFF Specifies that the implicit mass balance option will not be used.
Notes:
In some cases, the simulator may issue a warning message to tighten the linear solver tolerance to
improve material balance. This means that the adjustments necessary to maintain a material bal-
ance are sufficiently large to cause concern for the accuracy of the solution. In this situation, it
would be advisable to try at least one run with a tighter solver tolerance, and another run with both
a tighter solver tolerance and implicitmbal off, and compare the results of these runs with the orig-
inal run to determine whether the looser solver tolerance is acceptable or not.
Example:
IMPLICITMBAL OFF
R5000.0.1 Run Control: Implicit Mass Balance Option 241

Surface Network Constraint Overshoot
The handling of inactive surface network constraints is specified as follows:
OVERSHOOT ALLOW or DISALLOW

MAX maxover
HYDMAX hydmaxover
where:
OVERSHOOT Introduces constraint overshoot data.
ALLOW Specifies that the solution for a time step will be allowed to
converge even if an inactive constraint has been violated. Default:
ALLOW
DISALLOW If an inactive network constraint has been violated, the constraint

will be activated and another Newton iteration will be performed.
Default: ALLOW
MAX Introduces the maximum amount (fraction) by which an inactive

constraint may be violated. If a constraint is violated by more than
this fraction, then the solution will be damped, and another Newton
iteration will be performed. The minimum allowed value for
maxover is 0.03. (Fraction). Default: 0.1
HYDMAX Introduces the maximum amount (fraction) by which an inactive

hydraulics relationship may be violated. If (pout +
delp(hydraulics))/pin is greater than 1+hydmaxover, the solution
will be damped, and another Newton iteration will be performed.
The minimum allowed value for hydmaxover is 0.001. (Fraction).
Default: 0.03
Notes:
An example of an inactive constraint is a producing well which is operating on a rate constraint

(the active constraint), but which also has a minimum bottomhole pressure constraint (the inactive
constraint). The simulator will exactly honor the active constraint, which may result in the inac-
tive bottomhole pressure constraint being violated after the pressures are updated at the end of a
Newton iteration. If overshoot is allowed, and the fraction by which the bottomhole pressure
constraint is violated is less than maxover, then the simulator will proceed to the next time step
(assuming all other convergence criteria are satisfied). The next time step will then impose the
minimum bottomhole pressure constraint as the active constraint, and the rate constraint will
become inactive. Because the constraint is only violated for one time step, it usually will not
make a material difference to the simulation results to allow overshoot, and it saves the CPU
expense of an extra Newton iteration.
242 Run Control: Surface Network Constraint Overshoot R5000.0.1

Similarly, when a rate constraint is active, the hydraulics equation for that connection is not
active. The rate constraint will be exactly honored, which implies that a valve has restricted flow
in the connection, introducing a pressure drop over and above that which would be calculated
from the hydraulics relationship (hydraulics table, pressure drop correlation, or static gradient) for
that connection. If, after the pressures are updated at the end of a Newton iteration, the pressure
drop due to this implied valve actually turns out to be a pressure increase, then the hydraulics
equation has been violated, and the hydraulics equation should have been active instead of the rate
constraint.
Examples:
OVERSHOOT MAX 0.05 DISALLOW
R5000.0.1 Run Control: Surface Network Constraint Overshoot 243

Output Data at Start of Run
Special output at the start of the run is specified as follows:
OUTSTART CONNECT
EQUILREGION DEPTHTAB
GRIDBLOCK
OVERREAD
ALL
ENDOUTSTART
where:
OUTSTART Introduces output data for special output at the start of a run.
CONNECT Specifies that the connection data will be output.
EQUILREGION Specifies that equilibration data will be output.
DEPTHTAB Specifies that equilibration depth tables will be output.
GRIDBLOCK Specifies that equilibration gridblock data will be output.
OVERREAD Specifies that equilibration overread data will be output.
ALL Specifies that all equilibration data will be output.
ENDOUTSTART Specifies the end of OUTSTART data.
Notes:
Must be present before the first TIME input.
Example:
OUTSTART CONNECT
EQUILREGION DEPTHTAB GRIDBLOCK
ENDOUTSTART
244 Run Control: Output Data at Start of Run R5000.0.1

Output Control Data
The frequency at which output is written by the simulator is specified as follows:
OUTPUT ARRAYS OFF

AQUIFERS DT dt
AQUIFERSFILE DTTOL dttol
FIELD DT dt
FIELDPLOT DTTOL dttol
HYDRAULICS TIMES
ITERATIONS TNEXT
MAPS FREQ freq
NETWORK MONTHLY
NETPLOT QUARTERLY
NETWORKCOMP YEARLY
NETWORKTRACER TIMESTEP itime
PDCOR
PERFCOMP
PERFS
PERFPLOT
PERFTRACER
REGIONS
REGIONPLOT
RESTART
RFT
RFTFILE
SEPARATOR
STREAMCALC
TARGETS
TARGETPLOT
TEMPLATE
WELLCOMP
WELLPLOT
WELLS
WELLSRES
WELLTRACER
ENDOUTPUT
CPUOUT or NOCPUOUT
RECOUT or NORECOUT
NETSUM
VIPUNITS
LOGOUT ALL or NONE or LOG or OUT
where:
AQUIFER Specifies that the following frequency input applies to the

AQUIFER report written to the .out file.
R5000.0.1 Run Control: Output Control Data 245

AQUIFERFILE Specifies that the following frequency input applies to the

AQUIFER report written to the .aquif file.
OUTPUT Introduces output frequency data. By default, WELLS,

NETWORK, FIELDPLOT, WELLPLOT and NETPLOT are
output at every time specified by TIME input.
ARRAYS Specifies that the following frequency input applies to array output.
The arrays which will be output are specified in the Array and Map
Output Specification.
CPUOUT Specifies that the cpu summary will appear after array and well
output. This is the default.
DT Specifies that the output will occur at intervals of dt. (days, days,
days, hours)
DTTOL Specifies a tolerance for output at intervals of DT days. If the

simulation time is in the interval printtime – dttol to printtime, and
the end of the next time step would be greater than printtime, then
output will occur. This prevents shortening the timestep for the sole
purpose of honoring the DT data. (days, days, days, hours). The
default is 2 days.
ENDOUTPUT Specifies the end of OUTPUT data input.
FIELD Specifies that the following frequency input applies to field output
to the .out file.
FIELDPLOT Specifies that the following frequency input applies to field output
to the plot file.
FREQ Specifies that the output will occur every freq time steps.
HYDRAULICS Specifies that the following frequency input applies to hydraulics

data output to the .hyd file.
ITERATIONS Specifies that the following frequency input applies to the detailed
iteration report.
MAPS Specifies that the following frequency input applies to map output.
The arrays which will be output are specified in the Array and Map
Output Specification.
MONTHLY Specifies that the output will occur at the end of each calendar
month.
246 Run Control: Output Control Data R5000.0.1

NETSUM Specifies that a network summary file will be output (.netsum).

This file will contain the sum of the production (or injection) at the
network sinks (or sources). I.e all fluids entering and leaving the
network. This is different from the .sum file, which contains the
production/injection obtained by summing all the wells, and does
not reflect mixing and processing in the network. If NETSUM is
specified anywhere in the control file, the .netsum file will be
produced from the start of the run.
VIPUNITS Specifies that output will use the same units as the VIP® software.
For example, in ENGLISH units, the Nexus software would
normally output GOR in the units MSCF/STB whereas the VIP
software outputs SCF/STB.
NETWORK Specifies that the following frequency input applies to network

formatted output to the .out file.
NETPLOT Specifies that the following frequency input applies to network

output to the plot file.
NETWORKCOMP Specifies that the following frequency input applies to network

compositional formatted output to the .out file
NETWORKTRACER Specifies that the following frequency input applies to network

tracer formatted output to the .out file
PDCOR Specifies that the following frequency input applies to detailed

pressure drop correlation output to the .hyd file
NOCPUOUT Specifies that the cpu summary will appear only at the end of the
run.
NORECOUT Specifies that changes in the recurrent data will not be output to the
.out file.
OFF Turns off the specified output. This is the default if no other
keywords are specified following ARRAYS, REGIONS, WELLS,
PERFS, NETWORK, WELLPLOT, PERFPLOT, NETPLOT,
FIELDPLOT or RESTART.
PERFCOMP Specifies that the following frequency input applies to completion

compositional formatted output to the .out file
PERFTRACER Specifies that the following frequency input applies to completion

tracer formatted output to the .out file
PERFS Specifies that the following frequency input applies to perf


PERFPLOT Specifies that the following frequency input applies to perf output
to the plot file.
QUARTERLY Specifies that the output will occur at the end of each calendar
quarter.
RECOUT Specifies that changes in recurrent data will be output to the .out
file. This is the default.
REGIONS Specifies that the following frequency input applies to region fluids
in place output. See the REGDATA and REGBLK input for a
description of how the fluids in place are calculated for regions.
REGIONPLOT Specifies that the following frequency input applies to region fluids
in place output to the plot file. See the REGDATA and REGBLK
input for a description of how the fluids in place are calculated for
regions.
RESTART Specifies that the following frequency input applies to restart

output.
RFT Specifies that the following frequency input applies to the RFT
report written to the .out file. The wells which are included in the
report are specified using the RFTWELLS keyword in the Surface
Network file.
RFTFILE Specifies that the following frequency input applies to the RFT
report written to the .rft file. The wells which are included in the
report are specified using the RFTWELLS keyword in the Surface
Network file.
RIGS Specifies that rig data is written to the .out file.
SEPARATOR Specifies that the following frequency input applies to separator

report output to the .out file.
STREAMCALC Specifies that the following frequency input applies to StreamCalc

output to the .vdb file. StreamCalc is a Landmark application that
reads flux data from a vdb.
TARGETS Specifies that the following frequency input applies to target output
to the .out file.
TARGETPLOT Specifies that the following frequency input applies to target output
to the plot file.
TEMPLATE Specifies that the solver template will be recalculated, and output to
the restart file.

TIMES Specifies that the output will occur at every time specified by TIME
input in the run control file. This will override a previous TNEXT
specification.
TIMESTEP Specifies that the output will occur at the itime time step.
TNEXT Specifies that the output will occur at the next TIME input in the
run control file only. This will override a previous TIMES
specification.
WELLCOMP Specifies that the following frequency input applies to well

compositional formatted output to the .out file.
WELLPLOT Specifies that the following frequency input applies to well output
to the plot file.
WELLTRACER Specifies that the following frequency input applies to well tracer
formatted output to the .out file
WELLS Specifies that the following frequency input applies to well

WELLSRES Specifies that the following frequency input applies to reservoir

production rate output report output to the .out file.
YEARLY Specifies that the output will occur at the end of each calendar year.
LOGOUT Specifies which output files will be used for log data generated by
procedures and events such as shut ins in the network. This
keyword is followed by ALL or NONE or LOG or OUT. OUT
specifies that the log data will be output to the .out file only. LOG
specifies that the log data will be output to the .runlog file only.
ALL specifies that the log data will be output to both the .out and
.runlog files, and NONE specifies that the log output will be
suppressed.
Default: ALL
Notes:
The output frequency can be controlled by more than one criterion. E.g. the output of array data
could occur every freq timesteps and every dt days. All previously specified output for a particu-
lar type of data (i.e. ARRAYS, REGIONS, WELLS, PERFS, NETWORK, WELLPLOT, PERF-
PLOT, NETPLOT, FIELDPLOT or RESTART) is turned off when the keyword is encountered.
So to control the output by more than one criterion, all the frequency keywords must follow the
type keyword. E.g. OUTPUT ARRAYS FREQ 5 DT 30.0
To get array output at the start of the run, specify OUTPUT ARRAYS TIMES, specify the desired

arrays using the ARRAYOUT keyword, followed by the TIME keyword with the time equal to
the start date (or 0.0 days).
Defaults
By default, FIELD, WELLS, NETWORK, FIELDPLOT, WELLPLOT and NETPLOT are output
at every time specified by TIME input.
Example:
OUTPUT
MAPS MONTHLY TNEXT
PERFS YEARLY
WELLS FREQ 5
NETWORK OFF
ENDOUTPUT

Output Dual Porosity Data
By default array and map output will contain all porosity types available. However, you can mod-
ify dual porosity output in the following manner:
ARRAYOUT
arraytype1 (MATRIX) (FRAC) key1 key2 ... keyj
arraytype2 (MATRIX) (FRAC) key1 key2 ... keyk
. . . . . .
arraytypen (MATRIX) (FRAC) key1 key2 ... keyl
ENDARRAYOUT
or
MAPOUT
arraytype1 (MATRIX) (FRAC) key1 key2 ... keyj
arraytype2 (MATRIX) (FRAC) key1 key2 ... keyk
. . . .
arraytypen (MATRIX) (FRAC) key1 key2 ... keyl
ENDMAPOUT
where:
ARRAYOUT Specifies that the following arrays will be output to the ASCII
(formatted) output file.
MAPOUT Specifies that the following arrays will be output to a map file.
MATRIX Optional keyword which limits output of specified array to the

MATRIX porosity type. The default is to output all porosity types.
FRAC Optional keyword which limits output of specified array to the

FRAC porosity type. The default is to output all porosity types
arraytype1 Keyword specifying the type of array
key1 Keyword specifying an additional qualifier for the array
Wells are specified as follows:
WELLSPEC well_name
CELL KH RADB . (PORTYPE). (OTHER OPTIONAL HEADERS)
cell kh radb . portype
cell kh radb . Portype
R5000.0.1 Run Control: Output Dual Porosity Data 251

where:
WELLSPEC Keyword introducing well specification data
well_name Well name. The well name must start with an alpha character or a
number, and should not contain the % character.
CELL Column heading keyword indicating that the entries in this column
are the cell indices for each completion (integer). The index should
be the global cell index, corresponding to the indices specified in
the GLOBALCELL data input. An entry of NA can be used to
indicate an unperforated node. In this case, NA should also be used
for all other columns except SECT and DEPTH.
KH Column heading keyword indicating that the entries in this column

are the KH values (permeability*wellbore length) for each
completion.
252 Run Control: Output Dual Porosity Data R5000.0.1

Spreadsheet Control Data
Spreadsheet output from the simulator can be specified as follows:
SPREADSHEET FIELD OFF ON

WELLS DT dt
PERFS DTTOL dttol
NETWORK TIMES
TARGETS TNEXT
REGIONS FREQ freq
ALL MONTHLY
QUARTERLY
YEARLY
TIMESTEP itime
END SPREADSHEET
where:
SPREADSHEET Introduces output frequency data.
FIELD Specifies field spreadsheet data.
WELLS Specifies well spreadsheet data.
PERFS Specifies well completion spreadsheet data.
NETWORK Specifies network spreadsheet data.
TARGETS Specifies target spreadsheet data.
REGIONS Specifies region spreadsheet data.
ALL Specifies all spreadsheet data.
ON Specifies that the specified data will be output to a spreadsheet file

every time step. (Equivalent to FREQ 1). This is the Default (i.e.,
FIELD ON is the same as FIELD with no secondary keyword.
OFF Specifies that the specified data will not be output to a spreadsheet
file.
DT Specifies that the output will occur at intervals of dt. (days, days,
days, hours)
TIMES Specifies that the output will occur at every time specified by TIME
input in the run control file. This will override a previous TNEXT
specification.
R5000.0.1 Run Control: Spreadsheet Control Data 253

TNEXT Specifies that the output will occur at the next TIME input in the
run control file only. This will override a previous TIMES
specification.
FREQ Specifies that the output will occur every freq time steps.
MONTHLY Specifies that the output will occur at the end of each calendar
month.
QUARTERLY Specifies that the output will occur at the end of each calendar
quarter.
YEARLY Specifies that the output will occur at the end of each calendar year.
DTTOL Specifies a tolerance for output at intervals of DT days. If the

simulation time is in the interval printtime – dttol to printtime, and
the end of the next time step would be greater than printtime, then
output will occur. This prevents shortening the timestep for the sole
purpose of honoring the DT data. The default is 2 days.
TIMESTEP Specifies that the output will occur at the itime time step.
ENDSPREADSHEET Specifies the end of SPREADSHEET data input.
Notes:
The default is that no spreadsheet data is output
Example:
SPREADSHEET FIELD ON ! Output field data to a spreadsheet every time step

WELLS TIMES! Output well data to a spreadsheet at every TIME
PERFS OFF ! Turns off well completion spreadsheet output
ENDSPREADSHEET
254 Run Control: Spreadsheet Control Data R5000.0.1

Debug Output
Debug output is specified as follows:
DEBUG EQUILREGION
OSCILLATION
PARALLEL (OFF)
LINEARIZATION(ON or OFF)
HYDRAULICS (ON or OFF)
ENDDEBUG
where:
DEBUG Introduces data for debug output.
EQUILREGION Specifies that debug equilibration data will be output.
OSCILLATION Specifies that an oscillation report will be output.
PARALLEL Specifies that parallel debug data will be output. Processes (other
than the master process) that have access to the disk will write to
files *.out.#, *.wrn.#, *.dbg.# and *.log.#, where # is the process
number. Where applicable, output frequency is the same as that of
the master process.
LINEARIZATION Specifies that debug output to check the linearization of perf

mobilities, relative permeabilities etc will be output to the .dbg file.
HYDRAULICS Specifies that debug output will be written to the .dbg file when
connections are shut in due to hydraulics instabilities or no
intersection.
ON Turns option on.
OFF Turns option off.
ENDDEBUG Specifies the end of DEBUG data.
Example:
DEBUG EQUILREGION
ENDDEBUGBUG
R5000.0.1 Run Control: Debug Output 255

Array and Map Output Specification
The arrays chosen for output are specified in the following table. Note that each occurrence of an
ARRAYOUT or MAPOUT table adds to the list of arrays which will be output. To remove arrays
from the output, the keyword NONE must be specified, then all arrays must be respecified.
ARRAYOUT
arraytype1 key1 key2 ... keyj
arraytype2 key1 key2 ... keyk
. . . .
arraytypen key1 key2 ... keyl
ENDARRAYOUT
or
MAPOUT
arraytype1 key1 key2 ... keyj
arraytype2 key1 key2 ... keyk
. . . .
arraytypen key1 key2 ... keyl
ENDMAPOUT
where:
ARRAYOUT Specifies that the following arrays will be output to the ASCII
(formatted) output file.
MAPOUT Specifies that the following arrays will be output to a map file.
arraytype1 Keyword specifying the type of array
key1 Keyword specifying an additional qualifier for the array
256 Run Control: Array and Map Output Specification R5000.0.1

The possible arraytypei and keyi keywords are as follows:
arraytypei Description keyi
API API gravity

CFL CFL number LIMIT SAT COMP
COMP Compressibility TOTAL FLUID ROCK
CONCEN- Stream tracer concentra- component_name
TRATION tion tracer_names
DEN Density OIL GAS WATER
Cell VE Gas or Water
HT_VE Height GAS WATER
IFT Interfacial tension IFT
KMCMT Transmissibility multiplier P SW
KR Relative Permeability OIL GAS WATER
MOB Mobility OIL GAS WATER
MOLEX Liquid Molefractions component names
MOLEY Vapor Molefractions component names
MOLEZ Total Molefractions component names
MW Mole Weight OIL GAS WATER
Number of damps caused
NDAMP by cells
NONE Suppresses array output

P Pressure
PC Capillary Pressure OIL GAS WATER
Capillary pressure adjust-
PCADJ ment GAS WATER
Historical minimum pres-
PMIN sure
PSAT Saturation Pressure
True saturation pressure
PSATT (see note below)
PV Pore Volume
PVMLT Pore volume multiplier P SW
R5000.0.1 Run Control: Array and Map Output Specification 257

arraytypei Description keyi
RS Solution gas oil ratio

SAL Salt concentration
SAT Saturation OIL GAS WATER
VISC Viscosity OIL GAS WATER
Notes:
1. To get array output at the start of the run, specify OUTPUT ARRAYS TIMES, specify the
desired arrays using the ARRAYOUT keyword, followed by the TIME keyword with the
time equal to the start date (or 0.0 days).
2. For CFL number, SAT is the cfl number due to explicit treatment of saturation in the mobility
term, COMP is the cfl number due to explicit treatment of composition in the mobility term,
and LIMIT is the limiting cfl number (max(sat,comp)).
3. Note that use of CONCENTRATION WATER SALT would be equivalent to the use of the
SALINITY keyword.
4. PSATT is the true saturation pressure. If PSAT is not used as a computational method, PSAT
only provides an approximate value of PSAT.
Defaults:
By default, pressure, oil saturation, gas saturation and water saturation will be output in binary
form.
Example:
MAPOUT
P
SAT OIL GAS WATER
MOLEX CH4 C7+
ENDMAPOUT
258 Run Control: Array and Map Output Specification R5000.0.1

Region Output Specification
The region groups chosen for output to the .out file are specified in the following table.
REGIONOUT
NAME (RESERVOIR) OUTPUT
Reg_grp_name or FIELD or ALL (resv_name or ALL) ON or OFF
ENDREGIONOUT
where:
REGIONOUT Introduces region group output specification data.
NAME Column heading keyword. The entries in this column are either a
region group name, the keywords ALL or FIELD.
OUTPUT Column heading keyword. The entries in this column are either ON
or OFF.
RESERVOIR Column heading keyword. The entries in this column are either a
reservoir name (see the Multiple Reservoir Case File section) or the
keyword ALL.
Default: ALL
Name Entries in the NAME column specify what data is turned on or off
by the entry in the OUTPUT column. Valid entries in the NAME
column are:
A region group name (see the IREGION keyword in the Case File
section) controls output for this region group.
The keyword ALL controls output for all region groups.
The keyword FIELD controls output for the FIELD region group.
ON Turns on output for the specified name.
OFF Turns off output for the specified name.
ENDREGIONOUT Specifies the end of REGIONOUT data.
Notes:
1. The output selected is dependent on the order of data entry. I.e each input overrides any prior
input with which it conflicts. E.g. An entry of ALL OFF turns off all region output, regard-
less of any previous input.
R5000.0.1 Run Control: Region Output Specification 259

2. The default is ALL ON. I.e. all region groups will be output at the frequency specified in the
OUTPUT table (see the Output Control Data section).
Examples:
REGIONOUT
NAME OUTPUT
ALL OFF ! Turns off all region output
LAYERS ON ! Turns on output for the region group named LAYERS
ENDREGIONOUT
REGIONOUT
NAME OUTPUT
LAYERS ON ! Turns on output for the region group named LAYERS
ALL OFF ! Turns off all region output, including LAYERS
ENDREGIONOUT
REGIONOUT
NAME RESERVOIR OUTPUT
LAYERS RESV1 OFF ! Turns off output for the region group named
! LAYERS for the reservoir RESV1
ENDREGIONOUT
260 Run Control: Region Output Specification R5000.0.1

Output File Formats
By default, the map and plot files will be output in VDB format. The format can be changed as
follows.
MAPFORM or MAPBINARY or MAPVDB

PLOTFORM or PLOTBINARY or PLOTVDB
where:
MAPFORM Specifies that the map file will be formatted. This will apply for the
whole run, regardless of where the keyword appears in the run
control file. Default: VDB
MAPBINARY Specifies that the map file will be unformatted. This will apply for
the whole run, regardless of where the keyword appears in the run
MAPVDB Specifies that the map file will be output to VDB. This will apply
for the whole run, regardless of where the keyword appears in the
run control file. Default: VDB
PLOTFORM Specifies that the plot file will be formatted. This will apply for the
whole run, regardless of where the keyword appears in the run
PLOTBINARY Specifies that the plot file will be unformatted. This will apply for
PLOTVDB Specifies that the plot file will output to VDB. This will apply for
Example:
MAPFORM
R5000.0.1 Run Control: Output File Formats 261

Solver Parameters (SOLVER)
The parameters for the solver are specified as follows:
SOLVER RESERVOIR (CYCLELENGTH cyclelength)

(MAXCYCLES maxcycles)
GLOBAL (GLOBALTOL globaltol)
ALL (ITERATIVE or DIRECT)
(NOCUT or CUT)
(PRECON_ILU (DROPTOL droptol), or

PRECON_AMG or
PRECON_AMG_RS)
(DUAL_SOLVER ON or OFF)
(SYSTEM_REDUCED ON or OFF)
SOLVER FACILITIES (NOGRID or EXTENDED)(ncells)
(ITERATIVE or DIRECT)
GRIDSOLVER IMPLICIT_COUPLING NONE or
ROWSUM or
COLSUM
IMPES_ COUPLING NONE or
ROWSUM or
COLSUM
IMPLICIT_PRECON GAUSS_SEIDEL or
HALF_FAST or
ILU (0 or 1) (NO or MDF or RCM) or
X_LINE_GAUSS_SEIDEL or
Y_LINE_GAUSS_SEIDEL or
Z_LINE_GAUSS_SEIDEL
CPR_PRESSURE_EQUATION NONE or
NORMAL or
IMPES
PRESS_RED press_red
IMPLICIT_RED imp_red
GRID_RED grid_red
where:
SOLVER Introduces solver parameter data
RESERVOIR The following parameters will apply to the reservoir flow

equations.
GLOBAL The following parameters will apply to the coupled reservoir/

facilities equations.
ALL The following parameters will apply to both the reservoir and
surface network equations.
262 Run Control: Solver Parameters (SOLVER) R5000.0.1

PRECON_ILU Specifies that the ILU preconditioner will be used for the pressure
solve. This is the default.
DROPTOL Specifies the drop tolerance that will be used by the ILUT pressure
preconditioner. Default 0.007 if SYSTEM_REDUCED ON is
used, otherwise 0.004.
PRECON_AMG Specifies that the AMG preconditioner will be used for the pressure
solve.
PRECON_AMG_RS Specifies that the AMG preconditioner (Ruge-Steuben formulation)

will be used for the pressure solve.
CUT Specifies that the time step will be cut in the event of a solver
failure. This is the default.
NOCUT Specifies that the time step will not be cut in the event of a solver
failure.
DUAL_SOLVER Turns on or off the special multiple porosity solver methodology.

This is relevant only to multiple porosity cases with single
permeability. The default is ON. Usually this will produce better
solver performance for multiple porosity cases.
Important: Dual porosity and permeability models are not yet

commercially supported. Information relating to these options is
included in the manual for ongoing testing and pilots.
SYSTEM_REDUCED Turns on or off the option to solve a reduced system or the full
system of equations. The reduced system uses a red black ordering
to reduce the number of unknowns solved by the linear solver.
Default is ON.
FACILITIES The following parameters will apply to the surface network

equations.
CYCLELENGTH The maximum number of iterations (integer) in one GMRES solver

cycle. This input is only used by the ITERATIVE method.
Defaults: Reservoir: 7 for IMPES, 1 for IMPLICIT and 3 for mixed
IMPES or IMPLICIT. Facilities: NA. Global: 20.
MAXCYCLES The maximum number of GMRES cycles (integer) used to solve

the linear system. This input is only used by the ITERATIVE
method.
Defaults: Reservoir: 1. Facilities: NA. Global: 3.
GLOBALTOL The tolerance of the linear solution. This input is only used by the
ITERATIVE method. (Fraction).
R5000.0.1 Run Control: Solver Parameters (SOLVER) 263

Defaults: Reservoir: 0.001 for IMPES, 0.01 for IMPLICIT and

0.01 for mixed IMPES or IMPLICIT. Facilities: NA. Global:
0.001 for IMPES, 0.01 for IMPLICIT and 0.01 for mixed IMPES or
IMPLICIT.
ITERATIVE Specifies that the ITERATIVE method will be used to solve the
linear equations. Does not apply to the GLOBAL keyword. This is
the default for the reservoir equations and the FACILITIES
EXTENDED option. It is not available for the FACILITIES
NOGRID option.
DIRECT Specifies that the DIRECT method will be used to solve the linear
equations. It this is specified after the GLOBAL keyword, then all
the equations (Reservoir, facilities and the coupled system) will all
be solved using the direct solver.
NOGRID Specifies that the facilities will not include the perforated grid
blocks. The DIRECT method must be used for this option.
EXTENDED Specifies that the facilities equations will be extended to include the
perforated grid blocks, and optionally additional neighbor grid
blocks. The parameter ncells specifies the number of neighbor grid
blocks. A value of 1 (the default), specifies that only the perforated
grid blocks are included. By default, the ITERATIVE method will
be used on the extended facilities solve.
GRIDSOLVER Introduces solver parameters that can be set by grid. All

GRIDSOLVER data can be set by grid. See the section “Setting
Controls by Grid or Field”.
IMPLICIT_COUPLING Method used to modify an implicit grid matrix to account for

facility-grid coupling. This is followed by one of the following
keywords:
NONE – no modification
ROWSUM – nested factorization rowsum
COLSUM – nested factorization colsum
Default: ROWSUM
IMPES_COUPLING Method used to modify an impes grid matrix to account for

facility-grid coupling. This is followed by one of the following
keywords:
NONE – no modification
ROWSUM – nested factorization rowsum
COLSUM – nested factorization colsum
Default: ROWSUM

IMPLICIT_PRECON Type of preconditioner used on full implicit set of equations. This

is followed by one of the following keywords:
GAUSS_SEIDEL – symmetric point Gauss Seidel
HALF_FAST – does the elimination exactly where it is

convenient
ILU – ILU preconditioner. ILU can optionally be followed by an

infill level, 0 or 1, and by an ordering keyword NO, MDF or
RCM. NO is natural ordering, MDF is minimum discarded fill,
and RCM is reversed Cuthill McKee. The defaults are 0 and NO,
unless PRECON_ILU is selected for the pressure solve, in which
case the default ordering is MDF.
X_LINE_GAUSS_SEIDEL – Line Gauss Seidel in the x-

direction. Only available for structured grids.
Y_LINE_GAUSS_SEIDEL – Line Gauss Seidel in the y-

Z_LINE_GAUSS_SEIDEL – Line Gauss Seidel in the z-

Default: ILU 0 NO unless the option PRECON_ILU is selected

for the pressure solve, in which case the default is ILU 0 MDF.
CPR_PRESSURE_EQUATIONSpecifies what equations to use for the Constraint Pressure

Residual method. (Only used for implicit grids). This is
followed by one of the following keywords:
NONE – CPR is not used
NORMAL – the normal CPR method is used
IMPES – the IMPES pressure equations are used
Default: NORMAL
PRESS_RED Required 2-norm reduction during the CPR pressure solve. (real)
Default: 0.03
IMPLICIT_RED Required 2-norm reduction during the CPR implicit solve. (real). A
value of 0 calls for a single pass through the preconditioner.
Default: 0.0
GRID_RED Required 2-norm reduction for this grid in a multiple grid solve.
(real)
Default: 0.01
R5000.0.1 Run Control: Solver Parameters (SOLVER) 265

Notes:
1. There is currently no iterative solver for the facilities equations.
2. All GRIDSOLVER data can be set by grid or field by enclosing the input between the GRIDS
… ENDGRIDS input. See the section “Setting Controls by Grid or Field”.
Examples:
SOLVER RESERVOIR ITERATIVE

CYCLELENGTH 20
MAXCYCLES 20
GLOBALTOL 0.0001
SOLVER RESERVOIR GLOBALTOL 0.0002

FACILITIES EXTENDED
SOLVER ALL GLOBALTOL 0.0001 MAXCYCLES 50
! Set IMPLICIT_COUPLING ROWSUM and IMPLICIT_PRECON HALF_FAST for

! grids 2 and 3
! Set PRESS_RED for grid 1
! All other GRIDSOLVER parameters will take their default values
GRIDSOLVER IMPLICIT_COUPLING ROWSUM
GRIDS 2 3
GRIDSOLVER IMPLICIT_PRECON HALF_FAST
ENDGRIDS
GRIDS 1
GRIDSOLVER PRESS_RED 0.02
ENDGRIDS

Minimum and Maximum Run Pressure
The minimum and maximum pressure used in the run are specified as follows:
PMAX pmax
PMIN pmin
where:
PMAX Introduces the maximum pressure allowed in the run. (psia, kPaa,
(Kg/cm2)a, bara, psia). Default: The minimum of 25000 psia or the
maximum pressure which will result in non-negative PVT
properties.
PMIN Introduces the minimum pressure allowed in the run. (psia, kPaa,
(Kg/cm2)a, bara, psia). Default: 14.7 psia or the largest minimum
pressure entry in the PVT properties.
Examples:
PMAX 15000.0
R5000.0.1 Run Control: Minimum and Maximum Run Pressure 267

Timestepping Method
The method used for timestepping is specified as follows:
METHOD IMPES
IMPLICIT
where:
METHOD Introduces timestepping method data. All METHOD data can be

set by grid. See the section “Setting Controls by Grid or Field”.
IMPES Specifies that the following grids will use IMPES timestepping.
This is the default for all grids.
IMPLICIT Specifies that the following grids will use IMPLICIT timestepping.
Notes:
1. METHOD data can be set by grid or field by enclosing the input between the GRIDS …
ENDGRIDS input. See the section “Setting Controls by Grid or Field”.
Examples:
METHOD IMPLICIT
268 Run Control: Timestepping Method R5000.0.1

DRSDT Option
Specification of the DRSDT option limits the rate at which the solution gas ratio can increase in a
gridblock. Normally, the rate of increase is determined by the black oil data tables. In a grid sys-
tem that has the DRSDT option applied, the rate at which gas can enter the oil is possibly further
constrained, which leads to the formation of more free gas. Note that the limit is always con-
strained by the maximum value in the black oil saturated table data, even if the limit for the
DRSDT keyword is set to a very high number.
The 2PHASE option directs that the DRSDT constraint is only applied to gridblocks that already
have both oil and gas phases. This prevents the situation where two undersaturated oils with dif-
ferent Rs values mix and then form a free gas phase because of the DRSDT constraint.
Different limiting values can be specified for different grids or different reservoirs.
DRSDT LIMIT limit(2PHASE)
where:
DRSDT Introduces the DRSDT option. All DRSDT data can be set by grid.
See the section “Setting Controls by Grid or Field”.
LIMIT The limiting value in units (MSCF/STB/day, m3/m3/day, m3/m3/

day, m3/m3/day, cc/cc/hour).
2PHASE Specifies that the DRSDT constraint is only applied to gridblocks

that already have both oil and gas phases. By default, this is not in
effect.
Notes:
1. DRSDT data can be set by grid or field by enclosing the input between the GRIDS … END-
GRIDS input. See the section “Setting Controls by Grid or Field”.
Examples:
DRSDT LIMIT 0.0 2PHASE
R5000.0.1 Run Control: DRSDT Option 269

EOS Options
The options used by the EOS flash can be changed as follows:
EOSOPTIONS label or ALL

ZGIBBS
TOL tol
TRANSITION NEIGHBOR (TOLDZ toldz) or
TEST or
ALL
TRANS_TEST GIBBS or
PSAT
FUGERR fugerr
PHASEID PREVIOUS or
FLASH or
OIL or
GAS or
PSAT
INIT_SINGLE OIL or
GAS or
V
ALPHAMU alphamu
The above keywords are described in greater detail below:
label The label of an EOS PVT method which the options will apply to.
ALL The options apply to all EOS methods.
ZGIBBS If this option is selected, during the Z-factor selection process, the
Z-factor that provides the lowest Gibbs free energy for the phase is
selected. Normally, this option is off, and the lowest Z-factor is
selected for the liquid phase, and the largest Z-factor is selected for
the vapor phase.
270 Run Control: EOS Options R5000.0.1

TOL Flash tolerance. The flash calculation converges when
FUGERR
⎛ 1 – f------
2
v, i⎞
Σ ⎝ f ⎠
- < TOL
i=1 l, i
(Default 1.0e-4)

(default) or PSAT.
GIBBS. Phase transition (1 hydrocarbon phase to 2 hydrocarbon

phases) determined by Gibbs stability test. A second phase
emerges if its introduction results in the lowering of the Gibbs free
energy of the system. (Use instead of INCRP or PSAT)
INCRP. Phase transition (1 hydrocarbon phase to 2 hydrocarbon

phases) determined by increasing pressure method. In this method,
a series of 8 flashes are performed, starting at 90% of the grid-block
pressure, and increasing to the grid-block pressure. At each stage,
the K-values are extrapolated to the next higher pressure. It is
possible that a second loop of increasing pressures calculations are
performed. The second loop consists of a sequence of 5 flashes,
starting at 99.93% of the grid-block pressure and increasing to the
grid-block pressure. The PHASEFRAC keyword described below
controls the criteria for entering the second loop. (Default, can be
overridden by GIBBS or PSAT keyword.)
PHASEFRAC. The second increasing loop is entered if the first

loop fails on the last increment and the mole phase fraction is
within PHASEFRAC of the phase boundary. For example, if a
liquid fails to evolve a vapor phase on the last step, and the vapor
mole fraction is less than PHASEFRAC at the second last step, then
the second loop would be entered. The second loop uses much
smaller pressure increments so as to not mistakenly miss the
R5000.0.1 Run Control: EOS Options 271

PSAT. Phase transition (1 hydrocarbon phase to 2 hydrocarbon

phases) determined by saturation pressure test. A second phase
emerges if the grid-block pressure is lower than the calculated
saturation pressure. (Use instead of INCRP or GIBBS)

performed. Possible options are NEIGHBOR, TEST or ALL
NEIGHBOR. All single phase grid blocks which neighbor a two

phase grid block (except well grid blocks) will use K-values from
the neighbor block as the starting point to test for the emergence of
a second phase. Well grid blocks will use the increasing pressure
method. Single phase blocks which are adjacent to other single
phase blocks which are not of the same phase are also tested, if the
sum of the absolute value of the component mole fractions is
greater than TOLDZ. The increasing pressure method is also used
in single phase blocks. (Default)
TOLDZ. The threshold value for applying the phase transition test
when two adjacent blocks are of difference single phase types. The
absolute value of the differences between the mole fractions of the
hydrocarbon components are summed and compared to TOLDZ.
The default value is 0.05
TEST. All single phase grid blocks which neighbor a two phase
grid block, and all well grid blocks, will undergo a test for the
emergence of a second phase. The test used depends on the method
selected by the TRANSITION_TEST keyword. If no test is
specified, the increasing pressure method is used.
ALL. All single phase grid blocks are tested for the emergence of a
second phase using the increasing pressure method.
PREVIOUS, DENSITY, FLASH, OIL_INITIAL, OIL,
GAS_INITIAL, GAS or PSAT
PREVIOUS. Use label applied during previous timestep. (Default)
DENSITY. Base label on whether the mass density of a phase is

above or below the specified THRESHOLD value. Fluids with
density above the threshold value are labeled as oil, while fluids
with density below the threshold value are labeled as gas.
FLASH. Base the phase label on the vapor mole fraction calculated
from a set of increasing pressure flash calculations.
272 Run Control: EOS Options R5000.0.1

OIL. Always label a single phase fluid as an oil.
GAS. Always label a single phase fluid as a gas.
PSAT. Label a single phase fluid based on the result of a saturation

pressure calculation. A bubble point fluid is labeled as an oil, while
a dew point fluid is labeled as a gas.
INIT_SINGLE Option for determining the labeling of a single phase hydrocarbon

system during initialization calculations. Possible options are OIL,
GAS or V.
OIL. Always label a single phase hydrocarbon as oil,
GAS. Always label a single phase hydrocarbon as gas,
V. Label a single phase, depending on the vapor mole fraction

obtained from the flash calculation.(Default)

Example:
EOSOPTIONS myEOS
PHASEID PREVIOUS
R5000.0.1 Run Control: EOS Options 273

Time Data
TIME time
or
TIME date
where:
TIME Introduces time data
time The time when the following run control data will be applied.
(days, days, days, hours)
date The date when the following run control data will be applied. The
date can be specified in the format mm/dd/yyyy or mm/dd/
yyyy(hh:mm:ss). If the time (hh:mm:ss) is not given, it will be
taken to be (0:0:0) I.e midnight of the previous day.
Examples:
TIME 100.0
TIME 1/1/2000
TIME 10/04/2000(08:00:00)
274 Run Control: Time Data R5000.0.1

Include files
One level of include files are permitted in the RUNCONTROL file. These are specified as fol-
lows:
INCLUDE filename
where:
INCLUDE Introduces the name of an include file. The file name can use a
relative or absolute path.
Examples:
INCLUDE runcontrol.dat
R5000.0.1 Run Control: Include files 275

Example Run Control File
DESC Run Control File

START 03/18/1994
!
! Initial time step size 0.001 days, Max time step 5.0 days
!
DT AUTO 0.001
MIN 0.001
MAX 5.0
DCMAX ALL 0.05
!
! Use IMPES timestepping
!
METHOD IMPES
!
! Output arrays are pressure, So, Sg and Sw (Go to the .out file)
!
ARRAYOUT
P
SAT OIL GAS WATER
ENDARRAYOUT
!
! Output maps are pressure, So, Sg and Sw (Go to the .map file)
!
MAPOUT
P
SAT OIL GAS WATER
ENDMAPOUT
!
! Output frequencies
!
OUTPUT ARRAYS DT 365.0
MAPS DT 365.0
WELLS DT 100.0
PERFS DT 100.0
RESTART DT 365.0
WELLPLOT FREQ 1
FIELDPLOT FREQ 1
ENDOUTPUT
TIME 2800.0
STOP
276 Run Control: Example Run Control File R5000.0.1

Well Specification Data
In This Chapter
• Requirements.
• Well Specification Table.
• Relative Permeability scaling for Well Completions.
• Well Modification Table.
• INCLUDE files.
• Time Data.
• Example well file
All the data for a set of wells is input in a single file. Well files are included in a case in the
RECURRENT_FILES section as follows:
RECURRENT_FILES
WELLS set 1 filename1
WELLS set 2 filename2
....
The well names used in each file must be unique.
R5000.0.1 Well Specification Data: In This Chapter 277

Well Specification Data
The following sections describe the specification and modification of wells for the Nexus® soft-
ware.
Requirements
Each well must be defined in a WELLSPEC table. For each grid block that a well is completed
in, the grid block index, KH, Skin, wellbore radius and effective grid block radius must be speci-
fied.
Calculation of the Wellbore Constant for each completion
The wellbore constant is calculated as follows:
wbc = 5.61458 * 0.001127 * kh * pperf * wi (1)
where kh is the permeability*(wellbore length) product for the grid block, pperf is a partial perfo-
ration factor (which can be used to shut in the completion if it is set to 0), and wi is the wellbore
index.
The wellbore index wi, is calculated as follows:
wi = 2 π * (angle/360.0) / (ln(radb/radw) + skin) (2)
where angle is the angle open to flow, radb is the effective grid block radius, radw is the wellbore
radius and skin is the skin factor. However, wi can be input in the WELL table, in which case the
input value is used instead of the calculated value. radb, radw and skin must still be input in the
WELL table, but are not used unless radw or skin are modified. If modified values of radw or
skin are input, then equation 2 is used to recalculate wi.
278 Well Specification Data: Requirements Well Specification Data R5000.0.1

Wellbore Sub-Network Configuration
The Nexus software automatically generates a gridded wellbore representation for each well from
the well perforation data described in this chapter (WELLSPEC) and from the well connection
data (WELL) specified in the next chapter. Each entry in the WELLSPEC table usually represents
a perforation, or a connection from the specified reservoir grid cell to a network node at the center
of the (optionally specified) wellbore section. An entry in the WELLSPEC table may also repre-
sent an unperforated node in the wellbore connected to one or more perforated nodes, but we still
refer to these entries here as ‘perforations’. These unperforated nodes are allowed so that input
data requirements are minimized when constructing complex wellbore configurations (see the
examples at the end of the Surface Network Description Section). The default section number is
the perforation number in the order specified. This optionally specified section number is used
when the wellbore is located on a boundary between two or more cells, such as in a radial case
with multiple angular increments. The section number could also be used to generate a ‘coarse’
wellbore model relative to the reservoir grid, such that groups of grid cells singly penetrated by a
section of wellbore are connected to a single network node. This is not recommended, as it vio-
lates the assumptions inherent in the reservoir pressure correction term in the perforation flow
equations and leads to less accurate modeling of the pressure drops in the wellbore.
Since as many perforations as desired may be defined in the WELLSPEC table for any given grid
cell, the amount of ‘refinement’ in the gridded wellbore model is completely user controlled by
the number of defined perforations and sections. A single network node is created for each sec-
tion, at the depth specified in the WELLSPEC table for the first perforation in the section (all per-
foration depths in a given section should be the same and equal to the depth at the center of the
wellbore section). All perforations in the section are attached to the section node. These ‘perfn-
odes’ are automatically connected to one another sequentially in the order of their section number.
For other than simple linear, single flow channel wellbores (like branching wellbores with more
than two branches, or wells with annular/tubular communication), the user must define nodes in
the wellbore (in a WELLNODE table) and connect these well nodes appropriately as described in
the Surface Network chapter. The default flow directions of these perfnode connections are
inferred from the well type specified in the WELL data (producer or injector).
R5000.0.1Well Specification Data: Wellbore Sub-Network Configuration Well Specification Data 279
Well Specification Table (WELLSPEC)
Wells are specified as follows:
WELLSPEC well_name
CELL KH RADB (PORTYPE)(RADW) (SKIN) (WI) (PPERF) (IRELPM) (SECT)(GROUP) (ZONE) (ANGLE) (DEPTH)
cell kh radb (portype)(radw) (skin) (wi) (pperf) (isat) (isect) (group) (zone) (angle) (depth)
cell kh radb (portype)(radw) (skin) (wi) (pperf) (isat) (isect) (group) (zone) (angle) (depth)
. . . . . . . . . . . . . .
. . . . . . . . . . . . . .
Additional Columns
(X) (Y)(K)TEMP)(FLOWSECT)(MD)(PARENT)(MDCON)(LENGTH) IW JW GRID ANGLEA ANGLEV KHMULT L
(x) (y)(k)(temp)(flowsect)(md)(parent)(mdcon)(length)(iw)(jw)(grid)(anglea)(anglev) (khmult)(l)
(x) (y)(k)(temp)(flowsect)(md)(parent)(mdcon)(length)(iw)(jw)(grid)(anglea)(anglev) (khmult)(l)
. . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . .
where:
WELLSPEC Keyword introducing well specification data
well_name Well name. The well name must start with an alpha character or a
number, and should not contain the % character.
CELL Column heading keyword indicating that the entries in this column
are the cell indices for each completion (integer). The index should
be the global cell index, corresponding to the indices specified in
the GLOBALCELL data input. An entry of NA can be used to
indicate an unperforated node. In this case, NA should also be used
for all other columns except SECT and DEPTH.
KH Column heading keyword indicating that the entries in this column

are the KH values (permeability*wellbore length) for each
completion.
RADB Column heading keyword indicating that the entries in this column
are the effective grid block radii for each completion.
PORTYPE (Dual only.) Column heading keyword indicating that the entries in
this column are the porosity type for each completion. This column
must be entered and set to FRAC for multi-porosity cases.
RADW Column heading keyword indicating that the entries in this column
are the wellbore radii for each completion. Default: 0.25
SKIN Column heading keyword indicating that the entries in this column
are the skin factors for each completion. Default: 0
280 Well Specification Data: Wellbore Sub-Network Configuration Well Specification Table (WELL-
WI Column heading keyword indicating that the entries in this column

are the well indices for each completion. If the WI column is
present, the completion will use the input WI, and will not
calculate WI from SKIN, RADB and RADW. (Dimensionless).
PPERF Column heading keyword indicating that the entries in this column
are the partial perforation factors for each completion. pperf
multiplies the wellbore constant to account for partial penetration.
A value of 0 would shut in the completion. (Fraction). Default: 1
IRELPM Column heading keyword indicating that the entries in this column
are the relative permeability methods used for each completion.
Default: The grid block relative permeability method.
SECT Column heading keyword indicating that the entries in this column
are the section of the wellbore to which this completion flows. This
is primarily used for radial grid well completions, where several
grid blocks in the circumferential direction connect with the same
section of the wellbore. It can also be used to “lump” completions,
so that the wellbore is represented by fewer nodes in the network.
(See Network Configuration in the Surface Network section).
Default: Natural ordering. I.e The default behavior is that the first
completion flows to the first section of the wellbore, the second
completion flows to the second section of the wellbore etc.
GROUP Column heading keyword indicating that the entries in this column
are the workover group assignment for this completion. This is
used by the predictive well management workover functions. All
completions assigned to the same workover group may be worked
over as a unit.
Default: Natural ordering. I.e the first completion is assigned to the

first workover group, the second completion to the second
workover group etc.
ZONE Optional column heading keyword indicating that the entries in this
column are the Zone assignment for this completion. Zone
assignments are used when drawdown or buildup constraints are
specified. (See DPBHMX in the surface network CONSTRAINT
section). A value of 0 specifies that this completion will not be
considered when evaluating whether the drawdown or buildup
constraint is violated.
Default: 1.
R5000.0.1Well Specification Data: Wellbore Sub-Network Configuration Well Specification Table (WELL-
ANGLE Column heading keyword indicating that the entries in this column
are the angle open to flow for this completion (Degrees). This is
primarily used for radial grid well completions, where several grid
blocks in the circumferential direction connect with the same
section of the wellbore.
DEPTH Column heading keyword indicating that the entries in this column
are the depths for this section of the wellbore. Depth is required for
unperforated nodes. This depth should correspond to the center of
the wellbore at the midpoint of the section. An entry of # can be
used to indicate that the default value of the cell depth will be used.
(Note that there is no default for an unperforated node). For
multiple completions in a section, the depth for all the completions
is the depth of the first completion in the section. (ft, m, m, m, cm).
Note: Only the first depth specified for each section will be used.
X Column heading keyword indicating that the entries in this column

are the x coordinate locations for this section of the wellbore. For
multiple perforations in a section, the x location for all the
completions is the x coordinate location of the first completion in
the section. This will be used to calculate the connection lengths
between wellbore sections and the default length for the connection
to the bottom hole node. (ft, m, m, m, cm).
Y Column heading keyword indicating that the entries in this column

are the y coordinate locations for this section of the wellbore. For
multiple perforations in a section, the y location for all the
completions is the y coordinate location of the first completion in
the section. This will be used to calculate the connection lengths
between wellbore sections and the default length for the connection
to the bottom hole node. (ft, m, m, m, cm).
TEMP Column heading keyword indicating that the entries in this column
are the temperatures for this section of the wellbore. For multiple
completions in a section, the temperature for all the completions is
the temperature of the first completions in the section.
Temperatures are used by the pressure drop correlations. (See the
surface network section). (F, C, C, C, C).
Default: Cell temperature if reservoir temperature is input,

otherwise standard temperature.
FLOWSECT Column heading keyword indicating that the entries in this column
are the flow section for this completion. Flow sections can be used
to mark sections of the wellbore with different flow properties
(such as tubing diameter), or to mark different laterals in a
multilateral well. All completions with the same flowsect must be

input consecutively. Default: 1.
MD Column heading keyword indicating that the entries in this column

are measured depth for this completion. Entries are required for all
perfs if PARENT and MDCON input is present, or if the well will
be specified in a WELLNODES table in the surface network input.
(ft, m, m, m, cm). Default: Cell depth.
PARENT Column heading keyword indicating that the entries in this column
are the parent flow section to which the first completion in the
current flow section will connect. This input is only applicable to
the first completion in a flow section. Default: The preceding flow
section.
MDCON Column heading keyword indicating that the entries in this column
are measured depth where the current flow section will connect to
it’s parent. This input is only applicable to the first completion in a
flow section. (ft, m, m, m, cm). Default: The end of the parent
flow section.
LENGTH Column heading keyword indicating that the entry in this column is
the length of the perforated interval. (ft, m, m, m, cm).
The permeability-thickness of the perforation will be the default calculation times the multiplier
The following keywords are used to define perforations only when the structured grid format is
used. Refer to “ASCII Structured Grid Case File” on page 31.
IW x(i) direction gridblock index of the block containing the

perforation
JW y(j) direction gridblock index of the block containing the

perforation
K Effective permeability values for the grid block.
GRID Grid name to which the perforation data applies.
ANGLA Angle (in degrees) of the well segment with respect to the x axis in
the areal plane.
ANGLV Angle (in degrees) of the well segment with respect to the x axis in
the areal plane.
KHMULT The permeability-thickness of the perforation will be the default

calculation times the multiplier.
R5000.0.1Well Specification Data: Wellbore Sub-Network Configuration Well Specification Table (WELL-
L Column heading keyword indicating that the entries in this column

are the layer indices for each completion (integer).
Notes:
1. An unperforated node in the wellbore can be created by specifying a value of NA for all col-
umns except the required DEPTH column, and SECT if needed.
2. Measured depth data is used to create the default network connections for multilateral wells,
and also to create nodes in the wellbore for smart well configurations.
Example:
WELLSPEC well1
CELL KH SKIN RADW RADB
18 432.1 0.0 0.5 3.71
43l 364.2 0.0 0.5 3.71
Relative Permeability Scaling (WELLSPEC continued)
Relative permeability endpoints for well completions can be specified using additional columns
in the WELLSPEC table. The additional (optional) columns are:
(SWL) (SWR) (SWU) (SGL) (SGR) (SGU) (SWRO) (SGRO)

(swl) (swr) (swu) (sgl) (sgr) (sgu) (swro) (sgro)
(swl) (swr) (swu) (sgl) (sgr) (sgu) (swro) (sgro)
. . . . . . . .
. . . . . . . .
(SGRW) (KRW_SWRO) (KRW_SWU) (KRG_SGRO) (KRG_SGU) (KRO_SWL) (KRO_SWR) (KRO_SGL)

(sgrw) (krw_swro) (krw_swu) (krg_sgro) (krg_sgu) (kro_swl) (kro_swr) (kro_sgl)
. . . . . . . .
. . . . . . . .
(KRO_SGR) (KRW_SGL) (KRW_SGR) (KRG_SGRW) (SGTR) (SOTR)

(kro_sgr) (krw_sgl) (krw_sgr) (krg_sgrw) (sgtr) (sotr)
(kro_sgr) (krw_sgl) (krw_sgr) (krg_sgrw) (sgtr) (sotr)
. . . . . .
. . . . . .
where:
SWL Column heading indicating the minimum water saturation to be

used for each completion. (Fraction).
Default. The minimum water saturation for table the table specified
in the IRELPM column.
SWR Column heading indicating the residual water saturation to be used

for each completion. (Fraction).
Default. The residual water saturation for the table specified in the
IRELPM column.
SWU Column heading indicating the maximum water saturation to be

used for each completion. (Fraction).
Default. The maximum water saturation for the table specified in

the IRELPM column.
SGL Column heading indicating the minimum gas saturation to be used

Default. The minimum gas saturation for the table specified in the
IRELPM column.
R5000.0.1Well Specification Data: Wellbore Sub-Network Configuration Relative Permeability Scaling

SGR Column heading indicating the residual gas saturation to be used

Default. The residual gas saturation for the table specified in the
IRELPM column.
SGU Column heading indicating the maximum gas saturation to be used

Default. The maximum gas saturation for the table specified in the
IRELPM column.
SWRO Column heading indicating the water saturation at residual oil to

water to be used for each completion. (Fraction).
Default. The water saturation at residual oil to water for the table
specified in the IRELPM column.
SGRO Column heading indicating the gas saturation at residual oil to gas
to be used for each completion. (Fraction).
Default. The gas saturation at residual oil to gas for the table
SGRW Column heading indicating the gas saturation at residual water to be

used for each completion. (GASWATER systems only). (Fraction).
Default. The gas saturation at residual oil to gas for the table
KRW_SWRO Column heading indicating the value to be used for Krw at Swro for
each completion. (Fraction).
Default. The value for Krw at Swro for the table specified in the
IRELPM column.
KRW_SWU Column heading indicating the value to be used for Krw at Swu for
Default. The value for Krw at Swu for the table specified in the
IRELPM column.
KRG_SGRO Column heading indicating the value to be used for Krg at Sgro for
Default. The value for Krg at Sgro for the table specified in the
IRELPM column.
286 Well Specification Data: Wellbore Sub-Network Configuration Relative Permeability Scaling
KRG_SGU Column heading indicating the value to be used for Krg at Sgu for
Default. The value for Krg at Sgu for the table specified in the
IRELPM column.
KRO_SWL Column heading indicating the value to be used for Kro at Swl for
Default. The value for Kro at Swl for the table specified in the
IRELPM column.
KRO_SWR Column heading indicating the value to be used for Kro at Swr for
Default. The value for Kro at Swr for the table specified in the
IRELPM column.
KRO_SGL Column heading indicating the value to be used for Kro at Sgl for
each completion. (Must equal KRO_SWL if Sgl = 0). (Fraction).
Default. The value for Kro at Sgl for the table specified in the
IRELPM column.
KRO_SGR Column heading indicating the value to be used for Kro at Sgr for
Default. The value for Kro at Sgr for the table specified in the
IRELPM column.
KRW_SGL Column heading indicating the value to be used for Krw at Sgl for
each completion. (GASWATER fluid systems only). (Fraction).
Default. The value for Krw at Sgl for the table specified in the
IRELPM column.
KRW_SGR Column heading indicating the value to be used for Krw at Sgr for
Default. The value for Krw at Sgr for the table specified in the
IRELPM column.
KRG_SGRW Column heading indicating the value to be used for Krg at Sgrw for
Default. The value for Krw at Sgrw for the table specified in the
IRELPM column.
R5000.0.1Well Specification Data: Wellbore Sub-Network Configuration Relative Permeability Scaling

SGTR Column heading indicating the maximum trapped gas saturation to

be used for each completion. This applies to gas-oil hysteresis
cases. (Fraction).
SOTR Column heading indicating the maximum trapped gas saturation to

be used for each completion. This applies to water-oil hysteresis
cases. (Fraction).
Notes:
1. All WELLSPEC data for a well should be entered in a single WELLSPEC table.
2. Endpoint and hysteresis saturation rules:
a. If the IRELPM of the perf and block are the same, and the particular endpoint or
hysteresis saturation header does not appear on the WELLSPEC card, then the
perforation is assigned the endpoint or hysteresis saturation of the perforation block.
b. If an endpoint or hysteresis saturation header appears on the WELLSPEC card, then that
value is honored as long as endpoint scaling/hysteresis is active for the perforation.
c. If the IRELPM of the perf does not equal the IRELPM on the WELLSPEC card, then the
endpoints and hysteresis saturations are taken from the tables and/or hysteresis
keywords. Endpoint scaling is not available in this case. To implement endpoint scaling,
the user must specifically put the values on the WELLSPEC card.
Example:
WELLSPEC well1
CELL KH SKIN RADW RADB SWL SWR SWU
18 432.1 0.0 0.5 3.71 0.16 0.16 0.82
43l 364.2 0.0 0.5 3.71 0.18 0.18 0.76
288 Well Specification Data: Wellbore Sub-Network Configuration Relative Permeability Scaling
Well Modification Data
Well modification data is specified as follow:
WELLMOD well_name KH CON value

SKIN VAR value1 value2 ...... valuenp
RADW
WI
PPERF
IRELPM
where:
WELLMOD Introduces well modification data
well_name Well name
KH Introduces new KH data for the well. This will replace the data
input in the well specification (WELLSPEC) table, and result in
calculation of a new wellbore index. (md-ft, md-m, md-m, md-cm).
SKIN Introduces new skin data for the well. This will replace the data
input in the well specification (WELLSPEC) table, and result in
calculation of a new wellbore index. (Dimensionless).
RADW Introduces new wellbore radius data for the well. This will replace
the data input in the well specification (WELLSPEC) table, and
result in calculation of a new wellbore index. (ft, m, m, m, cm).
WI Introduces new wellbore index data for the well. This will replace
the data input in the well specification (WELLSPEC) table, and
override the wellbore index calculated from any prior input of
SKIN or RADW. (Dimensionless).
PPERF Introduces new partial perforation data for the well. This will
replace the data input in the well specification (WELLSPEC) table.
(Fraction).
IRELPM Introduces new relative permeability method assignments for the

well. This will replace the data input in the well specification
(WELLSPEC) table.
CON Indicates that a constant value will apply to all completions for the
well.
VAR Indicates that a value will be input for each completion in the well.
The subscripts on the values following the VAR keyword refer to
R5000.0.1Well Specification Data: Wellbore Sub-Network Configuration Well Modification Data 289
the completion index. np is the total number of completions for the

well, which is defined by the well specification data (WELL table).
valuei The new value for the specified well parameter for the ith
completion.
Examples:
WELLMOD well1SKINCON -1.0
WELLMOD well2PPERFVAR 1.0 1.0 0.0 0.0 0.5! well2 should be completed
! in 5 grid blocks
WELLMOD well3KH VAR 10.5 23.5 5*50.0

RADW CON 0.5
290 Well Specification Data: Wellbore Sub-Network Configuration Well Modification Data
Include files
One level of include files are permitted in the WELLS file. These are specified as follows:
INCLUDE filename
where:
Examples:
INCLUDE include_wells.dat
R5000.0.1 Well Specification Data: Wellbore Sub-Network Configuration Include files 291
Time Data
Time data is specified as follows
TIME time
or
TIME date
where:
time The time when the following well data will be applied. (days, days, days,
hours).
date The date when the following well data will be applied. The date can
be specified in the format mm/dd/yyyy or mm/dd/yyyy(hh:mm:ss). If
the time (hh:mm:ss) is not given, it will be taken to be (0:0:0) I.e
midnight of the previous day.
Examples:
TIME 100.0
TIME 1/1/2000
TIME 10/04/2000(08:00:00)
292 Well Specification Data: Wellbore Sub-Network Configuration Time Data R5000.0.1
Example well file
WELLSPEC P-1
64 500.0 0.0 3.5 117.9126
128 500.0 0.0 3.5 117.9126
TIME 12/12/1996
WELLSPEC I-1
1 500.0 0.0 3.5 117.9126
65 500.0 0.0 3.5 117.9126
TIME 16/11/2001
R5000.0.1 Well Specification Data: Wellbore Sub-Network Configuration Example well file 293
294 Well Specification Data: Wellbore Sub-Network Configuration Example well file R5000.0.1
Surface Network
In This Chapter
• Surface Network Description
• Network Fluid System
• Stream Composition Specification
• Default Network Temperature
• Dependency of Density on Temperature
• Multi-Reservoir Input
• Node Definition Data
• Default Connection Data
• Default Injection Well Mobility Treatment
• Default Crossflow Treatment
• Default Treatment for Datum Pressure Constraints
• Well Connection Data
• Wellhead Data
• Wellbore Data
• Wellnode Data
• Node Connection Data
• Tree Structured Network Data
• Combining Wells in a Multi-Reservoir Run
• Rig Data
R5000.0.1 Surface Network: In This Chapter 295

• Drillsite Data
• Reinjection Streams
• Pressure Drop Correlation Data
• Elevation Profiles
• Temperature Profiles
• Temperature Gradient Profiles
• Hydraulics Options
• Fluid Gradient Calculation Data
• Separation and Stream Splitting Node Data
• Commingled Production
• Simplified Heat Transfer
• Well Lists
• Connection Lists
• Node Lists
• Rig Lists
• Drill Parameters
• 2D Array of Connections
• Network Rate Constraint Data
• Network Pressure Constraint Data
• Network Drawdown/Buildup Constraints
• Network Rate Limits
• Well and Perforation Limits
• Fuel Shrinkage and Constraints
• Miscellaneous Constraint Data
• Multiple Rate Data
296 Surface Network: In This Chapter R5000.0.1

• Production and Injection Targets
• Connection Rate Data for Targets
• Guide Rate Formula
• Remote Control of Well Constraints
• Remote Control of Rate Constraints
• Gas Lift Ontime
• Gas Lift Optimization Parameters
• Activating and Deactivating Connections
• Water-Alternating-Gas (WAG) Wells
• Connection Shut In Parameters
• Valve Procedure Parameters
• Reopening Shut In Connections
• Wells included in RFT report
• Include files
• Skipping data for multifield runs
• Time Data
• Example surface network files
All the data for a surface network is input in a single file. The surface network is included in a
case in the RECURRENT_FILES section as follows:
RECURRENT_FILES
SURFACE set 1 filename1
Currently only one surface network file can be specified.
R5000.0.1 Surface Network: In This Chapter 297

Surface Network Description
The Nexus® software models the well and surface facility system as a set of nodes, connections
between the nodes, connections from nodes to reservoir grid cells (perforations), connections
from nodes to sinks (production), and connections from sources to nodes (injection). Nodes may
represent points along a flow channel (at a junction of 2 connections) or a junction of 3 or more
connections. Junction nodes may be stream-combining, stream-splitting (with outflows of equal
composition), or separation nodes. Separation nodes may represent a stage in an equilibrium sep-
aration. For compositional fluid systems, separation nodes may also represent any separator bat-
tery or gas plant defined in one of the separator method files. Internal connections (those other
than sink and source connections) may represent specified devices or they may represent flow
channels (referred to as ‘pipe connections’) that may contain implied devices. Specific device
models are available for valves and chokes. They relate the device setting to hydraulics behavior,
and allow the imposition of both maximum and minimum device setting (hydraulics) constraints,
in addition to any user-specified constraints. Any number of devices, such as a pumps, compres-
sors, chokes, valves, or other flow control devices may be implied to be present in internal con-
nections through specifications of constraints and appropriate hydraulics. Any constraint
specified to be controlled in a given connection implies a device in that connection unless a spe-
cific device model is assigned to it. The hydraulics relationship defined for the connection con-
taining an implied device represents that at the maximum operating, or fully open setting. This
setting may be effectively reduced by the model to meet any rate or pressure constraints specified
to be controlled by the device. Terminal connections (sinks and sources) contain an implied
device that is always maintaining a user-specified rate or pressure constraint (no hydraulics
apply). Hydraulics options for pipes and other implied devices currently include the use of
hydraulics tables, pressure drop correla¬tions, and the use of hydrostatic fluid pressure gradients
(computed implicitly or explicitly, or specified). Hydraulics options appropriate for compressors
are currently limited to hydraulics tables.
A wellbore sub-network representation is automatically generated for each well. The ‘terminal’
nodes (nodes connected to sources or sinks) and sink or source connections for each well sub-net-
work are automatically assigned the same name as the well, so that wells are easily connected
together into networks by redefining these ‘well connections’. In the case of individually con-
strained wells with no modeled network, all required network data including pressure and rate
constraints may be simply input using the well name as in conventional simulators.
The primary variables in the network model are component mass rates in perforations and in net-
work connections, and node pressures. The network model equations consist of modified well
model equations describing the component or total flow between the reservoir and the network
nodes in the wellbore through the perforations, component mass balances at nodes, and some
combination of the following: hydraulics relationships (from hydrostatic gradients or tables or
correlations) relating the node pressures of each connection, rate constraint equations on connec-
tions, pressure constraint equations on nodes, equal composition constraints for multiple connec-
tions outflowing from the same node, separation equations, and source composition constraints.
298 Surface Network: Surface Network Description R5000.0.1

The network model equations are fully coupled with the reservoir grid system equations (through
the perforation flow equations and the network node mass balances) in the global solution at the
end of each simulator Newton iteration. The network model equations are also fully decoupled
from the reservoir grid system and solved independently by Newton iteration to determine the
state of the network within each simulator Newton iteration, assuming that the reservoir variables
are fixed at their current iterate value. The network model is or can be (with some restrictions)
fully implicit with regard to all network and reservoir variables and applied constraints. The for-
mulation allows relatively simple incorporation of current features which are difficult to imple-
ment in more conventional formulations, such as:
• gridded wellbore
• automatic crossflow
• branching wellbores with inter-branch crossflow and independent branch control capability
• variable wellbore hydrostatic pressure gradients (when used) as a function of wellbore

composition and wellbore pressure
• arbitrary numbers and types of specified rate and pressure constraints (for wells and
anywhere in the network) with automatic limiting constraint determination
• implicit application of limiting constraints
• implicit perforation grid cell mobilities in the IMPES formulation
• injected fluid density is computed as a function of variable perforation composition and

wellbore pressure
R5000.0.1 Surface Network: Surface Network Description 299

Assumptions
1. Steady State.
2. The network temperature can be specified by user input, or calculated by a simplified heat
transfer calculation.
3. By default, rate constraints are controlled (by an implied valve) in the connection on which
they are specified. The control point (location of the implied valve) may be changed by user
input.
4. By default, minimum pressure constraints are controlled (by an implied valve) in the connec-
tion downstream of the node on which they are specified. If the node has more than one
downstream connection, the constraint cannot be applied. The control point (location of the
implied valve) may be changed by user input.
5. By default, maximum pressure constraints are controlled (by an implied valve) in the connec-
tion upstream of the node on which they are specified. If the node has more than one
upstream connection, the constraint cannot be applied. The control point (location of the
implied valve) may be changed by user input.
6. Kinematic and frictional pressure losses are neglected when hydrostatic gradients are used.
7. Phase equilibrium in the wellbore (equilibrium flashes are performed in evaluating hydro-
static gradients, in-situ rate constraints, and injected fluid densities).
8. Backflow is allowed between network nodes connected to reservoir grid cells (perfnodes), so
that crossflow is automatically modeled. A zero total backflow rate constraint applies by
default to all other connections (check-valves are assumed), which, except for connections to
sinks, can be overridden by the user.

Requirements
For cases in which all wells are individually bottomhole pressure, tubinghead pressure, and/or
rate constrained, and no surface network is actually modeled, data requirements are similar to
conventional reservoir simulators, and include only well connection data (WELL), constraint data
specified by well name (CONSTRAINTS), and for compositional cases with gas injection, stream
composition data (STREAMS).
Tubing connections to the wellheads may be created using the WELLHEAD table, and tree struc-
tured networks may be created using the GROUP table. For all other configurations, node defini-
tion data (NODES) and node connection data (NODECON) are additionally required.
For non-tree-shaped injection and production networks and for specifications of minimum and
maximum pressure constraints on connected nodes, there are requirements for hydraulics method
specifications. Between any specified minimum pressure and any specified maximum pressure
must lie a connection using a hydraulics method in which the pressure drop is an implicit function
of the rates of the stream (that is, either hydraulics tables or correlations must be used). A hydrau-
lics function that is, for example, a function of gas rate alone is not sufficient if only oil and water
are flowing. For multiple outflows from a node in a production network, each outflow must have
in its linear series of connections at least one connection in which the pressure drop is an implicit
function of its rate. Source connections into production networks representing satellite produc-
tion must have in their linear series at least one connection in which the pressure drop is a func-
tion of its rate. If these requirements are not met, and if data checking is insufficient to detect it,
violation of these requirements will result in a singular system and run failure.
Other requirements and restrictions include:
1. NODES data must precede NODECON and CONSTRAINTS data.
2. For compositional models, STREAMS data must precede NODECON data (and must pre-
cede WELL data if a stream name is specified).
3. NODECON data must precede CONSTRAINTS data.
4. All multiple outflow paths from a node must contain a connection in which the pressure drop
is a function of rate (i.e. either a perforation connection or a connection using hydraulics
tables). Otherwise, the flow rate allocation among the multiple paths may be indeterminate. If
none of the connections in a path satisfy this criterion, then a very small pressure drop term,
proportional to total mass rate, is added to the first connections out of the node. If the rates
are not determined by constraints, this pressure drop will determine the fraction of fluid flow-
ing in each outflow path, which may not be what the user intends.
5. Only one sink or source may be attached to a given node, except that multiple sinks may be
attached to separation nodes.
6. Terminal nodes (nodes attached to a sink or a source) that have multiple inflow connections
(multiple outflow connections for sources), must have no backflow allowed on the inflow

(outflow) connections.
7. Separation nodes may have only one inflow.
8. A minimum pressure must be specified at terminal sink nodes, and a maximum pressure must
be specified at terminal source nodes.
9. Separation nodes must have some inflow contribution from the reservoir.
10. See section on separation nodes for discussion of associated constraint limitations.

Network Configuration
The Nexus software automatically generates a gridded wellbore representation for each well from
the well perforation data described in the previous chapter (WELLSPEC) and from the well con-
nection data (WELLS) specified in this chapter. Each entry in the WELLSPEC table usually rep-
resents a perforation, or a connection from the specified reservoir grid cell to a network node at
the center of the (optionally specified) wellbore section. An entry in the WELLSPEC table may
also represent an unperforated node in the wellbore connected to one or more perforated nodes,
but we still refer to these entries here as ‘perforations’. These unperforated nodes are allowed so
that input data requirements are minimized when constructing complex wellbore configurations.
The default section number is the perforation number in the order specified. This optionally spec-
ified section number is used when the wellbore is located on a boundary between two or more
cells, such as in a radial case with multiple angular increments. The section number could also be
used to generate a coarse wellbore model relative to the reservoir grid, such that groups of grid
cells singly penetrated by a section of wellbore are connected to a single network node. A single
network node representing the entire lumped, or mixed, wellbore can be specified with the section
number, or all wellbores may be specified as being lumped by default in the CONDEFAULTS
table
Since as many perforations as desired may be defined in the WELLSPEC table for any given grid
cell, the amount of refinement in a gridded wellbore representation is completely user controlled
by the number of defined perforations and sections. A single network node is created for each
section, at the depth specified in the WELLSPEC table for the first perforation in the section. (All
perforation depths in a given section should be the same and equal to the depth at the center of the
wellbore section.) All perforations in the section are attached to the section node. These ‘perfn-
odes’ are automatically connected to one another sequentially in the order of their section number.
The default flow directions of these perfnode connections are inferred from the well type speci-
fied in the WELLS data (producer or injector). For other than simple linear, single flow channel
wellbores (like branching wellbores with more than two branches, or wells with annular/tubular
communication), the user must define nodes in the wellbore in a WELLNODE table, then connect
these nodes appropriately for the desired well configuration. Hydraulics methods for the wellbore
connections default to computed hydrostatic gradients, and may be specified using the WELL-
BORE table.
The automatically generated node corresponding to section n is named wellname%k, where k is

the first perf in the section, in the order defined in the WELLSPEC table. The automatically gen-
erated wellbore connection between section n-1 and section n is wellname%k, with a default
direction depending on whether the well is a producer or injector. A connection named
wellname%bh is automatically made between the withdrawal/injection node wellname%1 to a
bottom hole node. If a bottom hole depth is not entered in the WELLS table, then it is defaulted to
the depth of the first perf. If the bottom hole node is at the same location as the first perf, the con-
nection wellname%bh is a ‘ghost’ connection and there is no pressure change across the connec-
tion. A default sink or source connection, named wellname, is attached to node wellname. The
well sink and source connections may then be optionally redefined to connect to user-defined
nodes to form networks.

The DATUM option on the well card provides for bottom hole pressures to be corrected to datum
depth.
If the wellbore configurations correspond to the default linear configurations, all wells are indi-
vidually controlled by bottomhole pressure, tubinghead pressure, or rate, and no gathering system
(network) is desired, then well rate and pressure constraints are simply input using the well name
in the CONSTRAINTS data, and no additional user-specified network configuration data is
required. To apply tubinghead pressure constraints, input on the hydraulics method to use for the
tubing must also be input (WELLHEAD data). Alternatively, tree-structured injection and pro-
duction networks may be generated by the program as directed in the GROUP table.
If the default wellbore configurations do not require modification, then the rest of the network (if
any) is easily constructed by the user with NODES and NODECON data, redefining the default
source and sink connections to the individual wells using the well names for the names of the well
connections and the well nodes.
If the wellbore configuration is not simple, the user must define wellbore nodes in a WELLNODE
table, then connect these nodes to reflect the configuration of the well in a NODECON table.

Example 1
We illustrate the automatic generation of the wellbore configuration for a branched production
well with 2 branches. The perforated length of each branch passes through 3 grid cells, with a sin-
gle perforation defined in each grid cell, each connected to a separate node. The perforation in
each flow section must be ordered starting with the perforation closest to the offtake point.
WELLSPEC well1
CELL KH SKIN RADW RADB DEPTH FLOWSECT PARENT MD MDCON
18 432.1 0.0 0.5 3.71 # 1 NA 5150 NA
23l 364.2 0.0 0.5 3.71 # 1 NA 5250 NA
468 295.4 0.0 0.5 3.71 # 1 NA 5350 NA
92 489.9 0.0 0.5 3.71 # 2 NA 5175 5010
359 395.5 0.0 0.5 3.71 # 2 NA 5275 NA
592 934.5 0.0 0.5 3.71 # 2 NA 5375 NA
The # in the depth column indicates that the midpoint of each perforated section is at reservoir cell
depth.
The WELLS table for this well might be:
WELLS
NAME STREAM BHDEPTH BHMD
Well1 PRODUCER 4950 5000
ENDWELLS
The WELLS table indicates that the default explicit hydrostatic fluid pressure gradient will be
used in the wellbore, that the well is a producer, and the bottomhole node is at a depth of 4950,
and a measured depth of 5000.

The well sub-network generated for this well is shown in Figure 1. The default node names are
shown in red italics, and connection names in black. The dashed lines and cell numbers indicate
the perforations.
well 1
well1
well1%bh
well1%b1
well1%1 well1%5
well1%5 92
18 well1%1 well1%6
well1%2
well1%6 359
231 well1%2
well1%7
well1%3
well1%7
592
468 well1%3
Figure 1
A tubing connection to the wellhead can also generated using WELLHEAD data.
WELLS
NAME STREAM BHDEPTH BHMD
well1 PRODUCER 4950 5000
ENDWELLS
WELLHEAD
NAME WELL METHOD
well1_wh well1 1
ENDWELLHEAD

In this case, hydraulics table 1 is assigned to the connection from the withdrawal node to the well-
head. The node at the wellhead is called well1_wh, and a connection named well1_wh is automat-
ically connected to a sink. The resulting default wellbore configuration is shown in Figure 2.
well1_wh
well 1_wh
well 1
well1
well1%bh
well1%b1
well1%1 well1%5
well1%5 92
18 well1%1 well1%6
well1%2
well1%6 359
231 well1%2
well1%7
well1%3
well1%7
592
468 well1%3
Figure 2

Example 2
This example illustrates the modifications required to the default wellbore configuration in order
to create a “smart well” configuration, with production from the reservoir through the perforated
casing into the annulus, and with valves (sleeves) controlling flow from the annulus into the tub-
ing contained inside the casing. Annular flow in the casing is blocked by packers above and
between three perforated sections of the wellbore.
WELLSPEC P-1
CELL KH SKIN RADW RADB MD
1080 500.0 0.0 3.5 117.9126 5050
1264 500.0 0.0 3.5 117.9126 5150
1440 500.0 0.0 3.5 117.9126 5250
1772 500.0 0.0 3.5 117.9126 5350
1956 500.0 0.0 3.5 117.9126 5450
2140 500.0 0.0 3.5 117.9126 5550
!
! ADDTUBING entry of 1 adds 1 tubing string from the bottom
! hole node down through the perforated section of the wellbore.
! Because there is only one flow section in the WELLSPEC data, the
! tubing is given a flowsection index of 2.
!
WELLS
NAME STREAM TYPE METHOD BHMD ADDTUBING X Y BHDEPTH DIAM ROUGHNESS
P-1 PRODUCER PIPE HAGEDORN 4950 1 100 100 4900 3.5 0.0005
ENDWELLS
WELLNODE
NODE WELL MD FLOWSECT CONNECT
P-1-T1 P-1 5000 2 YES ! Point in tubing, just
! below packer 1
P-1-A1 P-1 5000 1 NO ! Point in annulus, just
! below packer 1
! below packer 2
! below packer 2
! below packer 3
! below packer 3
ENDWELLNODE

NODECON
NAME NODEIN NODEOUT
VALVE1 P-1-A1 P-1-T1 ! valve connecting annulus to tubing
ENDNODECON
Figure 3

Network Fluid System
The fluid system used in the network is defined as follows:
BLACKOIL or
GASWATER or
WATEROIL or
API or
EOS NHC nhc COMPONENTS cpt(1) cpt(2) ... cpt(n)
where:
BLACKOIL Specifies that all fluids in the network will use BLACKOIL pvt
methods. (This is the default)
GASWATER Specifies that all fluids in the network will use GASWATER pvt
methods.
WATEROIL Specifies that all fluids in the network will use WATEROIL pvt
methods.
API Specifies that all fluids in the network will use API pvt methods.
EOS Specifies that all fluids in the network will use EOS pvt methods.
NHC Specifies that all fluids in the network will have nhc hydrocarbon
components. This keyword is required for an EOS fluid system,
and must be immediately after the EOS keyword.
COMPONENTS Specifies that all fluids in the network must have components
named cpt(1) through cpt(n). This keyword is required for an EOS
fluid system, and must be immediately after the NHC keyword.
Notes:
1. This input must precede any STREAMS, NODECON and WELL input.
2. The number of hydrocarbon components must be the same in the network fluid system and
all reservoir grids connected to it (through the WELLSPEC well specification data).
Example:
EOS NHC 7 C1 C2 C3 C4 C5 C6 C7+
310 Surface Network: Network Fluid System R5000.0.1

Stream Composition Specification (STREAMS)
The composition of each source stream input to a terminal node of an injection sub-network is
defined as follows:
STREAMS
NAME cpt(1) cpt(2) ... cpt(nc)
name z1 z2 ... znc
name z1 z2 ... znc
ENDSTREAMS
where:
STREAMS Keyword indicating the start of the STREAMS table.
on the following lines are stream names.
name Stream name. The name must start with an alpha character.
cpt A component name. For EOS fluid systems, the component names
should be the same as those given on the EOS COMPONENTS
input with the addition of WATER. For black oil fluid systems, the
names are OIL, GAS and WATER. For dry gas fluid systems, the
names are GAS and WATER. The entries in the columns below the
component names are either mole fractions for EOS models or
mass fractions for black oil models. Columns of components which
have a fraction of zero need not be input. The sum of the fractions
must equal 1.
ENDSTREAMS Keyword indicating the end of the STREAMS table.

Notes:
1. Input is required only for compositional models with gas injection.
2. There is one stream automatically created for each component. It consists of only that com-
ponent, and uses the component name as the stream name. The automatically defined
streams are GAS, WATER and OIL for black oil models, GAS and WATER for gas water
models, WATER and OIL, for water oil models, GAS, OIL1, OIL2 and WATER for API
models, and WATER plus each component name for compositional models. Additional
streams may be defined in the STREAM table.
Example:
STREAMS
NAME C1 C2 C3
R5000.0.1 Surface Network: Stream Composition Specification (STREAMS) 311

stream1 0.5 0.5 0.0

stream2 0.5 0.25 0.25
312 Surface Network: Stream Composition Specification (STREAMS) R5000.0.1

Default Network Temperature (NETTEMP)
The default temperature for nodes in the network is defined as follows.
NETTEMP temp
where:
NETTEMP Introduces the default temperature which will be used for all nodes
which do not have temperatures input in a NODES table. (F, C, C,
C, C)
Default: 100 Fahrenheit
Notes:
Currently, node temperatures are only used in evaluating fluid properties for pressure drop corre-
lations for EOS runs.
Example:
NETTEMP 80.0
R5000.0.1 Surface Network: Default Network Temperature (NETTEMP) 313

Dependency of Density on Temperature (DEN_TEMP)
In compositional runs, the density of hydrocarbon phases is always dependent on temperature.
Hydrocarbon phase densities will also be dependent on temperature if temperature dependent

tables are input for API, black oil, water/oil, or gas/water fluid systems.
The DEN_TEMP option causes densities of hydrocarbon phases to be adjusted for API, black oil,
water/oil, or gas/water fluid systems even when only a single temperature is entered.
The adjustment is performed with the following equation:
ρ- = T ref
-------- --------
-
ρ ref T
Definitions:
ρ = the adjusted density
ρ ref = the density calculated at the table temperature
T = the connection temperature

Tref = the temperature of the table
The required keyword is
DEN_TEMP
where:
DEN_TEMP The existence of this keyword causes the adjustment...
314 Surface Network: Dependency of Density on Temperature (DEN_TEMP) R5000.0.1

Multi-Reservoir Input (RESV)
In the master network file of a multi-reservoir run, network names (e.g. connection, well and node
names) are treated as if they are unique. I.e. a network name from one of the individual reservoir
network files, which is referred to in the master network file, is not used in any of the other indi-
vidual reservoir network files. If a network name is not unique, then the reservoir where it is
defined may be input as follows:
RESV resv_name
…..
ENDRESV
where:
RESV Introduces a reservoir name, which must be present in the master

case file. Network names will then be resolved by looking for a
match with network names which were defined in the network file
for that reservoir. If there is no match, then names defined in the
other network files are checked, and the name must be unique.
ENDRESV Terminates the RESV input section. Network names input after this
point will no longer look for a match in a particular reservoir. I.e.
All network names referred to (in the master network file) must be
unique.
Notes:
1. This input is only valid in the master network file.
2. RESV input must be terminated with ENDRESV input before the next TIME input.
3. Only the logic to resolve network names is affected by this input. Method numbers will still
refer to methods input in the master case file.
Example:
NODES
NAME DEPTH
GATHP 5000.0
TERMP 5000.0
ENDNODES
RESV resv1
NODECON
NAME NODEIN NODEOUT
P-1 P-1 GATHP
ENDNODECON
R5000.0.1 Surface Network: Multi-Reservoir Input (RESV) 315

ENDRESV
RESV resv2
NODECON
NAME NODEIN NODEOUT
P-1 P-1 GATHP
ENDNODECON
ENDRESV
NODECON
NAME NODEIN NODEOUT
GATHP GATHP TERMP
SINKP TERMP SINK
NODECON
In this example, connection P-1, and node P-1 are defined in the network files for both reservoir
resv1, and reservoir resv2. Nodes GATHP and TERMP, and connections GATHP and SINKP are
defined in the master network file, and there are no similarly named nodes or connections in either
resv1 or resv2. By enclosing the connection of P-1 to GATHP inside RESV resv1 … ENDRESV,
the P-1 name is resolved by first checking the network connection and node names which were
defined in the network file for reservoir resv1. The name GATHP is also first checked against
node names in that reservoir's network file, and therefore this name must be unique (i.e., must not
exist in the network file for either reservoir), otherwise the name could not be resolved.
316 Surface Network: Multi-Reservoir Input (RESV) R5000.0.1

NODE Definition Data (NODES)
User-defined nodes in the surface network model are defined as follows.
NODES
NAME (TYPE) (DEPTH) (X) (Y) (NUMBER) (TEMP)
name(1) (type(1)) (depth(1)) (x(1)) (y(1)) (i(1)) (temp(1))
name(2) (type(2)) (depth(2)) (x(2)) (y(2)) (i(2)) (temp(2))
.
.
name(n) (depth(n)) (x(n)) (y(n)) ( i(n))(temp(n))
ENDNODES
where:
NODES Keyword indicating the start of the NODES table.
n Number of specified nodes.
on the following lines are node names.
name Node name. The name must start with an alpha character or a
number, and should not contain the % character except to redefine a
default wellbore node.
TYPE Column heading in keyword indicating that the entries in this

column specify the node type. The node type can be WELLHEAD,
which identifies the node as a well head node, or NA which means
the node is a normal node.
Default: NA
type The node type.
DEPTH Column heading keyword indicating that the entries in this location
on the following lines are node depths. (ft, m, m, m, cm)
Default: 0.0
depth The node depth.
X Column heading keyword indicating that the entries in this location

on the following lines are the node x coordinate location. (ft, m, m,
m, cm)
x The node x coordinate location.

Default: None for nodes, or the x value specified for the well.
R5000.0.1 Surface Network: NODE Definition Data (NODES) 317

Y Column heading keyword indicating that the entries in this location

on the following lines are the node y coordinate location. (ft, m, m,
m, cm)
y The node y coordinate location.

Default: None for nodes, or the y value specified for the well.
NUMBER Introduces a number which can be used instead of the node name to
specify constraint data.
TEMP Column heading keyword indicating that the entries in this location
on the following lines are the node temperatures. (F, C, C, C, C)
ENDNODES Alpha label indicating the end of the NODES data.
Notes:
The only purpose for redefining a wellbore node is so that it can be used as a node when calling a
procedure. The x, y and depth values are not used for a wellbore node.
Example:
NODES
NAME DEPTH
node1 100.0
node2 -50.0
node3 -25.0
node4 25.0
ENDNODES
318 Surface Network: NODE Definition Data (NODES) R5000.0.1

Default Connection Data (CONDEFAULTS)
Much of the data for connections can be defaulted. The CONDEFAULTS table provides a means
of customizing the default values which will be applied.
CONDEFAULTS
CONTYPE (DIAM) (INNERDIAM) (ROUGHNESS) (TYPE) (METHOD) (IBAT) (IPVT) (IWAT)
CONNECTION or (diam) (innerdiam) (ruf or NOFRICT) PIPE GRADCALC (ibat) (ipvt) (iwat)
BHCON or or PIPE ihyd
WELLBORE or or PIPE pdcorr
WELL or or PIPE MIXED
or PIPE CELLAVG
or PIPE CELLGRAD
or PIPEGRAD CALC
or PIPEGRAD grad
or LUMPED MIXED
or LUMPED CELLAVG
. . . . . . . . .
. . . . . . . . .
ENDCONDEFAULTS
Additional Columns:
(ONTIME) (HTC)
(ontime) (htc)
where:
CONDEFAULTS Keyword indicating the start of the CONDEFAULTS table.
CONTYPE Column heading keyword indicating that the entries in this location
on the following lines are connection types. The column entry
CONNECTION refers to any non-well connection, BHCON refers
to the connection from the bottom hole node to the wellbore node at
the first perforation, WELLBORE refers to connections in the
perforated section of the wellbore, and WELL refers to the
connection from the bottom hole node to the rest of the network.
The default WELL connection connects the well to a SINK or a
source, but if a network is present, it will be reconnected in a
NODECON, GROUP or WELLHEAD table to the appropriate
node in the network. Often, the WELL connection will represent
the tubing from the bottom hole node to the surface.
DIAM Optional column heading, indicating that the entries in this location
are the default connection diameters. Only used if pressure drop
R5000.0.1 Surface Network: Default Connection Data (CONDEFAULTS) 319

correlations are used in a connection. (Inches, cm, cm, cm, cm)

Default: 6 inches for CONNECTION, otherwise 3.5 inches.
INNERDIAM Optional column heading, indicating that the entries in this location
are the default connection inner diameters. Only used if pressure
drop correlations are used in a connection. The inner diameter
refers to the inner diameter of an annulus. I.e the outer diameter of
the inner pipe. The diameter, is the inner diameter of the outer pipe.
(Inches, cm, cm, cm, cm)
Default: 0
ROUGHNESS Optional column heading, indicating that the entries in this location
are the default connection roughness, or the keyword NOFRICT.
Only used if pressure drop correlations are used in a connection. If
NOFRICT is input, the frictional pressure drop will be ignored.
(Inches, mm, mm, mm, mm)
Default: 0
IPVT Optional column heading keyword indicating that the entries in this
location on the following lines are the default connection PVT table
numbers. (Not used for wellbore connections)
Default: 1 for CONNECTION, the PVT method used by the grid

block for the connecting perforation for BHCON, or WELL
connections.
IWAT Optional column heading keyword indicating that the entries in this
location on the following lines are the default connection Water
PVT table numbers. (Not used for wellbore connections)
Default: 1 for CONNECTION, the Water PVT method used by the

grid block for the connecting perforation for BHCON, or WELL
connections.
IBAT Optional column heading keyword indicating that the entries in this
location on the following lines are the default connection separator
table numbers. (Not used for wellbore connections)
Default: 1.
ONTIME Optional column heading keyword indicating that the entries in this
location on the following lines are the default ontime factors.
(Fraction). (Only used for Well connections)
Default: 1.0.
TYPE Optional column heading keyword indicating that entries in this

location on the following lines specify the type of connection, and
should be either PIPE for a pipe, tubing string or annulus, or
320 Surface Network: Default Connection Data (CONDEFAULTS) R5000.0.1

PIPEGRAD for a pipe, tubing string or annulus where the pressure

change across the connection is determined from a specified
density gradient, or LUMPED for a lumped (single node) wellbore.
LUMPED is only valid for a CONTYPE input of WELLBORE.
Default: PIPE
PIPE Specifies that the connection type is a PIPE. For a WELLBORE,

this means that the wellbore will be gridded -- i.e., each perforation
will flow to a different node in the wellbore.
PIPEGRAD Specifies that the connection type is a PIPE, and it will have either a
specified gradient, or the program will calculate the gradient. For a
WELLBORE, this means that the wellbore will be gridded -- i.e.,
each perforation will flow to a different node in the wellbore.
LUMPED Specifies that the connection type is a single node for each flow
section in the wellbore. This is only valid for a CONTYPE of
WELLBORE.
METHOD Optional column heading keyword. The entries in this location

depend on the keyword input in the TYPE column. For a PIPE, the
method is either GRADCALC, a hydraulics method table number,
or a pressure drop correlation method. (See PDCORR table input.)
For a CONTYPE of WELLBORE, the method can also be MIXED,
CELLAVG, or CELLGRAD. GRADCALC is the default. For a
PIPEGRAD (a special kind of pipe), the method is the fluid density
gradient (psi/ft) or CALC. The default is CALC. Note that a TYPE
of PIPEGRAD with a method of CALC is the same as a TYPE of
PIPE and a method of GRADCALC. For a CONTYPE of
WELLBORE, and a TYPE of LUMPED, the method can be
MIXED or CELLAVG.
Default: PIPE GRADCALC
GRADCALC Specifies that the fluid density gradient to be used for pressure drop
calculations in a PIPE connection will be calculated by the
simulator.
ihyd The hydraulics method (table) number (integer).
pdcorr The name of a pressure drop correlation. (See PDCORR input.)

The default methods are NOSLIP, DUKLER, DUKEAT, BEGGS,
HAGEDORN, DUNROS, HAG_BEG, AZIZ, SUPRIB, AND
ORKISZ).
MIXED Specifies that the fluid density gradient to be used for pressure drop
calculations in the wellbore will be calculated assuming the fluids

in the wellbore are fully mixed. (Only valid for the WELLBORE
contype.)
CELLAVG Specifies that the fluid density gradient to be used for pressure drop
calculations in the wellbore will be calculated from the mobility
weighted gradient of all perforated grid blocks for the well. (Only
valid for the WELLBORE contype.)
CELLGRAD Specifies that the fluid density gradient to be used for pressure drop
weighted gradient of the perforated grid blocks that flow to the
nodes at each end of the wellbore connection. (Only valid for the
WELLBORE contype that is not LUMPED.)
CALC Specifies that the fluid density gradient to be used for pressure drop
calculations in a PIPEGRAD connection will be calculated by the
simulator.
grad The fluid density gradient (real). (psi,ft, kPa/m, (Kg/cm2)/m, Bars/
m, psi/cm)
LUMPED Specifies that the wellbore will be modeled with a single node
located at the average depth of the perfs. (Only valid for the
WELLBORE contype.) (This input is obsolete, but is still
accepted.) It should be replaced by specifying LUMPED in the
TYPE column.
HTC Optional column heading keyword indicating that the entry in this
location is the default heat transfer coefficient. ((BTU/(hr*ft2*F),
W/(m2*K), W/(m2*K), W/(m2*K))
Default: 1.0 BTU/(hr*ft2*F) for CONNECTION, otherwise 3.0
BTU/(hr*ft2*F).
ENDCONDEFAULTS Keyword indicating the end of the CONDEFAULTS table.
Note:
In a multifield run, the input specified in a CONDEFAULTS table in the multifield network file
only apply to connections which are first defined in the multifield network file (i..e., connections
which are first defined in one of the individual reservoir network files will not take default values
from a CONDEFAULTS table input in the multifield network file). Note that CONNECTION is
the only connection type relevant to multifield.
Example:
CONDEFAULTS
CONTYPE DIAM ROUGHNESS METHOD
322 Surface Network: Default Connection Data (CONDEFAULTS) R5000.0.1

CONNECTION 3.5 0.0001 BEGGS

ENDCONDEFAULTS

Default Injection Well Mobility Treatment
The default method to calculate the fluid mobility at injection wells is specified as follows.
INJMOB TOTAL, ENDPT or ENDPTECL
Where:
INJMOB Keyword introducing default injection well mobility treatment.

This sets the mobility treatment for all the wells, unless it is
subsequently overridden by input in a WELLS table.
TOTAL Specifies that the sum of the mobility of all fluids in the grid block
will be used. This is the default.
ENDPT Specifies that the endpoint relative permeability of the injected

phase will be used to calculate the mobility. I.e Water injectors
will use the endpoint water relative permeability, and gas injectors
will use the endpoint gas relative permeability.
ENDPTECL Specifies that the endpoint relative permeability of the injected

phase will be used to calculate the mobility, in the same manner as
ECLIPSE™. I.e Water injectors will use the endpoint water
relative permeability, and gas injectors will use the endpoint gas
relative permeability. ECLIPSE uses the endpoint relative
permeabilities, even when Sw is greater than Swro.
Notes:
1. The default method specified by this input will be used unless overridden by later input in a
WELLS table.
Example:
INJMOB ENDPT
324 Surface Network: Default Injection Well Mobility Treatment R5000.0.1

Default Crossflow Treatment (CROSSFLOW)
The default crossflow behavior for wells can be turned specified as follows:
CROSSFLOW ON or OFF
SHUTINON or SHUTINOFF or SHUTIN_CELLGRAD
where:
CROSSFLOW Keyword introducing crossflow data. This sets the crossflow

behavior for wells, unless subsequently overridden by input in a
WELLS table.
ON Specifies that the wells are allowed to crossflow. This is the default
if the default explicit fluid gradients are used (if no GRADIENT
IMPLICIT card is input). This will be ignored if implicit gradients
are used.
OFF Specifies that the wells are not allowed to crossflow. This option is
forced if implicit gradients have been specified using GRADIENT
IMPLICIT.
SHUTINON Specifies that the shutin wells are allowed to crossflow.
SHUTINOFF Specifies that the shutin wells are not allowed to crossflow. This is
the default.
SHUTIN_CELLGRAD Specifies that the shutin wells are allowed to crossflow, and that the
wellbore gradient for each wellbore connection (the connections
between nodes in the wellbore) will be the average of the mobility
weighted grid block density gradients for the perforated cells
flowing to the nodes at each end of the connection.
Notes:
1. The default method specified by this input will be used unless overridden by later input in a
WELLS table.
2. Usually, the simulator will run more smoothly with crossflow on, so this is the recommended
option. When crossflow is off, timestep size and Newton convergence can be adversely
affected by well completions turning on and off over time.
3. The default method of calculating the gradient in the wellbore can result in oscillating flow
directions in the wellbore if the well is perforated over the oil zone and the gas or water zone,
when the well is shut in. For example, on one iteration, gas from a gas zone may try to flow
downward toward the oil zone, resulting in a gas gradient in the wellbore. But when the well-
R5000.0.1 Surface Network: Default Crossflow Treatment (CROSSFLOW) 325

bore has a gas gradient, it may be impossible for gas to enter the wellbore, so on the next iter-
ation, oil flows upward in the wellbore, resulting in an oil gradient. Neither iteration is
correct, because the current formulation does not allow for a static fluid column with a gas/
liquid interface in the wellbore. The SHUTIN_CELLGRAD option can mitigate this prob-
lem.
Example:
CROSSFLOW ON
326 Surface Network: Default Crossflow Treatment (CROSSFLOW) R5000.0.1

Default Treatment for Datum Pressure Constraints

(DATUM)
If a datum depth is specified for a well, the default treatment for applying pressure constraints at
the bottom hole node is specified as follows:
DATUM WELLGRAD or
MOBGRAD or
OILGRAD or
GASGRAD or
WATERGRAD
where:
DATUM Keyword introducing default datum constraint data. This sets the
treatment for datum pressure constraints at wells, unless
subsequently overridden by input in a WELLS table.
WELLGRAD Specifies that the well bottom hole pressures will be adjusted to
datum using the density gradient of the fluid flowing in the bottom
hole connection, evaluated at the bottom hole pressure.
MOBGRAD Specifies that the well bottom hole pressures will be adjusted to
datum using the mobility weighted reservoir density gradient in the
perforated grid blocks. This is the method used by the VIP®
software.
OILGRAD Specifies that the well bottom hole pressures will be adjusted to
datum using the initial average density gradient of the oil phase.
GASGRAD Specifies that the well bottom hole pressures will be adjusted to
datum using the initial average density gradient of the gas phase.
WATERGRAD Specifies that the well bottom hole pressures will be adjusted to
datum using the initial average density gradient of the water phase.
Notes:
1. By default, OILGRAD will be used if there is oil present in-situ, otherwise GASGRAD will
be used if there is free gas, otherwise WATGRAD will be used if only water is present. The
default method will be used unless overridden by later input in a WELLS table.
Example:
DATUM MOBGRAD
R5000.0.1 Surface Network: Default Treatment for Datum Pressure Constraints (DATUM) 327
Well Connection Data (WELLS)
Data to specify a well connection and properties for the well’s bottom hole connection (the con-
nection from the bottom hole node to the well’s withdrawal or injection node), is specified in a
WELLS table.
WELLS
NAME (STREAM) (NUMBER) (SCALE) (BHDEPTH) (DATUM) (X) (Y) (LENGTH) (DATGRAD)
Well_name PRODUCER or (n) (scale) (bhdepth) (depth) (x) (y) (length) (WELLGRAD or
. stream_name . . . . . . . MOBGRAD or
or WAG . . . . . . . OILGRAD or
. . . . . . . . . GASGRAD or
. . . . . . . . . WATERGRAD or
. . . . . . . . . grad)
. . . . . . . . . .
ENDWELLS
Additional Columns:
(BHMD) (ADDTUBING) (DIAM) (INNERDIAM)(ROUGHNESS) (TYPE) (METHOD) (IBAT) (IPVT) (IWAT)

(bh md) (itube) (diam) (innerdiam) (ruf or NOFRICT) PIPE and GRADCALC (ibat) (ipvt) (iwat)
or PIPE and MIXED
or PIPE and ihyd
or PIPE and pdcorr
or PIPEGRAD and CALC
or PIPEGRAD and grad
. . . . . . . . . . .
. . . . . . . . . . .
(TEMP) (ELEVPR) (TEMPPR) (INJMOB) (CROSSFLOW) (CROSS_SHUT) (ONTIME) (HTC)

(temp) (elevpr) (temppr) TOTAL or ON or OFF ON or OFF (ontime) (htc)
. . . ENDPT or . . . .
. . . ENDPTECL . . . .
NA
(DPADD) (RATEMULT) (WIMULT) (PI) (PIPHASE)

(dpadd) (ratemult) (wimult) (pi) (phase)
. . . . .
. . . . .
where:
WELLS Keyword indicating the start of the WELLS table.
NAME Column heading keyword indicating that the entry in this location
on the following lines is a well name. The name must start with an
alpha character or a number, and should not contain the %
328 Surface Network: Well Connection Data (WELLS) R5000.0.1

character. The wildcard character (*) can be used to specify

multiple wells (which have been previously defined by WELLS
input). The well name should correspond to wells defined in the
WELLSPEC data.
STREAM Optional column heading, indicating that the entry in this location
is either the name of an injection stream (for injection wells), the
keyword PRODUCER, or the keyword WAG. WAG wells must be
connected to both a water and a gas source, as described in note
below. Default: PRODUCER
NUMBER Optional column heading, indicating that the entry in this location
is a number which can be used instead of the well name to specify
constraint data.
Default: none
SCALE Optional column heading, indicating that the entry in this location
is a scale factor used to scale the production or injection up to a full
well rate. This is used for pattern symmetry elements, where only a
fraction of the well is being simulated.
Default: 1.0
BHDEPTH Optional column heading, indicating that the entry in this location
is the depth of the well at bottom hole. (ft, m, m, m, cm)
Default: The depth of the connecting perforation
DATUM Optional column heading, indicating that the entry in this location
is the datum depth. Bottom hole pressures are specified at the
datum depth. (ft, m, m, m, cm)
Default: The bottom hole depth.
X Optional column heading, indicating that the entry in this location

is the x coordinate location of the bottom hole node. If specified,
this will be used to calculate the default length for the bottom hole
connection. (ft, m, m, m, cm)
Default: NA
Y Optional column heading, indicating that the entry in this location

is the y coordinate location of the wellbore section. If specified,
this will be used to calculate the default length for the bottom hole
connection. (ft, m, m, m, cm)
Default: NA
DATGRAD Optional column heading, indicating that the entry in this location
is specifies the method to be used to adjust pressure to the datum
depth. (Used for pressure constraints applied to the bottom hole
node.) An entry of WELLGRAD specifies that the pressure will be
R5000.0.1 Surface Network: Well Connection Data (WELLS) 329

adjusted to datum using the density gradient of the fluids flowing in

the bottom hole connection, evaluated at the bottom hole pressure.
MOBGRAD specifies that the well bottom hole pressures will be
adjusted to datum using the mobility weighted reservoir density
gradient in the perforated grid blocks. This is the method used by
the VIP software. OILGRAD specifies that the well bottom hole
pressures will be adjusted to datum using the initial average density
gradient of the oil phase. GASGRAD specifies that the well
bottom hole pressures will be adjusted to datum using the initial
average density gradient of the gas phase. WATERGRAD specifies
that the well bottom hole pressures will be adjusted to datum using
the initial average density gradient of the water phase. A specified
gradient can also be entered.
Default: Specified by DATUM input.
LENGTH Optional column heading, indicating that the entry in this location
is the length of the bottom hole connection. (ft, m, m, m, cm)
Default: Calculated from the distance from the bottom hole node to
the connecting perforation. If the X and Y locations of the bottom
hole node or connecting perforation are not input, they are assumed
to be coincident.
BHMD Column heading keyword indicating that the entry in this location
on the following lines is the measured depth at bottom hole. If
BHDEPTH is input, and a WELLNODE table is input, then BHMD
must also be input. (ft, m, m, m, cm)
Default: Bottom hole depth
ADDTUBING Column heading keyword indicating that the entry in this location
on the following lines is the number of tubing strings in the
perforated wellbore. By default, there is only one flow path in the
perforated wellbore, representing an open hole completion or
perforated casing. An entry of 1 would add a tubing string, and
result in two flow paths: the annulus between the casing and the
tubing, and the tubing. A new flow section (see the FLOWSECT
input in the WELLSPEC table) is added for each flow section in the
WELLSPEC table. If the number of flow sections in the
WELLSPEC table is nflow, then the tubing flow sections will be set
to the WELLSPEC flow section + nflow. The flow section can be
used to set the properties of wellbore connections in the
WELLBORE table. The tubing will have a node at the location of
each perforation, and will be connected to the bottom hole node by
default.
Default: 0

DIAM Optional column heading, indicating that the entry in this location
is the bottom hole connection diameter. Only used if pressure drop
correlations are used in the bottom hole connection. (Inches, cm,
cm, cm, cm)
Default: Specified in CONDEFAULTS Table
INNERDIAM Optional column heading, indicating that the entry in this location
is the bottom hole connection inner diameter. Only used if pressure
drop correlations are used in the bottom hole connection. The inner
diameter refers to the inner diameter of an annulus. I.e the outer
diameter of the inner pipe. The diameter, is the inner diameter of
the outer pipe. (Inches, cm, cm, cm, cm)
ROUGHNESS Optional column heading, indicating that the entry in this location
is the bottom hole connection roughness, or the keyword
NOFRICT. Only used if pressure drop correlations are used in the
bottom hole connection. If NOFRICT is input, the frictional
pressure drop will be ignored. (Inches, mm, mm, mm, mm)
IPVT Optional column heading keyword indicating that the entry in this
location on the following lines is the bottom hole connection PVT
table number.
Default: Specified in CONDEFAULTS Table.
IWAT Optional column heading keyword indicating that the entry in this
location on the following lines is the bottom hole connection Water
PVT table number.
IBAT Optional column heading keyword indicating that the entry in this
location on the following lines is the bottom hole connection
separator table number. (Inches, cm, cm, cm, cm)
TYPE Optional column heading keyword indicating that entry in this

location on the following lines specifies the type of connection, and
should be either PIPE for a pipe, tubing string or annulus, or
PIPEGRAD for a pipe, tubing string or annulus where the pressure
change across the connection is determined from a specified
density gradient.
METHOD Optional column heading keyword. The entry in this location

depends on the keyword input in the TYPE column. For a PIPE,
the method is either GRADCALC, MIXED, a hydraulics method

table number, or a pressure drop correlation method (See PDCORR

table input.) GRADCALC is the default. For a PIPEGRAD (a
special kind of pipe), the method is the fluid density gradient (psi/
ft) or CALC. The default is CALC. Note that a TYPE of
PIPEGRAD with a method of CALC is the same as a TYPE of
PIPE and a method of GRADCALC.
calculations in the well bottom hole connection will be calculated
by the simulator.
calculations in the well bottom hole connection will be calculated
assuming the fluids in the wellbore are fully mixed.
simulator.
m, psi/cm)
pdcorr The name of a pressure drop correlation. (See PDCORR table.)

(The default methods are NOSLIP, DUKLER, DUKEAT, BEGGS,
HAGEDORN, HAG_BEG, DUNROS, AZIZ, SUPRIB, and
ORKISZ).
TEMP Optional column heading, indicating that the entry in this location
is the temperature of the bottom hole node. Node temperatures are
used by the pressure drop correlations. (F, C, C, C, C)
Default: Same as the connecting wellbore node (See CONSECT.)
ELEVPR Optional column heading keyword indicating that the entry in this
location on the following lines is the name of an elevation profile or
the keywords NA or NONE. NONE specifies that there is no
elevation profile for the well bottom hole connection. Elevation
profiles are used by the pressure drop correlations.
Default: NA.
TEMPPR Optional column heading keyword indicating that the entry in this
location on the following lines is the name of a temperature or
temperature gradient profile or the keywords NA or NONE. NONE
specifies that there is no temperature profile for the well bottom
hole connection. Temperature profiles are used by the pressure

drop correlations.
Default: NA.
INJMOB Optional column heading keyword indicating that the entity in this
location on the following lines specifies the mobility treatment for
injection wells (not applicable to producers). TOTAL specifies that
the total fluid mobility will be used, ENDPT specifies that the
endpoint mobility will be used (for the water phase if water is the
injected stream, otherwise for the gas phase), and ENDPTECL
specifies that the endpoint mobility will be used, in the same
manner as ECLIPSE. ECLIPSE uses the endpoint relative
permeabilities, even when Sw is greater than Swro..
Default: Specified by INJMOB input.
CROSSFLOW Optional column heading keyword indicating that the entry in this
location on the following lines specifies the crossflow treatment for
the well when it is flowing. ON allows crossflow, and OFF
prevents crossflow.
Default: Specified by CROSSFLOW input.
CROSS_SHUT Optional column heading keyword indicating that the entry in this
location on the following lines specifies the crossflow treatment for
the well when it is shut in. ON allows crossflow, CELLGRAD
allows crossflow using the CELLGRAD method of determining the
wellbore gradient, and OFF prevents crossflow. CELLGRAD
calculates the wellbore gradient using the average of the mobility
weighted grid block density gradients, for the perforated cells
flowing to the nodes at each end of the connection. (See Note 3 in
the Default Crossflow Treatment (CROSSFLOW) section.)
Default: Specified by CROSSFLOW input.
ONTIME Optional column heading keyword indicating that the entry in this
location on the following lines is the ontime factor for the well.
(Fraction.)
location is the heat transfer coefficient. (BTU/(hr*ft2*F), W/
(m2*K), W/(m2*K), W/(m2*K), W/(m2*K))
Default: Specified in CONDEFAULTS table.
DPADD Optional column heading keyword indicating that the entry in this
location is an additional pressure drop that will be added to the
pressure drop calculated if the hydraulics method is a hydraulics
table, a pressure drop correlation, or a calculated hydrostatic
gradient. (psi, kPa, Kg/cm2, bars, psi)
Default: 0.

RATEMULT Optional column heading keyword indicating that the entry in this
location will multiply the flow rates used for hydraulics
calculations when the hydraulics method is a hydraulics table or a
pressure drop correlation. (dimensionless)
Default: 1
WIMULT Optional column heading keyword indicating that the entry in this
location will multiply the well index input in the WELLSPEC data.
The effect of this multiplier is not cumulative. I.e the multiplier is
always applied to the original well index input from a WELLSPEC
table, or the value last calculated in a procedure. (dimensionless)
Default: 1
PI Optional column heading keyword indicating that the entry in this

location will specify a productivity/injectivity index for the phase
rate specified in the PIPHASE column. The units are determined
by the specified phase rate. The PI is converted to a WIMULT
value when the well is first put on production/injection. If PI is
specified, then the entry for WIMULT should be NA.
Default: NA
PIPHASE Optional column heading keyword indicating that the entry in this
location will specify the phase rate for the PI calculation. The
possible entries are QOS, QGS, QWS, QLIQS, QO, QG, QW,
QLIQ, QHC, QALL. The phase rate determines the units for the PI
entry, as follows:
QOS - Surface Oil Rate. Not valid for an injection well. (STB/D-
psi, STm3/D-kPa, STm3/D-(Kg/cm2), STm3/D-bar, STcc/hr-psi)
QGS - Surface Gas Rate. Not valid for a water injector. (MSCF/D-
psi, STm3/D-kPa, STm3/D-(kg/cm2), STm3/D-bar, STcc/hr-psi)
QWS - Surface Water Rate. Not valid for a gas injector. (STB/D-
psi, STm3/D-kPa, STm3/D-(Kg/cm2), STm3/D-bar, STcc/hr-psi
QLIQS- Surface Liquid Rate. Not valid for a gas injector. (STB/D-
psi, STm3/D-kPa, STm3/D-(Kg/cm2), STm3/D-bar, STcc/hr-psi)
QO - Reservoir Oil Rate. Not valid for an injection well. (RB/D-

psi, m3/D-kPa, m3/D-(Kg/cm2), m3/D-bar, cc/hr-psi)
QG - Reservoir Gas Rate. Not valid for a water injector. (RB/D-

QW - Reservoir Water Rate. Not valid for a gas injector. (RB/D-

QLIQ- Reservoir Liquid Rate. Not valid for a gas injector. (RB/D-
QHC - Reservoir Hydrocarbon Rate. Not valid for a water injector.

(RB/D-psi, m3/D-kPa, m3/D-(Kg/cm2), m3/D-bar, cc/hr-psi)
QALL- Reservoir Total Rate, (RB/D-psi, m3/D-kPa, m3/D-(Kg/

cm2), m3/D-bar, cc/hr-psi)
Default: QOS for producers, QWS for water injectors, QGS for gas
injectors and WAG wells.
ENDWELLS Keyword indicating the end of the WELLS table.
Notes:
1. The well connection is the connection from the bottom hole node (located at the bottom hole
depth) to the rest of the network. By default, the rest of the network consists of a sink for pro-
duction wells, and a source for injection wells. No other network connections or nodes need
to be defined if the run uses bottomhole constraints.
2. The well bottom hole connection is the connection from the bottom hole node to the offtake
or injection node (see the examples at the start of this section), which is automatically given
the name well_name%bh, where well_name is the name specified in the WELLS table.
3. If either loops or connections between injection and production networks are defined, the
ONTIME option is not robust and should not be used. The option is an approximate method
of increasing timestep sizes by avoiding explicitly shutting in wells during expected or
observed periods of downtime. Wellbore constants for the perforations are scaled by the well
ontime factor. Specified rate constraints in connections are scaled by an explicitly computed
connection ontime factor. Hydraulics in connections are evaluated at the ‘full-on’ rate given
by the (ontime) connection rate divided by the connection ontime factor. Ontime factors sig-
nificantly less than unity (less than 0.9) are not recommended.
4. If a value is input for PI, the productivity/injectivity of the well is calculated, assuming a unit
drawdown/buildup at each perforation, using the perforation data input in the WELLSPEC
table. A wimult value for the well is set to the ratio of the input PI to the calculated produc-
tivity/injectivity of the specified phase rate.
5. In order for a well to be a WAG injector, it must be connected to two sources, one of which is
a water source, and the other a hydrocarbon source. This is illustrated in Figure 4 on
page 336. Injection is switched from water to gas by constraining the water injection rate
(QWSMAX) in Connection 1 to zero, while removing any constraints on Connection 2. Sim-

ilarly, to switch from gas to water, the gas injection rate (QGSMAX) would be constrained to
zero in Connection 2, and all constraints would be removed on Connection 1.
The wag procedures do this switching automatically. After cycling starts, any rate constraint
specified by the user for these connections will be ignored. The maximum injection rate of
gas or water is controlled by one of the connections in the linear series leading to the well,
which in this example would be Connection 3, the Wellhead Connection, or the Well connec-
tion. The user specifies these constraints (QWSMAX and QGSMAX) in a CONSTRAINTS
table, just like any other constraint data. The switching connections (Connections 1 and 2)
must be the last branch in the network before the well is reached.
Figure 4: Source Connections for WAG Wells
Water Gas
Water Source Gas Source
Connection Connection
Connections 1 &2
Connection 1 Connection 2 control the switch
between water and
gas cycles
Connection 3
Wellhead Connection
PWMAXand PGMAX
can be specified at Well Connection
these nodes only
Examples:
Example 1.
WELLS
NAME STREAM SCALE
I-1 WATER 4.0
P-1 PRODUCER 4.0
ENDWELLS
Example 2
!
WELLSPEC P-2
CELL KH SKIN RADW RADB X Y DEPTH MD FLOWSECT
1 500.0 0.0 3.5 117.9126 3000 1000 5050 5100 1

2 500.0 0.0 3.5 117.9126 3200 1000 5050 5200 1

3 500.0 0.0 3.5 117.9126 3400 1000 5050 5300 2
4 500.0 0.0 3.5 117.9126 3600 1000 5050 5400 2
WELLS
NAME STREAM TYPE METHOD X Y BHDEPTH BHMD DIAM ROUGHNESS ADDTUBING
P-2 PRODUCER PIPE HAGEDORN 3000 1000 4900 4950 3.5 0.0005 1
ENDWELLS
The default well connections for well P-2 are as follows:
|
x MD 4950 ft
|\
| \
MD 5100 ft x x <- Perf 1
| |
| |
| |
The default well connections should be modified by creating nodes in the wellbore in a WELLN-
ODE table, and connecting or reconnecting the nodes in a NODECON table.

Wellhead Data (WELLHEAD)
Data for the connection from the well bottom hole depth to the wellhead (referred to as the well
connection) is specified in a WELLHEAD table.
WELLHEAD
WELL NAME (DEPTH) (X) (Y) (IPVT)(IWAT) (IBAT) (TYPE) (METHOD) (NUMBER)
wellname whname (depth) (x) (y) (ipvt) (iwat) (ibat)PIPE or GRADCALC (n)
PIPE or ihyd
PIPE or pdcorr
PIPEGRAD or CALC
PIPEGRAD or grad
. . . . . . . . . .
. . . . . . . . . .
ENDWELLHEAD
Additional Columns:
(DIAM) (INNERDIAM) (ROUGHNESS) (LENGTH) (TEMP) (ELEVPR) (TEMPPR)

(diam) (innerdiam) (ruf or NOFRICT)(length) (temp) (elevpr) (temppr)
. . . . . . .
. . . . . . .
(DPADD) (RATEMULT)
(dpadd) (ratemult)
. .
. .
where:
WELLHEAD Keyword indicating the start of the WELLHEAD table.
WELL Column heading keyword indicating that the entries in this location
on the following lines are well names.
wellname A well name. The name must have been previously defined using
WELL input.
on the following lines are wellhead names. A wellhead node and a
default wellhead connection to a sink or source are created with this
name. The wellhead connection can be redefined in a NODECON
table to connect the wellhead to a network. The well connection is
redefined to connect the well bottom hole node to the wellhead
node.
338 Surface Network: Wellhead Data (WELLHEAD) R5000.0.1

whname Wellhead name.

Default: wellname%TH
on the following lines are the wellhead depths.
depth The wellhead depth. (ft, m, m, m, cm)

Default: 0.

on the following lines are the wellhead x coordinate location. (ft, m,
m, m, cm)
x The wellhead x coordinate location.

Default: The x value specified for the well.

on the following lines are the wellhead y coordinate location. (ft, m,
m, m, cm)
y The wellhead y coordinate location.

Default: The y value specified for the well.
location on the following lines are the PVT table numbers to be
used for the well and wellhead connections.
ipvt PVT table number.

location on the following lines are the Water PVT table numbers to
be used for the well and wellhead connections.
iwat Water PVT table number.

location on the following lines are the separator battery numbers
associated with the well and wellhead connections. A value of 0
sets the separator to the default.
ibat Separator battery number.

TYPE Optional column heading keyword. The entries in this location on

the following lines specify the type of connection between the
bottomhole and wellhead, and should be either PIPE for a pipe,
R5000.0.1 Surface Network: Wellhead Data (WELLHEAD) 339

tubing string or annulus, or PIPEGRAD for a pipe, tubing string or

annulus where the pressure change across the connection is
determined from a specified density gradient.

method is either GRADCALC, the name of a pressure drop
correlation (see the PDCORR table) or a hydraulics method table
number. GRADCALC is the default. For a PIPEGRAD (a special
kind of pipe), the method is the fluid density gradient (psi/ft) or
CALC. The default is CALC. Note that a TYPE of PIPEGRAD
with a method of CALC is the same as a TYPE of PIPE and a
method of GRADCALC. If neither the TYPE nor the METHOD
columns are present, the default is PIPEGRAD GRADCALC.
simulator.
simulator.
m, psi/cm)
pdcorr The name of a pressure drop correlation. (See PDCORR table.)

(The default methods are NOSLIP, DUKLER, DUKEAT, BEGGS,
HAGEDORN, HAG_BEG, DUNROS, AZIZ, SUPRIB, AND
ORKISZ.)
NUMBER Introduces a number which can be used instead of the wellhead

name to specify constraint data.
is the well connection diameter. Only used if pressure drop
correlations are used in the well connection. (Inches, cm, cm, cm,
cm)
is the well connection inner diameter. Only used if pressure drop
correlations are used in the well connection. The inner diameter

refers to the inner diameter of an annulus. I.e the outer diameter of

the inner pipe. The diameter, is the inner diameter of the outer pipe.
is the well connection roughness, or the keyword NOFRICT. Only
used if pressure drop correlations are used in the well connection.
If NOFRICT is input, the frictional pressure drop will be ignored.
LENGTH Optional column heading, indicating that the entry in this location
is the length of the well connection. (ft, m, m, m, cm)
Default: Calculated from the distance from the bottom hole node to
the wellhead node. If the X and Y locations of the bottom hole
node or wellhead node are not input, they are assumed to be
coincident.
is the temperature of the wellhead node. Node temperatures are
used by the pressure drop correlations. (F, C, C, C, C)
Default: Standard temperature.
elevation profile for the well connection. Elevation profiles are
used by the pressure drop correlations. The length specified in the
elevation profile will supersede any entry in the LENGTH column.
Default: NA.
specifies that there is no temperature profile for the well
connection. Temperature profiles are used by the pressure drop
correlations. The length specified in the temperature profile will
supersede any entry in the LENGTH column.
Default: NA.
Default: 0.
R5000.0.1 Surface Network: Wellhead Data (WELLHEAD) 341

Default: 1
ENDWELLHEAD Keyword indicating the end of the WELLHEAD table.
Notes:
1. The WELLHEAD table creates a new node at the wellhead, a new connection from the well-
head node to a source or a sink, and redefines the well connection (which was created in the
WELLS table) to connect the well bottom hole node to the wellhead node. I.e the well con-
nection becomes the tubing from the bottom hole to the surface.
2. The data could also be input using a NODECON table. The WELLHEAD table is intended
to provide simplified input for the special connection from the bottom hole to surface, and is
particularly useful when there are no other connections in the network.
Example:
WELLHEAD
WELL METHOD
well1 1
ENDWELLHEAD

Wellbore Data (WELLBORE)
Data for the connections in the perforated section of the wellbore is specified in a WELLBORE
table.
WELLBORE
WELL (FLOWSECT) (DIAM) (INNERDIAM) (ROUGHNESS) (TYPE) (METHOD) (TEMP)
wellname ( flowsect) (diam) (innerdiam) (ruf or NOFRICT) PIPE GRADCALC (temp)
or PIPE ihyd
or PIPE pdcorr
or PIPE MIXED
or PIPE CELLAVG
or PIPE CELLGRAD
or PIPEGRAD CALC
or PIPEGRAD grad
or LUMPED MIXED
or LUMPED CELLAVG
. . . . . . . .
. . . . . . . .
ENDWELLBORE
Additional Columns:
(ELEVPR) (TEMPPR) (HTC)

(elevpr) (temppr) (htc)
. . .
. . .
where:
WELLBORE Keyword indicating the start of the WELLBORE table.
WELL input.
FLOWSECT Optional column heading, indicating that the entry in this location
is the flow section (specified in the WELLSPEC table) to which the
data input will apply.
Default: 1
is the wellbore connection diameter. Only used if pressure drop
correlations are used in the wellbore connection. (Inches, cm, cm,
R5000.0.1 Surface Network: Wellbore Data (WELLBORE) 343

cm)
is the wellbore connection inner diameter. Only used if pressure
drop correlations are used in the wellbore connection. The inner
diameter refers to the inner diameter of an annulus. I.e the outer
diameter of the inner pipe. The diameter, is the inner diameter of
the outer pipe. (Inches, cm, cm, cm, cm)
is the wellbore connection roughness, or the keyword NOFRICT. If
Only used if pressure drop correlations are used in the wellbore
connection. (Inches, mm, mm, mm, mm)

the following lines specify the type of the connections in the
wellbore, and should be either PIPE for a pipe, tubing string or
annulus, or PIPEGRAD for a pipe, tubing string or annulus where
the pressure change across the connection is determined from a
specified density gradient.
PIPE Specifies that the connection type is a PIPE and the wellbore will
be gridded -- i.e., each perforation will flow to a different node in
the wellbore.
PIPEGRAD Specifies that the connection type is a PIPE, and it will have either a
specified gradient, or the program will calculate the gradient. This
means that the wellbore will be gridded -- i.e., each perforation will
flow to a different node in the wellbore.
LUMPED Specifies that the connection type is a single node for the specified
flow section.

method is either GRADCALC, MIXED, CELLAVG, CELLGRAD,
the name of a pressure drop correlation (see the PDCORR table) or
a hydraulics method table number. GRADCALC is the default.
For a PIPEGRAD (a special kind of pipe), the method is the fluid
density gradient (psi/ft) or CALC. The default is CALC. Note that
a TYPE of PIPEGRAD with a method of CALC is the same as a
TYPE of PIPE and a method of GRADCALC. For LUMPED,
344 Surface Network: Wellbore Data (WELLBORE) R5000.0.1

only MIXED or CELLAVG may be input.

calculations in the wellbore connections will be calculated by the
simulator.
calculations in the wellbore will be calculated assuming the fluids
in the wellbore are fully mixed.
CELLAVG Specifies that the fluid density gradient to be used for pressure drop
weighted gradient of all perforated grid blocks for the well. This is
similar to the gradients calculated by the VIP software.
CELLGRAD Specifies that the fluid density gradient to be used for pressure drop
weighted gradient of the perforated grid blocks that flow to the
nodes at each end of the wellbore connection.
LUMPED Specifies that the wellbore will be modeled with a single node
located at the average depth of the perfs. (This input is obsolete,
but is still accepted.) It should be replaced by specifying LUMPED
in the TYPE column.
calculations in the wellbore connections will be calculated by the
simulator.
m, psi/cm)
is the temperature of the wellbore nodes. Node temperatures are
used by the pressure drop correlations. (F, C, C, C, C).
Default: Same temperature as the grid block.
the keyword NA. Elevation profiles are used by the pressure drop
correlations. If an elevation profile is specified, then measured
depth data (MD) must be specified in the WELLSPEC table for this
well. The wellbore connections which are created by the program
R5000.0.1 Surface Network: Wellbore Data (WELLBORE) 345

between perforations will interpolate their elevation changes from

the elevation profile.
temperature gradient profile, or the keyword NA. Temperature
profiles are used by the pressure drop correlations. If a
temperature profile is specified, then measured depth data (MD)
must be specified in the WELLSPEC table for this well. The
wellbore connections which are created by the program between
perforations will interpolate their temperatures from the
temperature profile.
(m2*K), W/(m2*K), W/(m2*K), W/(m2*K))
ENDWELLBORE Keyword indicating the end of the WELLBORE table.
Example:
WELLBORE
WELL METHOD DIAM
well1 BEGGS 3.5
ENDWELLBORE
346 Surface Network: Wellbore Data (WELLBORE) R5000.0.1

Wellnode Data (WELLNODE)
Nodes in the wellbore can be specified as follows. This table can also be used to disconnect sec-
tions of the wellbore.
WELLNODE
WELL NODE MD (FLOWSECT) (CONNECT)
wellname nodename or md ( flowsect) (YES or NO)
. NA . . .
. . . . .
ENDWELLNODE
where:
WELLNODE Keyword indicating the start of the WELLNODE table.
WELL input.
NODE Column heading, indicating that the entry in this location is the
name of a node located in the wellbore. This creates a new network
node, and this node should not appear in a NODES table. The NA
keyword can be used to disconnect the original wellbore connection
at this location, without creating a new node.
MD Column heading, indicating that the entry in this location is the

measured depth (specified in the WELLSPEC table) where the
node will be located. The measured depth must be within the range
of measured depths specified for this flow section of the wellbore.
The measured depths must be unique for each flow section. (ft, m,
m, m, cm)
FLOWSECT Optional column heading, indicating that the entry in this location
is the flow section (specified in the WELLSPEC table) to which the
data input will apply.
Default: 1
CONNECT Optional column heading, indicating that the entry in this location
specifies whether a connection should also be created from the new
node to the preceding node in the wellbore (in the direction of
decreasing measured depth).
Default: YES
R5000.0.1 Surface Network: Wellnode Data (WELLNODE) 347

ENDWELLNODE Keyword indicating the end of the WELLNODE table.
Notes:
1. The use of the CONNECT column. The Nexus software creates a default well network from
the perforation data in the WELLSPEC table. For example:
WELLSPEC P-2
CELL KH SKIN RADW RADB X Y DEPTH MD
1 500.0 0.0 3.5 117.9126 3000 1000 5050 5100
2 500.0 0.0 3.5 117.9126 3200 1000 5050 5200
3 500.0 0.0 3.5 117.9126 3400 1000 5050 5300
4 500.0 0.0 3.5 117.9126 3600 1000 5050 5400
would result in a well network with a node at perf 4, connected to a node at perf 3 ….. connected
to the bottomhole node:
The WELLNODE table is used to insert a new node somewhere in the well (depending on the
specified Measured depth for the node). Say this new node is located between perf 2 and perf 3.
When the new node is inserted, another connection must be added.
348 Surface Network: Wellnode Data (WELLNODE) R5000.0.1

The original connection from the node at perf 3 to the node at perf 2 is reconnected to go from the
node at perf 3 to the new node, and a new connection, which is given the same name as the name
of the new node, is added to connect the new node to the node at perf 2. If NO is specified on the
CONNECT column, this new connection is not created, and the wellbore is not connected from
the new node to the node at perf 2. I.e, the well network looks like:
Perf 3 and perf 4 would not contribute to production, unless the new node is connected to some
other node in a NODECON table.
Example:
WELLNODE
R5000.0.1 Surface Network: Wellnode Data (WELLNODE) 349

P-2-T1 P-2 4999.9 1 YES

PACKER1 P-2 5000 1 NO
P-2-1 P-2 5050 1 YES
P-2-T3 P-2 5199.9 1 YES
PACKER2 P-2 5200 1 NO
P-2-3 P-2 5250 1 YES
ENDWELLNODE
350 Surface Network: Wellnode Data (WELLNODE) R5000.0.1

Node Connection Data (NODECON)
Connections between nodes are specified as follows:
NODECON
NAME NODEIN NODEOUT (IPVT)(IWAT) (IBAT)(TYPE) (METHOD) (LENGTH) (NUMBER)
conname nodein nodeout (ipvt) (iwat) (ibat)PIPE or GRADCALC (length) (n)
PIPE or ihyd (length)
PIPE or pdcorr (length)
PIPEGRAD or CALC (length)
PIPEGRAD or grad (length)
VALVE or ivalve NA
GASLIFT or iglrtab NA
PUMP or ipump
COMPRESSOR or icompressor
NA NA NA
. . . . . . . .
. . . . . . . .
ENDNODECON
Additional Columns:
(DDEPTH) (DIAM) (INNERDIAM) (ROUGHNESS) (LENGTH) (ELEVPR)(TEMPPR)(MDIN) (MDOUT) (HTC)

(ddepth) (diam) (innerdiam) (ruf or NOFRICT)(length)(elevpr)(temppr)(mdin) (mdout) (htc)
. . . . . . . . . .
. . . . . . . . . .
(DPADD) (RATEMULT)
(dpadd) (ratemult)
. .
. .
where:
NODECON Keyword indicating the start of the NODECON table.
on the following lines are the connection names.
conname Connection name. The name must start with an alpha character or a
number, and should not contain the % character except to redefine a
default wellbore connection.
NODEIN Column heading keyword indicating that the entries in this location
on the following lines are the inflow node names.
nodein Inflow node name. To define an inflow ‘connection’ into the

terminal node of an injection sub-network (i.e., the injection
source), specify a stream name for nodein. If the name contains the
% character, then it refers to the default node name for a wellbore
R5000.0.1 Surface Network: Node Connection Data (NODECON) 351

node, and the part of the name preceding the % should be a well
name. Note that for black oil systems, WATER and GAS are
automatically defined stream names.
NODEOUT Column heading keyword indicating that the entries in this location
on the following lines are the outflow node names.
nodeout Outflow node name, or the label SINK to identify an outflow

‘connection’ from the terminal node of a production sub-network.
This terminal node to SINK connection is required in order specify
rate constraints for flow out of the terminal node. If the name
contains the % character, then it refers to the default node name for
a wellbore node, and the part of the name preceding the % should
be a well name.
used for each connection.
be used for each connection.
associated with each connection. A value of 0 sets the separator to
the default.

the following lines specify the type of connection, and should be
either PIPE for a pipe, tubing string or annulus, PIPEGRAD for a
pipe, tubing string or annulus where the pressure change across the
connection is determined from a specified density gradient, VALVE
for a valve, PUMP for a pump, COMPRESSOR for centrifugal
compressor, GASLIFT for a gaslift connection that uses an optimal
gaslift table, or NA for a connection to a source or a sink.

352 Surface Network: Node Connection Data (NODECON) R5000.0.1


method of GRADCALC. For a VALVE, the method is a valve
method table number. A VALVE method represents a valve or a
choke. For a GASLIFT injector, the method can be NONE or a
method corresponding to a GASLIFT method table number.
NODEIN for a GASLIFT injector must be a stream name, or a node
which is ultimately connected to an injection stream. For a PUMP
or COMPRESSOR, the method represents a pump or compressor
method.
simulator.
simulator.
NONE Specifies that the pressure increase in a COMPRESSOR or PUMP

connection is limited only by the PMAX constraint specified at the
outlet node, and any maximum rate constraints specified for the
connection.
NA Specifies that TYPE, METHOD or LENGTH values are not

applicable. Connections to sources or sinks must have a TYPE and
METHOD of NA.
grad The fluid density gradient (real). (psi, ft, kPa/m, (Kg/cm2)/m, Bars/
m, psi/cm)
ivalve The valve method number (integer).
iglrtab The optimal gaslift method number (integer).
ipump Pump method number defined in the section with the

NET_METHOD_FILES keyword. (integer)
icompressor Compressor method number defined in the section with the

LENGTH Column heading keyword indicating that the entries in this location
on the following lines are the length of the connection. (ft, m, m, m,
cm)

length The connection length.

Default: The distance between the node locations if specified.
DDEPTH Column heading keyword indicating that the entries in this location
on the following lines are the change in depth from the nodein to
the nodeout. (ft, m, m, m, cm)
ddepth The change in depth between nodein and nodeout.
Default: The depth difference between the nodein and nodeout

depths.
is the connection diameter. Only used if pressure drop correlations
are used in the connection. (Inches, cm, cm, cm, cm)
is the connection inner diameter. Only used if pressure drop
correlations are used in the connection. The inner diameter refers
to the inner diameter of an annulus. I.e the outer diameter of the
inner pipe. The diameter, is the inner diameter of the outer pipe.
is the connection roughness, or the keyword NOFRICT. Only used
if pressure drop correlations are used in the connection. If
NUMBER Introduces a number which can be used instead of the connection

name to specify constraint data.
elevation profile for this connection. Elevation profiles are used by
the pressure drop correlations. The length and change in depth
specified in the elevation profile will supersede any entry in the
LENGTH and DDEPTH columns.
Default: NA.

specifies that there is no temperature profile for this connection.

Temperature profiles are used by the pressure drop correlations.
The length specified in the temperature profile will supersede any
entry in the LENGTH column.
Default: NA.
MDIN The measured depth at NODEIN. This is used to interpolate

elevation and temperature data from profiles. (ft, m, m, m, cm)
Default: The measured depth for the node if it has been specified in
a WELLNODE or WELLS table. Otherwise, it has not default.
MDOUT The measured depth at NODEOUT. This is used to interpolate

elevation and temperature data from profiles. (ft, m, m, m, cm)
Default: The measured depth for the node if it has been specified in
a WELLNODE or WELLS table. Otherwise, it has not default.
(m2*K), W/(m2*K), W/(m2*K), W/(m2*K) )
Default: 0.
Default: 1.
ENDNODECON Keyword indicating the end of the NODECON table.
Notes:
1. MDIN and MDOUT are used to interpolate elevation and temperature data from profiles. if
the profile does not span the entire length of the connection. The inclination angles as a func-
tion of position in the connection are determined from the elevation profile, starting at length
= MDIN, and ending at length = MDOUT. If MDIN or MDOUT is not input, then it is
assumed that the profile spans the entire connection. Wellbore connections, which are auto-
matically created if the wellbore is not lumped, calculate MDIN and MDOUT from the mea-
sured depths input in the WELLSPEC table (if available).

2. GASLIFT connections must have a QGSMAX constraint specified.
3. For PUMP type connection, the type of pump (e.g., centrifugal, variable speed) and its per-
formance data must be defined in the file referred to in NET_METHOD_FILES section. The
power supplied to the pump in this connection must be defined in the CONSTRAINTS sec-
tion.
4. For COMPRESSOR type connection, the type of compressor (for example, centrifugal, vari-
able speed) and its performance data must be defined in the file referred to in
NET_METHOD_FILES section. The power supplied to the pump in this connection must be
defined in the CONSTRAINTS section.
5. For COMPRESSOR type connection, the temperature of the inlet node must be input in one
of the following ways: Nodes Table (keyword NODES), Network Default Temperature
(NDTTEMP) or Temperature Profile (TEMPPR).
Example:
NODECON
NAME NODEIN NODEOUT TYPE METHOD
sink1 node1 sink NA NA
con2 node2 node1 PIPE GRADCALC
con3 node3 node2 PIPEGRAD 0.43
con4 node4 node3 PIPE BEGGS
pumpcon node5 node6 PUMP 1
comprcon node7 node8 COMPRESSOR 1
ENDNODECON

Tree Structured Network Data (GROUP)
Simplified input for tree structured networks can be input in a GROUP table. For tree structured
networks GROUP tables can be used instead of NODES and NODECON tables. (NODES and
NODECON tables can use used in addition to GROUP tables if desired.)
A connection, named the same as the nodename, is automatically generated, connecting the node
to the name specified after the GROUP keyword. This name is either another node, SINK for a
production network or a stream name for an injection network. A node name specified after the
GROUP keyword must already be defined, either in a preceding GROUP table, or a NODES
table. I.e. GROUP SINK or GROUP stream_name must precede all other GROUP tables.
GROUP grpname
NODE (DEPTH) (X) (Y) (IPVT) (IWAT) (IBAT) (TYPE) (METHOD) (NUMBER)
nodename (depth) (x) (y) (ipvt) (iwat) (ibat) PIPE GRADCALC (n)
or PIPE ihyd
or PIPEGRAD CALC
or PIPEGRAD grad
or COMPRESSOR icompressor
or PUMP ipump
. . . . . . . . . .
. . . . . . . . . .
ENDGROUP
Additional Columns:
(DIAM) (INNERDIAM) (ROUGHNESS) (LENGTH) (TEMP) (ELEVPR) (TEMPPR)

(diam) (innerdiam) (ruf or NOFRICT)(length) (temp) (elevpr) (temppr)
. . . . . . .
. . . . . . .
(DPADD) (RATEMULT)
(dpadd) (ratemult)
. .
. .
where:
GROUP Keyword indicating the start of the GROUP table.
grpname Either a node name, or the keyword SINK for production networks,
or a stream name for injection networks. If this is a node name, it
must already be defined by a preceding GROUP or NODES table.
NODE Column heading keyword indicating that the entries in this location
on the following lines are the node names. Wells are automatically
R5000.0.1 Surface Network: Tree Structured Network Data (GROUP) 357

given node names the same as the well name. Wellbore nodes are
given names as described in the NODECON table section.
nodename Node name (or well name or wellbore node name). The name must
start with an alpha character or a number.
on the following lines are the node depths. (ft, m, m, m, cm)
depth The node depth.

Default: 0 for nodes, or the datum depth for wells.

on the following lines are the node x coordinate location. (ft, m, m,
m, cm)
x The node x coordinate location.

Default: None for nodes, or the x value specified for the well.

on the following lines are the node y coordinate location. (ft, m, m,
m, cm)
y The node y coordinate location.

Default: None for nodes, or the y value specified for the well.
used for each connection.
ipvt PVT table number.

Default: 1.
be used for each connection.
iwat Water PVT table number.

Default: 1.
associated with each connection. A value of 0 sets the separator to
the default.
ibat Separator battery number.

Default: 1.
358 Surface Network: Tree Structured Network Data (GROUP) R5000.0.1


the following lines specify the type of connection, and should be
either PIPE for a pipe, tubing string or annulus, PIPEGRAD for a
pipe, tubing string or annulus where the pressure change across the
connection is determined from a specified density gradient, PUMP
for a pump, COMPRESSOR for centrifugal compressor, or NA for
a connection to a source or a sink.

method of GRADCALC. For a PUMP or COMPRESSOR, the
method represents a pump or compressor method.
simulator.
simulator.
NA Specifies that TYPE and METHOD values are not applicable.

Connections to sources or sinks must have a TYPE and METHOD
of NA.
m, psi/cm)
ipump Pump method number defined in the section with the

icompressor Compressor method number defined in the section with the

NUMBER Introduces a number which can be used instead of the node name to
specify constraint data.

on the following lines are the length of the connection. (ft, m, m, m,
cm)
length The connection length.
Default: The distance between the locations of the nodes nodename

and grpname if specified.
is the connection diameter. Only used if pressure drop correlations
are used in the connection. (Inches, cm, cm, cm, cm)
is the connection inner diameter. Only used if pressure drop
correlations are used in the connection. The inner diameter refers
to the inner diameter of an annulus. I.e the outer diameter of the
inner pipe. The diameter, is the inner diameter of the outer pipe.
is the connection roughness, or the keyword NOFRICT. Only used
if pressure drop correlations are used in the connection. If
is the temperature of the nodes. Node temperatures are used by the
pressure drop correlations. (F, C, C, C, C)
Default: Standard temperature.
elevation profile for the connection. Elevation profiles are used by
the pressure drop correlations. The length specified in the elevation
profile will supersede the length specified in the LENGTH column.
Default: NA.
specifies that there is no temperature profile for the connection.
Temperature profiles are used by the pressure drop correlations.
360 Surface Network: Tree Structured Network Data (GROUP) R5000.0.1

The length specified in the elevation profile will supersede the

length specified in the LENGTH column.
Default: NA.
Default: 0.
Default: 1
ENDGROUP Keyword indicating the end of the GROUP table.
Example:
GROUP SINK
NODE
well1
node2
ENDGROUP

Combining Wells in a Multi-Reservoir Run

(COMBINEWELLS)
In a multi-reservoir run, there are two ways to combine a well from the individual reservoirs into
a single well. The first method automatically combines wells which have the same name, and the
second method requires WELLNODE input to define nodes in the wells which will be combined,
and NODECON input to connect those nodes appropriately. The two methods can be used in the
same dataset, in which case wells will first be combined using WELLNODE/NODECON input,
then any wells with the same name which have not already been combined, will be automatically
combined. The input to automatically combine wells is as follows:
COMBINEWELLS
Where
COMBINEWELLS Specifies that wells with the same name in the individual reservoir
network files will be combined into single wells in the simulation.
Wells are combined in the order in which the reservoirs are
specified in the multi-field case file. I.e. the first perforation of the
well in the second reservoir is connected to the last perforation of
the well with the same name in the first reservoir. The well
connection associated with the well defined in the second reservoir
is then inactive, and the well withdrawal point is from the first
perforation in the first reservoir.
Notes:
1. A combined well must be the same type of well in all reservoirs. I.e. the well must be defined
as PRODUCER in all reservoirs, or as a WAG well in all reservoirs, or as some other kind of
injection well in all reservoirs. It the well is an injector (other than WAG) then the injection
stream will be determined by the stream defined for the first reservoir in which the well
occurs.
2. Wells are combined starting with the first reservoir in which the well is present (defined as a
well in the network file for that reservoir) by attaching the perforations from the next reser-
voir in which the well is present to the end of the perforations from the preceding reservoir.
The well connections for all reservoirs except the first reservoir where the well occurs,
become inactive, so any constraints specified for these wells will be ignored.
3. Wells can be manually combined using WELLNODE/NODECON input. To do this, the con-
nection between the first perforation and the well node must be disconnected (see the exam-
ple below), and when this connection is disconnected, the logic for the COMBINEWELLS
option will not attempt to connect it to a well from a preceding reservoir. This allows both
methods of combining wells to be used in the same dataset.
362 Surface Network: Combining Wells in a Multi-Reservoir Run (COMBINEWELLS) R5000.0.1

Examples:
Example1. Automatic combination of wells in a three reservoir model.
In this example the reservoirs are named res1, res2 and res3, and are input in that order in the mul-
tifield case file. Well P-1 is present in res1 and res2, well I-1 is present in all three reservoirs, well
P-2 is present in res1 and res3, and well I-2 is present in res2 and res3. The result of the following
input is that well P-1 will be treated as a single well with perforations in res1 and res2, well I-1
will be treated as a single well with perforations in all reservoirs, well P-2 will be treated as a sin-
gle well with perforations in res1 and res3, and well I-2 will be treated as a single well with perfo-
rations in res2 and res3.
COMBINEWELLS
!
! Define nodes for gathering/injection networks
!
NODES
NAME DEPTH
GATHP 5000.0
TERMP 5000.0
GATHI 5000.0
TERMI 5000.0
ENDNODES
!
! Attach top most wells to the gathering/injection networks.
! Note that this input must be enclosed within RESV/ENDRESV keywords
! because the wells are defined in more than one reservoir file.
!
RESV res1
NODECON
NAME NODEIN NODEOUT
P-1 P-1 GATHP
P-2 P-2 GATHP
I-1 GATHI I-1
ENDNODECON
ENDRESV
RESV res2
NODECON
NAME NODEIN NODEOUT
I-2 GATHI I-2
ENDNODECON
ENDRESV
!
! Connect rest of simple gathering/injection networks
!
NODECON
NAME NODEIN NODEOUT
GATHP GATHP TERMP
R5000.0.1 Surface Network: Combining Wells in a Multi-Reservoir Run (COMBINEWELLS) 363

SINK TERMP SINK

GATHI TERMI GATHI
SOURCE WATER TERMI
ENDNODECON
Example 2. Manual combination of wells in a two reservoir model.
In this example the reservoirs are named res1, res2, and wells P-1 and I-1 are present in both res-
ervoirs. Note that the wells in this example could be combined using the COMBINEWELLS
input, because the wells have the same name in both reservoirs. The manual combination requires
the creation of two new nodes and connections in each well to be created (at the base of res1 and
the top of res2), while the automatic combination will not create any new nodes or connections.
!
! Define nodes for gathering/injection networks
!
NODES
NAME DEPTH
GATHP 5000.0
TERMP 5000.0
GATHI 5000.0
TERMI 5000.0
ENDNODES
!
! Define nodes at the base of the wells in res1 and
! connect the wells to the gathering/injection networks
! Note that this input must be enclosed within RESV/ENDRESV keywords
! because the wells are defined in more than one reservoir file.
!
RESV res1
WELLNODE
WELL NODE MD CONNECT
P-1 P-1Base 5200 YES
I-1 I-1Base 5200 YES
ENDWELLNODE
NODECON
NAME NODEIN NODEOUT
P-1 P-1 GATHP
I-1 GATHI I-1
ENDNODECON
ENDRESV
!
! Define nodes at the top of the wells in res2
! Note that the entry of NO for the CONNECT column
! will disconnect the top perforation from the well node
! which will make the well connections in res2 inactive
!
364 Surface Network: Combining Wells in a Multi-Reservoir Run (COMBINEWELLS) R5000.0.1

RESV res2
WELLNODE
WELL NODE MD CONNECT
P-1 P-1LTop 5200 NO
I-1 I-1LTop 5200 NO
ENDWELLNODE
ENDRESV
!
! Connect the wells so that the nodes at the bottom the wells in res1
! are connected to the nodes at the top of the wells in res2
!
NODECON
NAME NODEIN NODEOUT
P-1Con P-1LTop P-1Base
I-1Con I-1Base I-1LTop
ENDNODECON
!
! Connect rest of simple gathering/injection networks
!
NODECON
NAME NODEIN NODEOUT
GATHP GATHP TERMP
SINK TERMP SINK
GATHI TERMI GATHI
SOURCE WATER TERMI
ENDNODECON
R5000.0.1 Surface Network: Combining Wells in a Multi-Reservoir Run (COMBINEWELLS) 365

Rig Data (RIG)
Rig parameters are described below:
RIG
NAME DRILLSITE MOVETIME DRILLTIME
Rig_name site_name mtime dtime
or DEACTIVATE
or ALL
…
ENDRIG
where:
RIG Begins rig data.
NAME Name of the rig.
DRILLSITE Name of the site where the rig is initially located. If not specified,
the site will be assumed to be located at the drill site of the first well
which is drilled. Rigs can be deactivated by specifying
DEACTIVATE for the DRILLSITE.
Default: ALL.
MOVETIME Time to move rig from one drill site to another. If the rig has to be
moved about within a drill site, the time to move is included in the
drill time. (days, days, days, days, hours).
Default: 0.
DRILLTIME Default drill time, which is superseded if drill time is specified in a

DRILL table. (days, days, days, days, hours).
Default: 0.
ENDRIG Ends rig data.
Example:
RIG
NAME DRILLSITE MOVETIME DRILLTIME
rig1 site1 365 365
rig2 site2 730 730
rig3 deactivate # #
ENDRIG
366 Surface Network: Rig Data (RIG) R5000.0.1

Drillsite Data (DRILLSITE)
Drill site parameters are described below.
DRILLSITE
NAME (MAXRIGS)
site_name (max_rigs)
…
ENDDRILLSITE
where:
DRILLSITE Begins drill site data.
NAME List of drill sites for which rig data can be specified.
Default: ALL.
MAXRIGS The maximum number of rigs allowed at the drill site. Default: 1
ENDDRILLSITE Ends drill site data.
Example:
DRILLSITE
NAME MAXRIGS
site1 1
site2 2
site3 1
ENDDRILLSITE
R5000.0.1 Surface Network: Drillsite Data (DRILLSITE) 367

Reinjection Streams (REINJECTION)
To provide for reinjection of produced fluids, the composition for a reinjection stream can be
specified as follows:
REINJECTION
NAME CONNECTION (PHASE) (IBAT)
Stream_name con_name (WATER or (ibat)
GAS or OIL)
. . . .
. . . .
. . . .
ENDREINJECTION
where:
REINJECTION Keyword introducing reinjection stream data.
NAME Column heading keyword indicating that the entries in this column
are stream names. The streams must have already been defined in a
STREAMS table.
Default: None
CONNECTION Column heading keyword indicating that the entries in this column
are connection names or connection list names. The connection (or
connection list) must have already been defined.
Default: None
PHASE Column heading keyword indicating that the entries in this column
are phase names. I.e. WATER, GAS, or OIL.
Default: WATER
IBAT Column heading keyword indicating that the entries in this column
are the separator battery numbers which will be used to do the
separation.
Default: The separator battery assigned to the connection, or the

separator battery assigned to the first connection in the connection
list.
ENDREINJECTION Keyword terminating reinjection stream data.
368 Surface Network: Reinjection Streams (REINJECTION) R5000.0.1

Notes:
1. The stream must have already been defined in a STREAMS table. The composition specified
in the STREAMS table is used for an initial guess if there has been no prior production in the
specified connection.
2. The composition of the injection stream is obtained by flashing the fluid flowing in the spec-
ified connection (or the sum of the fluids flowing in the connection list) through the specified
separator specified. The reinjection composition is the composition of the specified reinjec-
tion phase.
Example:
REINJECTION
NAME CONNECTION PHASE
prod_stream sink_con GAS
ENDREINJECTION
R5000.0.1 Surface Network: Reinjection Streams (REINJECTION) 369

Stream Tracers (STREAM_TRACER)
Stream tracers can be identified by the combination of a component name and a tracer name as
follows:
STREAM_TRACER
NAME COMPONENT TRACER CONCENTRATION
Stream_name Component_name Tracer_name c1
…..
ENDSTREAM_TRACER
where:
STREAM_TRACER Keyword introducing stream tracer data.
NAME Stream name.
COMPONENT Component name.
TRACER Tracer name.
CONCENTRATION Concentration of the component.
ENDSTREAM_TRACER Keyword ending the stream tracer data.
Notes:
1. The same tracer name can be used in different components. E.g. tracer1 may be named as a
tracer in both OIL1 and OIL2 in an API run, which would be two separate tracers.
2. The tracer name SALT is a special case. The tracer WATER SALT represents salt dissolved
in water, and the concentration of SALT in WATER is the salinity which is used to look up
water properties (if the water properties have salinity dependence).
3. All concentrations, except SALT in WATER, must lie in the range 0 to 1. The concentration
of SALT in WATER should be in units consistent with the salinity input for the water proper-
ties, which for example, could have the units of ppm.
Examples:
! Specify the stream mass or mole fraction

!
STREAMS
NAME WATER
SEAWATER 1.0
ENDSTREAMS
! Specify the tracer concentration(s) for components in the stream
370 Surface Network: Stream Tracers (STREAM_TRACER) R5000.0.1

!
STREAM_TRACER
NAME COMPONENT TRACER CONCENTRATION
SEAWATER WATER SALT 100000
# WATER BLUE 0.3
ENDSTREAM_TRACER
Here, the default character # means use the same stream name as the previous line (or the stream
name can be repeated).
R5000.0.1 Surface Network: Stream Tracers (STREAM_TRACER) 371

Pressure Drop Correlation Data (PDCORR)
Pressure drop correlation data is entered as follows.
PDCORR
NAME CORRELATION (GRPGCR) (FRPGCR) (ACPGCR) (PRESIN) (DHCOR)
name NOSLIP or (grpgcr) (frpgcr) (acpgcr) (presin) (ON or OFF)
BEGGS or
HAGEDORN
.
ENDPDCORR
where:
PDCORR Keyword indicating the start of the PDCORR table.
on the following lines are correlation names.
name Correlation name. The name must start with an alpha character or a
number, and should not contain the % character. There are nine
correlation names available by default (NOSLIP, BEGGS,
HAGEDORN, DUKLER, DUKEAT, DUNROS, AZIZ, ORKISZ
and SUPRIB). These default correlation names use the default
values for the corresponding correlations. The values for the
default correlations can be respecified in a PDCORR table, or new
correlation names can be introduced.
CORRELATION Column heading keyword indicating that the entries in this location
on the following lines specify which correlation to use.
NOSLIP Without slip effect.
BEGGS Beggs and Brill.
HAGEDORN Hagedorn and Brown.
HAG_BEG Use Beggs and Brill correlation is the angle is in the range -45 to 45
degrees, otherwise use Hagedorn and Brown.
DUKLER Dukler II with Flanigan correction for elevation.
DUKEAT Dukler II with Eaton holdup and Flanigan correction for elevation.
DUNROS Dunns and Ross.
372 Surface Network: Pressure Drop Correlation Data (PDCORR) R5000.0.1

AZIZ Aziz, Govier, Fogarasi.
ORKISZ Orkiszewski.
SUPRIB Drift flux slip model.
GRPGCR Column heading keyword indicating that the entries in this location
on the following lines specify the correction factor for the gravity
pressure gradient. (Multiplier).
Default: 1.0
FRPGCR Column heading keyword indicating that the entries in this location
on the following lines specify the correction factor for the friction
pressure gradient. (Multiplier)
Default: 1.0
ACPGCR Column heading keyword indicating that the entries in this location
on the following lines specify the correction factor for the
acceleration pressure gradient. (Multiplier).
Default: 1.0
PRESIN Column heading keyword indicating that the entries in this location
on the following lines specify the pressure increment used when the
automatic grid is created to solve the pipe flow equations. The grid
size is selected to assure that the pressure drop in this interval is not
larger than the pressure increment PRESIN. (psi, kPa, Kg/cm2 , bars,
psi)
Default: 400 psi
DHCOR Column heading keyword indicating that the entries in this location
on the following lines specify whether the downhill correction is
applied.
ENDPDCORR Alpha label indicating the end of the PDCORR data.
Example:
PDCORR
NAME CORRELATION FRPGCR
BEGGS2 BEGGS 0.9
ENDPDCORR
R5000.0.1 Surface Network: Pressure Drop Correlation Data (PDCORR) 373

Elevation Profiles (ELEVPR)
Elevation profiles are input as follows.
ELEVPR name
LENGTH TVD (or ELEVATION or ANGLE)
length tvd (or elevation or angle)
.
ENDELEVPR
ALLOW_BHMOVE
where:
ELEVPR Keyword indicating the start of the ELEVPR table.
name Elevation profile name. The name must start with an alpha
character or a number, must not contain the % character, and must
not be NONE. This name is used to assign elevation profiles to
connections in a NODECON, WELLS, WELLHEAD or GROUP
table.
on the following lines specify length measured in the direction
toward the bottom of the well. I.e. For wells, this corresponds to
moving from the tubing head to the bottomhole. Length must be
input in increasing order. (ft, m, m, m, cm)
TVD Column heading keyword indicating that the entries in this location
on the following lines specify the total vertical depth corresponding
to the length entered in the LENGTH column. (ft, m, m, m, cm)
Default: 0.
ELEVATION Column heading keyword indicating that the entries in this location
on the following lines specify the elevation corresponding to the
length entered in the LENGTH column. (ft, m, m, m, cm)
Default: 0.
ANGLE Column heading keyword indicating that the entries in this location
on the following lines specify the inclination angle (relative to
horizontal), for the section of pipe preceding the length entered in
the LENGTH column. The angle is given by asin(dz/dl), where dl is
the change in length along a section of the pipe, and dz is the
change in depth. E.g. For the tubing for a vertical well, angle = 90°.
Angle is input in degrees and must be in the range -540 <= angle <=
374 Surface Network: Elevation Profiles (ELEVPR) R5000.0.1

540. If the angle is outside the range -180 <= angle <= 180, the
angle will be converted to lie inside this range.
ENDELEVPR Alpha label indicating the end of the ELEVPR data.
ALLOW_BHMOVE Specifies that if the change in depth calculated from the elevation
profile is less than the DDEPTH input (or calculated from the
difference in node depths) for the well connection to which it is
assigned, then the program will move the bottomhole node so that
the DDEPTH for the connection is the same as the elevation profile,
and the connection from the bottomhole node to the first
perforation will be extended to make up the difference.
Notes:
1. Entries in the TVD column are depths, while entries in the ELEVATION column are eleva-
tions or –depth.
2. Multiple connections can extract elevation data from a single elevation profile, if MDIN and
MDOUT are specified in the NODECON table.
3. If DDEPTH is input for a connection, or node depths at each end of the connection are input,
and it is less than the change in depth in the elevation profile, then the elevation profile is
truncated at the point where the change in depth equals the input DDEPTH. If DDEPTH is
greater than the change in depth in the elevation profile, a fatal error is generated, unless the
connection is the well connection and ALLOW_BHMOVE is specified. In this case, the bot-
tomhole node is moved so that DDEPTH for the connection is the same as that input in the
elevation profile, and the connection from the bottomhole node to the first perf is extended to
make up the difference. If this connection is not assigned an elevation profile (in the WELL-
BORE table), then it will be a vertical connection.
Example:
ELEVPR profile1
LENGTH TVD
1000.0 999.0
2000.0 1980.0
3000.0 2900.0
4000.0 3500.0
ENDELEVPR
R5000.0.1 Surface Network: Elevation Profiles (ELEVPR) 375

Temperature Profiles (TEMPPR)
Temperature profiles are input as follows.
TEMPPR name
LENGTH TEMP
length temperature
.
ENDTEMPPR
where:
TEMPPR Keyword indicating the start of the TEMPPR table.
name Temperature profile name. The name must start with an alpha
character or a number, must not contain the % character, and must
not be NONE. This name is used to assign temperature profiles to
connections in a NODECON, WELLS, WELLHEAD or GROUP
table.
on the following lines specify length measured in the direction
toward the bottom of the well. I.e. For wells, this corresponds to
the measured depth from the wellhead, and for surface connections,
it corresponds to moving toward the well. If a connection has
MDIN and MDOUT specified in the NODECON table, then the
connection will use the part of the profile from length = MDIN to
length = MDOUT. Length must be input in increasing order. (ft, m,
m, m, cm)
TEMP Column heading keyword indicating that the entries in this location
on the following lines specify the temperature corresponding to the
length entered in the LENGTH column. (F, C, C, C, C)
ENDTEMPPR Alpha label indicating the end of the TEMPPR data.

Example:
TEMPPR profile1
LENGTH TEMP
0.0 70.0
1000.0 75.0
2000.0 85.0
3000.0 95.0
4000.0 105.0
376 Surface Network: Temperature Profiles (TEMPPR) R5000.0.1

ENDTEMPPR
R5000.0.1 Surface Network: Temperature Profiles (TEMPPR) 377

Temperature Gradient Profiles (TEMPGR)
Temperature gradient profiles are input as follows.
TEMPGR name
DEPTH VALUE
depth(1) temperature
depth(2) temp_grad(2)
.
ENDTEMPGR
where:
TEMPGR Keyword indicating the start of the TEMPGR table.
name Temperature gradient profile name. The name must start with an
alpha character or a number, must not contain the % character, and
must not be NONE. This name is used to assign temperature
gradient profiles to connections in a NODECON, WELLS,
WELLHEAD or GROUP table.
on the following lines specify depths. (ft, m, m, m, cm)
VALUE Column heading keyword indicating that the entries in this location
on the following lines specify the temperature and temperature
gradients. The first entry is the temperature at the first depth.
Subsequent entries are the temperature gradient that applies from
the specified depth to the preceding depth in the table. (F/ft, C/m,
C/m, C/cm, C/cm)
ENDTEMPGR Alpha label indicating the end of the TEMPGR data.
Example:
TEMPGR profile1
DEPTH VALUE
0.0 60.0
1000.0 0.022
2000.0 0.021
ENDTEMPGR
378 Surface Network: Temperature Gradient Profiles (TEMPGR) R5000.0.1

Hydraulics Options (HYDRAULICS)
Hydraulic options are input as follows:
HYDRAULICS FLOW_UNSTABLE or SHUTIN_UNSTABLE
where:
HYDRAULICS Keyword introducing hydraulics options.
SHUTIN_UNSTABLE Specifies that the connections are shut in if the hydraulics are
unstable.
FLOW_UNSTABLE Specifies that the connections are not shut in if the hydraulics are
unstable, as long as a hydraulics intersection can be found.
This is the default.
Note:
For a hydraulics table with independent variables, QLIQ, GLR and WCUT, the hydraulics are
determined to be unstable if the change in the pressure drop across the connection (pin – pout) is
negative as the liquid rate increases. I.e. D (pin – pout) /D Qliq < 0.
Example:
HYDRAULICS FLOW_UNSTABLE
R5000.0.1 Surface Network: Hydraulics Options (HYDRAULICS) 379

Fluid Gradient Calculation Data (GRADIENT)
The method used when calculating fluid gradients is defined as follows:
GRADIENT EXPLICIT or IMPLICIT

(VIP or VIPOFF)
where:
GRADIENT Keyword introducing gradient calculation data.
IMPLICIT Specifies that fluid gradient calculations will be implicit.
EXPLICIT Specifies that fluid gradient calculations will be explicit. (This is

the default.)
VIP Specifies that for wellbore connections, the fluid gradient will be a
mobility-weighted average of the grid block fluid densities for
producers, and the density of the injected stream at wellbore
pressure for injectors. This is similar to the gradients calculated by
the VIP software. This input is obsolete, but still accepted. It
should now be specified by using the CELLAVG method in the
CONDEFAULTS table.
VIPOFF Specifies that VIP gradients will not be used. This input is obsolete,
but still accepted. The default method for the wellbore gradient
should now be specified in the CONDEFAULTS table.
Note:
1. By default, fluid gradients are calculated using the density of the fluids flowing in the con-
nection at the average of the nodein and nodeout pressure and temperature. Specifying VIP
overrides this for wellbore connections. It can also be changed by specifying a different
method in the CONDEFAULTS table or in the WELLBORE table. However, if GRADIENT
VIP is specified, the CONDEFAULTS and WELLBORE inputs will be ignored.
2. For multifield runs, gradient IMPLICIT or EXPLICIT input applies to the entire network and
can not be set by reservoir. The last GRADIENT input will determine the option used. For
each time period, the network files are read in the order that the reservoirs are input in the
multifield case file, with the multifield surface network file read last. So, GRADIENT input
in the multifield surface network file will override any preceding input in the individual res-
ervoir surface network files. GRADIENT VIP/VIPOFF input applies to the reservoir for
which it is input, but if it is present in the multifield surface network file, it will override any
prior input in the individual reservoirs.
380 Surface Network: Fluid Gradient Calculation Data (GRADIENT) R5000.0.1

Example:
GRADIENT IMPLICIT
R5000.0.1 Surface Network: Fluid Gradient Calculation Data (GRADIENT) 381

Separation and Stream Splitting Node Data (SEPNODES)
It is not necessary to define terminal nodes as separation nodes if the separator outflows may all
be considered as sink connections – fluids produced to a sink are always automatically flashed
through the separator battery defined for the sink connection. However, if internal separations are
desired (for example, for modeling gas reinjection or gas lift), separation node data are required.
For compositional fluids, separation nodes may represent any of the separator batteries or gas
plants described in the separator method files. Total phase rates obtained by flashing the inflow
through a separator battery (at the stage pressures and temperatures specified in the separator
method file), or through a gas plant, are implicitly split among the outflow connections using
user-defined volumetric phase fractions for the arbitrarily defined outflow connections. (These
fractions are essentially separation efficiency factors.) Only the separator battery number
(method number) is additionally required. Network node pressures computed by the model are
independent of separator battery stage pressures; rather they are determined by active network
constraints, reservoir behavior, and hydraulics.
For black-oil or compositional fluids, separation nodes may also represent separator stages which
can be sequentially connected to form separator batteries of arbitrary configuration. For each
stage node, the volumetric phase splits among the defined outflow connections are specified, and
for compositional fluids, the EOS method (IPVT) to be used for the flash calculation. The flash
calculation at each separation node is performed implicitly at network node conditions of temper-
ature and pressure. Node pressures are always determined by some combination of active net-
work constraints, network hydraulics, and reservoir conditions. Appropriate constraints, targets,
and hydraulics must be specified in order to, for example, set up a separator battery system that
operates at fixed stage pressures. Node temperatures are not yet predicted through a thermal
option but are given by, in order of increasing precedence:
1. The temperature associated with the EOS method, for compositional fluids.
2. Specification of NETTEMP in the surface network file, defining a single temperature for all
non-perforation network nodes. Required for black oil, gas-water, oil-water, and gas-water
fluid types when using the temperature dependency option. Perforation nodes are internally
assigned average connecting reservoir grid cell temperatures.
3. Specification of node temperatures in the NODES table of the surface network file.
Separation nodes may have an arbitrary number of outflow connections, but are restricted to hav-
ing a single inflow connection, and inflow and outflow connections may not be allowed to back-
flow.
The use of separation nodes introduces physical and corresponding numerical restrictions upon
placement of constraints. Of the n outflow connections of a separation node, n-1 of them are con-
sidered to be controlled by proportioning devices such as level controllers. The remaining con-
nection is referred to as the control connection, which may contain a device that can be used to
382 Surface Network: Separation and Stream Splitting Node Data (SEPNODES) R5000.0.1
regulate minimum pressure at the separation node. The model takes the control connection of a
given separation node as that outflow connection with the highest specified gas fraction. Separa-
tion systems are defined as groups of interconnected separation nodes and their connections flow-
ing only fluids originating from a single common upstream separator inflow connection. Since,
with respect to rates, all connections within the system downstream of any proportioned connec-
tion are considered proportioned, separation systems have a single control path (or path of possi-
ble hydraulic communication) from the common upstream connection into the first (furthest
upstream) separation node to a junction, a sink, or a reinjection system. Rate constraints in sepa-
ration systems are allowed to be applied only in connections along the control path of the system.
Constraints on rate-proportioned connections of a separation system must currently be targeted to
devices in connections upstream of the inlet separation node. Future enhancements will allow
singular devices in the control path to control flow through a proportioned connection. Maximum
pressure constraints cannot be specified for nodes that are not in the system control path (such as
for pumps for water disposal wells). These constraints must be handled through the predictive
logic with constraint modifications or flow rerouting. Applying a prohibited constraint within a
proportioned connection while keeping other controls fixed would physically result in flooding of
the upstream separator stages and system shutdown, and would numerically result in a singular
system of equations. There are no limitations on specifications of minimum pressure constraints
on nodes. If a node is a separation node, its minimum pressure constraint is automatically applied
within the control connection for that node.
Stream splitting nodes limit the split of the total flow rate into a node amongst the outflowing con-
nections by specified fractions. No phase separation occurs. Specification of the split implies the
presence of flow controlling devices in each defined outflow connection of the node. Each device
is assigned its specified maximum split as a maximum split constraint. If the sum of the specified
splits is unity, and at any given time, no other constraints are user-specified for these outflow
devices, then n-1 of the n outflow devices will be actively constraining the specified split. Which
of the n-1 devices are controlling is dependent upon hydraulics behavior and other active network
constraints, and is automatically determined by the program. If the sum of the fractions is unity,
then the specified fractions are honored unless other constraints specified by the user in at least
two of the outflowing connections become violated. In this case, the devices in the other connec-
tions (those without other violated constraints) will continue to constrain their maximum split to
the specified value.
Separation and stream splitting nodes in the surface network model are specified as follows.
SEPNODES
NODE node OUTCON conFOIL foil
FGAS fgas
FWATER fwater
FTOTAL ftotal
NOSPLITS
IPVT ipvt
IBAT (ibat or NONE)
PSEP (psep or NET)
TSEP (tsep or NET)
R5000.0.1 Surface Network: Separation and Stream Splitting Node Data (SEPNODES) 383
ENDSEPNODES
where:
SEPNODES Keyword indicating the start of the SEPNODES table.
NODE Introduces the name of a node.
node The name of a node (previously defined in a NODES or GROUP

table) which will be a separation node. All data following will
apply to this node until the another NODE keyword is input or the
ENDSEPNODES keyword is input.
OUTCON Introduces the name of a connection.
con The name of one of the outflow connections from the node. The
connections must have been previously defined in a NODECON
table or a GROUP table. In the NODECON table, the node must be
the NODEIN for this connection. All outflowing connections will
be inactive unless phase splits are specified.
FOIL Introduces the oil phase split for this connection. Only used if there
is an oil phase present in the network. (Fraction).
foil The fraction of the equilibrium oil phase which flows to this
connection.
Default: 0.0
FGAS Introduces the gas phase split for this connection. Only used if
there is a gas phase present in the network. (Fraction).
fgas The fraction of the equilibrium gas phase which flows to this
connection.
Default: 0.0
FWATER Introduces the water phase split for this connection. Only used if
there is a water phase present in the network. (Fraction).
fwater The fraction of water which flows to this connection.

Default: 0.0
FTOTAL Introduces the total rate split for this connection. Only used for a
stream splitting node. (Fraction).
ftotal The fraction of the total flow rate into the separation node which
flows to this connection.
Default: 0.0
NOSPLITS Specifies that this node is no longer a separation node or stream

splitting node.
IPVT Specifies the PVT method to use when the fluids are flashed in the
separator.
Default: The PVT method of the inflowing connection.
IBAT Specifies the separator method number (for a separator battery or

gas plant) to be used for the determination of phase volumes.
Default: None
PSEP Specifies the pressure at which the separation will occur. If IBAT is
specified, this input is ignored.
Default: NET. I.e The pressure calculated for node.
TSEP Specifies the temperature at which the separation will occur. If

IBAT is specified, this input is ignored.
Default: NET. I.e The temperature calculated (or input) for node.
ENDSEPNODES Alpha label indicating the end of the SEPNODES data.
Notes:
1. FTOTAL splits are mutually exclusive with FOIL, FGAS and FWATER splits. Whichever is
entered last will be honored. FTOTAL splits result in a stream splitting node, while FOIL,
FGAS and FWATER splits result in a separation node.
2. For each separation node, the sum of the fractions over all active outflowing connections
must equal 1.0 for each phase. The splits for all phases and all outflowing connections must
be specified before the next node or the ENDSEPNODES keyword is input.
3. For each stream splitting node, the sum of the FTOTAL fractions over all active outflowing
connections must greater than or equal to 1.0. The splits for all outflowing connections must
be specified before the next node or the ENDSEPNODES keyword is input.
4. Separation and stream splitting nodes can have only one inflowing connection.
5. Any properties of the separator node can be respecified at a later time without reentering all
the input.
6. Separation nodes are allowed only in production networks (more precisely, the inflow stream
must contain some contribution from the reservoir).
7. For a separation node, if a separator battery is assigned using IBAT, then the separator battery
is used to separate the fluids, but the pressures and temperatures specified in the separator
R5000.0.1 Surface Network: Separation and Stream Splitting Node Data (SEPNODES) 385
method have no influence on the network pressure and temperature solution.
8. For a separation node, if PSEP and or TSEP are specified, and IBAT is not specified, then a
single stage separation will occur at the specified pressure and temperature. PSEP and TSEP
have no influence on the network pressure and temperature solution.
9. For a separation node, if neither IBAT, nor PSEP and TSEP are specified, then the separation
is a single stage separation at the pressure and temperature calculated for the node.
10. When the keyword OUTCON is read for the first time for a NODE, any prior split data
(FOIL, FGAS FWATER or FTOTAL) is reset for all connections outflowing from the
SEPNODE.
Example:
SEPNODES
! Single stage separation at the calculated network pressure and temperature
NODE node1 OUTCON con1_1 FOIL 1.0
OUTCON con1_2 FGAS 1.0
OUTCON con1_3 FWATER 1.0
IPVT 1
! Separation using separation method 1
NODE node2 OUTCON con2_1 FOIL 1.0 FWATER 1.0
IBAT 1
! Single stage separation at a pressure = 100 and temperature = 60
NODE node3 OUTCON con2_1 FOIL 1.0 FWATER 1.0
PSEP 100 TSEP 60
! Stream splitting node

NODE node4 OUTCON con3_1 FTOTAL 0.5
OUTCON con3_2 FTOTAL 0.5
ENDSEPNODES
Commingled Production (COMMINGLE)
The method used when calculating surface production rates is specified as follows:
COMMINGLE ON or OFF
where:
COMMINGLE Keyword introducing commingle data.
ON Specifies that surface production rates will be determined by

calculating the contribution of each connection to the total surface
phase rates at a separator (where the fluids from several
connections are commingled). The location of the separator(s) is
specified by SEPNODES input. If a connection flows to more than
one separator, the surface production rates will not be commingled
for that connection.
OFF Specifies that surface production rates will be determined by

performing a separation on each connection separately.
(This is the default.)
Example:
COMMINGLE ON
R5000.0.1 Surface Network: Commingled Production (COMMINGLE) 387

Simplified Heat Transfer (HEATTR)
Temperatures in the surface network can be calculated using a simplified heat transfer option.
The option uses heat transfer coefficients for connections and wells, and specific heat capacities
for each fluid phase to perform an approximate heat loss calculation. Heat transfer coefficients
must be input for connections and wells. (See the CONDEFAULTS, WELLS, WELLBORE and
NODECON input sections.) The input for specific heat capacities and the keyword to activate the
option are as follows:
HEATTR
SHCOIL shcoil
SHCGAS shcgas
SHCWAT shcwat
where:
HEATTR Specifies that the simplified heat transfer option will be active.
SHCOIL Specific heat capacity of oil:

(BTU/(lbm*F), J/(kg*K), J/(kg*K), J/(kg*K), J/(kg*K)
Default: 0.53 BTU/(lbm*F) )
SHCGAS Specific heat capacity of gas:

(BTU/(lbm*F), J/(kg*K), J/(kg*K), J/(kg*K, J/(kg*K)
SHCWAT Specific heat capacity of water:

(BTU/(lbm*F), J/(kg*K), J/(kg*K), J/(kg*K), J/(kg*K)
Notes:
1. The equations governing the simplified heat transfer option are as follows:
dh
------ = – htc ⋅ π ⋅ diam ⋅ ( T – Tamb )
dx
where:
h is the fluid enthalpy, given by:
h = SHCOIL ⋅ qoil + SHCGAS ⋅ qgas + SHCWAT ⋅ qwat
x is the distance from the start of the connection in the direction of fluid flow
htc is the heat transfer coefficient
diam is the connection diameter
T is the temperature at distance x in the connection
388 Surface Network: Simplified Heat Transfer (HEATTR) R5000.0.1

Tamb is the ambient temperature at distance x in the connection
2. The temperatures calculated by the heat transfer option affect the network in-situ volumetric
rates calculated by the simulator, which in turn affect the pressure drops calculated by the
pressure drop correlations, and the fluid gradients calculated. However, this is only true if the
PVT methods used have temperature dependence, or the DEN_TEMP option is specified for
the surface network.
3. NETTEMP and RESTEMP or reservoir temperatures must be specified if the HEATTR

option is used. The ambient temperature used by the heat transfer calculation will use
NETTEMP, unless Node temperatures, or temperature profiles are input, and the temperature
of fluids flowing into the network from the perforations will use RESTEMP, unless the reser-
voir temperature array is input.
4. When the HEATTR option is used, all network temperatures, such as node temperatures, or
temperature profiles, are treated as ambient temperatures. If HEATTR is not used, these tem-
peratures are taken to be the actual temperature at the node or in the connection.
R5000.0.1 Surface Network: Simplified Heat Transfer (HEATTR) 389

Well Lists (WELLLIST)
A well lists can be used to specify a set of wells. These lists can be used when specifying con-
straints, or as arguments to well management procedures. Well lists are defined as follows:
WELLLIST well_list_name
(CLEAR)
ADD (or REMOVE)
wellname1
wellname2
.
.
ENDWELLLIST
Or
WELLLIST well_list_name
(CLEAR)
ADD (or REMOVE)
NODEPROD nodename1 or NODEINJ nodename1
NODEPROD nodename2 or NODEINJ nodename2
.
.
ENDWELLLIST
where:
WELLLIST Keyword introducing list of wells.
ENDWELLLIST Keyword specifying the end of the list of wells.
CLEAR Keyword specifying that all wells previously added to the list will
be removed.
ADD Keyword specifying that the listed wells, connections or nodes will
be added to the list.
REMOVE Keyword specifying that the listed wells, connections or nodes will
be removed from the list. The list must have been previously
created using the ADD keyword.
NODEPROD Keyword specifying that all producers connected upstream of the

specified node are added or removed from the list.
390 Surface Network: Well Lists (WELLLIST) R5000.0.1

NODEINJ Keyword specifying that all injectors connected downstream of the

specified node are added or removed from the list.
wellname1 A well name or a well list name. Well names can contain the
wildcard character (*).
nodename1 A node name.
Notes:
1. The NODEPROD or NODEINJ keywords add (or remove) the wells which have been con-
nected to the specified node by prior input. Both active and inactive wells will be added (or
removed) from the well list. The well list is not updated if the connections are altered by sub-
sequent input.
Example:
WELLLIST welllist1
ADD
well1
w_0*
NODEPROD node1
ENDWELLLIST
R5000.0.1 Surface Network: Well Lists (WELLLIST) 391

Connection Lists (CONLIST)
Connection lists can be used to specify a set of connections. These lists can be used when speci-
fying constraints, or as arguments to well management procedures. Connection lists are defined
as follows:
CONLIST connection_list_name
(CLEAR)
ADD (or REMOVE)
conname1
conname2
.
.
ENDCONLIST
Or
CONLIST connection_list_name
(CLEAR)
ADD (or REMOVE)
NODEIN nodename or NODEOUT nodename or NODEPRODWH nodename or
NODEPRODBH nodename or NODEINJWH nodename or NODEINJBH nodename
.
.
ENDCONLIST
where:
CONLIST Keyword introducing list of connections.
ENDCONLIST Keyword specifying the end of the list connections.
CLEAR Keyword specifying that all connections previously added to the

list will be removed.
392 Surface Network: Connection Lists (CONLIST) R5000.0.1

NODEIN Keyword specifying that the connections which have the specified
node as NODEIN (I.e all outflow connections for the node) are
added or removed from the list. (See NODECON table)
NODEOUT Keyword specifying that the connections which have the specified
node as NODEOUT (I.e all inflow connections for the node) are
added or removed from the list. (See NODECON table)
NODEPRODBH Keyword specifying that the well bottom hole connection for all
producers connected upstream of the specified node are added or
removed from the list.
NODEPRODWH Keyword specifying that the wellhead connection for all producers
connected upstream of the specified node are added or removed
from the list. (Wellhead connections must have been defined in a
WELLHEAD table)
NODEINJBH Keyword specifying that the well bottom hole connection for all
injectors connected downstream of the specified node are added or
removed from the list.
NODEINJWH Keyword specifying that the wellhead connection for all injectors
connected downstream of the specified node are added or removed
from the list. (Wellhead connections must have been defined in a
WELLHEAD table)
conname1 A connection name or a connection list name. Connection names

can contain the wildcard character (*).
nodename A node name.
Notes:
1. There are four connection lists provided by default. These are:
• PRODBHCONS – All production well bottom hole connection.
• PRODWHCONS – All production wellhead connections. (Must have been defined in a

WELLHEAD table.)
• INJBHCONS – All injection well bottom hole connections
• INJWHCONS – All injection wellhead connections. (Must have been defined in a

WELLHEAD table.)
2. The NODEPRODWH, NODEPRODBH, NODEINJWH or NODEINJBH keywords add (or

remove) the wellhead or well connections which have been connected to the specified node
by prior input. Both active and inactive connections will be added (or removed) from the
R5000.0.1 Surface Network: Connection Lists (CONLIST) 393

connection list. The connection list is not updated if the connections are altered by subse-
quent input
Example:
CONLIST conlist1
ADD
Con1
NODEOUT gathering_node ! all inflow connections of gathering_node
ENDCONLIST
394 Surface Network: Connection Lists (CONLIST) R5000.0.1

Node Lists (NODELIST)
Node lists can be used to specify a set of nodes. These lists can be used when specifying con-
straints, or as arguments to well management procedures. Node lists are defined as follows:
NODELIST node_list_name
(CLEAR)
ADD (or REMOVE)
nodename1
nodename2
.
.
ENDNODELIST
where:
NODELIST Keyword introducing list of nodes.
ENDNODELIST Keyword specifying the end of the list of nodes.
CLEAR Keyword specifying that all nodes previously added to the list will
be removed.
nodename1 A node name or a node list name. Node names can contain the
Notes:
1. There are four node lists provided by default. These are:
• PRODBHNODES – All production well bottom hole nodes.
• PRODWHNODES – All production wellhead nodes. (Must have been defined in a

WELLHEAD table.)
• INJBHNODES – All injection well bottom hole nodes.
• INJWHNODES – All injection wellhead nodes. (Must have been defined in a

WELLHEAD table.)
R5000.0.1 Surface Network: Node Lists (NODELIST) 395

Example:
NODELIST nodelist1
ADD
Node1
Node_*
ENDNODELIST
396 Surface Network: Node Lists (NODELIST) R5000.0.1

Rig Lists (RIGLIST)
Rig lists can be used to specify a set of rigs. These lists can be used when specifying rig data
arguments to drill queue procedures. Rig lists are defined as follows:
RIGLIST riglistname
(CLEAR)
ADD (or REMOVE)
Rigname
…
ENDRIGLIST
where:
RIGLIST Keyword introducing list of rigs.
CLEAR Keyword specifying that all rigs previously added to the list will be
removed.
ADD Keyword specifying that the rig(s) will be added to the list.
REMOVE Keyword specifying that the rig(s) will be removed from the list.
The list must have been previously created using the ADD
keyword.
Rigname A node name or a node list name. Node names can contain the
ENDRIGLIST Keyword ending the list of rigs.
Example:
RIGLIST
ADD
rig1
rig2
rig3
ENDRIGLIST
R5000.0.1 Surface Network: Rig Lists (RIGLIST) 397

Drill Parameters (DRILL)
Drill parameters are described below. These parameters are used in the drill queue procedures.
DRILL
WELL DRILLSITE DRILLTIME CMPLTIME RIGS REPLACEMENT
Well site_name dtime ctime rig well
or welllist or ALL or riglist or welllist
or ALL or NONE
ENDDRILL
where:
DRILL Keyword beginning the drill parameters.
WELL Specifies an individual well name or a well list.
DRILLSITE Specifies the drill site from which the well will be drilled. The
default is ALL.
DRILLTIME Amount of time before the rig is released. This supersedes the
default drill time specified in the RIG input. (days, days, days, days,
hours).
CMPLTIME Amount of time needed to complete the well. Time until start of
production will be drill time + cmpltime. (days, days, days, days,
hours). The default is 0.
RIGS Rigs that can be used to drill the well. The default is ALL.
REPLACEMENT Well or wells which can be drilled as a replacement for the well or
wells specified in the WELL column. The default is NONE. (Used
by redrill procedure.)
ENDDRILL Keyword ending the drill parameters.
Example:
DRILL
WELL DRILLSITE DRILLTIME CMPLTIME RIGS REPLACEMENT
well1 site1 240 30 rig1 well2
ENDDRILL
398 Surface Network: Drill Parameters (DRILL) R5000.0.1

2D Array of Connections (CONLIST_2D)
A two-dimensional array of connections (CONLIST_2D) can be used in procedures (see the Pro-
cedures section) to provide selectable connection lists. Two-dimensional arrays of connections
are input as follows:
CONLIST_2D conlist_2d_name
conname(1,1) conname(2,1) conname(3,1) ..
conname(1,2) conname(2,2) conname(3,2) …
.
.
ENDCONLIST_2D
where:
CONLIST_2D Keyword introducing list of connections.
ENDCONLIST_2D Keyword specifying the end of the list connections.
conname1 A connection name. Connection names can contain the wildcard

character (*).
Notes:
1. The connections specified on each line of input make up a row in the connection array.
2. Lines can be continued using a & at the end of the line.
3. There can be a different number of connections in each row of the connection array.
Example:
CONLIST_2D con2dname
! con2dname(i,j)
! i = 1, i = 2, i = 3
con1 con2 ! j = 1
con3 con4 con5 ! j = 2
ENDCONLIST_2D
R5000.0.1 Surface Network: 2D Array of Connections (CONLIST_2D) 399

Network Rate Constraints (CONSTRAINTS)
Rate constraints may be input for connections or wells. The only constraint which is applied by
default is a zero total backflow rate constraint (QALLMAX-) in all connections except those
between perfnodes (nodes connected to a reservoir grid cell). These perfnode connections are
allowed to backflow by default so that crossflow can occur automatically in any direction.
By default, the first occurrence of a connection or well in a time period (i.e. between TIME
inputs), will clear all previous constraints for that connection or well. All subsequent occurrences
of the same connection or well will add to the previously specified set of constraints.
Constraint data is specified as follows:
CONSTRAINTS
name
QOSMAX qosmax or MULT or NONE
QGSMAX qgsmax or MULT or NONE
QWSMAX qwsmax or MULT or NONE
QLIQSMAX qliqsmax or MUL or NONE
QALLRMAX MULT or NONE or 0
QOSMAX- qosmax- or NONE
QGSMAX- qgsmax- or NONE
QWSMAX- qwsmax- or NONE
QLIQSMAX- qliqsmax- or NONE
QOMAX qomax or NONE
QGMAX qgmax or NONE
QWMAX qwmax or NONE
QLIQMAX qliqmax or NONE
QALLMAX qallmax or NONE
QHCMAX qhcmax or NONE
QOMAX- qomax- or NONE
QGMAX- qgmax- or NONE
QWMAX- qwmax- or NONE
QLIQMAX- qliqmax- or NONE
QALLMAX- qallmax- or NONE
QHCMAX- qhcmax- or NONE
CLEAR
CLEARQ
CLEARP
ENDCONSTRAINTS
CLEAR
DONTCLEAR
where:
CONSTRAINTS Introduces constraint data.
400 Surface Network: Network Rate Constraints (CONSTRAINTS) R5000.0.1

name The name of a connection or well (or a connection or well list). The
wildcard character (*) can be used to specify multiple connections
or wells. When multiple names are specified using a wildcard
character, the constraint is applied if the name is of the correct type.
E.g. QOSMAX will be applied to a connection or well, but not to a
node. If numbers have been input to identify connections, nodes
and wells, then a number or number range can be used instead of a
name. A number range is specified as follows: n1 –n2, where n1
and n2 are integers, and n2 >= n1. Numbers can not be used in the
network file for a multi-reservoir run.
Surface rate constraints for connections or wells (Surface volume/day or hour, determined using
the EOS separator, or Black oil PVT method specified for the connection). If multiple rate data
has been entered (see QMULT table), then the surface rate constraint keywords may be followed
by the keyword MULT, to indicate that the value will be taken from the rates input in the QMULT
table. MULT can only be applied to connections which are in a linear series of connections lead-
ing to a well for which QMULT data has been input. I.e. There must be no branches in the net-
work between the connection and the well, other than gaslift connections. See Note 5 below. Rate
constraints can also be followed by the keyword NONE, to indicate that the constraint is inactive.
QOSMAX Maximum surface oil rate. (STB/D, STM3/D, STM3/D, STM3/D,

STCC/Hour)
QGSMAX Maximum surface gas rate. (MSCF/D, STM3/D, STM3/D, STM3/

D, STCC/Hour)
QWSMAX Maximum surface water rate. (STB/D, STM3/D, STM3/D, STM3/

D, STCC/Hour)
QLIQSMAX Maximum surface liquid rate. (STB/D, STM3/D, STM3/D, STM3/

D, STCC/Hour)
In-situ rate constraints for connections or wells (Reservoir volume/day or hour at the average
pressure and temperature in the connection)
QOMAX Maximum oil rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QGMAX Maximum gas rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QWMAX Maximum water rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QLIQMAX Maximum liquid rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QALLMAX Maximum total rate of all components. (RB/D, M3/D, M3/D, M3/D,
CC/Hour)
R5000.0.1 Surface Network: Network Rate Constraints (CONSTRAINTS) 401

QHCMAX Maximum total rate of all hydrocarbons. (RB/D, M3/D, M3/D, M3/
D, CC/Hour)
Surface rate constraints for reverse flow for connections or wells (Surface volume/day or hour,
determined using the EOS separator, or Black oil PVT method specified for the connection)
QOSMAX- Maximum reverse surface oil rate. (STB/D, STM3/D, STM3/D,

STM3/D, STCC/Hour)
QGSMAX- Maximum reverse surface gas rate. (MSCF/D, STM3/D, STM3/D,

STM3/D, STCC/Hour)
QWSMAX- Maximum reverse surface water rate. (STB/D, STM3/D, STM3/D,

STM3/D, STCC/Hour)
QLIQSMAX- Maximum reverse surface liquid rate. (STB/D, STM3/D, STM3/D,

STM3/D, STCC/Hour)
In-situ rate constraints for reverse flow, for connections or wells (Reservoir volume/day or hour at
the average pressure and temperature in the connection)
QOMAX- Maximum reverse oil rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QGMAX- Maximum reverse gas rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QWMAX- Maximum reverse water rate. (RB/D, M3/D, M3/D, M3/D,

CC/Hour)
QLIQMAX- Maximum reverse liquid rate. (RB/D, M3/D, M3/D, M3/D,

CC/Hour)
QALLMAX- Maximum reverse total rate of all components. (RB/D, M3/D,

M3/D, M3/D, CC/Hour)
Default: For connections below the bottom hole node, there is no

constraint. For all other connections, 0.
QHCMAX- Maximum reverse total rate of all hydrocarbons. (RB/D, M3/D,

Other keywords
QALLRMAX Must be followed by the keyword MULT, NONE or the number 0.

MULT specifies that the surface rates input in a QMULT table will
be converted internally to reservoir barrel equivalents, and summed
to obtain a total reservoir barrel rate for all fluid phases combined.
This conversion occurs at the start of each time step. NONE

specifies that the constraint is inactive, and 0 indicates a constraint

of 0, and may be used if no QMULT data has been input.
QALLRMAX can only be applied to connections which are in a
linear series of connections leading to a well for which QMULT
data has been input. I.e. There must be no branches in the network
between the connection and the well, other than gaslift connections.
CLEAR Specifies that the constraints for this connection, node or well will
be removed. Note, wells might have both rate and pressure
constraints.
CLEARQ Specifies that the rate constraints for this connection, or well will be
removed.
ENDCONSTRAINTS Keyword indicating the end of constraint data.
CLEAR Specifies the first occurrence of a node, connection or well in a time

period (i.e. between TIME inputs), will clear all previous
constraints for that node, connection or well. All subsequent
occurrences of the same node, connection or well will add to the
previously specified set of constraints. This is the default.
DONTCLEAR Specifies that the first occurrence of a node, connection or well in a

time period (i.e. between TIME inputs), will not clear all previous
constraints for that node, connection or well. All constraints will be
added to the previously specified set of constraints.
Notes:
1. If one of the default connection lists is used (PRODBHCONS, PRODWHCONS, INJBH-

CONS, INJWHCONS – see Well, Connection and Node Lists), then the constraint will be
applied to the well connections which have been previously defined in a WELLS and/or
WELLHEAD table.
2. All connections below a well's bottom hole node are allowed to backflow by default. This
includes the wellbore connections which are automatically created using the completion data
in the well file and any connections between well nodes. All other connections have QALL-
MAX set to zero, which prevents backflow.
3. If a well has gas lift injection at the bottom hole node, then the fluid flowing in the well con-
nection includes the gas lift gas. To set a rate constraint not including the gas lift gas, the well
bottom hole connection (well_name%bh) should be used as the connection name, rather than
the well name.
4. If the default separators are used for a connection, and the connection is part of an injection
network, then surface gas rates are calculated assuming all hydrocarbons are in the gas phase.
I.e a wet gas rate. The wet gas rate is calculated by multiplying the moles of each component
R5000.0.1 Surface Network: Network Rate Constraints (CONSTRAINTS) 403

by the standard volume per mole at the standard temperature and pressure specified for the
run. If a separator battery is specified for the connection, then the fluid is flashed through the
separator to determine the standard rates.
5. If the connection where the "MULT" constraint is specified is not the bottom hole connection
for the well, then the "MULT" constraint is a form of remote control. An implied valve is
assumed to be located at the connection where the constraint is applied, and will impose a
pressure drop such that the rate in the bottom hole connection satisfies the constraint. Speci-
fying remote control at the well head connection using the WELLCONTROL keyword has
no effect on the location of the implied valve for this type of constraint. In many cases,
"MULT" constraints should be specified on the wellhead connection, because that is where
they are often controlled
Example:
CONSTRAINTS
con1 QOSMAX 1000.0 QGSMAX 2000.0 QLIQMAX 3000.0
well1 QWSMAX 4000.0
! For the following input, QWSMAX applies to all wells and connections whose
! name starts with w. There must be at least one well or one node and one !
connection whose name starts with w.
w* QWSMAX 4000.0
ENDCONSTRAINTS

Network Pressure Constraints (CONSTRAINTS)
Pressure constraints may be input for node or wells. PMIN constraints are allowed in production
sub-networks only and PMAX constraints are allowed only in injection sub-networks. A pmin
constraint is required for the terminal node in a production network, and a pmax constraint is
required for the terminal node in an injection network. Pressure constraints are input in a CON-
STRAINTS table, which may also contain input for rate constraints, minimum rate limits and well
limits.
By default, the first occurrence of a node in a time period (i.e. between TIME inputs), will clear
all previous constraints for that node. All subsequent occurrences of the same node will add to the
previously specified set of constraints.
CONSTRAINTS
name PMIN pmin
PMAX pmax
PWMAX pwmax
PGMAX pgmax
BHP bhp
THP thp
CLEAR
CLEARP
ENDCONSTRAINTS
where:
name The name of a node or well (or a node or well list). The wildcard
character (*) can be used to specify multiple nodes or wells. When
multiple names are specified using a wildcard character, the
constraint is applied if the name is of the correct type. E.g. PMIN
will be applied to a node or well, but not to a connection. If
numbers have been input to identify connections, nodes and wells,
then a number or number range can be used instead of a name. A
number range is specified as follows: n1 –n2, where n1 and n2 are
integers, and n2 >= n1. Numbers can not be used in the network
file for a multi-reservoir run.
PMIN Specifies the minimum pressure constraint for a node or well.

Minimum pressure constraints only apply to production sub-
networks. (psia, kPaa, (Kg/cm2)a, barsa, psia)
R5000.0.1 Surface Network: Network Pressure Constraints (CONSTRAINTS) 405

PMAX Specifies the maximum pressure constraint for a node or well.

Maximum pressure constraints only apply to injection sub-
networks. (psia, kPaa, (Kg/cm2)a, barsa, psia)
PWMAX Maximum pressure applied during a water injection cycle for a

WAG well. Name should be the name of a node which is a nodeout
for a connection in the linear series of connections ending at the
bottomhole node. PWMAX will override the PMAX constraint
specified for this node (if any) at the time that the first water cycle
starts. This is illustrated in Figure 4 on page 336. (psia, kPaa, (Kg/
cm2)a, barsa, psia)
PGMAX Maximum pressure applied during a gas injection cycle, for a WAG
well. Name should be the name of a node which is a nodeout for a
connection in the linear series of connections ending at the
bottomhole node. PGMAX will override the PMAX constraint
specified for this node (if any) at the time that the first gas cycle
starts. This is illustrated in Figure 4 on page 336. (psia, kPaa, (Kg/
cm2)a, barsa, psia)
BHP Specifies the bottomhole pressure constraint for a well. This is

equivalent to PMIN for a production well and PMAX for an
injection well. (psia, kPaa, (Kg/cm2)a, barsa, psia)
THP Specifies the tubinghead pressure constraint for a well. This is

equivalent to PMIN for a production well and PMAX for an
injection well specified for the wellhead node. This can only used
if the wellhead node has been defined in a WELLHEAD table, or a
NODECON table. (psia, kPaa, (Kg/cm2)a, barsa, psia)
constraints, minimum rate limits and well limits.
CLEARP Specifies that the pressure constraints for this well or node will be
removed.
Notes:
1. If one of the default node lists is used (PRODBHNODES, PRODWHNODES, INJBH-

NODES, INJWHNODES – see Well, Connection and Node Lists), then the constraint will be
applied to the well nodes which have been previously defined in a WELLS and/or WELL-
HEAD table.
2. The CLEAR and DONTCLEAR keywords (see the“Network Rate Constraints (CON-
406 Surface Network: Network Pressure Constraints (CONSTRAINTS) R5000.0.1

STRAINTS)” on page 400) also act on the Pressure constraints. I.e., If CLEAR is specified,
the first occurrence of a well or node name will result in all constraints, including pressure
constraints, being removed.
Example:
CONSTRAINTS
node1 PMIN 500.0
well1 PMAX 3500.0
! For the following input, PMAX applies to all wells and nodes whose name
! starts with w
! name starts with w.
w* PMAX 3500.0
ENDCONSTRAINTS
R5000.0.1 Surface Network: Network Pressure Constraints (CONSTRAINTS) 407

Network Drawdown/Buildup Constraints (CONSTRAINTS)
Drawdown/Buildup constraints may be input for connections that are in the linear series of con-
nections leading to a well. Drawdown/Buildup constraints are input in a CONSTRAINTS table,
which may also contain input for rate constraints, pressure constraints, minimum rate limits and
well limits.
By default, the first occurrence of a connection in a time period (i.e., between TIME inputs) will
clear all previous constraints for that connection. All subsequent occurrences of the same connec-
tion will add to the previously specified set of constraints.
Drawdown/Buildup constraint data is specified as follows:
CONSTRAINTS
name DPBHMX (ZONE izone) dpbhmx or OFF
DPBHAVG dpbhavg or OFF
ENDCONSTRAINTS
where:
name The name of a connection or well (or a connection or well list). A

connection must be in the linear series of connections leading to a
well. The wildcard character (*) can be used to specify multiple
connections or wells. When multiple names are specified using a
wildcard character, the constraint is applied if the name is of the
correct type. For example, DPBHMX will be applied to a
connection or well, but not to a node. If numbers have been input
to identify connections, nodes and wells, then a number or number
range can be used instead of a name. A number range is specified
as follows: n1 -n2, where n1 and n2 are integers, and n2 >= n1.
Numbers can not be used in the network file for a multi-reservoir
run.
DPBHMX Specifies the maximum drawdown/build up for a well. This can be

specified for any connection which can control a single well. There
must be no branches in the network between the connection
specified, and a well. For a production well, DPBHMX is the
maximum drawdown for any completion in the well. For injection
wells, it is the maximum buildup for any completion in the well.
The connection specified is the point of control -- the location of a
valve which can be adjusted to achieve the desired drawdown.
Note that it may not be possible to control the drawdown in
crossflowing wells. DPBHMX can be followed by the keyword
OFF, which removes any prior input for this connection, or the
408 Surface Network: Network Drawdown/Buildup Constraints (CONSTRAINTS) R5000.0.1

keyword ZONE followed by a zone number. In this case, the

constraint applies only to completions in the specified zone. The
zone for each completion is specified in a WELLSPEC table. If no
zone is input, the constraint applies to all completions in the well,
except those with a zone number of 0. (psi, kPa, Kg/cm2, bars, psi)
ZONE Optional keyword specifying the perforation zone to which that the
DPBHMX constraint applies. The perforation zone is specified in a
WELLSPEC table. The default is all zones.
DPBHAVG Specifies the average drawdown/build up for a well. This can be

specified for any connection which can control a single well. There
must be no branches in the network between the connection
specified, and a well. For a production well, DPBHAVG is the
average drawdown for all perforations in the well. For injection
wells, it is the average buildup for all perforations in the well. The
connection specified is the point of control -- the location of a valve
which can be adjusted to achieve the desired drawdown. Note that
it may not be possible to control the drawdown in crossflowing
wells. DPBHAVG can be followed by the keyword OFF, which
removes any prior input for this connection. (psi, kPa, Kg/cm2,
bars, psi)
constraints, minimum rate limits and well limits.
CLEARQ Specifies that the constraints for this well or connection will be
removed, including DPBHMX and DPBHAVG constraints. Node
constraints will not be cleared.
Notes:

CONS, INJWHCONS; see Well, Connection and Node Lists), then the constraint will be
applied to the well connections which have been previously defined in a WELLS and/or
WELLHEAD table.
2. The CLEAR and DONTCLEAR keywords also act on the Drawdown and Buildup con-
straints. (See “Network Rate Constraints (CONSTRAINTS)” on page 400 .) For example,
if CLEAR is specified, the first occurrence of a well or connection name will result in all con-
straints, including drawdown and buildup constraints, being removed.
3. A DPBHMX or DPBHAVG constraint is a form of remote control. An implied valve is

assumed to be located at the connection where the constraint is applied, and will impose a
R5000.0.1 Surface Network: Network Drawdown/Buildup Constraints (CONSTRAINTS) 409

pressure drop such that the rate drawdown (or buildup) in the well satisfies the constraint.
Specifying remote control at the well head connection using the WELLCONTROL keyword
has no effect on the location of the implied valve for this type of constraint. In many cases,
the drawdown should be specified on the wellhead connection, because that is where it is
often controlled.
Example:
CONSTRAINTS
well1 DPBHMX ZONE 2 100.0
! The following connection must be in the linear series of connections
! leading to a well, otherwise the constraint is ignored
con1 DPBHAVG 150.0
ENDCONSTRAINTS
410 Surface Network: Network Drawdown/Buildup Constraints (CONSTRAINTS) R5000.0.1

Minimum Rate Limits (CONSTRAINTS)
In addition to connection rate and node pressure constraints, limits on the minimum rate that a
connection is allowed to flow before being shut can also be input in a CONSTRAINTS table.
Minimum rate limits are specified as follows:
CONSTRAINTS
name QOMIN qomin or NONE
QGMIN qgmin or NONE
QWMIN qwmin or NONE
QLIQMIN qliqmin or NONE
QALLMIN qallmin or NONE
QHCMIN qhcmin or NONE
QOMIN- qomin- or NONE
QGMIN- qgmin- or NONE
QWMIN- qwmin- or NONE
QLIQMIN- qliqmin- or NONE
QALLMIN- qallmin- or NONE
QHCMIN- qhcmin- or NONE
QOSMIN qosmin or NONE
QGSMIN qgsmin or NONE
QWSMIN qwsmin or NONE
QLIQSMIN qliqsmin or NONE
QOSMIN- qosmin- or NONE
QGSMIN- qgsmin- or NONE
QWSMIN- qwsmin- or NONE
QLIQSMIN- qliqsmin- or NONE
CLEAR
CLEARQ
ENDCONSTRAINTS
where:
name The name of a connection or well (or connection or well list). The
wildcard character (*) can be used to specify multiple connections
or wells. When multiple names are specified using a wildcard
character, the constraint is applied if the name is of the correct type.
E.g. Minimum rates will be applied to connections but not nodes.
If numbers have been input to idenfify connections and wells, then
a number or number range can be used instead of a name. A
number range is specified as follows: n1 –n2, where n1 and n2 are
integers, and n2 >= n1. Numbers can not be used in the network
file for a multi-reservoir run.
R5000.0.1 Surface Network: Minimum Rate Limits (CONSTRAINTS) 411

The minimum surface rate for a connection or well. (Surface volume/day or hour, determined
using the EOS separator, or Black oil PVT method specified for the connection).
QOSMIN Minimum surface oil rate. (STB/D, STM3/D, STM3/D, STM3/D,

STCC/Hour)
QGSMIN Minimum surface gas rate. (MSCF/D, STM3/D, STM3/D, STM3/D,

STCC/Hour)
QWSMIN Minimum surface oil rate. (STB/D, STM3/D, STM3/D, STM3/D,

STCC/Hour)
QLIQSMIN Minimum surface oil rate. (STB/D, STM3/D, STM3/D, STM3/D,

STCC/Hour)
The minimum in-situ rate for a connection or well. (Reservoir volume/day or hour at the average
pressure and temperature in the connection). If this rate can not be met, the connection or well
will be shut in.
QOMIN Minimum oil rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QGMIN Minimum gas rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QWMIN Minimum oil rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QLIQMIN Minimum oil rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
The minimum surface rate for reverse flow for a connection or well. (Surface volume/day or
hour, determined using the EOS separator, or Black oil PVT method specified for the connection).
If the connection or well is backflowing, and this rate can not be met, the connection or well will
be shut in.
QOSMIN- Minimum reverse surface oil rate.(STB/D, STM3/D, STM3/D,

STM3/D, STCC/Hour)
QGSMIN- Minimum reverse surface gas rate. (MSCF/D, STM3/D, STM3/D,

STM3/D, STCC/Hour)
QWSMIN- Minimum reverse surface oil rate.(STB/D, STM3/D, STM3/D,

STM3/D, STCC/Hour)
QLIQSMIN- Minimum reverse surface oil rate.(STB/D, STM3/D, STM3/D,

STM3/D, STCC/Hour)
The minimum in-situ rate for reverse flow for a connection or well. (Reservoir volume/day or
hour at the average pressure and temperature in the connection). If the connection or well is back-
flowing, and this rate can not be met, the connection or well will be shut in.
412 Surface Network: Minimum Rate Limits (CONSTRAINTS) R5000.0.1

QOMIN- Minimum reverse oil rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QGMIN- Minimum reverse gas rate. (RB/D, M3/D, M3/D, M3/D, CC/Hour)
QWMIN- Minimum reverse water rate. (RB/D, M3/D, M3/D, M3/D, CC/
Hour)
QLIQMIN- Minimum reverse liquid rate. (RB/D, M3/D, M3/D, M3/D, CC/
Hour)
QALLMIN- Minimum reverse total rate or all components. (RB/D, M3/D,

QHCMIN- Minimum reverse total rate of all hydrocarbons. (RB/D, M3/D,

be removed. Note: wells might have rate constraints, minimum rate
limits and pressure constraints.
CLEARQ Specifies that the rate constraints and minimum rate limits for this
connection, or well will be removed.
Notes:

CONS, INJWHCONS, PRODBHNODES – see Well, Connection and Node Lists), then the
constraint will be applied to the well connections which have been previously defined in a
WELLS and/or WELLHEAD table.
2. If the default separators are used for a connection, and the connection is part of an injection
network, then surface gas rates are calculated assuming all hydrocarbons are in the gas phase.
I.e a wet gas rate. The wet gas rate is calculated by multiplying the moles of each component
by the standard volume per mole at the standard temperature and pressure specified for the
run. If a separator battery is specified for the connection, then the fluid is flashed through the
separator to determine the standard rates.
3. The CLEAR and DONTCLEAR keywords (see “Network Rate Constraints (CON-
STRAINTS)” on page 400 ) also act on the Minimum Rate limits. For example, if CLEAR is
specified, the first occurrence of a well or connection name will result in all constraints,
including minimum rate limits, being removed.
Example:
CONSTRAINTS
con1 QOSMIN 10.0 QGSMIN 20.
R5000.0.1 Surface Network: Minimum Rate Limits (CONSTRAINTS) 413

ENDCONSTRAINTS
414 Surface Network: Minimum Rate Limits (CONSTRAINTS) R5000.0.1

Well and Perforation Limits (CONSTRAINTS)
In addition to connection rate and node pressure constraints, maximum limits on well water cuts,
water/oil ratios, gas/oil ratios or liquid/gas ratios can also be input in a CONSTRAINTS table.
Limit data is specified as follows:
CONSTRAINTS
name WCUTMAX wcutmax
WCUTPLUG wcutplug
WCUTPERF wcutperf
WORMAX wormax
WORPLUG worplug
WORPERF worperf
GORMAX gormax
GORPLUG gorplug
GORPERF gorperf
LGRMAX lgrmax
LGRPLUG lgrplug
LGRPERF lgrperf
CLEARLIMIT
ENDCONSTRAINTS
TSTPRF dtime
GROUP_PERFS
where:
name The name of a well or well list. The wildcard character (*) can be
used to specify multiple wells. If numbers have been input to
idenfify wells, then a number or number range can be used instead
of a name. A number range is specified as follows: n1 –n2, where
n1 and n2 are integers, and n2 >= n1. Numbers can not be used in
the network file for a multi-reservoir run.
WCUTMAX Specifies the maximum water cut for a well. Wells which exceed
this water cut will be shut in. (Fraction).
Default: No limit
WCUTPLUG Specifies the maximum water cut for recompleting a well. When a
well exceeds this water cut, the highest watercut perforations (or
group of perforations if GROUP_PERFS is specified) will be
plugged until the well’s water cut is less than wcutplug. If there is
only one perforation (or group of perforations) producing, this limit
is ignored, and any value specified for WCUTMAX will determine
whether the well is shut in. Once a perforation has been plugged, it
R5000.0.1 Surface Network: Well and Perforation Limits (CONSTRAINTS) 415

never produces again unless the well is re-perforated by new

WELLSPEC data, or by a WORKOVER procedure. (Fraction).
Default: No limit
WCUTPERF Specifies the maximum water cut for plugging a perforation. When
a perforation (or group of perforations if GROUP_PERFS is
specified) exceeds this water cut, it will be plugged. If there is only
one perforation (or group of perforations) producing, this limit is
ignored, and any value specified for WCUTMAX will determine
WELLSPEC data, or by a WORKOVER procedure. This test is
performed at the frequency specified by the TSTPRF input.
(Fraction).
Default: No limit
WORMAX Specifies the maximum water/oil ratio for a well. Wells which
exceed this water/oil ratio will be shut in. (STB/STB, STM3/STM3,
STM3/STM3, STM3/STM3, CC/CC).
Default: No limit
WORPLUG Specifies the maximum water/oil ratio for recompleting a well.

When a well exceeds this water/oil ratio, the highest water/oil ratio
perforations (or group of perforations if GROUP_PERFS is
specified) will be plugged until the well’s water/oil ratio is less than
worplug. If there is only one perforation (or group of perforations)
producing, this limit is ignored, and any value specified for
WORMAX will determine whether the well is shut in. Once a
perforation has been plugged, it never produces again unless the
well is re-perforated by new WELLSPEC data, or by a
WORKOVER procedure. (STB/STB, STM3/STM3, STM3/STM3,
STM3/STM3, CC/CC)
Default: No limit
WORPERF Specifies the maximum water/oil ratio for plugging a perforation.

When a perforation (or group of perforations if GROUP_PERFS is
specified) exceeds this water/oil ratio, it will be plugged. If there is
is ignored, and any value specified for WORMAX will determine
performed at the frequency specified by the TSTPRF input. (STB/
STB, STM3/STM3, STM3/STM3, STM3/STM3, CC/CC)
Default: No limit
416 Surface Network: Well and Perforation Limits (CONSTRAINTS) R5000.0.1

GORMAX Specifies the maximum gas/oil ratio for a well. Wells which exceed
this gas/oil ratio will be shut in. (MSCF/STB, STM3/STM3, STM3/
STM3, STM3/STM3, CC/CC).
Default: No limit
GORPLUG Specifies the maximum gas/oil ratio for recompleting a well.

When a well exceeds this gas/oil ratio, the highest gas/oil ratio
perforations (or group of perforations if GROUP_PERFS is
specified) will be plugged until the well’s gas/oil ratio is less than
gorplug. If there is only one perforation (or group of perforations)
producing, this limit is ignored, and any value specified for
GORMAX will determine whether the well is shut in. Once a
perforation has been plugged, it never produces again unless the
well is re-perforated by new WELLSPEC data, or by a
WORKOVER procedure. (MSCF/STB, STM3/STM3, STM3/
Default: No limit
GORPERF Specifies the maximum gas/oil ratio for plugging a perforation.

specified) exceeds this gas/oil ratio, it will be plugged. If there is
is ignored, and any value specified for GORMAX will determine
performed at the frequency specified by the TSTPRF input.
(MSCF/STB, STM3/STM3, STM3/STM3, STM3/STM3, CC/CC).
Default: No limit
LGRMAX Specifies the maximum liquid/gas ratio for a well. Wells which
exceed this liquid/gas ratio will be shut in. (STB/MSCF, STM3/
STM3, STM3/STM3, STM3/STM3, CC/CC).
Default: No limit
LGRPLUG Specifies the maximum liquid/gas ratio for recompleting a well.

When a well exceeds this liquid/gas ratio, the highest liquid/gas
ratio perforations (or group of perforations if GROUP_PERFS is
specified) will be plugged until the well’s liquid/gas ratio is less
than lgrplug. If there is only one perforation (or group of
perforations) producing, this limit is ignored, and any value
specified for LGRMAX will determine whether the well is shut in.
Once a perforation has been plugged, it never produces again unless
the well is re-perforated by new WELLSPEC data, or by a
WORKOVER procedure. (STB/MSCF, STM3/STM3, STM3/
Default: No limit

LGRPERF Specifies the maximum liquid/gas ratio for plugging a perforation.

specified) exceeds this liquid/gas ratio, it will be plugged. If there
is only one perforation (or group of perforations) producing, this
limit is ignored, and any value specified for LGRMAX will
determine whether the well is shut in. Once a perforation has been
plugged, it never produces again unless the well is re-perforated by
new WELLSPEC data, or by a WORKOVER procedure. This test
is performed at the frequency specified by the TSTPRF input.
(STB/MSCF, STM3/STM3, STM3/STM3, STM3/STM3, CC/CC).
Default: No limit
CLEARLIMIT Specifies that the limit constraints for this well will be removed.
TSTPRF Specifies the time interval between tests for violations of water cut,
WOR, GOR or LGR by perforation. (E.g WCUTPERF limit.)
Perforation tests are scheduled for the time at which TSTPRF is
input, plus tstprf days, and then every tstprf days after that.
Timesteps are not adjusted to hit the test time exactly. A value of 0
causes the program to test every timestep. (days, days, days, hours).
Default: No tests
GROUP_PERFS Specifies that perforation limits will be applied by perforation

group. I.e. perforations which have the same group index
(specified in the WELLSPEC table), will be treated as if they were
a single perforation.
Default: Not grouped.
Notes:
1. The CLEAR and DONTCLEAR keywords (see the Network Rate Constraints section) also
act on the Well and Perforation Limit constraints. I.e. If CLEAR is specified, the first occur-
rence of a well name will result in all constraints, including well and perforation constraints,
being removed.
2. If a PLUG limit is input for a well (e.g. WCUTPLUG), then the corresponding MAX limit
(e.g. WCUTMAX), if present, will not be enforced until only one perforation (or group of
perforations) remains open. I.e. The MAX limit is not enforced until the PLUG limit has no
more perforations available to plug.
Example:
TSTPRF 100.0
CONSTRAINTS
well1 WCUTMAX 0.75 WCUTPLUG 0.65
418 Surface Network: Well and Perforation Limits (CONSTRAINTS) R5000.0.1

well2 GORMAX 3.0 GORPERF 2.0

ENDCONSTRAINTS

Fuel Shrinkage and Constraints (CONSTRAINTS)
Gas used as fuel or lost to shrinkage can be specified as follows:
CONSTRAINTS
Conname QFUEL qfuel
FFUEL ffuel
QSHRINK qshrink
FSHRINK fshrink
CLEARFUEL
ENDCONSTRAINTS
Where:
QFUEL Specifies the rate of gas used as fuel. (MSCF/D, M3/D, M3/D,
M3/D, CC/Hour).
FFUEL Specifies the fraction of gas rate in connection conname used as

fuel. (Fraction).
QSHRINK Specifies the rate of gas lost to shrinkage. (MSCF/D, M3/D,

M3/D, M3/D, CC/Hour).
FSHRINK Specifies the fraction of gas rate in connection conname lost to

shrinkage. (Fraction).
CLEARFUEL Specifies that all fuel and shrinkage input will be cleared (set to
zero).
ENDCONSTRAINTS Keyword indicating the end of constraint data
Notes:
1. If both QFUEL and FFUEL are non zero, the total fuel used is the sum of the two.
2. If both QSHRINK and FSHRINK are non zero, the total shrinkage is the sum of the two.
3. FFUEL + FSHRINK must be <= 0.999
4. Fuel and shrinkage are removed at the inlet (upstream) node to the connection. A connection
which uses fuel or shrinkage must be the only connection flowing out of the inlet node.
Therefore, the connection can not flow out of a SEPNODE or stream splitting node. The rate
reported for the connection is the rate after fuel and shrinkage are removed.
5. Fuel usage and shrinkage are only calculated if the connection is flowing in the NODEIN to
420 Surface Network: Fuel Shrinkage and Constraints (CONSTRAINTS) R5000.0.1

NODEOUT direction. If flow occurs in the reverse direction, fuel usage and shrinkage are
set to zero.
Example:
CONSTRAINTS
Con1 QFUEL 1000
ENDCONSTRAINTS
R5000.0.1 Surface Network: Fuel Shrinkage and Constraints (CONSTRAINTS) 421

Miscellaneous Constraint Data (CONSTRAINTS)
Additional data for artificial lift, and activating and deactivating connections can be input in a
CONSTRAINTS table, in addition to rate constraints, pressure constraints, minimum rate limits
and well limits.
CONSTRAINTS
name ALQ alq
SETTING setting
GLEFMIN glefmin
GLRADD glradd
ACTIVATE
DEACTIVATE
POWER power
CLEARALQ
ENDCONSTRAINTS
where:
name The name of a connection or well (or a connection or well list). The
wildcard character (*) can be used to specify multiple connections.
When multiple names are specified using a wildcard character, the
constraint is applied if the name is of the correct type. I.e to all
names that fit the wildcard specification, which are connections. If
numbers have been input to idenfify connections, then a number or
number range can be used instead of a name. A number range is
specified as follows: n1 –n2, where n1 and n2 are integers, and n2
>= n1. Numbers can not be used in the network file for a multi-
reservoir run.
ALQ Specifies the artificial lift quantity. This the setting used when
looking up a hydraulics table. It will only have an effect for
hydraulics tables which have more than one ALQ value specified.
Default: The first artificial lift quantity value in the hydraulics
table.
SETTING Specifies a maximum valve setting. This is the setting used when
calculating the pressure drop across a valve, unless another
constraint is violated, in which case the setting is calculated by the
program. SETTING can also be followed by the keyword OPEN or
CLOSE, where OPEN is equivalent to the maximum setting in the
valve table, and CLOSE is equivalent to the minimum setting in the
422 Surface Network: Miscellaneous Constraint Data (CONSTRAINTS) R5000.0.1

valve table.
Default: OPEN.
GLEFMIN Specifies the minimum gas lift efficiency (Oil Production Rate/Gas
lift Rate) below which the connection will be taken off gas lift.
This limit should be specified for the gas lift connection. The Oil
Production Rate will be the rate in the out flowing connection from
the NODEOUT specified for the gas lift connection (often the
tubing connection). (STB/MSCF, m3/m3, m3/m3, m3/m3, cc/cc)
Default: No minimum.
GLRADD Specifies an additive correction term to the value of gas/liquid (or

gas/oil) ratio obtained from optimal gaslift tables. This only applies
to gas lift connections. (MSCF/STB, m3/ m3, m3/ m3, m3/ m3, cc/
cc)
Default: 0.
ACTIVATE Specifies that the connection or well will be activated.

Default: Connections and wells are active by default.
DEACTIVATE Specifies that the connection or well will be deactivated. This

provides a means of shutting in a well and preventing crossflow in
the wellbore.
POWER Specifies that the value entered on this line of data is the maximum
power supplied to the pump or compressor constituting this
connection. For centrifugal pumps with variable speed, the power
and the fluid rate and fluid properties determine the pressure
increase (head) of the pump. When an operating point for a
centrifugal pump or compressor can be found that consumes the
specified power at the prevailing flow rate, the actual power
consumed will equal to the specified value. In either of these
devices, when the input power is greater than the maximum power
that the device can consume at the prevailing flow rate, the device
will be operated at a lower power level that equals its maximum
limiting power level. The pump may be shut off if either the flow
rate too is too high (greater than the maximum flow rate in its
performance data) or if the specified power is too low for safe
operation of the pump. When a pump is shut off, both the power it
consumes and the pressure rise it generates are set to zero. The
same is true for centrifugal compressors, with the additional
possibility of being limited by the (low flow rate) surge limit. In the
case of compressors, the maximum flow rate limit is dictated by
choking of the flow. (HP, KW, KW, KW, KW)
Default: 0.
R5000.0.1 Surface Network: Miscellaneous Constraint Data (CONSTRAINTS) 423

CLEARALQ Specifies that the artificial lift quantity will be set to its default,
which is the first ALQ value in the hydraulics table. This also
clears any prior GLEFMIN or GLRADD input for the specified
connection.
Example:
CONSTRAINTS
con1 DEACTIVATE
con2 ALQ 1000
con3 POWER 2.50
ENDCONSTRAINTS
424 Surface Network: Miscellaneous Constraint Data (CONSTRAINTS) R5000.0.1

Multiple Rate Data (QMULT)
Well surface rates for all phases can be input in a QMULT table. These rates correspond to the
flow rates for the well bottom hole connection. These rates can be applied as constraints for any
connection in the linear series of connections leading to a well. (See Note 1 below.) If the con-
nection where the constraint is applied is not the well bottom hole connection, then the rate is
remotely controlled. I.e an implied valve is assumed to be located at the connection where the
constraint is applied, and will impose a pressure drop such that the rate in the bottom hole connec-
tion satisfies the constraint. Specifying remote control at the well head connection using the
WELLCONTROL keyword has no effect on the location of the implied valve for this type of con-
straint.
QMULT
WELL (QOIL) (QGAS) (QWATER)
Wellname qoil qgas qwater
. . . .
. . . .
ENDQMULT
where:
QMULT Keyword indicating the start of the QMULT table.
QOIL Column heading keyword indicating that the entries in this location
on the following lines are surface oil rates. (STB/D, STM3/D,
STM3/D, STM3/D, STCC/Hour)
Default: 0
QGAS Column heading keyword indicating that the entries in this location
on the following lines are surface gas rates. (MSCF/D, SM3/D,
SM3/D, SM3/D, STCC/Hour)
Default: 0
QWATER Column heading keyword indicating that the entries in this location
on the following lines are surface water rates. (STB/D, STM3/D,
STM3/D, STM3/D, STCC/Hour)
Default: 0
ENDQMULT Keyword indicating the end of the QMULT table.
R5000.0.1 Surface Network: Multiple Rate Data (QMULT) 425

Notes:
1. The rates input in a QMULT table can be applied as constraints by specifying the following
input in a CONSTRAINTS table.
Conname QOSMAX MULT The Qoil value will be used as a surface oil rate
constraint
Conname QGSMAX MULT The Qgas value will be used as a surface gas rate
constraint
Conname QWSMAX MULT The Qwater value will be used as a surface water rate
constraint
Conname QLIQSMAX MULT The sum of Qoil and Qwater will be used as a surface
liquid rate constraint
Conname QALLRMAX MULT The surface rates input in the QMULT table will be
converted internally to reservoir barrel
equivalents, and summed to obtain a total
reservoir barrel rate for all fluid phases combined.
In this case, Conname must be a well connection.
The connection Conname must lie in a linear series of connections leading to a well for which
QMULT data has been input. This means there must be no branches in the network between
the connection and the well, other than gaslift connections.
2. If the connection where the constraint is specified is not the bottom hole connection for the
well, then the "MULT" constraint is a form of remote control. An implied valve is assumed
to be located at the connection where the constraint is applied, and will impose a pressure
drop such that the rate in the bottom hole connection satisfies the constraint. Specifying
remote control at the well head connection using the WELLCONTROL keyword has no
effect on the location of the implied valve for this type of constraint. In many cases, "MULT"
constraints should be specified on the wellhead connection, because that is where they are
often controlled.
Example:
QMULT
WELL QOIL QGAS QWATER
Well1 121.0 53.6 2.5
Well2 211.0 102.4 35.7
ENDQMULT
426 Surface Network: Multiple Rate Data (QMULT) R5000.0.1

Production and Injection Targets (TARGET)
Targeting provides the capability to satisfy production or injection constraints by controlling mul-
tiple connections simultaneously (as opposed to CONSTRAINT input which constrains the pro-
duction and injection in a single connection). The production or injection target (i.e. the total rate
to be produced or injected) can be specified, or calculated by various methods, and the method by
which the target rate is allocated to the controlled connections can be specified. Many of the allo-
cation methods are based on potential production and injection. Potential rate in any given con-
nection is defined as the rate that would be obtained if all targets in the system were relaxed,
constrained by all defined constraints. Production and injection targets are input as follows.
TARGET
NAME CTRL (CTRLCOND) CTRLCONS (CTRLMETHOD) (CALCMETHOD) (CALCCOND)
tname ctrl (ctrlcond) ctrlcons (ctrlmethod) (calcmethod) (calccond)
. . . . . . .
ENDTARGET
Additional columns:
(CALCCONS) (VALUE) (ADDVALUE) (REGION) (PRIORITY) (QMIN) (QGUIDE) (MAXDPDT) (RANKDT)

(calccons) ( value ) (addvalue) (region) (priority) (qmin) (qguide) (maxdpdt) (rankdt)
. . . . . . . . .
where:
TARGET Keyword indicating the start of the TARGET table.
on the following lines specify a name for the target.
CTRL Column heading keyword indicating that the entries in this location
on the following lines specify the kind of control which will be
imposed at each of the control connections. Note that flow rates are
positive when flow is in the direction from NODEIN to
NODEOUT and rates are calculated using the conditions specified
in the CTRLCOND column. The possible controls are:
QO – oil rate.
QW – water rate.
QG – gas rate.
QLIQ – liquid rate.
QHC – hydrocarbon rate.
QALL – total fluid rate.
DEACTIVATE – deactivate target.
R5000.0.1 Surface Network: Production and Injection Targets (TARGET) 427

Note that the QALL option cannot be used with the SURFACE
condition, since SURFACE implies a separation after which gas
rates are in different units from oil and water rates and cannot
not be totalled.)
CTRLCOND Column heading keyword indicating that the entries in this location
on the following lines specify the conditions used for the control.
The possible conditions are:
SURFACE surface conditions. (Not valid if QALL or QHC

is input for CTRL.)
FIELD field average reservoir conditions (Not valid for
the master network file in a multifield run.)
REGAVG average reservoir conditions for the region. This
assumes the same region that is used to calculate
the target rate.
REGH- average reservoir conditions for the region, with
CAVG pressure calculated as the hydrocarbon pore vol-
ume weighted average. This assumes the same
region that is used to calculate the target rate.
CON at the conditions of the connections in the CTRL-
CONS connection list.
NA not applicable for pressure maintenance,
netvoidage and netfillup methods (CALC-
METHOD INJTGTP, PRODTGTP, NETVOID
and NETFILL). These methods use the condi-
tions specified on the CALCCOND column.
Resv_name field average reservoir conditions for the reser-
voir named Resv_name. (Only applies to multi-
field runs.) If a reservoir name is input for both
CALCCOND and CTRLCOND, then it must be
the same reservoir.
Default: SURFACE
CTRLCONS Column heading keyword indicating that the entries in this location
on the following lines specify which connections are controlled to
satisfy the target. CTRLCONS can be a connection list, a well list,
or a single connection. Production or injection constraints will be
applied to these connections so that the target constraint is satisfied.
Usually, the connection list should not mix connections controlling
injection with connections controlling production.
428 Surface Network: Production and Injection Targets (TARGET) R5000.0.1

CTRLMETHOD Column heading keyword indicating that the entries in this location
on the following lines specify the method that will be used to
allocate the target constraint to the controlling connections. The
possible methods are:
SCALE scale back connection rates in proportion to

their productivity/injectivity . The productiv-
ity/injectivity of each connection may be lim-
ited by other targets, if the connection is
involved in more than one target.
SCALEQP scale back connection rates in proportion to
their productivity/injectivity. The productivity/
injectivity of each connection is determined by
the potential solution only, and is not affected
by any other targets in which the connection is
involved
AVG all connections which are not limited by a pres-
sure constraint or a maximum rate constraint
flow at the same average rate.
GUIDERATE all connections which are not limited by a pres-
sure constraint or a maximum rate constraint
are scaled back in proportion to their specified
guide rate. (See the QGUIDE column and the
TGTCON table.)
WCUT reduce the production rate of the highest water
cut connections to the user-specified minimum
rate (specified by QMIN input), until the target
is reached. The last connection reduced is con-
strained so that the target is exactly met..
GOR reduce the production rate of the highest GOR
connections to the user-specified minimum
rate (specified by QMIN input), until the target
is reached. The last connection reduced is con-
strained so that the target is exactly met.
WRATE reduce the production rate of the highest water
rate connections to the user-specified mini-
mum rate (specified by QMIN input), until the
target is reached. The last connection reduced
is constrained so that the target is exactly met.

GRATE reduce the production rate of the highest gas

rate connections to the user-specified mini-
mum rate (specified by QMIN input), until the
target is reached. The last connection reduced
is constrained so that the target is exactly met.
LGR reduce the production rate of the highest liq-
uid/gas ratio connections to the user-specified
minimum rate (specified by QMIN input), until
the target is reached. The last connection
reduced is constrained so that the target is
exactly met.
AVGGOR scale the connection rates in proportion to the
inverse of the gas/oil ratio.
AVGWCUT scale the connection rates in proportion to the
inverse of the water cut.
AVGLGR scale the connection rates in proportion to the
inverse of the liquid/gas ratio.
GASLIFTOPT Distribute gas among the gas lift connections
specified in CTRLCONS by gas lift optimiza-
tion. See the Gas Lift Optimization Parame-
ters section.
Default: SCALE
CALCMETHOD Column heading keyword indicating that the entries in this location
on the following lines specify how the target rate will be
determined. The target rate can be specified as follows:
VALUE the target rate is specified in the VALUE col-

umn. This is the default
The target rate can be calculated from the sum of the flow rates in
the CALCCONS connection list as follows. Note that flow rates
are positive when flow is in the direction from NODEIN to NODE-
OUT, and the rates are evaluated at the conditions specified in the
CALCCOND column.
QW - total water rate.

QG - total gas rate.
QO - total oil rate.
QLIQ - total liquid rate.
QHC - total hydrocarbon rate.

QALL - total rate.

QWP - total potential water rate.
QGP - total potential gas rate.
QOP - total potential oil rate.
QLIQP - total potential liquid rate.
QHCP - total potential hydrocarbon rate.
QALLP - total potential rate.
The target rate can be calculated from the net production or net
injection in the CALCCONS connection list as follows. For the net
production calculation, flow rates in connections which are part of
the injection network are subtracted from flow rates in connections
which are part of the production network and vice versa for the net
injection calculation. The rates are evaluated at the conditions
specified in the CALCCOND column.
QWNETPROD - net water production rate.

QGNETPROD - net gas production rate.
QONETPROD - net oil production rate.
QLIQNETPROD - net liquid production rate.
QHCNETPROD - net hydrocarbon production rate.
QALLNETPROD - net total production rate.
QWPNETPROD - net potential water production rate.
QGPNETPROD - net potential gas production rate.
QOPNETPROD - net potential oil production rate.
QLIQPNETPROD - net potential liquid production rate.
QHCPNETPROD - net potential hydrocarbon production rate.
QALLPNETPROD - net potential total production rate.
QWNETINJ - net water injection rate.
QGNETINJ - net gas injection rate.
QONETINJ - net oil injection rate.
QLIQNETINJ - net liquid injection rate.
QHCNETINJ - net hydrocarbon injection rate.
QALLNETINJ - net total injection rate.
QWPNETINJ - net potential water injection rate.
QGPNETINJ - net potential gas injection rate.
QOPNETINJ - net potential oil injection rate.
QLIQPNETINJ - net potential liquid injection rate.
QHCPNETINJ - net potential hydrocarbon injection rate.
QALLPNETINJ - net potential total injection rate.

The target rate can be calculated from the injection into the region
specified in the REGION column as follows. Note that flow rates
are evaluated at the conditions specified in the CALCCOND col-
umn.
QWINJ - total water injection into the region.

QGINJ - total gas injection into the region.
QOINJ - total oil injection into the region.
QLIQINJ - total liquid injection into the region.
QHCINJ - total hydrocarbon injection into the region.
QALLINJ - total injection into the region.
The target rate can be calculated from the production from the
region specified in the REGION column as follows. Note that flow
rates are evaluated at the conditions specified in the CALCCOND
column.
QWPROD - total water production from the region.

QGPROD - total gas production from the region.
QOPROD - total oil production from the region.
QLIQPROD - total liquid production from the region.
QHCPROD - total hydrocarbon production from the
region.
QALLPROD - total production from the region.
The target rate can be calculated to maintain pressure in the speci-

fied region as follows:
INJTGTP the injection rate required in the control con-

nections to maintain pressure in the region
specified in the REGION column. Target pres-
sures are specified in the VALUE column. All
the connections in the CTRLCONS list are
assumed to inject into the region. CAL-
CCOND must be REGAVG, REGHCAVG or
FIELD, and CTRL must be QALL

INJTGTPHC the injection rate required in the control con-

nections to maintain hydrocarbon pore volume
averaged pressure in the region specified in the
REGION column. Target pressures are speci-
fied in the VALUE column. All the connec-
tions in the CTRLCONS list are assumed to
inject into the region. CALCCOND must be
REGAVG, REGHCAVG or FIELD, and CTRL
must be QALL
PRODTGTP the production rate required in the control con-
nections to maintain pressure in the region
specified in the REGION column. Target pres-
sures are specified in the VALUE column. All
PRODTGT- the production rate required in the control con-
PHC nections to maintain hydrocarbon pore volume
averaged pressure in the region specified in the
REGION column. Target pressures are speci-
fied in the VALUE column. All the connec-
tions in the CTRLCONS list are assumed to
inject into the region. CALCCOND must be
REGAVG, REGHCAVG or FIELD, and CTRL
must be QALL.
The target rate can be calculated to balance voidage in the specified

region as follows:
NETVOID the injection rate required in the control con-

nections to replace the net voidage in the
region specified in the REGION column. All

NETFILL the production rate required in the control con-

nections to produce the net fillup in the region
specified in the REGION column. All the con-
nections in the CTRLCONS list are assumed to
produce from the region. CALCCOND must
be REGAVG, REGHCAVG or FIELD, and
CTRL must be QALL
Default: VALUE
CALCCOND Column heading keyword indicating that the entries in this location
on the following lines specify the conditions used to calculate the
target rate. The possible pressure conditions are:
SURFACE surface conditions. (Not valid if the CALC-

METHOD specified begins with QALL or
QHC. E.g. QALLP, QHCNETPROD)
FIELD field average reservoir conditions (Not valid
for the master network file in a multifield run.)
REGAVG average reservoir conditions for the region.
REGHCAVG average reservoir conditions for the region,
with pressure calculated as the hydrocarbon
pore volume weighted average. This assumes
the same region that is used to calculate the tar-
get rate
CON at the conditions in connections in the CAL-
CCONS connection list.
NA not applicable for CALCMETHOD VALUE.
Resv_name field average reservoir conditions for the reser-
voir named Resv_name. (Only applies to mul-
tifield runs.) If a reservoir name is input for
both CALCCOND and CTRLCOND, then it
must be the same reservoir.
Default: SURFACE except for pressure maintenance, netvoid-
age and netfillup methods (CALCMETHOD INJTGTP, PRODT-
GTP, NETVOID and NETFILL), which default to REGAVG.
CALCCONS Column heading keyword indicating that the entries in this location
on the following lines specify which connections contribute to the
target calculation, or the keyword NA. CALCCONS can be a
connection list, a well list, or a single connection.
Default: NA

VALUE Column heading keyword indicating that the entries in this location
on the following lines specify the value for the target rate, a
multiplier applied to the target calculation, or the target pressure for
the region (for INJTGTP and PRODTGTP methods). An entry of
CURRENT can be used to specify the current pressure as the target
pressure.
Default: 1.0 or CURRENT
ADDVALUE Column heading keyword indicating that the entries in this location
on the following lines specify a amount which will be added to the
target rate calculated by CALCMETHOD. (Can not be used with
INJTGTP and PRODTGTP methods.)
Default: 0
REGION Column heading keyword indicating that the entries in this location
on the following lines specify the a region name. The keyword
input in this column should correspond to a region name input in
the REGDATA table (in the OPTIONS file). A region name or the
keyword FIELD is required if the CALCMETHOD entry requires a
region, or if REGAVG is specified for CTRLCOND or
CALCCOND. In the master network file of a multi-field run, a
reservoir name can be used as a region name.
Default: NA
PRIORITY Column heading keyword indicating that the entries in this location
on the following lines specify the priority for the target. Priority is
in inverse order of its integer value -- i.e. a value of 1 is the highest
priority. Targets are satisfied in the order of their priority, starting
with priority 1. For targets with the same priority, the first target
input will be satisfied first. ( positive Integer)
Default: 1
QMIN Column heading keyword indicating that the entries in this location
on the following lines specify the minimum rate for each
connection. This minimum rate applies to the phase(s) specified in
the CTRL column, and will be used by every connection in
CTRLCONS, unless an individual qmin is specified for a
connection in a TGTCON table. The units for QMIN depend on the
entry for the CTRL. (Real)
Default: 0
QGUIDE Column heading keyword indicating that the entries in this location
on the following lines specify the guide rate for each connection.
The entry can be a real value, or the keyword FORMULA. If
FORMULA is specified, the guide rate formula (see the Guide Rate
Formula Section) will be used to calculate the guide rate. This
guide rate will be used by every connection in CTRLCONS, unless

an individual guide rate is specified for a connection in a TGTCON

table. (Dimensionless). (Real)
Default: 1
MAXDPDT Column heading keyword indicating that the entries in this location
on the following lines specify the maximum rate of change of
region pressure versus time. This is used only if an INJTGTP or
PRODTGTP method of calculating a target is specified. (psi/day,
kPa/day, (Kg/cm2)/day, bars/day, psi/day). (Real)
Default: Unlimited
RANKDT Column heading keyword indicating that the entries in this location
on the following lines specify the minimum time change between
reranking the connections if the CTRLMETHOD is WCUT, GOR,
LGR, WRATE, GRATE, AVGWCUT, AVGGOR or AVGLGR --
i.e., the ranking will not be reperformed until the time elapsed from
the last ranking exceeds rankdt. (days, days, days, days, hours).
(Real)
Default: 0
ENDTARGET Alpha label indicating the end of the TARGET data.
Notes:
1. Region names are defined in a REGDATA table (in the OPTIONS file).
2. The potential rate is the maximum rate that flow in the connections specified by CALCCONS
in the absence of targeting, but subject to the connection rate constraints, and node pressure
constraints in the network.
3. When there are multiple targets, the effect of the targets is order dependent. The targeting
logic satisfies each target sequentially (or according to priority if the PRIORITY input is
used). It will generally work best to order the higher level targets last (i.e. the targets whose
CTRLCONS is a superset of other targets CTRLCONS, which might correspond to a higher
level gathering center).
4. While the input allows the controlling connections (CTRLCONS) to be any connections in
the network, it will generally work best to use the well, or wellhead connections or any other
connection to a well before it reaches a gathering node (manifold or gathering center). The
results may be unpredictable when multiple wells flow into a controlling connection, because
one or more of these wells might shut in if it can not compete with the other wells when all
wells are producing to the common pressure at the gathering node.
5. If a well has gas lift injection at the bottom hole node, then the fluid flowing in the well con-
nection includes the gas lift gas. To control a target excluding the gas lift gas, the CTRL-
CONS connection list should consist of well bottom hole connections (well_name%bh),
rather than the well connections.

6. The QMIN specified for a target applies to the phase rates specified in the CTRL column.
This means that it is mostly likely inappropriate to use a QMIN for a water rate target, since it
would result in wells which could not make the minimum water rate being shut in. It may
also not be appropriate for a gas rate target, unless gas is the primary fluid being produced.
Examples:
TARGET
NAME CTRL CTRLCOND CTRLCONS CTRLMETHOD CALCMETHOD CALCCOND CALCCONS VALUE
Ptarg1 QO SURFACE ds1_prod_wells SCALE VALUE NA NA 10000.0
Ptarg2 QW SURFACE ds1_prod_wells SHUTWCUT VALUE NA NA 20000.0
Itarg1 QW NA ds1_inj_wells GUIDERATE NETVOID NA drillsite1 1.0
Itarg2 QW NA ds2_inj_wells SCALE INJTGTP NA drillsite2 3550.0
Itarg3 QG SURFACE ds3_inj_wells SCALE QG SURFACE ds3_prod_wells 2.0
ENDTARGET
TARGET
NAME CTRL CTRLCOND CTRLCONS CTRLMETHOD CALCMETHOD CALCCOND REGION VALUE
Itarg4 QG REGAVG ds4_inj_wells SCALE QALLPROD REGAVG drillsite4 1.0
ENDTARGET
Ptarg1 imposes the constraint that the oil rate at surface conditions must not exceed 10000 STB/
Day. To meet this constraint, the connections in the connection list named ds1_prod_wells (per-
haps the production wells in drill site 1) will be controlled, with the oil rate allocated among them
by scaling each connection’s production in proportion to its productivity.
Ptarg2 imposes the constraint that the water rate at surface conditions must not exceed 20000
STB/Day. To meet this constraint, the connections in the connection list named ds1_prod_wells
(perhaps the production wells in drill site 1) will be controlled. If the constraint is exceeded, wells
will be shut in according to their water cut, starting with the highest water cut well. The swing
well (the last well shut in before the constraint is no longer exceeded), will be reopened, and con-
strained so that the target is exactly honored.
Itarg1 imposes the constraint that the water rate (determined at the average pressure of region drill
site1) must not exceed the net voidage produced from region drillsite1. To meet this constraint,
the connections in the connection list named ds1_inj_wells will be controlled. Usually, the con-
nections in ds1_inj_wells should inject into the region drillsite1, although this is not a require-
ment. Net voidage is calculated as the rate of change of the mass in place in the region plus the
mass injected by the controlled connections. This is the total mass produced from the region,
including flux into or out of the region but not including injection from the ds1_inj_wells connec-
tions. This mass is flashed at the region average pressure to determine the maximum amount of
fluid to inject. The target injection rate is allocated to each connection in ds1_inj_wells in propor-
tion to the specified guide rate.
Itarg2 imposes the constraint that the water rate (determined at the average pressure of region
drillsite2) must not exceed the amount of water required to maintain a pressure of 3550.0 psia in
the drillsite2 region. To meet this constraint, the connections in the connection list named
ds2_inj_wells will be controlled. Usually, the connections in ds2_inj_wells should inject into the
region drillsite2, although this is not a requirement. To determine the required injection rate, the

net voidage is calculated (as described above). In addition, the amount of injected fluid required
to raise or lower the average region pressure to the target pressure is calculated, subject to a limit
on the maximum allowed rate of change in the pressure. The target injection rate is allocated to
each connection in ds2_inj_wells in proportion to each connections injectivity.
Itarg3 imposes the constraint that the gas rate (determined at surface conditions) must not exceed
the amount of gas equal to twice the gas flowing in the connections ds3_prod_wells (determined
at surface conditions) To meet this constraint, the connections in the connection list named
ds3_inj_wells will be controlled. The target injection rate is allocated to each connection in
ds3_inj_wells in proportion to each connections injectivity.
Itarg4 imposes the constraint that the gas rate (determined at the average pressure of region
drillsite4) must not exceed the amount of gas required to replace the production of all fluids from
the drillsite4 region (at the average pressure of region drillsite3). To meet this constraint, the con-
nections in the connection list named ds3_inj_wells will be controlled. Usually, the connections
in ds4_inj_wells should inject into the region drillsite4, although this is not a requirement. To
determine the required injection rate, the total production from all perforations contained in
drillsite4 is summed, and flashed at the region average pressure. The target injection rate is allo-
cated to each connection in ds4_inj_wells in proportion to each connections injectivity.

Connection Rate Data for Targets (TGTCON)
Minimum rate and guide rate data can be entered for each connection which contributes to a target
as follows:.
TGTCON target_name (PARENT parentname)

CON (QMIN) (QGUIDE) (CALCMULT)
conname (qmin) (qguide ) (mult)
. . . .
ENDTGTCON
where:
TGTCON Keyword indicating the start of the TGTCON table.
Target_name A target name, previously defined in a TARGET table.
PARENT Optional keyword introducing the name of a parent connection.

This allows guide rates to be input in a tree structure, where the
guide rate for each connection will be the value input in the
QGUIDE column, multiplied by a fraction determined by its
parent’s guide rate. (See example 2)
Parentname The name of the connections parent in the tree. This could be a
connection name if the guide rate tree structure corresponds to the
actual network structure, or otherwise a dummy name can be input.
CON Column heading keyword indicating that the entries in this location
on the following lines specify the name of a connection, or a
connection list. Connection names can contain wildcard characters.
The connection must have been previous defined.
QMIN Column heading keyword indicating that the entries in this location
on the following lines specify the minimum rate for the
connection(s) for the phase(s) specified as the CTRL for target
target_name, when the target is satisfied. (The unit for QMIN
depends on the CTRL entry for this target.)
Default: Specified in TARGET table.
QGUIDE Column heading keyword indicating that the entries in this location
on the following lines specify the guide rate for the connection(s).
These guide rates are used when allocating target rates for each
connection for the target named target_name. The entry can be a
real value, or the keyword FORMULA. If FORMULA is specified,
the guide rate formula (see the Guide Rate Formula Section) will be
R5000.0.1 Surface Network: Connection Rate Data for Targets (TGTCON) 439
used to calculate the guide rate. (Dimensionless.)

Default: Specified in TARGET table.
CALCMULT Column heading keyword indicating that the entries in this location
on the following lines specify a multiplier used for each connection
in the CALCONS connection list when calculating the target rate.
Default: 1.0.
ENDTGTCON Alpha label indicating the end of the TGTCON data.
Notes:
1. Tree structured guide rates can be used for targeting using the GUIDERATE, SCALE, AVG,
AVGGOR, and AVGWCUT options for the CTRLMETHOD (See the Production and Injec-
tion Targets section.) When it is used for methods other than GUIDERATE, the production
(or injection) ratios at each level of the tree are honored if possible, except that the lowest
level connections in the tree (usually the wells), use the SCALE, AVG, AVGGOR or AVG-
WCUT method to allocate production (or injection) between the connections.
2. The guide rate formula can not be used for dummy connection names. (Dummy connection
names can be used instead of a parent connection name for tree structured guide rates.)
3. The QMIN specified for a target applies to the phase rates specified in the CTRL column.
This means that it is most likely inappropriate to use a QMIN for a water rate target, since it
would result in wells which could not make the minimum water rate being shut in. It may
also not be appropriate for a gas rate target, unless gas is the primary fluid being produced.
Examples:
Example 1. Simple guide rates
TGTCON targ1
CON QMIN QGUIDE
con1 100 100.0
con2 150 200.0
ENDTGTCON
Example 2. Tree structured guide rates
TGTCON ptarg PARENT CGATH1

CON QGUIDE
PRD1 0.6
PRD2 0.4
ENDTGTCON
CON QGUIDE
PRD3 0.5
PRD4 0.5
440 Surface Network: Connection Rate Data for Targets (TGTCON) R5000.0.1
ENDTGTCON
CON QGUIDE
CGATH1 0.6
CGATH2 0.4
ENDTGTCON
TGTCON ptarg
CON QGUIDE
PRD5 0.2
CGATH4 0.8
ENDTGTCON
This example corresponds to the following network.
In this example, the initial guide rate for the wells PRD1, PRD2, PRD3, PRD4 and PRD5 are:
0.288, 0.192, 0.16, 0.16 and 0.2. The targeting logic will attempt to preserve the ratio of the guide
rates at each level in the tree. So, if for example, PRD1 is not capable of making its fraction of the
target, but PRD2 can make more than its fraction, then the production from PRD2 would be
increased so that CGATH1 could make it’s fraction of the target. Likewise, if CGATH1 could not
make its fraction of the target, then production from CGATH2 will be increased (if possible) to
maintain the ratio between CGATH4 and PRD5.
R5000.0.1 Surface Network: Connection Rate Data for Targets (TGTCON) 441
Guide Rate Formula (GUIDERATE)
The guide rates used for targeting can be calculated from a formula as follows:
GUIDERATE
TARGET DTMIN PHASE A B C D E F INCREASE DAMP
Targetname dtmin oil/gas/liq/res a b c d e f Yes/no dampfac
ENDGUIDERATE
where
GUIDERATE Keyword indicating the start of a GUIDERATE formula table.
TARGET Column heading keyword indicating that the entries in this location
on the following lines specify the name of a target. The target must
have been previously defined in a TARGET table.
DTMIN Column heading keyword indicating that the entries in this location
on the following lines specify the minimum time interval between
guide rate calculations. (Days, Days, Days, Days, Hours)
Default: 0
PHASE Column heading keyword indicating that the entries in this location
on the following lines specify the phase used for the guide rate
calculation. See the notes below.
Default: OIL
A Column heading keyword indicating that the entries in this location

on the following lines specify the A parameter in the guide rate
formula. See the notes below.
Default: 0
B Column heading keyword indicating that the entries in this location

on the following lines specify the B parameter in the guide rate
Default: 0
C Column heading keyword indicating that the entries in this location

on the following lines specify the C parameter in the guide rate
Default: 0
442 Surface Network: Guide Rate Formula (GUIDERATE) R5000.0.1

D Column heading keyword indicating that the entries in this location

on the following lines specify the D parameter in the guide rate
Default: 0
E Column heading keyword indicating that the entries in this location

on the following lines specify the E parameter in the guide rate
Default: 0
F Column heading keyword indicating that the entries in this location

on the following lines specify the F parameter in the guide rate
Default: 0
INCREASE Column heading keyword indicating that the entries in this location
on the following lines specify whether the guide rate is allowed to
increase or not.
Default: YES
DAMP Column heading keyword indicating that the entries in this location
on the following lines specify the damp factor. The guide rate (GR)
will be a weighted average of the previous guide rate, and the guide
rate calculated from the formula.
GR = GR_old * (1 – dampfac) + GR_formula * dampfac
Default: 1.0
ENDGUIDERATE Keyword indicating the end of the GUIDERATE table.
R5000.0.1 Surface Network: Guide Rate Formula (GUIDERATE) 443

Notes:
1. The guide rate formula is given by
( POT p ) A
GR p = ----------------------------------------------------
-
D F
B + C ( R1 ) + E ( R2 )
where
POTp is the well’s or connections’s potential flow rate of the nominated phase
A, B, C, D, E and F are user-supplied powers and coefficients,
R1 and R2 are ratios of phase potentials, which depend on the nominated phase p
If the nominated phase is OIL:
GRp is the oil phase guide rate (STB/D, m3/Day).

R1 = water/oil ratio (dimensionless)
R2 = gas/oil ratio (MSCF/STB, m3/m3)
If the nominated phase is LIQ:
GRp is the liquid (oil + water) phase guide rate (STB/D, m3/Day).
R1 = water cut ratio (dimensionless)
R2 = gas/liquid ratio (MSCF/STB, m3/m3, cc/cc)
If the nominated phase is GAS:
GRp is the gas phase guide rate (MSCF/D, m3/Day).

R1 = water/gas ratio (STB/MSCF, m3/m3, cc/cc)
R2 = oil/gas ratio (STB/MSCF, m3/m3, cc/cc)
If the nominated phase is RES:
GRp is the reservoir fluid volume guide rate (RB/Day, Rm3/Day).

R1 = water/oil ratio (dimensionless)
R2 = gas/oil ratio (dimensionless)
2. In order to use the formula to calculate the guide rates, FORMULA must be specified in the
QGUIDE column of the TARGET table (which would cause all connections involved in the
target to use the formula), or FORMULA must be specified in the QGUIDE column of the
TGTCON table (which allows guide rates calculated from the formula to be used for some
444 Surface Network: Guide Rate Formula (GUIDERATE) R5000.0.1

connections, while others could use a specified guide rate).
Example:
GUIDERATE
TARGET PHASE A B C D E F INCREASE DAMP
ptarg OIL 1.5 1 1 1 1 1 YES 0.5
ENDGUIDERATE
R5000.0.1 Surface Network: Guide Rate Formula (GUIDERATE) 445

Remote Control of Well Constraints (WELLCONTROL)
By default, rate constraints input in a CONSTRAINTS table are controlled by an implied valve
located in the connection where the constraint is imposed (except for rate "MULT" constraints,
DPBHMX and DPBHAVG constraints). This means that for the well bottom hole node, the pres-
sure is controlled by the well connection, and rates specified for the well connection are con-
trolled by the well connection. When one of these constraints is active, there is an additional
pressure drop in the well connection (over and above the normal hydraulic pressure drop), which
is sufficient to restrict the rate or pressure to the specified constraint value. This additional pres-
sure drop is the result of the implied valve being adjusted. Note that the valve need not be explic-
itly modeled. It is sufficient for the program to know that a device is present which is capable of
imposing an additional pressure drop. For well bottom hole pressures and rate constraints input
for the well connection, or the well bottom hole connection, the wellhead connection can be spec-
ified as the control connection as follows:
WELLCONTROL WELLHEAD or LOCAL
where
WELLCONTROL Introduces data specifying where well bottom hole pressures and
rates will be controlled
WELLHEAD Specifies that the well head connection will control well bottom
hole pressures, well connection rates, and well bottom hole
connection rates.
LOCAL Specifies that the well connection will control well bottom hole
pressures and well rates, and the well bottom hole connection will
control well bottom hole connection rates. This is the default.
Notes:
1. This input will apply to WELLS defined in any WELLS table that follows.
2. This input can be overridden by specifying the control connections in a CONTROL table.
3. Rate constraints using the MULT keyword, which constrain the rate at a well bottom hole
connection, and DPBHMX and DPBHAVG constraints, are another form of remote control,
and they are unaffected by which option is specified for WELLCONTROL. In these cases,
the rate of bottom hole connection, or drawdown, is controlled at the location where the con-
straint is specified. E.g. if a DPBHMX constraint is specified for a well connection, it will
still be applied at the well connection, even if WELLCONTROL WELLHEAD is specified.
If it is desired for the drawdown to be controlled at the wellhead, then the DPBHMX con-
straint should be specified on the well head connection.
446 Surface Network: Remote Control of Well Constraints (WELLCONTROL) R5000.0.1

Examples
WELLCONTROL WELLHEAD
! The following wells will be controlled at the well head
WELLS
NAME STREAM DATUM
P-1 PRODUCER 5000.0
P-2 PRODUCER 5000.0
ENDWELLS
WELLCONTROL LOCAL
! The following wells will be controlled locally
! This has no effect on any wells previously input (P-1 and P-2 in this case)
WELLS
NAME STREAM DATUM
I-1 WATER 5000.0
I-2 WATER 5000.0
ENDWELLS
R5000.0.1 Surface Network: Remote Control of Well Constraints (WELLCONTROL) 447

Remote Control of Constraints (CONTROL)
By default, rate constraints input in a CONSTRAINTS table are controlled by an implied valve
located in the connection where the constraint is imposed, PMIN constraints are controlled by an
implied valve located in the connection immediately downstream of the node where the PMIN
constraint is imposed, and PMAX constraints are controlled by an implied valve in the connection
immediately upstream of the node where the PMAX constraint is imposed. When the constraint
is active, there is an additional pressure drop in the control connection (over and above the normal
hydraulic pressure drop), which is sufficient to restrict the rate or pressure to the specified con-
straint value. This additional pressure drop is the result of the implied valve being adjusted. Note
that the valve need not be explicitly modeled. It is sufficient for the program to know that a
device is present which is capable of imposing an additional pressure drop. If the location of the
control device (the implied valve) is not in the default location, for example if a valve at the well-
head is used to control the bottom hole pressure, then the location can be specified in a CON-
TROL table as follows:
CONTROL
TYPE NAME CONTROLCON
RATE constrained_con control_con
PMAX constrained_node control_con
PMIN constrained_node control_con
ENDCONTROL
where
CONTROL Introduces data for remote control of constraints.
TYPE Column header specifying what type of constraint will be

controlled.
RATE Any rate constraint, such as QOSMAX. The name in the NAME
column should be the connection where the rate constraint is
specified. The name in the CONTROLCON column should be the
connection where the rate will be controlled. In order to be able to
control the rate at connection constrained_con, all fluid flowing
through connection constrained_con must also flow through
connection control_con. I.e. If control_con is downstream of
constrained_con, then there can be no stream split or separator
between constrained_con and control_con, and all connections
feeding into a gathering node between constrained_con and
control_con must not allow backflow. If control_con is upstream of
448 Surface Network: Remote Control of Constraints (CONTROL) R5000.0.1

constrained_con, there can be no gathering node between

control_con and constrained_con, and any stream split must not
allow backflow in the outflowing connections.
PMAX PMAX constraint. The name in the NAME column should be the
node where the PMAX constraint is specified. The name in the
CONTROLCON column should be the connection where the
pressure will be controlled. In order to be able to control the
pressure, connection control_con must be upstream of node
constrained_node, and there can be no gathering node between
control_con and constrained_node, and any stream split must not
allow backflow in the outflowing connections.
PMIN PMIN constraint. The name in the NAME column should be the
node where the PMIN constraint is specified. The name in the
CONTROLCON column should be the connection where the
pressure will be controlled. In order to be able to control the
pressure, connection control_con must be downstream of node
constrained_node, and there can be no stream split or separator
between constrained_node and control_con, and all connections
feeding into a gathering node between constrained_node and
control_con must not allow backflow.
NAME Column header specifying what the connection, or node which will
be controlled.
CONTROLCON Column header specifying the connection which will control the
connection or node input in the NAME column, or the keyword
NONE.
ENDCONTROL Terminates CONTROL input
R5000.0.1 Surface Network: Remote Control of Constraints (CONTROL) 449

Notes:
1. The control connection must be located at a point where the constraint can be controlled. If
the control connection is downstream of the constrained connection, then there can be no
stream split between constrained_node and control_con, and all connections feeding into a
gathering node between constrained_node and control_con must not allow backflow.
split_con
constrained_con control_con
Figure 5
The above figure is an example of an invalid control location. In this case, control_con can
not control constrained_con, because fluid from constrained_con could flow out split_con,
bypassing the attempted control.
inflow_con
constrained_con control_con
Figure 6
The above figure is an example of a valid control location. In this case, control_con can con-
trol constrained_con, as long as inflow_con is not allowed to backflow.
If the control connection is upstream of the constrained connection, then there can be no
gathering node between control_con and constrained_node, and any stream split must not
allow backflow in the outflowing connections
split_con
control_con constrained_con
Figure 7

The above figure is an example of a valid control location. In this case, control_con can con-
trol constrained_con, as long as split_con is not allowed to backflow.
inflow_con
control_con constrained_con
Figure 8
The above figure is an example of an invalid control location. In this case, control_con can
not control constrained_con, because fluid from inflow_con can flow through
constrained_con, bypassing the attempted control.
2. A connection (or node) can only be controlled by one other connection.
3. Connections below the bottom hole node can not be specified as a CONTROLCON.
4. Connections below the bottom hole connection and nodes below the bottom hole node can
not be remotely controlled -- i.e., they can not be specified in the NAME column.
5. If a connection is the control connection for multiple nodes, then only one of the constraints
specified for the nodes can be exactly satisfied, and the constraints at the remaining nodes
will not be violated. E.g., if the production from three wells are gathered into a single node,
with one outflow connection, and the outflow connection is specified as the PMIN control
connection for the bottom hole pressure of all three wells, then (in the absence of other con-
straints), the bottom hole pressure of one of the wells will be PMIN, and the bottom hole
pressure of the two other wells will be greater than PMIN.
6. If a connection is the control connection for multiple connections, then only one of the con-
straints specified for the connections can be exactly satisfied, and the constraints at the
remaining connections will not be violated. E.g., if the production from three wells are gath-
ered into a single node, with one outflow connection, and the outflow connection is specified
as the RATE control connection for the bottom hole well connection of all three wells, then
(in the absence of other constraints), the rate of one of the wells will be exactly satisfy its
most restrictive rate constraint, and the rate at the other wells will be less than any of their
rate constraints.
7. Remote control of rate constraints also applies to allocated targets -- i.e., if a connection has
specified a controlcon in a CONTROL table, then if that connection is part of a CTRLCONS
connection list in a TARGET table, the fraction of the target allocated to the connection will
be a rate constraint controlled by the controlcon connection.
8. Rate constraints using the MULT keyword, which constrain the rate at a well bottom hole
connection, and DPBHMX and DPBHAVG constraints, are another form of remote control,
and they are unaffected by CONTROL input. In these cases, the rate of the bottom hole con-
nection, or drawdown, is controlled at the location where the constraint is specified. E.g., if
R5000.0.1 Surface Network: Remote Control of Constraints (CONTROL) 451

a QOSMAX MULT constraint is specified for a well connection, it will still be applied at the
well connection, even if the CONTROL input specifies a different control connection for
rates. If, for example, it is desired for the drawdown to be controlled at the wellhead, then the
QOSMAX MULT constraint should be specified on the well head connection.
Example:
In the following example, P-1 is a production well and I-1 is an injection well. In both cases, rates
specified for the well connection will be controlled by the wellhead connections, and bottom hole
pressure constraints will also be controlled by the wellhead connections. Note that P-1 could have
a gaslift connection injecting into the bottom hole node, and it would still be valid to specify the
wellhead connection as the control connection. This would correspond to the configuration
shown in Figure 6 on page 450.
CONTROL
TYPE NAME CONTROLCON

RATE P-1 P-1-Wellhead
PMIN P-1 P-1-Wellhead
RATE I-1 I-1-Wellhead
PMAX I-1 I-1-Wellhead
ENDCONTROL

Gas Lift Ontime (GLIFT)
The parameters controlling how gas lift ontime is calculated are as follows:
GLIFT CALCONTIME or NOONTIME
where:
GLIFT Introduces the keywords for gas lift ontime.
CALCONTIME Specifies that the ontime used for each gas lift calculation is the
total mass flow rate averaged ontime of the other inflowing
connections to the gas lift node. This is the default.
NOONTIME Specifies that the ontime used for each gas lift connection is 1. This
option mimics the VIP software.
Example:
GLIFT NOONTIME
R5000.0.1 Surface Network: Gas Lift Ontime (GLIFT) 453

Gas Lift Optimization Parameters (GLIFTOPT)
The parameters controlling gas lift optimization are specified as follows:
GLIFTOPT OILVALUE oilvalue

GASVALUE gasvalue
GLIFTCOST gliftcost
WATCOST watcost
MAXNOGLDT maxnogldt
MINNOGLDT minnogldt
where:
GLIFTOPT Introduces the keywords for gas lift optimization parameters.
OILVALUE Specifies the value of produced oil. ($/STB, $/ m3, $/ m3, $/ m3, $/
cc).
Default: 30 $/Stb
GASVALUE Specifies the value of produced gas. ($/MSCF, $/ m3, $/ m3,

$/ m3, $/cc).
Default: 3 $/MSCF
GLIFTCOST Specifies the cost of gas lift gas injected. ($/MSCF, $/ m3, $/ m3,
$/ m3, $/cc).
Default: 4.5 $/MSCF
WATCOST Specifies the cost of produced water. ($/STB, $/ m3, $/ m3, $/ m3,
$/cc).
Default: 2 $/Stb
MAXNOGLDT Specifies the maximum time interval between optimization

calculations. (Days, Days, Days, Days, Hours).
Default: 90 Days
MINNOGLDT Specifies the minimum time interval between optimization

calculations. (Days, Days, Days, Days, Hours).
Default: 0 Days
Notes:
1. Gas lift optimization allocates gaslift gas among all the gas lift injection connections, to max-
imize the following benefit function.
Benefit = Oilvalue*Oil Rate + Gasvalue*Gas Rate - Gliftcost*Gas Lift Rate - Watcost*Water

rate
454 Surface Network: Gas Lift Optimization Parameters (GLIFTOPT) R5000.0.1

2. Gas lift optimization is invoked by specifying the keyword GASLIFTOPT as the CTRL-
METHOD in a TARGET table.
Example:
GLIFTOPT OILVALUE 25
GASVALUE 6
GLIFTCOST 2
WATCOST 1
MAXNOGLDT 30
R5000.0.1 Surface Network: Gas Lift Optimization Parameters (GLIFTOPT) 455

Activating and Deactivating Connections (ACTIVATE/

DEACTIVATE)
Connections can be activated and deactivated as follows.
ACTIVATE
CONNECTION
name(1)
name(2)
.
.
name(n)
ENDACTIVATE
DEACTIVATE
CONNECTION
name(1)
name(2)
.
.
name(n)
ENDDEACTIVATE
where:
ACTIVATE Keyword indicating the start of table specifying connections to

activate. This will only have an effect if the connection has been
previously deactivated in a DEACTIVATE table.
DEACTIVATE Keyword indicating the start of a table specifying connections to

deactivate.
n Number of specified connections.
CONNECTION Column heading keyword indicating that the entries in this location
on the following lines are connection names.
name Connection name. The connection must have already been defined
in a NODECON table, a GROUP table, or as a WELL.
ENDACTIVATE Alpha label indicating the end of the ACTIVATE data.
ENDDEACTIVATE Alpha label indicating the end of the DEACTIVATE data.
Notes:
1. Because this table has only one column, more than one connection name can be input on each
456 Surface Network: Activating and Deactivating Connections (ACTIVATE/DEACTIVATE)

line of the table.
2. Sections of the network which are not connected to a source or sink, and a well will be dis-
connected from the active network. Therefore deactivating one connection may disconnect
large sections (sub-networks) from the active network.
Example:
DEACTIVATE
CONNECTION
con1 con2 con3
con4
ENDDEACTIVATE
R5000.0.1Surface Network: Activating and Deactivating Connections (ACTIVATE/DEACTIVATE) 457

Water-Alternating-Gas (WAG) Wells
The parameters controlling maximum injection and cycle time of WAG wells are as follows.
WAG
WELL WSCUM GSCUM WCUM GCUM DTWATER DTGAS
Wellname wscum gscum wcum gcum dtwat dtgas
ENDWAG
where:
WAG Keyword indicating the start of water-alternating-gas table data.
WELL Name of the water-alternating-gas well.
WSCUM Maximum cumulative injection of water, at surface conditions, for

each water cycle. (MSTB, k stm3, k stm3, k stm3, k stcc).
Default: NONE.
GSCUM Maximum cumulative injection of gas, at surface conditions, for

each gas cycle. (MMSCF, k stm3, k stm3, k stm3, k stcc).
Default: NONE.
WCUM Maximum cumulative injection of water, at reservoir conditions,

for each water cycle. (MRB, k m3, k m3, k m3, k cc).
Default: NONE.
GCUM Maximum cumulative injection of gas, at reservoir conditions, for

each gas cycle. (MRB, k m3, k m3, k m3, k cc).
Default: NONE.
DTWATER Maximum time taken for each water cycle. (days, days, days, days,
hours).
Default: NONE.
DTGAS Maximum time taken for each gas cycle (days, days, days, days,
hours).
Default: NONE.
ENDWAG Keyword indicating the end of water-alternating-gas table data
Notes:
1. All columns must have either a number greater than or equal to zero, or the keyword NONE.
NONE specifies that there is no limit for this quantity.
2. A wag cycle terminates when the first limit is exceeded. If all limits are specified as NONE,
458 Surface Network: Water-Alternating-Gas (WAG) Wells R5000.0.1

then the cycle will not terminate.
Example:
WAG
WELL WSCUM GSCUM
I1 300 300
ENDWAG
R5000.0.1 Surface Network: Water-Alternating-Gas (WAG) Wells 459

Connection Shut In Parameters (CONPARAM)
The parameters controlling when connections are shut in are specified as follows.
CONPARAM
CON (WCUT_SHUT) (WOR_SHUT) (GOR_SHUT) (GLR_SHUT)(WGR_SHUT)
conname (wcut_shut) (wor_shut) (gor_shut) (glr_shut) (wgr_shut)
. . . . . .
. . . . . .
. . . . . .
ENDCONPARAM
Additional Columns
(WCUT_CB_MAX)(GOR_CB_MAX) (GLR_CB_MAX)(WGR_CB_MAX)(GBP_CB_MAX)
(wcut_cb_max)(gor_cb_max) (glr_cb_max) (wgr_cb_max )(gbp_cb_max)
(WCUT_CB_MIN)(GOR_CB_MIN) (GLR_CB_MIN) (WGR_CB_MIN (GBP_CB_MIN)
(wcut_cb_min)(gor_cb_min )(glr_cb_min) (wgr_cb_min)(gbp_cb_min)
. . . . . .
. . . . . .
where:
CONPARAM Keyword indicating the start of the CONPARAM table.
WCUT_SHUT Column heading keyword indicating that the entries in this location
on the following lines specify the water cut, above which the
connection is shut in if the WCUT_SHUT procedure is invoked.
(Fraction).
Default: No Limit.
WOR_SHUT Column heading keyword indicating that the entries in this location
on the following lines specify the water/oil ratio, above which the
connection is shut in if the WOR_SHUT procedure is invoked.
(STB/STB, m3/m3, m3/m3, m3/m3, cc/cc)
Default: No Limit.
GOR_SHUT Column heading keyword indicating that the entries in this location
on the following lines specify the gas/oil ratio, above which the
connection is shut in if the GOR_SHUT procedure is invoked.
(MSCF/STB, m3/m3, m3/m3, m3/m3, cc/cc)
Default: No Limit.
GLR_SHUT Column heading keyword indicating that the entries in this location
on the following lines specify the gas/liquid ratio, above which the
connection is shut in if the GLR_SHUT procedure is invoked.
460 Surface Network: Connection Shut In Parameters (CONPARAM) R5000.0.1


Default: No Limit.
WCUT_CB_MAX Column heading keyword indicating that the entries in this location
on the following lines specify a water cut upper limit, used by the
procedure WCUTBACK to invoke a production rate cutback.
(Fraction).
Default: No Limit.
GOR_CB_MAX Column heading keyword indicating that the entries in this location
on the following lines specify a gas/oil ratio upper limit, used by the
procedure WCUTBACK to invoke a production rate cutback.
Default: No Limit.
GLR_CB_MAX Column heading keyword indicating that the entries in this location
on the following lines specify a gas/liquid ratio upper limit, used by
the procedure WCUTBACK to invoke a production rate cutback.
Default: No Limit.
WGR_CB_MAX Column heading keyword indicating that the entries in this location
on the following lines specify a water/gas ratio upper limit, used by
the procedure WCUTBACK to invoke a production rate cutback.
(STB/MSCF, m3/m3, m3/m3, m3/m3, cc/cc)
Default: No Limit.
GBP_CB_MAX Column heading keyword indicating that the entries in this location
on the following lines specify a grid block pressure limit, used by
the procedure WCUTBACK to reverse a cutback process applied
on wells. This value sets an upper limit for production wells, and a
lower limit for injection wells. (psi, kPa, Kg/cm2, bars, psi)
Default: No Limit.
WCUT_CB_MIN Column heading keyword indicating that the entries in this location
on the following lines specify a water cut lower limit, used by the
procedure WCUTBACK to reverse the cutback process applied on
a production rate. (Fraction).
Default: No Limit.
GOR_CB_MIN Column heading keyword indicating that the entries in this location
on the following lines specify a gas/oil ratio lower limit, used by the
procedure WCUTBACK to reverse the cutback process applied on
a production rate. (MSCF/STB, m3/m3, m3/m3, m3/m3, cc/cc)
Default: No Limit.
R5000.0.1 Surface Network: Connection Shut In Parameters (CONPARAM) 461

GLR_CB_MIN Column heading keyword indicating that the entries in this location
on the following lines specify a gas/liquid ratio lower limit, used by
the procedure WCUTBACK to reverse the cutback process applied
on a production rate. (MSCF/STB, m3/m3, m3/m3, m3/m3, cc/cc)
Default: No Limit.
WGR_SHUT Column heading keyword indicating that the entries in this location
on the following lines specify the water/gas ratio, above which the
connection is shut in if the WGR_SHUT procedure is invoked.
Default: No Limit
ENDCONPARAM Alpha label indicating the end of the CONPARAM data.
Note:
1. The shut in logic is not used unless the corresponding procedure (WCUT_SHUT,
WOR_SHUT, GOR_SHUT, GLR_SHUT or WGR_SHUT) is specified in the PROCS input.
See the Procedures section.
2. The WCUT_CB_MAX, GOR_CB_MAX, GLR_CB_MAX, WGR_CB_MAX,

GBP_CB_MAX, WCUT_CB_MIN, GOR_CB_MIN, GLR_CB_MIN, WGR_CB_MIN and
GBP_CB_MIN are not invoked unless the procedure WCUTBACK is specified in the
PROCS input. (See the Procedures section.)
Example
This example sets both gas-oil ratio upper and lower limits on a production well Prod1. The well’s
liquid producing rate will be reduced 10 percent (a cutback factor of 0.9) when its gas-oil ratio
exceeds 3.0. And, the rate will be increased by dividing it by a factor of 0.9 when its gas-oil ratio
falls bellow 2.0 – a cutback reversal process. For another producing well Well2, meanwhile, this
example sets a water cut upper limit of 0.6, and a grid block pressure lower limit at 3,000 psia.
When the well’s water cut exceeds 0.6, or a perforated grid block pressure falls below 3,000 psia,
its oil producing rate will be reduced 20 percent.
CONPARAM
CON WCUT_CB_MAX GOR_CB_MAX GBP_CB_MIN GOR_CB_MIN
Prod1 NA 3.0 NA 2.0
Well2 0.6 NA 3000 NA
ENDCONPARAM
PROCS
WCUTBACK(“LIQ”,Prod1,0.9)
WCUTBACK(“OIL”,Well1,0.8)
ENDPROCS
462 Surface Network: Connection Shut In Parameters (CONPARAM) R5000.0.1

Valve Procedure Parameters (CONPARAM)
The parameters controlling smart wells through the procedures WELL_VALVE and
SET_VALVE_SETTING are specified as follows.
CONPARAM
CON (WCUT_VALVE) (WOR_VALVE) (GOR_VALVE) (WGR_VALVE) (QO_VALVE) (QG_VALVE) (QW_VALVE)
conname (wcut_valve) (wor_valve) (gor_valve) (wgr_valve) (qo_valve) (qg_valve) (qw_valve)
. . . . . . . .
ENDCONPARAM
where:
CONPARAM Keyword indicating the start of the CONPARAM table.
WCUT_VALVE Column heading keyword indicating that the entries in this location
on the following lines specify a water cut, used by the procedures
WELL_VALVE and SET_VALVE_SETTING to control smart
wells. (Fraction).
Default: No Limit
WOR_VALVE Column heading keyword indicating that the entries in this location
on the following lines specify a water/oil ratio, used by the
procedures WELL_VALVE and SET_VALVE_SETTING to
control smart wells. (STB/STB, m3/m3, m3/m3, m3/m3, cc/cc).
Default: No Limit
GOR_VALVE Column heading keyword indicating that the entries in this location
on the following lines specify a gas/oil ratio, used by the procedures
wells. (MSCF/STB, m3/m3, m3/m3, m3/m3, cc/cc)
Default: No Limit
WGR_VALVE Column heading keyword indicating that the entries in this location
on the following lines specify a water/gas ratio, used by the
procedures WELL_VALVE and SET_VALVE_SETTING to
control smart wells. (STB/MSCF, m3/m3, m3/m3, m3/m3, cc/cc)
Default: No Limit
QO_VALVE Column heading keyword indicating that the entries in this location
on the following lines specify an oil rate, used by the procedures
R5000.0.1 Surface Network: Valve Procedure Parameters (CONPARAM) 463

wells. (STB/D, m3/D, m3/D, m3/D, cc/Hour)

Default: No Limit
QG_VALVE Column heading keyword indicating that the entries in this location
on the following lines specify a gas rate, used by the procedures
wells. (MSCF/D, m3/D, m3/D, m3/D, cc/Hour)
Default: No Limit
QW_VALVE Column heading keyword indicating that the entries in this location
on the following lines specify a water rate, used by the procedures
wells. (STB/D, m3/D, m3/D, m3/D, cc/Hour)
Default: No Limit
ENDCONPARAM Alpha label indicating the end of the CONPARAM data.
Note:
1. WOR_VALVE, GOR_VALVE, WGR_VALVE, QO_VALVE, QG_VALVE and

QW_VALVE, are triggers used by the procedures WELL_VALVE, and
SET_VALVE_SETTING, and are not invoked unless one or both of these procedures are
specified in the PROCS input. (See the Procedures section.) The procedures open, close or
adjust the valve setting for the connection or well if the trigger is exceeded.
Example 1
Well P-1 will have trigger setting of GOR=900 and WCUT = 0.90. If either setting is exceeded
the well will close off the worst offending valve connection. Well P-2 will trigger settings of QW
= 500 STBD and QG = 1000 MSCFD. If either setting is violated the worst offending valve will
be adjusted. The input data would be:
CONPARAM
CON WCUT_VALVE GOR_VALVE QW_VALVE QG_VALVE
P-1 0.90 900.0 NA NA
P-2 NA NA 500.0 1000.0
ENDCONPARAM
WELLLIST WELLS1
add
P-1
ENDWELLLIST
WELLLIST WELLS2
add
P-2
ENDWELLLIST
464 Surface Network: Valve Procedure Parameters (CONPARAM) R5000.0.1

PROCS
WELL_VALVE(“CLOSE”,wells1)
WELL_VALVE(“ADJUST”,wells2,’-1)
ENDPROCS
Example 2
Well P-1 has 3 downhole valves named P-1_A1, P-1_A2, and P-1_A3. The well has limits of
WCUT=0.90 and GOR = 900.0. Each valve is to be given a limit of WCUT=0.95 and GOR =
1500.0 If the well level trigger is reached the well will close of the worst offending valve. If a
valve level trigger is reached, the offending valve setting will be decreased by 1.
CONPARAM
CON WCUT_VALVE GOR_VALVE
P-1 0.90 900.
P-1_A1 0.95 1500
P-1_A2 0.95 1500
P-1_A3 0.95 1500
ENDCONPARAM
WELLLIST WELLS1
add
P-1
ENDWELLLIST
CONLIST VALVES1
add
P-1_A1
P-1_A2
P-1_A3
ENDCONLIST
PROCS
WELL_VALVE(“CLOSE”,wells1)
SET_VALVE_SETTING(“ADJUST”,valves1,-1)
ENDPROCS
R5000.0.1 Surface Network: Valve Procedure Parameters (CONPARAM) 465

Reopening Shut-in Connections and Restarting Shut Off

Pumps (TEST)
Connections which have been shut in can be tested for reopening as follows:
TEST (RESERVOIR resv_name) HYDSTAB FREQ freq

BACKFLOW DT dt
QMIN DP dp
LIMIT DATA
ALL NOTDATA
TARG t1 t2 … OFF
PROC p1 p2 … NEXT nxt
PUMP MAXOPEN maxopen
COMPRESSOR NOW
where:
TEST Introduces connection test data.
RESERVOIR Introduces a reservoir name, or one of the keywords MASTER or

ALL. This is only valid in the master network file of a multifield
run, and sets the reservoir to which the following test data will
apply. The keyword MASTER indicates that the test data will
apply to connection in the master network file only, and ALL
indicates that the test data will apply to all connections.
HYDSTAB Specifies that connections which have been shut in due to flow in
the unstable region of the hydraulics tables, or due to no
intersection between the inflow and the hydraulics table, will be
tested for ability to flow.
BACKFLOW Specifies that connections which have been shut in due to zero
backflow constraints or pressure will be tested for ability to flow.
QMIN Specifies that connections which have been shut in due to minimum
rate constraints will be tested for ability to flow.
LIMIT Specifies that well connections which have been shut in due to well
limits (e.g. WCUTMAX) will be tested for ability to flow.
TARG Specifies that connections which have been shut in by targeting (see
Production and Injection Targets) will be tested for the ability to
flow. This keyword is followed by a list of target names or the
keyword ALL for all targets.
466 Surface Network: Reopening Shut-in Connections and Restarting Shut Off Pumps (TEST)
PROC Specifies that connections which have been shut in by the

CONSTRAINT procedure with a SHUTIN argument (see
Procedures) will be tested for the ability to flow. This keyword is
followed by a list of integers, which correspond to the shut in flag
argument of the CONSTRAINT procedure.
PUMP Specifies that all pumps in the surface network will be checked at
the specified frequency or time, and those that have been shut off
will be turned back on. A pump is shut off when the calculated
operating point defined by the rate and head lies outside of the
performance data for the pump. Note that specification of power in
excess of the limit implied by the performance data does not lead to
a pump being shut off; in such cases, the pump will be operated at
the maximum possible power level for the flow conditions, which
may be lower than the input power level.
COMPRESSOR Specifies that all compressors in the surface network will be

checked at the specified frequency or time, and those that have been
shut off will be turned back on. A compressor is shut off when
either the gas flow rate at the in-situ conditions falls below the
minimum surge rate (that occurs at the lowest operating speed) for
the compressor or when the input power level is lower than the
power required at the lowest operating speed and the prevailing gas
volumetric flow rate at the in-situ conditions.
ALL Specifies that connections which have been shut in for hydraulics
instability, backflow, qmin, or limit will be tested for ability to flow,
and pumps and compressors which have been shut off will turned
back on.
FREQ Specifies the number of time steps between tests.
DT Specifies the time interval between tests (days, days, days, days,
hours).
DATA Specifies that the test will be applied when constraints or the
network is changed. This is the default.
NOTDATA Specifies that the test will not be applied when constraints or the
network is changed, unless the time corresponds to a specified
frequency or dt.
OFF Specifies that connections which have been shut in for the reason
given by the preceding keyword will not be tested for reopening.
NEXT Specifies the number of connections shut in due to hydraulics

stability, or backflow during a timestep, which will trigger a test for
R5000.0.1Surface Network: Reopening Shut-in Connections and Restarting Shut Off Pumps (TEST) 467
reopening shut in wells. I.e. if this number of connections are shut

in during a time step, then a test will be performed on the next time
step.
Default: Inactive
NOW Specifies that a test will be performed at the start of the next time
step.
Default: Inactive
MAXOPEN Specifies that the test will not be applied if a connection has been
previously reopened maxopen times. I.e. it limits the number of
times a connection can be reopened.
Default: No limit
DP For wells which have a bottom hole pressure constraint, and which
were shut in for backflow or hydraulics, this specifies that an
attempt will be made to reopen a well if the average pressure of the
perforated grid blocks for the well increases (decreases for an
injector) by more than dp. (psi, kPa, Kg/cm2, bars, psi). This only
applies to HYDSTAB and BACKFLOW tests.
Default: 1 psi for BACKFLOW and 10 psi for HYDSTAB
Notes:
1. Time step sizes are not adjusted to honor any specified time intervals.
2. All connections shut in for the same reason are tested at the same time, without regard to
when each well was shut in.
3. The default is to perform all tests whenever the surface network input data is changed, and to
test wells shut in for backflow or hydraulics if the average pressure of the perforated grid
blocks increases (decreases for injectors) by more than 1 psi for wells shut in for backflow, or
10 psi for wells shut in for hydraulics.
Examples:
1. Test wells shut in for hydraulics instability every 5 time steps, and wells shut in due to being
unable to make the minimum rate constraint every 15 days and every 10 time steps. Also test
pumps shut off for operating outside the performance data range every 5 time steps.
TEST HYDSTAB FREQ 5 MAXOPEN 10

QMIN DT 15.0
FREQ 10
2. Test wells shut in for by any target every 50 time steps, wells shut in by target targ1 or targ2
468 Surface Network: Reopening Shut-in Connections and Restarting Shut Off Pumps (TEST)
every 100 days (in addition to every 50 time steps), and wells shut in by procedures with
flags 1, 4 or 2 every 200 days.
TEST TARG ALL FREQ 50

TARG targ1 targ2 DT 100.0
PROC 1 4 2 DT 200.0
R5000.0.1Surface Network: Reopening Shut-in Connections and Restarting Shut Off Pumps (TEST) 469
Wells Included in RFT Report (RFTWELLS)
Wells to include in the RFT report are specified as follows:
RFTWELLS welllist
where:
RFTWELLS Introduces the well list which contains the wells to be included in
the RFT report.
Welllist The name of a well list. The well list must have been previously
defined in a WELLLIST table.
Example:
! define a well list containing all wells whose names start with P
WELLLIST rftwelllist
ADD
P*
ENDWELLLIST
RFTWELLS rftwelllist
470 Surface Network: Wells Included in RFT Report (RFTWELLS) R5000.0.1

Include Files (INCLUDE)
One level of include files are permitted in the SURFACE file. These are specified as follows:
INCLUDE filename
where:
Examples:
INCLUDE include_surface.dat
R5000.0.1 Surface Network: Include Files (INCLUDE) 471

Skipping Data for Multifield Runs (SKIP)
Sections of data can be skipped if they are not relevant to a multi-field (or a single field) run.
SKIP MULTIFIELD or SINGLEFIELD

ENDSKIP
where:
SKIP Specifies the start of the section of data which will be skipped.
MULTIFIELD Specifies that the following data (up to the ENDSKIP keyword),
will be ignored if this is a multifield run.
SINGLEFIELD Specifies that the following data (up to the ENDSKIP keyword),
will be ignored if this is a single field run.
ENDSKIP Specifies the end of the section of data which will be skipped.
Notes:
Multi-field runs can be assembled from multiple single field runs, as described in the Multiple
Reservoir Case File section.
Examples:
SKIP MULTIFIELD ! skip the following target input if this is a multifield run
TARGET
NAME CTRL CTRLCOND CTRLCONS CTRLMETHOD CALCMETHOD CALCCOND CALCCONS VALUE
Ptarg1 QO SURFACE ds1_prod_wells SCALE VALUE NA NA 10000.0
Ptarg2 QW SURFACE ds1_prod_wells SHUTWCUT VALUE NA NA 20000.0
Itarg1 QW NA ds1_inj_wells GUIDERATE NETVOID NA drillsite1 1.0
Itarg2 QW NA ds2_inj_wells SCALE INJTGTP NA drillsite2 3550.0
Itarg3 QG SURFACE ds3_inj_wells SCALE QG SURFACE ds3_prod_wells 2.0
ENDTARGET
ENDSKIP
472 Surface Network: Skipping Data for Multifield Runs (SKIP) R5000.0.1
Time Data (TIME)
Time data is specified as follows:
TIME time
or
TIME date
where:
time The time in days when the following surface network data will be
applied. (day, day, day, day, hour)
date The date when the following surface network data will be applied.
The date can be specified in the format mm/dd/yyyy or mm/dd/
Examples:
TIME 100.0
TIME 1/1/2000
TIME 10/04/2000(08:00:00)
R5000.0.1 Surface Network: Time Data (TIME) 473

Examples of Surface Network Files
Example 1. Wells on bottomhole control only
BLACKOIL
WELLS
NAME STREAM BHDEPTH
P-1 PRODUCER 5000.0
ENDWELLS
CONSTRAINTS
P-1 PMIN 100.0 QOSMAX 999999.
ENDCONSTRAINTS
TIME 1000.0
WELLS
NAME STREAM BHDEPTH
I-1 WATER 5000.0
ENDWELLS
CONSTRAINTS
I-1 PMAX 2000.0 QWSMAX 999999.
ENDCONSTRAINTS
TIME 2800.0
474 Surface Network: Examples of Surface Network Files R5000.0.1

Example 2. Dual lateral well, and smart horizontal well
Well File
WELLSPEC P-1
CELL KH RADW RADB X Y DEPTH FLOWSECT PARENT MD MDCON
64 500.0 3.5 117.9 1100 1005 5050 1 NA 5150 NA ! Lateral 1
63 500.0 3.5 117.9 1300 1010 5055 1 NA 5250 NA
62 500.0 3.5 117.9 1500 1011 5047 1 NA 5350 NA
61 500.0 3.5 117.9 1700 1003 5051 1 NA 5450 NA
128 500.0 3.5 117.9 1100 1012 5152 2 1 5250 4951 ! Lateral 2
127 500.0 3.5 117.9 1300 1008 5156 2 NA 5350 NA
126 500.0 3.5 117.9 1500 1007 5151 2 NA 5450 NA
125 500.0 3.5 117.9 1700 1008 5148 2 NA 5550 NA
WELLSPEC P-2
CELL KH RADW RADB X Y DEPTH MD
1 500.0 3.5 117.9 3000 1000 5050 5100
2 500.0 3.5 117.9 3200 1000 5050 5200
3 500.0 3.5 117.9 3400 1000 5050 5300
4 500.0 3.5 117.9 3600 1000 5050 5400
Network File
BLACKOIL
WELLS
NAME STREAM TYPE METHOD X Y BHDEPTH BHMD DIAM ROUGHNESS ADDTUBING
ENDWELLS
! The default connections for well P-2 are

!
! |
! x MD 4950 ft
! |\
! | \
! MD 5100 ft x x <- Perf 1
! | |
! MD 5200 ft x x <- Perf 2
! | |
! MD 5300 ft x x <- Perf 3
! | |
! MD 5400 ft x x <- Perf 4
!
R5000.0.1 Surface Network: Examples of Surface Network Files 475

WELLHEAD
WELL NAME DEPTH LENGTH DIAM INNERDIAM ROUGHNESS TYPE METHOD
P-1 TH-P-1 0.0 5000.0 6.0 0.0 0.0005 Pipe HAGEDORN
P-2 TH-P-2 0.0 5000.0 6.0 0.0 0.0005 Pipe HAGEDORN
ENDWELLHEAD
WELLBORE
WELL FLOWSECT TYPE METHOD DIAM INNERDIAM ROUGHNESS
P-1 1 PIPE HAGEDORN 8.0 0.0 0.0005 ! diameter of cased hole
P-1 2 PIPE HAGEDORN 8.0 0.0 0.0005 ! diameter of cased hole
P-2 1 PIPE HAGEDORN 8.0 4.0 0.0005 ! diameter of cased
! hole, inner diam =
! outer diam of tubing
P-2 2 PIPE HAGEDORN 3.5 0.0 0.0005 ! diameter of tubing
ENDWELLBORE
!
! For Well P-2
!
! Packer1 is at the top of layer 1
! Packer2 is at the top of layer 2
! #’s are node locations
!
! Nodes
!
! | |1| | Bottomhole node
! | | | |
! | | | |
! |xxx| |xxx| Packer 1
! | |2 3 |
! | | | |
! | | | 4 | Perf 1
! | | | |
! | | | |
! | | | 5 | Perf 2
! | | | |
! | | | |
! |xxx| |xxx| Packer 2
! | |6 9 |
! | | | |
! | |7| 10| Perf 3
! | | | |
! | | | |
! | |8| 11| Perf 4
! | |
! | |
!

WELLNODE
!
! The following reconnects well P-1 with a valve controlling each lateral
!
P-1-T1 P-1 4951 1 YES
P-1-L1 P-1 4951.01 1 NO
P-1-L2 P-1 4951.01 2 NO
!
! The following reconnects well P-2 as a smart well
!
P-2-T1 P-2 5050 2 YES ! Node 2 in the diagram above.
P-2-A1 P-2 5050 1 NO ! Node 8 in the diagram above.
P-2-T3 P-2 5250 2 YES ! Node 5 in the diagram above.
P-2-A3 P-2 5250 1 NO ! Node 11 in the diagram above.
ENDWELLNODE
NODECON
NAME NODEIN NODEOUT TYPE METHOD
P-1-VALVE1 P-1-L1 P-1-T1 VALVE 1 ! valve connecting lateral 1 to tubing
P-1-VALVE2 P-1-L2 P-1-T1 VALVE 1 ! valve connecting lateral 2 to tubing
P-2-VALVE1 P-2-A1 P-2-T1 VALVE 1 ! valve connecting annulus to tubing
P-2-VALVE2 P-2-A3 P-2-T3 VALVE 1 ! valve connecting cased hole to tubing
ENDNODECON
!
! The following is a minimal gathering network
!
NODECON
NAME NODEIN NODEOUT TYPE METHOD DIAM ROUGHNESS
TH-P-1 TH-P-1 GATHER PIPE HAGEDORN 10.0 0.0005
TH-P-2 TH-P-2 GATHER PIPE HAGEDORN 10.0 0.0005
GATHER GATHER TERM PIPE HAGEDORN 10.0 0.0005
SINK TERM SINK NA NA NA NA
ENDNODECON
CONSTRAINTS
TERM PMIN 100.0
P-1 QOSMAX 999999.
P-2 QOSMAX 999999.
P-1-VALVE1 QWSMAX 1000.0 ! could specify a setting for the valve e.g SETTING 4
P-1-VALVE2 QWSMAX 1000.0
P-2-VALVE1 QGSMAX 1000.0
P-2-VALVE2 QGSMAX 1000.0
ENDCONSTRAINTS
TIME 1000.0

Example 3. Small production and injection network
BLACKOIL
WELLS
NAME STREAM BHDEPTH
P-1 PRODUCER 5000.0
P-2 PRODUCER 5000.0
P-3 PRODUCER 5000.0
P-4 PRODUCER 5000.0
P-5 PRODUCER 5000.0
I-1 WATER 5000.0
I-2 WATER 5000.0
I-3 WATER 5000.0
I-4 WATER 5000.0
ENDWELLS
WELLHEAD
NAME WELL METHOD
TH-P-1 P-1 1
TH-P-2 P-2 1
TH-P-3 P-3 1
TH-P-4 P-4 1
TH-P-5 P-5 1
TH-I-1 I-1 2
TH-I-2 I-2 2
TH-I-3 I-3 2
TH-I-4 I-4 2
ENDWELLHEAD
NODES
NAME DEPTH
GATHP 0.0
TERMP 0.0
GATHI 0.0
TERMI 0.0
ENDNODES
NODECON
NAME NODEIN NODEOUT

th-P-1 th-P-1 GATHP

th-P-2 th-P-2 GATHP
th-P-3 th-P-3 GATHP
th-P-4 th-P-4 GATHP
th-P-5 th-P-5 GATHP
GATHP GATHP TERMP
SINK TERMP SINK
SOURCE WATER TERMI
GATHI TERMI GATHI
th-I-1 GATHI th-I-1
th-I-2 GATHI th-I-2
th-I-3 GATHI th-I-3
th-I-4 GATHI th-I-4
ENDNODECON
CONSTRAINTS
TERMP PMIN 100.0 ! QOSMAX 999999.0
p* THP 200.0
TERMI PMAX 6650.0 ! QWSMAX 999999.0
ENDCONSTRAINTS
TIME 2800.0

Example 4. Well tubing using pressure drop correlation
BLACKOIL
WELLS
NAME STREAM BHDEPTH
P-1 PRODUCER 5000.0
ENDWELLS
WELLHEAD
WELL NAME DEPTH LENGTH DIAM INNERDIAM ROUGHNESS TYPE METHOD
P-1 THP_P-1 0.0 5000.0 6.0 0.0 0.00072 Pipe NoSlip
ENDWELLHEAD
CONSTRAINTS
THP_P-1 PMIN 200.0
P-1 QOSMAX 10000.0
ENDCONSTRAINTS
TIME 1000.0
WELLS
NAME STREAM BHDEPTH
I-1 WATER 5000.0
ENDWELLS
CONSTRAINTS
I-1 PMAX 4500.0 QWSMAX 10000.
ENDCONSTRAINTS
TIME 2800.0

Procedures
In This Chapter
• Introduction
• Procedure array constants
• Procedure data input
• Variable declaration and initialization
• Operators
• IF statements
• DO loops
• Predefined variables
• Functions and the use of masks
• Description of functions
• Examples
Procedures are specified as part of the Surface Network file.
R5000.0.1 Procedures: In This Chapter 481

Introduction
Procedures are a set of instructions which direct the Nexus® software to perform various (user
specified) actions depending on whether various (user specified) conditions have been satisfied.
A FORTRAN-like syntax is used, allowing a great deal of flexibility in specifying constraints and
actions. The procedures are input as part of the surface network file. All the procedure data is
enclosed between the PROCS and ENDPROCS keywords, except for array constants.
Array constants are arrays of either real, integer or logical constants. The arrays are either 1 or 2
dimensional. 2 dimensional arrays are actually an array of 1D arrays which have varying size in
the first dimension. For example, a 2D array of skin values could be used by an action to set the
skin for each layer in a list of wells. The second dimension of the array would be the number of
wells in the list, and the first dimension would be the number of completions in each well (which
varies by well).
Procedures are always executed on the first Newton of each time step. If connections have
opened (started producing or injecting) during the first Newton, the procedures will also be exe-
cuted on the second Newton.
482 Procedures: Introduction R5000.0.1

Procedure Array Constants
Procedure constants are store data that can be used by procedure instructions and/or functions e.g.
An INT_2D could be used to store alternative hydraulics table assignments for each connection in
a connection list. The values stored in procedure constants can not be modified by the proce-
dures, and operations which would result in modifications to a procedure constant will be flagged
as an error. Procedure constants are input outside of the PROCS … ENDPROCS keyword pair.
They are specified as follows:
INT_1D name
i(1) i(2) i(3) ...
....
ENDINT_1D
INT_2D name
i(1,1) i(2,1) ...
i(1,2) i(2,2) ...
....
ENDINT_2D
REAL_1D name
r(1) r(2) r(3) ...
....
ENDREAL_1D
REAL_2D name
r(1,1) r(2,1) ...
r(1,2) r(2,2) ...
....
ENDREAL_2D
LOGICAL_1D name
l(1) l(2) l(3) ...
....
ENDLOGICAL_1D
LOGICAL_2D name
l(1,1) l(2,1) ...
l(1,2) l(2,2) ...
....
ENDLOGICAL_2D
where:
INT_1D Introduces a 1D integer array. The entries can be input on as many

lines as required.
ENDINT_1D Specifies the end of the 1D integer array data.
R5000.0.1 Procedures: Procedure Array Constants 483

INT_2D Introduces a 2D integer array. Each new line of input increments

the second dimension. The number of entries in the first dimension
can vary. Lines can be continued using the & character.
ENDINT_2D Specifies the end of the 2D integer array data.
REAL_1D Introduces a 1D real array. The entries can be input on as many

lines as required.
ENDREAL_1D Specifies the end of the 1D real array data.
REAL_2D Introduces a 2D real array. Each new line of input increments the
second dimension. The number of entries in the first dimension can
vary. Lines can be continued using the & character.
ENDREAL_2D Specifies the end of the 2D real array data.
LOGICAL_1D Introduces a 1D logical array. The entries can be input on as many

lines as required. Logical constants are either TRUE, T, FALSE or
F.
ENDLOGICAL_1D Specifies the end of the 1D logical array data.
LOGICAL_2D Introduces a 2D logical array. Each new line of input increments

the second dimension. The number of entries in the first dimension
can vary. Lines can be continued using the & character. Logical
constants are either TRUE, T, FALSE or F.
ENDLOGICAL_2D Specifies the end of the 2D logical array data.
name The name of the variable
Example:
INT_2D i2d
1 2
5 6 9
11 13
ENDINT_2D
484 Procedures: Procedure Array Constants R5000.0.1

Procedure Data Input
Procedure data input is specified as follows:
PROCS (NAME proc_name) (CLEAR) (PRIORITY priority)

ENDPROCS
where:
PROCS Introduces data for a set of procedures.
NAME Introduces a name which can be used to identify a procedure.
CLEAR Specifies that previous procedures that have been input will be
ignored. If a name has been input prior to the keyword CLEAR,
then only the named procedure will be cleared, otherwise all
procedures previously input in the network file will be cleared. In a
multifield run, this applies only to the procedures input in this
network file, and not to procedures input for other reservoirs.
PRIORITY Specifies the priority for this procedure. Procedures are executed in
the order specified by their priority, with a priority value of 1
meaning highest priority. Procedures with the same value of
priority are executed in the order in which they were input.
Default: 1
ENDPROCS Specifies the end of the procedure data.
Notes:
1. All procedure data except array constants, must be contained between a PROCS, END-
PROCS keyword pair.
Example:
PROCS
....
ENDPROCS
R5000.0.1 Procedures: Procedure Data Input 485

Variable Declaration and Initialization
Procedure variables are declared as follows:
INTEGER (, STATIC) i
REAL (, STATIC) r
LOGICAL (, STATIC) l
INT_1D (, STATIC) i1d or INT_1D(n) (, STATIC) i1d
REAL_1D (, STATIC) r1d or REAL_1D(n) (, STATIC) r1d
LOGICAL_1D (, STATIC) l1d or LOGICAL_1D(n) (, STATIC) l1d
INT_2D (, STATIC) i2d or INT_2D(m,n) (, STATIC) i2d
or INT_2D(:,n) (, STATIC) i2d
REAL_2D (, STATIC) r2d or REAL_2D(m,n) (, STATIC) r2d
or REAL_2D(:,n) (, STATIC) r2d
LOGICAL_2D (, STATIC) l2d or LOGICAL_2D(m,n) (, STATIC) l2d
or LOGICAL_2D(:,n) (, STATIC) l2d
NODE (, STATIC) node
CONNECTION (, STATIC) con
WELL (, STATIC) well
TARGET (, STATIC) tgt
CONLIST (, STATIC) conlist
NODELIST (, STATIC) nodelist
WELLLIST (, STATIC) welllist
CONLIST_2D (, STATIC) conlist_2d
where:
INTEGER Introduces an integer variable.
REAL Introduces a real variable.
LOGICAL Introduces a logical variable.
INT_1D Introduces a 1D integer array. Optionally, the dimension of the

array can be specified by enclosing it in parentheses.
REAL_1D Introduces a 1D real array. Optionally, the dimension of the array

can be specified by enclosing it in parentheses.
LOGICAL_1D Introduces a 1D logical array. Optionally, the dimension of the

array can be specified by enclosing it in parentheses.
INT_2D Introduces a 2D integer array. Optionally, the dimensions of the

array can be specified by enclosing them in parentheses, separated
by a comma. The first dimension may be specified with a colon to
indicate that it is variable.
486 Procedures: Variable Declaration and Initialization R5000.0.1

REAL_2D Introduces a 2D real array. Optionally, the dimensions of the array

can be specified by enclosing them in parentheses, separated by a
comma. The first dimension may be specified with a colon to
LOGICAL_2D Introduces a 2D logical array. Optionally, the dimensions of the

array can be specified by enclosing them in parentheses, separated
by a comma. The first dimension may be specified with a colon to
NODE Introduces a node variable.
CONNECTION Introduces a connection variable.
WELL Introduces a well variable.
TARGET Introduces a target variable.
CONLIST Introduces a connection list variable.
NODELIST Introduces a node list variable.
WELLLIST Introduces a well list variable.
CONLIST_2D Introduces a conlist_2d variable.
STATIC Specifies that the variable is shared, and can be used by all
procedures, including procedures in other network files in a
multifield run. If a variable is not declared as STATIC, then it is
only available for the instructions enclosed between the current
PROCS … ENDPROCS keywords. Variables declared as STATIC
persist, even after all prior procedures have been cleared.
Notes:
1. Variable names must begin with an alpha character. The names of all variables must be
unique, and can not be the same as a node, connection, well or constant array.
2. Numeric and logical variables can be initialized to a constant value by following the variable
name with the equals operator (=) and a number (or TRUE/FALSE). E.g. INTEGER I1 = 3
3. Arrays can only be initialized if their dimensions are specified (a colon can not be used). The
initial values are set the first time step that the procedures are executed.
4. Multiple variable names can be specified on line by using a comma as a separator. e.g.
INTEGER I1, I2
5. There are several default connection and node lists. (PRODBHCONS, PRODWHCONS,
R5000.0.1 Procedures: Variable Declaration and Initialization 487

INJBHCONS, INJWHCONS, PRODBHNODES, PRODWHNODES, INJBHNODES,

INJWHNODES – see Well, Connection and Node Lists in the SURFACE section).
6. Variables declared as STATIC are available for all subsequent procedures. This provides a
mechanism for sharing information between procedures.
7. In a multifield run, the procedures are executed in the order in which the reservoirs were
named in the master .fcs file, for each time period. The procedures in the master network file
are executed last.
Example:
INTEGER I1 = 1, I2
REAL_2D real2d_array
LOGICAL_1D(5) log_size5 = TRUE
488 Procedures: Variable Declaration and Initialization R5000.0.1

Operators
The following operators are available:
>
<
>=
<=
==
/=
=
+
-
/
*
OR
AND
NOT
where:
> Greater than operator.
< Less than operator.
>= Greater than or equal to operator.
<= Less than or equal to operator.
== Logical equal to operator.
/= Logical not equal to operator.
= Equals (assignment) operator.
+ Addition operator.
- Subtraction operator, or unary change sign operator.
/ Division operator. To avoid a run time floating point exception, a

divide by zero will produce the result 999999999.
* Multiplication operator.
OR Logical OR operator.
R5000.0.1 Procedures: Operators 489

AND Logical AND operator.
NOT Unary NOT operator.
Notes:
1. Operators must be separated from other input by a space.
2. If an integer variable is equated to a real, the real will be rounded down.
Example:
k = i + 1
l = a < b ! l is a logical variable, a and b are numeric variables
490 Procedures: Operators R5000.0.1

IF statements
IF (conditional) statements are specified as follows:
IF( condition1 )THEN

ELSEIF( condition2 ) THEN
ELSE
ENDIF
where:
IF Specifies the start of an IF statement.
THEN Specifies the start of the statements to be executed if the condition

is true.
ELSEIF Specifies a condition to evaluate if the previous condition is false.
ELSE Specifies the start of the statements to be executed if all previous

conditions are false.
ENDIF Specifies the end of the IF statement.
Notes:
1. IF statements can be nested.
2. ELSEIF and ELSE are optional.
3. The condition specified for the IF or ELSEIF must evaluate to TRUE or FALSE.
Example:
IF( a < b) THEN

a = b
IF( b == 0 )THEN
b = a + 1
ENDIF
ELSEIF( b > a + 1) THEN
b = a + 1
ENDIF
R5000.0.1 Procedures: IF statements 491

DO Loops
DO loops are specified as follows:
DO n or loopname: DO n or DO i = i1, i2 or loopname: DO i = i1, i2

ENDDO or ENDDO loopname
EXIT or EXIT loopname
CYCLE or CYCLE loopname
where:
DO Specifies the start of a DO statement. This must be followed by an

integer number (which specifies the maximum number of times the
loop will be executed) or an expression of the form i = i1, i2, where
i is an INTEGER variable and i1 and i2 are either integer numbers
or INTEGER variables. Optionally, DO can be preceded by a loop
name, followed by a colon. E.g. LOOP1: DO 3
ENDDO Specifies the end of the DO loop. Optionally, ENDDO can be

followed by the same loop name that was specified on the matching
DO statement.
EXIT Terminates the DO loop. Optionally, EXIT can be followed by the

name of the loop to be terminated.
CYCLE Jumps ahead to the ENDDO statement. Optionally, CYCLE can be

followed by the name of the loop which is to be cycled.
Notes:
DO statements can be nested.
Examples:
DO 5
….
END DO
INTEGER I, N = 5
loop1: DO I = 1, N
….
END DO loop1
492 Procedures: DO Loops R5000.0.1

Predefined Variables
The predefined variables are as follows:
TIME
ITIME
NEWTON
ALL1D
ALL2D
FIRST
where:
TIME The current simulation time in days.
ITIME The current time step.
NEWTON The current Newton iteration. This will normally be 1, but if

connections have opened during the first Newton, then the
procedures will also be executed on the second newton. To avoid
repeating instructions which only apply once in a time step, the
variable NEWTON can be used
ALL1D Can be used in as a function argument in place of a LOGICAL_1D

variable with all values TRUE.
ALL2D Can be used in as a function argument in place of a LOGICAL_2D

variable with all values TRUE.
FIRST TRUE the first time the procedure is executed. I.e the first time
step that the procedure is executed.
PRODWHCONS All wellhead connections for producing wells. Only for wells
whose wellhead connection is defined in a WELLHEAD table.
PRODBHCONS All connections to the bottom hole node for producing wells.
PRODWHNODES All wellhead nodes for producing wells. Only for wells whose
wellhead connection is defined in a WELLHEAD table.
PRODBHNODES All bottom hole nodes for producing wells.
INJWHCONS All wellhead connections for injecting wells. Only for wells whose
INJBHCONS All connections to the bottom hole node for injecting wells.
R5000.0.1 Procedures: Predefined Variables 493

INJWHNODES All wellhead nodes for injecting wells. Only for wells whose
INJBHNODES All bottom hole nodes for injecting wells.
Examples:
IF( FIRST )THEN

...
ENDIF
IF( TIME > 100.0 )THEN

! Plug all completions in all the wells in WELLLIST
WORKOVER(“PPERF”,WELLLIST,ALL2D,0.0,ALL1D)
ENDIF
494 Procedures: Predefined Variables R5000.0.1

Functions and the Use of masks
There are basic functions, such as abs (absolute value), max (maximum of two real or integer val-
ues) etc, functions to retrieve network data, such as p (pressure at a node or well), gor (gas oil
ratio of a connection or well) etc, functions to change the network, such as constraint (set a net-
work constraint), activate (activate a connection) etc, and functions to manipulate lists, such as
intersection (the intersection of two lists) etc.
Functions usually require one or more arguments and return a result which may be any of the
basic variable types. If the return type is an array or list, the function will allocate the space for
the array or list, so the variable used to store the returned value need not be dimensioned. Many
functions use logical 1D or 2D arrays as “masks” to determine when to perform the specified
action. For example, for the function
LOGICAL_1D MASK1D
LOGICAL_2D MASK2D
I = WORKOVER(“PPERF”,WELLS,MASK2D,0.0,MASK1D)
MASK1D is a LOGICAL_1D array which is true for each well in the list of wells named WELLS
where a workover is desired. MASK2D is a LOGICAL_2D array. The PPERF action (set the
PPERF value for the completion) is performed for each completion where MASK2D and
MASK1D are true. E.g. If MASK1D is true for the 2nd well in WELLS, then the PPERF values
for the 2nd well will be set to zero for all completions i where MASK2D(i,2) is true.
The masks can be created from logical expressions. E.g
MASK1D = WOR(WELLS,ALL1D) > 2.0
which sets MASK1D to true for all wells in WELLS where the water oil ratio exceeds 2.0.
(ALL1D is a predefined variable which is equivalent to a LOGICAL_1D array with all values
TRUE). The function WOR returns a REAL_1D array containing the water oil ratio of each well
in WELLS.
MASK2D = WOR(“PERF”, WELLS,MASK1D) > 4.0
which sets MASK2D to true for all completions where the water oil ratio exceeds 4.0, for all wells
in WELLS where MASK1D is true. Note that the function WOR is used in both of the above
expressions, but with different arguments. In this case, WOR returns a REAL_2D array contain-
ing the water oil ratio of each completion for each well in WELLS.
R5000.0.1 Procedures: Functions and the Use of masks 495

Notes:
1. Connections, nodes and wells which are used as function arguments must have been previ-
ously defined by NODES, NODECON, GROUP or WELL input. The default wellbore con-
nection and node names can not be used they have been “redefined” in a NODES,
NODECON or GROUP table.
2. All functions return results from the last time the network was solved. Any changes made to
the network by the procedure logic will not take effect until the network is resolved. E.g. If
you shut in a well, the flow from the well will still be included in the network until the net-
work is resolved. You can force a network solve using the SOLVE_NETWORK function.
This should be done sparingly as this is computationally expensive.
3. Although most functions return results, it is not necessary to set a variable equal to the func-
tion unless you want to store the result for some purpose.
4. Most functions are “Overloaded”. This means that the result of the function or result
returned by the function depend on the number and type of arguments used when invoking
the function. For example, the WOR function can return the Water/Oil ratio for a well, a con-
nection, a well list, a connection list, the completions in a well, or all the completions for all
wells in a well list, depending on the arguments used.
5. Functions and expressions can be used instead of variables in calls to other functions. E.g. I
= COUNT(WOR(WELLS,ALL1D) > 2.0). In this case, the result would be the number of
wells with a water/oil ratio exceeding 2.
Examples:
MASK1 = WOR(WELLS,ALL1D) > 2.0

MASK2D = WOR("GROUP",WELLS,MASK1D) > 4.0
WORKOVER("PPERF",WELLS,MASK2D,0.0,MASK1D)
496 Procedures: Functions and the Use of masks R5000.0.1

Description of Functions
In the following, Keywords and Strings must be enclosed in quotes.
Basic Functions
Function Type Description

abs(x) Result Same as x Absolute value of x
REAL or INTE-
x GER
accumulate(x) Result REAL_1D Result(n) = Sum (x(i)) i = 1, n
x REAL_1D
accumulate(x,order) Result REAL_1D Result(n) = Sum (x(order(i))) i = 1, n
x REAL_1D
order INT_1D
all(mask) Result LOGICAL True if all elements of mask are true
mask LOGICAL_1D 1D array of logicals (true or false)
any(mask) Result LOGICAL True if any element of mask is true
any(mask,first) Result LOGICAL True if any element of mask is true
Returns index of first true value of
first INTEGER mask
count(mask) Result INTEGER Number of true values in mask
max(x,y) Result REAL Maximum of x and y
x REAL
y REAL
max(i,j) Result INTEGER Maximum of i and j
i INTEGER
j INTEGER
R5000.0.1 Procedures: Basic Functions Description of Functions 497

Maximum value of v where mask is

maxval(v,mask) Result REAL true
v REAL_1D 1D array of real numbers
Maximum value of iv where mask is
maxval(iv,mask) Result INTEGER true
iv INTEGER_1D 1D array of integer numbers
Maximum value of v where mask is
maxval(v,first,mask) Result REAL true
Returns index of maximum value in v
first INTEGER (where mask is true)
Maximum value of iv where mask is
maxval(iv,first,mask) Result INTEGER true
Returns index of maximum value in iv
min(x,y) Result REAL Minimum of x and y
x REAL
y REAL
min(i,j) Result INTEGER Minimum of i and j
i INTEGER
j INTEGER
minval(v,mask) Result REAL Minimum value of v where mask is true
Minimum value of iv where mask is
minval(iv,mask) Result INTEGER true
498 Procedures: Basic Functions Description of Functions R5000.0.1

minval(v,first,mask) Result REAL Minimum value of v where mask is true

Returns index of minimum value in v
Minimum value of iv where mask is
minval(iv,first,mask) Result INTEGER true
Returns index of minimum value in iv
x raised to the power n, (xn). If n is < 0,

power(x,n) Result REAL and x is zero, 0 is returned.
x REAL A real number
n INTEGER An integer exponent
1D array consisting of each value in v
raised to the power n, where mask is
true, otherwise 0. If n is less that zero, a
power(v,n,mask) Result REAL_1D result of 0 will be returned if v is zero.
n INTEGER An integer exponent
x raised to the power y, (xy), if x > 0,

power(x,y) Result REAL otherwise 0.
x REAL A real number
y REAL A real exponent
1D array consisting of each value in v
raised to the power y, where mask is
power(v,y,mask) Result REAL_1DA true and v > 0, otherwise 0.
y REAL A real exponent
printout(key,string) Result None Prints the string to the specified file.

DBG, OUT or LOG. Specifies that the

printout will be to the .dbg, .out or .run-
key KEYWORD log file
A character string (enclosed in “”) of up
string STRING to 40 characters
Prints a string, and an integer to the
printout(key,i,string) Result None specified file.
i INTEGER Integer which will be printed.

Prints a string, and a real number to the
printout(key,r,string) Result None specified file.
r REAL Real Number which will be printed

Prints a string, and a logical to the spec-
printout(key,l,string) Result None ified file.
l LOGICAL Logical which will be printed

Prints a string, and a 1D integer array to
printout(key,i1d,string) Result None the specified file.
i1d INTEGER_1D 1D integer array which will be printed


Prints a string, and a 1D real array to
printout(key,r1d,string) Result None the specified file.
r1d REAL_1D 1D real array which will be printed

Prints a string, and a 1D logical array to
printout(key,l1d,string) Result None the specified file.
l1d LOGICAL_1D 1D logical array which will be printed

Prints a string, and a 2D integer array to
printout(key,i2d,string) Result None the specified file.
i2d INT_2D 2D integer array which will be printed

Prints a string, and a 2D real array to
printout(key,r2d,string) Result None the specified file.
r2d REAL_2D 2D real array which will be printed


Prints a string, and a 2D logical array to

printout(key,l2d,string) Result None the specified file.
l2d LOGICAL_2D 2D logical array which will be printed

print- Prints a string, and a node name to the
out(key,node,string) Result None specified file.
node NODE A node name which will be printed

print- Prints a string, and a connection name
out(key,con,string) Result None to the specified file.
A connection name which will be
con CONNECTION printed
print- Prints a string, and a well name to the
out(key,well,string) Result None specified file.
well WELL A well name which will be printed

Prints a string, and the node names in a
printout(key,nl,string) Result None node list to the specified file.


A nodelist. The names of the nodes in
nl NODELIST the list will be printed.
Prints a string, and the connection
names in a connection list to the speci-
printout(key,cl,string) Result None fied file.
A connection list. The names of the
cl CONLIST connections in the list will be printed.
Prints a string, and the well names in a
printout(key,wl,string) Result None well list to the specified file.
A well list. The names of the wells in
wl WELLLIST the list will be printed.
string STRING well list to the specified file.
Prints a string, and the connection
print- names in a 2D connection list to the
out(key,cl2d,string) Result None specified file.
A 2D connection list. The names of
the connections in the list will be
cl2d CONLIST_2D printed.
string STRING well list to the specified file.
set_value(iv,i,mask) Result INTEGER Number of values set
iv INTEGER_2D 2D array of integer numbers.

i INTEGER iv(j,k) = i where mask(k) is true

i INTEGER_1D iv(j,k) = i(j) where mask(k) is true
i INTEGER_2D iv(j,k) = i(j,k) where mask(k) is true
i INTEGER iv(j) = i where mask(j) is true
i INTEGER_1D iv(j) = I(j) where mask(j) is true
set_value(v,x,mask) Result INTEGER Number of values set
v REAL_2D 2D array of real numbers.
x REAL v(j,k) = x where mask(k) is true
x REAL_1D v(j,k) = x(j) where mask(k) is true
x REAL_2D v(j,k) = x(j,k) where mask(k) is true


x REAL v(j) = x where mask(k) is true
x REAL_1D v(j) = x(j) where mask(k) is true
set_value(lv,l,mask) Result INTEGER Number of values set
lv LOGICAL_2D 2D array of logicals.
l LOGICAL lv(j,k) = l where mask(k) is true
l LOGICAL_1D lv(j,k) = l(j) where mask(k) is true
l LOGICAL_2D lv(j,k) = l(j,k) where mask(k) is true
l LOGICAL lv(j) = l where mask(k) is true
l LOGICAL_1D lv(j) = l(j) where mask(k) is true
size(iv) Results INTEGER Number of elements in iv

size(v) Results INTEGER Number of elements in iv

size(nl) Results INTEGER Number of elements in iv
nl NODELIST A list of nodes
size(cl) Results INTEGER Number of elements in iv
cl CONLIST A list of connections
size(wl) Results INTEGER Number of elements in iv
wl WELLLIST A list of wells
sum(v,mask) Result REAL Sum of the values in v
sum(iv,mask) Result INTEGER Sum of the values in iv

Functions to Manipulate Lists

A reduction of the list of connections cl
with the connections where mask is
filter(cl,mask) Result CONLIST false removed.
A reduction of the list of nodes nl with
filter(nl,mask) Result NODELIST the nodes where mask is false removed.
A reduction of the list of wells wl with
filter(wl,mask) Result WELLLIST the wells where mask is false removed.
A reduction of the array iv with the val-
filter(iv,mask) Result INTEGER_1D ues where mask is false removed.
A reduction of the array v with the val-
filter(v,mask) Result REAL_1D ues where mask is false removed.
The 2D array of integer numbers where
filter(iv,mask) Result INTEGER_2D mask is true
The 2D array of real numbers where
filter(v,mask) Result REAL_2D mask is true
The list of connections which is com-
intersection(cl1,cl2) Result CONLIST mon to cl1 and cl2
cl1 CONLIST A list of connections
R5000.0.1 Procedures: Functions to Manipulate Lists Description of Functions 507


The list of nodes which is common to
intersection(nl1,nl2) Result NODELIST nl1 and nl2
nl1 NODELIST A list of nodes
The list of wells which is common to
intersection(wl1,wl2) Result WELLLIST wl1 and wl2
wl1 WELLLIST A list of wells
1D array of logicals (size of cl1) which
is true if a connection in cl1 is also in
mask(cl1,cl2) Result LOGICAL_1D cl2
1D array of logicals (size of nl1) which
mask(nl1,nl2) Result LOGICAL_1D is true if a node in nl1 is also in nl2
1D array of logicals (size of wl1) which
mask(wl1,wl2) Result LOGICAL_1D is true if a well in wl1 is also in wl2
A list of connections sorted in the order
sort(key,cl,v) Result CONLIST of v
INCR or DECR for sorting in increas-
key KEYWORD ing or decreasing order of v
v REAL_1D An array of real numbers
sort(key,nl,v) Result NODELIST A list of nodes sorted in the order of v
sort(key,wl,v) Result WELLLIST A list of wells sorted in the order of v
508 Procedures: Functions to Manipulate Lists Description of Functions R5000.0.1


The list of connections formed by the
union(cl1,cl2) Result CONLIST union of cl1 and cl2
The list of nodes formed by the union
union(nl1,nl2) Result NODELIST of nl1 and nl2
The list of wells formed by the union of
union(wl1,wl2) Result WELLLIST wl1 and wl2
R5000.0.1 Procedures: Functions to Manipulate Lists Description of Functions 509

Functions to Retrieve Network Data

conc(cpt,tracer,well) Result REAL The concentration of a component
tracer in a well.
cpt STRING The name of a component
tracer STRING The name of a tracer
well WELL The name of a well
conc(cpt,tracer,con) Result REAL The concentration of a component
tracer in a connection
con CONNECTION The name of a connection
conc(cpt,tracer,wl, mask) Result REAL The concentration of a component
tracer in each well in a well list
where mask is true.
wl WELLLIST The name of a well list
conc(cpt,tracer,cl,mask) Result REAL The concentration of a component
tracer in each connection in a con-
nection list where mask is true.
cpt STRING The name of a component.
tracer STRING The name of a tracer.
cl CONLIST The name of a connection list.
mask LOGICAL_1D 1D array of logicals (true or false).
conc(key,cpt,tracer,well) Result REAL_1D The concentration of a component
tracer in a well’s perforations.
key KEYWORD PERF - Return the concentration
for each perforation.
GROUP - Return the concentration
for each group of perforations.
510 Procedures: Functions to Retrieve Network Data Description of Functions R5000.0.1


conc(key,cpt,tracer,wl, Result REAL_2D The concentration of a component
mask) tracer in the perforations of each
well in the well list where mask is
true.
key KEYWORD PERF – Return the concentration
for each perforation
GROUP – Return the concentration
for each group of perforations
wl WELLLIST The name of a well list
conparam(key,con) Result REAL The value of the parameter speci-
fied by key for the specified con-
nection
key KEYWORD WCUT_SHUT, WOR_SHUT,
GOR_SHUT, GLR_SHUT,
WGR_SHUT, WCUT_VALVE,
WOR_VALVE, GOR_VALVE,
WGR_VALVE, QO_VALVE,
QG_VALVE or QW_VALVE
WCUT_CB_MAX,
GOR_CB_MAX, GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
GOR_CB_MIN,
GLR_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN
con CONNECTION A connection name
conparam(key,cl,mask) Result REAL_1D The value of the parameter speci-
fied by key for each connection in
the specified list where mask is
true. Where mask is false, the result
value is not set.
R5000.0.1 Procedures: Functions to Retrieve Network Data Description of Functions 511


GOR_SHUT, GLR_SHUT,
QG_VALVE or QW_VALVE,
WCUT_CB_MAX,
GOR_CB_MAX,
GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
GOR_CB_MIN,
GLR_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN
cl CONLIST A connection list
cum(key,con) Result REAL The cumulative production for the
connection
key KEYWORD OS – Oil at surface conditions
GS – Gas at surface conditions
WS – Water at surface conditions
LIQS – Liquid at surface conditions
cum(key,well) Result REAL The cumulative production for the
well connection
well WELL A well name
cum(key,cl,mask) Result REAL_1D The cumulative production for each
connection in the list where mask is
true. Where mask is false, the
result value is not set.


cum(key,wl,mask) Result REAL_1D The cumulative production for each
well’s connection in the list where
mask is true. Where mask is false,
the result value is not set.
wl WELLLIST A well list
get_constraint(key,well) Result REAL The current value of a well con-
straint
key KEYWORD Any of the keywords from the
CONSTRAINTS table which apply
to a well. E.g QOSMAX.
get_constraint(key,con) Result REAL The current value of a connection
constraint
to a connection, plus FTOTAL,
which sets the total rate split if the
connection is an outlet from a
stream splitting node. E.g QOS-
MAX.
get_constraint(key,node) Result REAL The current value of a node con-
straint
to a node, except BHP and THP.
E.g PMIN
node NODE A node name
get_constraint(key,wl, Result REAL_1D The current value of each well’s
mask) constraint in the list, where mask is
true.
to a well. E.g QOSMAX.

wl WELLLIST A well list name

get_constraint(key,cl, Result REAL_1D The current value of each connec-
mask) tion’s constraint in the list, where
mask is true.
to a connection, plus FTOTAL,
which sets the total rate split if the
connection is an outlet from a
stream splitting node. E.g QOS-
MAX.
cl CONLIST A connection list name
get_constraint(key,nl, Result REAL_1D The current value of each node’s
mask) constraint in the list, where mask is
true.
to a node, except BHP and THP.
E.g PMIN.
nl NODELIST A node list name
get_constraint(key,well, Result REAL The current value of a well DPB-
zone) HMX constraint for a completion
zone
key KEYWORD DPBHMX
zone INTEGER The completion zone to which the
DPHBMX constraint applies
get_constraint(key,con, Result REAL The current value of a connection
zone) DPBHMX constraint for a comple-
tion zone
key KEYWORD DPBHMX
DPHBMX constraint applies

get_constraint(key,wl, Result REAL The current value of each well’s

zone,mask) DPBHMX constraint in the well
list, for a completion zone, where
mask is true.
key KEYWORD DPBHMX
DPHBMX constraint applies.
get_constraint(key,cl,zone, Result REAL The current value of each connec-
mask) tion’s DPBHMX constraint in the
connection list, for a completion
zone, where mask is true.
key KEYWORD DPBHMX
DPHBMX constraint applies.
get_target(key,targ) Result REAL A target parameter
key KEYWORD RATE - The calculated target rate
from the previous time step
VALUE – The target VALUE
ADDVALUE – The target
ADDVALUE
targ TARGET A target name
glr(con) Result REAL The gas/liquid ratio for the connec-
tion
glr(well) Result REAL The gas/liquid ratio for the well
connection
glr(cl,mask) Result REAL_1D The gas/liquid ratio for each con-
nection in the list where mask is
result value is set to -1.


glr(wl,mask) Result REAL_1D The gas/liquid ratio for each well’s

result value is set to -1

glr(key,well) Result REAL_1D The gas/liquid ratio for the well’s
perforations
key KEYWORD PERF – Return the glr for each per-
foration
GROUP – Return the glr for each
group of perforations
glr(key,wl,mask) Result REAL_2D The gas/liquid ratio for each
well’s perforations, for wells
corresponding to mask = .true.
Where mask is false, the result
values are set to -1.
key KEYWORD PERF – Return the glr for each per-
foration
wl WELLLIST A well list.
gor(con) Result REAL The gas/oil ratio for the connection
gor(well) Result REAL The gas/oil ratio for the well con-
nection
gor(cl,mask) Result REAL_1D The gas/oil ratio for each connec-
tion in the list where mask is true.
value is set to -1


gor(wl,mask) Result REAL_1D The gas/oil ratio for each well’s

result value is set to -1.

gor(key,well) Result REAL_1D The gas/oil ratio for the well’s per-
forations
key KEYWORD PERF – Return the gor for each
perforation
GROUP – Return the gor for each
gor(key,wl,mask) Result REAL_2D The gas/oil ratio for each well’s
perforations, for wells correspond-
ing to mask = true. Where mask is
false, the result value is set to -1.
perforation
is_active(con) Result LOGICAL True if the connection is part of the
active network
is_active(well) Result LOGICAL True if the well is part of the active
network
is_active(cl,mask) Result LOGICAL_ID 1D array of logicals which are true
for any connection which is part of
the active network where mask is
true
mask LOGICAL_ID 1D array of logicals (true or false)
is_active(wl,mask) Result LOGICAL_ID 1D array of logicals which are true
for any well which is part of the
active network where mask is true

well CONLIST A well list name

mask LOGICAL_ID 1D array of logicals (true or false)
is_back_flowing(key, Result LOGICAL True if the connection is back flow-
con) ing for the reason specified by key.
key KEYWORD HYD – Hydraulics
QMAX – Qmax constraint
PMIN – Pmin constraint
PMAX – Pmax constraint
ANY – Any reason
is_back_flowing(key, Result LOGICAL True if the well’s connection is
well) back flowing for the reason speci-
fied by key.
ANY – Any reason
is_back_flowing(key, Result LOGICAL_1D True for each connection in the list
cl,mask) which is back flowing for the rea-
son specified by key, where mask is
true.
ANY – Any reason
is_back_flowing(key, Result LOGICAL_1D True for each well connection in
wl,mask) the list which is back flowing for
the reason specified by key, where
mask is true.
ANY – Any reason


is_flowing(key,con) Result LOGICAL True if the connection is flowing
for the reason specified by key.
ANY – Any reason
is_flowing(key,well) Result LOGICAL True if the well’s connection is
flowing for the reason specified by
key.
ANY – Any reason
is_flowing(key,cl,mask) Result LOGICAL_1D True for each connection in the list
which is flowing for the reason
specified by key, where mask is
true.
ANY – Any reason
is_flowing(key,wl,mask) Result LOGICAL_1D True for each well connection in
the list which is flowing for the rea-
true.
ANY – Any reason

is_not_flowing(key, Result LOGICAL True if the connection is not flow-

con) ing for the reason specified by key.
ANY – Any reason
is_not_flowing(key, Result LOGICAL True if the well’s connection is not
well) flowing for the reason specified by
key.
ANY – Any reason
is_not_flowing(key, Result LOGICAL_1D True for each connection in the list
cl,mask) which is not flowing for the reason
specified by key, where mask is
true.
ANY – Any reason
is_not_flowing(key, Result LOGICAL_1D True for each well connection in
wl,mask) the list which is not flowing for the
reason specified by key, where
mask is true.
ANY – Any reason
is_shutin(key,con) Result LOGICAL True if the connection is shut in for
the reason specified by key.


QMIN – Qmin constraint
QZERO – Zero rate constraint
QBACK – Back flow
ANY – Any reason
is_shutin(key,well) Result LOGICAL True if the well’s connection is shut
in for the reason specified by key.
QBACK – Back flow
ANY – Any reason
is_shutin(key,cl,mask) Result LOGICAL_1D True for each connection in the list
which is shut in for the reason spec-
ified by key, where mask is true.
QBACK – Back flow
ANY – Any reason
is_shutin(key,wl,mask) Result LOGICAL_1D True for each well connection in
the list which is shut in for the rea-
true.
QBACK – Back flow
ANY – Any reason
ogr(con) Result REAL The oil/gas ratio for the connection
ogr(well) Result REAL The oil-gas ratio for the well con-
nection


ogr(cl,mask) Result REAL_1D The oil/gas ratio for each connec-
value is set to -1
ogr(wl,mask) Result REAL_1D The oil/gas ratio for each well’s
true. tion in the list where mask is
value is set to -1
ogr(key,well) Result REAL_1D The oil/gas ratio for the well’s per-
forations
key KEYWORD PERF – Return the ogr for each
perforation
GROUP – Return the ogr for each
ogr(key,wl,mask) Result REAL_2D The oil/gas ratio for each well’s
perforation
p(node) Result REAL Pressure at the node
p(well) Result REAL Pressure at the well’s bottom hole
node
p(nl,mask) Result REAL_1D Pressure at the each node in the list
where mask is true. Where mask is
false, the result value is not set.

nl NODELIST A node list

perf_prop(key,well) Result INTEGER_1D The value of the perforation prop-
erty, for each perforation in the
well.
key KEYWORD SECT – Section index
GROUP – Group index
ZONE – Zone index
FLOWSECT – Flowsection index
perf_prop(key,wl,mask) Result INTEGER_2D The value of the perforation prop-
erty, for each perforation, for each
well in the well list where mask is
true.
key KEYWORD SECT – Section index
GROUP – Group index
ZONE – Zone index
FLOWSECT – Flowsection index
p(wl,mask) Result REAL_1D Pressure at each well’s bottom hole
node where mask is true. Where
mask is false, the result value is not
set.
q(key,con) Result REAL The rate for the connection
O – Oil at in-situ conditions
G – Gas at in-situ conditions
W – Water at in-situ conditions
LIQ – Liquid at in-situ conditions
ALL – All components at in-situ
conditions
HC – Hydrocarbons at in-situ con-
ditions
ALQ – Artificial Lift Quantity


q(key,well) Result REAL The rate for the well connection
conditions
ditions
q(key,cl,mask) Result REAL_1D The rate for each connection in the
list where mask is true. Where
mask is false, the result value is not
set.
conditions
ditions
q(key,wl,mask) Result REAL_1D The rate for each well’s connection
in the list where mask is true.
value is not set.


conditions
ditions
q(key1,key2,well) Result REAL_1D The rate for each of the well’s per-
forations
key1 KEYWORD OS – Oil at surface conditions
conditions
ditions
key2 KEYWORD PERF – Return the glr for each per-
foration
q(key1,key2,wl,mask) Result REAL_2D The rate for each perforation, for
each well in the list where mask is
result value is not set.

key1 KEYWORD OS – Oil at surface conditions

conditions
ditions
key2 KEYWORD PERF – Return the glr for each per-
foration
The potential rate for the connec-
tion. The potential rate is calcu-
lated by solving the network with
all targets inactive. Note: This may
require the potential solution to be
recalculated, which may require a
qp(key,con) Result REAL significant amount of cpu.
OS – Oil at surface conditions
conditions
ditions
key KEYWORD ALQ – Artificial Lift Quantity

The potential rate for the well con-

nection. The potential rate is calcu-
lated by solving the network with
all targets inactive. Note: This may
require the potential solution to be
recalculated, which may require a
qp(key,well) Result REAL significant amount of cpu.
conditions
ditions
The potential rate for each connec-
value is not set. The potential rate
is calculated by solving the network
with all targets inactive. Note: This
may require the potential solution
to be recalculated, which may
qp(key,cl,mask) Result REAL_1D require a significant amount of cpu.
conditions
ditions

The rate for each well’s connection

q(key,wl,mask) Result REAL_1D value is not set.
conditions
ditions
The potential rate for each of the
well’s perforations The potential
rate is calculated by solving the net-
work with all targets inactive.
Note: This may require the poten-
tial solution to be recalculated,
which may require a significant
qp(key1,key2,well) Result REAL_1D amount of cpu.
conditions
key1 KEYWORD ditions
PERF – Return the glr for each per-
foration
key2 KEYWORD group of perforations

The potential rate for each perfora-

tion, for each well in the list where
the result value is not set. The
potential rate is calculated by solv-
ing the network with all targets
inactive. Note: This may require
the potential solution to be recalcu-
lated, which may require a signifi-
qp(key1,key2,wl,mask) Result REAL_2D cant amount of cpu.
conditions
key1 KEYWORD ditions
PERF – Return the glr for each per-
foration
key2 KEYWORD group of perforations
valve_setting(con) RESULT REAL The value of the valve setting for
the specified connection
valve_setting(cl,mask) RESULT REAL_1D The value of the valve setting for
each connection in the list where
the result value is not set.
wcut(con) Result REAL The water cut for the connection
wcut(well) Result REAL The water cut for the well connec-
tion


wcut(cl,mask) Result REAL_1D The water cut for each connection
value is set to -1.
wcut(wl,mask) Result REAL_1D The water cut for each well’s con-
value is set to -1.
wcut(key,well) Result REAL_1D The water cut for the well’s perfo-
rations
key KEYWORD PERF – Return the wcut for each
perforation
GROUP – Return the wcut for each
wcut(key,wl,mask) Result REAL_2D The water cut for each well’s per-
forations, for wells corresponding
to mask = true. Where mask is
key KEYWORD PERF – Return the wcut for each
perforation
GROUP – Return the wcut for each
wgr(con) Result REAL The water/gas ratio for the connec-
tion
wgr(well) Result REAL The water/gas ratio for the well
connection

wgr(cl,mask) Result REAL_1D The water/gas ratio for each con-

value is set to -1.
wgr(wl,mask) Result REAL_1D The water/gas ratio for each well’s
value is set to -1.
wgr(key,well) Result REAL_1D The water/gas ratio for the well’s
perforations
key KEYWORD PERF – Return the wgr for each
perforation
GROUP – Return the wgr for each
wgr(key,wl,mask) Result REAL_2D The water/gas ratio for each well’s
key KEYWORD PERF – Return the wgr for each
perforation
GROUP – Return the wgr for each
wor(con) Result REAL The water/oil ratio for the connec-
tion
wor(well) Result REAL The water/oil ratio for the well
connection

wor(cl,mask) Result REAL_1D The water/oil ratio for each con-

result value is set to -1

wor(wl,mask) Result REAL_1D The water/oil ratio for each well’s
value is set to -1.
wor(key,well) Result REAL_1D The water/oil ratio for the well’s
perforations
key KEYWORD PERF – Return the wor for each
perforation
GROUP – Return the wor for each
wor(key,wl,mask) Result REAL_2D The water/oil ratio for each well’s
key KEYWORD PERF – Return the wor for each
perforation
GROUP – Return the wor for each

Functions to Change Network Data

abandon(l) Result NONE Stops run.
l LOGICAL Write restart record if 1 is true.
activate(con) Result INTEGER Activates a connection. Returns
the number of connections acti-
vated.
activate(cl,mask) Result LOGICAL_ID Activates the connections where
mask is true. Returns an array of
logicals, where the logical is true
if the connection was activated
activate(rig) Result INTEGER Activate a rig at the same drill site
where it was previously located.
Returns 1 if the rig was activated,
otherwise 0.
rig RIG A rig name.
activate(target) Result INTEGER Activates a target. Returns the
number of targets activated.
target WELL A target name
activate(well) Result INTEGER Activates a well’s connection.
Returns the number of wells acti-
vated.
activate(wl,mask) Result LOGICAL_ID Activates the well connections
where mask is true. Returns an
array of logicals, where the logical
is true if the well was activated
activate_next(cl,mask) Result INTEGER Activates the first inactive con-
nection in the connection list,
where mask is true. Returns the
index (in the list) of the activated
connection.
R5000.0.1 Procedures: Functions to Change Network Data Description of Functions 533


activate_next(wl,mask) Result INTEGER Activates the first inactive con-
nection in the well list, where
mask is true. Returns the index
(in the list) of the activated well.
constraint(key,con,value) Result INTEGER Set a constraint for a connection.
Returns 1 if the constraint
changed, 0 if the constraint did not
change.
CONSTRAINTS table which
apply to a connection. E.g. QOS-
MAX
value REAL The value to which the constraint
will be set.
constraint(key,con) Result INTEGER Set a constraint for a connection.
change.
Key KEYWORD SHUTIN - shut in the connection
CLEARQ - remove all rate con-
straints for the connection
CLEARDPBH - clear DPBHMX
and DPBHAVG constraints
CLEARALQ - clear ALQ,
GLEFMIN and GLRADD
CLEARFUEL - clear fuel and
shrinkage constraints
Con CONNECTION A connection name
constraint(key,cl,val- Result INTEGER Set a constraint for the connec-
ues,mask) tions in the connection list where
mask is true. Returns the number
of constraints changed.
CONSTRAINTS table which
apply to a connection. E.g. QOS-
MAX
534 Procedures: Functions to Change Network Data Description of Functions R5000.0.1


values REAL The values to which the con-
straints will be set.
constraint(key,cl,mask) Result INTEGER Set a constraint for the connec-
tions in the connection list where
Key KEYWORD SHUTIN - shut in the connection
straints for the connection
GLEFMIN and GLRADD
constraint(key,node,P) Result INTEGER Set a constraint for a node.
change.
Key KEYWORD PMIN or PMAX
p REAL The pressure to which the con-
straint will be set.
constraint(key,node) Result INTEGER Set a constraint for a node.
change.
Key KEYWORD CLEARP – remove all pressure
constraints for the node
constraint(key,nl,P,mask) Result INTEGER Set a constraint for the nodes in
the node list where mask is true.
Returns the number of constraints
changed.


p REAL The pressure to which the con-
straint will be set.
constraint(key,nl,P,mask) Result INTEGER Set a constraint for the nodes in
changed.
p REAL_1D The pressures to which the con-
straint will be set. The order of
the pressures in this array should
correspond to the order of the
node list.
constraint(key,nl,mask) Result INTEGER Set a constraint for the nodes in
changed.
Key KEYWORD CLEARP – remove all pressure
constraints for the node
constraint(key,well,r) Result INTEGER Set a constraint for a connection.
change.
Key KEYWORD PMIN, PMAX, or any of key-
words from the CONSTRAINTS
table which apply to a well. E.g.
QOSMAX
Well WELL A well name
r REAL The rate or pressure to which the
constraint will be set.
constraint(key, well) Result INTEGER Set a constraint for a connection.
change.

Key KEYWORD SHUTIN - shut in the well

straints for the well
CLEARP - remove all pressure
constraints for the well
GLEFMIN and GLRADD
constraint(key,wl,r,mask) Result INTEGER Set a constraint for the wells in the
well list where mask is true.
changed.
Key KEYWORD PMIN, PMAX, ALQ, or any of
keywords from the CON-
STRAINTS table which specify
rate. E.g. QOSMAX
r REAL The rate or pressure to which the
constraint will be set.
constraint(key,wl,r,mask) Result INTEGER Set a constraint for the wells in the
changed.
Key KEYWORD PMIN, PMAX, ALQ, or any of
keywords from the CON-
STRAINTS table which specify
rate. E.g. QOSMAX
r REAL_1D The rates or pressures to which
the constraint will be set. The
order of the rates in this array
should correspond to the order of
the connection list.

constraint(key,wl,mask) Result INTEGER Set a constraint for the wells in the

changed.
Key KEYWORD SHUTIN - shut in the well
straints for the well
CLEARP - remove all pressure
constraints for the well
GLEFMIN and GLRADD
constraint(key,well,value, Result INTEGER Set a DPBHMX constraint for a
zone) well. Returns 1 if the constraint
change
key KEYWORD DPBHMX

well WELL A connection name
will be set.
DPBHMX constraint applies.
constraint(key,con,value, Result INTEGER Set a DPBHMX constraint for a
zone) connection. Returns 1 if the con-
straint changed, 0 if the constraint
did not change
key KEYWORD DPBHMX
will be set.

constraint(key,wl, Result INTEGER Set a DPBHMX constraint for

values,zone,mask) each well in a well list, where
key KEYWORD DPBHMX
values REAL_1D The values to which the con-
constraint(key,cl, Result INTEGER Set a DPBHMX constraint for
values,zone,mask) each connection in a connection
list, where mask is true. Returns
the number of constraints
changed.
key KEYWORD DPBHMX
values REAL_1D The values to which the con-
deactivate(con) Result INTEGER Deactivates a connection. Returns
the number of connections deacti
vated. (Connections which are
outflows from SEPNODES can
not be deactivated).
deactivate(cl,mask) Result LOGICAL_1D Deactivates the connections where
if the connection was deacti-
not be deactivated.)

deactivate(con,flag) Result INTEGER Deactivates a connection. Returns

the number of connections deacti-
flag INTEGER A flag used to test the connection
for reactivation
deactivate(cl,mask,flag) Result LOGICAL_1D Deactivates the connections where
if the connection was deacti-
for reactivation
deactivate(rig) Result INTEGER Deactivate a rig. Returns 1 if the
rig was deactivated, otherwise 0.
rig RIG A rig name.
deactivate(tgt) Result INTEGER Deactivates a target. Returns the
number of targets deactivated.
tgt TARGET A target name
deactivate(well) Result INTEGER Deactivates a well’s connection.
Returns the number of wells deac-
tivated.
well WELL A connection list
deactivate(wl,mask) Result INTEGER Deactivates the well connections
is true if the well was deactivated.
deactivate(well,flag) Result INTEGER Deactivates a well’s connection.
Returns the number of wells deac-
tivated.

well WELL A connection list

flag INTEGER A flag used to test the well for
reactivation
deactivate(wl,mask,flag) Result INTEGER Deactivates the well connections
is true if the well was deactivated.
reactivation
deactivate_next(cl,mask) Result INTEGER Deactivates the first active con-
nection in the connection list,
index (in the list) of the deacti-
vated connection. (Connections
which are outflows from SEPN-
ODES can not be deactivated.)
deactivate_next(wl,mask) Result INTEGER Deactivates the first active con-
nection in the well list, where
(in the list) of the deactivated
well.
deactivate_next(cl,mask, Result INTEGER Deactivates the first active con-
flag) nection in the connection list,
index (in the list) of the deacti-
vated connection.
for reactivation

deactivate_next(wl,mask, Result INTEGER Deactivates the first active con-

flag) nection in the well list, where
(in the list) of the deactivated
well.
reactivation
drill(key1,key2,target, Result INTEGER Drills a well or wells when the

adjust,wl,nw,mask) target (evaluated using flow rates
computed from a potential solve),
can not be achieved. Returns the
number of wells which start
drilling.
Key1 KEYWORD RIGS – drills wells until all rigs

are in use. The procedure first
checks the first nw wells in the
well list and starts drilling if a rig
is available at the same drill site as
the well. Then if all rigs have not
been used, it will process the well
list again, allowing rigs to move
between drill sites until all rigs are
in use.
NORIGS – drilling is not subject

to rig availability, but only nw
wells can be in progress
simultaneously.
Key2 KEYWORD Specifies how the argument adjust

is used to adjust the target
VALUE.
MULT – the target VALUE is
multiplied by adjust.
ADDVALUE – adjust is added to
the target VALUE.
VALUE – adjust replaces the
target VALUE.
target TARGET A target name

adjust REAL The adjustment to the target

VALUE. How the adjustment is
applied depends on key2.
wl WELLLIST A well list containing the wells in

the drill queue. These wells
should initially be inactive.
nw INTEGER If NORIGS is specified, this is the

number of wells that can be
drilling simultaneously.
If RIGS is specified, this is the
number of inactive wells that the
procedure will check before
allowing rigs to move between
drill sites.

If mask is false for a well in the
well list, the well will not start
drilling.
drill(wl,nw,mask) Result INTEGER Drills wells until all rigs are in

use. The procedure first checks
the first nw wells in the well list
and starts drilling if a rig is
available (and mask is true) at the
same drill site as the well. Then if
all rigs have not been used, it will
process the well list again,
drill sites until all rigs are in use.
Returns the number of wells
which start drilling.

nw INTEGER This is the number of inactive

wells that the procedure will
check before allowing rigs to
move between drill sites.

mask LOGICAL 1D array of logicals (true or false).

drilling.
drill(key,wl,nw,mask) Result INTEGER Drills the wells in the well list

where mask is true, subject to rig
availability or the limitation on
the number of simultaneous wells
that can be drilled. Returns the
number of wells which start
drilling.
key KEY RIGS – drills wells until all rigs

are in use. The procedure first
checks the first nw wells in the
well list and starts drilling if a rig
is available at the same drill site as
the well. Then if all rigs have not
been used, it will process the well
list again, allowing rigs to move
between drill sites until all rigs are
in use.
NORIGS – drilling is not subject

to rig availability, but only nw
wells can be in progress
simultaneously.

nw INTEGER If NORIGS is specified, this is the

number of wells that can be
drilling simultaneously.
If RIGS is specified, this is the
number of inactive wells that the
procedure will check before
drill sites.
mask LOGICAL 1D array of logicals (true or false).

drilling.

glr_shut(cl,flag) Result INTEGER Shut in connections which have a

gas/oil ratio greater than the value
specified for GOR_SHUT in the
CONPARAM table. Returns the
number of connections shut in.
reopening
gor_shut(cl,flag) Result INTEGER Shut in connections which have a
water/oil ratio greater than the
value specified for GOR_SHUT
in the CONPARAM table.
Returns the number of connec-
tions shut in.
reopening
next_method(key,con,il) Result LOGICAL Changes a method used by a con-
nection to the next method in the
i1 array. Returns true if the
method was changed, otherwise
false.
key KEY HYD – hydraulics methods
BAT – separator methods
PVT – pvt methods
WAT – water pvt methods
VALVE - valve methods
CHOKE - choke methods
PUMP - pump methods
COMPRESSOR - compressor
methods
GASLIFT - optimal gaslift tables
i1 INTEGER_1D An array containing method indi-
ces (corresponding to the method
number specified in the case file).
next_method(key,cl,i2d, Result LOGICAL_1D Changes a method used by a con-
mask) nection to the next method in the
i2 array, where mask is true.
Returns an array of logicals,
where the logical is true if the
method was changed for a con-
nection in the list, otherwise false.


PVT – pvt methods
PUMP - pump methods
methods
i2d INTEGER_2D A 2D array containing method
indices (corresponding to the
method number specified in the
case file). The method for con-
nection cl(i) will be set to the next
method in the array i2(:,i).
next_method(key,well,i1, Result LOGICAL Changes a method used by a well
i2,ild) to the next method in the i1 array.
Returns true if the method was
changed, otherwise false.
key KEY HYD – hydraulics methods for the
wellbore connections in the speci-
fied range of well flow sections
i1 INTEGER Starting flow section (A value of 0
is used for the bottom hole con-
nection).
i2 INTEGER Ending flow section
i1d INTEGER_1D An array containing method indi-
ces (corresponding to the method
number specified in the case file).
next_method(key,wl,i1, Result LOGICAL_1D Changes a method used by a well
i2,i2d,mask) to the next method in the i2 array,
is true if the method was changed
for a well in the list, otherwise
false.


nection).
case file). The method for well
wl(i) will be set to the next
method in the array i2(:,i).
redrill(key1,key2,wl, Result INTEGER Starts drilling a replacement well

value,mask) when a trigger is violated.
key1 KEYWORD RIGS – drills a replacement when

the trigger specified by key2 is
violated, subject to a rig being
available.
NORIGS – drills a replacement
when the trigger specified by key2
is violated if mask is true for that
well.

key2 KEYWORD A keyword denoting the trigger

that when violated, will result in
replacing the well.
MAXQGS – maximum surface
gas rate.
MAXQOS – maximum surface oil
rate.
MAXQWS – maximum surface
water rate.
MAXQLIQS – maximum surface
liquid rate.
MINQGS – minimum surface gas
rate.
MINQOS – minimum surface oil
rate.
MINQWS – minimum surface
water rate.
MINQLIQS – minimum surface
liquid rate.
MAXGOR – maximum gas/oil
ratio.
MAXGLR – maximum gas/liquid
ratio.
MAXWCUT – maximum water
cut.
MAXWOR – maximum water/oil
ratio.
MAXWGR – maximum water/gas
ratio.
MAXOGR – maximum oil/gas
ratio.
wl WELLLIST A well list containing the wells

which will be checked for
replacement.
value REAL The trigger value. When key2 is a

MAX trigger, the well is replaced
when the value is exceeded.
When key2 is a MIN trigger, the
well is replaced when the value is
not reached.


well list, a replacement well will
not start drilling.
redrill(key1,wl,mask) Result INTEGER Starts drilling a replacement well.

Key1 KEYWORD RIGS – drilling of replacement

wells is not subject to rig
availability
NORIGS – drilling of
replacement wells is subject to rig
availability
wl WELLLIST A well list containing the wells

which will be checked for
replacement.

If mask is true for a well in the
well list, a replacement well will
start drilling.
select_con(cl,I) Result INTEGER Activate the ith connection in the
list, and deactivate other connec-
tions in the list. Returns 1 if the
connection was activated, 0 other-
wise.
l INTEGER The index (in cl) of the connection
to be activated. An index of 0
does nothing.
select_con(cl2,i1) Result INTEGER Activate connection cl2(j,i),
where j = i1(i), and deactivate
cl2(k,i), where k /= j. Returns the
number of connections activated.
cl2 CONLIST_2D A 2D connection list
i1 INTEGER_1D i1(i) is the connection in the list
cl2(:,i) to be activated. If i1(i) = 0,
no action is taken.

set_conparam(key, RESULT INTEGER The number of connections, for

con,value) which the connection parameter
has been set.
GOR_SHUT, GLR_SHUT,
QG_VALVE, QW_VALVE,
WCUT_CB_MAX,
GOR_CB_MAX,
GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
GOR_CB_MIN, GLR_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN
value REAL The value which the connection
parameter corresponding to the
keyword key, will be set to for
connection con.
set_conparam(key, RESULT INTEGER The number of connections, for
cl,value,mask) which the connection parameter
has been set
GOR_SHUT, GLR_SHUT,
QG_VALVE, QW_VALVE,
WCUT_CB_MAX,
GOR_CB_MAX,
GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN

value REAL The value which the connection

parameter corresponding to the
keyword key, will be set to for
each connection in the connection
list cl where mask is true
set_method(key,con,i) Result LOGICAL Changes a method used by a con-
nection to method i. Returns true
if the method was changed, other-
wise false.
PVT – pvt methods
PUMP - pump methods
methods
i INTEGER The method index (corresponding
to the method number specified in
the case file).
set_method(key,con, Result LOGICAL Changes a method used by a con-
grad) nection. Returns true if the
false.
key KEY GRAD – specified gradient
hydraulics method
grad REAL The gradient value.
set_method(key,con) Result LOGICAL Changes a method used by a con-
nection. Returns true if the
false.
key KEY GRADCALC – GRADCALC
hydraulics method

set_method(key,cl,il, Result LOGICAL_1D Changes a method used by a con-

mask) nection to the method specified in
the i1 array, where mask is true.
PVT – pvt methods
PUMP - pump methods
methods
i1 INTEGER_1D A 1D array containing method
case file). The index of the array
corresponds to a connection in cl.
set_method(key,cl,grads, Result LOGICAL_1D Changes a method used by a con-
mask) nection, where mask is true.
key KEY GRAD – specified gradient
hydraulics method
grads REAL_1D The gradients for each connection
in the list.
set_method(key,cl,mask) Result LOGICAL_1D Changes a method used by a con-
nection, where mask is true.

key KEY GRADCALC – GRADCALC

hydraulics method
set_method(key,well,i1, Result LOGICAL Changes a method used by a well
i2,i) to method i. Returns true if the
false.
nection).
the case file).
set_method(key,well,i1, Result LOGICAL Changes a method used by a well.
i2,grad) Returns true if the method was
key KEY GRAD – specified gradient for the
nection).
grad REAL The gradient.
set_method(key,well,i1, Result LOGICAL Changes a method used by a well.
i2) Returns true if the method was
key KEY GRADCALC – calculated gradi-
ent for the wellbore connections
in the specified range of well flow
sections


nection).
set_method(key,wl,i1,i2, Result LOGICAL_1D Changes a method used by a well
ild,mask) to the method specified in the i1
array, where mask is true. Returns
an array of logicals, where the
logical is true if the method was
changed for a well in the list, oth-
erwise false.
nection).
case file). The index of the array
corresponds to a connection in cl.
set_method(key,wl,i1,i2, Result LOGICAL_1D Changes a method used by a well,
grads,mask) where mask is true. Returns an
false.
key KEY GRAD – specified gradient for the
nection).

grads REAL_1D The gradients for each well in the

list.
set_method(key,wl,i1,i2, Result LOGICAL_1D Changes a method used by a well,
mask) where mask is true. Returns an
false.
key KEY GRADCALC – calculated gradi-
ent for the wellbore connections
in the specified range of well flow
sections
nection).
set_prop(key,con,x) Result LOGICAL Changes a connection property.
Returns true if the property was
key KEY DIAM – Connection diameter
INNERDIAM – Inner diameter of
annular connection
ROUGHNESS – Roughness
DPADD – Additional pressure
drop
RATEMULT – Rate multiplier for
hydraulics calculations
x REAL The new value for the connection
property.
set_prop(key,cl,x,mask) Result LOGICAL_1D Changes a connection property for
every connection in the list where
mask is true. Returns true for
each connection where the prop-
erty was changed, otherwise false.


annular connection
drop
x REAL The new value for the connection
property.
set_prop(key,cl,v,mask) Result LOGICAL_1D Changes a connection property for
every connection in the list where
mask is true. Returns true for
each connection where the prop-
erty was changed, otherwise false.
annular connection
drop
v REAL_1D A 1D array containing the new
values for the connection prop-
erty.
set_series_method(key, Result LOGICAL Changes a method used by every
con,i) connection in the linear series of
connections starting at the speci-
fied connection. Returns true if
the method was changed, other-
wise false.
key KEY BAT – Separator battery

PVT – PVT method
WAT – Water method


the case file).
set_series_method(key, Result LOGICAL_1D Changes the method used by
cl,iv,mask) every connection in the linear
series of connections starting at
the specified connection, for each
connection in the list where mask
is true. Returns true for each con-
nection where the method was
PVT – PVT method
iv INTEGER_1D A 1D array containing the method
index (corresponding to the
case file).
set_well_method(key, Result LOGICAL Changes a method used by a
well,i) well’s well connection, bottom
hole connection and wellbore.
Returns true if the method was
PVT – PVT method
the case file).
set_well_method(key,wl, Result LOGICAL_1D Changes the method used by a the
iv,mask) well connection, bottom hole con-
nection and wellbore, for each
well in the list where mask is true.
Returns true for each well where
the method was changed, other-
wise false.


PVT – PVT method
case file).
set_well_prop(key,well, Result LOGICAL Changes a property for a well’s
x) well connection and bottom hole
connection. Returns true if the
property was changed, otherwise
false.
annular connection
drop
WIMULT – The multiplier for the
well index.
PI – The well PI.
x REAL The new value for the property.
set_well_prop(key,wl,v, Result LOGICAL_1D Changes a property for the well
mask) connection and bottom hole con-
nection for every well in the list
where mask is true. Returns true
for each well where the property
was changed, otherwise false.


annular connection
drop
WIMULT – The multiplier for the
well index.
PI – The well PI.
v REAL_1D A 1D array containing the new
values for the property.
set_well_series_method Result LOGICAL Changes a method used by a
(key,well,i) well’s well connection, bottom
hole connection and wellbore, and
every connection in the linear
series of connections starting at
the well connection. Returns true
if the method was changed, other-
wise false.
PVT – PVT method
the case file).
set_well_series_method Result LOGICAL_1D Changes the method used by a the
(key,wl,iv,mask) well connection, bottom hole con-
nection and wellbore, and every
connection in the linear series of
connections starting at the well
connection, for each well in the
list where mask is true. Returns
true for each well where the
false.
PVT – PVT method


case file).
set_target(key,tgt,value) Result INTEGER Returns 1 if the target is changed.
key KEY VALUE or ADDVALUE
tgt TARGET The name of a target.
value REAL The new value for the target.
set_tgtcon(key,tgt,con, Result INTEGER Number of connections set
value)
key KEY QGUIDE – Guide rate
QMIN – Minimum rate
CALCMULT – Multiplier for cal-
culating target rate
QGUIDE – Guide rate
tgt TARGET The name of a target
value REAL The new value for the variable
specified by key
set_tgtcon(key,tgt,cl, Result INTEGER Number of connections set
value,mask)
culating target rate.
cl CONNECTION The name of a connection list.
value REAL The new value for the variable
specified by key
Applies to the connection list. I.e.
the value is only used for a con-
nection = cl(i) if mask(i) is true.

set_tgtcon(key,tgt,cl, Result INTEGER Number of connections set

value1d,mask)
cl CONNECTION The name of a connection list.
value1d REAL_1D The new values for the variable
specified by key. The value for
connection cl(i) is set to
value1d(i)
Applies to the connection list. I.e.
the value is only used for a con-
nection = cl(i) if mask(i) is true.
set_valve_setting(key, Result INTEGER The number of connections for
con) which the valve setting has been
changed.
key KEYWORD OPEN -open the valve if any of
the connection parameters which
apply to valves have been
exceeded.
CLOSE -close the valve if any of
exceeded.
The connection parameters which
apply to valves are:
WCUT_VALVE, WOR_VALVE,
GOR_VALVE, WGR_VALVE,
QO_VALVE, QG_VALVE or
QW_VALVE
set_valve_setting(key, Result INTEGER The number of connections for
con,value) which the valve setting has been
changed.

key KEYWORD ADJUST -adjust the valve setting

by the amount specified by value
if any of the connection parame-
ters which apply to valves have
been exceeded.
SET -change the valve setting to
the specified valueif any of the
connection parameters which
exceeded.
QW_VALVE
value REAL The value used when adjusting or
setting the valve setting. Can be
negative if the setting is being
adjusted.
set_valve_setting(key,cl) Result INTEGER The number of connections for
which the valve setting has been
changed.
exceeded.
exceeded.
QW_VALVE
cl CONLIST A connection listname
set_valve_setting(key,cl, Result INTEGER The number of connections for
value) which the valve setting has been
changed.


been exceeded.
exceeded.
QW_VALVE
adjusted.
mask) which the valve setting has been
changed.
exceeded.
exceeded.
QW_VALVE
Applies to any of the connections
in the connection list cl, where
mask is true.


value,mask) which the valve setting has been
changed.
been exceeded.
exceeded.
QW_VALVE
Applies to any of the connections
in the connection list cl, where
mask is true.
adjusted.
shutin(con,flag) Result INTEGER Shut in a connection. Returns 1 if
the connection is shut in, 0 if the
constraint was already shut in.
for reopening
shutin(cl,mask,flag) Result INTEGER Shut in connections in the connec-
tion list where the mask is true.
tions shut in.
for reopening

shutin(well,flag) Result INTEGER Shut in a well. Returns 1 if the

well is shut in, 0 if the well was
already shut in.
reopening
shutin(wl,mask,flag) Result INTEGER Shut in wells in the well list where
the mask is true. Returns the
number of wells shut in.
wl WELLLIST A connection list name
reopening
solve_network(printflag) Result None Solves for rates and pressures in
the network. Warning – This uses
a lot of cpu.
printflag LOGICAL Printout the network configura-
tion if it changes when printflag is
true
Solves for the potential rates and
pressures in the network. I.e the
solve_network_potential flow rates with all targets inactive.
(printflag) Result None Warning – This uses a lot of cpu.
Printout the network configura-
printflag LOGICAL true
update_network_config Result None Recalculates which connections
(printflag) and nodes are active
printflag LOGICAL Print out the network configura-
true
wag(key,ncycles,well) Result INTEGER The wag function initiates cycling
for the well specified. Each well
should only be included in one
call to a wag procedure at any
point in time. The result is 1 if the
well switches cycles (i.e switches
from water to gas injection or vice
versa), otherwise 0.

key KEYWORD Key is WW, WG, GW, GG, WS,

GS, The first letter specifies the
phase for the first cycle, W for
water and G for gas, and the sec-
ond letter specifies which phase to
inject after cycling, W for water,
G for gas and S for shut in.
ncycles INTEGER Ncycles is the number of cycles,
where one cycle means injection
of both a water slug and a gas
slug.
well WELL A well name.
wag(key, Result INTEGER The wag function initiates cycling
ncycles,welllist,mask) for the wells in the specified
welllist. Each well should only be
included in one call to a wag pro-
cedure at any point in time. The
result is the number of wells
which have switched cycles (i.e
wells which have switched from
water to gas injection or vice
versa).
slug.
welllist WELLLIST A well list.
mask LOGICAL_ID 1D array of logicals -- true or
false.

wag(key, result INTEGER The wag function initiates cycling

ncycles,mult,well) for the wells in the specified
welllist. Each well should only be
included in one call to a wag pro-
cedure at any point in time. The
result is the number of wells
which have switched cycles (i.e
wells which have switched from
water to gas injection or vice
versa).
slug.
mult REAL_1D Mult(1) multiplies the slug size
for the injection of the first phase,
mult(2) multiplies the slug size for
the injection of the second phase
etc. mult can be dimensioned less
than 2*ncycles, in which case all
multipliers not specified are taken
to be 1. E.g. to multiply sizes of
only the first water and gas slug,
by 0.5 the dimension of mult
should be 2, and set mult(1) = 0.5
and mult(2) = 0.5.
wag(key, result INTEGER The wag function initiates cycling
ncycles,mult, for the well specified. Each well
wellist,mask) should only be included in one
call to a wag procedure at any
point in time. The result is 1 if the
well switches cycles (i.e switches
from water to gas injection or vice
versa), otherwise 0.


slug.
mult REAL_ID Mult(1) multiplies the slug size
for the injection of the first phase,
mult(2) multiplies the slug size for
the injection of the second phase
etc. mult can be dimensioned less
than 2*ncycles, in which case all
multipliers not specified are taken
to be 1. E.g. to multiply sizes of
only the first water and gas slug,
by 0.5 the dimension of mult
should be 2, and set mult(1) = 0.5
and mult(2) = 0.5.
welllist WELLLIST A well list.
mask LOGICAL_ID 1D array of logicals -- true or
false.
Wcutback Result INTEGER Returns 1 if a rate cutback or rate
(key,well,value) cutback reversal processes is
applies, otherwise 0.

key KEYWORD OIL – rate cutback (or cutback

reversal) specified on OS (oil rate
at surface condition)
GAS – rate cutback (or cutback
reversal) specified on GS (gas rate
WAT– rate cutback (or cutback
reversal) specified on WS (water
rate at surface condition)
LIQ– rate cutback (or cutback
reversal) specified on LIQS (liq-
uid rate at surface condition)
apply to well cutback limits are:
WCUT_CB_MAX,
GOR_CB_MAX,
GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN.

value REAL The rate cutback factor or the ratio
of the reduced flow rate to the cur-
rent flow rate. Must be less than
1.0.
wcutback(key,wl,value) Result INTEGER The number of wells for which
either a rate cutback or a rate cut-
back reversal process is applied.


WCUT_CB_MAX,
GOR_CB_MAX,
GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN.
wl WELLIST The well list name.

value REAL OIL – rate cutback (or cutback

WCUT_CB_MAX,
GOR_CB_MAX,
GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN.
The rate cutback factor or the ratio
1.0.
wcut- Result INTEGER The number of wells for which
back(key,wl,value,mask) either a rate cutback or a rate cut-


WCUT_CB_MAX,
GOR_CB_MAX,
GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN.
wl WELLLIST A well list name.
1.0.
wcutback(key,con,value) Result INTEGER The number of wells for which


WCUT_CB_MAX,
GOR_CB_MAX,
GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN.
con CONNECTION A connection name.
1.0.
wcutback(key,cl,value) Result INTEGER The number of wells for which


WCUT_CB_MAX,
GOR_CB_MAX,
GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN.
cl CONLIST A connection list name.
1.0.
wcutback Result INTEGER The number of wells for which
(key,cl,value,mask) either a rate cutback or a rate cut-


apply to well cutback limits
are:WCUT_CB_MAX,
GOR_CB_MAX,
GLR_CB_MAX,
WGR_CB_MAX,
GBP_CB_MAX,
WCUT_CB_MIN,
WGR_CB_MIN or
GBP_CB_MIN.
cl CONLIST A connection list name.
1.0.
mask LOGICAL_ID 1D array of logicals (true or false).
well_valve(key,well) Result INTEGER The number of wells for which a
downhole valve setting has been
changed.
key KEYWORD CLOSE -close the worst offending
downhole valve if any of the con-
nection parameters which apply to
valves have been exceeded for the
well.
QW_VALVE

well_valve(key,well, Result INTEGER The number of wells for which a

value) downhole valve setting has been
changed.
key KEYWORD ADJUST -adjust the worst offend-
ing downhole valve setting by the
amount specified by value if any
of the connection parameters
which apply to valves have been
exceeded for the well.
QW_VALVE
setting the downhole valve set-
ting. Can be negative.
well_valve(key,wl) RESULT INTEGER The number of wells for which a
changed.
well.
QW_VALVE
well_valve(key,wl,value) Result INTEGER The number of wells for which a
changed.


QW_VALVE
well_valve(key,wl,mask) Result INTEGER The number of wells for which a
changed.
well.
QW_VALVE
Applies to any of the wells in the
well list wl, where mask is true.
well_valve(key,wl,value, Result INTEGER The number of wells for which a
mask) downhole valve setting has been
changed.


QW_VALVE
Applies to any of the wells in the
well list wl, where mask is true.
wcut_shut(cl,flag) Result INTEGER Shut in connections which have a
water cut greater than the value
specified for WCUT_SHUT in the
CONPARAM table. Returns the
number of connections shut in.
reopening
wgr_shut(cl,flag) Result INTEGER Shut in connections which have a
gas/water ratio greater than the
value specified for WGR_SHUT
tions shut in.
reopening

wplug RESULT INTEGER Close or plug-back a length of

(key,well,mask,value) well completion (perf) where
mask is true. Return the num-
ber of plug-backs which have
been performed. A plug-back
will not necessarily close an
entire connection. A connec-
tion is only closed when there
is no length of perforations
remaining open in the grid
block.
key KEYWORD TOP - plug-back to be applied
from the top of the open connec-
tions in the well.
BOTTOM - plug-back to be
applied from the bottom of the
open connections in the well.
value REAL Length of well completion (perf)
to be closed.
wplug(key,wl,mask2d, RESULT INTEGER Close or plug-back a length of
value,mask1d) well completion (perf) where
mask1d and mask2d are true.
Return the number of plug-backs
which have been performed. A
plug-back will not necessarily
close an entire connection. A con-
nection is only closed when there
is no length of perforations
remaining open in the grid block.
key KEYWORD TOP - plug-back to be applied
from the top of the open connec-
tions in the well.
BOTTOM - plug-back to be
applied from the bottom of the
open connections in the well.
wl WELLLIST A well list name.
mask2d LOGICAL_2D 2D array of logicals (true or false).
Applied to the completion for
each well, i.e. the plug-back is
only performed for well = wl(i) if
mask2d(j,i) is true.

value REAL Length of well completion (perf)

to be closed.
Applies to the well list, i.e. the
plug-back is only performed for
well = wl(i) if mask1d(i) is true.
wor_shut(cl,flag) Result INTEGER Shut in connections which have a
water/oil ratio greater than the
value specified for WOR_SHUT
tions shut in.
reopening
workover Result INTEGER Set the well completion (perf)
(key,well,mask,value) property to the value specified, for
each completion where mask is
true. Returns the number of com-
pletions which have changed.
key KEY PPERF – Partial perforation factor
SKIN – Skin
KH – Completion permeability-
thickness
WI – Completion well index
RADW – Completion wellbore
radius
value REAL New value for the completion
property
workover(key,well,mask, Result INTEGER Set the well completion (perf)
values) property to the value specified, for
each completion where mask is
true. Returns the number of com-
pletions which have changed.


SKIN – Skin
thickness
radius
values REAL_1D New values for the completion
property. The property for com-
pletion(i) is set to values(i).
(key,wl,mask2d, property to the value specified, for
value,mask1d) each completion where mask1d
and mask2d are true. Returns the
number of completions which
have changed.
SKIN – Skin
thickness
radius
Applies to the completion for each
well. I.e the workover is only per-
formed for completion j of well =
wl(i) if mask2d(j,i) is true
value REAL New value for the completion
property
Applies to the well list. I.e the
workover is only performed for
(key,wl,mask2d, property to the value specified, for
values,mask1d each completion where mask1d
and mask2d are true. Returns the
number of completions which
have changed.


SKIN – Skin
thickness
radius
Applies to the completion for each
well. I.e the workover is only per-
formed for completion j of well =
wl(i) if mask2d(j,i) is true
values REAL_2D The property for completion j of
well = wl(i) is set to values(i,j)
Applies to the well list. I.e the
workover is only performed for

Other Functions

get_dt(key) Result REAL Returns current timestep parameters
key KEY DT – Current time step size
MIN – Minimum time step size
MAX – Maximum time step size
QMAXPROD – QMAXPROD time
step size
QMAXINJ – QMAXINJ time step size
set_debug(key,t) Result None Turns debug printout on and off if time
>t
key KEY OFF – Turn off debug printout
MIN – Turn on minimum debug print-
out
MAX – Turn on maximum debug print-
out
t REAL Time
get_time(date) Result REAL Converts a date to a time in days (or
hours for LAB units)
date STRING A string containing a valid data e.g.
“01/01/2003”
set_log(key,t) Result None Turns log file output on or off if time > t
key KEY ON or OFF
t REAL Time
set_print(key,t) Result None Turns output of new constraints etc on
or off if time > t
key KEY ON or OFF
t REAL Time
set_dt(delt) Result None Sets time step size
delt REAL Time step size
set_dt(key,delt) Result None Sets time step size parameters
key KEY AUTO – Current time step size
MIN – Minimum time step size
MAX – Maximum time step size
QMAXPROD – QMAXPROD time
step size
QMAXINJ – QMAXINJ time step size
R5000.0.1 Procedures: Other Functions Description of Functions 583

delt REAL Time step size
584 Procedures: Other Functions Description of Functions R5000.0.1

Examples
Example 1. Simple Workovers
This examples works over wells when they exceed a water oil ratio of 2. When a well’s WOR
exceeds 2, all completion groups which have a WOR > 2 are plugged. The completion groups are
specified in the WELLSPEC table in the well file.
! List WELLS contains all wells whose names begin with P.
WELLLIST WELLS
P*
ENDWELLLIST
PROCS
LOGICAL_1D MASK1D
LOGICAL_2D MASK2D
MASK1D = WOR(WELLS,ALL1D) > 2.0

IF(ANY(MASK1D))THEN
! If any wells WOR exceeds 2, find all completion groups that exceed a ! WOR of
2
MASK2D = WOR("GROUP",WELLS,MASK1D) > 2.0
! Set the value of PPERF for all completion groups that exceed a WOR
! of 2 to zero (only in wells which have a WOR > 2)
WORKOVER("PPERF",WELLS,MASK2D,0.0,MASK1D)
ENDIF
ENDPROCS
R5000.0.1 Procedures: Other Functions Examples 585

Example 2. Drilling Queue
This examples activates wells, sets a pressure constraint and abandons the run when various con-
ditions are met.
WELLS
NAME STREAM BHDEPTH
P-1 PRODUCER 5000.0
P-2 PRODUCER 5000.0
P-3 PRODUCER 5000.0
P-4 PRODUCER 5000.0
P-5 PRODUCER 5000.0
P-6 PRODUCER 5000.0
P-7 PRODUCER 5000.0
ENDWELLS
NODES
NAME DEPTH
GATH 0.0
FIELD 0.0
ENDNODES
NODECON
NAME NODEIN NODEOUT
P-1 P-1 GATH
P-2 P-2 GATH
P-3 P-3 GATH
P-4 P-4 GATH
P-5 P-5 GATH
P-6 P-6 GATH
P-7 P-7 GATH
GATH GATH FIELD
FIELD FIELD SINK
ENDNODECON
WELLLIST welllist1
P*
ENDCONLIST
! Deactivate two or the wells
DEACTIVATE
CONNECTION
P-2
P-3
P-4
P-5
P-6
P-7
586 Procedures: Other Functions Examples R5000.0.1

ENDDEACTIVATE
CONSTRAINTS
FIELD PMIN 300.0
P* QOSMAX 999999.
ENDCONSTRAINTS
PROCS
INTEGER I = 0, J = 0
REAL X
X = Q("OS",FIELD)
IF(X < 400.0)THEN
! When surface oil rate at connection FIELD drops below 400 STB/D,
! activate the next well in WELLLIST1
I = ACTIVATE_NEXT(WELLLIST1,ALL1D)
IF(I == 0)THEN
! If no wells were activated, and the FIELD rate drops below 300 STB/D
! reduce the minimum pressure at node FIELD to 100 psi
IF(J == 0 AND X < 300.0)THEN

CONSTRAINT("PMIN",FIELD,100.0)
J = 1
ELSEIF(X < 200.0)THEN
! If no wells were activated, and the minimum pressure at node FIELD is

! already 100 psi, stop the run. No restart record is written.
ABANDON(FALSE)
ENDIF
ENDIF
ENDIF
ENDPROCS

Example 3. More complicated workover (Same network as example 2).
This example works over wells using the same criteria as example 2. However, the wells are first
shut in until one of the 3 workover rigs are available. The workovers take 30 days to complete.
PROCS
REAL_1D(2) RIG_TIMER = 30.0 ! dimensioned for 2 rigs

REAL_1D(7) WELL_TIMER = 9999999.0 ! dimensioned for 7 wells
INTEGER I = 0, J = 0
LOGICAL_1D MASK1, MASK2
MASK1 = WOR(WELLLIST1,ALL1D) > 2.0

DO 7 ! loop over the maximum number of wells
IF(ANY(MASK1,I))THEN
! If a wells WOR exceeds 2, store all completion groups with a WOR > 2
! shut in the well, and start a timer
! Note: This version of function ANY sets I to the index of the first
! true value of MASK1
MASK2 = WOR("GROUP",WELLLIST1(I)) > 2.0

WORKOVER("PPERF",WELLLIST1(I),MASK2,0.0)
CONSTRAINT("SHUTIN",WELLLIST1(I))
! Set the well timer to the earliest time well can reopen
WELL_TIMER(I) = TIME + 30.0
MASK1(I) = FALSE
ELSE
EXIT
ENDIF
ENDDO
DO 3 ! loop over the maximum number of rigs

IF(MINVAL(WELL_TIMER,I) <= TIME AND MINVAL(RIG_TIMER,J) <= TIME)THEN
! If a well can be reopened and a rig has had time to finish the
! workover, then reopen the well.
! Note: This version of MINVAL sets I to the index of the minimum
! value of WELL_TIMER
! remove all constraints
CONSTRAINT("RESET",WELLLIST1(I))
! set the maximum surface oil rate constraint
CONSTRAINT("QOSMAX",WELLLIST1(I),999999.0)

! reset the well timer for this well
WELL_TIMER(I) = 999999.0
! set the rig timer to the earliest time the rig can finish the next
! workover
RIG_TIMER(J) = TIME + 30.

ELSE
EXIT
ENDIF
ENDDO
Example 4. Another way to do Example 3.
PROCS
REAL_1D(2) RIG_TIMER = 30.0

REAL_1D(7) WELL_TIMER = 9999999.0
INTEGER I = 0
INT_1D ORDER1
LOGICAL_1D MASK1
LOGICAL_2D MASK2
MASK1 = WOR(WELLLIST1,ALL1D) > 2.0

IF(ANY(MASK1))THEN
! If a wells WOR exceeds 2, store all completion groups with a WOR > 2
! shut in the well, and start a timer
MASK2 = WOR("GROUP",WELLLIST1,MASK1) > 2.0

WORKOVER(“PPERF”,WELLLIST1,MASK2,0.0,MASK1)
CONSTRAINT("SHUTIN",WELLLIST1,MASK1)
SET_VALUE(WELL_TIMER,TIME + 30.0,MASK1)
ENDIF
I = COUNT(RIG_TIMER <= TIME)

MASK1 = WELL_TIMER <= TIME
I = MIN(I,COUNT(MASK1)) ! The number of wells to reopen
IF( I > 0)THEN
ORDER1 = ORDER(“INCR”,WELL_TIMER,ALL1D)
! MASK1 is TRUE for the first I wells shut in
MASK1 = ORDER1 <= I
! remove all constraints
CONSTRAINT(“RESET”,WELLLIST1,MASK1)
! set the maximum surface oil rate constraint
CONSTRAINT(“QOSMAX”,WELLLIST1,999999.0,MASK1)
! reset the well timer for this worked wells
SET_VALUE(WELL_TIMER,999999.0,MASK1)

! start the rig timer

ORDER1 = ORDER(“INCR”,RIG_TIMER,ALL1D)
MASK1 = ORDER1 <= I
SET_VALUE(RIG_TIMER,TIME + 30.0,MASK1)
ENDIF

Hydraulics Data
In This Chapter
• Hydraulics Data Using Oil Rates with Gas-Oil Ratios.
• Hydraulics Data Using Oil Rates with Gas-Liquid Ratios.
• Hydraulics Data Using Liquid Rates with Gas-Liquid ratios.
• Hydraulics Data Using Liquid Rates with Gas-Oil ratios.
• Hydraulics Data Using Gas Rates.
• Hydraulics Data Using Water Rates.
• Hydraulics Data Using Wet Gas Rates and Mean Molecular Weight.
• Hydraulics Table Extrapolation Limits
• Water Injection Hydraulics Correlation Data
All the data for a hydraulics method is input in a single file. Hydraulics files are included in a
case in the NET_METHOD_FILES section as follows:
NET_METHOD_FILES
HYD method 1 filename1
HYD method 2 filename2
....
R5000.0.1 Hydraulics Data: 591

Hydraulics Data Table Using Oil Rates With Gas-Oil Ratios
Hydraulics tables are specified as follows:
QOIL q1 q2 ...qn
GOR r1 r2 ...rm
WCUT c1 c2 ...ck
(ALQ alq1 alq2 ...alqj)
PIN or POUT or THP p1 p2 ...pl
(LENGTH length)
(DATUM datum_depth)
(DATGRAD GRAD or OILGRAD or GASGRAD or WATERGRAD)
(IGOR) (IWCUT) IQOIL (IALQ) (BHP(ITHP))
(ig1) (iw1) iq1 (ialq1) p(ip1) p(ip2)... p(ipl)
. . . . . . .
. . . . . . .
(ign) (iwm) iqk (ialqj) p(ip1) p(ip2)... p(ipl)
where:
QOIL Introduces the oil rates used in the hydraulics table. (STB/D, stm3/
D, stm3/D, stm3/D, cc/hour)
GOR Introduces the Gas/Oil ratios used in the hydraulics table. (MSCF/
STB, stm3/stm3, stm3/stm3, stm3/stm3, stcc/stcc)
Note: If the keyword BHP(ITHP) is present, then the units for

GOR are (SCF/STB, stm3/stm3, stm3/stm3, stm3/stm3, stcc/stcc).
This is provided for compatibility with existing VIP® data.
WCUT Introduces the water cuts used in the hydraulics table. (Fraction).
ALQ Introduces the artificial lift quantities used in the hydraulics table.
This is a setting which can be specified for each connection using
the hydraulics table.
PIN Introduces the pressures used in the hydraulics table at the inlet to
the tubing or pipe. The pressure values p(ip1) etc will be the
pressure at the outlet from the tubing or pipe. PIN corresponds to
the tubing head pressure for injection wells. (psia, kPaa, (Kg/cm2)a,
barsa, psia).
POUT Introduces the pressures used in the hydraulics table at the outlet
from the tubing or pipe. The pressure values p(ip1) etc will be the
pressure at the inlet to the tubing or pipe. POUT corresponds to the
592 Hydraulics Data: R5000.0.1

tubing head pressure for production wells. (psia, kPaa, (Kg/cm2)a,

barsa, psia)
THP Introduces the tubinghead pressure used in the hydraulics table.

This is for compatibility with existing VIP hydraulics tables, and
should only be used for production well tubing hydraulics. (psia,
kPaa, (Kg/cm2)a, barsa, psia)
LENGTH Introduces the tubing length for this table. If present, this can be
used to linearly scale the delta pressure for different tubing lengths.
(ft, m, m, m, cm)
DATUM Introduces the datum depth for the hydraulics table. The program
will account for any difference between the datum depth of the
table, and the bottom hole datum depth of the outlet from the tubing
(if PIN is specified), or the inlet to the tubing (if POUT is
specified), by a simple hydrostatic correction, using the method
specified by the DATGRAD keyword. If the outlet (or inlet) does
not have a datum depth specified, then the correction will be from
the datum depth, to the depth of the outlet (or inlet) node.
DATGRAD Introduces the method used to perform the hydrostatic correction if

a DATUM depth is input. GRAD specifies that the density of the
fluid flowing in the connection, evaluated at the pressure of the
outlet (or inlet) node, will be used. OILGRAD, GASGRAD and
WATERGRAD specify that the initial average density gradient of
the oil, gas or water phase will be used. Default: (see below)
The default DATGRAD is OILGRAD for the tables using Oil Rates
and Liquid Rates, GASGRAD for the tables using Gas Rates and
Wet Gas Rate, and WATERGRAD for the table using Water Rates.
Please add OILGRAD, GASGRAD or WATERGRAD as the
default as appropriate for each section.
IGOR Column heading keyword for the gas oil ratio index.
The gas oil ratio index corresponding to the ith gas oil ratio
(following the GOR keyword).
IWCUT Column heading keyword for the water cut index.
The water cut index corresponding to the ith water cut (following
the WCUT keyword).
IQOIL Column heading keyword for the oil rate index.
The oil rate index corresponding to the ith oil rate (following the
QOIL keywords).

IALQ Column heading keyword for the artificial lift quantity.
The artificial lift quantity index corresponding to the jth artificial

lift quantity (following the ALQ keyword).
BHP(ITHP) Provided for compatibility with existing VIP hydraulics data. This
keyword indicates that the units of the GOR data are (SCF/STB)
rather than MSCF/STB)
p(ipi) The pressure corresponding to the ith PIN or POUT pressure. (psia,
Notes:
For the well connection, the DATGRAD method specified on the WELLS table (which defaults to
the method specified by the DATUM keyword), is used for the datum adjustment, so that the cor-
rection from the table datum, and the bottom hole datum are performed using the same method.
Example:
DESC Hydraulics Data

QOIL 1.0 1000. 3000.
GOR 0.0 0.5 1.0 3.0
WCUT 0.0 0.2 0.4 0.6 0.95
POUT 100. 500. 900. 1400. 2000.
IGOR IWCUT IQOIL
1 1 1 2470. 2545. 2600. 2820. 3070.
1 1 2 2478. 2548. 2613. 2824. 3081.
1 1 3 2493. 2569. 2638. 2870. 3138.
1 2 1 2535. 2600. 2650. 2852. 3130.
1 2 2 2541. 2608. 2673. 2884. 3141.
1 2 3 2555. 2631. 2703. 2931. 3197.
1 3 1 2610. 2650. 2730. 2920. 3190.
1 3 2 2619. 2685. 2748. 2953. 3208.
1 3 3 2642. 2714. 2781. 2996. 3259.
1 4 1 2700. 2760. 2815. 3005. 3250.
1 4 2 2713. 2774. 2829. 3024. 3278.
1 4 3 2739. 2802. 2861. 3063. 3322.
1 5 1 2800. 2840. 2900. 3060. 3320.
1 5 2 2807. 2859. 2908. 3092. 3345.
1 5 3 2835. 2888. 2940. 3129. 3384.
2 1 1 1860. 1990. 2090. 2435. 2830.
2 1 2 1881. 2002. 2101. 2438. 2836.
2 1 3 1947. 2039. 2131. 2448. 2848.
2 2 1 1990. 2100. 2190. 2530. 2916.
2 2 2 2004. 2109. 2206. 2537. 2926.
2 2 3 2033. 2130. 2224. 2548. 2946.
2 3 1 2130. 2235. 2330. 2660. 3030.
2 3 2 2145. 2249. 2345. 2670. 3043.

2 3 3 2167. 2265. 2360. 2682. 3063.

2 4 1 2325. 2420. 2525. 2820. 3150.
2 4 2 2334. 2436. 2530. 2833. 3168.
2 4 3 2353. 2449. 2541. 2845. 3187.
2 5 1 2610. 2685. 2760. 2990. 3280.
2 5 2 2614. 2691. 2765. 3002. 3295.
2 5 3 2618. 2700. 2774. 3018. 3313.
3 1 1 1400. 1500. 1620. 2000. 2450.
3 1 2 1438. 1552. 1671. 2030. 2474.
3 1 3 1628. 1710. 1795. 2103. 2511.
3 2 1 1480. 1600. 1730. 2120. 2590.
3 2 2 1529. 1659. 1780. 2147. 2603.
3 2 3 1694. 1785. 1877. 2206. 2627.
3 3 1 1610. 1780. 1900. 2300. 2760.
3 3 2 1684. 1825. 1938. 2320. 2771.
3 3 3 1821. 1920. 2017. 2358. 2786.
3 4 1 1920. 2040. 2170. 2555. 2975.
3 4 2 1950. 2074. 2189. 2565. 2980.
3 4 3 2031. 2134. 2234. 2578. 2988.
3 5 1 2370. 2480. 2570. 2860. 3200.
3 5 2 2376. 2482. 2576. 2868. 3205.
3 5 3 2386. 2486. 2580. 2874. 3211.
4 1 1 800. 900. 1100. 1475. 1900.
4 1 2 1067. 1148. 1235. 1554. 1970.
4 1 3 1400. 1466. 1533. 1796. 2148.
4 2 1 900. 1050. 1150. 1560. 2000.
4 2 2 1088. 1167. 1258. 1617. 2060.
4 2 3 1427. 1490. 1559. 1834. 2209.
4 3 1 1000. 1100. 1220. 1650. 2100.
4 3 2 1153. 1241. 1345. 1745. 2221.
4 3 3 1469. 1541. 1619. 1922. 2329.
4 4 1 1280. 1350. 1500. 1960. 2490.
4 4 2 1333. 1453. 1581. 2004. 2508.
4 4 3 1594. 1681. 1772. 2113. 2557.
4 5 1 1800. 1940. 2080. 2500. 2935.
4 5 2 1853. 1981. 2106. 2512. 2941.
4 5 3 1966. 2070. 2175. 2535. 2950.

Hydraulics Data Table Using Oil Rates With Gas-Liquid

Ratios
QOIL q1 q2 ... qn
GLR r1 r2 ... rm
WCUT c1 c2 ... ck
(ALQ alq1 alq2 ... alqj)
PIN or POUT or THP p1 p2 ... pl
(LENGTH length)
(DATUM datum_depth)
(IGLR) (IWCUT) IQOIL (IALQ) (BHP(ITHP))

. . . . . . .
. . . . . . .
where:
QOIL Introduces the oil rates used in the hydraulics table. (STB/D, stm3/
D, stm3/D, stm3/D, stcc/hour)
GLR Introduces the Gas/Liquid ratios used in the hydraulics table.

(MSCF/STB, stm3/stm3, stm3/stm, stm3/stm, stcc/stcc)
Note: If the keyword BHP(ITHP) is present, then the units for GLR
are (SCF/STB, stm3/stm3, stm3/stm3, stm3/stm3, stcc/stcc). This is
provided for compatibility with existing VIP data.
barsa, psia).


barsa, psia)

should only be used for production well tubing hydraulics.
(ft, m, m, m, cm).
DATGRAD Introduces the method used to perform the hydrostatic correction is

IGLR Column heading keyword for the gas liquid ratio index.
The gas liquid ratio index corresponding to the ith gas liquid ratio
(following the GLR keyword).
the WCUT keyword).
IQOIL Column heading keyword for the oil rate index.
The oil rate index corresponding to the ith oil rate (following the
QOIL keywords).


keyword indicates that the units of the GLR data are (SCF/STB)
rather than (MSCF/STB)
Example:

QOIL 1.0 1000. 3000.
GLR 0.0 0.5 1.0 3.0
WCUT 0.0 0.2 0.4 0.6 0.95
POUT 100. 500. 900. 1400. 2000.
IGLR IWCUT IQOIL
1 1 1 2470. 2545. 2600. 2820. 3070.
1 1 2 2478. 2548. 2613. 2824. 3081.
1 1 3 2493. 2569. 2638. 2870. 3138.
1 2 1 2535. 2600. 2650. 2852. 3130.
1 2 2 2541. 2608. 2673. 2884. 3141.
1 2 3 2555. 2631. 2703. 2931. 3197.
1 3 1 2610. 2650. 2730. 2920. 3190.
1 3 2 2619. 2685. 2748. 2953. 3208.
1 3 3 2642. 2714. 2781. 2996. 3259.
1 4 1 2700. 2760. 2815. 3005. 3250.
1 4 2 2713. 2774. 2829. 3024. 3278.
1 4 3 2739. 2802. 2861. 3063. 3322.
1 5 1 2800. 2840. 2900. 3060. 3320.
1 5 2 2807. 2859. 2908. 3092. 3345.
1 5 3 2835. 2888. 2940. 3129. 3384.
2 1 1 1860. 1990. 2090. 2435. 2830.
2 1 2 1881. 2002. 2101. 2438. 2836.
2 1 3 1947. 2039. 2131. 2448. 2848.
2 2 1 1990. 2100. 2190. 2530. 2916.
2 2 2 2004. 2109. 2206. 2537. 2926.
2 2 3 2033. 2130. 2224. 2548. 2946.
2 3 1 2130. 2235. 2330. 2660. 3030.
2 3 2 2145. 2249. 2345. 2670. 3043.
2 3 3 2167. 2265. 2360. 2682. 3063.
2 4 1 2325. 2420. 2525. 2820. 3150.
2 4 2 2334. 2436. 2530. 2833. 3168.
2 4 3 2353. 2449. 2541. 2845. 3187.
2 5 1 2610. 2685. 2760. 2990. 3280.
2 5 2 2614. 2691. 2765. 3002. 3295.

2 5 3 2618. 2700. 2774. 3018. 3313.

3 1 1 1400. 1500. 1620. 2000. 2450.
3 1 2 1438. 1552. 1671. 2030. 2474.
3 1 3 1628. 1710. 1795. 2103. 2511.
3 2 1 1480. 1600. 1730. 2120. 2590.
3 2 2 1529. 1659. 1780. 2147. 2603.
3 2 3 1694. 1785. 1877. 2206. 2627.
3 3 1 1610. 1780. 1900. 2300. 2760.
3 3 2 1684. 1825. 1938. 2320. 2771.
3 3 3 1821. 1920. 2017. 2358. 2786.
3 4 1 1920. 2040. 2170. 2555. 2975.
3 4 2 1950. 2074. 2189. 2565. 2980.
3 4 3 2031. 2134. 2234. 2578. 2988.
3 5 1 2370. 2480. 2570. 2860. 3200.
3 5 2 2376. 2482. 2576. 2868. 3205.
3 5 3 2386. 2486. 2580. 2874. 3211.
4 1 1 800. 900. 1100. 1475. 1900.
4 1 2 1067. 1148. 1235. 1554. 1970.
4 1 3 1400. 1466. 1533. 1796. 2148.
4 2 1 900. 1050. 1150. 1560. 2000.
4 2 2 1088. 1167. 1258. 1617. 2060.
4 2 3 1427. 1490. 1559. 1834. 2209.
4 3 1 1000. 1100. 1220. 1650. 2100.
4 3 2 1153. 1241. 1345. 1745. 2221.
4 3 3 1469. 1541. 1619. 1922. 2329.
4 4 1 1280. 1350. 1500. 1960. 2490.
4 4 2 1333. 1453. 1581. 2004. 2508.
4 4 3 1594. 1681. 1772. 2113. 2557.
4 5 1 1800. 1940. 2080. 2500. 2935.
4 5 2 1853. 1981. 2106. 2512. 2941.
4 5 3 1966. 2070. 2175. 2535. 2950.

Hydraulics Data Table Using Liquid Rates With Gas-Liquid

Ratios
QLIQ q1 q2 ... qn
GLR r1 r2 ... rm
WCUT c1 c2 ... ck
(LENGTH) length
(DATUM datum_depth)
(IGLR) (IWCUT) IQLIQ (IALQ) (BHP(ITHP))

. . . . . . .
. . . . . . .
where:
QLIQ Introduces the liquid rates used in the hydraulics table. (STB/D,
stm3/D, stm3/D, stm3/D, stcc/hour)
GLR Introduces the Gas/Liquid ratios used in the hydraulics table.

(MSCF/STB, stm3/stm3, stm3/stm, stm3/stm3, stcc/stcc)
Note: If the keyword BHP(ITHP) is present, then the units for GLR
are (SCF/STB, stm3/stm3, stm3/stm, stm3/stm3, stcc/stcc). This is
provided for compatibility with existing VIP data.
WCUT Introduces the water cuts used in the hydraulics table.
barsa, psia)


barsa, psia)

(ft, m, m, m, cm)

the oil, gas or water phase will be used.
Default: (see below)
IGLR Column heading keyword for the gas liquid ratio index.
(following the GLR keyword).
the WCUT keyword).
IQLIQ Column heading keyword for the liquid rate index.

The liquid rate index corresponding to the ith liquid rate (following
the QLIQ keywords).

keyword indicates that the units of the GLR data are (SCF/STB)
The pressure corresponding to the ith PIN or POUT pressure. (psia,

Example:

QLIQ 1.0 1000. 3000.
GLR 0.0 0.5 1.0 3.0
WCUT 0.0 0.2 0.4 0.6 0.95
POUT 100. 500. 900. 1400. 2000.
IGLR IWCUT IQLIQ
1 1 1 2470. 2545. 2600. 2820. 3070.
1 1 2 2478. 2548. 2613. 2824. 3081.
1 1 3 2493. 2569. 2638. 2870. 3138.
1 2 1 2535. 2600. 2650. 2852. 3130.
1 2 2 2541. 2608. 2673. 2884. 3141.
1 2 3 2555. 2631. 2703. 2931. 3197.
1 3 1 2610. 2650. 2730. 2920. 3190.
1 3 2 2619. 2685. 2748. 2953. 3208.
1 3 3 2642. 2714. 2781. 2996. 3259.
1 4 1 2700. 2760. 2815. 3005. 3250.
1 4 2 2713. 2774. 2829. 3024. 3278.
1 4 3 2739. 2802. 2861. 3063. 3322.
1 5 1 2800. 2840. 2900. 3060. 3320.
1 5 2 2807. 2859. 2908. 3092. 3345.
1 5 3 2835. 2888. 2940. 3129. 3384.
2 1 1 1860. 1990. 2090. 2435. 2830.
2 1 2 1881. 2002. 2101. 2438. 2836.
2 1 3 1947. 2039. 2131. 2448. 2848.
2 2 1 1990. 2100. 2190. 2530. 2916.
2 2 2 2004. 2109. 2206. 2537. 2926.
2 2 3 2033. 2130. 2224. 2548. 2946.
2 3 1 2130. 2235. 2330. 2660. 3030.
2 3 2 2145. 2249. 2345. 2670. 3043.

2 3 3 2167. 2265. 2360. 2682. 3063.

2 4 1 2325. 2420. 2525. 2820. 3150.
2 4 2 2334. 2436. 2530. 2833. 3168.
2 4 3 2353. 2449. 2541. 2845. 3187.
2 5 1 2610. 2685. 2760. 2990. 3280.
2 5 2 2614. 2691. 2765. 3002. 3295.
2 5 3 2618. 2700. 2774. 3018. 3313.
3 1 1 1400. 1500. 1620. 2000. 2450.
3 1 2 1438. 1552. 1671. 2030. 2474.
3 1 3 1628. 1710. 1795. 2103. 2511.
3 2 1 1480. 1600. 1730. 2120. 2590.
3 2 2 1529. 1659. 1780. 2147. 2603.
3 2 3 1694. 1785. 1877. 2206. 2627.
3 3 1 1610. 1780. 1900. 2300. 2760.
3 3 2 1684. 1825. 1938. 2320. 2771.
3 3 3 1821. 1920. 2017. 2358. 2786.
3 4 1 1920. 2040. 2170. 2555. 2975.
3 4 2 1950. 2074. 2189. 2565. 2980.
3 4 3 2031. 2134. 2234. 2578. 2988.
3 5 1 2370. 2480. 2570. 2860. 3200.
3 5 2 2376. 2482. 2576. 2868. 3205.
3 5 3 2386. 2486. 2580. 2874. 3211.
4 1 1 800. 900. 1100. 1475. 1900.
4 1 2 1067. 1148. 1235. 1554. 1970.
4 1 3 1400. 1466. 1533. 1796. 2148.
4 2 1 900. 1050. 1150. 1560. 2000.
4 2 2 1088. 1167. 1258. 1617. 2060.
4 2 3 1427. 1490. 1559. 1834. 2209.
4 3 1 1000. 1100. 1220. 1650. 2100.
4 3 2 1153. 1241. 1345. 1745. 2221.
4 3 3 1469. 1541. 1619. 1922. 2329.
4 4 1 1280. 1350. 1500. 1960. 2490.
4 4 2 1333. 1453. 1581. 2004. 2508.
4 4 3 1594. 1681. 1772. 2113. 2557.
4 5 1 1800. 1940. 2080. 2500. 2935.
4 5 2 1853. 1981. 2106. 2512. 2941.
4 5 3 1966. 2070. 2175. 2535. 2950.

Hydraulics Data Table Using Liquid Rates With Gas-Oil

Ratios
QLIQ q1 q2 ... qn
GOR r1 r2 ... rm
WCUT c1 c2 ... ck
(LENGTH) length
(DATUM datum_depth)
(IGOR) (IWCUT) IQLIQ (IALQ) (BHP(ITHP))

. . . . . . .
. . . . . . .
where:
QLIQ Introduces the liquid rates used in the hydraulics table. (STB/D,
GOR Introduces the Gas/Oil ratios used in the hydraulics table. (MSCF/
STB, stm3/stm3, stm3/stm3, stm3/stm3, stcc/stcc)

GOR are (SCF/STB, stm3/stm3, stm3/stm3, stm3/stm3, stcc/stcc).
This is provided for compatibility with existing VIP data.
barsa, psia)


barsa, psia)

(ft, m, m, m, cm)

IGOR Column heading keyword for the gas oil ratio index.
The gas oil ratio index corresponding to the ith gas oil ratio
(following the GOR keyword).
the WCUT keyword).
IQLIQ Column heading keyword for the liquid rate index.

The liquid rate index corresponding to the ith liquid rate (following
the QLIQ keywords).

keyword indicates that the units of the GOR data are (SCF/STB)
rather than (MSCF/STB

p(ipi) The pressure corresponding to the ith PIN or POUT pressure.
Example:

QLIQ 1.0 1000. 3000.
GOR 0.0 0.5 1.0 3.0
WCUT 0.0 0.2 0.4 0.6 0.95
POUT 100. 500. 900. 1400. 2000.
IGOR IWCUT IQLIQ
1 1 1 2470. 2545. 2600. 2820. 3070.
1 1 2 2478. 2548. 2613. 2824. 3081.
1 1 3 2493. 2569. 2638. 2870. 3138.
1 2 1 2535. 2600. 2650. 2852. 3130.
1 2 2 2541. 2608. 2673. 2884. 3141.
1 2 3 2555. 2631. 2703. 2931. 3197.
1 3 1 2610. 2650. 2730. 2920. 3190.
1 3 2 2619. 2685. 2748. 2953. 3208.
1 3 3 2642. 2714. 2781. 2996. 3259.
1 4 1 2700. 2760. 2815. 3005. 3250.
1 4 2 2713. 2774. 2829. 3024. 3278.
1 4 3 2739. 2802. 2861. 3063. 3322.
1 5 1 2800. 2840. 2900. 3060. 3320.
1 5 2 2807. 2859. 2908. 3092. 3345.
1 5 3 2835. 2888. 2940. 3129. 3384.
2 1 1 1860. 1990. 2090. 2435. 2830.
2 1 2 1881. 2002. 2101. 2438. 2836.
2 1 3 1947. 2039. 2131. 2448. 2848.
2 2 1 1990. 2100. 2190. 2530. 2916.
2 2 2 2004. 2109. 2206. 2537. 2926.
2 2 3 2033. 2130. 2224. 2548. 2946.
2 3 1 2130. 2235. 2330. 2660. 3030.
2 3 2 2145. 2249. 2345. 2670. 3043.
2 3 3 2167. 2265. 2360. 2682. 3063.

2 4 1 2325. 2420. 2525. 2820. 3150.

2 4 2 2334. 2436. 2530. 2833. 3168.
2 4 3 2353. 2449. 2541. 2845. 3187.
2 5 1 2610. 2685. 2760. 2990. 3280.
2 5 2 2614. 2691. 2765. 3002. 3295.
2 5 3 2618. 2700. 2774. 3018. 3313.
3 1 1 1400. 1500. 1620. 2000. 2450.
3 1 2 1438. 1552. 1671. 2030. 2474.
3 1 3 1628. 1710. 1795. 2103. 2511.
3 2 1 1480. 1600. 1730. 2120. 2590.
3 2 2 1529. 1659. 1780. 2147. 2603.
3 2 3 1694. 1785. 1877. 2206. 2627.
3 3 1 1610. 1780. 1900. 2300. 2760.
3 3 2 1684. 1825. 1938. 2320. 2771.
3 3 3 1821. 1920. 2017. 2358. 2786.
3 4 1 1920. 2040. 2170. 2555. 2975.
3 4 2 1950. 2074. 2189. 2565. 2980.
3 4 3 2031. 2134. 2234. 2578. 2988.
3 5 1 2370. 2480. 2570. 2860. 3200.
3 5 2 2376. 2482. 2576. 2868. 3205.
3 5 3 2386. 2486. 2580. 2874. 3211.
4 1 1 800. 900. 1100. 1475. 1900.
4 1 2 1067. 1148. 1235. 1554. 1970.
4 1 3 1400. 1466. 1533. 1796. 2148.
4 2 1 900. 1050. 1150. 1560. 2000.
4 2 2 1088. 1167. 1258. 1617. 2060.
4 2 3 1427. 1490. 1559. 1834. 2209.
4 3 1 1000. 1100. 1220. 1650. 2100.
4 3 2 1153. 1241. 1345. 1745. 2221.
4 3 3 1469. 1541. 1619. 1922. 2329.
4 4 1 1280. 1350. 1500. 1960. 2490.
4 4 2 1333. 1453. 1581. 2004. 2508.
4 4 3 1594. 1681. 1772. 2113. 2557.
4 5 1 1800. 1940. 2080. 2500. 2935.
4 5 2 1853. 1981. 2106. 2512. 2941.
4 5 3 1966. 2070. 2175. 2535. 2950.

Hydraulics Data Table Using Gas Rates
QGAS q1 q2 ... qn
OGR r1 r2 ... rm
WGR c1 c2 ... ck
(LENGTH length)
(DATUM datum_depth)
(IOGR) (IWGR) IQGAS (IALQ) (BHP(ITHP))

(io1) (iw1) iq1 (ialq1) p(ip1) p(ip2)... p(ipl)
. . . . . . .
. . . . . . .
(ion) (iwm) iqk (ialqj) p(ip1) p(ip2)... p(ipl)
where:
QGAS Introduces the gas rates used in the hydraulics table. (MSCF/D,
OGR Introduces the Oil/Gas ratios used in the hydraulics table. (STB/
MSCF, stm3/stm3, stm3/stm, stm3/stm, stcc/stcc)

OGR are (bbl/mmscf). This is provided for compatibility with
existing VIP data.
WGR Introduces the Water/Gas ratios used in the hydraulics table. (STB/
MSCF, stm3/stm3, stm3/stm, stm3/stm, stcc/stcc)

WGR are (bbl/mmscf). This is provided for compatibility with
existing VIP data.
barsa, psia)

barsa, psia)

(ft, m, m, m, cm)

IOGR Column heading keyword for the oil gas ratio index.
(following the OGR keyword).
IWGR Column heading keyword for the water gas ratio index.
The water gas ratio index corresponding to the ith water gas ratio
(following the WGR keyword).

IQGAS Column heading keyword for the gas rate index.
The gas rate index corresponding to the ith gas rate (following the
QGAS keywords).

keyword indicates that the units of the OGR and WGR data are
(STB/MMSCF) rather than (STB/MSCF)

Example:

QGAS 1.0 1000. 3000.
OGR 0.0 0.5 1.0 3.0
WGR 0.0 0.2 0.4 0.6 0.95
POUT 100. 500. 900. 1400. 2000.
IOGR IWGR IQGAS
1 1 1 2470. 2545. 2600. 2820. 3070.
1 1 2 2478. 2548. 2613. 2824. 3081.
1 1 3 2493. 2569. 2638. 2870. 3138.
1 2 1 2535. 2600. 2650. 2852. 3130.
1 2 2 2541. 2608. 2673. 2884. 3141.
1 2 3 2555. 2631. 2703. 2931. 3197.
1 3 1 2610. 2650. 2730. 2920. 3190.
1 3 2 2619. 2685. 2748. 2953. 3208.
1 3 3 2642. 2714. 2781. 2996. 3259.
1 4 1 2700. 2760. 2815. 3005. 3250.
1 4 2 2713. 2774. 2829. 3024. 3278.
1 4 3 2739. 2802. 2861. 3063. 3322.
1 5 1 2800. 2840. 2900. 3060. 3320.
1 5 2 2807. 2859. 2908. 3092. 3345.
1 5 3 2835. 2888. 2940. 3129. 3384.
2 1 1 1860. 1990. 2090. 2435. 2830.
2 1 2 1881. 2002. 2101. 2438. 2836.
2 1 3 1947. 2039. 2131. 2448. 2848.
2 2 1 1990. 2100. 2190. 2530. 2916.
2 2 2 2004. 2109. 2206. 2537. 2926.
2 2 3 2033. 2130. 2224. 2548. 2946.
2 3 1 2130. 2235. 2330. 2660. 3030.

2 3 2 2145. 2249. 2345. 2670. 3043.

2 3 3 2167. 2265. 2360. 2682. 3063.
2 4 1 2325. 2420. 2525. 2820. 3150.
2 4 2 2334. 2436. 2530. 2833. 3168.
2 4 3 2353. 2449. 2541. 2845. 3187.
2 5 1 2610. 2685. 2760. 2990. 3280.
2 5 2 2614. 2691. 2765. 3002. 3295.
2 5 3 2618. 2700. 2774. 3018. 3313.
3 1 1 1400. 1500. 1620. 2000. 2450.
3 1 2 1438. 1552. 1671. 2030. 2474.
3 1 3 1628. 1710. 1795. 2103. 2511.
3 2 1 1480. 1600. 1730. 2120. 2590.
3 2 2 1529. 1659. 1780. 2147. 2603.
3 2 3 1694. 1785. 1877. 2206. 2627.
3 3 1 1610. 1780. 1900. 2300. 2760.
3 3 2 1684. 1825. 1938. 2320. 2771.
3 3 3 1821. 1920. 2017. 2358. 2786.
3 4 1 1920. 2040. 2170. 2555. 2975.
3 4 2 1950. 2074. 2189. 2565. 2980.
3 4 3 2031. 2134. 2234. 2578. 2988.
3 5 1 2370. 2480. 2570. 2860. 3200.
3 5 2 2376. 2482. 2576. 2868. 3205.
3 5 3 2386. 2486. 2580. 2874. 3211.
4 1 1 800. 900. 1100. 1475. 1900.
4 1 2 1067. 1148. 1235. 1554. 1970.
4 1 3 1400. 1466. 1533. 1796. 2148.
4 2 1 900. 1050. 1150. 1560. 2000.
4 2 2 1088. 1167. 1258. 1617. 2060.
4 2 3 1427. 1490. 1559. 1834. 2209.
4 3 1 1000. 1100. 1220. 1650. 2100.
4 3 2 1153. 1241. 1345. 1745. 2221.
4 3 3 1469. 1541. 1619. 1922. 2329.
4 4 1 1280. 1350. 1500. 1960. 2490.
4 4 2 1333. 1453. 1581. 2004. 2508.
4 4 3 1594. 1681. 1772. 2113. 2557.
4 5 1 1800. 1940. 2080. 2500. 2935.
4 5 2 1853. 1981. 2106. 2512. 2941.
4 5 3 1966. 2070. 2175. 2535. 2950.

Hydraulics Data Table Using Water Rates
QWAT q1 q2 ... qn
GWR r1 r2 ... rm
OCUT c1 c2 ... ck
(LENGTH length)
(DATUM datum_depth)
(IGWR) (IOCUT) IQWAT (IALQ) (BHP(ITHP))

(ig1) (io1) iq1 (ialq1) p(ip1) p(ip2)... p(ipl)
. . . . . . .
. . . . . . .
(ign) (iom) iqk (ialqj) p(ip1) p(ip2)... p(ipl)
where:
QWAT Introduces the water rates used in the hydraulics table. (STB/D,
GWR Introduces the Gas/Water ratios used in the hydraulics table.

(MSCF/STB, stm3/stm3, stm3/stm3, stm3/stm3, stcc/stcc)

GWR are (SCF/STB, stm3/stm3, stm3/stm3, stm3/stm3, stcc/stcc).
This is provided for compatibility with existing VIP data.
OCUT Introduces the oil cut used in the hydraulics table.
barsa, psia)


barsa, psia)

(ft, m, m, m, cm)

IGWR Column heading keyword for the gas/water ratio index.
The gas water ratio index corresponding to the ith gas water ratio
(following the GWR keyword).
IOCUT Column heading keyword for the oil cut index.
The oil cut index corresponding to the ith oil cut (following the
OCUT keyword).
IQWAT Column heading keyword for the water rate index.
The water rate index corresponding to the ith water rate (following
the QWAT keywords).


keyword indicates that the units of the GWR data are (SCF/STB

Example:

QWAT 1.0 1000. 3000.
GWR 0.0 0.5 1.0 3.0
OCUT 0.0 0.2 0.4 0.6 0.95
POUT 100. 500. 900. 1400. 2000.
IGWR IOCUT IQWAT
1 1 1 2470. 2545. 2600. 2820. 3070.
1 1 2 2478. 2548. 2613. 2824. 3081.
1 1 3 2493. 2569. 2638. 2870. 3138.
1 2 1 2535. 2600. 2650. 2852. 3130.
1 2 2 2541. 2608. 2673. 2884. 3141.
1 2 3 2555. 2631. 2703. 2931. 3197.
1 3 1 2610. 2650. 2730. 2920. 3190.
1 3 2 2619. 2685. 2748. 2953. 3208.
1 3 3 2642. 2714. 2781. 2996. 3259.
1 4 1 2700. 2760. 2815. 3005. 3250.
1 4 2 2713. 2774. 2829. 3024. 3278.
1 4 3 2739. 2802. 2861. 3063. 3322.
1 5 1 2800. 2840. 2900. 3060. 3320.
1 5 2 2807. 2859. 2908. 3092. 3345.
1 5 3 2835. 2888. 2940. 3129. 3384.
2 1 1 1860. 1990. 2090. 2435. 2830.
2 1 2 1881. 2002. 2101. 2438. 2836.
2 1 3 1947. 2039. 2131. 2448. 2848.
2 2 1 1990. 2100. 2190. 2530. 2916.
2 2 2 2004. 2109. 2206. 2537. 2926.
2 2 3 2033. 2130. 2224. 2548. 2946.
2 3 1 2130. 2235. 2330. 2660. 3030.
2 3 2 2145. 2249. 2345. 2670. 3043.
2 3 3 2167. 2265. 2360. 2682. 3063.
2 4 1 2325. 2420. 2525. 2820. 3150.
2 4 2 2334. 2436. 2530. 2833. 3168.
2 4 3 2353. 2449. 2541. 2845. 3187.

2 5 1 2610. 2685. 2760. 2990. 3280.

2 5 2 2614. 2691. 2765. 3002. 3295.
2 5 3 2618. 2700. 2774. 3018. 3313.
3 1 1 1400. 1500. 1620. 2000. 2450.
3 1 2 1438. 1552. 1671. 2030. 2474.
3 1 3 1628. 1710. 1795. 2103. 2511.
3 2 1 1480. 1600. 1730. 2120. 2590.
3 2 2 1529. 1659. 1780. 2147. 2603.
3 2 3 1694. 1785. 1877. 2206. 2627.
3 3 1 1610. 1780. 1900. 2300. 2760.
3 3 2 1684. 1825. 1938. 2320. 2771.
3 3 3 1821. 1920. 2017. 2358. 2786.
3 4 1 1920. 2040. 2170. 2555. 2975.
3 4 2 1950. 2074. 2189. 2565. 2980.
3 4 3 2031. 2134. 2234. 2578. 2988.
3 5 1 2370. 2480. 2570. 2860. 3200.
3 5 2 2376. 2482. 2576. 2868. 3205.
3 5 3 2386. 2486. 2580. 2874. 3211.
4 1 1 800. 900. 1100. 1475. 1900.
4 1 2 1067. 1148. 1235. 1554. 1970.
4 1 3 1400. 1466. 1533. 1796. 2148.
4 2 1 900. 1050. 1150. 1560. 2000.
4 2 2 1088. 1167. 1258. 1617. 2060.
4 2 3 1427. 1490. 1559. 1834. 2209.
4 3 1 1000. 1100. 1220. 1650. 2100.
4 3 2 1153. 1241. 1345. 1745. 2221.
4 3 3 1469. 1541. 1619. 1922. 2329.
4 4 1 1280. 1350. 1500. 1960. 2490.
4 4 2 1333. 1453. 1581. 2004. 2508.
4 4 3 1594. 1681. 1772. 2113. 2557.
4 5 1 1800. 1940. 2080. 2500. 2935.
4 5 2 1853. 1981. 2106. 2512. 2941.
4 5 3 1966. 2070. 2175. 2535. 2950.

Hydraulics Data Table Using Wet Gas Rates and Mean

Molecular Weights
QWGAS q1 q2 ... qn
MMW r1 r2 ... rm
WWGR c1 c2 ... ck
(LENGTH length)
(DATUM datum_depth)
(IMMW) (IWWGR) IQWGAS(IALQ)(BHP(ITHP))

(im1) (iw1) iq1 (ialq1) p(ip1) p(ip2)... p(ipl)
. . . . . . .
. . . . . . .
(imn) (iwm) iqk (ialqj) p(ip1) p(ip2)... p(ipl)
where:
QWGAS Introduces the wet gas rates used in the hydraulics table. (MSCF/
D, m3/D, m3/D, m3/D, cc/Hour)
MMW Introduces the mean molecular weights used in the hydraulics table.
WWGR Introduces the Water/Wet Gas ratios used in the hydraulics table.

WWGR are (STB/MMSCF) for the ENGLISH unit system.
barsa, psia)


barsa, psia)

(ft, m, m, m, cm)

IMMW Column heading keyword for the mean molecular weight index.
imi The mean molecular weight index corresponding to the ith mean
molecular weight (following the MMW keyword).
IWWGR Column heading keyword for the water/wet gas ratio index. (BBL/
STB, m3/m3, m3/m3, m3/m3, cc/cc)
iwi The water/wetgas ratio index corresponding to the ith water/wet gas
ratio (following the WWGR keyword).
IQWGAS Column heading keyword for the wet gas rate index.

iqi The wet gas rate index corresponding to the ith wet gas rate
(following the QWGAS keywords).
ialqj The artificial lift quantity index corresponding to the jth artificial
keyword indicates that the units of the WWGR data are (bbl/
mmscf) rather than (bbl/mcf).

(psia)
Notes:
1. Hydraulics tables of this form are only applicable to EOS runs.
Example:

QWGAS 1.0 1000. 3000.
MMW 20.0 40.0 60.0 80.0
WWGR 0.0 0.2 0.4 0.6 0.95
POUT 100. 500. 900. 1400. 2000.
IMMW IWWGR IQWGAS
1 1 1 2470. 2545. 2600. 2820. 3070.
1 1 2 2478. 2548. 2613. 2824. 3081.
1 1 3 2493. 2569. 2638. 2870. 3138.
1 2 1 2535. 2600. 2650. 2852. 3130.
1 2 2 2541. 2608. 2673. 2884. 3141.
1 2 3 2555. 2631. 2703. 2931. 3197.
1 3 1 2610. 2650. 2730. 2920. 3190.
1 3 2 2619. 2685. 2748. 2953. 3208.
1 3 3 2642. 2714. 2781. 2996. 3259.
1 4 1 2700. 2760. 2815. 3005. 3250.
1 4 2 2713. 2774. 2829. 3024. 3278.
1 4 3 2739. 2802. 2861. 3063. 3322.
1 5 1 2800. 2840. 2900. 3060. 3320.
1 5 2 2807. 2859. 2908. 3092. 3345.
1 5 3 2835. 2888. 2940. 3129. 3384.
2 1 1 1860. 1990. 2090. 2435. 2830.
2 1 2 1881. 2002. 2101. 2438. 2836.
2 1 3 1947. 2039. 2131. 2448. 2848.
2 2 1 1990. 2100. 2190. 2530. 2916.
2 2 2 2004. 2109. 2206. 2537. 2926.
2 2 3 2033. 2130. 2224. 2548. 2946.
2 3 1 2130. 2235. 2330. 2660. 3030.

2 3 2 2145. 2249. 2345. 2670. 3043.

2 3 3 2167. 2265. 2360. 2682. 3063.
2 4 1 2325. 2420. 2525. 2820. 3150.
2 4 2 2334. 2436. 2530. 2833. 3168.
2 4 3 2353. 2449. 2541. 2845. 3187.
2 5 1 2610. 2685. 2760. 2990. 3280.
2 5 2 2614. 2691. 2765. 3002. 3295.
2 5 3 2618. 2700. 2774. 3018. 3313.
3 1 1 1400. 1500. 1620. 2000. 2450.
3 1 2 1438. 1552. 1671. 2030. 2474.
3 1 3 1628. 1710. 1795. 2103. 2511.
3 2 1 1480. 1600. 1730. 2120. 2590.
3 2 2 1529. 1659. 1780. 2147. 2603.
3 2 3 1694. 1785. 1877. 2206. 2627.
3 3 1 1610. 1780. 1900. 2300. 2760.
3 3 2 1684. 1825. 1938. 2320. 2771.
3 3 3 1821. 1920. 2017. 2358. 2786.
3 4 1 1920. 2040. 2170. 2555. 2975.
3 4 2 1950. 2074. 2189. 2565. 2980.
3 4 3 2031. 2134. 2234. 2578. 2988.
3 5 1 2370. 2480. 2570. 2860. 3200.
3 5 2 2376. 2482. 2576. 2868. 3205.
3 5 3 2386. 2486. 2580. 2874. 3211.
4 1 1 800. 900. 1100. 1475. 1900.
4 1 2 1067. 1148. 1235. 1554. 1970.
4 1 3 1400. 1466. 1533. 1796. 2148.
4 2 1 900. 1050. 1150. 1560. 2000.
4 2 2 1088. 1167. 1258. 1617. 2060.
4 2 3 1427. 1490. 1559. 1834. 2209.
4 3 1 1000. 1100. 1220. 1650. 2100.
4 3 2 1153. 1241. 1345. 1745. 2221.
4 3 3 1469. 1541. 1619. 1922. 2329.
4 4 1 1280. 1350. 1500. 1960. 2490.
4 4 2 1333. 1453. 1581. 2004. 2508.
4 4 3 1594. 1681. 1772. 2113. 2557.
4 5 1 1800. 1940. 2080. 2500. 2935.
4 5 2 1853. 1981. 2106. 2512. 2941.
4 5 3 1966. 2070. 2175. 2535. 2950.

Hydraulics Table Extrapolation Limits
The extrapolation limits for hydraulics tables are specified as follows:
LIMITS
VARIABLE (MIN) (MAX)
var(1) (min(1)) (max(1))
. . .
ENDLIMITS
where:
LIMITS Introduces the hydraulics extrapolation limits table.
ENDLIMITS Specifies the end of the extrapolation limits table.
VARIABLE Column heading keyword for the variable whose extrapolation

limits will be specified. The variable names (var(1) etc) should be
the same as the keywords used to specify the table. E.g. for
hydraulics tables using liquid rates and gas-liquid ratios, the
variables are QLIQ, GLR, WCUT, ALQ and THP.
MIN Column heading keyword for the minimum extrapolation limit.
MAX Column heading keyword for the maximum extrapolation limit.
Notes:
The default minimum extrapolation limit for the rate (QLIQ etc) and fluid ratios (GLR, WCUT
etc) is zero, and the default maximum extrapolation limit is the maximum value input in the table.
For PIN, POUT and ALQ, the default extrapolation limits are the minimum and maximum values
input for the table.
Example:
LIMITS
VARIABLE MIN MAX
QLIQ 0.0 10000.0
GLR 0.0 10.0
ENDLIMITS

Water Injection Hydraulics Correlation Data
Water injection hydraulics data are specified as follows:
WATINJ GRAD grad

VISC visc
DIAM diam
LENGTH length
DZ dz
ROUGHNESS ruf
where:
WATINJ Introduces the water injection correlation data.
GRAD Introduces the injected fluid pressure gradient (psi/ft, kPa/m, (Kg/
cm2)/m, barsa/m, psi/cm). Default: 0.433 psi/ft
VISC Introduces the injected fluid viscosity (cp, cp, cp, cp, cp). Default:
0.7 cp
DIAM Introduces the tubing diameter (in, cm, cm, cm, cm).
LENGTH Introduces the default tubing length (ft, m, m, m, cm). Not used if
the x, y coordinates and depths of nodein and nodeout for the
connection have been specified.
DZ Introduces the depth change between nodein (wellhead) and

nodeout (bottomhole) (ft, m, m, m, cm). I.e. depth(nodeout) –
depth(nodein). Not used if the depths of nodein and nodeout for the
connection have been specified.
ROUGHNESS Introduces the tubing roughness factor (in, mm, mm, mm, mm).
Default: 0.0


Valve and Choke Data
In This Chapter
• Valve coefficient data

• Choke coefficient data
All the data for valve and choke methods are input in a single file. Valve and choke files are
included in a case file in the NET_METHOD_FILES section as follows
NET_METHOD_FILES
VALVE method 1 filename1
VALVE method 2 filename2
R5000.0.1 Valve and Choke Data: In This Chapter 623

Valve Coefficient Data
Valve coefficient tables are specified as follows:
VALVE (QALL, or QOIL or QGAS or QWATER or QLIQ)

SETTING VC
s1 vc1 or NOFLOW
s2 vc2
. .
sn vcn
ENDVALVE
where:
VALVE Introduces a valve table.
QALL Specifies that total mass rate is used to determine the pressure drop
across the valve. This is the default.
QOIL Specifies oil rate is used to determine the pressure drop across the
valve.
QGAS Specifies gas rate is used to determine the pressure drop across the
valve.
QWATER Specifies that water rate is used to determine the pressure drop
across the valve.
QLIQUID Specifies that liquid rate is used to determine the pressure drop
across the valve.
SETTING Column heading for the valve setting. The first row in the table
corresponds to the valve being closed. The setting values must be
monotonically increasing.
VC Column heading for the valve coefficient. The first entry in the
table can specify the keyword NOFLOW, indicating that there can
be no flow through the valve. This value must be monotonically
decreasing.
ENDVALVE Keyword specifying the end of the valve table.
Notes:
The Valvec valve model predicts subcritical pressure drop across a valve using the following
equation:
624 Valve and Choke Data: Valve Coefficient Data R5000.0.1

Pout - Pin = -vc(setting) * Qtot * |Qtot| / ρ
where:
Pout is the pressure at the outlet of the valve
Pin is the pressure at the inlet of the valve
Qtot is the total mass rate of the fluid in lb/sec, kg/sec or gm/sec
ρ is the mixture density
vc(setting) is the valve coefficient, which depends on the setting
Example:
VALVE QALL
SETTING VC
1 NOFLOW
2 5.4
3 0.8
4 0.3
5 0.01
ENDVALVE
R5000.0.1 Valve and Choke Data: Valve Coefficient Data 625

Choke Coefficient Data
Choke coefficient tables are specified as follows:
CHOKE
SETTING ID
s1 id1 or NOFLOW
s2 id2
. .
sn idn
ENDCHOKE
where:
CHOKE Introduces a choke table.
SETTING Column heading for the choke setting. The first row in the table
corresponds to the choke being closed. The setting values must be
monotonically increasing.
ID Column heading for the choke inner diameter. The first entry in the
table can specify the keyword NOFLOW, indicating that there can
be no flow through the choke (id = 0). (Inches, cm, cm, cm)
ENDCHOKE Keyword specifying the end of the choke table.
Example:
CHOKE
SETTING ID
20.5 0.014465
21.0 0.034404
21.5 0.050908
22.0 0.065789
22.5 0.079637
ENDCHOKE
626 Valve and Choke Data: Choke Coefficient Data R5000.0.1

Pump Data
In This Chapter
• Pump data
All the data for a pump method is input in a single file. Pump files are included in a case file in the
NET_METHOD_FILES section as follows:
NET_METHOD_FILES
PUMP method 1 filename1
PUMP method 2 filename2
R5000.0.1 Pump Data: In This Chapter 627

Pump Data
Pump data is input as follows:
PUMP_CNTR
SPEED pump_speed
LIQ_RATE HEAD EFF NPSHR
q1 h1 eff1 npshr1
q2 h2 eff3 npshr2
…
…
q_Nq1 h_Nq1 eff_Nq1 npshr_Nq1
ENDSPEED
SPEED pump_speed
q1 h1 eff1 npshr1
q2 h2 eff3 npshr2
….
…q_Nq2 h_Nq2 eff_Nq2 npshr_Nq2
ENDSPEED
…
…
ENDPUMP_ CNTR
where:
PUMP_ CNTR Start of the pump performance data block. The presence of this
keyword also indicates that the pump is of centrifugal type with
variable speed (CVS).
SPEED Start of block containing data of a performance curve for water at a

certain speed for this pump.
pump_speed Speed in rpm of the centrifugal pump for the present performance
curve.
LIQ_RATE Column heading for liquid rate.
qi Water rate for the current row of data, (ft3/hr, m3/hr, m3/hr, m3/hr,
cc/hr).
HEAD Column heading for the head.
hi The head (pressure rise in column height of water) generated by the

pump at the current speed and rate (ft, m, m, m, cm).
EFF Column heading for the pump efficiency
628 Pump Data: Pump Data R5000.0.1

effi Efficiency of the pump at the current speed and rate (fraction, non-
dimensional).
NPSHR Column heading for the net positive suction head required for
avoiding cavitation.
npshri NPSHR (net positive suction head required) at the current speed
and rate (ft, m, m, m, m)
ENDSPEED End of the block of data for the performance curve for the current
speed.
ENDPUMP_ CNTR End of the block of data for the centrifugal type with variable speed
(CVS) pump performance.
Notes:
1. The performance data for each curve must obey the following rules:
• The rows should be arranged in the order of increasing rates (qi).
• The last row (with the maximum rate) must have head = 0.0.
• All but the last row must have positive head.
• The head must decrease with increasing rate (stable regime).
• All rows must have positive efficiency and non-negative NPSHR.
• NPSHR value must increase monotonically with rate.
2. The curves must obey the following rules.
• The curves for different speeds must not intersect.
• The curves must be arranged in decreasing order of speed.
• At least two curves must be input for each pump.
3. The pump model has the following behavior
• If the fluid rate is outside the range of rates of input, the pump will be turned off, and no
increase in pressure will take place.
• If the volumetric gas fraction in the flow exceeds 4%, the pump will be turned off.
• If the specified power cannot be attained at the current rate of flow, the pump will be
operated at the highest speed specified in the input performance data (and thus at the
highest permissible power) at that rate.
R5000.0.1 Pump Data: Pump Data 629

• If the inlet pressure falls below the NPSHR value at the current rate and speed, the pump
will be turned off, and a warning will be issued. (This represents the condition of
cavitation in the pump.)
Example:
DESC DATA FOR PUMP method 1 filename1

PUMP_CNTR
SPEED 500
0 100 0.5 4
0.2 99.8811 0.5523 4.4
2 99.5244 0.604 4.8
3 98.9298 0.6545 5.2
4 98.0975 0.7034 5.6
5 97.0273 0.75 6
6 95.7194 0.7939 6.4
7 94.1736 0.8346 6.8
8 92.3 0.8716 7.2
9 90.3686 0.9045 7.6
10 88.1094 0.933 8
11 85.6124 0.9568 8.4
12 82.8775 0.9755 8.8
13 79.9049 0.9891 9.2
14 76.6944 0.9973 9.6
15 73.2461 1 10
16 69.56 0.9973 10.4
17 65.6361 0.9891 10.8
18 61.4744 0.9755 11.2
19 57.0749 0.9568 11.6
20 52.4376 0.933 12
21 47.5624 0.9045 12.4
22 42.4495 0.8716 12.8
23 37.0987 0.8346 13.2
24 31.5101 0.7939 13.6
25 25.6837 0.75 14
26 19.6195 0.7034 14.4
27 13.3175 0.6545 14.8
28 6.7776 0.6039 15.2
29 0 0.5523 15.6
ENDSPEED
SPEED 400
0 80 0.8 4
0.3 79.7784 0.8386 4.32
2 79.1136 0.8679 4.64
3 78.0055 0.8946 4.96
4 76.4543 0.9186 5.28
5 74.4598 0.9397 5.6

6 72.0222 0.9579 5.92

7 69.1413 0.9729 6.24
8 65.8172 0.9847 6.56
9 62.0499 0.9932 6.88
10 57.8393 0.9983 7.2
11 53.1856 1 7.52
12 48.0886 0.9983 7.84
13 42.5485 0.9932 8.16
14 36.5651 0.9847 8.48
15 30.1385 0.9729 8.8
16 23.2687 0.9579 9.12
17 15.9557 0.9397 9.44
18 8.1994 0.9186 9.76
19 0 0.8946 10.08
ENDSPEED
SPEED 300
0 72 0.991 4
1 71.7188 0.9923 4.2
1.5 70.875 0.9962 4.4
3 69.4688 0.9962 4.6
4 7.5 0.9923 4.8
5 64.9688 0.9845 5
6 61.875 0.973 5.2
7 58.2188 0.9578 5.4
8 54 0.9392 5.6
9 49.2188 0.9174 5.8
10 43.875 0.8926 6
11 37.9688 0.8651 6.2
12 31.5 0.8352 6.4
13 24.4688 0.8033 6.6
14 16.875 0.7698 6.8
15 8.7188 0.735 7
16 0 0.6994 7.2
ENDSPEED
ENDPUMP_CNTR
R5000.0.1 Pump Data: Pump Data 631


Compressor Data
In This Chapter
• Compressor data
All the data for a compressor method is input in a single file. Compressor files are included in a
case file in the NET_METHOD_FILES section as follows:
NET_METHOD_FILES
COMPRESSOR method 1 filename1
COMPRESSOR method 2 filename2
R5000.0.1 Compressor Data: In This Chapter 633

Compressor Data
Compressor data is input as follows:
COMP_CNTR
SPEED compr_speed1
GAS_RATE HEAD EFF
q1 h1 eff1
q2 h2 eff2
…
…
q_Nq1 h_Nq1 eff_Nq1
ENDSPEED
SPEED compr_speed2
GAS_RATEHEAD EFF
q1 h1 eff1
q2 h2 eff2
…
…
q_Nq1 h_Nq1 eff_Nq1
ENDSPEED
…
…
ENDCOMP_CNTR
where:
COMP_CNTR Start of compressor performance data block. The latter part of the
keyword indicates that it is a centrifugal compressor.
SPEED Keyword indicating that the following block contains data of a

performance curve for a certain speed for this compressor.
compr_speed Speed as a multiple of the design speed of the compressor for the
present performance curve. The design speed is indicated by input
of 1.0.
GAS_RATE Column heading for gas rate.
qi Actual inlet gas rate for the current row of data, (ft3/min, m3/min,
m3/min, m3/min, cc/min). "Actual rate" is the rate at the inlet
pressure and temperature conditions.
HEAD Column heading for the polytropic head.
634 Compressor Data: Compressor Data R5000.0.1

hi The polytropic head (increase in the specific enthalpy of the gas)

generated by the compressor at the current speed and rate (Btu/lb,
KJ/Kg, KJ/Kg, KJ/Kg, KJ/Kg).
EFF Column heading for the compressor efficiency.
effi Polytropic efficiency of the compressor at the current speed and

rate (fraction, non-dimensional).
ENDSPEED End of the block of data for the performance curve for the current
speed.
ENDCOMP_CNTR End of the block of data for the centrifugal compressor

performance.
Notes:
1. The performance data for each curve must obey the following rules:
• The rows should be arranged in the order of increasing rates (qi).
• The first row corresponds to the minimum rate, which is at the surge limit of the
compressor at the given speed. The compressor must be shut-down below this rate.
• The last row (with the maximum rate) corresponds to the choking condition.
• All rows must have positive head.
• The head must decrease with increasing rate (stable regime)
• All rows must have positive efficiency. Typically the efficiency has a maximum near
middle of the rate range, and declines smoothly on either side.
2. The curves must obey the following rules.
• The curves for different speeds must not intersect.
• The curves must be arranged in decreasing order of speed.
• At least two curves must be input for each compressor.
• The surge rates of the curves must increase with speed.
• The choke rates of the curves must increase with speed.
• Two neighboring head curves are such that the choke rate for lower curve is greater than
the surge rate of the upper curve. This ensures that the curves are spaced closely enough
that interpolation can be done successfully during the calculations.
R5000.0.1 Compressor Data: Compressor Data 635

• The heads at the surge rates for the curves are increasing from the bottom to top (i.e.,
with increasing speed).
• The heads at the choke rates for the curves are increasing from the bottom to top (i.e.,
with increasing speed).
3. The compressor model has the following behavior:
• If the fluid rate is below the surge rate of the lowest speed curve, the compressor will be
turned off and no increase in pressure will take place. The flow rate will not exceed the
choke limit at the specified power level. When the compressor is operating at a choke
limit, the pressure rise will be commensurate with the flow rate on the limit, and the
power consumed will be at the most equal to the specified value.
• If the volumetric liquid fraction in the flow exceeds 4%, the compressor will be turned
off.
• For a given power, and flow rate, the compressor will be operated at a speed that yields
the highest polytropic head. If this calculation is limited by the surge limit, then the
actual (lower than input) value of power at the surge limit will be included in the output.
Example:
COMP_CNTR
SPEED 1.05
GAS_RATE HEAD EFF
10000 88100 0.7
11000 87896 0.72
12000 87285 0.74
13000 86267 0.76
14000 84842 0.78
15000 83009 0.8
16000 80769 0.82
17000 78122 0.84
18000 75067 0.82
19000 71606 0.8
20000 67737 0.78
21000 63460 0.76
22000 58777 0.74
23000 53686 0.72
24000 48188 0.7
ENDSPEED
SPEED 1.00
GAS_RATE HEAD EFF
9000 84100 0.68
10000 83896 0.705
11000 83285 0.73
12000 82267 0.755
13000 80842 0.78

14000 79009 0.805

15000 76769 0.83
16000 74122 0.84
17000 71067 0.83
18000 67606 0.805
19000 63737 0.78
20000 59460 0.755
21000 54777 0.73
22000 49686 0.705
23000 44188 0.68
ENDSPEED
SPEED 0.80
GAS_RATE HEAD EFF
8000 80100 0.66
9000 79896 0.688
10000 79285 0.716
11000 78267 0.744
12000 76842 0.772
13000 75009 0.8
14000 72769 0.828
15000 70122 0.84
16000 67067 0.828
17000 63606 0.8
18000 59737 0.772
19000 55460 0.744
20000 50777 0.716
21000 45686 0.688
22000 40188 0.66
ENDSPEED
SPEED 0.60
GAS_RATE HEAD EFF
7000 76100 0.6074
8000 75896 0.6384
9000 75285 0.6697
10000 74267 0.7013
11000 72842 0.7331
12000 71009 0.7651
13000 68769 0.7973
14000 66122 0.8400
15000 63067 0.8200
16000 59606 0.7651
17000 55737 0.7331
18000 51460 0.7013
19000 46777 0.6697
20000 41686 0.6384
21000 36188 0.6074
ENDSPEED
ENDCOMP_CNTR
R5000.0.1 Compressor Data: Compressor Data 637


Gaslift Data
In This Chapter
• Optimal Gaslift data.
All the data for an optimal Gaslift method is input in a single file. Gaslift files are included in a
case in the NET_METHOD_FILES section as follows:
NET_METHOD_FILES
Gaslift method 1 filename1
Gaslift method 2 filename2
....
R5000.0.1 Gaslift Data: In This Chapter 639

Optimal Gaslift Data
Optimal Gaslift tables are specified as follows:
QLIQ or QOIL q1 q2 ... qn

WCUT w1 w2 ... wk
(PRESSURE) p1 p2 ... pl
(QOILREV q1 q2 ...qn)
FORWARD or REVERSE
(IWCUT) (IQLIQ or IQOIL) (IPRES) (GLR or GOR)

(iw1) (iq1) (ip1) g(iw1,iq1,ip1)
. . . .
. . . .
(iwk) (iqn) (ipl) g(iwk,iqn,ipl)
where:
QOIL Introduces the oil rates used in the gaslift table. (STB/Day, m3/Day,
m3/Day, m3/Day, cc/hour)
QLIQ Introduces the liquid rates used in the gaslift table. (STB/Day, m3/
Day, m3/Day, m3/Day, cc/hour)
WCUT Introduces the water cuts used in the gaslift table. (Fraction).
PRESSURE Introduces the mobility weighted pressures for the flowing perfs
used in the gaslift table. (psia, kPa, (Kg/cm2)a, barsa, psia)
IWCUT Column heading keyword for the water cut index.iwi The water cut
index corresponding to the ith water cut (following the WCUT
keyword).
IQOIL Column heading keyword for the oil rate index.iqi. The oil rate
index corresponding to the ith oil rate (following the QOIL or
QOILREV keywords).
IQLIQ Column heading keyword for the liquid rate index.iqi. The liquid
rate index corresponding to the ith liquid rate (following the QLIQ
or QOILREV keywords).
IPRES Column heading keyword for the pressure index. The pressure
index corresponding to the ith pressure (following the PRESSURE
keyword).
640 Gaslift Data: Optimal Gaslift Data R5000.0.1

GLR Column heading for the optimal gas/liquid ratio. This is the total
gas rate in the connection into which the gas lift gas is injected,
divided by the liquid rate in the same connection. I.e (Formation
gas rate + Lift gas rate)/(Formation liquid rate). (MCF/STB, m3/
m3, m3/ m3, m3/ m3, cc/cc)
GOR Column heading for the optimal gas/oil ratio. This is the total gas
rate in the connection into which the gas lift gas is injected, divided
by the oil rate in the same connection. I.e (Formation gas rate +
Lift gas rate)/(Formation oil rate). (MCF/STB, m3/ m3, m3/ m3,
m3/ m3, cc/cc)
Note:
The optimal gas lift table is used to calculate the gas rate for the gas lift connection to which it
assigned (see the TYPE keyword in the NODECON table, described in the Surface Network sec-
tion). The gas lift rate is calculated by interpolating the optimal GLR or GOR from the gas lift
table at the oil rate (or liquid rate) and water cut in the connection into which the gas is injected,
and the mobility weighted average wellbore pressure (if it is in a linear series of connections that
start at a production well). Referring to the diagram below, for a table of optimal GLR, the gas
rate in connection 2 would be given by:
Gas Rate(Connection 2) = max(0, GLR * Liquid Rate(Connection 3) – Gas Rate(Connection 1))
And for a table of optimal GOR, the gas rate in connection 2 would be given by:
Gas Rate(Connection 2) = max(0, GOR * Liquid Rate(Connection 3) – Gas Rate(Connection

1))
Where GLR (or GOR) is the GLR (or GOR) value interpolated from the table, at the oil (or liquid
rate) and water cut in connection 3, and the mobility weighted average wellbore pressure of the
well that the production is flowing from. The gas rate in the gas lift connection can also not
exceed the maximum gas rate assigned to the gas lift connection in a CONSTRAINT table (see
R5000.0.1 Gaslift Data: Optimal Gaslift Data 641

the “Surface Network” on page 295).
Example:
DESC Optimal Gaslift Data

WCUT 0.0 0.2 0.4 0.6 0.8 1.0
QLIQ 1000 3500 6000
PRESSURE 2500 4500
IPRES IWCUT IQLIQ GLR
1 1 1 0.8
1 1 2 0.7
1 1 3 0.6
1 2 1 0.9
1 2 2 0.8
1 2 3 0.7
1 3 1 1.0
1 3 2 0.9
1 3 3 0.8
1 4 1 1.1
1 4 2 1.0
1 4 3 0.0
1 5 1 1.2
1 5 2 1.0
1 5 3 0.9
1 6 1 1.3
1 6 2 1.1
1 6 3 1.0
2 1 1 0.5
2 1 2 0.4
2 1 3 0.3
2 2 1 0.6
2 2 2 0.5
2 2 3 0.4

2 3 1 0.7
2 3 2 0.6
2 3 3 0.5
2 4 1 0.8
2 4 2 0.7
2 4 3 0.6
2 5 1 0.9
2 5 2 0.8
2 5 3 0.7
2 6 1 1.0
2 6 2 0.9
2 6 3 0.8
R5000.0.1 Gaslift Data: Optimal Gaslift Data 643


Override Data
In This Chapter
• Array and transmissibility override in a region
• Transmissibility override across an interface
• Pressure threshold for limiting grid block to grid block flow
• Time Data
All the data for overriding array or transmissibility data is input in a single file. The override data
file is included in a case in the RECURRENT_FILES section as follows:
RECURRENT_FILES
OVERRIDE filename
In order for override data to be applied, either data must also be provided for the XINDEX, YIN-
DEX and ZINDEX arrays in the PROPERTY_FILES section of the case file, or a
STRUCTURED_GRID file must be provided in the GRID_FILES section.
R5000.0.1 Override Data: In This Chapter 645

Array and Transmissibility Override in a Region
The override input is specified as follows:
OVER
X1 X2 Y1 Y2 Z1 Z2 key (key) ...
x1(1) x2(1) y1(1) y2(1) z1(1) z2(1) #v(1) (#v(1)) ...
. . . . . . . . ...
ENDOVER
or
OVER_MF
X1 X2 Y1 Y2 Z1 Z2 cptname (cptname)...
x1(1) x2(1) y1(1) y2(1) z1(1) z2(1) #v(1) (#v(1)) ...
. . . . . . . . ...
ENDOVER_MF
where:
OVER Introduces the override input table.
OVER_MF Introduces the override input table for molefractions.
ENDOVER Specifies the end of the override table.
ENDOVER_MF Specifies the end of the override table for molefractions.
X1 Column heading keyword for the lower limit of the xindex value
(real).
X2 Column heading keyword for the upper limit of the xindex value
(real).
Y1 Column heading keyword for the lower limit of the yindex value
(real).
Y2 Column heading keyword for the upper limit of the yindex value
(real).
Z1 Column heading keyword for the lower limit of the zindex value
(real).
Z2 Column heading keyword for the upper limit of the zindex value
(real).
key A column heading keyword for an array or transmissibility, using

one or more of the following keywords:
646 Override Data: Array and Transmissibility Override in a Region R5000.0.1

PV Cell pore volumes are to be modified.

DEPTH Cell depths are to be modified.
SG Cell gas saturations are to be modified.
SW Cell water saturations are to be modified.
PRESSURE Cell pressures are to be modified.
PSAT Cell saturation pressures are to be modified.
TEMPERATURE Cell temperatures are to be modified.
POROSITY Cell porosities
KX Cell x-direction permeability
XCENTER Cell x location of center
YCENTER Cell y location of center
MINDEPTH Cell minimum depth
MAXDEPTH Cell maximum depth
TX Connection “X-direction” transmissibilities
are to be modified (assuming a 7 point sten-
cil).
TY Connection “Y-direction” transmissibilities
cil).
TZ Connection “Z-direction” transmissibilities
cil).
cptname Column heading for the molefractions of a component.
#v # is an operator that describes how the array or transmissibility is to

be modified, and v is the value to be applied. Any of the following
symbols may be used for the operator #.
+ add
- subtract
/ divide
* multiply
= equal
<= min(array or transmissibility value, v)
>= max(array or transmissibility value, v)
There are no spaces between the operator and the value v.
Notes:
1. XINDEX, YINDEX and ZINDEX arrays must be input in order to perform overrides. The
R5000.0.1 Override Data: Array and Transmissibility Override in a Region 647

values of these arrays should correspond to the location of the grid block in some coordinate
system. This could be the actual (x, y, z) location of the grid block, but it will usually be
more useful to use a coordinate system which conforms to the reservoir geometry. For exam-
ple, for a structured grid, the (i, j, k) index of the grid could be used. (Locally refined grids
would have fractional values of (i, j, k) relative to the coarsest grid). Connection directions
are determined using the (xindex, yindex, zindex) values for the two connected cells.
2. The modification is performed if the (xindex, yindex, zindex) location is inside or on the
boundaries of the region specified. I.e
x1 <= xindex <= x2
y1 <= yindex <= y2
z1 <= zindex <= z2
For connections, the cells at one end of the connection must be inside or on the boundaries of
the region, and the indices for the other end of the connection must be less than the upper
limit. I.e. one end of the connection must satisfy the inequalities above, and the other end
must satisfy the inequalities
xindex <= x2
yindex <= y2
zindex <= z2
3. No connections or cells are created by override operations. I.e there is no connection

between two neighboring cells, overriding transmissibilities for a region containing the two
cells and using an add or equal operation will not result in a new connection.
4. Array modifications are performed before equilibration.
5. The arrays can only be modified at time 0. Transmissibilities can be modified with time.
6. If array modifications result in invalid values, e.g. pore volume <= 0, the run will stop.
7. If transmissibility modifications result in values < 0, the value will be set to 0.
Example:
OVER
X1 X2 Y1 Y2 Z1 Z2 PV TX
2.0 4.0 5.0 7.0 0.0 2.0 *0.5 *0.5
ENDOVER
TIME 100.0 ! Modify the following transmissibilities at 100 days

OVER
648 Override Data: Array and Transmissibility Override in a Region R5000.0.1

X1 X2 Y1 Y2 Z1 Z2 TX
2.0 4.0 5.0 7.0 0.0 2.0 *2.0
ENDOVER
R5000.0.1 Override Data: Array and Transmissibility Override in a Region 649

Transmissibility Override across an Interface
The override input is specified as follows:
INTERFACE
X1 X2 Y1 Y2 Z1 Z2 key (key) ...
x1(1) x2(1) y1(1) y2(1) z1(1) z2(1) #v(1) (#v(1)) ...
. . . . . . . . ...
ENDINTERFACE
where:
INTERFACE Introduces the override input table.
ENDINTERFACE Specifies the end of the override table.
X1 Column heading keyword for the lower limit of the xindex value
(real).
X2 Column heading keyword for the upper limit of the xindex value
(real).
Y1 Column heading keyword for the lower limit of the yindex value
(real).
Y2 Column heading keyword for the upper limit of the yindex value
(real).
Z1 Column heading keyword for the lower limit of the zindex value
(real).
Z2 Column heading keyword for the upper limit of the zindex value
(real).
key One or more of the following column heading keywords.
TX Connection “X-direction” transmissibilities

cil).
TY Connection “Y-direction” transmissibilities
cil).
TZ Connection “Z-direction” transmissibilities
cil).
650 Override Data: Transmissibility Override across an Interface R5000.0.1

cptname Column heading for the molefraction of a component.
#v # is an operator that describes how the array or transmissibility is to

be modified, and v is the value to be applied. Any of the following
symbols may be used for the operator #.
+ add
- subtract
/ divide
* multiply
= equal
<= min(array or transmissibility value, v)
>= max(array or transmissibility value, v)
There are no spaces between the operator and the value v.
Notes:
1. XINDEX, YINDEX and ZINDEX arrays must be input in order to perform overrides. The
values of these arrays should correspond to the location of the grid block in some coordinate
system. This could be the actual (x, y, z) location of the grid block, but it will usually be
more useful to use a coordinate system which conforms to the reservoir geometry. For exam-
ple, for a structured grid, the (i, j, k) index of the grid could be used. (Locally refined grids
would have fractional values of (i, j, k) relative to the coarsest grid). Connection directions
are determined using the (xindex, yindex, zindex) values for the two connected cells.
2. The modification is performed if
xindex1 <= x2, yindex1 <= y2, zindex1 <= z2 and

xindex2 >= x1, yindex2 >= y1, zindex2 >= z1
or
index2 <= x2, yindex2 <= y2, zindex2 <= z2 and

index1 >= x1, yindex1 >= y1, zindex1 >= z1
where xindex1, yindex1, zindex1 are the index values for the cell at one end of the connec-
tion, and xindex2, yindex2 and zindex2 are the index values for the cell at the other end of the
connection.
3. Transmissibilities can be modified with time.
4. If transmissibility modifications result in values < 0, the value will be set to 0.
5. One (and only one) or X2 – X1, Y2 – Y1 or Z2 – Z1 must be 0.
R5000.0.1 Override Data: Transmissibility Override across an Interface 651

Example:
INTERFACE
4.0 4.0 5.0 7.0 0.0 2.0 *0.5
ENDINTERFACE
TIME 100.0 ! Modify the following transmissibilities at 100 days

INTERFACE
4.0 4.0 5.0 7.0 0.0 2.0 *2.0
ENDINTERFACE
652 Override Data: Transmissibility Override across an Interface R5000.0.1

Pressure Threshold for Limiting Gridblock-to-Gridblock

Flow
The pressure threshold for limiting flow between grid blocks that are part of an identifiable inter-
face is input as follows:
PTHLD
PRES (NAME) (ITR1) (ITR2)
Pres(1) (name(1)) (itr1(1)) (itr2(1))
Pres(2) (name(2)) (itr1(2)) (itr2(2))
. . . .
ENDPTHLD
where
PTHLD Introduces a pressure threshold table.
PRES Column heading keyword indicating that the entries in this column
are either a phase potential difference, or the keyword EQUIL.
There will be no flow across the connection until the input phase
potential difference is exceeded. If the keyword EQUIL is entered,
the threshold potential difference is set to the maximum phase
potential difference for the connection at initial conditions. EQUIL
can only be input at time = 0. (psi, kPa, Kg/cm2, bar, psi).
Default: EQUIL
NAME Column heading keyword indicating that the entries in this column
are the identifying fault names input in the connection data. The
threshold pressure specified will apply to all connections which
have this fault name.
ITR1 Column heading keyword indicating that the entries in this column
are integer values identifying a transmissibility regions.
Transmissibility regions are input with the ITRAN keyword in the
case file. (see the Case File section). The threshold pressure will
apply to all connections across the interface defined by itr1 and itr2.
Itr1 and itr2 cannot be the same.
ITR2 Column heading keyword indicating that the entries in this column
are integer values identifying a transmissibility regions.
R5000.0.1 Override Data: Pressure Threshold for Limiting Gridblock-to-Gridblock Flow 653
Transmissibility regions are input with the ITRAN keyword in the

case file. (See the Case File section). The threshold pressure will
apply to all connections across the interface defined by itr1 and itr2.
Itr1 and itr2 cannot be the same.
ENDPTHLD Indicates the end of the PTHLD table.
Notes:
Flow across any interface connection will not occur until the phase potential difference across the
connection exceeds the threshold pressure. The phase potential difference to flow will be reduced
by the threshold pressure.
Examples:
PTHLD
PRES NAME
10.0 FAULT1
15.0 FAULT2
ENDPTHLD
PTHLD
PRES ITR1 ITR2
20.0 1 2
5.0 2 3
ENDPTHLD
654 Override Data: Pressure Threshold for Limiting Gridblock-to-Gridblock Flow R5000.0.1
Time Data
Time data is specified as follows:
TIME time
or
TIME date
where:
time The time when the following override data will be applied. (days,
days, days, days, hours).
date The date when the following override data will be applied. The
date can be specified in the format mm/dd/yyyy or mm/dd/
Examples:
TIME 100.0
TIME 1/1/2000
TIME 10/04/2000(08:00:00)
R5000.0.1 Override Data: Time Data 655

656 Override Data: Time Data R5000.0.1

Default EOS Properties
In This Chapter
• Default Properties.
• Default EOS Options.
• Default EOS Component Property Data.
• Default EOS Binary Interaction Data.
• Default Ideal Gas Cp Coefficients table.
• Standard Components.
All the default EOS properties data is input in a single file. The default EOS property file is
included in a case as follows:
R5000.0.1 Default EOS Properties: In This Chapter 657

Default properties
Default properties for 12 standard components are provided (see Standard Component List).
Default properties can be re-defined by the user. The default properties are entered in table form.
If the name of the entered component is the same as the name of a standard component, the
default properties for that component are overwritten. If the name of the entered component is
new, a new standard component is defined.
658 Default EOS Properties: Default properties R5000.0.1

Default EOS Options
Default EOS options are specified as follows:
EOSDEFAULTS PR or PR_OLD or SRK or RK

ZGIBBS
MCO2 mco2
TOL tol
TRANSITION NEIGHBOR (TOLDZ toldz) or
TEST or
ALL
TRANS_TEST GIBBS or
I NCRP PHASEFRAC frac or
PSAT
FUGERR fugerr
PHASEID PREVIOUS or
FLASH or
OIL or
GAS or
PSAT
ALPHAMU alphamu
VSHIFTOFF
STKATZOFF
where:
ENGLISH Specifies that the input is in english oilfield units.
METRIC Specifies that the input is in metric units, with pressures in kPa.
pressures.
METBAR Specifies that the input is in metric units, with pressures in bars.
LAB Specifies that the input is in laboratory units.
KELVIN Specifies that the temperatures are specified in degrees kelvin.
RANKINE Specifies that the temperatures are specified in degrees Rankine.
FAHR Specifies that the temperatures are specified in degrees Fahrenheit.
R5000.0.1 Default EOS Properties: Default EOS Options 659

CELSIUS Specifies that the temperatures are specified in degrees Celsius.
EOSDEFAULTS Introduces data for default EOS options.
PR Peng Robinson method.
PR_OLD Original Peng Robinson method.
SRK Soave-Redlich-Kwong method.
RK Redlich-Kwong method.
MCO2 Identifies component number that is the CO2 component. Required

because CO2 is often treated differently than other components,
especially in terms of water solubility. (Default 0)
TOL Flash tolerance. The flash calculation converges when

FUGERR
⎛ 1 – f------
2
v, i⎞
Σ ⎝ f ⎠
- < TOL
i=1 l, i
(Default 1.0e-4)
ZGIBBS If this option is selected, during the Z-factor selection process, the
Z-factor that provides the lowest Gibbs free energy for the phase is
selected. Normally, this option is off, and the lowest Z-factor is
selected for the liquid phase, and the largest Z-factor is selected for
the vapor phase.

performed. Possible options are NEIGHBOR, TEST, DELTA, B or
ALL
NEIGHBOR All single phase grid blocks which neighbor

a two phase grid block (except well grid
blocks) will use K-values from the neighbor
block as the starting point to test for the
emergence of a second phase. Well grid
blocks will use the increasing pressure
method. Single phase blocks which are adja-
cent to other single phase blocks which are
not of the same phase are also tested, if the
sum of the absolute value of the component
mole fractions is greater than TOLDZ. The
increasing pressure method is also used in
single phase blocks.
660 Default EOS Properties: Default EOS Options R5000.0.1

TOLDZ The threshold value for applying the phase

transition test when two adjacent blocks are
of difference single phase types. The abso-
lute value of the differences between the
mole fractions of the hydrocarbon compo-
nents are summed and compared to TOLDZ.
The default value is 0.05
TEST All single phase grid blocks which neighbor
a two phase grid block, and all well grid
blocks, will undergo a test for the emergence
of a second phase. The test used depends on
the method selected by the
TRANSITION_TEST keyword. If no test is
specified, the increasing pressure method is
used. (Default)
DELTA In addition to gridblocks selected for testing
by the TEST keyword, gridblocks which
exceed threshold changes in pressure or
composition are tested.
B In addition to gridblocks selected for testing
by the TEST keyword, gridblocks which
exceed threshold changes in the thermody-
namic B parameter are tested.
ALL All single phase grid blocks are tested for the
emergence of a second phase using the
increasing pressure method.
(default) or PSAT.
GIBBS Phase transition (1 hydrocarbon phase to 2

hydrocarbon phases) determined by Gibbs
stability test. A second phase emerges if its
introduction results in the lowering of the
Gibbs free energy of the system. (Use
instead of INCRP or PSAT)
INCRP Phase transition (1 hydrocarbon phase to 2
hydrocarbon phases) determined by increas-
ing pressure method. In this method, a
series of 8 flashes are performed, starting at

90% of the grid-block pressure, and increas-

ing to the grid-block pressure. At each stage,
the K-values are extrapolated to the next
higher pressure. It is possible that a second
loop of increasing pressures calculations are
performed. The second loop consists of a
sequence of 5 flashes, starting at 99.93% of
the grid-block pressure and increasing to the
grid-block pressure. The PHASEFRAC key-
word described below controls the criteria
for entering the second loop. (Default, can
be overridden by GIBBS or PSAT keyword.)
PHASEFRAC The second increasing loop is entered if the
first loop fails on the last increment and the
mole phase fraction is within PHASEFRAC
of the phase boundary. For example, if a liq-
uid fails to evolve a vapor phase on the last
step, and the vapor mole fraction is less than
PHASEFRAC at the second last step, then
the second loop would be entered. The sec-
ond loop uses much smaller pressure incre-
ments so as to not mistakenly miss the
PSAT Phase transition (1 hydrocarbon phase to 2
hydrocarbon phases) determined by satura-
tion pressure test. A second phase emerges
if the grid-block pressure is lower than the
calculated saturation pressure. (Use instead
of INCRP or GIBBS)

PREVIOUS, DENSITY, FLASH, OIL, GAS or PSAT
PREVIOUS Use label applied during previous timestep.

(Default)
DENSITY Base label on whether the mass density of a
phase is above or below the specified
THRESHOLD value. Fluids with density
above the threshold value are labeled as oil,
while fluids with density below the threshold
value are labeled as gas.
662 Default EOS Properties: Default EOS Options R5000.0.1

FLASH Base the phase label on the vapor mole

fraction calculated from a set of increasing
pressure flash calculations.
OIL Always label a single phase fluid as an oil.
GAS Always label a single phase fluid as a gas.
PSAT Label a single phase fluid based on the
result of a saturation pressure calculation. A
bubble point fluid is labeled as an oil, while a
dew point fluid is labeled as a gas.

VSHIFTOFF Specifies that the simulator will ignore VSHIFT input (In EOS
STKATZOFF Specifies that the simulator will ignore STKATZ input (In EOS
Example:
ENGLISH RANKINE
EOSDEFAULTS PR
PHASEID DENSITY

Default EOS Component Property Data
The input for default EOS component property data is specified as follows:
DEFPROPS
COMPONENT MOLWT TC PC VC or ZC ACENTR VSHIFT STKATZ PARACHOR
name(1) mw(1) tc(1) pc(1) vc/zc(1) acentr(1) vshift(1) stkatz(1) parachor(1)
name(2) mw(2) tc(2) pc(2) vc/zc(2) acentr(2) vshift(2) stkatz(2) parachor(2)
. . . . . . . . .
. . . . . . . . .
Additional Columns
(STK_C1N2) (STK_CO2) (STK_C2) (BP)

stk_c1n2(1) stk_co2(1) stk_c2(1) bp(1)
stk_c1n2(2) stk_co2(2) stk_c2(2) bp(2)
. .
. .
ENDDEFPROPS
where:
DEFPROPS Introduces the default component property table.
ENDDEFPROPS Specifies the end of the default component property table.
COMPONENT Column heading keyword for component names.
MOLWT Molecular weight of component.
TC Critical Temperature of component (See units discussion above)
PC Critical Pressure of component (psia, kPa, Kg/cm2, bars, psia).
VC Critical volume of component (ft3/lbmole, m3/kgmole, m3/kgmole,

m3/kgmole, cc/gmole). Used for Thodos viscosity calculation.
Only one of VC or ZC should be entered.
ZC Critical gas compressibility factor of component. Used for Thodos

viscosity calculation. Only one of VC or ZC should be entered.
ACENTR Acentric factor of component.
VSHIFT Volume shift parameter of component.
STKATZ Standing-Katz factor for density calculation.
PARACHOR Parachor of component.
664 Default EOS Properties: Default EOS Component Property Data R5000.0.1
STK_C1N2 The portion of this component which should be assigned to the C1-
N2 grouping for purposes of calculating the density using the
STK_CO2 The portion of this component which should be assigned to the

CO2 grouping for purposes of calculating the density using the
STK_C2 The portion of this component which should be assigned to the C2

grouping for purposes of calculating the density using the Standing-
Katz procedure. The values should be between 0 and 1.
BP Normal boiling point of the component (at 1 atmosphere pressure).

(degrees F, C, C, C, C). This value is used for calculation of the
ideal gas state Cp as a function of temperature using the Kesler and
Lee correlation. An acceptable input value for BP is NA. Values
less than -1000 are ignored.
Notes:
1. If the name of the entered component is the same as the name of a component already defined
in the default table, the default properties for that component are overwritten. If the name of
the entered component is new, a new standard component is defined.
2. Names cannot be repeated.
3. STKATZ is an optional column heading that indicates Standing-Katz will be used to calculate
surface densities. When using the Standing-Katz procedure, the user can choose to enter the
additional STK_C1N2, STK_CO2, and STK_C2 columns. If the three columns are entered,
the sum of the values for a particular component must be less than or equal to 1. For exam-
ple, a pseudocomponent could represent C1 (83 mole percent), N2 (5 mole percent), and CO2
(10 mole percent), and H2S (2 mole percent). Then, the value of STK_C1N2 should be 0.88,
the value of STK_CO2 should be 0.10, and the value of STK_C2 should be 0.0. If none of the
columns are entered, components are assigned to groupings based on molecular weights.
4. In simulation runs including compressor model and thermal modeling, the Cp of the gas
phase is required. That in turn requires Cp in the ideal gas state for each component. For this
purpose, each component should be defined either in PROPS section or exist in the DEF-
PROPS section. In either section, the definition must have an input of either boiling point
temperature in the BP column of this table or the five coefficients igs_cp_coeff in the
IGS_CP table. The boiling point data is used in the Kesler and Lee correlation. (Ref. Edmis-
ter, Applied Hydrocarbon Thermodynamics, Vol 1, P. 132) The ideal gas Cp calculated by
using the coefficients entered in the IGS_CP table supersede those calculated by the Kesler-
Lee correlation.
R5000.0.1 Default EOS Properties: Default EOS Component Property Data 665
Example:
DEFPROPS
COMPONENT MOLWT TC PC VC ACENTR STKATZ VSHIFT PARACHOR
PS1 44.01 87.93 1070.7 1.51 0.2310 0.8172 -0.0603 151.0
PS2 44.01 206.03 616.0 3.20 0.1523 0.5069 -0.0603 151.0
PS3 58.12 296.23 500.0 4.11 0.1700 0.5772 -0.0675 191.0
PS4 110.10 550.33 400.0 7.00 0.4700 0.7500 0.0597 271.0
PS5 226.03 870.33 250.4 14.0 0.6500 0.8655 0.0968 396.0
PS6 345.43 1105.33 175.2 21.00 0.9750 0.9800 -0.0610 623.0
ENDPROPS
666 Default EOS Properties: Default EOS Component Property Data R5000.0.1
Default EOS Component Coefficients for Ideal Gas Cp
IGS_CP
name(1) coeff(1,1) coeff(2,1) coeff(3,1) coeff(4,1) coeff(5,1)
name(2) coeff(1,2) coeff(2,2) coeff(3,2) coeff(4,2) coeff(5,2)
…
…
ENDIGS_CP
where
Name(i) = component name
coeff (j,i), j=1,5 Coefficients in a 4th order polynomial in T that defines the ideal gas
state Cp (specific heat at constant pressure) of the component at
temperature T. All 5 values must be input for each component.
(Default values for these coefficients for standard components are
obtained from Passut-Danner Ideal Gas State Enthalpy
Coefficients) (The units are BTU/Lb-Ri, KJ/Kg-Ki, KJ/Kg-Ki, J/
gm- Ki).
The ideal gas specific heat at constant pressure (Cp0) for a

component at temperature T is calculated in using the following
formula:
CP_IGS(i) = coeff (1,i) + j=2,5 coeff (j,i)*Tj-1
Note
1. The ideal gas coefficients are set by default for components CO2, H2S, N2, C1, C2, C3, NC4,
IC4, NC5, IC5, NC6, and C6. Using this table, the preset values can be overwritten for these
components. Also, the coefficients for additional components can be set.
Example
IGS_CP
C6 -5.1207E-02 6.7533E-03 -3.6192E-06 7.5354E-10 0.0
ENDIGS_CP
R5000.0.1 Default EOS Properties: Default EOS Component Coefficients for Ideal Gas Cp 667
Default EOS Binary Interaction Data
The input for default EOS binary interaction data is specified as follows:
BINA component_name
component_name1 bina1
. .
ENDBINA
BINB component_name
. .
ENDBINB
where:
BINA Introduces binary interaction coefficient data for the A term.
ENDBINA Terminates the BINA table.
BINB Introduces binary interaction coefficient data for the B term.
ENDBINB Terminates the BINB table.
Note:
A different table is specified for each component in the DEFPROPS. The list of components may
contain any standard components which exist before it in the standard table, or any new compo-
nents that exist before it in the new table. The list of components does not have to include every
single component, only those components for which the interaction coefficient is non-zero.
Example:
BINA PS1
N2 0.028
C1 0.005
ENDBINA
668 Default EOS Properties: Default EOS Binary Interaction Data R5000.0.1
Standard Components
The default properties for the standard components are as follows:
COMPONENT MOLWT TC PC ZC ACENTR STKATZ VSHIFT PARACHOR

CO2 28.103 -234.4 493.0 0.2910 0.0372 0.300 -0.1740 35.0
H2S 44.010 87.9 1070.9 0.2742 0.2225 0.815 -0.1009 49.6
N2 34.076 212.7 1036.0 0.2660 0.0920 0.801 -0.1141 80.1
C1 16.043 -116.6 667.8 0.2890 0.0126 0.300 -0.1546 71.0
C2 30.070 90.1 707.8 0.2850 0.0978 0.356 -0.0740 111.0
C3 44.097 206.0 616.3 0.2810 0.1541 0.508 -0.0603 151.0
NC4 58.124 305.7 550.7 0.2740 0.2015 0.584 -0.0675 191.0
IC4 58.124 275.0 529.1 0.2830 0.1840 0.563 -0.0798 191.0
NC5 72.151 385.7 488.6 0.2620 0.2524 0.631 -0.0369 231.0
IC5 72.151 369.1 490.4 0.2730 0.2286 0.625 -0.0640 231.0
NC6 86.178 453.7 436.9 0.2640 0.2998 0.664 -0.0036 271.0
C6 84.0 463.0 468.3 0.2698 0.2313 0.685 -0.02197 271.0
For all components, the default values of OMEGAA and OMEGAB are determined by the choice
of equation of state.
EOS OMEGAA OMEGAB

PR 0.4274802 0.08664035
PR_OLD 0.457235529 0.077796074
SRK 0.4274802 0.08664035
RK 0.4274802 0.08664035
BINA
COMPONENT CO2 H2S N2 C1 C2 C3 NC4 IC4 NC5 IC5 NC6
H2S 0.0
N2 0.0 0.0
C1 0.15 0.0 0.12
C2 0.15 0.0 0.12 0.0
C3 0.15 0.0 0.12 0.0 0.0
NC4 0.15 0.0 0.12 0.020 0.01 0.01
IC4 0.15 0.0 0.12 0.020 0.01 0.01 0.0
NC5 0.15 0.0 0.12 0.020 0.01 0.01 0.0 0.0
IC5 0.15 0.0 0.12 0.020 0.01 0.01 0.0 0.0 0.0
NC6 0.15 0.0 0.12 0.025 0.01 0.01 0.0 0.0 0.0 0.0
C6 0.15 0.0 0.12 0.025 0.01 0.01 0.0 0.0 0.0 0.0 0.0
The default values of BINB are all zero.
R5000.0.1 Default EOS Properties: Standard Components 669

The default values of ideal gas Cp coefficients are as follows:
For CO2:
4.778, 0.11443, 1.01130d-4, -0.26490d-7, 0.34706d-11, -0.13140d-15
For H2S:
-0.617,0.23858, -0.24460d-4, 0.41070d-7, -1.30126d-11, 1.44852d-15
For N2:
-0.934, 0.25520, -0.17790d-4, 0.15890d-7, -0.32203d-11, 0.15893d-15
For C1:
-6.977, 0.57170, -2.94312d-4, 4.23157d-7, -15.26740d-11, 19.45261d-15
For C2:
-0.021, 0.26488, -0.25014d-4, 2.92334d-7, -12.86050d-11, 18.22060d-15
For C3:
-0.738, 0.17260, 0.94041d-4, 2.15543d-7, -10.70986d-11, 15.92794d-15
For NC4:
7.430, 0.09857, 2.69180d-4, 0.51820d-7, -4.20139d-11, 6.56042d-15
For IC4:
11.498, 0.04668, 3.34801d-4, 0.14423d-7, -3.16420d-11, 5.42893d-15
For NC5:
27.172, -0.00280, 4.40073d-4, -0.86287d-7, 0.81764d-11, -0.19715d-15
For IC5:
27.623, -0.03150, 4.69884d-4, -0.98282d-7, 1.02985d-11, -0.29485d-15
For NC6:
-7.391, 0.22911, -0.81569d-4, 4.52784d-7, -25.23180d-11, 47.48019d-15
For C6:
670 Default EOS Properties: Standard Components R5000.0.1

-7.391, 0.22911, -0.81569d-4, 4.52784d-7, -25.23180d-11, 47.48019d-15
R5000.0.1 Default EOS Properties: Standard Components 671

672 Default EOS Properties: Standard Components R5000.0.1

Task Guides
ASCII Structured Grid Case File
This case file is used to create specific text simulation output for use as input to various decision
management applications such as DecisionSpace DMS.
Required File Structure

The structured grid case file is an alternate form of the case file which must be created according
to specifications described here.
VIP® Keywords:
1. The STRUCTURED_GRID section replaces the PROPERTY_FILES section. This section

contains structured grid data using VIP formats: CORTOL, NX, NY, and NZ. These entries
are mandatory.
2. The following arrays can also be added: PINCHOUT, TOLPV, FAULTS, LGR .. ENDLGR,
and DECOMP.
Nexus® Keywords:
1. ROCK_ARRAY_FILES: This section of the case file should not be input. All rock array data
is included in the STRUCTURED_GRID file.
2. ROCK_FILES: RELPM and ROCK input is the same as for a dataset without
STRUCTURED_GRID input.
3. PVT_FILES: PVT, WATER and SEPARATOR input is the same as for a dataset without
STRUCTURED_GRID input.
4. AQUIFER_FILES: AQUIFER input is the same as for a dataset without

STRUCTURED_GRID input. Note that AQCONNS input (in the PROPERTY_FILES sec-
tion) is part of the STRUCTURED_GRID file.
5. RECURRENT_FILES: SURFACE and RUNCONTROL input is the same as for run without
STRUCTURED_GRID input. WELL data is the same, except that additional column headers
are allowed in the WELLSPEC table. These column headers are: IW, JW, L, GRID, ANGLA,
ANGLV, KHMULT and K.
R5000.0.1 Task Guides: Required File Structure ASCII Structured Grid Case File 673
6. NET_METHOD_FILES: HYD, VALUE and GASLIFT input is the same as for a dataset
without STRUCTURED_GRID input. OVERRIDE and IREGION files cannot be used.
674 Task Guides: Required File Structure ASCII Structured Grid Case File R5000.0.1
Dual Porosity Modeling
The Nexus software models the dual porosity processes by using two continua representing the
rock matrix and fractures. These continua are superposed, and the model assumes the two contin-
ual exchange fluids. Two finite-difference grid systems represent both continua. Consequently,
you must supply the fracture properties as well as data for the rock matrix.
The user should be aware of the following differences in data input required or used by the Dual
option:
1. Array porosity type is specified by keyword qualifiers in the PROPERTY_FILES (FRAC,

MATRIX,)
2. Connection porosity type is specified by keyword qualifiers in the PROPERTY_FILES

(FRAC, MATRIX, MATRIXFRAC)
3. Special PROPERTY_FILES arrays (LZ, IXFER)
4. Connection data in connection file (IXFER).
5. Special relative permeability options (VEGO, VEWO, DRELPM).
6. Special ROCK_ARRAY_FILES (FVEGO, FVEWO).
7. XFER methods – a new type of ROCK_FILES (PSEUDO, GO_ONLY, WO_ONLY, NCOL,

NSMTAB, INTSW, PRINT)
8. Additional output options within the RUNCONTROL file (ARRAYOUT, MAPOUT,

MATRIX, FRAC)
9. New porosity type specification in the WELLSPEC data (PORTYPE)
10. The dual porosity input affects the data in these areas:
Dual Porosity Inheritance Rules:
• The following quantities not specified with a FRAC designation will be inherited from
the associated MATRIX quantities:
IPVT, IEQUIL, IWATER, IREGION, ACTIVE, ITRAN, and ITRACER
• The following quantities not specified with a FRAC designation WILL NOT BE
inherited from the associated MATRIX quantities:
R5000.0.1 Task Guides: Required File Structure Dual Porosity Modeling 675
PV, IRELPM, DEPTH, THICKNESS, NETTHICKNESS, POROSITY, KX,

KY,KZ, IROCK, GLOBALCELL,COMPR, (ALL ENDPOINTS).
• Quantities specified by FRAC designation are not inherited by any associated missing
MATRIX quantities
In this Chapter
• Vertical Equilibrium options.
• Transfer Function options
• Array and Map output options
• Well Specifications
Example
PROPERTY_FILES
GLOBALCELL Set 1 filename
GLOBALCELL FRAC Set 1 filename Required Array
PV Set 1 filename
PV FRAC Set 1 filename ⎜Required Array
CONNECTIONS Set 1 filename
CONNECTIONS FRAC Set 1 filename ⎜Required Array
CONNECTIONS MATRIXFRAC Set 1 filename ⎜Required Array
AQCONNS FRAC Set 1 filename ⎜Optional Array
ZCORNER Set 1 filename
LZ Set 1 filename ⎜Optional Array
DEPTH Set 1 filename
DEPTH FRAC Set 1 filename ⎜Required Array
IGRID Set 1 filename
IRELPM Set 1 filename
IRELPM FRAC
IXFER Set 1 Filename Optional Array
Set 1 filename ⎜Optional Array
OPTIONS Set 1 filename
EQUIL Method 1 f filename
ROCK_ARRAY_FILES
FVEGO Set 1 filename ⎜Optional Array
676 Task Guides: In this Chapter Dual Porosity Modeling R5000.0.1

FVEWO Set 1 filename ⎜Optional Array

FVEGO FRAC Set 1 filename ⎜Optional Array
FVEWO FRAC Set 1 filename ⎜Optional Array
ROCK_FILES
ROCK Method 1 filename
RELPM Method 1 filename ⎜Feature
RELPM Method 2 filename
XFER Method 1 filename ⎜Optional Array
PVT_FILES
PVT Method 1 filename
WATER Method 1 filename
AQUIFER_FILES
AQUIFER Method 1 filename
SEPARATOR Method 1 filename
RECURRENT_FILES
RUNCONTROL filename ⎜Feature
WELLS Set 1 filename ⎜Feature
SURFACE Network 1 filename
Vertical Equilibrium Options

When vertical equilibrium is invoked, the program internally generates the relative permeability
functions. Use of the directional relative permeability option results in a different set of functions
generated for the areal and vertical directions. The vertical equilibrium options let you activate
gas-oil (VEGO) or water-oil (VEWO) vertical equilibrium options for the specified relative per-
meability method.
Transfer Function Options

By default, the Nexus software will use the relative permeability methods specified for the
matrix-fracture cell pair to calculate the inter-porosity transport.
Alternatively, you can specify different relative permeability methods for the inter-porosity trans-
port (matrix-fracture) than are used for fracture-fracture. This is accomplished by specifying the
desired IRELPMs in the connection data.
Finally, special manipulation of the user-specified rock curves may be applied to inter-porosity
calculations by specifying the PSEUDO transfer function option. The PSEUDO option will mod-
ify the matrix capillary pressure (for matrix-fracture flow only) and will be applied to whichever
R5000.0.1 Task Guides: Vertical Equilibrium Options Dual Porosity Modeling 677
rock curve is active for that connection.
Warning:
Both LZ and ZCORNER must be defined if the PSEUDO option is used.
To summarize:
1. Use matrix cell and fracture cell relative permeability and capillary pressure curves as
entered (Default).
2. Use matrix-fraction connection specified relative permeability and capillary pressure curves
as entered (IRELPM).
3. Specify PSEUDO option in a XFER method. This will cause the capillary pressure calcula-
tions for the matrix to be calculated in a special way. Relative permeability calculations are
not affected by use of the PSEUDO option.
In all cases the upstream potential dictates the relative permeability values used and capillary
pressures are applied in the usual manner.
Array and Map Output

By default array and map output will contain all porosity types available. However, the user can
modify the output in using Run Control options.
Well Specification
Dual porosity wells can be specified within using the PORTYPE option in the WELLSPEC table.
678 Task Guides: Array and Map Output Dual Porosity Modeling R5000.0.1
Appendix A: Structured Grid Data
Introduction
This section describes arrays that are valid for the ASCII structured grid case file format, as
described in “ASCII Structured Grid Case File” on page 31.
Most of the options allowed in the structured grid file use the same format as the VIP-CORE®
software. Currently, the Nexus® software supports only a subset of the VIP-CORE options.
Any level of INCLUDE file is allowed, but the include path must conform to the Nexus conven-
tion for relative path names (relative to the directory of the file where they are defined).
Important: The content of this appendix should be considered as separate from the other Nexus
data. The data and data formats discussed in this section apply only to the ‘STRUCTURE_GRID’
data section in the Nexus case file and may cause errors if used in any other data sections. Many
of the conventions used for this data are derived from the VIP software and are used solely to
facilitate the migration of VIP array data to Nexus array data.
R5000.0.1 Introduction 679

Grid Definition and Utility Data
Grid Definition
The structured grid uses the following keywords and parameter rules for defining the grid.
Rectangular (Cartesian) Grid Definition (NX, NY, NZ)
Only the rectangular grid system is supported.
The basic grid description of NX, NY and NZ is required.
NX NY NZ
nx ny nz
where
NX Number of gridblocks in the x direction.
NY Number of gridblocks in the y direction. If nx = 1, then ny cannot

be > 1.
NZ Number of gridblocks in the z direction.
Note:
The extra entry NCOMP from a VIP-CORE deck may be present but it will be ignored when the
structured grid is generated.
Local Grid Refinement (LGR)
Cartesian LGRs are supported but optional.
All grid data is converted to corner point geometry This is equivalent to entering CORP array
data or specifying LGR/ENDLGR cards in the VIP-CORE software. Refined grids may be nested,
but there is a restriction that boundary cells may only be refined for the ROOT grid. Boundary
cells are those corresponding to I=1, I=NX, J=1, J=NY, K=1 and K=NZ for each grid.
LGR
CARTREF name
i1 i2 j1 j2 k1 k2
nx1 nx2 nx3 .........nx(i2-i1+1)
ny1 ny2 ny3 .........ny(j2-j1+1)
nz1 nz2 nz3 .........nz(k2-k1+1)
(OMIT io1 io2 jo1 jo2 ko1 ko2)
680 Structured Grid Data: Grid Definition and Utility Data R5000.0.1
(INGRID in1 in2 jn1 jn2 kn1 kn2)

(CARTREF name)
nested refinement
(ENDREF)
ENDREF
...
ENDLGR
where
CARTREF A cartesian grid is being defined.
name Name of grid being defined.
i1, i2, j1, j2, k1, k2 Indices defining the portion of the coarse grid to be refined.
nx1, nx2, . . . Number of x direction fine gridblocks for each of the corresponding
coarse gridblocks.
ny1, ny2, . . . Number of y direction fine gridblocks for each of the corresponding
coarse gridblocks.
nz1, nz2, . . . Number of z direction fine gridblocks for each of the corresponding
coarse gridblocks.
OMIT Range of coarse gridblocks to be removed from the refinement grid.

Can be repeated as needed.
io1, io2, jo1, . . . Indices defining the portion of the coarse grid to be removed from
the refinement.
i1 ≤ io1, io2 ≤ i2
j1 ≤ jo1, jo2 ≤ j2
k1 ≤ ko1, ko2≤ k2
INGRID Range of coarse gridblocks to be included in the refinement grid.

Can be repeated as needed.
in1, in2, jn1, . . . Indices defining the portion of the coarse grid to be included in the
refinement.
R5000.0.1 Structured Grid Data: Grid Definition and Utility Data 681
i1 ≤ in1, in2 ≤ i2
j1 ≤ jn1, jn2 ≤ j2
k1 ≤ kn1, kn2≤ k2
ENDREF End of data defining a refined grid.
Grid Utility Data

The structured grid uses the following keywords and parameter rules for defining the utility data.
Nonstandard Gridblock Connections (PINCHOUT)
PINCHOUT controls the generation of nonstandard gridblock connections between layers of the
grid system where pinchouts occur. Such connections will be generated automatically whenever
two layers are separated by one or more inactive blocks, where the total thickness separating them
is less than tolth. The transmissibilities generated in this way may be overridden by the use of
FTRANS cards.
PINCHOUT (tolnet) (tolth) (tolgrs) (NONE)
where
tolnet Gridblock net thickness tolerance, ft (m). Pore volume is set to zero
for blocks with a net thickness less than or equal to tolnet. Default
is 0.
tolth Interblock gross thickness tolerance, ft (m). A block is considered

to be “pinched out” if it is inactive and the gross thickness between
two active gridblocks is less than or equal to tolth. Default is
tolnet.
tolgrs Gridblock gross thickness tolerance, ft (m). Total volume and pore
volume are set to zero for blocks with a gross thickness less than or
equal to tolgrs. Default is tolnet.
NONE Keyword to turn off the automatic generation of pinchouts.
Fault Modeling (FAULTS)
FAULTS invokes the fault modeling option.
FAULTS
⎛ LATERAL ⎞
⎝ NONE ⎠
where
LATERAL Calculate connections, across any block on the other side of the
fault plane. Default only connects logically vertical blocks.
NONE Do not generate automatic faults or pinchout connections.
Corner Point Simulation (CORNER)
CORNER is used to set optional parameters for corner point grids. The user may set the variables
iquads, jquads, and kquads to control the accuracy of the integration process used for pore vol-
ume and transmissibility calculations. Corner point grids allow the user to describe more general
grid systems than those describable through the specification of block-size arrays only.
Some examples of the use of the corner-point option include the description of non-orthogonal
grids and the modeling of sloping faults and pinchouts. The user should take great care with the
use of this option, since less data checking is performed on the grid system description. The cor-
ner-point option is not compatible with radial or cylindrical grids.
When FAULTS is also specified, the corner-point option requires somewhat different specifica-
tion of faults than the standard fault data description. If the user specifies corner-point depths
(instead of explicit faults), the program will automatically generate fault connections.
When corner point grids are used, the program will automatically recognize pinchouts and gener-
ate the appropriate nonstandard interlayer gridblock connections. The FTRANS fault option
allows the user to overread the transmissibilities generated in this way.
CORNER (NEWTRAN (V98) (iquads jquads kquads)
where
CORNER Sets optional prearrangers for corner point grids.
NEWTRAN Invoke the NEWTRAN option for the inter-block transmissibility

calculation.
V98 Invoke the NEWTRAN calculation in use in version 98.
iquads Number of quadrature points (1 ≤ iquads ≤ 3) in the x direction.

Default is 3 (Default for NEWTRAN option is 2).
jquads Number of quadrature points (1 ≤ jquads ≤ 3) in the y direction.

kquads Number of quadrature points (1 ≤ kquads ≤ 3) in the z direction.

Example:
CORNER NEWTRAN 3 3 3
Fault Connections from Corner-Point Data (CORTOL)
CORTOL controls under what conditions block connections will be generated from corner-point
data. If a block connection value is less than one or more of the tolerance, a connection is not cal-
culated.
CORTOL tola tolt tolpv tolpn
where
tola Tolerance for relative overlap area for corner-point faults. When
LGR is on or CORP data is read, tola is the absolute overlap area,
sq. ft. (sq m). Default is 1.E-3.
tolt Tolerance for absolute transmissibility cutoff for corner-point

faults, rb-cp/day/psi (cm-cp/day/kPa). Default is 1.E-8 rb-cp/day/
psi.
tolpv Tolerance for pore volume cutoff, rb (m3). Pore volumes in cells
with calculated values less than tolpv are set to zero. OVER/
VOVER of pore volumes are applied after this check. Default is 0.
tolpn Tolerance for determining if corner-point gridblock corner points

are in vertical contact, ft (m). If the difference in depth between the
corner points at the top of layer n and the bottom of layer n-1 is less
than tolpn it is assumed layer n and n-1 are in contact and a non-
zero z-direction transmissibility is calculated. Default is 1.E-4 ft.
The CORTOL card is used to control under what conditions block connections will be generated
from corner-point data. If a block connection value is less than one or more of the tolerances, a
connection is not calculated.
Examples:
To change the overlap, transmissibility, and pore volume tolerances to 1.E-2, 1.E-7, and 100,
respectively:
CORTOL 1.E-2 1.E-7 100
Handedness of Coordinates (RIGHTHANDED)
The coordinate system used internally is left-handed. Corner-point data systems that are right-
handed must be identified by use of the keyword RIGHTHANDED as part of the utility data. If
not identified, right-handed systems will calculate negative pore volumes. CORP array data read
for ROOT and children grids must be either all left-handed or all right-handed.
RIGHTHANDED
where
RIGHTHANDED CORP array data are right-handed.
i x
2
j 1
y
z
4 3
k
5 6
8 7
Pinchout Gridblock Connections (PINCHGRID)
Pinchout connections are generated automatically. PINCHOUT is used to specify the tolerances
tolnet and tolth. By default, gridblocks having a net thickness less than or equal to tolnet will be
considered inactive (zero pore volume) only if the parent gridblock is also inactive. The PINCH-
GRID card allows for the application of the tolnet tolerance to gridblocks within a grid indepen-
dent of their parent.
PINCHGRID gridname1 (gridname2) ... (gridnamei)
where
PINCHGRID Alpha label indicating that the following named grids will be tested
against tolnet independently of their parent grid.
gridname Names of grids to be tested. If this list only contains the keyword
ALL, then all grid refinements will be tested.
Pore Volume Cutoff (TOLPV)
The TOLPV card is used to specify the pore volume cutoff tolerance, tolpv on a grid-by-grid
basis. Gridblocks with a pore volume less than tolpv will be considered inactive (zero pore vol-
ume). The pore volume test is only applied to the matrix blocks. OVER/VOVER of pore volumes
are applied after this check.
TOLPV (gridname1) (gridname2) ... (gridnamei) tolpv
where
TOLPV Alpha label indicating that the following named grids will be
assigned tolpv as the pore volume cutoff.
gridname Names of grids to be assigned tolpv. If this list only contains the
keyword ALL, or no grid names are provided, then all grid
refinements will be assigned tolpv.
tolpv Pore volume cutoff tolerance, rb (m3). Default for grids not
specified is the value specified by the CORTOL card.
Map File/VDB Control

Map file data is handled differently in the Nexus software than in VIP-CORE.
The following keywords specify the type of map file to be generated. The default is to generate a
binary map file.
MAPFORM Generate an ascii map file.
MAPBINARY Generate a binary map file (default).
MAPVDB Generate a binary map file and load it to a vdb.
FULLMAPARRAYS Write map array data in expanded full size array format. The default
is to write array data for only the active cells.
NOVDBPACK Write map array data in expanded full size array format.
NOVDBPACK has the same meaning and usage as

FULLMAPARRAYS. (Allowed for VIP keyword compatibility).
By default the target VDB will be the <casename>.vdb located in the Nexus case directory (.fcs).
The map file will be written to the directory containing the structured grid data
(STRUCTURED_GRID input in .fcs file). If specified by MAPVDB, the map file will be loaded
into the VDB's INIT class of data for the <casename> case. Any data existing in the INIT and
RECUR class of this study or case will be overwritten by this process.
Note that the vdb loading will be done through the dbmap utility, located through the VIPEXEC
environment variable.
On Linux, the VIPEXEC environment variable must also point to a directory where the rdb-
map.sh script is located to successfully load the map file into the vdb.
Domain Decomposition and Parallel Runs

VIP-like domain decomposition will be accepted, however the final decomposition will only
honor the card in one areal dimension.
Domain Decomposition of Cartesian Grids (DECOMP)
The DECOMP/ENDDEC data must follow the LGR data. If no LGR’s are defined, then the data
must follow the grid dimensions data, in which case the LGR option is turned on automatically
and the ROOT grid could be decomposed.
DECOMP
gridname1 ndx ndy ndz
(X npx1 npx2 npx3 ... npxndx)
(Y npy1 npy2 npy3 ... npyndy)
(Z npz1 npz2 npz3 ... npzndz)
(gridname2 (KEEP) ndx ndy ndz)
.
.
.
ENDDEC
where
DECOMP Keyword for introducing grid decomposition data.
gridnamei Name of grid to be decomposed.
Note: Nested grids make decomposition dependent on grid order. It

is recommended to specify the most refined grids first.
ndx, ndy, ndz Number of domains in the x, y, z directions.
X, Y, Z Optional keywords that allows control of the size of each new

subdomain.
npx1, npx2,... Number of x direction parent grid blocks in each new domain.
npy1, npy2,... Number of y direction parent grid blocks in each new domain.
npz1, npz2,... Number of z direction parent grid blocks in each new domain.
ENDDEC End of grid decomposition data.
Note
For problems with LGRs, the DECOMP data is ignored and a decomposition is produced on a
grid basis.
DUAL Arrays
Dual porosity input is not currently supported for the Nexus software.
Grid Arrays
Arrays
For each grid, array data are entered following the ARRAYS keyword.
Start of Arrays Data (ARRAYS)
ARRAYS (grid name)
where
ARRAYS Indicates beginning of array data for each grid
grid name Name of grid for which the following array data applies. The
default grid name is ROOT, which is the name of the top level grid.
Arrays use their Nexus unstructured input names whenever they
exist (KX POROSITY …). VIP-CORE-like names are supported
for some of the arrays.
The input format is similar to VIP-CORE:
<Array name> format (amin amax)
where
format Uses one of the following:
Keyword Definition
CON Requires one value for input. The entire
array is constant for all gridblocks.
XVAR Requires NX data values. For certain cor-
ner-point arrays NX+1 data values are
required.
XVAR varies the array property in the x

direction, while holding it constant in the y
and z directions. This usually is used with
the DX array.
R5000.0.1 Structured Grid Data: Grid Arrays 689

Keyword Definition
YVAR Requires NY data values. For certain cor-
ner-point arrays, NY+1 data values are
required.
YVAR varies the array property in the y

direction, while holding it constant in the x
and z directions. This usually is used with
the DY array.
ZVAR Requires NZ data values. For corner-point
arrays NZ+1 data values are required.
ZVAR varies the array property in the z

direction while holding it constant in the x
and y directions. This is useful for reading
data that varies by layers.
VALUE Requires NX*NY*NZ data values.
For corner-point arrays

(NX+1)*(NY+1)*(NZ+1) or
NX*NY*(NZ+1) data values are required,
depending on the array. Each gridblock
must be assigned a value. The values are
input by x-direction rows. All rows for the
first xy plane are entered in order of
increasing y index, followed by the remain-
ing planes in order of increasing z index.
Although the number of data values on a

line is essentially unrestricted, the user
should order his array data as rows or mul-
tiples of rows to make data entries at spe-
cific locations easily referenced. This can
be further clarified with the use of comment
cards.
MULT Requires one value and the source array.
Allows the user to define a new array from

a previously-defined array. Each element of
the new array is a constant multiple of the
previously defined array.
Note: MULT cannot be used with the

XCORN, YCORN, and ZCORN arrays.
These arrays are not supported by the struc-
tured grid format.
690 Structured Grid Data: Grid Arrays R5000.0.1

amin Minimum value against which data values are checked (optional).
amax Maximum value against which data values are checked (optional).

The DEPTH and MDEPTH arrays allow the following extra formats:
Automatic Generation of Values for Layers (LAYER)
NOTE: While LAYER is supported for all arrays in the VIP software, it is currently only sup-
ported for DEPTH/MDEPTH in the Nexus software.
The LAYER option replicates the values provided for the first layer for each of the other layers of
the grid. When used with non-corner-point arrays, the LAYER option requires NX*NY values.
When used with other corner-point arrays, the LAYER option requires (NX+1)*(NY+1) data val-
ues.
To use the LAYER option with the DEPTH or MDEPTH arrays, the DZ array must have been read
previously. The depth of each gridblock in the first layer (K = 1) is read. The depths of the remain-
ing gridblocks are then calculated from the depths of the gridblocks in the first layer and grid-
block thicknesses.
When MOD cards are used with this option, only the specified locations are changed; the depths
of the locations not specified on the MOD cards are not recalculated. For example, if the depths of
layer 1 are modified, then the depths of the other layers are not recalculated. Thus,
DEPTH (layer 2) ≠ DEPTH (layer 1) + DZ (layer 1). 00
Indiscriminate use of the MOD card may therefore result in different layers occupying the same or
overlapping positions.
To avoid this problem MODLYR cards may be used. When the depths of layer 1 are modified
using MODLYR cards, the depths of the remaining layers are recalculated.
DEPTH LAYER
values
where
LAYER The LAYER option replicates the values provided for the first layer
for each of the other layers of the grid. When used with other
corner-point arrays, the LAYER option requires (NX+1)*(NY+1)
data values.
To use the LAYER option with the DEPTH or MDEPTH arrays, the
DZ must have been read previously. The depth of each gridblock in
the first layer (K = 1) is read. The depths of the remaining
gridblocks are then calculated from the depths of the gridblocks in
the first layer and gridblock thicknesses.

Block Depths from Origin (DIP)
Note: The DIP option can be used only to enter the DEPTH and MDEPTH arrays. It cannot be
used with the XCORN, YCORN, and ZCORN arrays. These arrays are not supported by the struc-
tured grid format.
When used with the DEPTH or MDEPTH arrays, the DZ array must have been previously read.
Using the DIP option, the Nexus software calculates the data values for the first layer of grid-
blocks based upon the DIP information, then calculates the depths for the remaining gridblocks
based upon the thicknesses using the LAYER option.
The depth of each gridblock in the first layer is calculated from a reference depth (dref), the dip
angle in the x direction (xdip), and the dip angle in the y direction (ydip).
If only the reference depth is given, the system is considered non-dipping and each gridblock in
the first layer is assigned the depth value dref.
After a depth value is calculated/assigned for each gridblock in the first layer, the depths of the
remaining layers are calculated from the depths of the first layer and gridblock thicknesses.
When MOD cards are used with this option, only the specified locations are changed. The depths
of the locations not specified on the MOD cards are not recalculated. For example, if the depths of
layer 1 are modified, then the depths of the other layers are not recalculated. Thus,
DEPTH (layer 2) ≠ DEPTH (layer 1) + DZ (layer 1).
Indiscriminate use of the MOD card may therefore result in different layers occupying the same or
overlapping positions.
DEPTH DIP
dref xdip ydip
where
DIP Using the DIP option, the Nexus software calculates the data values
for the first layer of gridblocks based upon the DIP information,
then calculates the depths for the remaining gridblocks based upon
the thicknesses using the LAYER option.
dref Depth to the top (DEPTH) or middle (MDEPTH) of gridblock

(1,1,1) in a cartesian grid, ft (m).
xdip Dip in the x direction, measured between the x axis and horizontal,
decimal degrees. This can be omitted if both xdip and ydip are
equal to zero. A positive value indicates increasing depth.

ydip Dip in the y direction, measured between the y axis and the
horizontal, decimal degrees. This can be omitted if it is equal to
zero. A positive value indicates increasing depth.
On the following lines, the expected number of input values must be entered. The exception is
MULT, for which the multiplier value followed by the source array name key must be entered.
The following optional array modification options are allowed immediately after the array values
data:
Modify by Constant (MOD)
Note: MOD can be used with all arrays except CORP.
MOD is used to apply a constant arithmetic operation to a portion of the grid system. It modifies
the immediately preceding array data. Only one title card containing the keyword MOD is
required, but the data cards may be repeated as necessary.
MOD
i2 j2 k2
i1 j1 k1 #v (v2)
NX NY NZ
where
MOD Indicates that changes are to be made to the preceding array using
the MOD option.
Gridblock locations are defined by indices i, j, k in reference to the

(x, y, z) grid. Modifications are applied to array elements that fall in
the portion of the grid defined by:
i1 ≤ I ≤ i2
j1 ≤ J ≤ j2
k1 ≤ K ≤ k2
where i1, j1, k1 are numeric, i2 is numeric or NX, j2 is numeric or

NY, and k2 is numeric or NZ.
# An operator that describes how the array is to be modified. Any of

the following symbols may be used:

Operator Definition
+ Add.
- Subtract.
/ Divide
* Multiply.
= Equals.
GE Values smaller than v will be set to v2.
LE Values larger than vl will be set to v2.
There are no spaces between the operator and the value #v, except
when # is GE or LE.
v The value to be applied to the indicated portion of the array by

using the specified operation.
v2
The step value required for the GE and LE operators.
Replace Selected Values (VMOD)
Note: VMOD can be used with all arrays except CORP.
VMOD modifies the array data immediately preceding VMOD with an individual value for each
changed gridblock. A minimum of two data entries must follow VMOD. The first contains the
locations describing the gridblocks to be changed. The second contains the altered values for
those gridblocks. A new VMOD and its corresponding data are read for each different portion of
the grid system being altered.
VMOD
i2 j2 k2
i1 j1 k1 (op)
NX NY NZ
Values as necessary
where
VMOD Indicates that changes are to be made to the preceding array by

replacing selected values.


i1 ≤ I ≤ i2
j1 ≤ J ≤ j2
k1 ≤ K ≤ k2

op An optional keyword that defines the operation to apply to the

array. Any of the following symbols may be used:
Operator Definition
ADD Add.
SUB Subtract.
DIV Divide
MULT Multiply.
EQ Equals.
Enough values must be read to replace all array elements in the

designated portion of the grid. The number of required values is:
(k2 - k1 + 1) * (j2 - j1 + 1) * (i2 - i1 + 1)
The order of replacement is by x direction rows. All rows for the

first xy plane are entered in order of increasing J index, followed by
the remaining planes in order of increasing K index.
The values can be from INCLUDE files that are either binary or
formatted. They can also be from VDB files.

Modify Depth by a Constant (MODLYR)
Note: MOLDYER can be used with a DEPTH or MDEPTH array.
The MODLYR option is used to apply a constant arithmetic operation to the depth values of gridblocks in
Layer 1 of a grid system. The depth array must be the immediately preceding array, and the array option
LAYER or DIP must have been used. Only one MODLYR is required, but the data cards may be repeated
as necessary.
MODLYR
i2 j2
i1 j1 #v
NX NY
where
MODLYR Indicates that changes are to be made to the Layer 1 depths of the
preceding depth array.
Gridblock locations are defined by for Layer 1 by indices i, j in

reference to the (x, y, z) grid. Modifications are applied to array
elements that fall in the portion of the grid defined by:
i1 ≤ I ≤ i2
j1 ≤ J ≤ j2
K = 1
where i1, j1 are numeric, i2 is numeric or NX, j2 is numeric or NY.

Operator Definition
+ Add.
- Subtract.
/ Divide
* Multiply.
= Equals.
There are no spaces between the operator and the value #v.

v The value to be applied to the indicated portion of the array by

using the specified operation.
Modify a Constant (MODX, MODY, MODZ)
Note: MODX, MODY, and MODZ are used only with the CORP array.
The MODX, MODY, MODZ options are used to apply constant arithmetic operations to a portion
of the x, y, and z data entered with the CORP keyword. All eight cornerpoint values of each grid-
block included in the portion of the grid specified will be modified. The MODX, MODY, and
MODZ data need to immediately follow the CORP data. Multiple data cards may follow a
MODX, MODY, or MODZ keyword.
MODX
MODY
MODZ
i1 i2 j1 j2 k1 k2 #v
where
MODX Indicates that changes are to be made to the x coordinate values.
MODY Indicates that changes are to be made to the y coordinate values.
MODZ Indicates that changes are to be made to the z coordinate values.

(x, y, z) grid. Modifications are applied to x, y, or z coordinate
elements that fall in the portion of the grid defined by:
i1 ≤ I ≤ i2
j1 ≤ J ≤ j2
k1 ≤ K ≤ k2


Operator Definition
+ Add.
- Subtract.
/ Divide
* Multiply.
= Equals.
There are no spaces between the operator and the value #v.
v The value to be applied to the indicated portion of the x, y, z

coordinate arrays, according to the specified operation.
Grid Geometry
Three input formats are supported for arrays that define the grid geometry.
Block Along Coordinate Axis. (DX, DY, DZ, DEPTH, MDEPTH)
DX DY DZ DEPTH or MDEPTH (DZNET or NETGRS)
where
DX Incremental length of each gridblock in the x direction, measured

along the horizontal. ft (m)
Faults data are not currently supported for the DX input format (i.e,
no FX faults cards allowed).
DY Incremental length of each gridblock in the y direction, measured

along the horizontal. ft (m)
Faults data are not currently supported for the DY input format (i.e,
no FY faults cards allowed) .
DZ Gross vertical thickness of each gridblock. Net thickness is

assumed equal to gross thickness if no DZNET or NETGRS array
is read. ft (m)
DEPTH Depth to the top of each gridblock, measured from an arbitrary

datum, positive downward. ft (m)

MDEPTH Depth to the center of each gridblock, measured from an arbitrary

DZNET Net vertical thickness of each gridblock. Used only when gross
vertical thickness is specified with the DZ array. If net and gross
thickness are equal, use the DZ array.
The net pay is assumed to be evenly distributed across the entire

gross interval. If both gross and net thicknesses are input, gross
thickness is used only in the calculations of depth and vertical
transmissibility; net thickness is used to determine pore volume and
areal transmissibility.
NETGRS Ratio of net vertical thickness to gross thickness of each gridblock.

Default is 1.
Net/Gross ratio usually is input using the ZVAR or VALUE option.

Net/Gross ratio is used to calculate net from gross thickness. The
net pay is assumed to be evenly distributed across the entire gross
interval. Gross thickness is used in the calculations of depth and
vertical transmissibility; net thickness is used to determine pore
volume and areal transmissibility.
Block Along Bedding Plane (DXB, DYB, DZB, DEPTH, MDEPTH)
DXB DYB DZB DEPTH or MDEPTH (DZNET or NETGRS)
where
DXB Incremental length of each gridblock in the x direction, measured

along the bedding plane. ft (m)
Faults data are not currently supported for the DXB input format
(i.e., no FX faults cards are allowed).
DYB Incremental length of each gridblock in the y direction, measured

along the bedding plane. ft (m)
Faults data are not currently supported for the DYB input format
(i.e., no FY faults cards are allowed).
DZB Gross stratum thickness of each gridblock, measured perpendicular

to the bedding plane. Net stratum thickness is assumed equal to
gross thickness if no DZBNET array is read. ft (m)
DEPTH Depth to the top of each gridblock, measured from an arbitrary


MDEPTH Depth to the center of each gridblock, measured from an arbitrary

DZBNET Net stratum thickness of each gridblock, measured perpendicular to

the bedding plane. Used only when gross stratum thickness is
specified with the DZB array. If net and gross thickness are equal,
use the DZB array..
The net pay is assumed to be evenly distributed across the entire

gross interval. If both gross and net thicknesses are input, gross
thickness is used only in the calculations of depth and vertical
transmissibility; net thickness is used to determine pore volume and
areal transmissibility.

Default is 1.

Cornerpoint Grid (CORP)
CORP (EIGHT)
(NETGRS)
where
CORP (x, y, z) coordinate values.
24*NX*NY*NZ data values are required.
The default order is (x1, y1, z1), (x2, y2, z2), (x3, y3, z3) .............
(x8, y8, z8.

i x
j 2
1
y
z
4 3
k
5 6
8 7
The CORP array consists of eight (x, y, z) coordinate values for

each gridblock. The size of the CORP array is therefore 24 times
the number of gridblocks in a grid. The (x, y) values of CORP data
for different children grids need not all be relative to the same
origin. Each child grid is rotated and translated in a horizontal plane
so as to align with its corresponding parent grid. However, the z
(depth) values of different CORP arrays are required to be relative
to the same reference and consistent with other depth values used
elsewhere in the input data.
EIGHT Alternative order of CORP data.
(x1, x2, x4, x3, x5, x6, x8, x7),

(y1, y2, y4, y3, y5, y6, y8, y7),
(z1, z2, z4, z3, z5, z6, z8, z7

Default is 1.

For problems with LGRs and CORP, child grids can use the following:
• CORP array

• no geometry array input (the Nexus software will create the CORP by splitting the parent
CORP evenly according to the refinement size).
• DX, DY, and DZ arrays (the Nexus software will create the CORP by splitting the parent
CORP according to the weights entered on the DX/Y/Z arrays.)

Grid Physical Properties

Required Properties
Porosity and Permeability
POROSITY (or POR) KX KY KZ
where
POROSITY (or POR) Porosity of each gridblock. If both net and gross thickness are
input, porosity should correspond to the net thickness. fraction.
KX Permeability controlling flow in the x direction, applied to the

gridblock center. md (md)
KY Permeability controlling flow in the y direction, applied to the

KZ Permeability controlling flow between the layers, applied to the

Optional Properties
Optional properties include compressibility and permeability arrays to be used for well index cal-
culation.
Compressibility (COMPR)
Rock compressibility can be given a value for each gridblock. Typically rock compressibility can
be expressed as a function of porosity.
COMPR (or CR) option (amin amax nl)
where
COMPR (or CR) Rock compressibility of each gridblock. psi-1(kPa-1).
option Array input option.
amin Minimum value for data values (optional, unless amax is specified).
amax Maximum value for data values (optional, unless amin is specified).

Permeability Arrays for Well Index Calculations
When the COARSEN option is used, permeabilities have to be upscaled. The permeability arrays
KX, KY, KZ are used for transmissibility calculations and are upscaled using flow-based algo-
rithms from the UPSCALE card. In certain types of calculations, such as well PI and J-function
calculations, flow based upscaling is not appropriate.
The KWX, KWY, KWZ arrays are used for these other calculations. If only one of the sets of
arrays KX, KY, KZ or KWX, KWY, KWZ is input, the set not input will default to the input set.
The method for upscaling these well PI permeabilities may be specified on the UPSCALE card.
[KWX or KWY or KWZ] option (amin amax)
where
KWX Well PI upscaled permeability in the x direction. md (md)
KWY Well PI upscaled permeability in the y direction. md (md)
KWZ Well PI upscaled permeability in the z direction. md (md)
option Array input option.
amin Minimum value for data values (optional, unless amax specified).
amax Maximum value for data values (optional, unless amin specified).
Integer Arrays
The Nexus structured grid format supports the following integer arrays.
• IEQUIL - Equilibration method cell assignments.
• IPVT - PVT method cell assignments.
• IWATER - Water PVT cell assignments.
• IRELPM - Relative permeability method cell assignments.
(If no user imbibition is defined, the VIP-CORE ISAT array is supported instead.)
• IROCK - Rock method (compressibility) cell assignments.
If only pressure-induced compaction has been assigned, the VIP-CORE ICMT compaction
regions array is supported instead.

If only sw-induced compaction has been defined, the VIP-CORE IWIRC water-induced
compaction array is supported instead.
• ITRAN - Transmissibility region cell assignments.
• ITRACER - The tracer initialization method assigned to each grid cell.
• DEADCELL or LIVECELL - Active or inactive gridblock indicators (adapted from the VIP-
CORE software).
• IGRID - Computational grid assignments.
Note: If both IGRID and a DECOMP card are entered, the DECOMP card will be ignored.

Region Definition Arrays

The Nexus structured grid format supports the following region arrays.
Region Group Name (IREGION)
The region group name defaults to Output_Regions, and must have an entry on a REGDATA table
in the options file.
IREGION (region group name)
(IRegion is a Nexus array.)
Extra Regions (XREG)
The VIP-CORE “extra regions” card (XREG) is used to assign gridblocks to more than one output
region. This option only applies to the IREGION array. This option is allowed for compatibility reasons
with the VIP software, but IREGION with nondefault group name should be used instead of
XREG whenever possible. XREG is allowed only for the default group.
XREG
i1 i2 j1 j2 k1 k2 (= v)
where
XREG Indicates that extra output regions are being defined.

i1 ≤ I ≤ i2
j1 ≤ J ≤ j2
k1 ≤ K ≤ k2
v Region number assigned to the indicated portion of the IREGION

array. This value must be less than or equal to 99 and greater than
the largest value in the IREGION array. The “=” sign must precede
the value.
If this value is not specified, then enough values must be provided

on the following data cards for all blocks of the designated portion
of the grid. The number of values required is:
(k2 - k1 + 1) * (j2 - j1 +1) * (i2 - i1 +1)

Rock Arrays
The Nexus structured grid format supports the following rock arrays.
• SWL - Minimum water saturation.
• SWR - Residual water saturation.
• SGL - Minimum gas saturation.
• SGR - Residual gas saturation.
• SWRO - Water saturation at residual oil to water.
• SGRO - Gas saturation at residual oil to gas.
• SGRW - Gas saturation at residual water (GASWATER fluid systems only).
• KRW_SWRO (or KRWRO) - Krw at Swro.
• KRW_SWU - Krw at Swu.
• KRG_SGRO (or KRGRO) - Krg at Sgro.
• KRG_SGU - Krg at Sgu.
• KRO_SWL (or KROLW) - Kro at Swl.
• KRO_SGL - Kro at Sgl.
• KRO_SGR - Kro at Sgr.
• KRW_SGL - Krw at Sgl (GASWATER only).
• KRW_SGR - Krw at Sgr (GASWATER only).
• KRG_SGRW (or KRGRW) - Krw at Sgrw (GASWATER only).
• SGTR - Maximum trapped gas saturation (KRG hysteresis).
• SOTR - Maximum trapped oil saturation (KROW hysteresis).
• SWLPC - Minimum water saturation for PCWO curve (2PT Scaling only).
• SGLPC - Minimum gas saturation for PCGO/PCGW curves (2PT Scaling only).

User Initialization Arrays

The Nexus structured grid format supports the following user initialization arrays.
• SW - Initial water saturation.
• SG - Initial gas saturation.
• PRESSURE (or P) - Initial cell pressure.
• TEMPERATURE (or TEMP) - Reservoir temperature.
• SALINITY (or SAL) - Water salinity.
• API - The API gravity of the oil.
• WORKA1 (for use in FUNCTION).
• WORKA2 (for use in FUNCTION) .
• WORKA3 (for use in FUNCTION) .
WORKA1, WORKA2, WORKA3 are temporary work arrays that can be used as inputs to
FUNCTION. The FUNCTION option is explained in the next section of this chapter.
Multiplier Arrays
The Nexus structured grid format supports the following multiplier arrays.
• TMX - X-direction transmissibility multiplier.
• TMY - X-direction transmissibility multiplier.
• TMZ - X-direction transmissibility multiplier.
• PVMULT - Pore volume multiplier.

Functions for Arrays

The structured grid format supports the following FUNCTION option, which emulates the VIP-
CORE function option.
The function input option can be applied in reservoir simulations to:
• Calculate average values of rock property arrays in specified gridblocks using information
about their values in some reservoir locations.
• Represent some correlations between reservoir rock properties.
Functional dependencies can be represented in tabular or analytical forms. If the tabular function
option is applied, known values of output arrays at given values of input arrays should be input as
function table entries. In this case, an interpolation procedure is applied for the determination of
the values of the output arrays in reservoir gridblocks.
Note: For the interpolation option, only 1st and 2nd order interpolation are supported with a sin-
gle input array.
In the analytical function option, the values of the output arrays in the gridblocks are calculated as
an analytical function of input array values.
An advanced multidimensional spline interpolation technique is used for the tabular function rep-
resentation. The order of the spline and the number of the points of the function table, which are
used for the interpolation, are defined internally minimizing the interpolation error. In general, the
different number of the function table entries are used for the calculation of the function values in
different gridblocks. However, the user can control the number of the function table entries which
are used for the interpolation and the spline order using the parameter m in the FUNCTION card
and the DRANGE card.
The entries of the function table can be input in arbitrary order. However, they are internally
sorted for each gridblock in increasing order of a distance between values of the input variables in
the gridblock and in the function table. The first m entries of the sorted function table which sat-
isfy the constraints defined in the DRANGE card are used for the interpolation.
The function procedure can be executed only for selected blocks. These blocks are defined by the
FUNCTION, BLOCKS, and/or RANGE INPUT cards.
The optional ANALYT, BLOCKS, RANGE INPUT, RANGE OUTPUT, and DRANGE cards can
be input in arbitrary order.
Input or output variables in the function option can be integer arrays like ISAT, ISATI, IREGION,
IPVT, ICMT, and/or IEQUIL. They are internally transformed in a real data type and, then, the
standard function option is applied.

FUNCTION
FUNCTION (reg_type) (m p1 p2 . . . pN)

(r1,r2,...,rL)
(ANALYT function_type (a0 a1 ... an))
(BLOCKS i1 i2 j1 j2 k1 k2)
(RANGE INPUT xmin1 xmax1 . . . xminN xmaxN)
(RANGE OUTPUT ymin1 ymax1 . . . yminK ymaxK)
(DRANGE dr1 dr2 . . . drN)
inp_arr1...inp_arrN OUTPUT out_arr1...out_arrK
where
FUNCTION The function input table is defined.
reg_type Type of regions in which function input option is applied. One of

the following: ISAT, ISATI, IREGION, IEQUIL, ICMT, IPVT,
ITRAN, IWIRC.
m Maximum number of the function table entries which can be used

for the interpolation. The default value is the number of the entries
in the function table.
p1...pN Shifts of the first, second, ... , and N-th input arrays. They are
deducted from the values of the input variables in the function
table. The default values are zero.
r1,...,rL Region numbers. The function input option is applied only in

gridblocks which belong to one of these regions.
ANALYT Analytical function option.
function_type Analytical function type.
The following analytical functions can be used:
POLYN is the polynomial of the n-th order. The polynomial order n

can be not larger than nine. The value of the output array (y) in a
gridblock is determined as y = ao xn + a1 xn-1+ . . . + an, where x is
the value of the first input array in the gridblock;
ABS is the absolute value y = |x|;
EXP is the exponential function y = ex;
EXP10 is the exponential function y = 10x;

LOG is the natural logarithm y = ln|x|;
LOG10 is the common logarithm y = log10|x|;
SQRT is the square root ( y = x ); ;
GE is the step function
x, ifx greater than or equal to a 0

y =
a 1 , otherwise;
LE is the step function
x, if x is less than or equal to a 0

y =
a 1 , otherwise;
ADD is the sum of the values of the two input arrays in a gridblock y = x1
+ x2;
SUBT is the difference of the values of the two input arrays in a gridblock
y = x1 - x2;
DIV is the ratio of the values of the two input arrays in a gridblock
( x 1 ⁄ x 2 ) ,if x 2 is not equal tozero,

y = ,
x1 ;
MULT is the product of the values of the two input arrays in a

gridblock y = x1 × x2;
MIN is the minimum of the values of the two input arrays in a

gridblock y = min (x1,x2);
MAX is the maximum of the values of the two input arrays in a

gridblock y = max (x1,x2);

a0,a1,...,an Coefficients of the polynomial or step function;
BLOCKS Range of blocks is defined. The function input option is applied

only in gridblocks from this range.
i, j, k Gridblock locations are defined by indices i ,j, k in reference to the

(x, y, z) or (r, theta, z) grid. The function input option is applied to
gridblocks that fall in the portion of the grid defined by:
i1 ≤ I ≤ i2,
j1 ≤ J ≤ j 2 ,
k1 ≤ K ≤ k2.
If the BLOCKS card is not specified, the default values are:
i1 = j1 = k1 = 1,
i2 = NX, j2 = NY, k2 = NZ.
RANGE INPUT Ranges of input variables are defined.
xmin, xmax Minimum and maximum values of the input variables. The function
input option is applied only in gridblocks in which input variables
xi belong to the specified ranges:
xmini ≤ xi ≤ xmaxi, i=1, ..., N
If the RANGE INPUT card is not specified, the default values are:
xmin1 = xmin2 = . . . = xminN = -1.e+12,

xmax1 = xmax2 = , . . = xmaxN = 1.e+12.
RANGE OUTPUT Ranges of output variables are defined.
ymin, ymax
Minimum and maximum values of the output variables. The output

variable is set to the maximum value if the interpolated value of the
variable is larger than the maximum value. The output variable is
set to the minimum value if the interpolated value of the variable is
smaller than the minimum value.
If the RANGE OUTPUT card is not specified, the default values

are:
ymin1 = ymin2 = . . . = yminK = -1.e+12,

ymax1 = ymax2 = . . . = ymaxK = 1.e+12.

DRANGE Ranges of function table entries are defined.
dr1,...,drN Maximum distances from the input point. The j-th entry of the
function table (xj,1, xj,2,...,xj,N) is used for the interpolation of the
output variables at the input point (x1, x2, ..., xN) only if the
following constraints are satisfied:
|x1 - xj,1 | ≤ dr1,

|x2 - xj,2 | ≤ dr2,
....
|xN - xj,N | ≤ drN.
If the DRANGE card is not specified, the default values are:
dr1 = dr2 = . . . = drN = 1.e+12.
VOLAVR Currently the VOLAVR (volume average procedure) is not

supported.
The volume-averaged procedure is applied. The volume-averaged

values of the output variables in gridblocks are calculated. Only the
XC, YC, and MDEPTH arrays can be used as input variables in the
procedure. If the VOLAVR keyword is not included the output
variables are calculated at block centers.
inp_arr Name of an input array (input variable). Input arrays for a function
may be any of the user input arrays except the following:
CORP
nondefault IREGION
MDEPTH
XC
YC
COMPR (or CR)
OUTPUT This keyword separates the names of the input and output arrays.
out_arr Name of one of the arrays listed earlier in this chapter as being
supported by the Nexus structured grid option.
Several names can be included. The interpolation procedure is

executed for every output variable independently
Every function table entry should be input on one line. It should consist of N values of the input
variables and K correspondent values of the output variable. The function table entries can be
input in arbitrary order.

Note:
FUNCTION cards must appear after all array input and before any MULT card or fault data. Sev-
eral FUNCTION cards can be included in the data set.
Note:
When IREGION is used as an input or output array, and extra regions have been defined, the extra
region values are not involved in the FUNCTION calculations. For IREGION as input, only the
original region number is used in the function table lookup. For IREGION as output, only the
original region number is replaced; the extra region numbers are retained.

Array Propagation Rules

For problems with LGRs, arrays need to be defined at least for the ROOT grid level and are prop-
agated from parent to child grids if the array is not defined at the child level.
For rock arrays, the above restriction does not apply. For each grid where the array is not entered
or has not been entered in a parent, the relative permeability table value is used.
A value of -1 can also be used for any of the rock array to force the program to use the relative
permeability table value.
Functions will be applied following the user input order.

Grid Modifiers
The following modifiers are valid for structured grid data.
Arbitrary Gridblock Connections (FTRANS)

VIP-like FTRANS entries are allowed to define fault connections.
The FTRANS option allows you to specify arbitrary connections between gridblocks. The data
include the specifications of the two blocks and the value to be used for the interblock transmissi-
bility. FTRANS entries may also be used to modify the transmissibility between two blocks con-
nected (1) as a result of automatic fault generation due to data read for the CORP arrays, or (2) as
a result of the automatic detection of pinchouts. The simulator will not permit FTRANS entries to
define or modify the connection between two blocks that would ordinarily be connected in a stan-
dard unfaulted grid; the OVER and VOVER cards can be used for this purpose.
FTRANS
(GRID name)
(FNAME fname)
i1 j1 k1 i2 j2 k2 t
(repeat as necessary)
where
GRID Data applies to a particular grid.
name Name of the grid. Default is ROOT.
FNAME Alpha character keyword for assigning a name to the group of

connections defined by the following i1 j1 k1 etc. data. A
connection will be assigned to a name based on the last definition
encountered. By default no identifying name is assigned.
fname A character string or number by which the group of grid blocks is

identified. A maximum of 256 characters or numbers is allowed;
otherwise the string is truncated to the first 256.
i1 X direction index for the block on the “left” of the fault.
j1 Y direction index for the block on the “left” of the fault.
k1 Z direction index for the block on the “left” of the fault.
i2 X direction index for the block on the “right” of the fault.
j2 Y direction index for the block on the “right” of the fault.
R5000.0.1 Structured Grid Data: Grid Modifiers 717

k2 Z direction index for the block on the “right” of the fault.

t Transmissibility for the connection across the fault. This
replaces any other transmissibility defined for the pair of
blocks. Units for t are the same as those for
transmissibilities read for the standard transmissibility
arrays.
Note that the fault transmissibility unit is rb-cp/day/psi for the field unit system.
718 Structured Grid Data: Grid Modifiers R5000.0.1

Connection Transmissibility Modification (MULT)

VIP-like MULT entries allow the user to modify transmissibility multipliers defined using TMS,
TMY, and TMZ arrays. This option can also be used to assign a group of gridblocks to a name for use by
the MULTFL option.
The options on the MULT card can be specified in any order. One array name must be included on
each card. Other keywords are optional. If some option is not included the corresponding value
defined in the previous MULT card is used. For the first MULT card, the following default values
are used: ALL MINUS MULT.
The MULT cards are order-dependent. The MULT card allows the user to modify transmissibility
multipliers for standard and non-standard connections. Connections between Block (I, J, K) and
Blocks (I-1, J, K), (I+1, J, K), (I, J+1, K), (I, J-1, K), (I, J, K-1), (I, J, K+1) are defined as standard
connections. All other connections are non-standard, including grid-to-grid connections created
by user-defined LGR data and created by DECOMP data. The transmissibility multipliers for left
and right block faces in three coordinate directions can be specified. If a nonstandard transmissi-
bility multiplier for a block face is set to zero, then faulted connections are not automatically gen-
erated for this face.A minimum of one card must follow the MULT card.
The MULT cards must appear after all array input and before any fault data.
⎛ STD ⎞
⎜ ⎟ ⎛ MINUS ⎞
MULT array ⎜ NONSTD ⎟ ⎜ ⎟ (operator)
⎜ ⎟ ⎝ PLUS ⎠
⎝ ALL ⎠
(GRID name)
(FNAME fname)
i1 i2 j1 j2 k1 k2 (val)
(Repeat as necessary)
where
array One of the following: TX, TY, TZ.
NONSTD Nonstandard transmissibility multipliers are to be modified.
STD Standard transmissibility multipliers are to be modified.
ALL Standard and nonstandard transmissibility multipliers are to be

modified.
MINUS Transmissibility multipliers for the minus (from block center) faces
are to be modified.
PLUS Transmissibility multipliers for the plus (from block center) faces
are to be modified.

operator Defines the operation to apply to the transmissibility multipliers.

Any of the following keywords may be used:
ADD - add
SUB - subtract
DIV - divide
MULT - multiply
EQ- equal.

blocks defined by the following i, j, k range, and in a direction
(X,Y, or Z) consistent with the array specified on the MULT card. A
grid block will be assigned to a name based on the last definition
encountered. By default no identifying name is assigned. FNAME
is not allowed in combination with the PLUS option.
fname A character string or number by which the group of grid blocks is

identified. A maximum of 256 characters or numbers is allowed,
i1, i2 Range of grid blocks to be modified in the x (r) direction.
j1, j2 Range of grid blocks to be modified in the y (θ) direction.
k1, k2 Range of grid blocks to be modified in the z direction.
val The value to be applied to the indicated portion of the multiplier

array by using the specified operation. If this value is not specified,
then enough values must be provided in the following data cards to
modify transmissibility multipliers in all blocks of the designated
portion of the grid. The number of values required is: (k2 - k1 + 1) *
(j2 -j1 + 1) * (i2 -i1 + i).
Note:
For problems with LGRs, the multipliers will currently be applied from high- to low-level grid
order. This is different with VIP-CORE, where MULT cards are applied in the input order.

Inter/Intra Region Transmissibility Multiplier (MULTIR)

VIP-like MULTIR entries can be used to modify transmissibility between and within regions
defined through an ITRAN integer array.
The order of data entry must be OVER/VOVER, COARSEN, MULTIR, MULTFL, REGION/
REGSEP/REGDTM, INFLUX/FLUX, when such data are input.
MULTIR
itr1 itr2 tmul (X) (Y) (Z) (STD) (NONSTD)
Repeat as necessary)
where
itr1, itr2 Positive integer values identifying transmissibility regions. The

transmissibility regions are defined using the ITRAN and ITRANF
arrays. When itr1 and itr2 are different, the transmissibilities
between these regions are multiplied by tmul wherever they are in
contact. When itr1 and itr2 are equal the transmissibilities within
the region are multiplied by tmul.
tmul Transmissibility multiplier between regions itr1 and itr2 wherever

they are in contact.
XYZ Directions for applying the multiplier. The letters are order-
independent and spaces are optional. Default XYZ. Specifying all
directions also multiplies connections that do not have a direction
associated with them. Connections defined using FTRANS do not
have a direction.
STD Apply multiplier to the standard connections which include grid to

grid connections for local grid refinement.
NONSTD Apply multiplier to nonstandard connections (faults).
Notes
1. When neither STD or NONSTD are specified, both standard and nonstandard connections are
multiplied.
2. The multipliers are applied after the FTRANS, OVER, and COARSEN data. The multipliers
are cumulative
3. The matrix-to-fracture exchange transmissibility connections of the dual porosity option are
not effected by MULTIR.

Grid Override Options (OVER)

The OVER card is used to apply a constant arithmetic operation to a portion of the grid system.
Only one title card is required, but the data cards may be repeated as necessary. The parentheses
indicate optional values. They are not part of the data. Array names are shown in parentheses
since any combination of the arrays can appear on the title card. Do not use parentheses during
input. The array names can appear in any order. The order of #v’s on the data cards corresponds to
the order of the array names. Although several array names can appear on one OVER card, it is
generally less confusing to have “sets” of OVER cards, with each set modifying only one array.
OVER array (array)(array)(array)

(GRID name)
(FNAME fname)
i j K
2 2 2
i1 j1 k1 #v (v2) (#v (v2)) (#v (v2)) (#v (v2))
NX NY NZ
where
OVER Indicates array changes are to be made using the OVER option.
array One or more of the following array names.
PV The pore volume array is to be altered.
TX The x direction transmissibilities are to be altered.
TY The y direction transmissibilities are to be altered.
TZ The z direction transmissibilities are to be altered.

(X,Y, or Z) consistent with the array specified on the OVER card.
The assignment is only done if the array is a transmissibility array.
A grid block will be assigned to a name based on the last definition
fname A character string or number by which the group of gridblocks is



(x, y, z) grid. Modifications are applied to array elements lying in
i1 ≤ I ≤ i2
j1 ≤ J ≤ j2
k1 ≤ K ≤ k2


+ add
- subtract
/ divide
* multiply
= equal
GE values smaller than v will be set equal to v2
LE values larger than v will be set equal to v2
There are no spaces between the operator and the value, #v, except
when # is GE or LE.
v The value to be applied to the indicated portion of the

corresponding array by using the specified operation.
v2 The step value required for the GE and LE operators.
Note
1. The pore volume (PV) unit is rb and the transmissibility unit is rb-cp/day/psi for the field unit
system.
2. FNAME identifiers can also be assigned using other OVER and VOVER keywords. A grid-
block will be assigned based on the last identifier encountered.

Value Override Option (VOVER)

The VOVER option modifies the specified array data with an individual value for each changed
gridblock. A minimum of two cards must follow the VOVER card. The first contains the loca-
tions describing the gridblocks to be changed. The second contains the altered values for those
gridblocks. A new VOVER card and its corresponding data cards are read for each different por-
tion of the grid system being altered.
VOVER array
(GRID name)
(FNAME fname)
i j K
2 2 2
i1 j1 k1 (op)
NX NY NZ
where
VOVER Indicates changes are to be made to the specified array by replacing

selected values.
array One of the following array names:
PV The pore volume array is to be altered.
TX The x direction transmissibilities are to be altered.
TY The y direction transmissibilities are to be altered.
TZ The z direction transmissibilities are to be altered.

(X,Y, or Z) consistent with the array specified on the VOVER card.
The assignment is only done if the array is a transmissibility array.
A grid block will be assigned to a name based on the last definition
fname A character string or number by which the group of gridblocks is


(x, y, z) grid. Modifications are applied to array elements lying in

i1 ≤ I ≤ i2
j1 ≤ J ≤ j2
k1 ≤ K ≤ k2

op an optional keyword that defines the operation to apply to the array. Any
of the following keywords may be used:
ADD add
SUB subtract
DIV divide
MULT multiply
EQ equal
Enough values must be read to replace all array elements in the

designated portion of the grid. The number of values required is:
(k2 - k1 + 1) * (j2 - j1 + 1) * (i2 - i1 + 1).
The order of replacement is by x-direction rows. All rows for the

first xy plane are entered in order of increasing J index, followed by
the remaining planes in order of increasing K index.
Notes:
1. Only one array can be changed with each VOVER card.
2. The pore volume (PV) unit is rb and the transmissibility unit is rb-cp/day/psi for the field unit
system.
3. FNAME identifiers can also be assigned using other OVER and VOVER keywords. A grid-
block will be assigned based on the last identifier encountered.

Named Fault Region Transmissibility Multiplier (MULTFL)

The MULTFL keyword is used to modify the transmissibilities between grid blocks that have
been assigned a name. Grid blocks can be assigned a name using the FNAME parameter on the
MULT, FAULTS, OVER and VOVER options. Both standard and non-standard transmissibility
connections if any are multiplied.
The MULTFL keyword is also used to modify the transmissibility connections that are defined
and named with the FTRANS option. Only the non-standard transmissibility connections defined
with the FTRANS data will be effected, while any corresponding standard connections will be left
unaltered.
Note: All the transmissibility multipliers are cumulative. They are applied on top of any previ-
ously defined using other options.
The order of data must be OVER/VOVER, COARSEN, MULTIR, MULTFL, REGION/REG-

SEP/REGDTM, INFLUX/FLUX, when such data are input.
MULTFL fname tmul
where
MULTFL Alpha character keyword.
fname Name or number identifying the fault or group of grid block to be

operated upon.
tmul Transmissibility multiplier.

Grid Coarsening (COARSEN)

Grids can be coarsened by combining adjacent cells to form a coarse cell. Flow between coarse
cells is through nonstandard transmissibility connections that are computed automatically. Well
locations are specified with respect to the original fine grid dimensions.
You can use the i1, i2, ... window option to define the number of coarse blocks formed in each
coordinate direction.
COARSEN (gridname) ⎛ AUTO⎞

⎝ SEAL⎠
i1 i2 j1 j2 k1 k2 ( n xc nyc nzc )
(X nx 1 nx 2 nx 3 … … … … nx nxc )
(Y ny 1 ny 2 ny 3 … … … … ny nyc )
(Z nz 1 nz 2 nz 3 … … … … nz nzc )
Enter sets of data as needed.
where
COARSEN Keyword for introducing the grid coarsening data. The order of data
must be OVER/VOVER, COARSEN, MULTIR, MULTFL,
REGION/REGSEP/REGDTM, INFLUX/FLUX, when such data
are input.
gridname Name of grid being coarsened. Default is the root grid.
AUTO Detects faults, and varying integer properties within a coarsened

block, and skips the coarsening for such blocks, thus preserving the
fine-scale details.
The default will coarsen across faults, creating flow across faults
within each layer.
SEAL When coarsening across faults, does not connect layers that are not
connected by a standard connection in the fine grid.
The default will coarsen across faults, creating flow across faults
within each layer.
i1, i2, j1, j2, k1, k2 Indices defining a portion of the grid to be coarsened. This line may
be repeated to coarsen multiple portions of the grid.

nxc, nyc, nzc Number of coarse blocks formed in each coordinate direction, from
the portion of the grid defined by i1,i2,j1,j2,k1,k2. Default is 1,1,1
i.e. one coarse cell is created.
X,Y,Z Optional keywords that allow control of the grouping of the fine
gridblocks into coarse gridblocks.
nx1, nx2,... Number of fine gridblocks in each corresponding coarse gridblock

along the x direction.
ny1, ny2,... Number of fine gridblocks in each corresponding coarse gridblock

along the y direction.
nz1, nz2,... Number of fine gridblocks in each corresponding coarse gridblock

along the z direction.
Notes:
1. When X,Y,Z data are not specified, then nxc, nyc, nzc need to be integer fractions of (i2-
i1+1), (j2-j1+1), (k2-k1+1) respectively.
2. When X,Y,Z data are specified,
nxc
∑ nxi = i2 – i1 + 1
i=1
nyc
∑ nyi = j2 – j1 + 1
i=1
nzc
∑ nzi = k2 – k1 + 1
i=1
3. Coarsening at parent-child LGR interfaces is not allowed.
4. Coarse block integer properties (ISAT, ISATI, IEQUIL, IREGION, IPVT, IPVTW, ITRAN,
IWIRC, ICMT, OILTRF, GASTRF) are assigned from the fine blocks that sum to the largest
pore volume for a particular index.

Aquifer Connections (INFLUX)

You can enter aquifer connections to the a structured grid using VIP-like INFLUX options. Both
the Carter-Tracy and the Fekovitch methods are valid.
Carter-Tracy Aquifer Influx
The Carter-Tracy method provides good approximations to the Van Everdingen and Hurst analyt-
ical solutions for influx.
Fetkovich Aquifer Influx
The Fetkovich method utilizes the pseudo steady-state aquifer productivity index and an aquifer
material balance to represent the system.
Inputs
For both Carter-Trace and Fetkovich aquifer influx, the title and data cards must appear in the
order shown.
INFLUX ninf
IINF JINF KINF SINF (ALL)
iinf jinf kinf sinf
(repeat as required)
(GRID name)
(VALUE)
(WINDOW
i1 i2 j1 j2 k1 k2 sinf)
(ENDAQ)
where
INFLUX Indicates that the data being read are influx data.
ninf The identifying number of the “aquifer” being described.
The titles on the fifth card must appear as shown. The optional fifth keyword controls possible
connections to non-aquifer gridblocks
ALL Connect all specified blocks to aquifer. Default skips blocks that
are above the water-oil contact.
The number of data cards following the fifth card must equal nbinf,
unless an “ENDAQ” card is given.
iinf x direction index of a gridblock attached to this “aquifer”.

jinf y direction index of a gridblock attached to this “aquifer”.
kinf z direction index of a gridblock attached to this “aquifer”.
sinf Scale factor used to allocate the total “aquifer” influx/efflux among
the gridblocks attached to the “aquifer”. These are normalized
within the program, so values have only relative meaning. They
will usually reflect the cross-sectional area times the permeability
of the gridblock faces attached to the “aquifer”.
sinf may be any of the following:
=n The scale factor is set to “n”.
+n The scale factor is increased by “n”.
n The scale factor is increased by “n”.
-n The scale factor is decreased by “n”.
*n The scale factor is multiplied by “n”.
/n The scale factor is divided by “n”.
XCALC The scale factor is calculated in the x direction.
YCALC The scale factor is calculated in the y direction.
ZCALC The scale factor is calculated in the z direction.
For the WINDOW option, there are six additional options which
enable the user to easily assign an aquifer to an irregular grid
boundary. Starting on the specified face of the window and moving
inward, the aquifer is attached to the first active gridblock
encountered within the window. The options are:
I- Aquifer connects to the i- faces

I+ Aquifer connects to the i+ faces
J- Aquifer connects to the j- faces
J+ Aquifer connects to the j+ faces
K- Aquifer connects to the k- faces
K+ Aquifer connects to the k+ faces
The following keywords may also appear in these Data Cards:

VALUE Puts the reading of these Data Cards into VALUE mode, ends
WINDOW mode. Reads data cards of the form iinf, jinf, kinf, and
sinf.
WINDOW Puts the reading of these Data Cards into WINDOW mode, ends
VALUE mode.
In this mode, data must be entered as follows:
i1 i2 j1 j2 k1 k2 sinf
The range specified is the same as that given by the MOD card .
ENDAQ Indicates the end of the influx data cards. (optional)
Notes:
1. Aquifer connections to coarsened sections is not supported.
2. The non-grid aquifer parameters, including the aquifer type, should all be in the aquifer
method file, not the grid file

Structured Grid Example
! ----------------------------------------------------------------------------
! GRID DEFINITION
! ----------------------------------------------------------------------------
NX NY NZ
10 10 3
LGR
CARTREF REF1
1 1 1 1 1 3
3
3
1 1 1
ENDREF
ENDLGR
! PV tolerance for LGR grids
TOLPV ROOT 50.
TOLPV REF1 20.
! ----------------------------------------------------------------------------
! GRID DATA ARRAYS
! ----------------------------------------------------------------------------
ARRAYS
DX CON
1000
DY CON
1000
DZ ZVAR
20 30 50
DEPTH LAYER
100*8325
POROSITY CON
0.30431
KX ZVAR
500 50 200
KY MULT
1.1 KX
KZ ZVAR
0 50 25
732 Structured Grid Data: Structured Grid Example R5000.0.1

SALINITY CON
1
IREGION CON
1
XREG
1 3 1 1 1 1 =2
! Injection region assignment

IREGION Injection_Regions VALUE
300*1
ARRAYS REF1
KZ ZVAR
0 250 125
! ----------------------------------------------------------------------------
! Pore volume / transmissibility modifications
! ----------------------------------------------------------------------------
OVER PV
3 3 1 1 2 2 =0
! ----------------------------------------------------------------------------
! Analytical aquifer
! ----------------------------------------------------------------------------
INFLUX 1
IINF JINF KINF SINF
WINDOW
1 1 1 1 1 1 XCALC
VALUE
1 1 1 =1
ENDAQ
R5000.0.1 Structured Grid Data: Structured Grid Example 733

734 Structured Grid Data: Structured Grid Example R5000.0.1

Keyword Index
Numerics
2PHASE 269
2PT 708
A
A 442
ACENTR 128, 664
ACPGCR 373
ACTIVATE 423, 456
ACTIVE 19, 60
ADD 390, 392, 395, 397, 720
ADDITIONAL 72
ADDTUBING 330
ADDVALUE 435
ADJUSTTOTIME 232
ALL 72, 178, 232, 244, 253, 262, 270, 467, 719, 729
ALL_KEYWORDS 14, 17, 27, 28, 33
ALL1D 493
ALL2D 493
ALLOW 242
ALPHAMU 125, 273, 663
ALQ 422, 592, 596, 600, 604, 608, 612, 616
ANALYT 710, 711
ANGLA 283
ANGLE 282, 374
ANGLV 283
API 22, 60, 95, 96, 97, 145, 201, 204, 310, 709
APIDEFAULT 112
APIGROUP 112
AQCONNS 21
AQDEF 271
AQUIFER 24, 34, 70, 245
AQUIFER_FILES 15, 24, 34
AQUIFERFILE 246
ARRAYOUT 251, 256
ARRAYS 246, 689
AUTO 231, 727
AUTOGOC_COMP 208
AVG 429
R5000.0.1 Keyword Index 735

AVGGOR 430
AVGLGR 430
AVGWCUT 430
AZIZ 373
B
B 442
BACKFLOW 466
BAQ 219
BEGGS 372
BEGIN_API 145
BG 98, 102, 106
BGFAC 106
BHDEPTH 329
BHMD 330
BHP 406
BHP(ITHP) 594, 598, 602, 606, 610, 614, 618
BINA 131, 668
BINB 131, 668
BLACKOIL 95, 310
BLOCKS 710, 713
BO 98, 100, 104
BOFAC 104
BOSEP 142
BW 87, 91
C
C 442
CALC 322, 332, 340, 345, 353, 359
CALCCOND 434
CALCCONS 434
CALCMETHOD 430
CALCMULT 440
CALCONTIME 453
CARLSON 158
CARTER_TRACY 219
CARTREF 681
CELL 70, 252, 280
CELL1 64
CELL2 64
CELLAVG 322, 345
CELLGRAD 322, 345
CELSIUS 46, 119, 660
CFL 257
736 Keyword Index R5000.0.1

CHOKE 626
CLEAR 390, 392, 395, 397, 403, 406, 409, 413, 485
CLEARALQ 424
CLEARFUEL 420
CLEARLIMIT 418
CLEARP 406
CLEARQ 403, 409, 413
CMPLTIME 398
CMT 186
COARSEN 727
COATS 234
COMBINE_GRIDS 27, 29
COMBINEWELLS 362
COMMINGLE 387
COMP 91, 257
COMP_CNTR 634
COMPONENT 127, 216, 370, 664
COMPONENTS 118, 310
COMPOSITION 60, 207
COMPR 20, 60, 184, 704
COMPRESSOR 25, 30, 35, 467
CON 231, 289, 428, 434, 439, 460, 463, 689
CONCENTRATION 22, 370
CONDEFAULTS 319
CONLIST 392, 487
CONLIST_2D 399, 487
CONNECT 244, 347
CONNECTION 368, 456, 487
CONNECTIONS 18
CONPARAM 460, 463
CONSTRAINTS 400, 405, 411, 415, 420, 422
CONTROL 448, 452
CONTROLCON 449
CONTYPE 319
CORNER 683
CORP 701
CORRELATION 372
CORTOL 684
CP 99, 102, 106
CPR_PRESSURE_EQUATION 262, 265
CPUOUT 246
CR 184, 704
CR_REPRESSURE 187
CROSS_SHUT 333
CROSSFLOW 325, 333
CSORM 21, 60, 79

CT 220, 226
CTRL 427
CTRLCOND 428
CTRLCONS 428
CTRLMETHOD 429
CUT 263
CV 98, 102, 106
CVW 87, 91
CW 87, 91
CYCLE 492
CYCLELENGTH 263
D
D 443
DAMP 443
DAQI 221, 225
DATA 467
DATEFORMAT 14, 16, 27, 28, 32, 46
DATGRAD 329, 593
DATUM 327, 329, 593
DCMAX 232
DCRPT 232
DD/MM/YYYY 16, 28, 33, 47
DDEPTH 354
DEACTIVATE 423, 427, 456
DEADCELL 706
DEBUG 255
DECOMP 687
DEFAULT_UNITS 14, 16, 27, 32
DEFPROPS 664
DELTA 124
DEN 257
DENGAS 95, 96, 97
DENOIL 95, 96, 97
DENW 87
DEPTH 18, 60, 204, 207, 216, 282, 317, 339, 358, 378, 692, 699, 700
DEPTHTAB 244
DESC 14, 16, 27, 32, 46
DHCOR 373
DIAM 319, 331, 340, 343, 354, 360, 621
DINIT 200
DIP 693
DIR 64
DIRECT 264
DISALLOW 242

DIV 720
DMOBLIM 238
DO 492
DONTCLEAR 403
DP 104
DPADD 333, 341, 355, 361
DPBHAVG 409
DPBHMX 406, 408
DPLIM 238
DRANGE 710, 714
DRELPM 170
DRILL 398
DRILLSITE 366, 367, 398
DRILLTIME 366, 398
DRSDT 269
DSGLIM 239
DSLIM 238
DSW 188
DT 231, 246, 253, 467
DTGAS 458
DTTOL 246, 254
DTWATER 458
DUAL_SOLVER ON/OFF 263
DUKEAT 372
DUKLER 372
DUNROS 372
DVOLLIM 238
DX 699
DXB 700
DY 699
DYB 700
DZ 621, 699
DZB 700
DZBNET 701
DZLIM 238
DZNET 700
E
E 443
EFF 628, 635
EIGHT 702
ELEVATION 374
ELEVPR 332, 341, 345, 354, 360, 374
ELSE 491
ELSEIF 491

END_API 145
ENDACTIVATE 456
ENDAQ 729
ENDBINA 131, 668
ENDBINB 131, 668
ENDCHOKE 626
ENDCONDEFAULTS 322
ENDCONLIST 392
ENDCONLIST_2D 399
ENDCONPARAM 462, 464
ENDCONSTRAINTS 403, 406, 413, 418, 420, 424
ENDCONTROL 449
ENDDEACTIVATE 456
ENDDEBUG 255
ENDDEC 687
ENDDEFPROPS 664
ENDDO 492
ENDDRILL 398
ENDDRILLSITE 367
ENDELEVPR 375
ENDGRIDS 230
ENDGRIDTOPROC 83
ENDGROUP 361
ENDGUIDERATE 443
ENDIF 491
ENDINT_1D 483
ENDINT_2D 484
ENDINTERFACE 650
ENDLIMITS 620
ENDLOGICAL_1D 484
ENDLOGICAL_2D 484
ENDNODECON 355
ENDNODELIST 395
ENDNODES 318
ENDOUTPUT 246
ENDOUTSTART 244
ENDOVER 646
ENDOVER_MF 646
ENDPDCORR 373
ENDPROCS 485
ENDPROPS 127
ENDPT 324
ENDPTECL 324
ENDPTHLD 654
ENDPUMP_ CNTR 629, 635
ENDQMULT 425

ENDREAL_1D 484
ENDREAL_2D 484
ENDREF 682
ENDREGBLK 76
ENDREGDATA 77
ENDREGIONOUT 259
ENDREINJECTION 368
ENDRESV 315
ENDRIG 366
ENDRIGLIST 397
ENDSEPNODES 385
ENDSKIP 472
ENDSPEED 629, 635
ENDSPREADSHEET 254
ENDSTREAM_TRACER 370
ENDSTREAMS 311
ENDSTRUCTURED_MAPS 80
ENDTARGET 436
ENDTEMPGR 378
ENDTEMPPR 376
ENDTGTCON 440
ENDVALVE 624
ENDWAG 458
ENDWELLBORE 346
ENDWELLHEAD 342
ENDWELLLIST 390
ENDWELLNODE 348
ENDWELLS 335
ENGLISH 16, 27, 32, 46, 119, 659
EOS 118, 310
EOS_DEFAULTS 14, 17, 27, 29, 33
EOSDEFAULTS 660
EOSMETHOD 139
EOSOPTIONS 120, 128, 270
EQ 720
EQUIL 21, 33
EQUILREGION 244, 255
EXIT 492
EXPLICIT 380
EXTENDED 264
EXTRAPOLATE GAS 208
EXTRAPOLATE_OIL 208
F
F 443

FACILITIES 263
FAHR 46, 119, 659
FAULTS 682
FDL1 137, 143, 146
FDV1 137, 143, 146
FETKOVICH 223
FFUEL 420
FGAS 384
FIELD 253, 428, 434
FIELDPLOT 246
FIRST 493
FLASH_GIBBS_OFF 120
FLASH_GIBBS_ON 120
FLOW_UNSTABLE 379
FLOWSECT 282, 343, 347
FLT 64
FNAME 717, 719, 722, 724
FOIL 384
FRAC 18
FRACTURE 251
FREQ 246, 254, 467
FRPGCR 373
FSHRINK 420
FTOTAL 384
FTRANS 717
FUGERR 122, 271, 662
FULLMAPARRAYS 686
FUNCTION 709, 710, 711
FWATER 384
G
GAS 102
GAS_RATE 634
GASGRAD 327
GASLIFT 25, 29, 35
GASLIFTOPT 430
GASMF 205
GASVALUE 454
GASWATER 97, 310, 708
GBP_CB_MAX 461
GCUM 458
GCYCLE 232
GDWTABLE 174
GE 723
GLEFMIN 423

GLIFT 453
GLIFTCOST 454
GLIFTOPT 454
GLOBAL 262
GLOBALCELL 19, 60
GLOBALTOL 263
GLR 596, 600, 641
GLR_CB_MAX 461
GLR_CB_MIN 462
GLR_SHUT 460
GLRADD 423
GO_ONLY 67
GOC 200
GOR 96, 429, 592, 604, 641
GOR_CB_MAX 461
GOR_CB_MIN 461
GOR_SHUT 460
GOR_VALVE 463
GORMAX 417
GORPERF 417
GORPLUG 417
GOTABLE 152
GRAD 621
GRADCALC 321, 332, 340, 345, 353, 359
GRADIENT 380
GRATE 430
GRID 82, 283, 717, 719, 722, 724, 729
GRID_FILES 32
GRID_RED 265
GRIDBLOCK 244
GRIDS 230
GRIDSOLVER 264
GRIDTOPROC 82
GROUP 281, 357
GROUP_PERFS 418
GRPGCR 373
GSCUM 458
GUIDERATE 429, 442
GW3PHASE 156
GWC 201
GWR 612
GWTABLE 154
H
H 220, 225

HAG_BEG 372
HAGEDORN 372
HEAD 628, 634
HEATTR 388
HTC 320, 322, 331, 333, 355
HYD 25, 29, 34
HYDMAX 242
HYDRAULICS 246, 255, 379
HYDSTAB 466
HYSTERESIS 157
I
IALQ 594, 598, 602, 606, 610, 614, 618
IBAT 77, 320, 331, 339, 352, 358, 368, 385
ICMT 710
ID 626
IDL1 136, 142, 145
IDL2 136, 142, 146
IDV1 136, 143, 146
IDV2 136, 143, 146
IEQUIL 18, 60, 705, 710
IF 491
IFT 172
IGLR 597, 601
IGOR 593, 605
IGRID 19, 60, 706
IGWR 613
IINF 729
ILU 262, 265
IMMW 617
IMPES 232, 262, 268
IMPES_COUPLING 264
IMPLICIT 232, 268, 380
IMPLICIT_COUPLING 264
IMPLICIT_PRECON 265
IMPLICIT_RED 265
IMPSTAB 234
INCLUDE 275, 291, 471
INCREASE 443
INGRID 681
INIT_SINGLE 273
INITIALIZATION_FILES 14, 21, 33
INITIALIZE_ONLY 17, 28, 33
INJBHCONS 493
INJBHNODES 494

INJMOB 324, 333

INJTGTP 432
INJTGTPHC 433
INJWHCONS 493
INJWHNODES 494
INNERDIAM 320, 331, 340, 344, 354, 360
INSAT 203
INT_1D 483, 486
INT_2D 484, 486
INTEGER 486
INTERFACE 650
INTSAT 201
INTSW 67
IOCUT 613
IOGR 609
IPRES 640
IPVT 18, 60, 77, 320, 331, 339, 352, 358, 385, 705, 710
IQGAS 610
IQLIQ 601, 605, 640
IQOIL 593, 597, 640
IQWAT 613
IQWGAS 617
IREGION 20, 25, 60, 707, 710, 715
IRELPM 18, 60, 281, 289, 705
IRELPM1 64
IRELPM2 65
IROCK 18, 60, 705
IRREVERSIBLE CMT 187, 190
ISAT 710
ISATI 710
ITDPD 221
ITERATIONS 246
ITERATIVE 264
ITIME 493
ITR1 653
ITR2 653
ITRACER 19, 706
ITRAN 19, 706
IW 283
IWAT 77, 320, 331, 339, 352, 358
IWATER 18, 61, 705
IWCUT 593, 597, 601, 605, 640
IWGR 609
IWWGR 617
IXFER 19, 61, 65

J
JFUNC 162
JINF 729
JW 283
K
K 221, 225, 283
KELVIN 46, 119, 659
KEYCMPLIST 138
KEYCMPMF 139
KG 99, 107
KH 252, 280, 289
KHMULT 283
KINF 729
KMCMT 257
KP 185
KP_REPRESSURE 187
KPMULT 20, 61, 185
KR 257
KRDAMP 239
KRG 152, 154, 157, 161, 708
KRG_SGRO 23, 61, 168, 286, 708
KRG_SGRW 24, 61, 168, 287, 708
KRG_SGU 23, 61, 168, 287, 708
KRGRO 708
KRGRW 708
KRO_SGL 23, 61, 168, 287, 708
KRO_SGR 24, 61, 168, 287, 708
KRO_SWL 23, 61, 168, 287, 708
KRO_SWR 23, 61, 168, 287
KROG 152
KROINT 149
KROLW 708
KROW 150, 157, 160, 708
KRW 150, 154, 157, 160
KRW_SGL 24, 61, 168, 287, 708
KRW_SGR 24, 61, 168, 287, 708
KRW_SWRO 23, 61, 168, 286, 708
KRW_SWU 23, 61, 168, 286, 708
KRWG 174
KRWINT 176
KRWRO 708
KVGAS 145
KVOIL_H 145
KVOIL_L 145

KWX 705
KWY 705
KWZ 705
KX 19, 61, 162, 704
KXKY 162
KY 19, 61, 162, 704
KZ 20, 704
L
L 220, 225, 284
LAB 16, 28, 32, 46, 119, 659
LABEL 118, 219, 223
LATERAL 683
LAYER 692
LBC1 125
LBC2 126
LBC3 126
LBC4 126
LBC5 126
LE 723
LENGTH 283, 330, 341, 353, 360, 374, 376, 593, 597, 601, 605, 609, 613, 617, 621
LENGTHFLOW 374
LGR 430
LGRMAX 417
LGRPERF 418
LGRPLUG 417
LIMIT 269, 466
LIMITCFL 234
LIMITS 620
LINE_SEARCH 239
LINEAR 157, 219, 223
LINEARIZATION 255
LIQ_RATE 628
LIVECELL 706
LOCAL 446
LOGICAL 486
LOGICAL_1D 484, 486
LOGICAL_2D 484, 487
LOGOUT 249
LUMPED 322, 344, 345
LZ 61
M
MAPBINARY 261, 686

MAPFORM 261, 686

MAPOUT 251, 256
MAPS 246
MAPVDB 261, 686
MASS 91, 237
MATCHVIPPRES 205
MATRIX 18, 251
MATRIXFRAC 18
MAX 231, 242, 620
MAXBADNETS 233
MAXCUTS 234
MAXCYCLES 263
MAXDPDT 436
MAXINCREASE 232
MAXNEWTONS 233
MAXNOGLDT 454
MAXOPEN 468
MAXRIGS 367
MAXSW 158
MAXTRAP 158
MCO2 122, 660
MD 283, 347
MDCON 283
MDEPTH 700, 701
MDIN 355
MDOUT 355
METBAR 16, 28, 32, 46, 119, 659
METHOD 136, 145, 268, 321, 331, 340, 344, 352, 359
METKG/CM2 16, 28, 32, 46, 119, 659
METRIC 16, 27, 32, 46, 119, 659
MIN 231, 620
MINNOGLDT 454
MINUS 719
MIXED 321, 332, 345
MM/DD/YYYY 16, 28, 32, 47
MMW 616
MOB 257
MOBGRAD 327
MOD 694
MODLYR 697
MODX 698
MODY 698
MODZ 698
MOLEFRACTION 22, 61
MOLEX 257
MOLEY 257

MOLEZ 257
MOLWT 127, 664
MONTHLY 246, 254
MOVETIME 366
MULT 401, 690, 719, 720
MULTFL 726
MULTIFIELD 472
MULTIR 721
MW 257
MWGAS 142, 145
MWOIL 142
MWOIL _H 145
MWOIL _L 145
N
NA 353, 359, 428, 434
NAME 77, 80, 259, 311, 317, 328, 338, 351, 366, 367, 368, 370, 372, 427, 449, 653
NCOL 67
NCORNER 20, 61
NEGFLOWLIM 239
NET_METHOD_FILES 25, 27, 29, 34
NETFILL 434
NETGRS 700, 701
NETPLOT 247
NETSUM 247
NETTEMP 313
NETVOID 433
NETWORK 247, 253
NETWORKCOMP 247
NETWORKTRACER 247
NEWTON 493
NEWTRAN 683
NEXT 467
NHC 118, 310
NOCHK 108, 164
NOCPUOUT 247
NOCUT 263
NOCUTS 234
NODE 347, 357, 384, 487
NODECON 351
NODEIN 351, 393
NODEINJ 391
NODEINJBH 393
NODEINJWH 393
NODELIST 395, 487

NODEOUT 352, 393

NODEPROD 390
NODEPRODBH 393
NODEPRODWH 393
NODES 317
NOFRICT 320, 331, 341, 344, 354, 360
NOGRID 264
NOMATCHVIPPRES 205
NONE 164, 257, 353, 683
NONEQ 211
NONSTD 719, 721
NOONTIME 453
NORECOUT 247
NOREPORT 17, 28, 33
NORMAL 262
NOSLIP 372
NOSPLITS 385
NOTDATA 467
NOVDBPACK 686
NOW 468
NPSHR 629
NSMTAB 67
NSPLINE 178
NUMBER 77, 80, 318, 329, 340, 354, 359
NX 80, 680, 694, 695, 697, 722, 724
NY 80, 680, 694, 695, 697, 722, 724
NZ 80, 680, 694, 695, 722, 724
O
OCUT 612
OFF 234, 247, 253, 255, 259, 325, 387, 467
OGR 97, 608
OIL 100
OILGRAD 327
OILMF 205
OILVALUE 454
OMEGAA 127
OMEGAB 127
OMIT 681
ON 234, 253, 255, 259, 325, 387
ONTIME 320, 333
OPTIONS 21, 33
ORKISZ 373
OSCILLATION 255
OUTCON 384

OUTPUT 246, 259, 714

OUTSTART 244
OVER 646, 722
OVER_MF 646
OVERREAD 211, 244
OVERRIDE 25
OVERSHOOT 242
P
P 186, 257, 709
PAQI 221, 225
PARACHOR 128, 664
PARALLEL 255
PARENT 283, 439
PC 127, 257, 664
PCGO 152, 708
PCGOC 200
PCGW 154, 708
PCGWC 201
PCWO 150, 157, 160, 708
PCWOC 200
PD 729
PDCOR 247
PDCORR 372
PEACEMAN 234
PERF 237
PERFCOMP 247
PERFPLOT 248
PERFREV 237
PERFS 247, 253
PERFTRACER 247
PERMBASIS 162
PGMAX 406
PHASE 368, 442
PHASEID 125, 272, 662
PHI 221
PI 224, 334
PIN 592, 596, 600, 608, 612, 616
PINCHGRID 685
PINCHOUT 682
PINIT 200
PIPE 344
PIPEGRAD 344
PIPHASE 334
PLOTBINARY 261

PLOTFORM 261
PLOTVDB 261
PLUS 719
PMAX 267, 406, 449
PMIN 267, 405, 449
POR 704
PORBASIS 162
POROSITY 19, 61, 704
PORTYPE 280
POST_SMOOTH 263
POUT 592, 596, 600, 604, 609, 612, 616
POWER 423
PPERF 281, 289
PR 120, 660
PR_OLD 120, 660
PRECON_AMG 263
PRECON_AMG_RS 263
PRECON_ILU 263
PREF 87, 184, 185
PRES 98, 100, 102, 104, 106, 136, 142, 653
PRES_STD 139
PRESIN 373
PRESS_RED 265
PRESSURE 21, 61, 211, 640, 709
PRINT 67
PRIORITY 435, 485
PROC 82, 467
PROCS 485
PRODBHCONS 493
PRODBHNODES 493
PRODTGTP 433
PRODTGTPHC 433
PRODWHCONS 493
PRODWHNODES 493
PROPERTY_FILES 14, 17
PROPS 127
PRSTAB 166
PSAT 22, 61, 91, 104, 200, 204, 207, 257
PSEP 385
PSEUDO 67
PSTD 73
PTHLD 653
PUMP 25, 30, 35
PUMP_ CNTR 628
PV 18, 257
PVMLT 257

PVMULT 186, 189, 709

PVT 24, 29, 34
PVT_FILES 15, 24, 27, 29, 34
PWMAX 406
Q
QALL 427, 431, 624
QALLINJ 432
QALLMAX 401, 402
QALLMIN 413
QALLNETINJ 431
QALLNETPROD 431
QALLP 431
QALLPNETINJ 431
QALLPNETPROD 431
QALLPROD 432
QALLRMAX 402
QFUEL 420
QG 427, 430
QG_VALVE 464
QGAS 425, 608, 624
QGINJ 432
QGMAX 402
QGMIN 412, 413
QGNETINJ 431
QGNETPROD 431
QGP 431
QGPNETINJ 431
QGPNETPROD 431
QGPROD 432
QGSMAX 401, 402
QGSMIN 412
QGUIDE 435, 439
QHC 427, 430
QHCINJ 432
QHCMAX 402
QHCMIN 413
QHCNETINJ 431
QHCNETPROD 431
QHCP 431
QHCPNETINJ 431
QHCPNETPROD 431
QHCPROD 432
QLIQ 427, 430, 600, 604
QLIQINJ 432

QLIQMAX 401, 402

QLIQMIN 412, 413
QLIQNETINJ 431
QLIQNETPROD 431
QLIQP 431
QLIQPNETINJ 431
QLIQPNETPROD 431
QLIQPROD 432
QLIQSMAX 401, 402
QLIQSMIN 412
QLIQUID 624
QMAXINJ 232
QMAXPROD 231
QMIN 435, 439, 466
QMULT 425
QO 427, 430
QO_VALVE 463
QOIL 425, 592, 596, 624, 640
QOINJ 432
QOMAX 402
QOMIN 412, 413
QONETINJ 431
QONETPROD 431
QOP 431
QOPNETINJ 431
QOPNETPROD 431
QOPROD 432
QOSMAX 401, 402
QOSMIN 412
QSHRINK 420
QUARTERLY 248, 254
QW 427, 430
QW_VALVE 464
QWAT 612
QWATER 425, 624
QWGAS 616
QWINJ 432
QWMAX 401, 402
QWMIN 412, 413
QWNETINJ 431
QWNETPROD 431
QWP 431
QWPNETINJ 431
QWPNETPROD 431
QWPROD 432
QWSMAX 401, 402

QWSMIN 412
R
RADB 280
RADIAL 219, 223
RADW 280, 289
RANGE INPUT 710, 713
RANGE OUTPUT 710, 713
RANKDT 436
RANKINE 46, 119, 659
RATE 448
RATEMULT 334, 342, 355, 361
RE 225
REAL 486
REAL_1D 484, 486
REAL_2D 484, 487
RECFAC_TABLE 139
RECOUT 248
RECURRENT_FILES 15, 24, 27, 29, 34
REGAVG 428, 434
REGBLK 76
REGDATA 77
REGHCAVG 428
REGION 435
REGIONOUT 259
REGIONPLOT 248
REGIONS 248, 253
REINJECTION 368
RELPM 24, 34
REMOVE 390, 392, 395, 397
REPLACEMENT 398
REPORT 17, 27, 28, 33
RES_TEMP 75
RESERVOIR 27, 29, 82, 230, 259, 262, 466
RESTART 14, 16, 27, 28, 33, 248
RESV 315
REVERSIBLE 187, 190
REVERSIBLE CMT 187
REVERSIBLE WIRCT 190
RFT 248
RFTFILE 248
RFTWELLS 470
RIG 398
RIGHTHANDED 685
RIGLIST 397

RIGS 248, 366

RK 120, 660
RO 220, 225
ROCK 24, 34
ROCK_ARRAY_FILES 15, 23
ROCK_FILES 15, 24, 33
ROUGHNESS 320, 331, 341, 344, 354, 360, 621
RS 98, 100, 258
RSSAT 104
RSW 91
RUN_UNITS 14, 16, 27, 32
RUNCONTROL 25, 29, 34
RV 98, 102, 106
S
S 220, 225
SAL 258, 709
SALINITY 87, 91, 201, 204, 222, 226, 709
SAT 258
SATURATED 98
SCALE 329, 429
SCALED 157
SCALEQP 429
SCALING 164
SEAL 727
SECT 281
SEDIMENTATION 205
SEPARATOR 24, 29, 34
SEPNODES 384
SETTING 422, 624, 626
SG 21, 61, 152, 154, 161, 174, 211, 709
SGCPERFTOL 239
SGCTOL 239
SGL 23, 62, 167, 285, 708
SGLPC 23, 62, 167, 708
SGR 23, 62, 167, 177, 286, 708
SGRO 23, 62, 167, 178, 286, 708
SGRW 23, 62, 167, 178, 286, 708
SGTR 24, 708
SGU 23, 62, 167, 286
SHCGAS 388
SHCOIL 388
SHCWAT 388
SHUTIN_UNSTABLE 379
SHUTINOFF 325

SHUTINON 325
SINF 729
SINGLEFIELD 472
SKIN 280, 289
SKIP 472
SKIPBLOCKDCMAX 234
SKIPMASSCFL 234
SOLUBILITY 91
SOLVER 262
SOMOPT1 149
SOMOPT2 149
SOTR 24, 708
SPECG 95, 96, 97
SPEED 628, 634
SPREADSHEET 253
SRK 120, 660
STAGE 136, 142, 145
START 229
STATIC 487
STD 91, 719, 721
STK_C1N2 665
STK_C2 665
STK_CO2 665
STKATZ 128, 664
STKATZOFF 125, 128, 663
STONE1 149
STONE1_WAT 175
STONE2 149
STONE2_WAT 175
STREAM 329
STREAM_TRACER 370
STREAMS 311
STRENGTH 70
STRUCTURED_GRID 32
STRUCTURED_MAPS 80
SUB 720
SUPRIB 373
SURFACE 24, 29, 34, 428, 434
SW 21, 61, 150, 160, 211, 709
SWINIT 188
SWL 23, 62, 166, 285, 708
SWLPC 23, 62, 167, 708
SWMOPT1 175
SWMOPT2 176
SWR 23, 62, 167, 177, 285, 708
SWRO 23, 62, 167, 178, 286, 708

SWU 23, 62, 167, 285

SYSTEM_REDUCED 263
T
TAMULT 186, 189
TARG 466
TARGET 427, 442, 487
TARGETCFL 234
TARGETPLOT 248
TARGETS 248, 253
TC 127, 220, 664
TD 221, 729
TDPD 221
TEMP 87, 91, 118, 136, 142, 204, 207, 282, 318, 332, 341, 345, 360, 376, 709
TEMP_STD 139
TEMPERATURE 22, 62, 709
TEMPGR 378
TEMPLATE 248
TEMPPR 332, 341, 346, 354, 360, 376
TENI 172
TENTHR 172
TEST 466
TGTCON 439
THEN 491
THP 406, 593, 597, 601, 605, 609, 613, 617
THREEPOINT 164
TIME 274, 292, 473, 493, 655
TIMES 249, 253
TIMESTEP 249, 254
TINIT 200
TMX 709
TMY 709
TMZ 709
TNEXT 249, 254, 468
TOL 122, 178, 271, 660
TOLHYS 158
TOLPV 686
TOLREV 158
TOLREV_P 187
TOLREV_SW 190
TOLS 237
TOTAL 324
TRACER 222, 226, 370
TRACER_INIT 22, 33
TRANS 64

TRANS_TEST 122, 271, 661

TRANSITION 123, 272, 660
TSEP 385
TSTD 72
TSTPRF 418
TVD 374
TWOPOINT 164
TYPE 317, 320, 331, 339, 344, 352, 359, 448
U
UNITS 91
UNSATGAS 106
UNSATOIL 104
USE CLOSEST_GAS 208
USE_CLOSEST_OIL 208
USE_SPLINE 177
USEMASSCFL 234
USER 158
V
V98 683
VALUE 378, 430, 435, 690, 729
VALVE 25, 29, 35, 624
VAR 289
VARIABLE 620
VC 127, 624, 664
VEGO 170
VEGO_PC 170
VEWO 170
VEWO_PC 170
VG 98, 102, 106
VGFAC 106
VIP 380
VIPOFF 380
VIPUNITS 247
VISC 221, 621
VISPE 120
VISW 87
VMOD 695
VO 98, 100, 104
VOFAC 105
VOLAVR 714
VOLCON 237
VOLERR_PREV 239

VOLRPT 232
VSHIFT 128, 664
VSHIFTOFF 125, 128, 663
VW 91
W
W 220, 225
WAG 458
WAQI 226
WATCOST 454
WATER 24, 29, 34
WATERGRAD 327
WATERMETHOD 139
WATEROIL 96, 310
WATINJ 621
WCUM 458
WCUT 429, 592, 596, 600, 604, 640
WCUT_CB_MIN 461
WCUT_SHUT 460
WCUT_VALVE 463
WCUTMAX 415
WCUTPERF 416
WCUTPLUG 415
WCYCLE 232
WEI 226
WELL 338, 343, 347, 398, 425, 458, 487
WELLBORE 343
WELLCOMP 249
WELLCONTROL 446
WELLGRAD 327
WELLHEAD 338, 446
WELLLIST 390, 487
WELLMOD 289
WELLNODE 347
WELLPLOT 249
WELLS 25, 34, 249, 253, 328, 446
WELLSPEC 252, 280
WELLSRES 249
WELLTRACER 249
WGR 608
WGR_CB_MAX 461
WGR_SHUT 461, 462
WGR_VALVE 463
WI 281, 289
WIMULT 334

WINDOW 729
WIRCT 188
WO_ONLY 67
WOC 200
WOR_SHUT 460
WOR_VALVE 463
WORKA1 709
WORKA2 709
WORKA3 709
WORMAX 416
WORPERF 416
WORPLUG 416
WOTABLE 150
WOTABLE_IMB 160
WRATE 429
WSCUM 458
WTR 729
WWGR 616
X
X 282, 317, 329, 339, 358, 721, 728
X_LINE_GAUSS_SEIDEL 262, 265
X1 646, 650
X2 646, 650
XCORNER 20, 62
XEX 172
XINDEX 20, 62
XREG 707
XVAR 689
Y
Y 282, 318, 329, 339, 358, 721, 728
Y_LINE_GAUSS_SEIDEL 262, 265
Y1 646, 650
Y2 646, 650
YCORNER 21, 62
YEARLY 249, 254
YINDEX 20, 62
YVAR 690
Z
Z 721, 728
Z_LINE_GAUSS_SEIDEL 262, 265

Z1 646, 650
Z2 646, 650
ZC 127, 664
ZCORNER 21, 62
ZG 99, 102, 107
ZGIBBS 120, 270, 660
ZGIBBS_OFF 120
ZINDEX 20, 62
ZLIQ 142
ZOIL 145
ZONE 281, 409
ZVAR 690

Subject Index
A
activation ( network connections)
pressure constraints 405
activation (network connections)
rate constraints 400
activation (wells and network connections) 456
array
input (grid cell) data 58
map 256
output 256
override 645
array data
arithmetic operations on 698
define new from previous 690
gridblock depths 693
B
black oil pvt 93
C
completion data 280
compositional (EOS) pvt 116
binary interaction coefficients 131
component property data 127
default properties 658
options 270
compressibility
rock 184
connection, grid cell
input data 63
connection, network
configuration 303
defaults 319
lists 392
node connection data 351
R5000.0.1 Subject Index 763


reopening (shut-ins) 466
well connection data 328
wellbore connection data 343
wellhead connection data 338
constraints
clearing constraints 400, 403, 406, 413, 418
convergence tolerances 237
crossflow 325
D
deactivation (wells and connections) 456
depth
arithmetic operations on 697
of gridblocks 693
drill queue
output 248
E
endpoint mobility for injectors 324
endpoint scaling (relative perms) 164
F
files
hydraulics method file 591
hydrocarbon pvt properties 93
initialization (equilibration) 199
options file 71
override file 645
relative permeability file 147
rock method 183
run control 227
water properties 85
fluid systems
black oil (or volatile oil) 95
compositional (EOS) 116
EOS default properties 657
EOS options 270
764 Subject Index R5000.0.1

gas/water 97
water/oil 96
formulation specification 268
G
gas/oil ratio limits 417
gas/water fluid systems 97
gaslift
additive correction to optimal gaslift table 423
gaslift connection 353, 423
minimum gaslift efficiency 423
optimal gaslift table 639, 640
grid
structured grid 80
grid cell
connection data 63
data (array data) 57
grids
gridblock depth 693
how calculated 693
H
hydraulics
data (tables) 591
method files 591
table extrapolation limits 620
hysteresis parameters 157
I
impes stability 234
include files
run control 275
surface network 471
well 291
initialization
basic initialization data 200
equilibration method files 199
overreads 211
supercritical 210
injection targets 427

input
case file 13
formats 41
units 37
J
J-function 162
K
keyword format 41
rules 42
tabular input 43
tree-structured keywords 44
L
liquid/gas ratio limits 417
list
connection 392
connection, 2D 399
node 395
well 390
LUMPED 321
M
maximum run pressure 267
methods
equilibration (initialization) 199
for flashing fluids in place 76
hydrocarbon PVT methods 93
region PVT method assignment 77
region separator method assignment 77
relative permeability/capillary pressure 147
rock method 183
water properties methods 85
Minimum Rate Limits 411
minimum run pressure 227

N
network
activation/deactivation
node 317
connection data 351
definition 317
lists 395
O
options file 71
output
control 245
control at start of run 244
debug 255
file formats 261
printed and mapped arrays 256
overreads (initialization) 211
overrides (arrays and transmissibilities) 646
P
perforation data 280
PIPE 321
PIPEGRAD 321
procedures (predictive management) 481
functions and masks 495
production targets 427
PUMP 467
pumps
restarting 466
pvt
black oil systems 95
compositional (EOS) systems 116
gas/water systems 97
hydrocarbon properties 93
properties 93
region method assignments 77
water properties 85
water/oil systems 96

R
region
fluids in place calculation method 76
names 77
pvt methods 77
separator assignments 77
relative permeability / capillary pressure 147
endpoint scaling 164
gas/oil table 152
hysteresis 157
J-function for capillary pressure 162
kroint options 149
stone1 options 149
stone2 options 149
water/oil table 150
rock
compressibility 184
method file 183
run control 227
convergence tolerances 237
formulation 268
impes stability 234
iterative change damping (implicit) 238
max/min run pressures 267
solver parameters 262
start date 229
time step control 231
S
separation and stream splitting nodes 382
separator
region method assignments 77
solver control 262
Stone 162
structured grid data 31, 673
structured grids 80
surface network data 295
configuration 303
connection defaults 319
connection list 392
connection list, 2D 399
crossflow 325

description 298
elevation profiles 374
fluid system 310
hydraulics, correlations 372
hydraulics, gradients (hydrostatic) 380
hydraulics, options 379
injection targets 427
mobility, injectors 324
node definition 317
procedures (predictive management) 481
procedures (predictive management), functions and tasks 495
production targets 427
profiles, elevation 374
profiles, temperature 376
profiles, temperature gradient 378
reinjection 368
separations 382
stream composition 311
targets 427
temperature gradient profiles 378
temperature profiles 376
time data (in network file) 473
tree structured networks (GROUP) 357
well connection data 328
well list 390
T
targets 427
guide rate 439
minimum rate 439
time data
in network file 473
in run control file 274
in well file 292
time step control 231, 234
transmissibility
data 63
override 646

U
units 37
W
WAG Well 458
connection requirements 335
maximum pressure for gas injection cycle 406
maximum pressure for water injection cycle 406
water cut limits 415, 416
water/oil fluid system pvt 96
water/oil ratio limits 416
water-alternating-gas well 458
connection requirements 335
maximum pressure for gas injection cycle 406
maximum pressure for water injection cycle 406
well
completion data 280
connection data 328
connection defaults 319
include files 471
injection (stream) composition 311
lists 390
mobility, injectors 324
modification of completion data 289
perforation data 280
well and perforation limits
perforation limits 415
well limits 415
wellbore
configuration 278
connection 303

Nexus Keyword Document

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Nexus Keyword Document

Uploaded by

Copyright:

Available Formats

Nexus® Keyword Document

©2008 Landmark Graphics Corporation

Landmark Graphics Corporation

Table of Contents............................................................................................................ iii

The Case File .................................................................................................................... 13

Units Systems .................................................................................................................. 37

Keyword Format .............................................................................................................. 41

Output Files ....................................................................................................................... 51

Array Data ........................................................................................................................... 57

Pseudo Transfer Function ......................................................................................... 67

Aquifer Connection Data ............................................................................................ 69

Water Properties ............................................................................................................. 85

Hydrocarbon PVT Properties ................................................................................... 93

Units Selection ............................................................................................................. 119

Separator Methods ........................................................................................................ 135

Relative Permeability and Capillary Pressure ................................................ 147

Rock Properties ............................................................................................................... 183

Rock Compaction Options (Specified by Method)............................................................. 187

Equilibration Data ........................................................................................................... 199

Tracer Initialization ........................................................................................................ 215

Aquifer Data ....................................................................................................................... 217

Run Control........................................................................................................................ 227

Output Dual Porosity Data.................................................................................................. 251

Well Specification Data ............................................................................................... 277

Surface Network .............................................................................................................. 295

Default Crossflow Treatment (CROSSFLOW) .................................................................. 325

Valve Procedure Parameters (CONPARAM)..................................................................... 463

Procedures ......................................................................................................................... 481

Hydraulics Data ............................................................................................................... 591

Valve and Choke Data .................................................................................................. 623

Pump Data .......................................................................................................................... 627

Compressor Data ............................................................................................................ 633

Gaslift Data ......................................................................................................................... 639

Override Data .................................................................................................................... 645

Default EOS Properties ............................................................................................... 657

Task Guides ....................................................................................................................... 673

Structured Grid Data ..................................................................................................... 679

Grid Definition and Utility Data ......................................................................................... 680

Keyword Index ................................................................................................................. 735

Subject Index .................................................................................................................... 763

The Case File

The following data input is described in this chapter:

• A special form of the Case File for running modular tests.

R5000.0.1 The Case File: In This Chapter 13

The parameters are specified as follows:

14 The Case File: Case File R5000.0.1

EQUIL METHOD is filename

R5000.0.1 The Case File: Case File 15

MM/DD/YYYY Specifies that dates will be entered in the MM/DD/YYYY format.

DD/MM/YYYY Specifies that dates will be entered in the dd/mm/yyyy format.

RESTART Introduces restart input. This is followed by the TIME, LAST, or

16 The Case File: Case File R5000.0.1

The keyword TIME may be followed by a time in days (or hours

The restart directory name is the name of the restart directory

REPORT Specifies that a report of the input will be output to the

INITIALIZE_ONLY Specifies that the simulation will terminate immediately after

PROPERTY_FILES Introduces data input for the following reservoir properties.

R5000.0.1 The Case File: Case File 17

FRAC Keyword qualifier indicating that this file applies to fracture

MATRIXFRAC Keyword qualifier indicating that this file applies to matrix-fracture

CONNECTIONS Introduces a file containing cell to cell connection data. This is

PV Introduces a file containing cell pore volume data. This is followed

IRELPM Introduces a file containing relative permeability method cell

IPVT Introduces a file containing PVT method cell assignments. This is