VIP-EXECUTIVE Reference Manual

VIP-EXECUTIVE®
Reference Manual
© 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
Trademarks
3D Drill View, 3D Drill View KM, 3DFS, 3D Surveillance, 3DView, Active Field Surveillance, Active Reservoir Surveillance, ADC,
Advanced Data Transfer, ARIES, ARIES DecisionSuite, AssetConnect, Asset Decision Solutions, Asset Development Center,
AssetDirector, Asset Journal, AssetLink, AssetLink Advisor, AssetLink Director, AssetLink Observer, AssetObserver, AssetObserver
Advisor, Asset Performance, AssetPlanner, AssetSolver, AssetSolver Online, AssetView, BLITZPAK, CasingLife, CasingSeat,
COMPASS, Corporate Data Archiver, Corporate Data Store, Data Analyzer, DataManager, DataStar, DBPlot, Decision Management
System, 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 Infrastructure, DecisionSpace Nexus, DecisionSpace
PowerModel, DecisionSpace PrecisionTarget, DecisionSpace Reservoir, DecisionSpace TracPlanner, DecisionSpace Well Seismic
Fusion, DecisionSpace WellSolver, DecisionSuite, DepthTeam, Depth Team, DepthTeam Explorer, Depth Team Explorer, DepthTeam
Express, Depth Team Express, DepthTeam Extreme, Depth Team Extreme, DepthTeam Interpreter, Depth Team Interpreter, Desktop
Navigator, DESKTOP-PVT, DESKTOP-VIP, DEX, DIMS, Discovery, Discovery Asset, Discovery FrameBuilder, DMS, Drillability Suite,
Drilling Desktop, DrillModel, Drill-to-the-Earth Model, Drillworks, Drillworks ConnectML, 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, ezFault, ezModel, ezSurface, ezTracker, FastTrack, FG+, FieldPlan, Field Scenario Planner, FZAP!,
GeoAtlas, GeoDataLoad, GeoGraphix, GeoGraphix Exploration System, GeoLink, GeoProbe GF DataServer, GES, GES97,
GESXplorer, GMAplus, GMI Imager, GRIDGENR, Handheld Field Operator, HHFO, I2 Enterprise, iDIMS, IsoMap, iWellFile, i Wellfile,
KnowledgeSource, Landmark, Landmark Decision Center, Landmark & Design, Landmark Logo and Design, Landscape, Lattix,
LeaseMap, LMK Resources, LogEdit, LogM, LogPrep, Make Great Decisions, MathPack, MIMIC, MIMIC+, Model Builder,
MyLandmark, Nexus, Object MP, OpenBooks, OpenJournal, OpenSGM, OpenVision, OpenWells, OpenWire, OpenWorks,
OpenWorks Development Kit, OpenWorks Well File, OpenWorks Production, PAL, Parallel-VIP, PetroBank, PetroBank Explorer,
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, Pressworks,
PRIZM, Production Asset Manager, Production, 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+, 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, Reservoir Framework Builder, RESev,
ResMap, RightTime, RTOC, SCAN, SeisCube, SeisMap, SeisModel, SeisSpace, SeisVision, SeisWell, SeisWorks, SeisWorks 2D,
SeisWorks 3D, SeisWorks PowerCalculator, SeisWorks PowerJournal, SeisWorks PowerSection, SeisWorks PowerView,
SeisXchange, Semblance Computation and Analysis, Sierra Family, SigmaView, SimConnect, SimConvert, SimDataStudio,
SimResults, SimResults+, SimResults+3D, SIVA+, SLAM, smartSECTION, Spatializer, SpecDecomp, StrataAmp, StrataMap,
StrataModel, StrataSim, StrataWorks, StratWorks, StratWorks 3D, StreamCalc, StressCheck, STRUCT, Structure Cube, Surf &
Connect, SynTool, SystemStart, SystemStart for Clients, SystemStart for Servers, System Start 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, TracPlanner Xpress, 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, Well Cost, 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 acknowledges that certain third party code has been bundled with, or embedded in, Landmark’s
software. The licensors of this third party code, and the terms and conditions of their respective licenses,
may be found at the following location:
..\Nexus-VIP5000.0.1\help\com\lgc\dspx\Third_Party.pdf
❖
Table of Contents
Preface
About This Manual
Chapter 1
Data Overview
1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-25
1.1.1 VIP-COMP Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-25
1.1.2 VIP-ENCORE Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-26
1.1.3 VIP-DUAL Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-26
1.1.4 VIP-POLYMER Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-27
1.1.5 VIP-THERM Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-27
1.1.6 Shared Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28
1.2 Typical Data Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
1.2.1 Well Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
1.2.2 Production Histories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
1.2.3 Pressure History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30
1.3 Data Deck Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31
1.4 Input Data Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-42
1.5 Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-47
1.5.1 General Utility Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48
1.5.1.1 Comment Lines (C) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48
1.5.1.2 Read Data from an External File (INCLUDE) . . . . . . . . . . . . 1-48
1.5.1.3 Stop Reading Data from the Current INCLUDE File
(ENDINC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-49
1.5.1.4 Echo Print On (LIST) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-49
1.5.1.5 Echo Print Off (NOLIST) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-49
1.5.1.6 Skip Data On (SKIP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
1.5.1.7 Skip Data Off (NOSKIP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
1.5.1.8 Columns To Be Read (NCOL) . . . . . . . . . . . . . . . . . . . . . . . . 1-50
1.5.1.9 Data Line Continuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-50
1.5.2 Well Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-51
1.5.3 Alternative Well Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-51
1.6 Files Used by VIP-EXECUTIVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-52
R5000.0.1 Table of Contents v

VIP-EXECUTIVE® Reference Guide Landmark
1.7 Units Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-55
Chapter 2
Utility Data
2.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57
2.2 Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57
2.2.1 Start of Time-Dependent Data (RUN) . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57
2.2.2 Calculate Memory Requirement (STORAGE) . . . . . . . . . . . . . . . . . . . . 2-58
2.2.3 Change Default Dimensions (DIM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58
2.2.4 Material Balance Option (OPTMBL) (Not available in VIP-THERM) 2-63
2.2.5 Volume Balance Option (VOLBAL)
(Not available in VIP-THERM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64
2.3 Formulation Options (VIP-COMP or VIP-ENCORE) . . . . . . . . . . . . . . . . . . . . . 2-64
2.3.1 Implicit form of Finite Difference Equations (IMPLICIT) . . . . . . . . . . 2-64
2.3.2 Explicit form of Finite Difference Equations (IMPES)
(Not available in VIP-THERM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-65
2.4 Results File Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-65
2.4.1 Plot File Format and Data Selection (PLOT) . . . . . . . . . . . . . . . . . . . . . 2-65
2.4.2 Compositional Plot File Format and Data Selection (CPLOT) . . . . . . . 2-66
2.4.3 Map File Format (MAP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-69
2.4.4 Flat File(s) for PLOT/MAP Instead of VDB File (NOVDB) . . . . . . . . . 2-70
2.4.5 VDB File for PLOT/MAP Data (VDB) . . . . . . . . . . . . . . . . . . . . . . . . . 2-70
2.4.6 Flow Vectors (FLOWVEC)
(Not accepted by VIP-THERM, see FLOWS card in VIP-CORE manual) . . 2-71
2.5 Pore Volume Deformation Option (PVDEF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-72
2.6 Conductive (Leaky) Fault Solution Options (Not available in VIP-THERM) . . . 2-73
2.6.1 Segregated Flow Assumption (SEGREG) . . . . . . . . . . . . . . . . . . . . . . . 2-73
2.6.2 Fully Coupled Calculation (LKCPLD) . . . . . . . . . . . . . . . . . . . . . . . . . . 2-73
2.7 General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74
2.7.1 Restarting Runs (RESTART) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74
2.7.2 Descriptive Run Information (TITLE1, TITLE2, TITLE3) . . . . . . . . . . 2-75
2.7.3 Beginning of Data (START) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-75
2.7.4 Time Specification for Reading Data (TIME) . . . . . . . . . . . . . . . . . . . . 2-76
2.7.5 Date Specification for Reading Data (DATE) . . . . . . . . . . . . . . . . . . . . 2-77
2.7.6 Run Termination (STOP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-77
2.7.7 End-of-File Marker (END) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-77
Chapter 3
Well Data
3.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-79
3.2 Well Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-79
3.2.1 Well Name and Location (WELL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-80
vi Table of Contents R5000.0.1

Landmark VIP-EXECUTIVE® Reference Guide
3.2.2 Describe Well Perforations (FPERF) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-83

3.2.3 Describe Well Perforations, VIP-DUAL (FPERF) . . . . . . . . . . . . . . . . . 3-95
3.2.4 Set Status of Well Perforations (PRFSTAT) . . . . . . . . . . . . . . . . . . . . . 3-97
3.2.5 Well Perforation Tolerances (PERFPT) . . . . . . . . . . . . . . . . . . . . . . . . . 3-99
3.2.6 Inclined and Horizontal Well Flow Correlation (BEGGS) . . . . . . . . . 3-100
3.2.7 Wellbore Friction Pressure Loss (NOFRICTION) . . . . . . . . . . . . . . . . 3-100
3.3 Surface Separation Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-101
3.3.1 Compositional Separator Battery, VIP-COMP or VIP-THERM
(SEPARATOR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-101
3.3.2 Black-Oil Separator Battery, VIP-ENCORE (SEPARATOR) . . . . . . . 3-104
3.3.3 K-Value Separation Data, VIP-ENCORE (SEPARATOR) . . . . . . . . . 3-107
3.3.4 Gas Plant Data Input (GASPLANT) (Not available in VIP-THERM) 3-110
3.3.5 Separator Switching (NEWSEP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
3.3.6 Surface Facility Model Input (TSFM) . . . . . . . . . . . . . . . . . . . . . . . . . 3-113
3.4 Well Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-114
3.4.1 Production Well Definition (PROD) . . . . . . . . . . . . . . . . . . . . . . . . . . 3-115
3.4.2 Injection Well Definition (INJ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-117
3.4.2.1 Temperature Specification (VIP-THERM) . . . . . . . . . . . . . . 3-119
3.4.2.2 Steam Quality Specification (VIP-THERM) . . . . . . . . . . . . . 3-120
3.4.2.3 Pressure Specification (VIP-THERM) . . . . . . . . . . . . . . . . . 3-120
3.4.2.4 Treatment of Water/Steam Injectors (VIP-THERM) . . . . . . 3-120
3.4.3 Define Additional Injection Rate for FSTD or FRES Wells (INJA) . . 3-124
3.4.4 Computation of Mobility for Gas Injectors (GINJMOB) . . . . . . . . . . . 3-124
3.4.5 Computation of Mobility for Water Injectors (WINJMOB) . . . . . . . . 3-125
3.4.6 Production Rates Outer Iteration Number (ITNSTP) . . . . . . . . . . . . . . 3-125
3.4.7 Water Injection Rates Outer Iteration Number (ITNSTQ) . . . . . . . . . . 3-125
3.4.8 Gas Reinjection Rates Outer Iteration Number (ITNGRE) . . . . . . . . . 3-127
3.4.9 Change Well Type Class (WLTYCH) . . . . . . . . . . . . . . . . . . . . . . . . . 3-128
3.5 Well Constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-130
3.5.1 Maximum Rate (QMAX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-130
3.5.2 Water Limit - Water Cut, Rate or Liquid-Gas Ratio Constraint
(WLIMIT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-131
3.5.3 Gas Limit - GOR or Rate Constraint (GLIMIT) . . . . . . . . . . . . . . . . . . 3-132
3.5.4 Steam Limit - Steam Rate or Steam-Oil Ratio Constraint (SLIMIT)
(VIP-THERM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-134
3.5.5 Economic Limit (ECOLIM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-135
3.5.6 Perforation Test Schedule (TSTPRF) . . . . . . . . . . . . . . . . . . . . . . . . . . 3-136
3.5.7 Perforation Water Cut, GOR, and/or SOR Limits (PRFLIM) . . . . . . . 3-137
3.5.8 Minimum Rate (QMIN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-138
3.5.9 Multiple Rate (QMULT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-139
3.5.10 Injection Gas Composition (YINJ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-140
3.5.11 Define Additional Injection Gas Composition (YINJA) . . . . . . . . . . 3-141
3.5.12 Injection Water Salinity (WSAL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-141
3.5.13 Time Interval Between Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-142
3.5.13.1 Global Specification (TEST) . . . . . . . . . . . . . . . . . . . . . . . . 3-142
R5000.0.1 Table of Contents vii

3.5.13.2 Specification by Well (WTEST) . . . . . . . . . . . . . . . . . . . . . 3-143

3.5.14 Fraction of Time That Well is on Stream (ONTIME) . . . . . . . . . . . . 3-144
3.5.15 Well Permeability-Thickness Multiplier (WKHMULT) . . . . . . . . . . 3-145
3.5.16 GOR Penalty (GORPEN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-145
3.5.17 GOR Constraint (GORCON, GORLIM) . . . . . . . . . . . . . . . . . . . . . . 3-146
3.5.18 Maximum Steam Rate for Producers (QSTMX) (VIP-THERM) . . . . 3-148
3.6 Pressure Constraints and Productivity Indices . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-148
3.6.1 Well Index (WI)(Skip if PI or FLOW orWIL or KHWI is used) . . . . 3-152
3.6.2 Productivity/Injectivity Index (PI)
(Skip if WI or RFLOW or WIL or KHWI is used) . . . . . . . . . . . . . . . . . . . 3-153
3.6.3 Radial Flow Equation Data (RFLOW)
(Skip if WI or PI or WIL or KHWI is used) . . . . . . . . . . . . . . . . . . . . . . . . . 3-154
3.6.4 Well Angle Open to Flow (FLOANG) . . . . . . . . . . . . . . . . . . . . . . . . . 3-156
3.6.5 Well Datum Depth (WLWDAT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-157
3.6.6 Bottomhole Pressure (BHP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-157
3.6.7 Tubinghead Pressure (THP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-158
3.6.8 Implicit Tubinghead Pressure Equations (IMPTHP) . . . . . . . . . . . . . . 3-159
3.6.9 Tubinghead Pressure Iteration Control (ITNTHP) . . . . . . . . . . . . . . . . 3-159
3.6.10 Maximum Drawdown Constraint (DPBHMX) . . . . . . . . . . . . . . . . . . 3-160
3.7 Wellbore Crossflow Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-161
3.7.1 Crossflow Option (XFON/XFOFF) (Not available in VIP-THERM) . 3-161
3.7.2 Wellbore Gradient Calculation (MBAWG) . . . . . . . . . . . . . . . . . . . . . 3-162
3.7.3 Wellbore Gradient Calculation (VIP-THERM) . . . . . . . . . . . . . . . . . . 3-163
3.8 Wellbore Flash Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-164
3.8.1 THP Convergence Control (BHPITN) . . . . . . . . . . . . . . . . . . . . . . . . 3-164
3.9 Wellbore Hydraulics Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-166
3.9.1 Wellbore Hydraulics Table Assignment (ITUBE) . . . . . . . . . . . . . . . . 3-166
3.9.2 Wellbore Hydraulics Table (BHPTAB) . . . . . . . . . . . . . . . . . . . . . . . . 3-167
3.9.3 Wellbore Hydraulics Table Switching (NEWBHPTAB) . . . . . . . . . . . 3-171
3.9.4 Wellbore Hydraulics Table for Injectors (BHITAB) . . . . . . . . . . . . . . 3-173
3.9.5 Additive Correction to BHP Tables (BHPADD) . . . . . . . . . . . . . . . . . 3-175
3.9.6 Artificial Lift Quantity (ALQ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-175
3.10 Gas Producers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-176
3.10.1 Assignment of Gas Producer THP Tables (GTHPWL) . . . . . . . . . . . 3-177
3.10.2 Gas Well THP Calculation Data (GASTHP) . . . . . . . . . . . . . . . . . . . 3-177
3.10.3 Z-factor/Viscosity Tables for Gas Producer THP (THPGTB) . . . . . . 3-178
3.11 Single Phase Injectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-180
3.11.1 Tubing Length Assignment (TUBE) . . . . . . . . . . . . . . . . . . . . . . . . . 3-180
3.11.2 Tubing Diameter/Friction Factor (DIAM) . . . . . . . . . . . . . . . . . . . . . 3-181
3.11.3 Specify Density and Viscosity Values (WTRTHP) . . . . . . . . . . . . . . 3-181
3.12 Pattern Balancing (Not available in VIP-THERM) . . . . . . . . . . . . . . . . . . . . . 3-182
3.12.1 Pattern Balancing Option (PATTN) . . . . . . . . . . . . . . . . . . . . . . . . . . 3-182
3.12.2 Assign Central Injection Wells to a Pattern or
viii Table of Contents R5000.0.1

Turn Off Pattern Balancing (PATNCI ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-183

3.12.3 Assign a Peripheral Production Well and Production Fractions to Multiple
Patterns (PATNPP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-185
3.12.4 Same Perforations in Pattern Gas and Water Injectors (WAGPERF) 3-186
3.12.5 Voidage Calculation Based on GOR (PTNGOR) . . . . . . . . . . . . . . . . 3-187
3.12.6 Hydrocarbon Volumes and Angles (ATWGVA) . . . . . . . . . . . . . . . . 3-187
3.12.7 MI Injection Target and Allocation Parameters (ATWGCL) . . . . . . . 3-188
3.12.8 Category Definitions and Injection Fractions (ATWGCT) . . . . . . . . 3-189
3.13 Non-Darcy Gas Flow (Not available in VIP-THERM) . . . . . . . . . . . . . . . . . . 3-190
3.13.1 Non-Darcy Gas Density and Viscosity Option (WNDGDV) . . . . . . . 3-190
3.13.2 Specify Rate-Dependent Skin Factors for Non-Darcy Gas Flow (WDNDG)
3-191
3.14 Automatic Recompletion Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-192
3.14.1 Recompletion Unit Status and Limit Data (RCMPPERF) . . . . . . . . . 3-192
3.14.2 Order for Opening Recompletion Units (RCMPOR) . . . . . . . . . . . . . 3-195
3.15 WAG (Water-Alternating-Gas) Wells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-196
3.15.1 WAG Injection Well Definition (WAG) . . . . . . . . . . . . . . . . . . . . . . 3-196
3.15.2 Maximum Rates for WAG Injectors (QMAXWG) . . . . . . . . . . . . . . 3-199
3.15.3 Bottomhole Pressure for WAG Injectors (BHPWAG) . . . . . . . . . . . . 3-200
3.15.4 Injection Temperature for WAG injectors (TINJWAG, VIP-THERM Only)
3-201
3.15.5 Timestep Controls for WAG Injectors (DTWAG) . . . . . . . . . . . . . . . 3-201
3.16 WBSIM (Gridded Wellbore) Well Definition (Not Available in VIP-THERM) . . . . . 3-202
3.16.1 WBSIM Well Perforations (COMPERF) . . . . . . . . . . . . . . . . . . . . . . 3-202
3.16.2 Dynamic Vertical Flow Transport Parameters Calculation . . . . . . . . 3-205
3.17 Automatic Cycle Control (VIP-THERM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-206
3.17.1 Cycle Tables (CYCLETABLE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-206
3.17.2 Cyclic Well Definition (CYCLIC) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-212
3.17.3 Cycle Phase Perforation Status (CPERF) . . . . . . . . . . . . . . . . . . . . . 3-212
3.17.4 Start Cycle (CSTART) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-214
3.17.5 Stop Cycle (CSTOP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-215
3.18 Condensate Banking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-216
3.18.1 Condensate Banking Calculation Parameters (CNDBNK) . . . . . . . . 3-216
3.18.2 . . . . . . . Selective Application of Condensate Banking (CNDBWL) 3-217
3.19 Well Index Multipliers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-219
3.19.1 Assignment of WI Multiplier Tables (WIMUWL) . . . . . . . . . . . . . . . 3-219
3.19.2 WI Multiplier Tables (WIMULTAB) . . . . . . . . . . . . . . . . . . . . . . . . . 3-219
3.19.3 Outer Iteration Number (ITNWIMULT) . . . . . . . . . . . . . . . . . . . . . . 3-220
3.19.4 Reset Cumulative Reservoir Production (RESETCUM) . . . . . . . . . . 3-221
R5000.0.1 Table of Contents ix

Chapter 4
Well Management Level Data
4.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-223
4.2 Well Management Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-223
4.2.1 Well Management Level Definition (GATHER, FLOSTA, AREA) . . 4-223
4.2.2 Fraction of Time Management Level is Onstream (ONTIME) . . . . . . 4-224
4.3 Production and Injection Targeting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-226
4.3.1 Production Target (PTARG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-226
4.3.2 Production Target History Option (PTARGH) . . . . . . . . . . . . . . . . . . . 4-228
4.3.3 Production Target Frequency (PTGFRQ) . . . . . . . . . . . . . . . . . . . . . . . 4-229
4.3.4 Options for Reduction of Rates to Meet Target (TRGOPT) . . . . . . . . 4-230
4.3.5 Order for Checking Phase Targets (TRGORD) . . . . . . . . . . . . . . . . . . 4-233
4.3.6 Minimum Rate for Use in Targeting Calculations (TRGQMN) . . . . . . 4-235
4.3.7 Well Rate Maximum Tolerances (TRGTOL) . . . . . . . . . . . . . . . . . . . . 4-236
4.3.8 Injection Target (ITARG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-237
4.3.9 Well Rate Scaleback Options with Targeting (LSCALE) . . . . . . . . . . 4-238
4.4 Minimum Rates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-240
4.4.1 Minimum Production Rates (PRDMIN) . . . . . . . . . . . . . . . . . . . . . . . . 4-240
4.4.2 Minimum Injection Rates (INJMIN) . . . . . . . . . . . . . . . . . . . . . . . . . . 4-241
4.5 Gas Cycling (Not available in VIP-THERM) . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-243
4.5.1 Shrinkage Gas Specification (GASSKG) . . . . . . . . . . . . . . . . . . . . . . . 4-243
4.5.2 Fuel Gas Specification (GASFUL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-244
4.5.3 Sales Gas Specification (GASSLS) . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-246
4.5.4 Makeup Gas Specification (GASMKP) . . . . . . . . . . . . . . . . . . . . . . . . 4-247
4.5.5 Makeup MI Specification (MIMKP) . . . . . . . . . . . . . . . . . . . . . . . . . . 4-249
4.5.6 Effective Gas Injection Target (ETRGOP) . . . . . . . . . . . . . . . . . . . . . . 4-250
4.5.7 Makeup Gas Composition (YINJMK) . . . . . . . . . . . . . . . . . . . . . . . . . 4-251
4.5.8 Reinjected Gas Composition (YREINJ) . . . . . . . . . . . . . . . . . . . . . . . . 4-252
4.5.9 Liquid Recovery Factors (RECFAC) . . . . . . . . . . . . . . . . . . . . . . . . . . 4-253
4.5.10 Invoke Major Gas Sales Option (PLANT) . . . . . . . . . . . . . . . . . . . . . 4-254
4.5.11 Gas Conditioning for Sales Gas and Fuel Gas (GASCOND) . . . . . . . 4-255
4.5.12 Natural Gas Liquid (NGL) Plant Data Input (NGLPLANT) . . . . . . . 4-256
4.5.13 Miscible Injectant (MI) Plant Data Input (MIPLANT) . . . . . . . . . . . 4-259
4.5.14 Liquified Petroleum Gas (LPG) Plant Data Input (LPGPLANT) . . . 4-262
4.5.15 Maximum Feed Rate to NGL Plant (NGLFED) . . . . . . . . . . . . . . . . . 4-264
4.5.16 Maximum NGL Rate (NGLOUT) . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-265
4.5.17 Maximum Feed Rate to LPG Plant (LPGFED) . . . . . . . . . . . . . . . . . 4-266
4.5.18 Maximum LPG Rate (LPGOUT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-267
4.6 Basic Gas Reinjection (GINJOP) (Not Available in VIP-THERM) . . . . . . . . . 4-268
4.7 Injection Regions (Not available in VIP-THERM) . . . . . . . . . . . . . . . . . . . . . . 4-269
4.7.1 Define the Injection Region Option (RINJOP) . . . . . . . . . . . . . . . . . . . 4-269
4.7.2 Assign Name to Injection Region (INJRNM) . . . . . . . . . . . . . . . . . . . 4-271
4.7.3 Maximum Source Water Injection Rate (IRSRCW) . . . . . . . . . . . . . . 4-271
x Table of Contents R5000.0.1

4.7.4 Assign Injection Wells to Injection Regions (INJRGR) . . . . . . . . . . . . 4-272

4.7.5 Distribution Percentage of Injection Rate to Injection Regions (IRPCTA) .
4-273
4.7.6 Assign Gridblocks to Injection Regions (INJREGN) . . . . . . . . . . . . . . 4-273
4.7.7 Specify How Distribution of Injection Fluid is to Occur (IRDIST) . . . 4-274
4.7.8 Forced Gas Injection Into Injection Regions (IRGAS) . . . . . . . . . . . . 4-277
4.7.9 Select Gas Project Prioritization Option (PRIOP) . . . . . . . . . . . . . . . . 4-280
4.7.10 Assign Name to Gas Project (PROJNM) . . . . . . . . . . . . . . . . . . . . . . 4-280
4.7.11 Assign Gas Injection Wells to Projects (PROJWL) . . . . . . . . . . . . . . 4-281
4.7.12 Prioritize Gas Projects (PRIIR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-281
4.8 Voidage Injection by Guide Rate (Not available in VIP-THERM) . . . . . . . . . . 4-282
4.8.1 Maximum Injection Target for a Group (INJTAR) . . . . . . . . . . . . . . . 4-282
4.8.2 Injection Guide Rate for a Group (INJGR) . . . . . . . . . . . . . . . . . . . . . 4-284
4.9 Water Injection Pumps (Not available in VIP-THERM) . . . . . . . . . . . . . . . . . . 4-285
4.9.1 Assign Injector Pump Characteristics Tables (IPUMP) . . . . . . . . . . . . 4-285
4.9.2 Water Injection Pump Discharge Pressure (PMPTAB) . . . . . . . . . . . . 4-286
4.9.3 Convergence Criteria (WTRPUMP) . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-286
4.10 Gaslift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-288
4.10.1 Gaslift Allocation (QLIFT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-288
4.10.2 Gaslift Gas Source (QLIFTA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-290
4.10.3 Optimal GLR Tables for Gaslift (GLRTAB) . . . . . . . . . . . . . . . . . . . 4-292
4.10.4 Optimal GLR Table Pointer for Gaslift (GLRTBP) . . . . . . . . . . . . . . 4-293
4.10.5 Maximum Well Gaslift Gas Rate (GLGMAX) . . . . . . . . . . . . . . . . . 4-294
4.10.6 Minimum Well Gaslift Gas Rate (GLGMIN) . . . . . . . . . . . . . . . . . . . 4-295
4.10.7 Additive Correction to GLR Tables (GLRADD) . . . . . . . . . . . . . . . . 4-296
4.10.8 Time Interval for Gaslift Gas Rate Calculations (TESTGL) . . . . . . . 4-297
4.10.9 Minimum Gaslift Efficiency (GLEFMN) . . . . . . . . . . . . . . . . . . . . . . 4-297
4.10.10 Performance Curve Option Data (PFMCRV) . . . . . . . . . . . . . . . . . . 4-297
4.10.11 Gaslift Gas in Gas Handling Loop (GLGOP) . . . . . . . . . . . . . . . . . . 4-300
4.10.12 Makeup Gaslift Gas Specification (QLIFTM) . . . . . . . . . . . . . . . . . 4-301
4.11 Multi-level Optimization of Gaslift Gas Utilization . . . . . . . . . . . . . . . . . . . . . 4-302
4.11.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-302
4.11.2 Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-302
4.11.3 Gaslift Optimization Outer Iteration Number (ITNGLG) . . . . . . . . . 4-303
4.12 Automatic Drilling Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-304
4.12.1 Drilling Rig Definition (DRLRIG) . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-304
4.12.2 List of Wells in Drilling Queues (DRILLQUEUE) . . . . . . . . . . . . . . 4-305
4.12.3 Target Specification (DRLTRG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-308
4.12.4 Drilling of Replacement Wells (DRILLWELL) . . . . . . . . . . . . . . . . . 4-310
4.12.5 Elapsed Time to Drill a Well (WLDRTIME) . . . . . . . . . . . . . . . . . . . 4-313
4.13 Automatic Well Workovers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-315
4.13.1 Workover Rig Definition (WRKRIG) . . . . . . . . . . . . . . . . . . . . . . . . 4-315
4.13.2 Relative Number of Workovers (WRKRTO) . . . . . . . . . . . . . . . . . . . 4-316
R5000.0.1 Table of Contents xi

4.13.3 Workover Calculation Frequency (WRKFRQ) . . . . . . . . . . . . . . . . . 4-317

4.13.4 Elapsed Time Between Workovers (WRKDLT) . . . . . . . . . . . . . . . . 4-318
4.13.5 Workover Failure Rate (WRKFAIL) . . . . . . . . . . . . . . . . . . . . . . . . . 4-319
4.13.6 Well Limit for Automatic Shutoffs (WRKWLM) . . . . . . . . . . . . . . . 4-319
4.13.7 Workover Benefit Function Limits (WRKLIM) . . . . . . . . . . . . . . . . 4-320
4.13.8 Group Numbers for "Group 1" (WRKGP1) . . . . . . . . . . . . . . . . . . . . 4-322
4.13.9 Group Numbers for "Group 2" (WRKGP2) . . . . . . . . . . . . . . . . . . . . 4-324
4.13.10 “Group 1” Default Coefficients (WRKCF1) . . . . . . . . . . . . . . . . . . 4-325
4.13.11 “Group 2” Default Coefficients (WRKCF2) . . . . . . . . . . . . . . . . . . 4-326
4.13.12 Coefficients for Workover Benefit Functions (WRKCOEF) . . . . . . 4-327
4.13.13 Debug Output (WRKDBG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-329
4.14 Fluid Tracking (Not available in VIP-THERM) . . . . . . . . . . . . . . . . . . . . . . . . 4-330
4.14.1 Fluid Tracking Option (TRACK) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-330
4.14.2 Tracked Fluid Number (YINJT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-331
4.14.3 Activates Tracked Fluid Composition Output (OPRSYS) . . . . . . . . . 4-331
4.15 Water Tracking (Not available in VIP-THERM) . . . . . . . . . . . . . . . . . . . . . . . 4-333
4.15.1 Tracked Water Mixing Parameter (FTWMIX) . . . . . . . . . . . . . . . . . . 4-333
4.15.2 Tracked Water Type Number (WINJT) . . . . . . . . . . . . . . . . . . . . . . . 4-333
Chapter 5
Predictive Well Management
5.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-335
5.2 Keywords Common to NEW PWM and MGOR PWM . . . . . . . . . . . . . . . . . . . 5-336
5.2.1 Predictive Well Management (PREDICT) . . . . . . . . . . . . . . . . . . . . . . 5-336
5.2.2 Number of Outer Iterations Each Timestep (WMITN) . . . . . . . . . . . . 5-336
5.2.3 Pressure Systems and Lift Methods Available (PWMGC) . . . . . . . . . 5-337
5.2.4 Tubinghead Pressure (THP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-338
5.2.5 Production Target Data (PTARG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-338
5.2.6 Frequency of PWM Calculations (PWMFRQ) . . . . . . . . . . . . . . . . . . . 5-341
5.2.7 Bottomhole Pressure Tables (SYSTB) . . . . . . . . . . . . . . . . . . . . . . . . . 5-341
5.2.8 Define Pressure Systems for Wells During History (HISTSYS) . . . . . 5-342
5.2.9 Defining Pressure Systems (PRSYS) . . . . . . . . . . . . . . . . . . . . . . . . . . 5-343
5.2.10 Artificial Lift Method Names (ARTLFT) . . . . . . . . . . . . . . . . . . . . . 5-344
5.2.11 Tolerance for Production Rates
(PWMTLP, NONPWM, TRGPWM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-344
5.2.12 Oil Incremental Benefit with Gaslift (PWMOBN) . . . . . . . . . . . . . . . 5-346
5.2.13 Maximum PWM Timestep Size (DTPWM) . . . . . . . . . . . . . . . . . . . . 5-346
5.2.14 Write PWM Report to File (PWMFILE) . . . . . . . . . . . . . . . . . . . . . . 5-347
5.2.15 Debug Output (PWMDBG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-347
5.3 Keywords for NEW PWM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-349
5.3.1 Minimum Oil Rate for Producers (QOMIN) . . . . . . . . . . . . . . . . . . . . 5-349
5.3.2 Minimum Gas Rate for Producers (QGMIN) . . . . . . . . . . . . . . . . . . . . 5-350
5.3.3 PWM Calculation Steps (PWMSTEP) . . . . . . . . . . . . . . . . . . . . . . . . . 5-352
5.3.4 Producing Area Number (PWMWPA) . . . . . . . . . . . . . . . . . . . . . . . . . 5-358
xii Table of Contents R5000.0.1

5.3.5 Producing Mechanism (PWMWPM) . . . . . . . . . . . . . . . . . . . . . . . . . . 5-359

5.3.6 Define Well Category (PWMCAT) . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-360
5.3.7 MUSTFLOW Well Specification (MUSTFLOW) . . . . . . . . . . . . . . . . 5-361
5.3.8 Minimum Oil Rate for Wells on Gaslift (QOMINL) . . . . . . . . . . . . . . 5-361
5.3.9 Execute Normal Targeting Procedure (PWMTRG) . . . . . . . . . . . . . . . 5-363
5.3.10 Frequency of Pressure System Switching (PRSDLT) . . . . . . . . . . . . 5-363
5.3.11 Well Rate Control (PWMWCN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-363
5.4 Keywords for MGOR PWM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-365
5.4.1 Separator Battery Numbers (SYSSEP) . . . . . . . . . . . . . . . . . . . . . . . . . 5-365
5.4.2 MGOR Option Data (PRMGOR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-365
5.4.3 Water-Cut Versus Efficiency Table (EFFTAB) . . . . . . . . . . . . . . . . . . 5-366
5.4.4 Specify Wells Included in Well Debug Report (WPWMDB) . . . . . . . 5-367
Chapter 6
Output Control
6.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-369
6.2 Print/Map Arrays and Parameters (OUTPUT, MAPOUT) . . . . . . . . . . . . . . . . . 6-370
6.3 Array Print Windows (OUTWINDOW) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-379
6.4 Content and Frequency of Printed Output (PRINT) . . . . . . . . . . . . . . . . . . . . . . 6-381
6.5 Buildup Pressure Output Control (BUILDUP) . . . . . . . . . . . . . . . . . . . . . . . . . . 6-386
6.6 Write Files (WPLOT, WMAP, WMAPOLD, WREST, WFLUX, WFILE, WCPLOT)
6-387
6.7 Save Temporary Restarts (WLASTR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-389
6.8 Write Fluid Tracking Data (WTRACK) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-389
6.9 Print/Map Mole Fractions (OUTX, OUTY, OUTZ, OUTXT, OUTYT, OUTZT,
MAPX, MAPY, MAPZ, MAPXT, MAPYT, MAPZT) . . . . . . . . . . . . . . . . . . . . . . 6-391
6.10 Format of Mole Fraction Array Print (ALLCOMP) . . . . . . . . . . . . . . . . . . . . . 6-392
6.11 Tracked Water Type Fractions (OUTWT, MAPWT) . . . . . . . . . . . . . . . . . . . . 6-392
6.12 Specify Which Separator Batteries to Process (OUTSEP) . . . . . . . . . . . . . . . . 6-393
6.13 Reservoir Region Separator Battery Assignment (REGSEP) . . . . . . . . . . . . . . 6-394
6.14 Compute Potentials for Plot File (PLOTPTN) . . . . . . . . . . . . . . . . . . . . . . . . . 6-395
6.15 Printout Processed Well Cards (PRINTOUT) . . . . . . . . . . . . . . . . . . . . . . . . . . 6-395
6.16 Logical Unit for Timestep Summary Output (IPRTSS) . . . . . . . . . . . . . . . . . . 6-396
6.17 Specify Wells Included in Well RFT Report (OUTRFT) . . . . . . . . . . . . . . . . . 6-396
6.18 Spreadsheet Files (SSSUM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-397
6.19 Well Average Pressure Calculation (OUTPAVG) . . . . . . . . . . . . . . . . . . . . . . 6-405
6.20 Print Well Indices (PRWI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-406
R5000.0.1 Table of Contents xiii

6.21 Print Well Properties Summary (PRWSTA) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-406

6.22 Track File Format (TFORM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-406
6.23 Boundary Flux File Format (FXFORM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-407
6.24 Print by Cross-Sections (CROSS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-408
6.25 Grouping Wells (WLGRP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-408
6.26 Group Specification of Maximum Well Rates (QMAXGR) . . . . . . . . . . . . . . . 6-409
6.27 Plot File Well Specification (PLOTLIST) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-410
6.28 Spreadsheet Well Specification (SPRLIST) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-411
6.29 Results File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-413
6.29.1 Plot File Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-413
6.29.2 Compositional Plot File Organization . . . . . . . . . . . . . . . . . . . . . . . . 6-417
6.29.3 Map File Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-421
6.29.4 Hydrocarbon Track File Organization . . . . . . . . . . . . . . . . . . . . . . . . 6-424
Chapter 7
Simulator Control
7.1 Timestep Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-427
7.1.1 Timestep Controls (DT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-428
7.1.2 Timestep Size After Rate Changes (DTQMAX) . . . . . . . . . . . . . . . . . 7-430
7.1.3 Outer Iteration Controls (ITNLIM) . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-431
7.1.4 Control Convergence Failures and Timestep Cuts (TCUT) . . . . . . . . . 7-432
7.1.5 Control Treatment of IMPES Stability (IMPSTAB) . . . . . . . . . . . . . . 7-433
7.1.6 Maximum Variable Change Overshoot (MAXOVR) . . . . . . . . . . . . . . 7-434
7.1.7 Convergence Tolerance on Unknowns (TOLD) . . . . . . . . . . . . . . . . . . 7-435
7.1.8 Convergence Tolerance on Residuals (TOLR) . . . . . . . . . . . . . . . . . . . 7-436
7.1.9 Saturation Convergence Tolerance for OPTMBL and VOLBAL (TOLSCN)
7-437
7.1.10 Well Convergence Tolerance for OPTMBL and VOLBAL
(TOLWCN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-438
7.1.11 Maximum Allowable Material Balance Error (ABORT) . . . . . . . . . . 7-438
7.1.12 Minimum BHP Damping Factor (CBHPMN) . . . . . . . . . . . . . . . . . . 7-439
7.1.13 Table Extrapolation Control (CHKTAB) . . . . . . . . . . . . . . . . . . . . . . 7-439
7.1.14 Timestep Size Factors (MXDTCF, MXDTFC, DTCUTF) . . . . . . . . 7-440
7.2 Matrix Solution Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-441
7.2.1 Gaussian Elimination (GAUSS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-442
7.2.2 Iterative Solver (EXCEL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-442
7.2.3 Iterative Solver (BLITZ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-443
7.2.4 Bad Solution Indicator (SLVCUT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-446
7.3 Implicit Well Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-447
7.3.1 Implicit Well Calculations in IMPES Grids (IMPWEL) . . . . . . . . . . . 7-447
7.4 Automatic Parameter Settings (FASTSIM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-448
xiv Table of Contents R5000.0.1

7.5 Interactive Suspend Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-450

7.5.1 Interactive Card (INTERACTIVE) . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-451
7.5.2 BATCH Card (BATCH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-452
7.6 Interactive Recurrent Data Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-453
Chapter 8
Miscellaneous Options
8.1 Energy Minimization Phase Equilibrium (VIP-COMP) . . . . . . . . . . . . . . . . . . . 8-455
8.1.1 Invoking the Gibbs Algorithm (GIBBS) . . . . . . . . . . . . . . . . . . . . . . . 8-455
8.1.2 Turning Off the Gibbs Algorithm (GIBOFF) . . . . . . . . . . . . . . . . . . . . 8-457
8.2 Successive Substitution Flash Data (VIP-COMP) . . . . . . . . . . . . . . . . . . . . . . . . 8-457
8.2.1 Definition of Flash Calculation Method (FLASH) . . . . . . . . . . . . . . . . 8-457
8.2.2 Control of Flash Calculations (KMAX) . . . . . . . . . . . . . . . . . . . . . . . . 8-458
8.3 Gas Percolation Algorithm (GASPERC) (Not available in VIP-THERM) . . . . . 8-460
8.4 Gas Remobilization Option (GASRMON) (Not available in VIP-THERM) . . . 8-460
8.5 Modified Land’s Constant for Hysteresis (MODLAND) . . . . . . . . . . . . . . . . . . 8-462
8.6 Modifying VIP-CORE Array Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-463
8.6.1 Override Modification (OVER) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-463
8.6.2 Override Modification, VIP-DUAL (OVER) . . . . . . . . . . . . . . . . . . . . 8-465
8.6.3 Individual Value Override Modification (VOVER) . . . . . . . . . . . . . . . 8-466
8.6.4 Individual Value Override Modification, VIP-DUAL (VOVER) . . . . 8-468
8.6.5 Modifying Fault Connection Transmissibilities (FTRANS) . . . . . . . . 8-470
8.6.6 Modifying Fault Connection Transmissibilities, VIP-DUAL
(FTRANF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-471
8.7 Named Fault/Region Transmissibility Multiplier (MULTFL) . . . . . . . . . . . . . . 8-472
8.8 Inter/Intra Region Transmissibility Multiplier (MULTIR) . . . . . . . . . . . . . . . . . 8-472
8.9 Pressure Threshold for Limiting Grid Block to Grid Block Flow (PTHLD) . . . 8-473
8.10 Phase Identification (PHASID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-475
8.11 Diffusion Activation/Deactivation (DIFFUSION) . . . . . . . . . . . . . . . . . . . . . . 8-476
Chapter 9
Polymer Option (VIP-POLYMER)
9.1 Polymer Physical Property Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-477
9.1.1 Change Default Dimensions (DIM) . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-477
9.1.2 Polymer Mode (POLYMER) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-478
9.1.3 Polymer Concentration/Salinity Table (POLYT) . . . . . . . . . . . . . . . . . 9-478
9.1.4 Polymer Concentration/Salinity Functions (POLYF) . . . . . . . . . . . . . . 9-480
9.1.5 Non-Newtonian Viscosity Cards (SHEAR) . . . . . . . . . . . . . . . . . . . . . 9-481
9.1.6 Polymer Inaccessible Pore Volume Card (EPHIP) . . . . . . . . . . . . . . . . 9-483
9.1.7 Cation Exchange Cards (IONEX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-483
R5000.0.1 Table of Contents xv

9.1.8 Effective Divalent Salinity Cards (CSEP) . . . . . . . . . . . . . . . . . . . . . . 9-484

9.1.9 Salinity Units Card (SUNITS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-484
9.2 Injectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-485
9.2.1 Polymer Concentration (CPINJ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-485
9.2.2 Anion (Chloride) Concentration (CLINJ) . . . . . . . . . . . . . . . . . . . . . . . 9-485
9.2.3 Divalent Cation (Calcium) Concentration (CAINJ) . . . . . . . . . . . . . . . 9-486
9.2.4 Polymer Slug Definition (PSLUG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-486
9.2.5 Describe Well Perforations (FPERF) . . . . . . . . . . . . . . . . . . . . . . . . . . 9-487
9.3 Instantaneous Gel Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-487
9.3.1 Gel Data (GEL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-487
9.3.2 Permeability Reduction Multiplier (RKMULT) . . . . . . . . . . . . . . . . . . 9-488
9.4 Print/Map Arrays and Parameters (OUTPUT, MAPOUT) . . . . . . . . . . . . . . . . . 9-488
9.5 Timestep Controls (DT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-490
9.6 Modifying VIP-CORE Array Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-491
9.6.1 Override Modification (OVER) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-491
9.6.2 Individual Value Override Modification (VOVER) . . . . . . . . . . . . . . . 9-491
Chapter 10
Surface Pipeline Network Option

10.1 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-493
10.2 Flow Modeling in Well Tubing Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-496
10.3 Application of Hydraulic Tables for Modeling Flow in Flow Devices . . . . . . 10-497
10.4 Application of Look-Up Tables for Pressure Gradient
Determination in Pipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-497
10.5 Profiles of Temperature, Inclination Angle, Valve Coefficient, Choke Correlation, and
PVT Tables (CURVE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-498
10.5.1 Temperature Profile (CURVE TEMPPR) . . . . . . . . . . . . . . . . . . . . 10-498
10.5.2 Temperature Gradient Profile (CURVE TMGRPR) . . . . . . . . . . . . 10-499
10.5.3 Elevation Profile (CURVE ELEVPR) . . . . . . . . . . . . . . . . . . . . . . . 10-500
10.5.4 Valve Coefficient Profile (CURVE VCPR) . . . . . . . . . . . . . . . . . . . 10-501
10.5.5 Choke Correlation (CURVE IDPR) . . . . . . . . . . . . . . . . . . . . . . . . . 10-502
10.5.6 PVT Property Table Profile (CURVE IPVTPR) . . . . . . . . . . . . . . . 10-503
10.6 Pipe Data (PIPES) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-504
10.7 Tubing Data (TUBING) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-508
10.8 Valve Data (VALVES, VALSET) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-512
10.9 Link Data (LINK) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-516
10.10 Node Data (NODES) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-520
10.10.1 Gas Partial Processing Optimization (PPOPT) . . . . . . . . . . . . . . . . 10-524
xvi Table of Contents R5000.0.1

10.11 Node Connection Data (NODCON) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-526

10.12 Lift Gas Composition (YINJA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-529
10.13 Well Connection Data (WELCON) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-530
10.14 Satellite Field Production Data (NODSOURCE and SOUCOM) . . . . . . . . . 10-535
10.15 Production Fluids from Different PVT Units . . . . . . . . . . . . . . . . . . . . . . . . 10-537
10.15.1 Water PVT Profile (SPNPVW) . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-537
10.15.2 Surface Network PVT Unit (SPNPVT) . . . . . . . . . . . . . . . . . . . . . 10-538
10.15.3 Well PVT Unit (SPNPTU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-539
10.15.4 Describe Well Perforations (FPERF) . . . . . . . . . . . . . . . . . . . . . . . 10-539
10.16 Pseudo Well Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-540
10.16.1 Inflow Performance Correlations (BHITAB) . . . . . . . . . . . . . . . . . 10-541
10.16.2 Correlation Assignments (PSEUTAB) . . . . . . . . . . . . . . . . . . . . . . 10-544
10.16.3 Reservoir Pressure (PSEUPRES) . . . . . . . . . . . . . . . . . . . . . . . . . . 10-545
10.16.4 Compositions (PSEUXY) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-545
10.16.5 Well Status (PSEUWS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-546
10.17 General Parameters of the Surface Pipeline Network System (NETPAR) . . 10-548
10.18 Output of Surface Pipeline Network Information . . . . . . . . . . . . . . . . . . . . . 10-553
10.18.1 Node Report in Print File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-553
10.18.2 Node Spreadsheet File (SSSUM) . . . . . . . . . . . . . . . . . . . . . . . . . . 10-554
10.18.3 Spreadsheet Node Specification (SPRLIST) . . . . . . . . . . . . . . . . . 10-556
10.18.4 Tubing Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-557
10.18.5 Surface Pipeline Network Information in Plot File . . . . . . . . . . . . 10-558
10.18.6 Generation of Hydraulic Tables (HTOUTPUT) . . . . . . . . . . . . . . . 10-558
10.19 Production Well Optimization Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-565
10.19.1 Default Dimensions (DIM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-565
10.19.2 Objective Coefficients (OBJCOEF) . . . . . . . . . . . . . . . . . . . . . . . . 10-565
10.19.3 Lock Well Rates (LOCK) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-566
10.19.4 Surface Network Optimization Control (NTOPTC) . . . . . . . . . . . . 10-567
10.19.5 Node Data (NODES) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-568
10.19.6 Well Connection Data (WELCON) . . . . . . . . . . . . . . . . . . . . . . . . 10-569
10.19.7 Maximum Velocity Constraints (WLVEL) . . . . . . . . . . . . . . . . . . 10-570
10.19.8 Output Well and Node Connection Changes (PRTSWT) . . . . . . . 10-570
10.19.9 Gaslift Optimization Using Performance Curves (PFMCRV) . . . . 10-571
10.20 Integration of Surface Pipeline Network and Predictive Well Management . 10-572
10.20.1 Number of Outer Iterations Each Timestep (WMITN) . . . . . . . . . 10-572
10.21 Understanding Injection Network Allocations and Node Pressures in VIP . 10-574
10.21.1 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-576
10.1.0.1 Injection Network with No Group Targeting . . . . . . . . . . 10-577
10.1.0.2 Injection Network with Group Targeting Using ITARG . . 10-578
10.1.0.3 Injection Regions for Group Targets . . . . . . . . . . . . . . . . . 10-579
10.1.0.4 Injection Regions with Network Node Targets . . . . . . . . . 10-580
10.21.2 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-580
R5000.0.1 Table of Contents xvii

Chapter 11
Automatic Tuning Procedures
11.1 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-581
11.2 Well Index Adjustment Procedure (WIADJ) and Tubing String Parameter Adjustment
Procedure (TBADJ). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-581
11.3 Dynamic TUNING Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-589
11.3.1 General Parameters (TUNING, ENDTUNING) . . . . . . . . . . . . . . . . 11-594
11.3.2 Convergence Tolerances (MAXRER and MAXRNE) . . . . . . . . . . 11-596
11.3.3 Parameter Ranges (TWELL, TFPERF, TTUBING, TWLFL, TSPN, MN-
PFCF, MNFLCF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-598
11.3.4 Activation of Inactive Perforations (MINRER) . . . . . . . . . . . . . . . . 11-601
11.3.5 Field Measurements and Error Function Coefficients (QMULT, TBHP, . .
TTHP, TPRND, TERC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-603
11.3.6 Adjustment Factors (ADJWI, ADJFPERF, ADJTUBING, ADJWLFL, AD-
JSPN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-605
11.3.7 Output of Automatic Tuning Results . . . . . . . . . . . . . . . . . . . . . . . . 11-607
Chapter 12
Gas Field Operations (GFO) Option
12.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-609
12.2 Gas Field Operations Data (GFO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-610
12.3 Annual Scheduling File (ASF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-615
Chapter 13
Local Grid Refinement
13.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-617
13.2 Formulation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-617
13.2.1 Formulation Specification by Grid (IMPGRID) (VIP-COMP or VIP-EN-
CORE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-617
13.2.2 Turn Off Pressure Interpolation (NOPINT) . . . . . . . . . . . . . . . . . . . 13-618
13.3 Activate/Deactivate Grids (Not available in VIP-THERM) . . . . . . . . . . . . . . 13-619
13.4 Timestep Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-620
13.4.1 Timestep Controls for IMPLICIT Grids (DTMPL)
(VIP-COMP or VIP-ENCORE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-620
13.4.2 Iteration Controls for IMPLICIT Grids (ITNMPL)
(VIP-COMP or VIP-ENCORE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-621
13.5 Matrix Solution Option (CBLITZ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-622
13.5.1 CBLITZ Parameters by Grid (CBLGRID) . . . . . . . . . . . . . . . . . . . . 13-624
13.6 Well Data Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-626
13.6.1 Well Name and Location (WELL) . . . . . . . . . . . . . . . . . . . . . . . . . . 13-626
xviii Table of Contents R5000.0.1

13.6.2 Describe Well Perforations (FPERF) . . . . . . . . . . . . . . . . . . . . . . . . 13-626

13.7 Assign Gridblocks to Injection Regions (INJREGN) . . . . . . . . . . . . . . . . . . . 13-628
13.8 Options Restricted to Use with Single-Grid Systems Only . . . . . . . . . . . . . . . 13-628
13.9 Arbitrary Gridblock Connections (FTRANS) . . . . . . . . . . . . . . . . . . . . . . . . . 13-628
13.10 Override Modification (OVER) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-629
13.11 Value Override (VOVER) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-629
Chapter 14
Tracer Option
14.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-631
14.2 VIP Tracer Option Input Data Description . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-631
14.2.1 Change Default Dimensions (DIM) . . . . . . . . . . . . . . . . . . . . . . . . . 14-632
14.2.2 Activate Front Tracking Option (FRONT) . . . . . . . . . . . . . . . . . . . . 14-632
14.2.3 Define Parameters for Tracer Option (TRACER) . . . . . . . . . . . . . . 14-633
14.2.4 Inject Tracer (TRACIN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-635
14.2.5 Write Map Records to Database (WTRACE) . . . . . . . . . . . . . . . . . . 14-637
14.2.6 Write Plot Records to Database (WTRPLOT) . . . . . . . . . . . . . . . . . 14-637
14.2.7 Write Records to Tracer File (WTRDBG) . . . . . . . . . . . . . . . . . . . . 14-638
14.2.8 Write Tracer Summary (PRINT TRACER) . . . . . . . . . . . . . . . . . . . 14-639
Chapter 15
Parallel Computing
15.1 Parallel Grid Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-641
15.1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-641
15.1.1 Processor Mapping File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-641
Appendix v
References
Keyword Index
Subject Index
R5000.0.1 Table of Contents xix

xx Table of Contents R5000.0.1

Preface
000000 About This Manual
Introduction
VIP-COMP®, VIP-ENCORE®, VIP-DUAL®, VIP-POLYMER®, and VIP-
THERM® are the simulation modules of the VIP-EXECUTIVE® Family of
simulators. The VIP-COMP, VIP-ENCORE, VIP-DUAL, and VIP-POLYMER
modules are all conveniently "packaged" within a single program library which
we call VIP-EXECUTIVE. 00
Purpose
The primary purpose of this Reference Manual is to document the input options of
the VIP-EXECUTIVE suite of reservoir simulation modules. It is assumed that
the reader is familiar with reservoir engineering concepts, in general, and
reservoir simulation terminology, specifically. This document is not intended to be
a cookbook for the novice simulation user. 00
The Modules
This manual is intended to be used in conjunction with the VIP-CORE Reference
Manual. VIP-CORE is the module within VIP-EXECUTIVE which calculates the
initial reservoir conditions to be used by one of the simulation modules. 00
The VIP-EXECUTIVE reservoir simulator contains the following program

modules: 00
VIP-ENCORE Multi-Component Black-Oil Model
VIP-COMP Equation-of-State Compositional Model
VIP-DUAL Dual-Porosity Model
VIP-POLYMER Polymer Flooding Model
VIP-THERM Thermal Model
These program modules work together to provide total flexibility in reservoir

modeling. For example, VIP-ENCORE and VIP-DUAL could be combined to
R5000.0.1 About This Manual xxi

VIP-EXECUTIVE® Reference Manual Landmark
provide simulation capability for a dual-porosity, black-oil reservoir. If VIP-

COMP were included in the same program, the user could convert to a fully
compositional version of the dual-porosity model simply by substituting the
compositional specific data for the black-oil specific data. 00
The Chapters
The input data stream for the simulation modules consists of keywords and data
values which invoke the features of the simulator. Chapter 1 is an overview of the
data; it also describes data cards which are used throughout the entire data stream.
The subsequent chapters describe the time-dependent data, which have some
order dependencies. (Any restrictions are described in the appropriate section. 00
Data Format
The keywords, or alpha labels, used in the data input stream are denoted in this
manual by upper case letters. The names of the variables that are entered as
numbers in the data stream are typed in lower case letters. 00
Data Options
In all of the data descriptions, parentheses are used to indicate optional items of
data. Parentheses are never included in the actual data stream, unless specifically
noted. Items of data that are aligned vertically in the description of a single data
card indicate a choice. The items are mutually exclusive. 00
Compatibility
This documentation is compatible with Version R5000.0.1 of the VIP-
EXECUTIVE software. Along with additional enhancements, some of the formats
have been modified. In the case of changed formats, only our new formats
appear. 00
Units
Internal calculations are carried out in customary oil field units, but input and
output can be in either customary units or the International System of Units (SI)
metric system or in laboratory units. Throughout this Reference Manual, units are
first listed as the customary units followed by the SI units in parentheses. The user
may choose metric pressure units of kg/cm2 (bar) instead of the default kPa. In
this case, whenever the documentation reads kPa, kg/cm2 (bar) will be expected.
A table of data types and the possible units is given in Section 1.7. 00
xxii About This Manual R5000.0.1

Landmark VIP-EXECUTIVE® Reference Manual
Related Documentation
The following manuals provide more information related to the material in this
manual. For more information, please consult the appropriate manual listed below.
00
■ VIP-EXECUTIVE Technical Reference. A detailed discussion of the

mathematical theory behind the VIP simulators. [Available only in hardcopy]
■ VIP-CORE Reference Manual. A complete summary of all keywords and

data formats needed to build an initial reservoir model.
R5000.0.1 About This Manual xxiii

xxiv About This Manual R5000.0.1

Chapter
1
Data Overview
00000
1.1 Introduction
VIP-COMP®, VIP-ENCORE®, VIP-DUAL®, VIP-POLYMER®, and VIP-
THERM® are the simulation modules of the VIP-EXECUTIVE® Family of
simulators. The VIP-COMP, VIP-ENCORE, VIP-DUAL, VIP-POLYMER, and
VIP-THERM modules are all conveniently “packaged” within a single program
library which we call VIP-EXECUTIVE. When VIP-DUAL is executed, it is used
in conjunction with either VIP-COMP or VIP-ENCORE. For example, VIP-
CORE, VIP-ENCORE and VIP-DUAL may be combined to provide a modeling
capability for a fractured “black-oil” reservoir. If VIP-COMP replaces VIP-
ENCORE, the user could convert to a fully compositional version of the fractured
reservoir model simply by substituting the compositional specific data for the
black-oil specific data. All of these modules contain one or more of our newest
solution algorithms: EXCEL™ and BLITZ™.
Only the particular modules purchased are activated. These are listed on the first
page of computer output in the title box.
The documentation for VIP-COMP, VIP-ENCORE, VIP-DUAL, VIP-

POLYMER, and VIP-THERM are included in this Reference Manual. The major
features are applicable to all of the modules; therefore, the majority of the data
required for all four of these modules is identical. Where data differs between
VIP-COMP, VIP-ENCORE, and VIP-THERM or additional data is required for
VIP-DUAL, VIP-POLYMER, or VIP-THERM, the model to which the described
data applies is enclosed in parentheses after the section heading.
1.1.1 VIP-COMP Overview

VIP-COMP is an n-component, equation-of-state, compositional simulator. It can
simulate the flow of oil, gas, and water through an underground reservoir and
predict the behavior of all associated production/injection wells. The system takes
into account the fact that fluid properties and phase behavior can vary strongly
with fluid composition. Fluid properties and phase equilibrium are governed by
generalized cubic equation-of-state which includes the Peng-Robinson (Reference
11) equation and various versions of the Redlich-Kwong (Reference 12) equation.
Both oil and gas are treated as mixtures containing an arbitrary number of
hydrocarbon and nonhydrocarbon components. In addition, special techniques are
implemented in VIP-COMP to insure stability and efficiency of solution for near-
critical oil and gas fluid systems.
R5000.0.1 Data Overview 1-25

1.1.2 VIP-ENCORE Overview

VIP-ENCORE is a three-phase reservoir simulator which models the immiscible
flow of oil, gas, and water within the reservoir. VIP-ENCORE is a special case of
the generalized VIP-COMP simulator. Fluid properties can be described
according to the “black-oil convention” -- oil at reservoir conditions is a mixture
of stock tank oil and dissolved gas. The amount of gas dissolved in the oil is
determined by a bubble-point pressure relationship. VIP-ENCORE is able to treat
water-oil or gas-water two-phase problems as special cases of the more
generalized three-phase fluid system. In addition, VIP-ENCORE can process
multicomponent systems whose PVT properties are adequately described by
pressure-dependent K-values. Thus, it can be used to model gas condensates and
volatile oils more rigorously than conventional black-oil simulators.
1.1.3 VIP-DUAL Overview
NOTE: VIP-DUAL is available as a separately licensed option.
The VIP-DUAL option simulates the performance of reservoirs which are

naturally fractured, heterogeneous, or highly stratified. The full dual-porosity,
dual-permeability formulation allows flow in both fractures and rock matrix,
thereby enabling correct and accurate modeling of reservoirs which may be highly
fractured in some regions while unfractured in others. VIP-DUAL must be used in
conjunction with either VIP-ENCORE or VIP-COMP. Within VIP-DUAL, the
exchange of fluids between the fracture and matrix rock is based on the Warren &
Root theory, and the more recent work of Thomas, Dixon, and Pierson. Mass
transfer between matrix rock and fractures includes diffusion, convection,
imbibition, and gravity drainage. Imbibition and gravity drainage effects are
modelled with pseudo-capillary pressure functions that include hysteresis. These
functions are automatically and independently determined for the matrix and
fractures and account for the matrix block and gridblock sizes. Also available is a
dual-porosity/single-permeability option which assumes that the fractures alone
are a continuous media and the matrix rock exists only as a source or sink for
reservoir fluids.
1-26 Data Overview R5000.0.1

1.1.4 VIP-POLYMER Overview
NOTE: VIP-POLYMER is available as a separately licensed option.
The VIP-POLYMER option simulates the performance of polymer flooded

reservoirs. The model takes into account the major physical properties attributed
to the flow of polymer solutions through porous media. These include a non-
Newtonian viscosity. The polymer is represented by a separate component,
present only in the aqueous phase and occupying no volume. VIP-POLYMER
must be used in conjunction with either VIP-ENCORE or VIP-COMP.
1.1.5 VIP-THERM Option

VIP-THERM is an extension of the fully implicit formulation of VIP-COMP to
include an energy balance, an equilibrium constraint for the water component,
heat loss models, and temperature-dependency of all important properties. Two
phase behavior models are available: 1) the n-component compositional equation
of state model which VIP-THERM shares with VIP-COMP or 2) the dead oil
model in which oil is treated as a single non-volatile component.
The VIP-THERM compositional model is a fully implicit, n-component,

equation-of-state, thermal simulator. The number of volatile components may be
specified as less than or equal to the total number of components. Water and
steam properties including density, enthalpy, and viscosity are obtained from a
tabular input file which is separate from the file containing the data described in
this manual.
The VIP-THERM dead oil model is a fully implict three-phase reservoir simulator
which models the flow of oil, water, and steam within the reservoir. This version
is a special case of the generalized compositional version. Oil is represented as a
single non-volatile component. Oil properties are either calculated by
interpolation from input tables or are calculated from input values of oil
compressibility, oil coefficient of thermal expansion, oil heat capacity, and oil
viscosity as a function of temperature. Water and steam properties including
density, enthalpy, and viscosity are obtained from a tabular input file which is
separate from the file containing the data described in this manual.
VIP-COMP or VIP-ENCORE initialization data may easily be converted to VIP-

THERM format:
1. Specify THERMAL card in VIP-CORE utility data (VIP-CORE Section

2.2.19.1).
2. Specify NCV in the grid system data (VIP-CORE Sections 2.2.3.1 or 2.2.3.2).
3. Replace Physical Property Constants table with VIP-THERM format (VIP-

CORE Section 2.2.4.2).

4. Replace VIP-ENCORE PVT data with either EOS data (VIP -CORE Section
4.4) or Dead Oil PVT data (VIP-CORE Section 4.7). If PCHOR was
specified in VIP-COMP EOS data, that column must be removed before the
data will be accepted by VIP-THERM.
5. Specify heat capacity arrays in VIP-CORE array data (VIP-CORE Sections

5.38 and 5.39).
6. Specify heat loss data in VIP-CORE (VIP-CORE Chapter 12).
VIP-COMP and VIP-ENCORE recurrent data may easily be converted to VIP-

THERM format:
1. Specify TINJ and QUAL for all water injectors (Sections 3.4.2.1 and 3.4.2.2).
Also specify PINJ ( Section 3.4.2.3) for all wells for which steam quality is
specified as zero.
2. Specify TINJ for all gas injectors (VIP-EXECUTIVE Section 3.4.2.1).
3. Modify DT cards (VIP-EXECUTIVE Section 7.1.1), ITNLIM cards (VIP-

EXECUTIVE Section 7.1.3), and TOLD cards (VIP-EXECUTIVE 7.1.7) to
include values for maximum temperature change.
4. Modify TOLR cards (VIP-EXECUTIVE Section 7.1.8) to include an energy

balance tolerance.
1.1.6 Shared Features

VIP-COMP, VIP-ENCORE, VIP-DUAL, VIP-POLYMER, and VIP-THERM
share all of the same major features. Wells are controlled by a variety of options
which allow both rate and pressure constraints. Wells also can be shut in or
recompleted automatically. Rates can be adjusted to meet production and injection
targets at any of the target levels. These target levels include gathering center,
flow station, area, and field.
Separator conditions are also taken into consideration for all of the simulator
modules. In VIP-COMP (or in the VIP-THERM compositional model), a multi-
component model, separators are required to determine surface production rates.
In VIP-ENCORE, separators allow for the additional flexibility of treating flash
separation conditions at the surface versus the differential calculations which take
place in the reservoir.
Both VIP-COMP and VIP-ENCORE allow fully implicit or IMPES formulations

to be selected for the integration of the flow equations. When the DUAL or the
THERMAL option is activated, only the fully implicit formulation is accepted for
the additional required stability.
Internal calculations are carried out in customary oil field units, but input and
output can be in either customary units or the International System of Units (SI)
metric system or in laboratory units. Throughout this Reference Manual, units are
first listed as the customary units followed by the SI units in parentheses. The user

may choose metric pressure units of kg/cm2 (bar) instead of the default kPa. In
this case, whenever the documentation reads kPa, kg/cm2 (bar) will be expected.
A table of data types and the possible units is given in Section 1.7.

1.2 Typical Data Requirements
1.2.1 Well Data

The following well data are required:
■ Well completion and workover or stimulation reports indicating treatments

(i.e., acid, frac, etc.) and completion intervals.
■ Measured data (i.e., rates, pressure) from any productivity or injectivity tests.
1.2.2 Production Histories

The following production histories are required:
■ Summary sheets for each well showing monthly volumes of all fluids
produced and the number of days or hours on production in the month.
■ Plots of individual well performance (i.e., rate, GOR, WOR) versus time.
1.2.3 Pressure History

The following pressure history is required:
■ Pressure survey reports for all pressure measurements detailing all pertinent
data (i.e., tool identification, tool calibration, tool range, reference elevations,
tool run depth, datum depth, all measured pressures) and the results from any
pressure analysis work performed (i.e., Horner buildup, etc.).
■ Isobaric maps, if available, showing the distribution of pressure in the

reservoir at various times in the reservoir’s history.
■ Plots showing all pressure data as a function of time or cumulative

production.

1.3 Data Deck Layout

Time-dependent, or recurrent, data include all data that can be defined or altered
subsequent to initialization. With clearly noted exceptions, any item of time-
dependent data can be changed any time during the simulation. In addition to the
operating characteristics of wells, these data define simulator controls and the
frequency and type of output.
Figure 1-1 displays the layout of the recurrent data. The first possible card in the
time-dependent data is the RUN card. It is no longer a required card.
The first required data card is the RESTART card, although other optional utility
data may precede it. The data following the RESTART card are divided into
“time” groups, each of which is read and processed at a time selected by the user.
Each group is introduced by a card which specifies when that group is to be
processed. The first group is introduced by the START card (either user-specified
or automatically inserted) and is read immediately. Each of the remaining groups
is introduced either by a TIME card or by a DATE card that tells when the data
group should be read. TIME and DATE cards are used interchangeably and may
be mixed in the same run.
All simulations are terminated by a STOP card, which may appear anywhere in
the time-dependent portion of the data deck. Whenever a STOP card is
encountered, no further data processing occurs. The run stops at the time or date
appearing on the preceding TIME or DATE card.
An END card must be the last card in the data stream; it acts as an end-of-file.

Figure 1-1: Order of Recurrent Data
VIP-EXECUTIVE time-dependent data input allows the user to describe well

data, output control, and simulator control. The well data includes the definition
of all well and well management level parameters. VIP-EXECUTIVE offers
numerous options to define all of the time-dependent data; however, only a
minimum amount of recurrent data is actually needed to run the simulator. Change
need be specified by exception only.
The required time-dependent well data is displayed in Table 1-1 and Table 1-2 .
Table 1-1 lists the minimum data requirements for a production well, while
Table 1-2 displays the same information for an injection well. These tables also
show the minimum data requirements to implement pressure constraints at the
well level. VIP-EXECUTIVE offers several types and levels of production/
injection constraints. These are listed in the Chapter 2 Table of Contents for
Section 3.3.
A matrix solver option may be specified. At time = 0 either BLITZ or CBLITZ

will be defaulted, depending on the problem type. At time > 0 the solver
information will be retrieved from the restart file. We suggest the user also enter
data for print controls along with the well data that are appropriate for the
particular study.
Table 1-3 and Table 1-4 list the VIP-EXECUTIVE data cards that can be used to
control production and injection.

Table 1-5 and Table 1-6 list all of the required data cards for any given option for
both production and injection. Within the lists commas indicate "and" meaning
both are required. The "or" indicates any one of the required cards is necessary,
and the user chooses which is appropriate.

Table 1-1: Minimum Data Requirements for Production Wells
Rate constraint only:
WELL PROD FPERF QMAX
Bottomhole pressure constraint:
WI
WELL PROD FPERF QMAX PI BHP
RFLOW
Tubinghead pressure constraint:
WI
WELL PROD FPERF QMAX PI THP ITUBE BHPTAB
RFLW
Notes:1. For the tubinghead pressure constraint, more than one well can refer to the same
BHPTAB.
2. If no productivity is defined by a WI, PI, or RFLOW card, well productivity will be

automatically adjusted to cause the well to flow at the rate specified on the QMAX card;
i.e., defaults to rate constraint. This can slow convergence whenever the gridblock pres-
sure, adjusted to datum depth, approaches the bottomhole pressure.

Table 1-2: Minimum Data Requirements for Injection Wells
Rate constraint only:
WELL INJ FPERF QMAX
Bottomhole pressure constraint only:
WI
WELL INJ FPERF QMAX PI BHP
RFLOW
Tubinghead pressure constraint:
WI
WELL INJ FPERF QMAX PI THP TUBE DIAM
RFLOW ITUBE BHITAB
Gas Injectors only:
YINJ
VIP-THERM only:
TINJ QUAL PINJ

(water/ (if
steam QUAL =
injectors) 0. or 1.)
Note: If no injectivity is defined by a WI, PI, or RFLOW card or by WIL or KHWI data on the
FPERF card, the injectivity will be automatically adjusted to cause the well to flow at the
rate specified on the QMAX card; i.e., defaults to rate constraint. This can slow conver-
gence whenever the gridblock pressure, adjusted to datum depth, approaches the bottom-
hole pressure.

Table 1-3: Data Cards Valid For Production

ALQ QLIFTM
AREA QMAX
BEGGS QMIN
BHP QMULT
BHPADD QSTMX (VIP-THERM)
BHPITN RCMPPERF
BHPTAB RCMPOR
DIAM RIGDEF
DPBHMX SEPARATOR
ECOLIM TEST
FLOSTA TESTGL
FPERF THP
FTWMIX THPGTB
GASPLANT TRACK
GASTHP TRGOPT
GATHER TRGORD
GLEFMN TRGQMN
GLGMAX TRGTOL
GLGOP TSFM
GLIMIT TSTPRF
GLRADD TUBE
GLRTAB WDNDG
GLRTBP WELL
GTHPWL WI, PI, RFLOW
IPRTRG WLIMIT
ITNSTP WLTYCH
ITNTHP WNDGDV
ITUBE WRKCF1
LSCALE WRKCF2
MBAWG WRKCOEF
NEWSEP WRKDBG
NOFRICTION WRKDLT
ONTIME WRKFAIL
PFMCRV WRKFRQ
PRDMIN WRKGP1
PRFLIM WRKGP2
PROD WRKLIM
PTARG WRKRTO
QLIFT WRKWLM
QLIFTA XFOFF
XFON

Table 1-4: Data Cards Valid For Injection

AREA ONTIME
BEGGS PATNCI
BHITAB PATNPP
BHP PATTN
BHPITN PINJ (VIP-THERM)
DIAM PMPTAB
DPBHMX PRIIR
ECOLIM PRIOP
ETRGOP PROJNM
FLOSTA PROJWL
FPERF QMAX
FTWMIX QMIN
GASFUL QUAL (VIP-THERM)
GASMKP QSTMX (VIP-THERM)
GASSKG RECFAC
GASSLS RINJOP
GATHER SEPARATOR
GINJMOB TEST
GINJOP THP
INJ TINJ (VIP-THERM)
INJA TRACK
INJGR TRGTOL
INJMIN TSFM
INJRGR TUBE
INJREGN WELL
INJRNM WI, PI, RFLOW
INJTAR WINJT
IPRTRG WLTYCH
IPUMP WNDGDV
IRDIST WTRPUMP
IRPCTA WTRTHP
IRSRCW XFOFF
ITARG XFON
ITNSTQ YINJ
ITUBE YINJA
LSCALE YINJMK
MBAWG YINJT
NEWSEP YREINJ
NOFRICTION

Table 1-5: Production Data Card Cross-Reference

DATA CARD REQUIRED DATA CARDS
Required
WELL --
FPERF WELL QMAX
PROD WELL
QMAX PROD, FPERF
Optional
ALQ THP
AREA --
BEGGS FPERF (horizontal well data)
BHP WI or PI or RFLOW
BHPADD BHPTAB
BHPITN GTHPWL,THPGTB, TUBE, DIAM
BHPTAB ITUBE, THP
DIAM THP, GTHPWL, THPGTB, TUBE
DPBHMX WI or PI or RFLOW
ECOLIM --
FLOSTA --
GASTHP GTHPWL, THPGTB, TUBE, DIAM
GATHER --
GLEFMN QLIFT, QLIFTA
GLGMAX QLIFT, QLIFTA
GLIMIT --
GLRADD GLRTAB
GLRTAB QLIFT, QLIFTA
GLRTBP QLIFT, QLIFTA, GLRTAB
GTHPWL THP, THPGTB, TUBE, DIAM
IPRTRG PTARG
ITNTHP THP
ITUBE THP, BHPTAB
MBAWG --
LSCALE --
NEWSEP SEPARATOR
NOFRICTION FPERF (horizontal well data)
ONTIME --
PFMCRV QLIFT, QLIFTA
PI BHP or THP
PRDMIN --

Table 1-5: Production Data Card Cross-Reference (Continued)

PRFLIM TSTPRF
PTARG --
QLIFT THP
QLIFTA QLIFT, GLRTAB
QMIN
QSTMX
RFLOW BHP or THP
SEPARATOR --
TEST --
TESTGL QLIFT, QLIFTA
THP ITUBE or TUBE, BHPTAB, WI or PI or RFLOW
THPGTB THP, GTHPWL, TUBE, DIAM
TRGTOL PTARG
TSTPRF PRFLIM
TUBE THP, GTHPWL, THPGTB, DIAM
WI BHP or THP
WLIMIT --
WLTYCH --
XFOFF --
XFON --

Table 1-6: Injection Data Card Cross-Reference

Required
WELL --
FPERF WELL, QMAX
INJ WELL
QMAX INJ, FPERF
TINJ WELL, INJ (VIP-THERM only)
QUAL WELL, INJ (VIP-THERM water/steam
injectors only)
PINJ WELL, INJ (VIP-THERM water/steam
injectors with QUAL = 0. or 1. only)
Optional
AREA --
BEGGS FPERF (horizontal well data)
BHITAB ITUBE, THP
BHP WI or PI or RFLOW
BHPITN THP
DIAM THP, TUBE
DPBHMX WI or PI or RFLOW
ECOLIM --
FLOSTA --
GASFUL INJ (reinjection)
GASMKP INJ (reinjection), YINJMK
GASSKG INJ (reinjection)
GASSLS INJ (reinjection)
GATHER --
GINJMOB --
GINJOP INJ (reinjection)
INJMIN --
INJREGN RINJOP (INJREG)
INJRGR RINJOP (INJREG)
INJRNM RINJOP (INJREG)
IPRTRG ITARG
IPUMP THP, PMPTAB
IRDIST RINJOP (INJREG)
IRPCTA RINJOP (INJREG)
IRSRCW RINJOP (INJREG)
ITARG --
ITNSTQ --
ITUBE THP, BHITAB
LSCALE --
MBAWG --
NEWSEP SEPARATOR

Table 1-6: Injection Data Card Cross-Reference (Continued)

NOFRICTION FPERF (horizontal well data)
ONTIME --
PI BHP or THP
PMPTAB THP, IPUMP
QMIN ECOLIM
RECFAC INJ (reinjection)
RFLOW BHP or THP
RINJOP INJ (reinjection)
SEPARATOR --
TEST --
THP TUBE, DIAM, WI or PI or RFLOW
TRGTOL ITARG
TUBE THP, DIAM
WI BHP or THP
WLTYCH --
WTRPUMP IPUMP, PMPTAB
WTRTHP THP
XFOFF --
XFON --
YINJ INJ
YINJMK INJ (reinjection), GASMKP
YREINJ INJ (reinjection)

1.4 Input Data Template

The printout that follows lists the most frequently used simulator data input
options.
C
******************************************************************
C TIME DEPENDENT DATA CHAPTER 2
C
******************************************************************
C
DIM PARAMETERS SECTION 2.2.3
C
C NOTE:THE DIM CARD IS ONLY USED TO MODIFY THE DEFAULT PROGRAM
C DIMENSIONS.
C
IMPLICIT SECTION 2.3.1
C
C NOTE:IF THE IMPLICIT CARD IS NOT ENTERED IN AN ISOTHERMAL RUN
STARTING FROM INITIAL CONDITIONS, THE DEFAULT IS IMPES.
C
RESTART (STARTING T.S.) SECTION 2.5.1
C
C NOTE:THE RESTART CARD IS ALWAYS REQUIRED. THE DEFAULT TIMESTEP
C NUMBER IS ZERO.
C
TITLE1
VIP-EXECUTIVE BATCH DATA INPUT TEMPLATE
TITLE2
THIS LIST INCLUDES ONLY THE MOST FREQUENTLY USED OPTIONS
C
C NOTE: IF TITLE CARDS ARE NOT ENTERED, THE TITLE CONTAINED ON
C THE RESTART RECORD WILL BE RETAINED.
C
START
C
C NOTE:THE START CARD INDICATES THE BEGINNING OF THE DATA TO
C BE INCLUDED IN THIS RUN. IT MAY BE MOVED DOWN IN THE
C DATA DECK AS APPROPRIATE FOR STARTING NEW RESTART RUNS.
C
OUTPUT OPTION LIST SECTION 6.2
PRINT OPTION LIST I/O FREQ SECTION 6.3
C
C NOTE:THE PRECEDING TWO CARDS ARE REQUIRED TO GENERATE ARRAYS,
C ITERATION SUMMARIES, WELL AND WELL MANAGEMENT LEVEL
C SUMMARIES, REGION SUMMARIES, SEPARATOR SUMMARIES, AND
C SIMULATION STATISTICS; IF THEY ARE OMITTED ONLY TIMESTEP
C SUMMARIES AND END-OF-JOB SIMULATION STATISTICS WILL BE
C PRINTED.
C++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
C MATRIX SOLUTION OPTIONS SECTION 7.2
C+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

C
[METHOD] (PARAMETERS) SECTION 7.2
C
C NOTE:THE MATRIX SOLUTION METHOD MAY BE DEFAULTED.
C
C-----------------------------------------------------------------
C TIMESTEP CONTROL SECTION 7.1
C-----------------------------------------------------------------
C
DT DT DTMIN DTMAX (DTMPMX) DPMAX DSMAX DVMAX DZMAXSECTION 7.1.1
C
C
C-----------------------------------------------------------------
C WELL DATA CHAPTER 3
C-----------------------------------------------------------------
C SECTION 3.2.1
WELL N (NAME) I J (IGC) (IBAT)
WELL NO. NAME I LOC. J LOC. G.C.NO. BAT.NO.
C REPEAT THE DATA CARD AS NECESSARY
C
PROD FLUID (UNIT) WELL LIST SECTION 3.4.1
INJ FLUID (UNIT) (LEVEL) WELL LIST SECTION 3.4.2
C
C NOTE:PROD AND/OR INJ CARDS ARE REQUIRED FOR EACH WELL IN THE
C RESERVOIR MODEL
C
FPERF SECTION 3.2.2
WELLL KH
W1 L1 KH1
X L2 KH2
FPERF SECTION 3.2.2
WELLL KH SWMN SWRO
W2 L1 KH1 SWMN1 SWRO1
X L2 KH2 SWMN2SWRO2
X L3 KH3 SWMN3SWRO3
C
C NOTE:EACH WELL MUST BE INCLUDED IN A SET OF FPERF DATA
C
QMAX WELL LIST SECTION 3.5.1
C
BHP WELL LIST SECTION 3.6.4
BHP1 BHP2 . . . BHPN
WDAT1 WDAT2 . . . WDATN
THP WELL LIST SECTION 3.6.5
THP1 THP2 . . . THPN
C
C NOTE:A BHP OR THP VALUE MAY BE SPECIFIED FOR EACH WELL.
C
WI WELL LIST SECTION 3.6.1
WI1 WI2 . . . WIN
PI WELL LIST SECTION 3.6.2
GF1 GF2 . . . GFN
PI1 PI2 . . . PIN

RFLOW WELL LIST SECTION 3.6.3

RW1 RW2 . . . RWN
RB1 RB2 . . . RBN
SKIN1 SKIN2 . . . SKINN
C
C NOTE:A WI, PI, OR RFLOW VALUE IS REQUIRED IF THP OR BHP IS
C DEFINED.
C
TUBE WELL LIST SECTION 3.11.1
TL1 TL2 . . . TLN
DZW1 DZW2 . . . DZWN
DIAM WELL LIST SECTION 3.11.2
DIAM1 DIAM2 . . . DIAMN
EPS1 EPS2 . . . EPSN
C
C NOTE:TUBE AND DIAM VALUES ARE REQUIRED ONLY IF THP IS SPECIFIED
C FOR AN INJECTOR.
C
ITUBE WELL LIST SECTION 3.9.1
IBHP1 IBHP2 . . . IBHPN
DZW1 DZW2 . . . DZWN
BHPTAB - BHP TABLE SECTION 3.9.2
C
C NOTE:ITUBE AND BHPTAB DATA ARE REQUIRED ONLY IF THP IS
C SPECIFIED FOR A PRODUCER
C
C----------------------------------------------------------------
C POLYMER PHYSICAL PROPERTY DATA SECTION 9.1.2
C-----------------------------------------------------------------
POLYMER
C-----------------------------------------------------------------
C POLYMER CONCENTRATION TABLE SECTION 9.1.3
C-----------------------------------------------------------------
POLYT
ESALT PERM POR
C THE ABOVE CARD IS FOLLOWED BY 1 DATA CARD
CP VP0 CPADSRK
POLYMER VISCOSITY ATPOLYMERPERMEABILITY
CONCENTRATIONZERO SHEAR RATEADSORPTIONREDUCTION FACTOR
C THE PREVIOUS 2 CARDS ARE REPLACED BY AT LEAST 2 DATA CARDS
C
C-----------------------------------------------------------------
C POLYMER NON-NEWTONIAN VISCOSITY PARAMETERSSECTION 9.1.5
C-----------------------------------------------------------------
C
SHEAR NSH
GAMMAC GAMHF POWN
C
C-----------------------------------------------------------------
C POLYMER INACCESSIBLE PORE VOLUME SECTION 9.1.6

C-----------------------------------------------------------------
C
EPHIP NEP EPHIP
C
C-----------------------------------------------------------------
C CATION EXCHANGE PARAMETERS SECTION 9.1.7
C-----------------------------------------------------------------
C
IONEX NEX
QV XKC
C
C-----------------------------------------------------------------
C EFFECTIVE SALINITY PARAMETERS SECTION 9.1.8
C-----------------------------------------------------------------
CSEP
BETAP CSE1
C
C-----------------------------------------------------------------
C SALINITY UNITS SECTION 9.1.9
C-----------------------------------------------------------------
C
SUNITS UNITS
C
C-----------------------------------------------------------------
C INITIAL ION CONCENTRATIONS SECTION 9.5.1
C-----------------------------------------------------------------
C
OVER CLW
C OVER OR VOVER CARDS ARE USED TO INITIALIZE THE ANION
C CONCENTRATIONS
C
OVER CAW
C OVER OR VOVER CARDS ARE USED TO INITIALIZE THE CATION
C CONCENTRATIONS
C
C-----------------------------------------------------------------
C POLYMER PROPERTIES REGION NUMBER SECTION 9.5.1
C-----------------------------------------------------------------
C
OVER IPOLYT
C OVER OR VOVER CARDS ARE USED TO INITIALIZE THE IPOLYT ARRAY
C
C-----------------------------------------------------------------
C POLYMER INJECTION CONCENTRATION SECTION 9.2.1
C-----------------------------------------------------------------
C
CPINJ WELL LIST
CPW1 CPW2 . . . CPWN
C
C-----------------------------------------------------------------
C ANION INJECTION CONCENTRATION SECTION 9.2.2
C-----------------------------------------------------------------
C

CLINJ WELL LIST

CLW1 CLW2 . . . CLWN
C
C-----------------------------------------------------------------
C DIVALENT CATION INJECTION CONCENTRATION SECTION 9.2.3
C-----------------------------------------------------------------
C
CAINJ WELL LIST
CAW1 CAW2 . . . CAWN
C
C-----------------------------------------------------------------
C TIME CARDS SECTION 1.3.6 - 2.1.39
C-----------------------------------------------------------------
TIME (DATE)
STOP
END
C

1.5 Data Format

Nearly all data are input in "free field" format. This means it is not necessary to
enter numbers in specific columns. Each item of data, or "word", must be
separated by either one or more blank columns or by a comma. Unless explicitly
stated, all data need not appear on a single card - the continuation character ‘>’ is
used to extend data onto the next card.
If more than one set of the same data type is read for the same well, the last set of
data encountered is used. For example, if two sets of FPERF cards are read for
Well 3, the second set of FPERF data will be used.
Data appearing on the card or cards following a well list have a one-to-one
correspondence with the wells in the list.
The data stream includes both numbers and alpha keywords; the latter are used to
identify subsequent numbers or select program options. Generally, each new type
of data is introduced by an alpha keyword. Secondary keyword items in [ ] are
“required mutually exclusive” while those in ( ) are “optional”. The brackets and
parentheses should not be input with the data (unless noted); they simple help
describe data input options. In the data descriptions that follow, keywords are
shown in upper case letters (they can be input in upper or lower case). The names
of the variables that are entered as numbers are shown in lower case letters. For
example, one of the data cards indicates the time in days when simulated
operating conditions are to be changed. In the data description, this is written as:
TIME time
This indicates that the data card must contain the alpha label TIME followed by a
number that indicates the time in days. An example of a valid data card follows:
TIME 365
This information could be anywhere on the card so long as nothing else appears in
the columns being scanned and there is at least one blank between TIME and 365.
Numbers can be represented in any of the conventional FORTRAN formats. Note

the following valid representations of the number 1000:
1000 1000. 1.E3 1E3 0.1E+4 10000E-01
None of the various forms may contain an imbedded blank, since the simulator
interprets them as two words rather than one. There is no distinction between
integer and floating point representations of numbers. (All numbers are decoded
as if they were floating point, then are stored as either integer or floating point
variables, depending on use.)

Repeated values can be written in shorthand notation to reduce data preparation

effort. For example, consider two equivalent ways of specifying the following
data card:
Method 1: 10 12.5 12.5 12.5 15. 15. 16.5
Method 2: 10 3*12.5 2*15 16.5
The single "word" 3*12.5 is decoded as 12.5 12.5 12.5 and 2*15 becomes 15 15.
On the other hand, 3* 12.5 could not be decoded properly because of the blank
between * and 12.5. In this case, the simulator issues an error message. If an error
occurs in the time-dependent data, the run stops before the first timestep is taken.
The number of data values on a line is restricted to 20,000. This applies to

decoded repeated values, so that 1500*3 becomes 1,500 data values.
Any word beginning with a number (or a decimal point) must be a valid numeric
form, or it causes the run to terminate before the first timestep. Any word
beginning with a character other than a number (or a decimal point) is treated as
alpha data. A # sign before a number causes the number to be interpreted as an
alpha string.
Any word beginning with an exclamation point (!) indicates the beginning of
inline comments. All text after the exclamation point is ignored by the simulator.
1.5.1 General Utility Data
1.5.1.1 Comment Lines (C)
C comment
Makes a ’comment’ of the field which follows. The alpha label C must be the first
word on the card and must be followed by a blank.
See also the use of the inline comment character !, which is discussed in the
introduction to this section.
1.5.1.2 Read Data from an External File (INCLUDE)
INCLUDE file-name
NOTE: A relative pathname for an include file is resolved with respect to the
current working directory rather than to the directory where the simulation
module dataset resides. 00
Definition: 00

file-name The pathname to the file from which data should be

read.The file name may be contained in double quotes.
The file name may contain blanks; in this case, it must be
contained in double quotes.
When the INCLUDE card is encountered in the input file, the named file is
opened and it becomes the current input file. A fatal error occurs if the file cannot
be opened. Reading from the include file stops when either a physical end-of-file
is encountered or an ENDINC card is encountered. Reading then continues from
the previous input file. Include files can be nested (i.e. contain other INCLUDE
cards). However, the nesting level cannot exceed nine.
1.5.1.3 Stop Reading Data from the Current INCLUDE File (ENDINC)
ENDINC
The ENDINC card indicates the end of data for the current include file. When the
ENDINC card is encountered on an INCLUDE file, the file is closed and data
continues to be read from the previous input file. If INCLUDE files are nested
then the nesting level is decreased by one. The ENDINC card is optional in that a
physical end-of-file also indicates end of data. A warning message is given when
an ENDINC card is encountered on the primary input file.
Examples: ENDINC
1.5.1.4 Echo Print On (LIST)
LIST
LIST and NOLIST cards control printing of card images of the data read. Until a
NOLIST Card is entered, LIST is assumed.
Examples: LIST
1.5.1.5 Echo Print Off (NOLIST)
NOLIST
If NOLIST is read, printing of card images is suppressed until a LIST card is read.
Examples: NOLIST

1.5.1.6 Skip Data On (SKIP)
SKIP
A SKIP card indicates that all subsequent data is ignored until a NOSKIP card is
encountered; i.e. it is as if all the cards were comment lines. The card images are
not printed.
Examples: SKIP
.
.
.
NOSKIP
1.5.1.7 Skip Data Off (NOSKIP)
NOSKIP
A NOSKIP card ends the skip data option.
1.5.1.8 Columns To Be Read (NCOL)
NCOL ncol
Definition: 00
ncol Number of columns to be scanned for data; value must be

between 30 and 1000, inclusive. Default is 1000.
Only the columns 1 to ncol will be processed. Items beyond column ncol will be
ignored (e.g. comments).
Examples: In order to limit processing to the first 45 columns:

NCOL 45
1.5.1.9 Data Line Continuation
Data required to be entered in a single record may be input on multiple lines by

entering a “greater than” (>) character at the end of each data line to be continued.

1.5.2 Well Lists

Several types of data apply to wells. When well data are defined, the alpha label
card identifying the type of data also includes a list of wells for which data are
being entered. A typical list of well numbers may appear as a well list of:
1 2 3 7 10 25 15 16 17 18 19
Alternatively, this could be represented as:
1 -3 7 10 25 15 -19
In this example, 1 -3 means wells 1 through 3. It is mandatory that at least one

blank appear between 1 and -3. Furthermore, a blank may not appear between -
and 3. The well numbers in a well list do not have to appear in sequential order.
Data appearing on the card or cards following a well list have a one-to-one
correspondence with the wells in the list. For example,
QMAX 1 -4 12 10
1250 1000 1725 2*800 950
is interpreted as follows:
Well QMAX
1 1250
2 1000
3 1725
4 800
12 800
10 950
1.5.3 Alternative Well Lists

Wells can also be referred to by their alphanumeric names. However, the well
names need to have been defined by the WELL CARD. A typical list of well
names may appear as a well list of:
A1 A2 AAA INJEC1 #12345678
Well names beginning with ., +, -, / or a numeral need to be preceded by the #

character so as to interpret the string as an alphanumeric. Only the first eight (8)
characters of any character string are used for well names.
A group of wells sharing the same root can be selected by use of an identification
of the form "root*". For this reason the character * cannot be used as part of a well
name.

Data appearing on the card or cards following a well list have a one to one
correspondence with the wells or group of wells in the list. For example, suppose
wells A1, A2, AAA and INJEC1 are defined. Then:
QMAX A* INJEC1
1000. 2000.
is interpreted as follows:
Well QMAX
A1 1000.
A2 1000.
AAA 1000.
INJEC1 2000.
1.6 Files Used by VIP-EXECUTIVE

It is possible to write enough information onto disk to allow a subsequent run to
pick up where the first one left off. The information saved this way is called a
"restart record".
VIP-CORE automatically writes a restart record upon completion of the

initialization process. The simulation modules also have the ability to write restart
records. These subsequent restart records are written as the user directs by means
of WREST and/or WLASTR data cards (see Section 6.7). A subsequent run that
continues a previous run is a "restart run".
To begin a simulation at time zero, the restart file generated by VIP-CORE is

attached. To simulate from a time greater than zero, a restart file created by a
previous simulation run is attached.
Along with the standard restart records, VIP-EXECUTIVE simulation modules

can write periodic summary records for subsequent processing by ancillary
programs. All of the records written can be generated at user-specified time
intervals as directed by means of specific data cards. The currently available menu
of these data cards, the summary records they control, and the FORTRAN units on
which the information is stored include:
PRINT Printer Output (Chapter 6), FORTRAN Unit 6.
WPLOT Production/Injection Data, summarized by well, well

management levels, region, and field (Chapter 6),
FORTRAN Unit 11 or the vdb file.
WCPLOT Production/Injection Compositional Data, summarized

by well, well management levels, region, and field
(Chapter 6), FORTRAN Unit 26 or the vdb file.

WMAP Grid Array Maps (Chapter 6), FORTRAN Unit 27 or the

vdb file.
WMAPOLD Grid Array SIMOUT Maps (Chapter 6), FORTRAN Unit

9.
WREST/ Restart Records (Chapter 6), FORTRAN Unit 2.

WLASTR
WFLUX Boundary flux data (Chapter 6), FORTRAN Unit 16.

FORTRAN Unit 61 is used instead if the model is being
executed as both a fine grid and a course grid.
WFILE Special well file (Chapter 6), FORTRAN Unit 71.
WTRACK Tracking option output (Chapter 6), FORTRAN Unit 17.
To save any or all of these records for subsequent post-processing, appropriate

commands must be added to the job control stream for permanent storage of the
appropriate FORTRAN units.

Simulator I/O is illustrated schematically in Figure 1-2 below along with the
appropriate FORTRAN (FT) Unit numbers.
RESTART FILE: FT02
PRINTER FILE: FT06
SIMOUT MAP FILE: FT09
PLOT DATA FILE: FT11
WELL LAYER SUMMARY: FT13
TARGETING MESSAGE FILE:
FT14
INPUT
DECK: TIMESTEP INFORMATION
FT05 FILE: FT15
VIP-EXECUTIVE OUTPUT BOUNDARY FLUX (IF
SIMULATION NOT ALSO INPUT): FT16
MODULE
RESTART TRACKING OUTPUT: FT17
FILE:
RFT REPORT: FT18
FT03
COMPOSITIONAL PLOT DATA
FILE: FT26
FINE GRID MAP FILE: FT27
BOUNDARY
FLUX BUILDUP PRESSURE DEBUG:
FT16 FT29
STONE PSEUDOS FILE: FT31
SCRATCH FILES: TRACK FILE: FT37
FT01 (Formatted)
FT08 (Formatted) TRACER OUTPUT FILE: FT38
FT04 (Unformatted) WELL PROD/INJ HISTORY
FT21, FT23 FILE: FT40
FLUX DEBUG: FT55
FACILITY UTILIZATION
SUMMARY: FT57
OUTPUT BOUNDARY FLUX (IF
ALSO INPUT USED): FT61
EXPERT RUN STATISTICS
FILE: FT69
WELL REPORT FILE: FT71
SPREADSHEET SUMMARY
FILES: FT72 - FT77
INPUT DATA INCLUDE
OPTION: FT91-FT99
TIMESTEP SUMMARY FILE:
USER-CONTROLLED
Figure 1-2: Simulation I/O Files

1.7 Units Conventions

Three unit conventions are available in VIP-EXECUTIVE. The default unit
system is FIELD (also known as customary, or English units). The others are
METRIC and LAB, which can be selected by placing a METRIC or LAB card in
the UTILITY section of the VIP-CORE input file. The METRIC option also can
specify pressure as kPa (default), kg/cm2, or bar units. All references to kPa in
the METRIC column of the table below can be replaced by kg/cm2 or bar
depending on the pressure option selected.
Data Type Field Metric Lab
Angle degrees degrees degrees
Area acres m2 cm2
Compressibility 1/psi 1/kPa 1/psi
Density (water) gm/cc gm/cc gm/cc
Density (oil) gm/cc or gm/cc or gm/cc or

degree API degree API degree API
Formation volume fac- rb/STB m3/STM3 cc/stcc

tor (oil)
Formation volume fac- rb/MSCF m3/SM3 cc/scc or

tor (gas) or Z-factor or Z-factor z-factor
Gas gravity relative to air at relative to air at relative to air at

std. cond. std. cond. std. cond.
Gas-liquid ratio SCF/STB SM3/STM3 scc/stcc
Length feet meters cm
Moles lb-moles lb-moles gm-moles
Permeability md md md
Pressure psia kPa psia
Rates 1/day 1/day 1/day
Saturation fraction fraction fraction
Standard pressure 14.65 psia 101.325 kPa or 14.65 psia

(default) 1.03353 kg/cm2
Standard temperature 60° F 15° C 15° C

(default)
Solution gas-oil ratio SCF/STB SM3/STM3 scc/stcc
Temperature degrees F degrees C degrees C

Data Type Field Metric Lab
Time days days hours
Transmissibility rb-cp/day/psi m3-cp/day/kPa cc-cp/day/psi
Viscosity cp cp cp
Volume (surface liquid) STB STM3 stcc
Volume (reservoir) rb m3 cc
Volume (surface gas) MSCF SM3 scc
Water-cut fraction fraction fraction
Thermal conductivity Btu/day/ft/° F W/M/° C Btu/day/ft/° F
Thermal trasmissibility Btu/day/° F W/° C Btu/day/° F
Enthalpy Btu/Lb mole kJ/kg mole Btu/Lb mole
Rock heat capacity Btu/ft3/° F kJ/m3/° C Btu/ft3/° F
Fluid heat capacity Btu/Lb/° F kJ/kg/° C Btu/Lb/° F

Chapter
2
Utility Data
00000
2.1 Introduction
The following cards can be used to control the program. Of these, the RESTART
and END cards are required. The other cards should be used when appropriate.
The only order-dependencies involve the RUN, STORAGE, and DIM cards. The
other utility data cards may be in any order, but must precede any recurrent data.
2.2 Control
2.2.1 Start of Time-Dependent Data (RUN)
RUN
The RUN card is an optional card signifying the beginning of the simulation data
deck. If entered it should be the first card. It should not be entered along with a
STORAGE card.
Example:
RUN
DIMNBHPMX NBHPQ NPRFMX NPRFTOTNWMAX
5 5 1 50 5
IMPLICIT
RESTART 0
TITLE2
L4VIPR.DAT RESULTS
START
R5000.0.1 Utility Data 2-57

2.2.2 Calculate Memory Requirement (STORAGE)

If entered the STORAGE card must be the first card in the deck.
STORAGE CORERST
The STORAGE card allows the user to calculate memory requirements for
various combinations of grid size, options, formulation and solver. Model
description is read from the initialization restart. Recurrent data which affect
memory requirements (such as solver and formulation) are obtained from the data
set.
2.2.3 Change Default Dimensions (DIM)

If entered the DIM card(s) must immediately follow the RUN/STORAGE
card, or be the first card(s) in the deck.
The DIM card allows the user to change the default dimensions on any run
starting from initial conditions (time zero) and to increase the dimensions passed
on a restart. Multiple sets of DIM cards may be entered, one after the other, or the
continuation character > may be used.
If a dimension is not changed on a restart run, the value used will be the one read
from the restart file. The defaults noted below only apply until they are initially
overwritten by a DIM card.
DIM param1 param2 . . . paramn (card 1)

size1 size2 . . . sizen (card 2)
Definitions:
param Alpha labels of those dimension parameters being

defined.
NAMAX Amount of workspace available for matrix solution

methods. Default is to use internally calculated value.
NAREAX Maximum number of areas (well management hierarchy)

to be defined in this run. Default is 5.
NBATMX Maximum number of separator batteries to be defined in

this run. Default is 5.
NBHIMX Maximum number of bottomhole pressure tables for

injectors to be defined in this run. Default is 3.
2-58 Utility Data R5000.0.1

NBHIQ Maximum number of rate or tubinghead pressure values

in any of the bottomhole pressure tables for injectors to
be defined in this run. Default is 5.
NBHIV Maximum number of bottomhole pressure values in any

of the bottomhole pressure tables for injectors to be
defined in this run. Default is 50.
NBHPMX Maximum number of bottomhole pressure tables for

producers to be defined in this run. Default is 3.
NBHPQ Maximum number of rate, ratio, water-cut or tubinghead

pressure values in any of the bottomhole pressure tables
for producers to be defined in this run. Default is 5.
NBHPV Maximum number of bottomhole pressure values in any

of the bottomhole pressure tables for producers to be
NCPLMX Maximum number of gasplant interpolation values to be

NCYCMX Maximum number of cycle entries in any cyclic table

(CYCLETABLE or CPERF). Default is 1. If it is desired
to vary constraints by cycle, this dimension must be
increased to the maximum number of cycle specifications
in all input CYCLETABLE and CPERF data.
NCYCTM Maximum cycle table number to be defined in this run.

Default is 10.
NFSMAX Maximum number of flow stations to be defined in this

run. Default is 5.
NGCMAX Maximum number of gathering centers to be defined in

NGLRMX Maximum number of optimal GLR tables (gas lift) to be

NGLRQ Maximum number of rate or water-cut values in any of

the optimal GLR tables (gas lift) to be defined in this run.
Default is 5.
NGLRV Maximum number of gas-liquid (or gas-oil) ratio values

in any of the optimal GLR tables (gas lift) to be defined
in this run. Default is 100.
NIADD Amount of workspace to be added to the internally

calculated length of the integer work array for the BLITZ
matrix solution method. Default is 0.

NIRMX Maximum number of injection regions to be defined in

NPMPMX Maximum number of water pump tubinghead pressure

tables to be defined in this run. Default is 0.
NPMPV Maximum number of rate/tubinghead pressure values in

any of the water pump tubinghead pressure tables to be
NPRFMS Maximum number of real and pseudo perforated

intervals (implicit well option) contained in any well to
be defined in this run. (See Section 7.3.1.) Default is 7 *
NPRFMX.
NPRFMX Maximum number of perforated intervals contained in

any well to be defined in this run. Default is 5.
NPRFSOL Maximum numbr of real and pseuso perforations

(implicit well option) for all wells to be defined in this
run. (See Section 7.3.1.) Default is 7 * NPRFTOT.
NPRFTOT Maximum number of perforations for all wells to be

NPRIMX Maximum number of priorities in the gas project

prioritization option to be defined in this run. Default is
1.
NPROMX Maximum number of projects in the gas project

prioritization option to be defined in this run. Default is
1.
NPRSYS Number of pressure systems to be defined in this run.

Default is 2. This parameter can be specified on the DIM
card for the predictive well management calculations.
NPTNMX Maximum number of patterns for the pattern balancing

option to be defined in this run. Default is 0.
NPWMAL Number of artificial lift methods in any pressure system

to be defined in this run. Default is 1. Currently this
number may not be larger than 1. This parameter can be
specified on the DIM card for the predictive well
management calculations.
NPWMPA Maximum number of producing areas to be defined in

this run. Default is 20. This parameter can be specified on
the DIM card for the predictive well management
calculations.

NPWMPM Maximum number of producing mechanisms to be

defined in the run. Default is 20. This parameter can be
NPWMPS Maximum number of passes in any PWM step to be

defined in this run. Default is 10. This parameter can be
NRCMUN Maximum number of recompletion units per well to be

NRIGMX Maximum number of rigs at any well management level

to be defined in this run. Default is 10.
NRIGTOT Maximum number of automatic workover rigs plus

drilling rigs to be defined in this run. Default is 0.
NSTGMX Maximum number of stages to be defined for any

separator battery in this run. Default is 5.
NTHGMX Maximum number of z-factor/viscosity tables for gas

producer tubinghead pressure option to be defined in this
run. Default is 1.
NTHPGQ Maximum number of pressure or temperature values in

any of the gas producer THP tables to be defined in this
run. Default is 5.
NTHPGV Maximum number of z-factor/viscosity values in any of

the gas producer THP tables to be defined in this run.
Default is 50.
NWIMV Maximum number of entries in any well index multiplier

table to be defined in this run. Default is 30.
NWMAX Maximum well number to be defined in this run. Default

is 10.
NWRKG1 Maximum number of groupings for group 1 to be defined

in this run. Default is 20. This parameter can be specified
on the DIM card for the automatic workover calculations.
NWRKG2 Maximum number of groupings for group 2 to be defined

in this run. Default is 20. This parameter can be specified
on the DIM card for the automatic workover calculations.
NXFCON Maximum number of perforations per crossflow well to

be defined in this run. Default is NPRFMX, which is
usually much too large. The maximum effective number

of perforations per crossflow well for this run is printed

in the Simulation Statistics report at the end of the run.
NXFWEL Maximum number of crossflow wells to be defined in

size The value or size of the corresponding parameter.
Examples:
DIM NPRFTOTNWMAXNGCMAXNBHPMX
660 660 9 10
RESTART 0

2.2.4 Material Balance Option (OPTMBL) (Not available in VIP-THERM)
OPTMBL (STBCHK) (PJACO) (DAMP)
The OPTMBL option is derived from an updating procedure for solution

unknowns that satisfies the material balance for hydrocarbons and water during
each outer iteration. Also, the convergence of the outer iteration is controlled by
the residuals in the saturation constraint equation and the well constraint equation.
The convergence tolerances may be specified through the TOLSCN and
TOLWCN cards, respectively. The use of this option will reduce the number of
outer iterations and hence the CPU time. This option is only applicable to the
IMPES formulation. OPTMBL only functions for the run in which it is specified,
i.e., it is not passed on restarts and must be reentered.
Definitions:
STBCHK Alpha label indicating that an OPTMBL stability test is

only to be performed for single-phase gridblocks either
with two-phase neighbors or that contain wells.
Otherwise, a stability test will be performed for all
single-phase gridblocks. For certain compositional
problems, this feature could significantly reduce the CPU
time. This keyword can be used only for compositional
problems.
PJACO Alpha label indicating that a partial Jacobian update of

the fugacity equations will be performed, in conjunction
with the OPTMBL option. Jacobian coefficients will not
be recalculated for gridblocks that satisfy a preset
convergence criteria. For certain compositional
problems, this feature could result in up to a 20%
reduction in CPU time. This keyword can be used only
for compositional problems.
DAMP Alpha label indicating that damping the outer iteration

solution is allowed.

2.2.5 Volume Balance Option (VOLBAL) (Not available in VIP-THERM)
VOLBAL
The relaxed volume balance (VOLBAL) option is derived from an updating

procedure for solution unknowns that conserves material for hydrocarbons and
water during each outer iteration. The convergence of the outer iteration is
controlled by the residuals in the saturation constraint equation and the well
constraint equation. The convergence tolerances may be specified through the
TOLSCN and TOLWCN cards, respectively. This option is only applicable to the
IMPLICIT formulation.
NOTE: Do not use the VOLBAL option with the POLYMER (Section 9.1)
option.
2.3 Formulation Options (VIP-COMP or VIP-ENCORE)

Two formulation options are available: IMPES and IMPLICIT. The formulation
may be switched from one to another at the beginning of any restart run by
entering any one of the cards. If no formulation card is entered in a run starting
from initial conditions, the IMPES form of the finite difference equations will be
used. If no formulation card is entered in a restart run, the formulation will be the
same as used during the previous run. The format of the restart file is independent
of the formulation option.
2.3.1 Implicit form of Finite Difference Equations (IMPLICIT)
IMPLICIT
Definition:
IMPLICIT This run will use the implicit form of the finite difference
equations. Pressures, saturations and compositions will
be solved for simultaneously. Not required for VIP-
THERM.
Example:
DIMNBHPMX NBHPQ NPRFMXNPRFTOT NWMAX

5 5 10 50 5
IMPLICIT
RESTART 0
TITLE 2
L4VIPR.DAT RESULTS

START
OUTPUT P SO SW
2.3.2 Explicit form of Finite Difference Equations (IMPES) (Not available in

VIP-THERM)
IMPES
Definition:
IMPES This run will use the IMPES form of the finite difference
equations. Only pressure will be implicit.
2.4 Results File Control
2.4.1 Plot File Format and Data Selection (PLOT)
PLOT (FORM) (class1 . . .)
Possible Class Names 00
WELL WLLYR GATHER FLOSTA AREA REGION FIELD SURFACE ALL 00
Definitions: 00
FORM This parameter causes formatted records to be written to

the plot file. It is required for files that are going to be
processed on another computer by PACKER, the Plot and
Map Restructuring program. If the FORM parameter is
omitted, binary records are written to the plot file.
(Binary records are less expensive to write and to store
but do not have the flexibility of being able to be used on
all computer systems).
This parameter is ignored if plot data is being written to

the vdb file.
WELL Well production and injection data.
WLLYR Well production and injection data detailed by layer

perforations.
GATHER Gathering center production and injection data.
FLOSTA Flow station production and injection data.

AREA Area production and injection data.
REGION Region production and injection data.
FIELD Field production and injection data.
SURFACE Surface network pressure and rate data at nodes. This

parameter is applicable only when plot data is being
written to the vdb file.
ALL Data for all classes.
NOTE: 1. The PLOT card is needed if summary records of production/injection

data are to be written during the simulation for subsequent post-
processing. There are three formats. If none of the plot classes are
specified, then all of the plot classes (except WLLYR) are written to
the plot file at WPLOT frequency (see Chapter 6 - Output Control).
If ALL is specified, all of the plot classes (including WLLYR) are
written to the plot file. If one or more plot class names are specified,
only those plot classes (including WLLYR) are written to the plot file.
2. Plot data is either written to the vdb file or written to the plot file. The
default is to use the vdb file. This may be changed by specifying
NOVDB (Section 2.4.4).
3. For additional information, see the PLOT file format description in

the OUTPUT CONTROL section.
Examples: 00
C To get all classes:

PLOT FORM ALL 00
C To select formatted information for WELL, GATHER and FIELD:

PLOT FORM WELL GATHER FIELD 00
2.4.2 Compositional Plot File Format and Data Selection (CPLOT)
CPLOT (FORM) (CNDN)(CCNDN)(class1 ...)
Possible Class Names 00
WELL WLLYR GATHER FLOSTA AREA REGION FIELD ALL 00
Definitions: 00

the compositional plot file. It is required for files that are
going to be processed on another computer by PACKER,

the Plot and Map Restructuring program. If the FORM

parameter is omitted, binary records are written to the
compositional plot file. (Binary records are less
expensive to write and to store but do not have the
flexibility of being able to be used on all computer
systems).
This parameter is ignored if plot data is being written to

the vdb file.
CNDN Condensate production rate and condensate production

yield for the specified classes will be written to the
compositional plot file.
CCNDN Cumulative condensate production volumes for the

specified classes except WLLYR will be written to the
compositional plot file.
WELL Well compositional production and injection data.
WLLYR Well compositional production and injection data

detailed by layer perforations.
GATHER Gathering center compositional production and injection

data.
FLOSTA Flow station compositional production and injection data.
AREA Area compositional production and injection data.
REGION Region compositional production and injection data.
FIELD Field compositional production and injection data.
ALL Data for all classes.
NOTE: The CPLOT card is needed if summary records of compositional

production/injection data are to be written during the simulation for
subsequent post-processing. There are three formats. If none of the plot
classes are specified, then all of the plot classes (except WLLYR) are
written to the compositional plot file at WCPLOT frequency (see Chapter
6 - Output Control). If ALL is specified, all of the plot classes (including
WLLYR) are written to the compositional plot file. If one or more plot
class names are specified, only those plot classes (including WLLYR) are
written to the compositional plot file.
Condensate production rate and yield are not written to the compositional
plot file if CNDN is not specified (default). Cumulative condensate
production volume is not written to the compositional plot file if CCNDN
is not specified (default). The cumulative condensate production volume is
not written to the compositional plot file for WLLYR even when CCNDN
is specified.

The format for CPLOT file is exactly the same as the format for PLOT
file. For additional information, see the PLOT file format description in
the OUTPUT CONTROL section.
Examples: 00
C To get all classes:

CPLOT FORM CNDN CCNDN ALL 00
C To select formatted information for WELL, GATHER and FIELD:

CPLOT FORM CNDN WELL GATHER FIELD 00

2.4.3 Map File Format (MAP)

The MAP card may be entered only if a MAP card was specified in the VIP-
CORE dataset. The MAP card need only be entered in the Utility Data of the
simulation run if the file format is to be changed from that used in the run after
which this run is restarting; i.e., either VIP-CORE or a previous simulation run.
The MAP card is ignored if map data is being written to the vdb file.
By default, the map records will be written to the same type of file (vdb or map
file) as that used in the run after which this run is restarting. If the user wishes to
switch from vdb output to a map file, then a NOVDB card (Section 2.4.4) should
be entered. There is no way to turn vdb back on once NOVDB has been selected.
The arrays to be written to the vdb file/map file may be specified on the recurrent
data cards MAPOUT, MAPX, MAPY, MAPZ, MAPXT, MAPYT, MAPZT,
MAPWT. Note that these cards and the MAP card do not apply to the SIMOUT
map file.
⎛ BINARY
⎞
MAP ⎜ ⎟
⎝ FORM ⎠
Definitions:
BINARY This parameter causes binary records to be written to the

map file (FORTRAN Unit 27). If neither BINARY nor
FORM are entered, the format of the map file will not
change.

the map file (FORTRAN Unit 27). It is required for files
that are going to be disposed to another computer, when
binary compatibility cannot be guaranteed. If neither
BINARY nor FORM are entered, the format of the map
file will not change.

2.4.4 Flat File(s) for PLOT/MAP Instead of VDB File (NOVDB)

The NOVDB card is used to specify that plot/cplot and/or map array data are to be
written to separate files instead of to the vdb file.
It is permissible for plot/cplot data to be written to the vdb file while map array
data is written to a map file (FORTRAN Unit 27), or vice versa (plot to
FORTRAN Unit 11, cplot to FORTRAN Unit 26).
NOVDB (PLOT) (MAP)
Definitions:
PLOT This parameter causes the plot/cplot data to be written to

FORTRAN files rather than the vdb file.
MAP This parameter causes the map array data to be written to

a FORTRAN file rather than the vdb file.
NOTE: If no NOVDB or VDB card is entered, plot/cplot data will be written to

the vdb file, while map data will be written to whatever file type was used
in VIP-CORE.
If a NOVDB card is entered with no additional parameters, the effect is the

same as entering both PLOT and MAP.
2.4.5 VDB File for PLOT/MAP Data (VDB)

The VDB card is used to cause plot/cplot and/or map array data to be written to
the vdb file. It may also be used to request the simultaneous writing of plot/cplot
and/or map array data to the respective FORTRAN files.
It is permissible for plot/cplot data to be written to the vdb file while map array
data is written to a map file (FORTRAN Unit 27), or vice versa (plot to
FORTRAN Unit 11, cplot to FORTRAN Unit 26).
VDB (PLUS (PLOT) (MAP))
Definitions:
PLUS This parameter causes one or both of PLOT and MAP to

be written simultaneously to the vdb file and the
respective FORTRAN files.
PLOT This parameter causes the plot/cplot data to be written to

both the FORTRAN files and the vdb file.

MAP This parameter causes the map array data to be written to

both a FORTRAN file and the vdb file.
NOTE: If no NOVDB or VDB card is entered, plot/cplot data will be written to

the vdb file, while map data will be written to whatever file type was used
in VIP-CORE.
If the PLUS parameter is entered, at least one of PLOT or MAP must also
be entered.
If a VDB card is entered with no additional parameters, both PLOT and

MAP will only be written to the vdb file.
2.4.6 Flow Vectors (FLOWVEC) (Not accepted by VIP-THERM, see FLOWS

card in VIP-CORE manual)
FLOWVEC
The FLOWVEC card is used to indicate that, during this run or a subsequent
restart run, the printing and/or mapping of flow vector arrays will be requested.

2.5 Pore Volume Deformation Option (PVDEF)

The PVDEF card is an optional keyword that will automatically do the following:
Cause a flat map file to be written. A vdb file will also be written if the
data so specifies. A MAP card must have been entered in VIP-CORE.
The flat map file will be binary unless the user specifies FORMAT on the
MAP card.
In addition to any arrays written to the map file using the MAPOUT card,
the following arrays will be written: P SG SW SO PV PVMUL .
A set of map data will always be written at the time corresponding to the
STOP (or END) card, regardless of any WMAP data.
This option will remain true on subsequent restarts. OFF allows the user
to disable it.
PVDEF (OFF)
Definitions:
OFF Alpha label turning off the PVDEF option.

2.6 Conductive (Leaky) Fault Solution Options (Not available in

VIP-THERM)
2.6.1 Segregated Flow Assumption (SEGREG)
SEGREG
Definitions:
SEGREG Alpha label indicating that the segregated flow

assumption in conductive faults is to be used. If the
SEGREG card is not entered, the fully-mixed assumption
is used.
2.6.2 Fully Coupled Calculation (LKCPLD)
ON
LKCPLD
OFF
Definitions:
ON Alpha label indicating that the fully coupled calculation

for inflow gridblocks is to be performed.
OFF Alpha label indicating that a portion (related to outflow

gridblocks’ rates) of the rate calculation for inflow
gridblocks (gridblocks receiving fluids from faults) is to
be iteratively lagged.
NOTE: If the LKCPLD card is omitted in a run starting from time=0, the default is
to use the fully coupled calculation. If the LKCPLD card is omitted in a
restart run, the default is to use whatever was the case on the previous run.
The lagged option (LKCPLD OFF) in general could significantly reduce

the solver CPU time and hence will be more efficient for simple models.
However, it may increase the number of Newton iterations and/or cause
convergence problems for more complex models (e.g., fine-grid models).

2.7 General
The AUTOCYCLE card is required for any run using automatic cycle control
(Section 3.17).
AUTOCYCLE
2.7.1 Restarting Runs (RESTART)

This card is required on every run, including runs that begin from initial
conditions.
⎛ istart ⎞
⎜ ⎟
⎜ STEPNO istart ⎟
RESTART ⎜ ⎟ (NOOUT)
⎜ DATE date month year ⎟
⎜ TIME time ⎟
⎜ ⎟
⎝ LAST ⎠
Definitions:
istart The timestep number from which this run is to begin. A

value of zero indicates a run that will start from initial
conditions. Default is 0.
STEPNO Alpha label indicating that the restart record written on a

certain timestep should be used.
istrt The timestep number from which this run is to begin. A

value of zero indicates a run that will start from initial
conditions. No default.
DATE Alpha label indicating that the restart record written on a

certain date should be used.
d..m..y.. The day, month, and year from which this run is to begin.
No default.
TIME Alpha label indicating that the restart record written at a

certain time should be used.
time The time, in days, from which the run is to begin. No

default.

LAST Alpha label indicating that the last record found on the
restart file is to be used to start this run. This record must
have been written at a time greater than zero.
NOOUT Alpha label indicating that no output restart file

(FORTRAN Unit 2) is to be generated during this run.
This is useful for quick runs when it is known that no
subsequent runs will be restarted from this one.
Example:
For a restart run starting from timestep number 11, whose corresponding date
is March 25, 1989, the following three lines function identically.
RESTART 11
RESTART STEPNO 11
RESTART DATE 25 3 1989
If the output restart file is not needed, the input is
RESTART 11 NOOUT
2.7.2 Descriptive Run Information (TITLE1, TITLE2, TITLE3)

Title cards are not required. If none are read, then the titles contained on the restart
record will be retained. Any or all of the three title cards contained on the restart
record can be overwritten by entering new title cards.
TITLE1
title1
TITLE2
title2
TITLE3
title3
Definitions:
TITLEn Alpha label indicating that titlen is to be replaced by the

information on the following card.
titlen The information on this card will replace that contained

on the restart record for title line n.
2.7.3 Beginning of Data (START)

All data appearing between the last recognized utility data and the START card
will be ignored. On subsequent restart runs the START card can be moved down
in the data deck to cause previously used data to be ignored.

The START card is not required to be input. If it is omitted the simulator will
effectively insert a START card at the appropriate position in the input data based
on the information on the RESTART card. For a run starting at time = 0, the
START card is placed immediately following all recognized utility data. When
starting from a time > 0, the placement depends on whether a TIME/DATE card
exists with the specified time equal to the restart time. If so the START card is
placed after the corresponding TIME/DATE card. If not the START card is placed
immediately before the next TIME/DATE card after the restart time.
START
Definition:
START Alpha label indicating the beginning of the data to be

included in this run.
2.7.4 Time Specification for Reading Data (TIME)

TIME and DATE cards are used interchangeably to control timestep size and
output frequency, and may be mixed in the same run. One TIME or DATE card is
required.
TIME PLUS delt

time
Definitions:
PLUS Alpha label indicating that the following value is a time

increment.
delt Time increment, days. The following data group will be

read at the time equal to the current time plus delt.
time Time in days at which the following data group is read.

This must be a positive value. Subsequent time values
always must increase.
Example:
TIME PLUS 1.0

TIME 360
.
.
C RECURRENT DATA FOR THE PERIOD

C 360 TO 720 DAYS GOES HERE

.
.
TIME 720
2.7.5 Date Specification for Reading Data (DATE)

TIME and DATE cards are used interchangeably to control timestep size and
output frequency, and may be mixed in the same run. One TIME or DATE card is
required.
The date on this card determines the time at which the following data group is
read. The program does account for leap years.
DATE day mo yr
Definitions:
day Day of the month.
mo Month expressed as a number from 1 to 12.
yr Year. If yr is entered as a number smaller than 1000, it is

interpreted as 1900 + yr (e.g. 75 becomes 1975, 101
becomes 2001). Any value greater than or equal to 1000
is not adjusted.
2.7.6 Run Termination (STOP)

The STOP card terminates the run at the time defined on the TIME or DATE card
preceding it. No further data processing will occur after a STOP card is found. If
the STOP card is omitted, the END card is used to terminate the run.
STOP
Example:
C Data here is processed

STOP
C Data here is not processed
END
2.7.7 End-of-File Marker (END)

The END card must be the last card in the data stream; it acts as an end-of-file

marker. When the END card is read, error checking and data processing begins.
END

Chapter
3
00000 Well Data
3.1 Introduction
The well data includes all data which describes wells; i.e., the definition of all
well and well management level parameters. The minimum required well data is
shown in Table 1-1 and Table 1-2 . These tables also exhibit the minimum data
requirements for wells subject to pressure constraints at the well level.
3.2 Well Location

VIP-EXECUTIVE model wells may be vertical or deviated. A well is referred to
as "vertical" if its perforations all have the same areal coordinates; otherwise it is
"deviated". Thus, a vertical VIP-EXECUTIVE model well can incline from true
vertical. More than one well may coexist in a given gridblock. Also, a well may
have more than one perforation in a given reservoir layer.
Additionally an inclined and horizontal well flow correlation option is available.

It is activated through parameters on the FPERF card.
If a pattern element option was selected in VIP-CORE (see Section 2.2.3.4 of the
VIP-CORE Reference Manual), then all extensive well input and output data
(minimum and maximum rates, KH values, production/injection rates and
cumulative, etc.) are defined as full well values. The grid geometry is fixed for
each pattern element option and is shown in Figures 2-2 to 2-8 of the VIP-CORE
Reference Manual. Conventional injector/producer well locations are
summarized in Table 3-1 for all the pattern element types.
Table 3-1: Conventional Well Locations For Pattern Element Options
Grid
Pattern Type Well Description Well Location
Orientation
1/8 5- or 9-spot Parallel Injector 1, NY

Corner Producer NX, 1
Side Producer (9-spot) 1, 1
1/8 5- or 9-spot Diagonal Inejctor 1, NY

Corner Producer NX, NY
Side Producer (9-spot) (NX-1)/2, 1
R5000.0.1 Well Data 3-79

Table 3-1: Conventional Well Locations For Pattern Element Options
Grid
Pattern Type Well Description Well Location
Orientation
1/4 5- or 9-spot Parallel Injector 1, NY

Corner Producer NX, 1
Side Producer (9-spot) 1, 1
Side Producer (9-spot) NX, NY
1/4 5- or 9-spot Diagonal Injector (NX-1)/2, NY

Corner Producer (NX-1)/2, 1
Side Producer (9-spot) 1, (NY-1)/2
Side Producer (9-spot) NX, (NY-1)/2
1/12 7-spot -- Injector 1, NY

Producer NX, 1
1/6 7-spot -- Injector (NX-1)/2, 1

Producer 1, NY
Producer NX, NY
3.2.1 Well Name and Location (WELL)

Vertical Well
WELL N (NAME) (GRID) IW JW (IGC) (IBAT)

nw (wname) (gridname) iw jw (igc) (ibat)
(Repeat data card as necessary for subsequent wells.)
Deviated Well
WELL N (NAME)(GRID) IW JW (IGC) (IBAT)

nw (wname)(gridname)X X (igc) (ibat)
or
WELL N (NAME)(GRID) (IGC) (IBAT)

nw (wname)(gridname)(igc) (ibat)
(Repeat data card as necessary for subsequent wells.)
3-80 Well Data R5000.0.1

Definitions:
N Alpha label indicating that this field will contain a well

number. Required as the first data field following WELL.
NAME Alpha label indicating that this field will contain a well
name.
GRID Alpha keyword indicating that this field will contain the
grid name in which the well is perforated.
IW Alpha label indicating that this field will contain the x

direction (r direction) index of the gridblock containing
the well.
JW Alpha label indicating that this field will contain the y

direction (θ direction) index of the gridblock containing
the well.
IGC Alpha label indicating that this field will contain the
number of the gathering center to which the well is
attached.
IBAT Alpha label indicating that this field will contain the
number of the separator battery to which the well is
assigned.
nw Well number. Any value in the range of one to NWMAX

(maximum well number for which the program is
dimensioned) may be used. A value of zero causes the
program to automatically assign a well number to the
well, provided a well name is used to define the well. In
this case, the well number assigned will be the minimum
value between one and NWMAX that has not already
been allocated by the user or chosen by the program.
wname Well name of up to eight (8) characters. The first

character in the name must be alphabetic unless the name
is immediately preceded by the character #. The well
name must be unique. A repeated well name will result in
an error message and termination of the run. Default is
blanks.
gridname Name of the grid in which this well is perforated. If

entered, the iw, jw well location must be relative to this
grid.
iw X direction (r direction) index of the gridblock

containing the well.
R5000.0.1 Well Data 3-81

jw Y direction (θ direction) index of the gridblock

containing the well.
igc Number of the gathering center to which the well is

attached. Default is 1.
ibat Number of the separator battery to which the well is

assigned. Alternatives include the battery number of a
separator input in the separator data (Surface Separator
Data), a value of -npvt which accesses a default
separator, and a value of 0:
ibati = nbat (input battery)

= -npvt (default separator)
= 0
Default is 0 which will result in Separator 1 being

assigned if one has been defined or the default separator
for PVT region 1 if one has not been defined.
The deviated well option can be used to model any non-vertical well, including
horizontal wells. The data format is identical to the format for the vertical well
option. However, to define a deviated well, the iw and jw fields must contain the
alphabetic character X, if the IW and JW fields appear on the WELL card. If the
IW and JW fields are absent from a WELL card, this implies that the well is
deviated.
The areal locations of the deviated well completions are entered by perforation as
described in the FPERF card.
NOTE: (for both Vertical and Deviated wells):
1.Data fields on the WELL card may be entered in any order. However,
the data following the WELL card must be in the order specified by
the heading labels.
2.Once a well has been defined with a WELL card, it cannot be redefined.
A second WELL card with the same well number results in an error
message and terminates the run.
3.A well must be defined by a WELL card before any references can be
made to the well on other data cards.
4.NWMAX, the maximum well number permitted, is a limit established

by program dimensions. This value is printed on the first page of the
program output and may be reset by using the DIM card (see Section
2.2.3).
5.More than one well may be assigned the same (iw, jw) location.
Examples:
3-82 Well Data R5000.0.1

VERTICAL:
C+++++++++++++++++++++++++++++++++
C WELLS 1 -364 SAD WELLS
C 253 -266 NGI WELLS
C 324 -326 WGI WELLS
C PUT WELLS INTO THE APPROPRIATE GC/FS
C
C+++++++++++++++++++++++++++++++++
C
WELL NNAME IW JW IGC

1 #01-01 18 26 4
DEVIATED:
WELL N NAMEIW JW IGC IBAT

5DEV1 X X 2 3
or
WELL N NAMEIGC IBAT

5DEV1 2 3
3.2.2 Describe Well Perforations (FPERF)

The FPERF card is used to describe well perforations. Three basic formats are
permitted, with optional data for specific situations. If necessary, one or more
continuation cards may be used by placing the character ">" as the last string on a
card and then continuing the data on the following card. Except for the well
number, the data may appear in any order; however, the order on the cards for the
perforations must match the order of the headings.
If the water-oil hysteresis model is being used (VIP-CORE Section 4.3.4), ISAT
cannot be specified unless hysteresis for the perforation relative permeabilities is
deactivated by entering a NOHYSW card before the FPERF card. By default,
perforation relative permeabilities are set equal to the hysteretic gridblock values.
NOHYSW
General Format:
FPERF (NOPWDEP) (NORESET) (card 1)

WELL (other headings) (card 2)
Perforation data cards (card 3)
(Card 3 is repeated as necessary to describe all the
perforations for each well being perforated.)
R5000.0.1 Well Data 3-83

The three basic formats for the FPERF cards are:
Format A: (Any relative permeability option; each layer specified)
FPERF (card 1)
(K)
(H)
WELL L (IW JW) (KH)(Other headings)(card 2)
(K H)
(k)
(h)
nw l (iw jw) (kh) (Other data) (card 3)
(k h)
Format B: (Any permeability option; depth to perforations specified)
FPERF (card 1)
WELL(IW JW) DTOP DBOT (K)(Other headings)(card 2)
nw (iw jw) dtop dbot (k)(Other data)(card 3)
Format C: (Vertical equilibrium relative permeability; each layer specified)
FPERF (card 1)
(K)
WELLL (IW JW)HTOP HBOT(KH) (Other headings)(card 2)
(k)
nw l (iw jw) htop hbot (kh) (Other data)(card 3)
In the basic formats shown above, the "other headings" may identify 1) data
affecting relative permeability endpoints (SWL, SWMN, SWRO, SWMX, SGL,
SGMN, SGRO, SGMX, ISAT, ISATI); 2) weighting factors used to interpolate
between rock and vertical equilibrium relative permeability (FVEW, FVEG); 3)
perforation status (STAT); 4) perforation unit number (UNIT) and/or
recompletion unit number (RCMPUNT); 5) well index values for each perforation
or the data to calculate the values (WIL, SKIN, RADB, RADW); 6) additional
data required for the reduced entry skin (Sr) calculation, to be used in conjunction
with the calculation of the well index for each perforation (RKHKV, DHTOP,
HTOT); 7) rate dependent skin factor for non-Darcy gas flow (WDL); and 8)
inclined and horizontal well data (LENGTH, PWDEP, DIAM, ROUGH, ANGLV,
ANGLA). In VIP-THERM, the “other headings” may also identify 1) specified
production well gradients (GRAD); and 2) a well index permeability thickness
product (KHWI).
For each column heading that appears on card 2, a single data value must appear
in the corresponding position on each card 3. An exception to this rule is data for
L, the layer number. A range of values may be entered. Some of the data may
only be used for certain types of models or in conjunction with other data; such
restrictions are noted below.
3-84 Well Data R5000.0.1

Inclusion of the UNIT heading invokes the perforation UNIT option in which
layers are grouped into perforation units before perforation production constraints
are applied. The unit number has no effect on injection wells.
A separate grouping algorithm is invoked using the RCMPUNT heading and data.
This option involves the automatic opening of a group of perforations when
another group violates constraints. This unit number has no effect on injection
wells.
NOTE: If neither KH nor K are entered, an effective permeability will be

computed using gridblock permeability from VIP-CORE. BUT, IF
PERMEABILITIES WERE NOT ENTERED IN VIP-CORE (I.E., PORE
VOLUMES AND TRANSMISSIBILITIES WERE INPUT), THE
EFFECTIVE PERMEABILITY COMPUTED HERE WILL BE ZERO.
Definitions:
NOPWDEP Alpha label indicating that, for horizontal/inclined wells

for which PWDEP data is not entered, the depth to center
of well segment will be set to the depth of the gridblock
containing the perforation.
NORESET Alpha label indicating that the well and perforation

cumulative reservoir production arrays (for each of the
wells entered), used in conjunction with the WI
multiplier tables (Section 3.19.2), should not be reset to
zero with the input of new FPERF data. Default is to zero
out these arrays.
WELL Column heading for nw, the well number or well name.
The well number or name must be entered for each data
card. For multiple completions in a single well the alpha
label X can be substituted for the well number or well
name on each data card after the first.
GRID Column heading for gridname, the name of the grid in

which this well perforation is located. The iw, jw and l, if
entered for the perforation, must be relative to this grid.
L Column heading for l, the layer number for a completed

interval. Required unless dtop and dbot are used. A
single number or a range of values may be entered. The
format for the range of values is i1
-i2, where i1 ≤ i2, or i1 NZ. The last format results in
perforations in all layers between layer i1 and the last
layer in the appropriate grid, inclusive.
IW Column heading for iw, the x(r) direction gridblock index

of the block containing the perforation for a deviated
well.
R5000.0.1 Well Data 3-85

JW Column heading for jw, the y(θ) direction gridblock

index of the block containing the perforation for a
deviated well.
K Column heading for k, the average permeability times the

net-to-gross ratio of the perforated interval, md (md). For
an areal model, the default is the product of the gridblock
net-to-gross ratio and K x K y ( or K r K θ ). For a cross-
section model, the default is the product of the gridblock
net-to-gross ratio and the appropriate permeability. Not
permitted with kh.
H Column heading for h, the thickness of the perforated

interval, ft (m). Default is gridblock gross thickness. Not
permitted with kh, dtop, dbot, htop, or hbot.
KH Column heading for kh, the average permeability-

thickness of the perforated interval, md-ft (md-m) or a
permeability-thickness multiplier. Default is the product
of the gridblock’s areal permeability and net thickness.
To input a permeability thickness-multiplier, enter a ‘*’

followed by the value. The permeability-thickness of the
perforation will be the default calculation times the
multiplier.
UNIT Column heading for unit, the perforation unit number.

Values must lie between 1 and nprfmx.
RCMPUNT Column heading for rcmpunt, the recompletion unit

number. Values must lie between 1 and nrcmun.
Permitted only if the dimension nrcmun is greater than
zero.
DTOP Column heading for dtop, the subsea depth to the top of a
perforated interval, ft (m). May not be used with l, kh, h,
htop, or hbot. Must appear with dbot. Required unless l
is used. When used with the VE option with corner point
geometry, the layer number l must also be specified. Also
for this special case, if dtop is entered as -1.0, it will be
reset to the gridblock center top depth.
DBOT Column heading for dbot, the subsea depth to the bottom
of a perforated interval, ft (m). May not be used with l,
kh, h, htop, or hbot. Must appear with dtop. Required
unless l is used. When used with the VE option with
corner point geometry, the layer number l must also be
specified. Also for this special case, if dbot is entered as -
1.0, it will be reset to the gridblock center bottom depth.
3-86 Well Data R5000.0.1

HTOP Column heading for htop, the distance from the top of
the gridblock to the top of the perforation, expressed as a
fraction of the gross thickness of the gridblock. Default is
0. Permitted only in Format C when using the vertical
equilibrium option. The value of htop can be less than 0
in the VE corner-point option.
HBOT Column heading for hbot, the distance from the top of
the gridblock to the bottom of the perforation, expressed
as a fraction of the gross thickness of the gridblock.
Default is 1. Permitted only in Format C when using the
vertical equilibrium option. The value of hbot can be
greater than 1 in the VE corner-point option.
DHTOP Column heading for dhtop, the distance between the top
of the block where the wellbore penetrated the block, and
the top of the perforated interval, ft(m). Default is 0.,
except when DTOP and DBOT are also specified, in
which case dhtop is calculated as dtop * gross thickness.
The value of dhtop can be less than 0 in the VE corner-
point option.
HTOT Column heading for htot, the maximum sand thickness

which could be perforated along the wellbore within the
gridblock, ft(m); i.e., not necessarily the true vertical net
sand thickness. Default is the gross thickness of the
block. For the special case of the VE option with corner
point geometry, the default is the deepest corner point
base depth minus the shallowest corner point top depth.
SWL Column heading for swl, the connate water saturation to

be used in denormalizing water relative permeabilities
for this perforation. Default is the gridblock’s value.
SWMN and SWRO must also be specified.
SWMN Column heading for swmn, the residual water saturation

to be used in denormalizing water relative permeabilities
SWRO must also be specified.
SWRO Column heading for swro, the water saturation at residual

oil to water, to be used in denormalizing water relative
permeabilities for this perforation. Default is the
gridblock’s value. SWMN must also be specified.
SWMX Column heading for swmx, the maximum water

saturation to be used in denormalizing water relative
permeabilities for this perforation. Default is 1. SWMN
and SWRO must also be specified.
R5000.0.1 Well Data 3-87

SGL Column heading for sgl, the connate gas saturation to be

used in denormalizing gas relative permeabilities for this
perforation. Default is the gridblock’s value. SGMN and
SGRO must also be specified.
SGMN Column heading for sgmn, the residual gas saturation to

be used in denormalizing gas relative permeabilities for
this perforation. Default is the gridblock’s value. SGRO
must also be specified.
SGRO Column heading for sgro, the gas saturation at residual

oil to gas, to be used in denormalizing gas relative
gridblock’s value. SGMN must also be specified.
SGMX Column heading for sgmx, the maximum gas saturation

to be used in denormalizing gas relative permeabilities
for this perforation. Default is 1-swl. SGMN and SGRO
ISAT Column heading for isat, the saturation table to be used

in calculating relative permeabilities. Default is the
gridblock’s rock type.
ISATI Column heading for isati, the imbibition saturation table

to be used in calculating relative permeabilities. Default
is the gridblock’s rock type.
ICMT Column heading for icmt, the compaction table to be

used in calculating effective pore volume and the
perforation permeability thickness. Default is the
gridblock’s compaction table. The TAMULT column of
multipliers will be used for vertical wells; the TVMULT
column of multipliers (set equal to TAMULT if not
entered) will be used for horizontal/inclined wells.
IWIM Column heading for iwim, the WI multiplier table to be

used in calculating the effective perforation well index.
Entering this data causes the table lookups for this well to
be by perforation. If not entered, or if a subsequent
WIMUWL (Section 3.19.1) value is entered for this well,
the table lookup will be for the well as a whole.
Perforation data only applies to WI multiplier tables with
one of the cumulative reservoir production options.
FVEW Column heading for fvew, the weighting factor used to

interpolate between rock and vertical equilibrium relative
permeabilities in the matrix for water-oil systems. A
value of 1.0 is full vertical equilibrium. Default is the
gridblock’s value.
3-88 Well Data R5000.0.1

FVEG Column heading for fveg, the weighting factor used to

permeabilities in the matrix for gas-oil systems. A value
of 1.0 is full vertical equilibrium. Default is the
STAT Column heading for stat, the perforation status indicator.

Value is ON or OFF. Default is ON.
WDL Column heading for wdl, the rate dependent skin factor
for non-Darcy gas flow.
WIL Column heading for wil, the well index, by perforation.

Dimensionless.
If WIL is not specified as a data item, and if any one or

more of the data items SKIN, RADB, RADW, RKHKV,
DHTOP, or HTOT is specified, then wil will be
calculated as follows:
Δθ
wil = -----------------------------------------------------------
radb
⎛ l n ⎛ -------------⎞ + skin + Sr⎞
⎝ ⎝ radw⎠ ⎠
where Δθ = 2π for rectangular grids and varies with

ntheta for radial grids. For rectangular grids, Δθ can be
changed by the FLOANG card. Sr is zero unless any one
or more of the data items RKHKV, DHTOP, or HTOT is
specified, in which case Sr will be calculated as follows:
0.825
Sr = 1.35 ⎛ htot
---------- – 1⎞ { ln ( htot rkhkv + 7 ) – [ 0.49 + 0.1 ln ( htot rkhkv ) ]ln r wc – 1.95 }
⎝ h ⎠
where rwc = radw e0.2126(Zm/htot +2.753)
and Zm = dhtop + h(hbot - htop)/2
SKIN Column heading for skin, the skin factor for this
perforation. Dimensionless. Default is 0.
RADB Column heading for radb, the equivalent radius of the

gridblock containing the well, ft (m). Default is the value
computed in VIP-CORE based on Peaceman’s
recommendation (Reference 2):
1⁄2 1⁄2
⎛ kx
------⎞ Δy 2 + ⎛ ------⎞ Δx 2
ky
⎝ ky⎠ ⎝ kx⎠
radb = 0.28 -------------------------------------------------------------------
1⁄4
-
⎛ kx
------⎞ ky 1 ⁄ 4
+ ⎛ ------⎞
⎝ ky⎠ ⎝ kx⎠
R5000.0.1 Well Data 3-89

RADW Column heading for radw, the wellbore radius, ft (m).

Default is 0.25.
RKHKV Column heading for rkhkv, the ratio of horizontal to

vertical permeability within this productive interval.
Default is 1.
The following only apply to inclined and horizontal wells
LENGTH Column heading for length, the length of well segment in

a well gridblock, ft (m).
PWDEP Column heading for pwdep, the depth to center of well

segment, ft (m). If not specified, the depth will be
computed from LENGTH and ANGLV.
DIAM Column heading for diam, the diameter of the well

segment, ft (m). RADW may be used instead.
ROUGH Column heading for rough, the absolute roughness of the

well segment, ft (m).
ANGLV Column heading for anglv, the angle of the source end of
the segment to the downward vertical direction, degrees.
ANGLA Column heading for angla, the angle of the segment with
respect to the x axis in the areal plane, degrees. Default is
0.
The following only apply to VIP-THERM:
GRAD Column heading indicating the position of grad on the

following data cards.
grad Wellbore gradient for the perforated interval, psi/ft (kPa/

m). Ignored for injection wells.
KHWI Column heading indicating the position of khwi on the

following data cards.
khwi For producers (see Equation , Section 3.6), khwi =

0.001127 ⋅ WI ⋅ KH, rB cp/D psia (rm3 cp/D kPa).
For water/steam injectors (see Equation 3-1 and 3-5 in

Section 3.4.2.4), khwi = 0.001127 ⋅ WI ⋅ KH ⋅ λ, rB/D
psia (rm3/D kPa).
Do not use for gas injectors.
NOTE: 1.All unread data is given default values prior to calculating perforation
properties.
3-90 Well Data R5000.0.1

2.In Format B, the simulator automatically generates as many perforations

as required by the dtop and dbot data. In this case, iw and jw are
held constant over the perforated thickness.
3.In Format C, if k is read, the htop and hbot data are used to determine
thickness and position of the perforation. If kh is read, then htop and
hbot determine position only.
4.If h is read in Format A when using vertical equilibrium relative

permeabilities, htop and hbot are set so as to center the perforation
vertically in the gridblock.
5.All perforations for each well being perforated must be defined on

consecutive cards.
6.If an interval is specified more than once, the result is multiple

perforations; i.e., the KH will be cumulative. The previously specified
interval is not replaced.
7.When compaction tables are entered in VIP-CORE, the KH of each

perforation is multiplied by the appropriate compaction multiplier.
The lookup table is either the one specified with icmt in FPERF data,
or the perforation gridblock table specified in VIP-CORE. The
TAMULT column of multipliers will be used for vertical wells; the
TVMULT column of multipliers (set equal to TAMULT if not
entered) will be used for horizontal/inclined wells.
8.Except for one condition, respecifying the FPERF data for a well
replaces the entire set of perforations with the new data. The
exception is when the new data immediately follows the old data on
the same FPERF card. In this case the new data is assumed to be a
continuation of the old data.
9.When rate dependent skin factor for each perforation (WDL) is

specified, the well index cannot be zero. Well index set to zero is a
special case which means adjusting the well index to honor both the
rate and bottomhole pressure constraints. In such case, rate dependent
skin factor does not have effective meanings. An error message will
print in the output and the simulation run will be terminated.
10.The inclined and horizontal well flow correlation option is activated by

the presence of the LENGTH, PWDEP, DIAM, ROUGH, ANGLV,
and ANGLA keywords on the FPERF card. These data cause the well
index and permeability thickness to be computed automatically.
Optional keywords to alter the flow correlation and friction factors are
given in Section 3.2.6 and Section 3.2.7. If the data for a
multilateral well is being input, set the values of ROUGH, the
absolute roughness, to -1. This disables the friction loss computation
which is currently inaccurate for this type of well. Wellbore gradients
will be calculated by the simulator using the volume balance method
(Section 3.7.2) which cannot be overridden.
R5000.0.1 Well Data 3-91

11.If KHWI is input, then a productivity index (specified by WIL data or

by a PI, WI, or RFLOW card, Section 3.6) is not required and will be
ignored if input.
Example 1:
FPERF
WELLL
1 3
X 4
X 6
2 1
X 2
Example 2:
FPERF
WELLL KH
1 2 3000
X 3 4200
X 4 1700
2 1 5780
X 2 3620
In this example perforated intervals are defined for Wells 1 and 2. Well 1 is
perforated in layers 2, 3, and 4 with permeability-thickness values of 3000, 4200,
and 1700 md-ft, respectively. Well 2 is perforated in layers 1 and 2 with
permeability-thickness values of 5780 and 3620 md-ft, respectively.
Example 3:
FPERF
WELLL IW JW KH
1 7 1 1 1550
X 7 1 2 3100
X 7 1 3 1550
X 8 1 1 120
X 8 1 2 240
X 8 1 3 120
In this example perforations are defined for a three-dimensional coning problem.

The well is completed in layers 7 and 8 in the first radial annulus (I=1). All of the
angular increments are completed (J=1,3).
Example 4:
FPERF
WELLL WIL
22 3 .85
X 4 1.02
X 5 1.24
3-92 Well Data R5000.0.1

In this example, Well 22 is perforated in layers 3, 4, and 5, and each of the layers
has exhibited a different response to the stimulation treatment.
Example 5:
FPERF
WELLL RADBRADWSKIN
27 1 450. .25 -1.5
X 2 450. .25 2.2
In this example, Well 27 is perforated in layers 1 and 2, and each of the layers has
exhibited a different response to the stimulation treatment.
Example 6:
FPERF
WELLLHRADB RADW SKINRKHKVDHTOP HTOT
35 1 20450. .25 -1.5 2.0 10. 30
X 2 15450. .25 2.2 5.0 0 25
In this example, Well 35 is perforated in layers 1 and 2, and each of the layers has
exhibited a different response to the stimulation treatment. In addition, layer 1 is
perforated in the lower 20 feet of layer 1, ten feet below the top of the layer, and
layer 2 is perforated in the top 15 feet. Layer 1 is fairly clean, with a kh to kv ratio
of 2. Layer 2 has more shaly streaks, with a kh to kv ratio of 5. The wil values will
be calculated for each layer, after first calculating a reduced entry skin factor for
each layer. The permeability-thickness values stored for each layer will be the
layer permeability times htot, since the reduced entry skin factor will compensate
for the partial penetration.
Example 7:
FPERF
WELLLDTOPDBOT SKINRKHKVHTOT
42 3 7528-1 .4 4.5 45
X 4 -1 7588 -.82.5 52
This combination of both L and DTOP/DBOT can only be used with the special
case of using the VE option with corner point geometry. In this example, the
reduced entry skin factor will be calculated for each layer based on its perforated
interval relative to the geometry of the gridblock. The wil values for each layer
will then be calculated, and the permeability-thickness stored for the layers will be
the layer permeability times its htot.
The following example illustrates the definition of an inclined well, perforated in

layers 1-4 and with a horizontal section in layer 4.
R5000.0.1 Well Data 3-93

Example 8:
FPERF
WELLL IWJW LENGTH PWDEP DIAM ROUGH ANGLV ANGLASKIN
21 3 1118 4450 0.25 0.00001 540. 5

X 2 31 120 4490 0.25 0.00001 7 40.5
X 3 31 50 4560 0.25 0.0000110 402
X 4 31 45 4577 0.15 0.0000120 403
X 4 41 90 4600 0.15 0.0000120 404
X 4 51 70 4635 0.15 0.0000190 402
X 4 61 150 4635 0.15 0.0000190 405
X 4 71 100 4635 0.15 0.0000190 406
X 4 81 100 4635 0.15 0.0000190 4010
The following example illustrates the simulation of a multilateral well.
Example 9:
FPERF
WELLIWJWL LENGTHDIAMROUGHANGLVANGLA
111 11 550 0.375 -1.090. 0.

X 12 115 100 0.375-1.090. 0.
X 13 115 100 0.375-1.090. 0.
X 14 115 100 0.375-1.090. 0.
X 15 115 100 0.375-1.090. 0.
X 16 115 100 0.375-1.090. 0.
X 17 115 100 0.375-1.090. 0.
C
X 11 115 70.7 0.375-1.090. 45.
X 12 125 141.4 0.375-1.090. 45.
X 13 135 141.4 0.375-1.090. 45.
X 14 145 141.4 0.375-1.090. 45.
X 15 155 141.4 0.375-1.090. 45.
X 16 165 13.7 0.375-1.090. 45.
C
X 11 115 50 0.375-1.090. 90.
X 11 125 100 0.375-1.090. 90.
X 11 135 100 0.375-1.090. 90.
X 11 145 100 0.375-1.090. 90.
X 11 155 100 0.375-1.090. 90.
X 11 165 100 0.375-1.090. 90.
X 11 175 100 0.375-1.090. 90.
The following example illustrates the use of the range of layers option.
Example 10:
FPERF
WELL L
1 1 -6
2 4 -5
3-94 Well Data R5000.0.1

3 2
X 3
X 5
4 1 NZ
5 3 NZ
6 2
The following example illustrates the use of the permeability-thickness multiplier.
Example 11:
FPERF
WELL L KH
1 2 *2.
X 3 1000.
X 4 *0.5
3.2.3 Describe Well Perforations, VIP-DUAL (FPERF)

The DUAL option allows additional data on the FPERF card. The three basic
formats still apply. In the basic formats, the additional "other headings" which
apply to DUAL may identify data affecting relative permeability endpoints
(SWLF, SWMNF, SWROF, SWMXF, SGLF, SGMNF, SGROF, SGMXF, ISATF,
ISATIF), weighting factors used to interpolate between rock and vertical
equilibrium relative permeability (FVEWF, FVEGF), a fraction used to allocate
the total permeability or permeability-thickness between the matrix and fracture
(FM), and a rate dependent skin factor for non-Darcy gas flow (WDLF). Each
perforation defined by the user will generate two perforations, one for the matrix
and one for the fracture, depending on the value of FM. (see note)
These data can be used in conjunction with any of the other FPERF data. Any
restrictions are noted within the definitions.
Definitions:
SWLF Column heading for swlf, the connate water saturation to

be used in denormalizing fracture water relative
gridblock’s value. SWMNF and SWROF must also be
specified.
SWMNF Column heading for swmnf, the residual water saturation

to be used in denormalizing fracture water relative
gridblock’s value. SWROF must also be specified.
SWROF Column heading for swrof, the water saturation at

residual oil to water, to be used in denormalizing fracture
water relative permeabilities for this perforation. Default
is the gridblock’s value. SWMNF must also be specified.
R5000.0.1 Well Data 3-95

SWMXF Column heading for swmxf, the maximum water

saturation to be used in denormalizing fracture water
relative permeabilities for this perforation. Default is 1.
SWMNF and SWROF must also be specified.
SGLF Column heading for sglf, the connate gas saturation to be

used in denormalizing fracture gas relative permeabilities
SGMNF and SGROF must also be specified.
SGMNF Column heading for sgmnf, the residual gas saturation to

be used in denormalizing fracture gas relative
gridblock’s value. SGROF must also be specified.
SGROF Column heading for sgrof, the gas saturation at residual

oil to gas, to be used in denormalizing fracture gas
relative permeabilities for this perforation. Default is the
gridblock’s value. SGMNF must also be specified.
SGMXF Column heading for sgmxf, the maximum gas saturation

to be used in denormalizing gas relative permeabilities
for this perforation. Default is 1-swlf. SGMNF and
SGROF must also be specified.
ISATF Column heading for isatf, the saturation table to be used

in calculating fracture relative permeabilities. Default is
the gridblock’s rock type.
ISATIF Column heading for isatif, the imbibition saturation table

to be used in calculating fracture relative permeabilities.
Default is the gridblock’s rock type.
ICMTF Column heading for icmtf, the compaction table to be

used in calculating fracture effective pore volume.
Default is the gridblock’s compaction table. The
TAMULT column of multipliers will be used for vertical
wells; the TVMULT column of multipliers (set equal to
TAMULT if not entered) will be used for horizontal/
inclined wells.
IWIMF Column heading for iwimf, the WI multiplier table to be

used in calculating the fracture effective perforation well
index. Entering this data causes the table lookups for this
well to be by perforation. If not entered, or if a
subsequent WIMUWL (Section 3.19.1) value is entered
for this well, the table lookup will be for the well as a
whole. Perforation data only applies to WI multiplier
tables with one of the cumulative reservoir production
options.
3-96 Well Data R5000.0.1

FVEWF Column heading for fvewf, the weighting factor used to

permeabilities in the fracture network for water-oil
systems. A value of 1.0 is full vertical equilibrium.
Default is the gridblock’s value.
FVEGF Column heading for fvegf, the weighting factor used to

permeabilities in the fracture network for gas-oil systems.
A value of 1.0 is full vertical equilibrium. Default is the
FM Column heading for fm, the fraction of the total k or kh

contributed by the matrix. This data is entered only in
conjunction with the dual-porosity option. Default value
is calculated as the ratio KX/(KX+KXF), where KX is
the matrix x direction permeability and KXF is the
fracture x direction permeability for the block being
perforated.
WDLF Column heading for wdlf, the rate dependent skin factor
for non-Darcy gas flow in the fracture network.
NOTE: Single permeability option will remove perforations from the matrix, and
only perforate the fractures.
Example 1:
FPERF
WELL L H K FM
17 4 12 1750 .02
X 5 7 1200 0
In this example the perforated intervals are defined for Well 17. It is completed in
layers 4 and 5 of a fractured reservoir (FM option is used). The lengths of the
perforated intervals are 12 and 7 feet, respectively, and the average permeabilities
of the intervals are 1750 and 1200 md, respectively. In Layer 4, 98% of the
production comes from the fracture system and 2% comes from the matrix. In
Layer 5, all of the production comes from the fracture system. (Only three
perforations would be generated from this data.)
3.2.4 Set Status of Well Perforations (PRFSTAT)

The PRFSTAT card is used to set the status of (previously defined) perforations of
wells. The user may define subsets of perforations or all the perforations in a well.
PRFSTAT
WELL STAT (L IW JW GRID UNIT)
R5000.0.1 Well Data 3-97

Perforation data cards
Definitions:
WELL Column heading for nw, the well number or well name.
The well number or name must be entered for each data
card and must be the first parameter. For multiple
completions in a single well, the alpha label X can be
substituted for the well number or well name on each
data card after the first.
STAT Column heading for stat, the perforation status indicator.

Value is ON or OFF. This parameter must be entered.
L Column heading for l, the layer number to which this

status change is restricted. A single number or range of
values may be entered. The format for the range of values
is i1 -i2, where i1≤i2, or i1 NZ. The last format results in
perforations in all layers between layer i1, and the last
layer in the appropriate grid, inclusive.
IW Column heading for iw, the x(r) direction gridblock index

to which this status change is restricted.
JW Column heading for jw, the y( Θ ) direction gridblock

index to which this status change is restricted.
GRID Column heading for the grid name to which this status
change is restricted.
UNIT Column heading for unit, the perforation unit number to

which this status change is restricted.
NOTE: The WELL parameter must be first. The remaining parameters may be in
any order. The parameter STAT is required.
For all parameters except WELL and STAT, the character * may be
entered to denote that the status change should not be restricted by this
parameter.
For parameters L, IW, and JW, if a grid name is not entered under the
parameter GRID, the data will be presumed to apply to the grid of the first
perforation of the well. If a grid name is entered, the data will apply to that
grid.
3-98 Well Data R5000.0.1

3.2.5 Well Perforation Tolerances (PERFPT)
PERFPT khmin (rkhmin pvmin rpvmin)
Definitions:
khmin Minimum KH value in well perforations, md-ft (md-m).

The perforation status is set to OFF if the KH value in the
perforation is less than khmin. Default is 0.
rkhmin Minimum relative KH value in well perforations, fraction.

The status of a perforation in a well is set to OFF if the ratio
of the KH value in this perforation to the maximum KH
value in well active perforations is less than rkhmin. Default
is 0.
pvmin Minimum pore volume in gridblocks with well perforations,

ft**3 (m**3). The perforation status is set to OFF if the
pore volume of the perforation gridblock is less than pvmin.
Default is 0.
rpvmin Minimum relative pore volume value in gridblocks with

well perforations, fraction. The status of a perforation in a
well is set to OFF if the ratio of the gridblock pore volume
in this perforation to the maximum grid block pore volume
in well active perforations is less than rpvmin. Default is 0.
Example:
PERFPT 20 0.01 0 0.001
R5000.0.1 Well Data 3-99

3.2.6 Inclined and Horizontal Well Flow Correlation (BEGGS)

The BEGGS card is used to specify the correlation to be used for inclined
producers.
BEGGS ON surf
OFF
Definitions:
ON The Beggs and Brill correlation will be used for inclined

producers. Haaland’s correlation will be used for inclined
injectors.
OFF Haaland’s single phase equation will be used for

producers. This is the default.
surf Liquid surface tension, dynes/cm.
NOTE: If the BEGGS keyword is not input, Haaland’s correlation will be used for
all wells.
Example:
BEGGS ON 0.121
3.2.7 Wellbore Friction Pressure Loss (NOFRICTION)
NOFRICTION
Definition:
NOFRICTION Alpha label indicating that the friction kinematic pressure

loss will be neglected from the horizontal well pressure
loss computation.
NOTE: This option is applicable only to the Horizontal and Inclined well option.
When the keyword NOFRICTION is absent, the horizontal and inclined
well option computes frictional pressures losses (kinematic and
hydrostatic). Note that the hydrostatic pressure loss is always computed.
3-100 Well Data R5000.0.1

3.3 Surface Separation Data

This section does not apply to the VIP-THERM Dead Oil Model.
The surface separation data includes the definition of the set of pressure and
temperature conditions through which a produced fluid will be passed. Also
defined are the destinations of the product from each stage of the separation
process.
3.3.1 Compositional Separator Battery, VIP-COMP or VIP-THERM

(SEPARATOR)
Each separator battery may contain an arbitrary number of stages. Each stage
contains one feed stream and two output streams: vapor and liquid. Each of the
two output streams can itself be split into two streams, each of which may be fed
to (1) any downstream separator stage, (2) the gas sales line or (3) the oil sales
line.
SEPARATOR ibat
(PVTTABLE ipvt)
(1) STAGE TEMP PRES VFRAC VDEST LFRAC LDEST
(2) n tn pn vfn1 vdn1 lfn1 ldn1
(3) X X X vfn2 vdn2 lfn2 ldn2
(Type 2 and 3 Data Cards are repeated as necessary to define all
the stages of separation.)
Definitions:
ibat List of separator battery numbers.
ipvt EOS table number used for separator calculations (VIP-

COMP only). If the particular EOS table has EOSSEP
data, the EOSSEP parameters will be used for the
calculations. If the PVTTABLE number is not input,
EOS table 1 will be assumed.
n Separator stage number. Values range from 1 to the total

number of stages.
tn Operating temperature of separator stage n, °F (°C).
pn Operating pressure of separator stage n, psia (kPa).
vfn1 Fraction of the vapor stream leaving separator stage n to

be sent to the destination indicated by vdn1. Values must
lie in the range 0-1. If vfn1 is less than 1.0, then one type
2 data card must be provided for this stage so that vfn1
and vfn2 sum to 1.0.
R5000.0.1 Well Data 3-101

vdn1 Destination of the first vapor stream leaving stage n.

Alternatives include a downstream separator stage, the
gas sales line, and vent.
⎧ m ( m is a stage number )
⎪
vd n1 = ⎨ GAS ( alpha label )
⎪
⎩ VENT ( alpha label )
lfn1 Fraction of the liquid stream leaving separator stage n to

be sent to the destination indicated by ldn1. Values must
lie in the range 0-1. If lfn1 is less than 1.0, then one type 2
data card must be provided for this stage so that lfn1 and
lfn2 sum to 1.0.
ldn1 Destination of the first liquid stream leaving stage n.

Alternatives include a downstream separator stage and
the oil sales line.
ld n1 = ⎨
⎩ OIL ( alpha label )
X Alpha label that must be entered in the first three

locations on the type 2 data card.

be sent to the destination indicated by vdn2. The values
of vfn1 and vfn2 must sum to exactly 1.0.
vdn2 Destination of the second vapor stream leaving stage n.

the gas sales line.

be sent to the destination indicated by ldn2. The values of
lfn1 and lfn2 must sum to exactly 1.0.
ldn2 Destination of the second liquid stream leaving stage n.

the oil sales line.
NOTE: 1. Stock tank conditions should be entered as the last stage of separation
in order to obtain the stock tank liquid volume.
2. The user may optionally enter surface separator equation of state parameters. Because
Ωa and Ωb parameters, binary coefficients, and volume shift factors
at reservoir conditions are sometimes not adequate for describing
fluid behavior during surface separations, an option to change these
parameters is provided. If entered, these data must immediately
3-102 Well Data R5000.0.1

follow the data for the last stage of the separator battery to which they
apply. The user may override the data for any or all stages for a
battery.
3. Surface separator equation-of-state parameters cannot be entered without entering all

of the separator data, and default values are calculated from reservoir
values considering temperature dependency (see Coats, SPE 10512).
4. The default separator is single stage at standard temperature and pressure. A vapor
fraction of 1.0 is assigned the destination GAS (gas sales line) and a
liquid fraction of 1.0 is assigned the destination OIL (oil sales line).
5. Both the default and the input separators can be accessed for surface volume
calculations by means of the REGSEP card.
OMEGAS istg
Ωai . . . Ωanc
OMEGBS istg
Ωbi . . . Ωbnc
(DJKSEPcmpj istg
cmpk djk
. .
. .)
ENDSEP
(VSHFTSistg
vshftsi ... vshftsnc)
Definitions:
OMEGAS Alpha label indicating that surface separator Ωa values

will be entered.
OMEGBS Alpha label indicating that surface separator Ωb values

will be entered.
istg Separator stage in the current battery to which the

equation-of-state parameters apply.
Ωai Values of Ωa for each hydrocarbon component.
Ωbi Values of Ωb for each hydrocarbon component.
DJKSEP Alpha label indicating that optional surface separator

binary interaction coefficients will be entered.
cmpj Component name of the first component in a binary

mixture.
cmpk Component name of the second component in a binary

mixture.
R5000.0.1 Well Data 3-103

djk The binary interaction coefficient for mixtures of

component j and component k.
VSHFTS Alpha label indicating that optional surface separator

volume shift factors will be entered.
vshftsi Surface separator volume shift factor for component i at

stage istg.
Example:
C=======================================
C COMPOSITIONAL SEPARATOR BATTERY
C=======================================
SEPARATOR 1
STAGETEMPPRES VFRACVDESTLFRAC LDEST
1 100.0 665.0 1.GAS 1. 2
2 132.0 100.0 1.GAS 1. 3
3 126.0 40.0 1.GAS 1. 4
4 149.0 15.0 1.GAS 1. 5
5 60.0 14.7 1.GAS 1. OIL
3.3.2 Black-Oil Separator Battery, VIP-ENCORE (SEPARATOR)

The default separator is described in Section 4.7.1 of the VIP-CORE Reference
Manual.
Separator data may be entered in VIP-CORE and/or the simulation modules.

Separator batteries in addition to those defined in VIP-CORE may be input, and
those defined in VIP-CORE may be redefined. This last statement is not true
when the PVT interpolation option is in use; separator data may not be input in the
simulation modules.
When "black oil" type problems are run in VIP-ENCORE, the PVT data is
converted into a multicomponent format, including the use of K-values and z-
factors to calculate the phase behavior and volumetric behavior of both oil and
gas. This treatment makes it possible for separator conditions to be exactly
modeled, while using differential expansion data to describe fluid behavior in the
reservoir. This eliminates the conflict between differential and flash volumetrics
that creates difficulty for conventional black-oil simulators.
Some of the options for separator data input given in Section 4.7.1 in the reference
manual for VIP-CORE are not yet available in the simulation modules. If data for
one of these options is available, the option should be used in VIP-CORE.
Separator input data include the following:
1. Definition of the separator configuration. This includes the number of stages,

the destinations of the two outflow streams leaving each stage, and the
fraction of each outflow stream that flows to each destination.
3-104 Well Data R5000.0.1

2. The density of the oil product (stock tank oil) leaving the last separator stage.
3. The molecular weight of the stock tank oil. Since the separator data should
correspond to a fluid described in one of the PVT tables, a liquid molecular
weight should not be input. Molecular weight can and will be calculated from
the input K-values and the differential liberation data.
4. The equilibrium K-values for each component in the system for each stage of
separation. The use of K-values derived from the last step in the differential
liberation experiment can lead to large errors in surface volume calculations
(for reasons discussed below). This option should only be used when accurate
separator K-values and liquid density are known.
One must take great care to insure that the input K-values are consistent with the
internally defined component molecular weights, which are printed out in the
Default Separator Properties Table in VIP-CORE.
SEPARATOR ibat
STAGE VFRAC VDEST LFRAC LDEST (label card)
n vfn1 vdn1 lfn1 ldn1 (type 1 data card)
X vfn2 vdn2 lfn2 ldn2 (type 2 data card)
(Type 1 and 2 data cards are repeated as necessary to
define all of the stages of separation.)
DLIQ MWL (label card)
dliq mwl (type 3 data card)
KVALUES (label card)
COMP STAGE 1 (STAGE 2. . .STAGE n) (label card)
comp kval1 (kval2 . . . kvaln) (type 4 data card)
(Enter one of these cards for each component in the fluid system.)
Definitions:

number of stages.


⎪
⎪
lfn1 Fraction of the liquid stream leaving separator stage n
will be sent to the destination indicated by ldn1. Values
R5000.0.1 Well Data 3-105

must lie in the range 0-1. If lfn1 is less than 1.0, then one
type 2 data card must be provided for this stage, so that
lfn1 and lfn2 sum to 1.0.

the oil sales line.
ld n1 = ⎨
X Alpha label that must be entered in the first location on
the type 2 data card.


the gas sales line.

lfn1 and lfn2 must sum to exactly 1.0.

the oil sales line.
dliq Density of the oil product (stock tank oil) leaving the last
separator stage, gm/cc (gm/cc).
mwl Molecular weight of the stock tank oil.
comp Component name (or number).
kvali Equilibrium K-value for this component for stage i.
3-106 Well Data R5000.0.1

3.3.3 K-Value Separation Data, VIP-ENCORE (SEPARATOR)
SEPARATOR ibat
STAGE VFRAC VDEST LFRAC LDEST (label card)
n vfn1 vdn1 lfn1 ldn1 (type 1 data card)
X vfn2 vdn2 lfn2 ldn2 (type 2 data card)
(Type 1 and 2 data cards are repeated as necessary to
define all of the stages of separation.)
DLIQ MWL (label card)
dliq mwl (type 3 data card)
KVALUES (label card)
COMP STAGE 1 (STAGE 2. . .STAGE n) (label card)
comp kval1 (kval2 . . . kvaln) (type 4 data card)
(Enter one of these cards for each component in the fluid system.)
Definitions:

number of stages.


⎪
⎪

be sent to the destination indicated by ldn1. Values must
lie in the range 0-1. If lfn1 is less than 1.0, then one type 2
data card must be provided for this stage so that lfn1 and
lfn2 sum to 1.0.

the oil sales line.
ld n1 = ⎨
R5000.0.1 Well Data 3-107

X Alpha label that must be entered in the first location on

the type 2 data card.


the gas sales line.

lfnl and lfn2 must sum to exactly 1.0.

the oil sales line.
dliq Density of the oil product (stock tank oil) leaving the last
separator stage, gm/cc (gm/cc).
mwl Molecular weight of the stock tank oil.
comp Component number.
kvali Equilibrium K-value for this component for stage i.
NOTE: Each separator battery may contain any number of stages. Each stage
contains one feed stream and two output streams: vapor and liquid. Each
of the two output streams can itself be split into two streams, each of
which may be fed to; any downstream separator stage, the gas sales line
(GAS) or the oil sales line (OIL).
Separator data may be entered in VIP-CORE and/or the simulation

modules. Separator batteries in addition to those defined in VIP-CORE
may be input, and those defined in VIP-CORE may be redefined. This last
statement is not true when the PVT interpolation option is in use; separator
data may not be input in the simulation modules.
The equilibrium K-values for each component in the system for each stage
of separation. The use of K-values derived from the last step in the
differential liberation experiment can lead to large errors in surface
volume calculations (for reasons discussed below). This option should
only be used when accurate separator K-values and liquid density are
known. When using this option, one must take great care to insure that the
input K-values are consistent with the internally defined component
molecular weights, which are printed out in the default separator
properties table.
DEFAULT SEPARATOR
3-108 Well Data R5000.0.1

The default separator is single stage at standard temperature and pressure.

A vapor fraction of 1.0 is assigned the destination GAS (gas sales line)
and a liquid fraction of 1.0 is assigned the destination OIL (oil sales line).
Both the default and the input separators can be accessed for surface
volume calculations by means of the REGSEP Card.
Default separator K-values are derived in one of two ways depending on

whether or not saturated oil mole fractions at the initial saturation pressure
are input in the K-value PVT tabular data. If these mole fractions are not
input, default K-values are equal to those in the last entry of the KVTAB
table (at standard pressure). This may cause large errors in surface
volumes if the default separator is used for separation, since these K-
values correspond to the last step in the laboratory differential liberation
experiment in which a relatively large fraction of the heavy components is
vaporized. If saturated oil mole fractions at the initial saturation pressure
are input, this fluid is flashed stepwise through the KVTAB data
(corresponding to the differential liberation test) to standard pressure
using the input K-values in the table. Default separator K-values are then
calculated based on the composition of the total gas liberated between the
initial saturation pressure and standard pressure, and the composition of
the oil at standard pressure.
The default separator oil z-factor is determined by one of several methods

which depends on whether or not residual oil z-factor, density, or API
gravity is input in the K-value PVT tabular data. If none of these residual
oil properties is input, the default separator oil z-factor is given by the oil
z-factor in the last entry of the table (at standard pressure) corrected for
temperature. Since this neglects oil density variation between reservoir
and standard temperature, error in oil surface volume will result. If a
residual oil z-factor is input, this is the default separator value. If residual
oil density or API gravity is input, in which case oil composition at the
initial saturation pressure must also be input, the residual oil composition
obtained for the stepwise flash to derive default separator K-values (as
described above) is used to calculate a residual oil molecular weight. The
default separator oil z-factor is then calculated from this molecular weight
and the input residual oil density or API gravity.
Examples:
C=============================================
C BLACK-OIL AND K-VALUE SINGLE STAGE
SEPARATOR
C
=============================================
SEPARATOR 1
STAGE VFRAC VDEST LFRAC LDEST
1 1. GAS 1. OIL
DLIQ MWL
0.8966 200
C
R5000.0.1 Well Data 3-109

KVALUES
COMPSTAGE 1
1 89.4
2 0.0056
3.3.4 Gas Plant Data Input (GASPLANT) (Not available in VIP-THERM)
GASPLANT
NKEY ikey ibat
KEYCMP
vkcmp1 vkcmp2 ... vkcmpj ... vkcmpNI
(enter number of KEY component plus composition values for
interpolation. j=1 to number of interpolation points, NI)
PLNTRY
pr1,1 pr1,2 ... pr1,j ... pr1,NI
pr2,1 pr2,2 ... pr2,j ... pr2,NI
. . . .
. . . .
pri,1 pri,2 ... pri,j ... pri,NI
. . .
prNC,1 prNC,2 ... prNC,j ... prNC,NI
(enter the plant liquid molar recovery fractions for each
interpolation point, j=1 to number of interpolation values, NI and
repeat for all components, i=1 to the number of components, NC)
Definitions:
NKEY Alpha label indicating that the key component plus

fraction number and battery are to be read. The cards
KEYCMP and PLNTRY defined below should follow
the NKEY card, as all values correspond to ibat, the
battery defined on this card.
ikey The number of the key component plus fraction to be

used in the liquid recovery fraction table look up. The
sum of the well stream over all mole fraction from the
key component plus all the following components are
used in the table look up of component liquid recovery
values.
ibat The battery number of the Gas Plant.
KEYCMP Alpha label indicating the key component plus over all
mole fractions are to be entered. These are the sum of key
component plus mole fractions that are to be used in the
liquid recovery fraction table look up. The key
component plus fraction is used for ibat, the battery
defined on the NKEY card.
3-110 Well Data R5000.0.1

vkcmp The value of the sum of key component plus fraction to

be used as an interpolation value. There are NI number of
interpolation point values to be read. They should be on
one card and should cover the range of sums that are to
be expected in the run. The range of values on this card
should be between 0. and 1. NI is determined by the
number of values read on the card.
PLNTRY Alpha label indicating that the separate liquid recovery

fractions will be entered. The liquid recovery fraction is
the molar fraction of the component that will be
separated to the liquid stream. The plant recovery values
are for ibat, the battery that was defined on the NKEY
card.
pr The fraction of the component that will be separated to

the liquid stream in the Gas Plant. The liquid recovery
fractions are entered for each component as a function of
the key component plus mole fraction and one value must
be entered for NI points and for each component. The
data must be ordered so that the liquid recovery fractions
should be entered for component 1 for all values of key
component plus fraction interpolation points (NI). The
next card is for component 2 recovery fractions at NI
points. This continues until all component values have
been read. In all there should be (NI * NC) values read.
The values must be between 0. and 1.
NOTE: Input to a gas plant is the total well stream, while output is determined by
the molar liquid recovery fractions. There are no surface flash calculations
as are carried out with a normal surface separator.
A gasplant can be entered in VIP-CORE and/or the simulation modules.

Surface batteries in addition to those defined in VIP-CORE may be input,
and those defined in VIP-CORE can be redefined in the simulation
modules.
The user may optionally enter the surface separator equation-of-state

parameters. These parameters will be used for the stock tank density
calculations to obtain the surface rates. The new equation-of-state
parameters must follow the last stage of the battery to which they apply.
The values of the separator equation-of-state parameters will default to the
reservoir values if not given.
Examples:
C=========================================
C GAS PLANT SURFACE SEPARATOR
C =========================================
GASPLANT
R5000.0.1 Well Data 3-111

NKEY 6 1
KEYCMP
C DEFINE KEY COMPONENT PLUS FRACTIONS (NC = 6 TO 8)
C NUMBER OF INTERPOLATION POINTS (NI= 11)
.9999 .108 .104 .098 .075 .065 .047 .028 .018 .010 .000
PLNTRY
C DEFINE COMPONENT LIQUID RECOVERIES (NI = 11, NC =8)
.0240 .0240 .0240 .0220 .0170 .0140 .0100 .0050 .0030 .0020 .0020
.0070 .0070 .0070 .0060 .0050 .0040 .0030 .0010 .0010 .0000 .0000
.0610 .0610 .0590 .0560 .0430 .0370 .0270 .0140 .0090 .0060 .0060
.1790 .1790 .1750 .1690 .1370 .1220 .0920 .0550 .0400 .0290 .0290
.4680 .4680 .4640 .4530 .4000 .3710 .3050 .2200 .1770 .1480 .1480
.9960 .9960 .9960 .9960 .9940 .9930 .9890 .9790 .9690 .9590 .9590
1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000
1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000
3.3.5 Separator Switching (NEWSEP)

The NEWSEP card allows the user to assign separator batteries to a well as a
function of either the flowing bottomhole pressure of the well or the tubinghead
pressure of the well.
NEWSEP ⎛ BHP⎞ wl
⎝ THP⎠
l1 l2 . . . ln
h1 h 2. . . hn
p1 p 2. . . pn
Definitions:
BHP Alpha label indicating that the assigning of separator

batteries is based on the flowing bottomhole pressure of
the well. This is the default.
THP Alpha label indicating that the assigning of separator

batteries is based on the tubinghead pressure of the well.
wl List of well numbers for which l, h, and p values are

being entered (see Section 1.5.2).
l Separator battery number for low pressure.
h Separator battery number for high pressure.
p Bottomhole/tubinghead pressure, psia (kPa).
NOTE: 1. If flowing bottomhole pressure/tubinghead pressure is less than pi for

welli, separator battery li will be used. If flowing bottomhole
3-112 Well Data R5000.0.1

pressure/tubinghead pressure is greater than or equal to pi, separator

battery hi will be used.
2. If it is desired to use one of the default separators defined by VIP-CORE,

then l or h should be set to -npvt, where npvt is a PVT table number
(VIP-ENCORE) or 1 (VIP-COMP).
3. The THP option on the NEWSEP card may not be used for a well unless a
tubinghead pressure constraint (THP card) is specified for that well.
3.3.6 Surface Facility Model Input (TSFM)
gas
gas rate
gas
plant
gas
separator
battery gas
oil
oil
stabilizer
H/C/well stream
oil
stock
oil rate tank
Hydrocarbon component recovery factors are specified for the oil stabilizer and
gas plant units (moles of component i recovered as oil/mole component i in feed).
The component molar rates from the gas plant are converted to surface volumetric
rates using specified component molar densities (LB mole/ft3).
The well gas rate is defined at the gas inlet to the gas plant. The default well oil
rate is at the oil outlet of the oil stabilizer. However, if the keyword ADDNGL is
specified on the TSFM card, the well oil rate is redefined as the sum of the oil
from the oil stabilizer plus the natural gas liquids (“oil”) from the gas plant. All
well and group constraints apply at these points, unless the keyword DRYTRG is
specified on the TSFM card. If so, the gas group constraints apply to the gas
leaving the gas plant (after liquids have been stripped).
Gas reinjection options apply to gas produced from the gas plant.
Stream rates, cumulatives, and compositions are reported in the TSFM Surface
Facility Model Report. Output is controlled by the PRINT WELLS card.
R5000.0.1 Well Data 3-113

Information on streams leaving the separator battery or on separator stage streams

is obtained from the SEPARATOR report.
TSFM (ADDNGL)(DRYTRG)
rfs1 rfs2 ... rfsnc
rfp1 rfp2 ... rfpnc
denp1 denp2 ... denpnc
Definitions:
TSFM Alpha label which turns on the Surface Facility Model.
ADDNGL Alpha label which redefines the well oil rate as the sum
of the oil from the oil stabilizer plus the natural gas
liquids (“oil”) from the gas plant. The default well oil
rate is only the oil from the oil stabilizer. This will affect
all well group constraints with respect to oil rate.
DRYTRG Alpha label indicating that gas targets apply to gas

leaving the gas plant (after liquids have been stripped).
The default is for the gas targets to apply to gas entering
the gas plant (before liquids have been stripped).
rfsi Hydrocarbon component recovery factors for the oil

stabilizer, moles of i produced as oil/mole of i in feed.
rfpi Hydrocarbon component recovery factors for the gas

plant, moles of i produced as oil/mole of i in feed.
denpi Hydrocarbon component molar densities used to convert

gas plant oil product stream rate to surface volumetric
rate, LB moles/ft3.
NOTE: Usage of the TSFM option will change the oil in place calculations for the
REGION summary report, based on the possibility that the separators
defined do not yield proper stock tank volumes without the inclusion of
the oil stabilizer. (i.e., the separators defined are only the high pressure or
low pressure separators, and by themselves do not yield correct stock tank
volumes.)
3.4 Well Type

Each well must be identified as either a production well or an injection well. The
PROD, INJ, and WAG cards are used for this purpose. These cards also allow the
user to identify the primary fluid being produced/injected at a rate specified on
either the QMAX card or the QMULT card. For producers, other fluids may be
produced in conjunction with the primary fluid based upon mobility.
3-114 Well Data R5000.0.1

If a minimum rate constraint is imposed on a well by means of a QMIN card, the

fluid phase used in determining that constraint is defined by the ECOLIM card.
In VIP-EXECUTIVE, the fluid production (injection) of a well may be

constrained at five levels: the individual well level, the gathering center level, the
flow station level, the area level, and the field level. Multiple constraints may be
imposed at each level. For example, at the well level, oil production may be
limited by minimum and maximum rates, water cut, GOR, and bottomhole
pressure. All of these constraints may be imposed simultaneously. At the
gathering center level, production targets can be allocated back to individual
wells. At the highest level, field-wide targets can be imposed. The well constraint
hierarchy is described in detail in Section 3.4, 3.5, and 3.6.
3.4.1 Production Well Definition (PROD)

A PROD card must precede a QMAX or QMULT card for producers.
A PROD card is required for production wells to define the production phase and
units being used for data on the QMAX (maximum well rate) card or the QMULT
(multiple rate) card.
W ⎛ STD ⎞
PROD ⎜ ⎟ wl
O ⎜ RES ⎟
G ⎝ MOLES ⎠
ALL
LIQUID
MULTRT
Definitions:
Alpha label indicating the type of maximum production rate specified on the
QMAX card or the QMULT card. Valid labels for fluid production rate are:
W Water.
O Oil.
G Gas.
ALL All fluid components combined.
LIQUID Total liquid (oil plus water).
MULTRT Alpha label indicating the rate defined by the QMULT

card is specified separately for each fluid phase. Rates are
specified in STB/D (STM3/D) for water and oil, and
MSCF/D (SM3/D) for gas. The separate rates are
converted internally to reservoir barrel equivalents and
summed to obtain a total reservoir barrel rate for all fluid
R5000.0.1 Well Data 3-115

phases combined. This conversion occurs at the start of

each timestep. Rates for this type of well must be
specified with a QMULT card.
Alpha label indicating units type:
STD Standard conditions. STB/D (STM3/D) for water, oil, or

liquid. MSCF/D (SM3/D) for gas. Not permitted for
ALL.
RES Reservoir conditions, rb/D (m3/D).
MOLES Lb-moles/D (lb-moles/D). Only permitted for ALL.
wl List of all production wells with rates specified in this

manner (see Section 1.5.2).
NOTE: 1. One and only one of the labels W, O, G, ALL, LIQUID or MULTRT
must be specified. There is no default. Timestep convergence may be
slowed by use of the ALL or MULTRT options.
2. If no units type is specified, the default is STD except for ALL. The
default for ALL is RES.
3. When an injection well is converted to a production well, and if the

injector’s bhp value is the default value 10,000 psia, then the bhp
value will be changed to 0 psia. Otherwise, previously input BHP or
THP data will be maintained.
4. Specifying a PROD card for a shut-in well will cause the well to be
"turned back on".
5. The QMULT card may be used to input rates for the well types, W, O, G,
or LIQUID. The appropriate rate(s) are taken from QMULT data,
ignoring the remaining rates. For example, for a LIQUID producer
the oil and water rates will be summed to get the maximum well rate.
The gas rate will not be used.
Example:
C
PROD ALL 1 -364 390 -428 438 -507 514 -538
C
or
C***************************************************
C DEFINE WELL CHARACTERISTICS
C***************************************************
PROD LIQUID STD 2 -14 18 22 24 -37 41
3-116 Well Data R5000.0.1

3.4.2 Injection Well Definition (INJ)

An INJ card must precede a QMAX card for injectors.
An INJ card is required for injection wells to define the injected phase and units
being used for data on the QMAX (maximum well rate) card.
⎛ STD ⎞ ⎛ GATHER ⎞
⎜ ⎟ ⎜ ⎟
INJ W ⎜ RES ⎟ ⎜ FLOSTA ⎟ ⎛ KEYCMP⎞ wl
⎜ FSTD ⎟⎟ ⎜ AREA ⎟ ⎝ MI ⎠
G ⎜ ⎜ ⎟
⎝ FRES ⎠ ⎝ FIELD ⎠
Definitions:
Alpha label indicating the maximum injection rate specified on the QMAX
card is based on:
W Water (Water and steam in VIP-THERM).
G Gas.
STD Standard conditions, STB/D (STM3/D) for water

injectors, MSCF/D (SM3/D) for gas injectors. This is the
default.
FSTD A fraction of the total surface production rate of the

injected phase (see note below) within a specified level
of the well management hierarchy (see below). Note that
some options (for example, the UNIFORM gas injection
option ) change the definition of FSTD.
FRES A fraction of the total fluid withdrawal (at reservoir

conditions) within a specified level of the well
management hierarchy (see below). Note that some
options (for example, the injection region option) change
the definition of FRES.
When FSTD or FRES is specified, the level in the well management hierarchy
upon which replacement is based may be specified. The well management
level may also be specified for MI injectors with STD or RES specification to
identify the level upon which the MI composition determined from the MI
plant in the major gas sales option is to be used for the injection composition.
In this case, YINJ cards for MI injectors should be omitted and the MI plant
R5000.0.1 Well Data 3-117

calculation for the selected well management level must be invoked (see
PLANT card in Section 4.5). The well management levels are:
GATHER Gathering Center. This is the default for FSTD or FRES

specification.
FLOSTA Flow station.
AREA Area.
FIELD Field. This is the default for STD or RES specification

with MI plant in the major gas sales option.
If a gas conditioning plant in the major gas sales option is present, and
keyword DIST is specified in the GASCOND card, a portion of the FSTD gas
injectors may be assigned to receive the key component (component icomp in
the GASCOND card) removed from the sales gas stream using the following
keyword:
KEYCMP Alpha label indicating that the key component stream

removed from the sales gas in the gas conditioning plant
will be injected into the gas injectors specified in this INJ
card. These gas injectors must be specified as FSTD
injectors and a GASCOND card with keyword DIST
Alternatively, in the four-component miscible (Todd and Longstaff) option the

wells being specified on this card may be identified as MI injectors through
input of alpha label MI. In this case, the wells must be specified as FSTD
injectors and an MI recovery factor must be specified using a RECFAC card
(see Section 4.5.9).
MI Alpha label indicating that the wells being defined are MI

injectors in a four-component miscible model. These
injectors must be specified as FSTD injectors and an MI
recovery factor must be specified using a RECFAC card.
wl List of all injection wells with rates specified in this

NOTE: 1. Either W or G must be specified. There is no default.
2. Optionally, exactly one of the labels STD, RES, FSTD, and FRES may be
specified. If none is specified, STD is the default.
3. Optionally, if either FSTD or FRES is specified, exactly one of the labels

GATHER, FLOSTA, AREA, and FIELD may be specified. If none is
specified, GATHER is the default.
4. Optionally, if either STD or RES is specified and the major gas sales
option (with MI plants) for a well management level is invoked, the
well management level (label GATHER, FLOSTA, AREA, or
3-118 Well Data R5000.0.1

FIELD) may be specified to identify the level upon which the

calculated MI composition from the MI plant is to be used as the
injection composition. In this case, the injection composition (YINJ
card) may be omitted (the input of YINJ card will cause the calculated
MI composition to be ignored). If none is specified, FIELD is the
default.
5. When a production well is converted to an injection well, any previously

input WLIMIT, GLIMIT, or QMIN data will be ignored, and the
ECOLIM unit will be set to the injection phase. Also, if the
producer’s bhp value is the default value 0 psia, then the bhp value
will be changed to 10,000 psia. Otherwise, previously input BHP or
6. Anytime a gas injection well is specified or respecified as either STD or

RES, and the wells are not to be identified as MI wells (with MI plant
in the major gas sales option), the composition of the injected gas
must be defined using the YINJ card.
7. For an FSTD gas injector, the fraction is not of the total gas production but
of the gas available for reinjection. This quantity is a function of gas
production, gas sales, gas makeup, etc.
8. Optionally, if an FSTD gas well is specified and a GASCOND card with

keyword DIST is also present, keyword KEYCMP may be specified.
9. Optionally, if FSTD gas wells are specified and the four-component

miscible option is invoked, keyword MI may be specified to identify
the MI injectors.
10. Specifying an INJ card for a shut-in well will cause the well to be “turned
back on”.
Example:
C
INJ G STD 253 -266 324 -326 365 -381
YINJ 253 -266 324 -326 365 -381
0.9944 0.0056
C
INJ G STD GATHER 1 -10
C
INJ G FSTD FIELD KEYCMP 11 -20
3.4.2.1 Temperature Specification (VIP-THERM)
A TINJ card must be specified for all injection wells in VIP-THERM.
TINJ wl
tinj1 tinj2 . . . tinjn
R5000.0.1 Well Data 3-119

Definitions:
wl List of wells for which the data is being specified (see

Section 1.5.2).
tinj Injection temperature, °F (°C).
3.4.2.2 Steam Quality Specification (VIP-THERM)
QUAL cards must be specified for water/steam injection wells in VIP-

THERM.
QUAL wl
qual1 qual2 . . . qualn
Definitions:
wl List of wells for which the data is being defined (see

Section 1.5.2).
qual Steam quality, mass fraction vapor.
3.4.2.3 Pressure Specification (VIP-THERM)
If a quality of 0.0 or 1.0 is specified for a water/steam injector, then a PINJ

card must be specified for the well.
PINJ wl
pinj1 pinj2 ... pinjn
Definitions:
wl List of wells for which the data are being defined (see
Section 1.5.2).
pinj Injection pressure, psia (kPa).
3.4.2.4 Treatment of Water/Steam Injectors (VIP-THERM)
The equation describing the mass rate of water/steam injection is:

L
∑ [ kh ⋅ λ ⋅ ρ ] ⋅ [ P
o
q = – 0.001127 ⋅ WI l bl – P bh – γ ( D l – D o ) ]
l=1
where
q = H20 injection rate.
3-120 Well Data R5000.0.1

o
P bh = Datum flowing bottomhole pressure.
WI = Well index.
khl = Permeability thickness product for perforation l.
λl = Mobility for perforation l.
ρl = Average density for perforation l.
Pbl = Pressure of gridblock containing perforation l.
γ = Average fluid density over perforated interval of the well.
Dl = Subsea depth of perforation l.
Do = Datum depth.
The rate of energy injection is given by
E=q⋅H
where H is the enthalpy of the injected steam/water mixture which is assumed

constant over the perforated interval and with time. H is calculated from the user
specified values of TINJ, QUAL, and PINJ (if QUAL = 0 or 1).
The average density term ρl is Equation is calculated from phase densities ρwl, ρsl
and quality Ql:
ρ wl ⋅ ρ sl
ρ l = --------------------------------------------
ρ sl + Q l ( ρ wl – ρ gl )
The perforation quality Ql is calculated from enthalpy H and pressure Pl. If Ql is 0

or 1, then the perforation temperature Tl is calculated. Otherwise, Tl is the water
saturation temperature at Pl. Ideally, Pl should be set to P obh – γ ( D l – D o ) ,
which is the pressure in the wellbore opposite perforation l. However, this poses
problems for a fully implicit model, especially since γ is a function of ρl. Hence,
we use Pl = Pbl (pressure of griblock containing perforation l. Phase densities ρwl
and ρsl are evaluated at Pl, Tl.
There are three options for treatment of the mobility term λ in Equation .
Conventionally, λ is taken as the total mobility of the gridblock containing the
perforation:
kro krg krw

λ = -------- + -------- + ---------
μo μg μw
where the relative permeabilities are evaluated at gridblock conditions using the
perforation relative permeability functions and the viscosities are gridblock
values. There are two disadvantages to this method in thermal simulation:
R5000.0.1 Well Data 3-121

1. Extreme nonlinearities are introduced into Equation , mainly through

temperature dependence of the viscosities. Stable timestep size will be
significantly reduced relative to other methods, especially near the initiation
of injection (at low temperatures).
2. If the gridblock is large relative to the drainage radius of the well, the mobility
should be evaluated at near-wellbore conditions rather than at average
gridblock conditions.
The total mobility method is available as an option. In the endpoint method

(default), it is assumed that the formation in the vicinity of the wellbore which
controls injectivity is quickly reduced to some irreducible oil saturation which
depends on Ql. The effect of the saturation changes occurring during this period
on mobility are neglected. Perforation mobilities are given by the volumetric
average of the water mobility at residual oil to water and the steam mobility at
residual oil to gas:
1 – Q l krwrol Q l krgrol
-------------- ----------------- + ------ ----------------
ρ wl μ wl ρ sl μ sl
λ l = ------------------------------------------------------------------
-
1 – Ql Ql
-------------- + ------
ρ wl ρ sl
where relative permeabiliites and phase densities and viscosities are evaluated at
Pl, Tl. The third option is that the perforation mobilities may be (in effect) user-
specified as constant values using the KHWI option on the FPERF card (Section
3.2.2). For injectors, KHWI is defined as:
KHWI l = 0.001127 ⋅ WI ⋅ kh l ⋅ λ l
The WINJMOB card allows the user to select between the first two options.
WINJMOB ENDPOINT
TOTAL
Definitions:
ENDPOINT Alpha label which activates endpoint mobility, Equation

(default).
TOTAL Alpha label which activates total mobilty option,

Equation .
Previous to version 1.8R, the endpoint method was used with the following
differences:
1. Ql in Equation and was set to the user specified value of QUAL.
3-122 Well Data R5000.0.1

2. Phase densities and viscosities in Equation and were evaluated at the user-
specified value of TINJ and the corresponding water saturation pressure.
Simulation results using this method can be reproduced by specification of the

keyword OLDINJ.
OLDINJ
R5000.0.1 Well Data 3-123

3.4.3 Define Additional Injection Rate for FSTD or FRES Wells (INJA)
The INJA card is used to specify an additional injection rate for either FRES or
FSTD wells.
INJA qa wl
Definitions:
qa Additional injection rate for FSTD or FRES wells.
wl List of injection wells for which qa are being specified

(see Section 1.5.2)
NOTE: The unit is determined by the INJ card. If the well specified on the INJ
card is an FRES well, then qa is reservoir rate. If it is an FSTD well, then
qa is surface rate.
The INJA card should be specified after the INJ card.
This option can be used for both the standard reinjection or general
injection option, but this data is ignored when the guide rate voidage
injection option (INJTAR) is used.
If the well is a gas injection well using the standard reinjection option, the
YINJA card can be used to specify the gas composition for the additional
rate.
3.4.4 Computation of Mobility for Gas Injectors (GINJMOB)

The GINJMOB card is used to specify the method to use for computing the
mobility for gas injection wells.
GINJMOB ENDPOINT
TOTAL
Definitions:
ENDPOINT Alpha label indicating that endpoint mobilities will be

used for gas injectors. This is the default.
TOTAL Alpha label indicating that total gridblock mobilities will

be used for gas injectors.
3-124 Well Data R5000.0.1

3.4.5 Computation of Mobility for Water Injectors (WINJMOB)

The WINJMOB card is used to specify the method to use for computing the
mobility for water injection wells.
WINJMOB ENDPOINT
TOTAL
Definitions:
ENDPOINT Alpha label indicating that endpoint mobilities will be

used for water injectors. This is the default.
TOTAL Alpha label indicating that total gridblock mobilities will

be used for water injectors.
3.4.6 Production Rates Outer Iteration Number (ITNSTP)

The ITNSTP card allows the user to specify the outer iteration number after which
production rates will not be recomputed for the remainder of the timestep. The
maximum drawdown constraint option (DPBHMX card) makes use of this
iteration number to fix the bottomhole pressure of a constrained producer for the
remainder of the timestep.
ITNSTP itnstp
Definition:
itnstp Outer iteration number after which production rates will

not be recomputed for the timestep. Default is 99999,
meaning the rates will be computed every outer iteration.
3.4.7 Water Injection Rates Outer Iteration Number (ITNSTQ)

The ITNSTQ card allows the user to specify the outer iteration number after
which water injection rates will not be recomputed for the remainder of the
timestep. The maximum drawdown constraint option (DPBHMX card) makes use
of this iteration number to fix the bottomhole pressure of a constrained injector for
the remainder of the timestep.
Some options, such as the injection region option, require water injection rates to
be recomputed during each outer iteration that their computations are being made.
The actual itnstq value used will be the minimum value needed to satisfy this
requirement and the users input.
R5000.0.1 Well Data 3-125

ITNSTQ itnstq
3-126 Well Data R5000.0.1

Definition:
itnstq Outer iteration number after which water injection rates

will not be recomputed for the timestep. Default is
99999, meaning the rates will be computed for every
outer iteration.
3.4.8 Gas Reinjection Rates Outer Iteration Number (ITNGRE)

The ITNGRE card allows the user to specify the outer iteration number after
which gas reinjection rates will not be recomputed for the remainder of the
timestep.
ITNGRE itngre
Definition:
itngre Outer iteration number after which gas reinjection rates

will not be recomputed for the timestep. Default is -1,
meaning an internal algorithm is used to determine the
number of iterations.
NOTE: 1. The gas reinjection rates are used for FSTD gas injectors and in the
general injection region option (RINJOP INJREG).
2. The default algorithm for computing the value of itngre is
itngre = max(min(itnmax - 3, 3), 1),
where itnmax is the maximum number of outer iterations per timestep

from the ITNLIM card.
R5000.0.1 Well Data 3-127

3.4.9 Change Well Type Class (WLTYCH)

The WLTYCH card is used to immediately change the well type of one class of
wells to another type.
WLTYCH
FROM *
TO *
W
O (STD)
where * =PROD G (RES)
ALL (MOLES)
LIQUID
MULTRT
or
(STD)(GATHER)
INJ W (RES)(FLOSTA)
G (FSTD)(AREA)
(FRES)(FIELD)
Definitions:
Alpha label indicating the type of maximum production rate specified on the
QMAX card or the QMULT card. Valid labels for fluid production rate are:
W Water.
O Oil.
G Gas.
ALL All fluid components combined.
LIQUID Total liquid (oil plus water).
MULTRT Rate for each fluid phase. See PROD card for more
detailed discussion.
STD Standard conditions. STB/D (STM3/D) for water, oil, or

liquid. MSCF/D (SM3/D) for gas. Not permitted for
ALL.
MOLES Lb-moles/D (lb-moles/D). Only permitted for ALL.
3-128 Well Data R5000.0.1

Alpha label indicating the maximum injection rate specified on the QMAX
card is based on:
W Water.
G Gas.
STD Standard conditions, STB/D (STM3/D) for water

injectors, MSCF/D (SM3/D) for gas injectors. This is the
default.
FSTD A fraction of the total surface production rate of the

injected phase within a specified level of the well
management hierarchy (see below).
FRES A fraction of the total fluid withdrawal (at reservoir

conditions) within a specified level of the well
management hierarchy (see below).
upon which replacement is based may be specified. These are:
GATHER Gathering Center. This is the default.
AREA Area.
FIELD Field.
NOTE: 1. At the exact moment in the program that this card is read, all wells of
the type designated by the FROM data will be converted to wells of
the type designated by the TO data.
2. It is up to the user to make sure all well data are consistent with this
switch.
R5000.0.1 Well Data 3-129

3.5 Well Constraints

Each well produces/injects at the maximum rate defined by a QMAX card or a
QMULT card, subject to reduction to honor other applicable constraints.
3.5.1 Maximum Rate (QMAX)

Must be preceded by a PROD or INJ card (Section 3.4.1 and 3.4.2).
The QMAX card defines the maximum rate a well is allowed to produce/inject. A
QMAX card, or a QMULT card, is required for the well to flow.
QMAX wl
qmax1 qmax2 . . . qmaxn
Definitions:
wl List of wells for which qmax values are being specified

qmax Maximum rate at which the well is allowed to produce/

inject. Units are determined by the PROD or INJ card.
Default is zero.
NOTE: 1. The well produces/injects at a rate of qmax unless this causes a

violation of one of the other constraints defined by the user. In this
event, the constraint is observed, which causes a rate reduction.
2. The number of qmax values must equal the number of wells in the well
list.
3. For the FSTD injection option, qmax is the fraction of the total surface
production rate of the injected phase within the appropriate level. For
the FRES injection option, qmax is the fraction of the total reservoir
volume production rate within the appropriate level. Note that certain
options (UNIFORM gas injection, injection region) change the
definitions of FSTD and FRES.
Example:
C
INJ W STD 382 -389 429 -437 508 -513
QMAX 382 -389 429 -437 508 -513

8*10000 9*0 6*10000
3-130 Well Data R5000.0.1

3.5.2 Water Limit - Water Cut, Rate or Liquid-Gas Ratio Constraint (WLIMIT)
This card can be used in conjunction with a TEST card (Section 3.5.13).
The WLIMIT card allows the user to define a maximum water cut, water rate, or
liquid-gas ratio for a production well.
PLUG
WLIMIT SHUTIN (LGR) wl
LIMIT
PLUGPLUS
wmax1 wmax2 . . . wmaxn
(wcut1 wcut2 . . . wcutn)
Definitions:
PLUG Alpha label indicating that the well is automatically

recompleted whenever water cut exceeds wmax. When
the well has just one active perforation, the check is
against wcut instead of wmax. Recompletion consists of
plugging the perforation with the highest water cut. If
there is only one perforation, the well is permanently shut
in. Once a perforation has been plugged, it never
produces/injects again, unless the well is reperforated by
an FPERF card.
SHUTIN Alpha label indicating that the well is automatically shut

in whenever water cut exceeds wmax. It periodically is
tested according to data on the TEST card. If water cut is
found to be less than wmax during a test, the well is
returned to production.
LIMIT Alpha label indicating that the water production rate is

not allowed to exceed wmax, STB/D (STM3/D). The
specified production rate is reduced, if necessary. The
water production limit is rechecked every timestep.
PLUGPLUS Alpha label indicating that when a well is recompleted

with the PLUG option as described above, all
perforations in the list after the plugged one will also be
plugged.
LGR Alpha label indicating that the PLUG and SHUTIN

options apply to liquid-gas ratio instead of water cut. The
LIMIT option is unaffected.
wl List of wells to which these restrictions apply (see

Section 1.5.2).
R5000.0.1 Well Data 3-131

wmax Limiting water cut or water production rate, or liquid-gas

ratio, depending on the option selected.
wcut Limiting water cut or liquid-gas ratio for wells with only
one active perforation. Available only for the PLUG
option. This entire card may be omitted, in which case
the default is wcuti = wmaxi.
NOTE: 1. One and only one of the PLUG, SHUTIN, LIMIT, or PLUGPLUS
labels must be specified.
2. The number of wmax and wcut values must equal the number of wells in
the well list. None of these restrictions is applied to wells not named
on a WLIMIT card.
3. Only the SHUTIN option is affected by the TEST card.
4. WLIMIT data may not be specified for injection wells.
5. Liquid-gas ratios are specified in units of STB/MMSCF (STM3/KSM3).
6. Specifying a WLIMIT card for a shut-in well will cause the well to be
"turned back on".
Example:
TIME 5
C
WLIMIT SHUTIN
1 -252 267 -323 327 -364 390 -428 252*.99 57*.99
38*.99 39*.99
C
3.5.3 Gas Limit - GOR or Rate Constraint (GLIMIT)

The GLIMIT card allows the user to define a maximum gas-oil ratio or gas rate
for a production well.
GOR or Rate Constraint
PLUG
GLIMIT SHUTIN wl
LIMIT
PLUGPLUS
gmax1 gmax2 . . . gmaxn
(gorm1 gorm2 . . . gormn)
Definitions:
3-132 Well Data R5000.0.1


recompleted whenever the producing gas-oil ratio
exceeds gmax, SCF/STB (SM3/STM3). When the well
has just one active perforation, the check is against gorm
instead of gmax. Recompletion consists of plugging the
perforation with the highest gas-oil ratio. If there is only
one perforation, the well is permanently shut-in. Once a
perforation has been plugged, it never produces/injects
again unless the well is reperforated by an FPERF card.

in whenever the producing gas-oil ratio exceeds gmax,
SCF/STB (SM3/STM3). It is tested periodically
according to data on the TEST card. If the gas-oil ratio is
found to be less than gmax during a test, the well is
LIMIT Alpha label indicating that the gas production rate is not
allowed to exceed gmax, MSCF/D (SM3/D). The
specified production rate is reduced, if necessary. The gas
production limit is rechecked every timestep.
PLUGPLUS Alpha label indicating that when a well is recompleted

with the PLUG option as described above, all
perforations in the list before the plugged one will also be
plugged.

Section 1.5.2).
gmax Limiting gas-oil ratio or gas production rate, depending

on the option selected.
gorm Limiting gas-oil ratio for wells with only one active
perforation. Available only for the PLUG option. This
entire card may be omitted, in which case the default is
gormi = gmaxi.
NOTE: 1. One and only one of the PLUG, SHUTIN, LIMIT, or PLUGPLUS
labels must be specified.
2. The number of gmax and gorm values must equal the number of wells in
on a GLIMIT card.
4. GLIMIT data may not be specified for injection wells.
5. Specifying a GLIMIT card for a shut-in well will cause the well to be
"turned back on".
R5000.0.1 Well Data 3-133

3.5.4 Steam Limit - Steam Rate or Steam-Oil Ratio Constraint (SLIMIT) (VIP-
THERM)
The SLIMIT card allows the user to define a maximum steam rate or steam-oil
ratio for a production well.
PLUG
SLIMIT SHUTIN (SOR) wl
smax1 smax2 . . . smaxn
(smaxl1 smaxl2 . . . smaxln)
Definitions:

recompleted whenever steam rate exceeds smax. When
the well has just one active perforation, the check is
against smaxl instead of smax. Recompletion consists of
plugging the perforation with the highest steam rate. If
there is only one perforation, the well is permanently shut
in. Once a perforation has been plugged, it never
produces/injects again, unless the well is reperforated by
an FPERF card.

in whenever the steam rate exceeds smax. It periodically
is tested according to data on the TEST card. If steam
rate is found to be less than smax during a test, the well is
SOR Alpha label indicating that the PLUG and SHUTIN

options apply to steam-oil ratio instead of steam rate.

Section 1.5.2).
smax Limiting steam production rate, STB(CWE)/D

(STM3(CWE)/D),or steam-oil ratio, STB(CWE)/STB
(STM3(CWE)/STM3), depending on the option selected.
smaxl Limiting steam rate or steam-oil ratio for wells with only
one active perforation. Available only for the PLUG
option. This entire card may be omitted, in which case
the default is smaxli = smaxi.
NOTE: 1. One and only one of the PLUG or SMAXL SHUTIN labels must be
specified.
3-134 Well Data R5000.0.1

2. The number of smax and smaxl values must equal the number of wells in
on a WLIMIT card.
4. SLIMIT data may not be specified for injection wells.
5. Steam-oil ratios are specified in units of STB(CWE)/STB (STM3 [CWE]/

STM3). (CWE = cold water equivalent.)
6. Specifying a SLIMIT card for a shut-in well will cause the well to be
"turned back on".
Example:
TIME 5
C
SLIMIT SHUTIN SOR
1 -252 267 -323 327 -364 390 -428 252*.99 57*.99
38*.99 39*.99
C
3.5.5 Economic Limit (ECOLIM)

An ECOLIM card is required to define the units being used for data on the QMIN
(minimum well rate) card.
W
ECOLIM O wl
G
LIQUID
Definitions:
Alpha label indicating the minimum production/injection specified on the

QMIN card is based on:
W Water, STB/D (STM3/D).
O Oil, STB/D (STM3/D).
G Gas, MSCF/D (SM3/D).
LIQUID Liquid, STB/D (STM3/D).
wl List of all wells with minimum rates specified in this

NOTE: 1. The ECOLIM card is used for both producers and injectors. One and
R5000.0.1 Well Data 3-135

only one of the W, O, G, or LIQUID labels must be specified. There is

no default.
2. Specifying an ECOLIM card for a shut-in well will cause the well to be
"turned back on".
3.5.6 Perforation Test Schedule (TSTPRF)

The TSTPRF card is used to specify the time interval between perforation tests. It
is used in conjunction with the PRFLIM card.
TSTPRF tstpnc
Definition:
tstpnc Time interval between tests for violations of water cut or

GOR by perforations, days. Default is 99,999 days.
NOTE: 1. Perforation tests are scheduled for the time at which the TSTPRF card
is read plus tstpnc days. Until the simulation reaches that time, the
perforation water cuts and GORs are unrestricted. Timesteps are not
adjusted to hit the test time exactly. Once a set of tests is performed,
new tests are scheduled for a time that is tstpnc days farther into the
simulation. A tstpnc value of zero causes the program to test during
every timestep.
2. Flashes to surface conditions are required for each perforation during

these tests. This could cause a significant increase in computer time if
frequently performed.
3. Both the TSTPRF and PRFLIM cards are needed to activate the option to
check each active perforation for violations of water cut or GOR
limits.
4. The TSTPRF card is also used to activate the recompletion unit option.
3-136 Well Data R5000.0.1

3.5.7 Perforation Water Cut, GOR, and/or SOR Limits (PRFLIM)

The PRFLIM card is used to assign water cut, GOR, and/or SOR (steam oil ratio,
VIP-THERM only) limits to be applied to each well perforation. Perforations will
be shut in if they exceed the limits and a TSTPRF card is active. Note that the last
perforation open is subject to the well constraints (WLIMIT/GLIMIT/SLIMIT)
not the layer constraints.
PRFLIM wl
GOR (PLUS) gorlim1 gorlim2 . . . gorlimn
WCUT (PLUS) wctlim1 wctlim2 . . . wctlimn
SOR sorlim1 sorlim2 . . . sorlimn
Definitions:
wl List of production wells for which limiting water cut and/

or GOR values are being specified (see Section 1.5.2).
GOR Alpha label indicating that the values on this card are the
limiting GOR values for each well in the well list.
PLUS Alpha label indicating that when a perforation is shut in

due to the GOR limit, all perforations in the list before
the shut-in one will also be shut in.
gorlim GOR limit to be applied to each perforation in this well,

SCF/STB (SM3/STM3). Default is -1.0, meaning the
well’s perforations will not be checked.
WCUT Alpha label indicating that the values on this card are the
limiting water cut values for each well in the well list.
PLUS Alpha label indicating that when a perforation is shut in

due to the water cut limit, all perforations in the list after
the shut-in one will also be shut in.
wctlim Water cut limit to be applied to each perforation in this

well. Default is -1.0, meaning the well’s perforations will
not be checked.
SOR Alpha label indicating that the values on this card are the
limiting steam-oil ratios for each well in the well list.
sorlim Steam-oil ratio limit to be applied to each perforation in

this well. Default is -1.0, meaning the well’s perforations
will not be checked.
NOTE: 1. The number of gorlim/wctlim and/or sorlim values must each

equal the number of wells in the well list.
R5000.0.1 Well Data 3-137

2. Any combination of GOR, WCUT, and SOR cards may be specified.
3. Flashes to surface conditions are required for each perforation during

these tests. This could cause a significant increase in computer time if
frequently performed.
4. Specifying a PRFLIM card for a shut-in well will cause the well to be
"turned back on".
5. The units of steam-oil ratio are STB(CWE)/STB (STM3(CWE)/STM3).

(CWE = cold water equivalent.)
3.5.8 Minimum Rate (QMIN)

The QMIN card must be preceded by an ECOLIM card (Section ).
A QMIN card is used to define the minimum rate a well is allowed to produce/
inject. When the rate falls below this qmin value, the well is shut in. The rate will
only be checked to see if qmin is exceeded, thereby returning the well to
production/injection, based on TEST card data.
QMIN wl
qmin1 qmin2 . . . qminn
Definitions:
wl List of wells for which qmin values are being specified

qmin Minimum rate at which the well is allowed to produce/

inject. Units are determined by the ECOLIM card.
Default is zero.
NOTE: 1. The number of qmin values must equal the number of wells in the
well list.
2. Specifying a QMIN card for a shut-in well will cause the well to be
"turned back on".
3-138 Well Data R5000.0.1

3.5.9 Multiple Rate (QMULT)

Must be preceded by a PROD card (Section 3.4.1)
A QMULT card is required for a well to flow if the MULTRT option was specified
on the PROD card. The QMULT card defines the maximum surface rates of all
three phases for each well, from which a total reservoir volume rate will be
computed and used as the maximum rate constraint.
A QMULT card may also be used to specify maximum surface rates for producer
well types W, O, G, or LIQUID. The appropriate phase rate(s) will be used
depending on the well type.
QMULT wl
omax1 omax2 ... omaxn
gmax1 gmax2 ... gmaxn
wmax1 wmax2 ... wmaxn
Definitions:
wl List of production wells for which maximum rates are

being specified (see Section 1.5.2).
omax Specified oil rate for the well. Units are STB/D (STM3/
D).
gmax Specified gas rate for the well. Units are MSCF/D (SM3/
D).
wmax Specified water rate for the well. Units are STB/D
(STM3/D).
NOTE: 1. For a MULTRT well, the specified surface rates will be converted
internally to reservoir barrel rates and summed to obtain a maximum
reservoir barrel rate for total fluid at reservoir conditions. The well
will produce at this maximum rate unless this causes a violation of
one of the constraints (pressure, water cut, or gas-oil ratio constraints,
but not rate constraints) defined by the user. In this event, the
constraint is observed, causing a rate reduction. The conversion to a
reservoir barrel rate is calculated at the start of each timestep.
2. The number of omax, gmax, and wmax values must each equal the
number of wells in the well list.
R5000.0.1 Well Data 3-139

3.5.10 Injection Gas Composition (YINJ)

The YINJ card is used to specify the composition of the injected gas for injection
wells using the STD or RES options and the wells are not identified as MI wells
(with MI plant in the major gas sales option).
YINJ wl
yinj1 yinj2 . . . yinjnc
Definitions:
wl List of wells for which yinj values are being specified

yinjk The mole fraction of component k in the gas injection

stream. A value must be specified for each of the n
components, and the values must sum exactly to 1.0.
n The number of hydrocarbon components in the gas

phase. Equal to ncv for VIP-THERM, equal to nc
otherwise.
NOTE: 1. A YINJ card must be entered to define the injected gas composition
for all injection wells that are using the STD or RES options, except
for those wells identified as MI wells in the major gas sales option
(see Section 4.5).
2. The specified gas composition applies to all the wells in the well list.
3. As many data cards as necessary may be used to specify a yinj value for
each component.
Example:
C
INJ G STD 253 -266 324 -326 365 -381
YINJ 253 -266 324 -326 365 -381
0.9944 0.0056
3-140 Well Data R5000.0.1

3.5.11 Define Additional Injection Gas Composition (YINJA)

The YINJA card is used to specify gas composition for injection wells using the
INJA card.
YINJA wl
yinja1 yinja2 . .. yinjanc
Definitions:
wl List of wells for which yinja values are being specified

yinjak The mole fraction of component k in the additional gas

injection stream. A value must be specified for each of
the n components and the values must sum exactly to 1.0.
n The number of hydrocarbon components in the gas

phase. Equal to ncv for VIP-THERM, equal to nc
otherwise.
NOTE: If the INJA card is specified for a gas injection well, but the YINJA card is
not specified for that well, the production composition from the specified
well management hierachy, or the composition specified by the YREINJ
card, is used for the well. If the YINJA composition is specified, the rate
weighted composition is used.
The YINJA card cannot be used for the FRES gas injection well using the
general injection option.
3.5.12 Injection Water Salinity (WSAL)

The WSAL card is used to specify the water salinity of injection wells.
WSAL wl
wsal1 wsal2 . .. wsaln
Definitions:
wl List of injectin wells for which wsal values are being

specified (see Section 1.5.2).
wsal Water salinity, user-specified units. Default is 0.
NOTE: 1. The number of wsal values must equal the number of wells in the well
list.
R5000.0.1 Well Data 3-141

3.5.13 Time Interval Between Tests

All wells that have been automatically shut in (pressure limit violation, lack of
mobility, rate limit violation) are tested periodically to determine whether they can
be returned to production/injection. The TEST (or WTEST) card is used to
specify the time interval between tests for each type of shut-in well. The
previous format for the TEST card is still accepted. See Note 1 below.
3.5.13.1 Global Specification (TEST)
When the TEST card is input, two methods are available to determine the time at
which wells are tested:
1. all wells of the appropriate shut-in type tested at the same time and
2. each well is tested at the time interval after it was shut-in.
The first method is the default; the second method is invoked if any of the three
values tincp, tincm, or tincr is negative.
TEST PRESSURE MOBILITY RATE

tincp tincm tincr
Definitions:
PRESSURE Alpha label indicating that the corresponding value on

the next card is the test increment for pressure shut-ins.
MOBILITY Alpha label indicating that the corresponding value on

the next card is the test increment for mobility shut-ins.
RATE Alpha label indicating that the corresponding value on

the next card is the test increment for rate shut-ins.
tincp Time interval between tests for shut-in wells due to a

pressure limit violation, days. If the test card is not
entered, the default is 0 days.
tincm Time interval between tests for shut-in wells due to lack
of mobility, days. If the test card is not entered, the
default is 0 days.
tincr Time interval between tests for shut-in wells due to a rate
limit violation, days. If the test card is not entered, the
default is 99,999 days.
NOTE: 1. When the prior input format of TEST tinc is used, the tincp, tincm,
and tincr values are all set equal to tinc.
3-142 Well Data R5000.0.1

2. A zero value for a time increment causes testing every timestep.
3. For the default method (positive values of tincp, tincm, and tincr), well
tests are scheduled for the time at which the TEST card is read plus
the appropriate shut-in type increment. Until the simulation reaches
that time, shut-in wells will remain shut in. Timesteps are not adjusted
to hit the test time exactly. Once the wells are tested, new tests are
scheduled for a time that is the appropriate increment farther into the
simulation.
4. For the second method (negative value of any of the three variables), each
shut-in well is tested after the appropriate time interval (absolute
value) has elapsed since it was shut-in. Timesteps are not adjusted to
hit any test time exactly. If a well does not return to production/
injection when tested, it will be retested at a time that is the
appropriate increment farther into the simulation.
5. The TEST card data applies to all wells; i.e., it replaces any previously
specified WTEST data.
3.5.13.2 Specification by Well (WTEST)
The WTEST card is used to specify the time interval between tests for individual
wells. When this option is used, each well is tested at the time interval after it was
shut-in.
WTEST wl
(PRESSURE tincp1 tincp2 ... tincpn)
(MOBILITY tincm1 tincm2 ... tincmn)
(RATE tincr1 tincr2 ... tincrn)
Definitions:
wl List of wells for which time interval values are being

PRESSURE Alpha label indicating that the values on this card are test
increments for pressure shut-ins.
MOBILITY Alpha label indicating that the values on this card are test
increments for mobility shut-ins.
RATE Alpha label indicating that the values on this card are test
increments for rate shut-ins.
tinc p Time interval between tests for shut-in wells due to a

pressure limit violation, days.
tincm Time interval between tests for shut-in wells due to a

mobility limit violation, days.
R5000.0.1 Well Data 3-143

tincr Time interval between tests for shut-in wells due to a rate
limit violation, days.
NOTE: 1. The number of tincp, tincm, and tincr values must equal the number
of wells in the well list.
2. A zero value for a time increment causes testing every timestep.
3. Each shut-in well is tested after the appropriate time interval has elapsed
since it was shut-in. Timesteps are not adjusted to hit any test time
exactly. If a well does not return to production/injection when tested,
it will be retested at a time that is the appropriate increment further
into the simulation.
3.5.14 Fraction of Time That Well is on Stream (ONTIME)

Ontime factors do not apply to injection wells using either of the FSTD or FRES
reinjection options.
The ONTIME card is used to specify the fraction of the time that a well is actually
producing/injecting. The fraction is applied to the well rate after the rate has been
determined by QMAX or pressure constraints and after the well minimum rate
(QMIN), water cut (WLIMIT) and GOR (GLIMIT) checks.
Ontime factors may be input at the well level or at any other level of well
management. The effective ontime factor for a well will be the one specified at
the lowest level of the well hierarchy; that is, the first user-specified factor found
in this order:
1. the well,
2. the appropriate gathering center,
3. the appropriate flow station,
4. the appropriate area,
5. the field.
ONTIME WELL wl
ontime1 ontime2 . . . ontimen
Definitions:
WELL Alpha label indicating that the data on this card applies
to wells. See Section 4.2.2 for ontime factor input at
other levels of well management.
3-144 Well Data R5000.0.1

wl List of wells for which ontime factors are being specified

ontime Fraction of time that the well is actually producing/

injecting. Default is 1.0.
NOTE: The number of ontime values must equal the number of wells in the well
list.
3.5.15 Well Permeability-Thickness Multiplier (WKHMULT)

The WKHMULT card is used to specify a multiplier to be applied to the
perforation permeability-thicknesses of a well. The multiplication occurs
immediately upon reading the data.
WKHMULT wl
wkhm1 wkhm2 ... wkhmn
Definitions:
wl List of wells for which wkhm values are being specified

wkhm Permeability-thickness multiplier.
NOTE: The number of wkhm values must equal the number of wells in the well
list.
3.5.16 GOR Penalty (GORPEN)

The GOR penalty data is used to set limits on oil production rates of individual
wells, based on their previous month’s average GOR.
The oil production rate limits for the specified wells will be
Oil Rate Limit = ------- Base ------•--Maximum

GOR
----------- Rate
------------------ Limit
-------------------------
Average GOR for the previous month
but not larger than the maximum rate limit. The Base GOR is a parameter entered
with the GORPEN card. The Maximum Rate Limit is specified with the QMAX,
QMULT or other oil rate limiting option.
While any well has a Base GOR greater than zero, the time steps are automatically
restricted to coincide with the end of each calendar month. The last day of each
month is represented by 00:00:01 AM on 1/??/?? in DAY/MONTH/YEAR
format. At the end of each month, the average GOR over the month is determined
for each well and used thereafter when required.
R5000.0.1 Well Data 3-145

GORPEN wl
bgor1 bgor2 . . . . . . bgorn
(agor1 agor2 . . . . . . agorn)
Definitions:
wl List of wells for each gorpen values are being specified.
bgor Base GOR for the well, SCF/STB (SM3/STM3). A zero

or negative value will turn the GOR penalty off for the
well. Default is -1.0.
agor Initial average GOR for the previous month, SCF/STB

(SM3/STM3). This value if entered will be used until the
end of the current month. This entire card may be
omitted, in which case the default is as follows:
If the GOR penalty for any well is in use, then the

previous month’s average GOR for the wells will already
have been calculated. This value will be used.
If this is the first GOR penalty data for any well, then the
average GOR over the previous month will not be
available. If the well has an oil rate the value will be set
to the well’s GOR at the previous time step, otherwise
agori = bgori.
NOTE: The GOR penalty data should normally be first introduced at the
beginning of the month. If it is first entered in the middle of a month the
average GOR calculated at the end of the month will be based on the
production since the data was entered.
3.5.17 GOR Constraint (GORCON, GORLIM)

The GOR constraint data is used to automatically adjust production rates of
individual wells to satisfy the input GOR constraints. This option cannot be used
simultaneously with the GOR penalty option (GORPEN) in the same
simulation run.
The new well rate limits for the specified wells will be
expo
- = ⎛ ---------------------------------------------
-⎞
New rate limit Target GOR
--------------------------------------------------------------------------------------
Rate limit at prev timestep ⎝ Avg. GOR for the prev period ⎠
The new rate limit shall not exceed the input maximum rate limit and the ratio
calculated above may be bounded by a user-input minimum and/or maximum.
This option can be applied to producers with QMAX or QMULT rate
specifications and the frequencies for rate adjustments can be individually defined
by the user.
3-146 Well Data R5000.0.1

⎛ OFF ⎞
GORCON ⎜ ⎟
⎝ (MINFCT fctmin) (MAXFCT fctmax) ⎠
GORLIM wl
tgor1 tgor2 ... tgorn)
(EXPONENT expo1 expo2... expon)
(FREQUENCY freq1 freq2... freqn)
Definitions:
GORCON Alpha label indicating that the GOR constraint option is

being specified. This card is not needed if no other
keywords on the card are being entered.
OFF Alpha label indicating that the GOR constraint option is

to be turned off for all wells, in which case the well rate
constraints return to the input maximum rate limits.
MINFCT Alpha label indicating that the minimum rate ratio for all
wells specified on GORLIM cards is being entered.
fctmin Minimum allowable rate ratio when well rate is being

reduced. Must be positive and less than or equal to 1.
Default is 0.5.
MAXFCT Alpha label indicating that the maximum rate ratio for all
wells specified on GORLIM cards is being entered.
fctmax Maximum allowable rate ratio when well rate is being

increased. Must not be less than 1. Default is 2.
GORLIM Alpha label indicating that the GOR constraints for

producers are being entered.
wl List of wells for which GOR constraint values are being

tgor Target GOR for producers, SCF/STB (SM3/STM3). A

zero or negative value will turn the GOR constraint off
for the well, causing the well rate constraint to return to
the input maximum rate limit. Default is -1.0.
EXPONENT Alpha label indicating that the exponents in the well rate
ratio equation are being entered.
expo Exponent in the equation for each well. Default is 1.0.
R5000.0.1 Well Data 3-147

FREQUENCY Alpha label indicating that the frequencies for well rate
adjustments are being entered.
freq Frequency for well rate adjustments, days. Default is 0.,

meaning that the rate is adjusted every timestep.
3.5.18 Maximum Steam Rate for Producers (QSTMX) (VIP-THERM)

The QSTMX card must be preceded by a PROD card (Section 3.4.1).
The QSTMX card defines the maximum steam rate a well is allowed to produce.
This rate constraint is optional and is applied in addition to any other maximum
rate constraints which may be defined.
QSTMX wl
qstmx1 qstmx2 . . . qstmxn
Definitions:
wl List of wells for which qstmx values are being specified

qstmx Maximum steam production rate at reservoir conditions

in cold water equivalent surface units, STB(CWE)/D
(STM3(CWE)/D).
3.6 Pressure Constraints and Productivity Indices

VIP-EXECUTIVE calculates a flowing bottomhole pressure consistent with the
well index and well rate. This bottomhole pressure is checked against any user-
defined pressure constraints. If the flow rate is in violation of a pressure
constraint, it is altered accordingly and a new corresponding well rate is
calculated. This bottomhole pressure is then used to allocate production/injection
to individual gridblocks.
Bottomhole pressure constraints are defined by BHP cards. Alternatively,

tubinghead pressure constraints can be imposed to control well flow. These are
established by entering both THP cards and BHPTAB data. Hydraulics tables
(BHPTAB data) are used for three-phase producers to relate tubinghead pressure
to bottomhole pressure, flow rate, water cut, and gas-liquid ratio. VIP-
EXECUTIVE searches for the largest intersection of the Inflow and Outflow
Performance Curves (Figure 3-1). The bottomhole pressure corresponding to this
intersection is used to calculate well phase rates.
Tubinghead pressure constraints can also be imposed on gas producers and on gas
and water injectors. For these cases the default algorithm is based on the "average
pressure and temperature method" as described by Beggs (Reference 1). For gas
and water injectors hydraulics tables (BHITAB data) may alternatively be entered.
3-148 Well Data R5000.0.1

Bottomhole pressure can also be constrained by the DPBHMX card, which

defines a maximum drawdown (for producers) or buildup (for injectors) in each
well. The drawdown/buildup is computed as the difference between a well’s
average gridblock pressure at datum and the well’s bottomhole pressure. This
option is applicable whether a well is on a BHP or THP constraint. If necessary,
the bottomhole pressure of the well is reset so that the drawdown, or buildup, does
not exceed DPBHMX. A new corresponding well rate is then calculated. To help
alleviate convergence problems, after ITNSTP iterations (producers) or ITNSTQ
iterations (injectors) the bottomhole pressure of DPBHMX constrained wells is
fixed for the remainder of the timestep.
Hydraulics For A Given

Tubinghead Pressure
Figure 3-1: Tubinghead Pressure
Whenever BHP or THP constraints are imposed, VIP-EXECUTIVE must

calculate a flowing bottomhole pressure, fbhp. Productivity/injectivity indices are
used to relate well flow rates to fbhp. In the VIP-EXECUTIVE family of
simulators this is accomplished through a well index, WI. The well index is
defined by its use within the following oil production equation:
L
kh k ro
q o = 0.001127WI ∑ - [ P – P obh – γ ( D l – D o ) ].
--------------
B o μ o I bl
I=1
where
qo Oil phase production rate.

o
P bh Datum flowing bottomhole pressure.
WI Well index.
R5000.0.1 Well Data 3-149

khl Permeability-thickness as defined by the FPERF card

opposite the l-th perforation of the well. This need not be
the gridblock value.
krol Relative permeability to oil at the gridblock saturation.
Bol Oil formation volume factor at Pbl.
μol Oil viscosity at Pbl.
Pbl Gridblock pressure of the cell containing the l-th

perforation.
γ Average fluid density over the perforated interval of the

well, based on production or injection fluids.
Dl Subsea depth of the l-th perforation.
Do Datum depth.
Since qo is known (the value defined by the QMAX card), Equation can be
o
solved for flowing bottomhole pressure at datum, P bh .
Therefore, the flowing bottomhole pressure at the reference depth is given by:
L
kh k ro
WI ∑ --------------
B o μ o I bl
- [ P – γ ( D l – D o ) ] – q o ⁄ 0.001127
o I=1
P bh = --------------------------------------------------------------------------------------------------------------------------
L
khk ro
WI ∑ -------------
Bo μo I
I=1
o o
This value of P bh is then compared to the user-specified bhp value. If P bh is
greater than bhp, the pressure constraint is honored and P obh is set equal to bhp. A
new qo is then calculated using Equation . (Similar expressions are used for gas
and water.)
The data cards described in this section provide alternate ways to introduce the
well index into the recurrent data stream. If no THP or BHP limits are to be
established for a well, then no WI, PI, or RFLOW cards should be entered for that
well. If previous limits are to be removed, wi should be set to zero by a WI card.
In VIP-THERM, if KHWI is entered in the FPERF data (Section 3.2.2), then no

WI, PI, or RFLOW data should be entered since the well index is included in
KHWI.
If no productivity/injectivity index (PI, WI, RFLOW, KHWI (VIP-THERM)) is

specified, the well index defaults to zero. In this case, the simulator produces/
injects the specified maximum production/injection rate without regard to
pressure limitations. Allocation to different perforations is made on the basis of
fluid mobility. This is reasonable only if Pbl - Pbhl is approximately constant for
3-150 Well Data R5000.0.1

all layers; however, it may cause convergence difficulties in many cases. It is

strongly recommended that a productivity/injectivity index be specified for each
well.
R5000.0.1 Well Data 3-151

3.6.1 Well Index (WI)(Skip if PI or FLOW orWIL or KHWI is used)

The WI card is used to specify well indices for wells. Data specified on a WI card
will replace any previous WI, PI, or RFLOW data for the same well. WIL values
computed for a well by a previous FPERF card will be replaced by WI data for the
same well.
WI (NORESET) wl
wi1 wi2 . . .win
Definitions:

cumulative reservoir production arrays (for the wells in
the following list), used in conjunction with the WI
zero with the input of new WI data. Default is to zero out
these arrays.
wl List of wells for which wi values are being entered (see

Section 1.5.2).
wi Well index, dimensionless.
2π
wi = --------------------------------- ,
r
ln ⎛ -----⎞ + skin
b
⎝ r w⎠
where
rb Equivalent radius (Peaceman) of the

gridblock containing the well (see
RFLOW Card) in ft (m).
rw Wellbore radius.
skin Skin factor.
NOTE: The number of wi values must equal the number of wells in the well list.
Example:
WI 4 -541
538*0.52
3-152 Well Data R5000.0.1

3.6.2 Productivity/Injectivity Index (PI) (Skip if WI or RFLOW or WIL or KHWI

is used)
The PI card is used to specify productivity/injectivity data for wells. Data
specified on a PI card will replace any previous WI, PI, or RFLOW data for the
same well. WIL values computed for a well by a previous FPERF card will be
replaced by PI data for the same well.
PI (NORESET) wl
gf1 gf2 . . .gfn
pi1 pi2 . . .pin
Definitions:

zero with the input of new PI data. Default is to zero out
these arrays.
wl List of wells for which gf and pi values are being entered

gf Geometry factor. Converts the productivity/injectivity

index from a drainage radius basis to a gridblock basis.
Dimensionless.
For laminar, radial flow,
ln ( r e ⁄ r w )
gf = -----------------------
ln ( r b ⁄ r w )
where
re Drainage radius.
rb Equivalent radius (Peaceman) of the

gridblock containing the well (see
RFLOW Card) in ft (m).
rw Wellbore radius.
pi Productivity/injectivity index. Units are determined by

the units of production or injection rates defined by the
PROD or INJ cards:
R5000.0.1 Well Data 3-153

STB/D-psia (STM3/D-kPa) - Water, oil, or liquid STD

producer, or a water injector with the STD or FSTD
option.
MSCF/D-psia (SM3/D-kPa) - Gas STD producer or a gas

injector with the STD or FSTD option.
rb/D-psia (m3/D-kPa) - Producer with the ALL or RES

option or an injector with the RES or FRES option.
NOTE: 1. The number of gf and pi values must equal the number of wells in the
well list.
2. PI data replace WI or RFLOW data. If none of these is read for any well, it
produces/injects at the rate given on the QMAX card.
3. The pi is converted to wi (for internal program use) when the well is first
put on production/injection. For an oil producer:
pi ⋅ gf
wi = ----------------------------------------------------
L
-
khk ro
0.001127 ∑ ------------
μo Bo I
-
I 1
3.6.3 Radial Flow Equation Data (RFLOW) (Skip if WI or PI or WIL or KHWI

is used)
The RFLOW card is used to specify radial flow equation data for wells. Data
specified on an RFLOW card will replace any previous WI, PI, or RFLOW data
for the same well. WIL values computed for a well by a previous FPERF card will
be replaced by RFLOW data for the same well.
RFLOW (NORESET) wl
rw1 rw2 . . .rwn
rb1 rb2 . . .rbn
skin1 skin2 . . .skinn
Definitions:

zero with the input of new RFLOW data. Default is to
zero out these arrays.
wl List of wells for which rw, rb, and skin values are being
entered (see Section 1.5.2).
3-154 Well Data R5000.0.1

rw Wellbore radius, ft (m).
rb Equivalent radius (Peaceman) of the gridblock

containing the well, ft (m). If this value is set to zero rb is
defaulted (see note 3).
skin Skin factor. Dimensionless.
R5000.0.1 Well Data 3-155

NOTE: 1. The number of rw, rb, and skin values must equal the number of
wells in the well list. These values are used to calculate the well index
and must result in a positive well index. The program calculates wi
from the data as follows:
ΔΘ
wi = ---------------------------------
r
ln ⎛ -----⎞ + skin
b
⎝ r w⎠
The term ΔΘ is calculated from the data entered on the FLOANG card. If
not entered, ΔΘ = 2 π .
2. The RFLOW data replace PI or WI data. If none of these is read for any
well, it produces/injects at the rate given on the QMAX card.
3. When rb is entered as zero, its value is defaulted to that recommended by

Peaceman (Reference 2), for wells located in the center of
rectangular gridblocks with isotropic permeabilities:
2 2 1⁄2
r b = 0.14 ( Δx + Δy )
For other configurations, e.g., wells in cross-sections, wells at gridblock

corners, the correct value of rb, must be entered explicitly.
rb can only be defaulted for vertical wells in non-radial systems; i.e. the
WELL keyword must contain IW and JW data. To obtain a defaulted
value of rb for non-vertical wells or wells in a radial systems, the
FPERF keyword must be used. Also wells with anisotropic
permeablilities or other conditions that require the rb to vary by layer
should make use of the FPERF keywork to define or default the
values of rb.
3.6.4 Well Angle Open to Flow (FLOANG)

The FLOANG card is used to define the angle open to flow for wells.
FLOANG wl
wang1 wang2...wangn
Definitions:
wl List of wells for which wang values are being entered

wang Well angle open to flow, degrees. Values allowed are 0o

to 360o, inclusive. Default is 360o.
3-156 Well Data R5000.0.1

NOTE: The number of wang values must equal the number of wells in the well
list.
3.6.5 Well Datum Depth (WLWDAT)

The WLWDAT card is used to assign the depth to which the flowing and limiting
bottomhole pressures are referenced.
WLWDAT wl
wdat1 wdat2 ... wdatn
Definitions:
w1 List of wells for which wdat values are being entered

(See Section 1.5.2).
wdat Well datum depth, (ft)m. Bottomhole pressure is

referenced to this depth. If not entered, datum depth
defaults to the DEPTH from the first IEQUIL card. A
value of zero causes wdat to be set to the depth to the
center of the gridblock containing the first perforation.
NOTE: The number of wdat values must equal the number of wells in the well
list.
3.6.6 Bottomhole Pressure (BHP)

To invoke BHP constraints, the user must define a productivity/injectivity index
(Section 3.6). The BHP card allows the user to define a limiting bottomhole
pressure.
BHP wl
bhp1 bhp2 . . .bhpn
Definitions:
wl List of wells for which bhp values are being entered (see
Section 1.5.2).
bhp Limiting bottomhole pressure, psia (kPa); i.e., minimum

allowed pressure for a producer or maximum allowed
pressure for an injector. Default is 0 psia for producers
and 10,000 psia for injectors.
R5000.0.1 Well Data 3-157

NOTE: 1. The number of bhp values must equal the number of wells in the well
list.
2. If both BHP and THP constraints have been entered for a well, both will
be honored.
3. The bottomhole pressure printed in well reports is referenced to a depth of

wdat (see WLWDAT card, Section 3.6.5) which must be measured
from the same reference point as is used for gridblock depths.
4. If no THP or BHP limits are to be established, then no WI, PI, or RFLOW

cards should be entered for the affected wells. If previous limits are to
be removed, pi should be set to zero by a PI card. Note that inputting
a wi value of zero on the WI card will shut in the well because of no
mobility.
Example:
C set the BHP to a minimum of 500 psi at 8800 feet
BHP 1 -150
150*500.
WLWDAT 1 -150
150*8800
3.6.7 Tubinghead Pressure (THP)

To invoke THP constraints with wellbore hydraulics tables for multiphase
producers, the user must define a productivity index (Section 3.6), BHPTAB data,
and ITUBE data. To invoke THP constraints with wellbore hydraulics tables for
injectors, the user must define an injectivity index (Section 3.6), BHITAB data,
and ITUBE data. To invoke single-phase THP constraints for injectors, the user
must define an injectivity index, DIAM data, and TUBE data. To invoke THP
constraints for gas producers, the user must define a productivity index (Section
3.6), DIAM data, GTHPWL data, and THPGTB data. The THP card allows the
user to define a limiting tubinghead pressure.
THP wl
thp1 thp2 . . . thpn
Definitions:
wl List of wells for which thp values are being entered (see
Section 1.5.2).
thp Tubinghead pressure limit, psia (kPa); i.e., minimum

pressure for producers or maximum pressure for
injectors.
NOTE: 1. The number of thp values must equal the number of wells in the well
3-158 Well Data R5000.0.1

list.
2. If both BHP and THP constraints have been entered for a well, both will
be honored.
3. If no THP or BHP limits are to be established for a well, then no WI, PI, or
RFLOW cards should be entered for that well. If previous limits are to
be removed, wi should be set to zero.
4. For predictive well management, tubinghead pressure values for

production wells should be input for each eligible pressure system.
The following statements are true when implicit tubinghead pressure equations
are not used. For both three-phase and gas producers, the tubinghead pressure
algorithm is only performed during the first "few" outer iterations of the timestep
(ITNTHP card). During the rest of the timestep the well is treated as a bottomhole
pressure constrained well, with bhp equalling the calculated value from the
tubinghead pressure algorithm.
3.6.8 Implicit Tubinghead Pressure Equations (IMPTHP)

The IMPTHP card is used to specify whether implicit tubinghead pressure
equations are to be set up when a well is constrained by a tubinghead pressure
limit (THP).
IMPTHP ON
OFF
Definitions:
ON Alpha Label indicating that implicit tubinghead pressure

equations are to be set up.
OFF Alpha label indicating that implicit tubinghead pressure

equations are not to be set up. This is the default.
NOTE: The tubinghead pressure iteration control variable, ITNTHP, is ignored

when implicit tubinghead pressure is on.
3.6.9 Tubinghead Pressure Iteration Control (ITNTHP)

The ITNTHP card allows the user to specify the number of outer iterations of each
timestep during which the tubinghead pressure algorithm will be performed. After
this number the wells are treated as bottomhole pressure controlled, with bhp
equalling the calculated value from the itnthp iteration.
R5000.0.1 Well Data 3-159

ITNTHP itnthp
Definition:
itnthp Number of outer iterations of each timestep during which

the tubinghead pressure algorithm for producers will be
performed. Default is 2.
NOTE: This value is ignored when implicit tubinghead pressure equations are in
use (IMPTHP ON).
3.6.10 Maximum Drawdown Constraint (DPBHMX)

The DPBHMX card allows the user to define a limiting drawdown or buildup
pressure.
DPBHMX wl
dpbhmx1 dpbhmx2 . . . dpbhmxn
Definitions:
wl List of wells for which dpbhmx values are being entered

dpbhmx Limiting drawdown (producers) or buildup pressure

(injectors), psia (kPa); i.e., maximum allowed difference
between a well’s average gridblock pressure at datum and
the well’s bottomhole pressure. Default is 10,000 psia.
NOTE: The number of dpbhmx values must equal the number of wells in the
well list.
The well’s average gridblock pressure is calculated over all the flowing
perforations.
To help alleviate convergence problems, after ITNSTP iterations

(producers) or ITNSTQ iterations (injectors) the bottomhole pressure of
DPBHMX constrained wells is fixed for the remainder of the timestep.
3-160 Well Data R5000.0.1

3.7 Wellbore Crossflow Model
3.7.1 Crossflow Option (XFON/XFOFF) (Not available in VIP-THERM)

Wellbore crossflow is computed using the method of Modine, Coats, and Wells
(Reference 9).
The XFON and XFOFF cards are used to select crossflow computations by well.
The computations can be enabled or disabled at any time. Crossflow is off by
default.
XFON (QMX) wl
XFOFF wl
Definitions:
XFON Keyword indicating that wellbore crossflow

computations are to be performed for the following list of
wells.
XFOFF Keyword indicating that wellbore crossflow

computations are not to be performed for the following
list of wells.
QMX Keyword indicating that the wellbore crossflow

computations for each of the wells in the following list
will not occur until the well has a QMAX > 0.
wl Well list (see Section 1.5.2).
NOTE: 1. Print control for the wellbore crossflow summary is equivalent to that
for the Well Perforation Summary (WLLYR). When the Well
Perforation Summary is printed, the Wellbore Crossflow Summary is
printed which shows crossflow rates by phase and perforation in units
of rb/D (rm3/D) for all wells which are currently crossflowing.
Crossflow rates are not included in the Well Perforation Summary.
2. If XFON is specified for one or more wells the simulator will compute the
wellbore gradient using the volume balance method (MBAWG =
OFF).
R5000.0.1 Well Data 3-161

3.7.2 Wellbore Gradient Calculation (MBAWG)

Two methods are available for calculating wellbore gradients. In the first method
(default, except as indicated below), an average value of the wellbore gradient
over the perforated intervals is calculated by "mobility allocation" as
L Np
⎛ ⎞
k rj ρ j⎟
( WI*KH ) I ⎜
∑ ⎜ ∑
⎝j = 1 j ⎠ I
-----------
μ ⎟
I=1
GRAD = ---------------------------------------------------------------
L Np
⎛ ⎞
⎜ k rj⎟
∑
( WI*KH ) I
⎜
⎝j 1 j⎠
∑ ------
μ⎟
I 1
where L is the number of layers, Np is the number of phases, WI and KH are the
well index and permeability-thickness products by layer, and krj, ρj, and μj are
phase relative permeabilities, densities, and viscosities.
In the second method, a value for the wellbore gradient opposite each perforated
interval is calculated by a wellbore volume balance. These calculations include
the effects of crossflowing layers but ignore interphase mass transfer effects and
fluid expansion in the wellbore. This method is the default, and cannot be
overridden, if either the crossflow option is invoked or the horizontal/inclined
wellbore flow correlation (see note 9 in Section 3.2.2) is invoked.
The MBAWG card is used to control the wellbore gradient calculations.
⎛ ON ⎞
MBAWG ⎜ ⎟
⎝ OFF ⎠
Definitions:
ON Use mobility allocation method for the average wellbore

gradient. This is the default.
OFF Use the volume balance method for the wellbore

gradient.
3-162 Well Data R5000.0.1

3.7.3 Wellbore Gradient Calculation (VIP-THERM)

In VIP-THERM, three methods of calculating wellbore gradients are available.
For production wells, a fourth option is specification of gradient by perforation in
the FPERF data (Section 3.2.2). Two of the calculational options, MOBAVG and
VOLBAL, are described in the previous section, the data for which is also
accepted in VIP-THERM. The default (except as indicated below) in VIP-
THERM is similar to the MOBAVG option except that a gradient for each
perforation is computed which is a mobility average gradient of the fluids
produced at and below it:
p
⎛ ⎞
k rj ρ j⎟
( WI*KH ) I ⎜
∑ ⎜ ∑
⎝j = 1 j ⎠ I
-----------
μ ⎟
I=k
GRAD k = ---------------------------------------------------------------
L Np
⎛ ⎞
k rj⎟
( WI*KH ) I ⎜
∑ ⎜
⎝
∑ ------
μj ⎟
⎠
MOBAVG
WBGRAD MOBAVB
VOLBAL
Definitions:
MOBAVG Use single mobility average gradient.
MOBAVB Use mobility average for each perforation based on all

perforations below and including it. Default, except as
indicated below.
VOLBAL Use volume balance method. This is the default if either

the crossflow option or the inclined/horizontal wellbore
flow correlation (see note 9 in Section 3.2.2) is invoked.
R5000.0.1 Well Data 3-163

3.8 Wellbore Flash Controls

The wellbore flash procedure is designed to calculate stock tank oil, water, and
gas flow rates for each production well when a surface rate or a pressure
constraint is specified by the user. An iterative procedure is applied to find a
bottomhole pressure that honors the well boundary condition. The procedure is
executed in each outer iteration of a timestep, and separator flash subroutines are
called several times in each iteration of the procedure. These calculations require
a significant amount of computer time in compositional models with many wells.
In order to minimize the work involved in these calculations, methods have been
developed to improve the efficiency of calculations. The wellbore equations and
the separator flash equations are now solved simultaneously. The initial
bottomhole pressure is calculated from the wellbore equation with a separator
coefficient defined in the previous outer iteration and values are only recalculated
if necessary. The user can control iteration tolerances and decide whether
simplified separator calculations will be performed.
The user may optionally choose to take into account pressure gradient variations
with depth in production wells in the wellbore flash calculations.
3.8.1 THP Convergence Control (BHPITN)

The BHPITN card is used in conjunction with the THP, ITUBE, BHPTAB, and
BHPADD cards. A BHPITN card with the first three parameters specified will
apply to injection wells only. A card with the two additional parameters is used to
set iteration and convergence parameters for tubinghead pressure and simplified
separator computations in production wells.
BHPITN ibhpmx bhptlp bhptlq (P bhptlz)
Definitions:
ibhpmx Maximum number of tubinghead pressure iterations.

Default is 100.
bhptlp Relative tolerance used to determine convergence of the

bottomhole pressure calculation during THP iterations.
Default is 0.0001.
bhptlq Relative tolerance used to determine convergence of the

rate calculation during THP iterations. Default is 0.001
for producers and 0.0001 for injectors.
P Alpha label indicating that iteration and convergence

parameters for tubinghead pressure and simplified
separator computations for production wells are set.
3-164 Well Data R5000.0.1

bhptlz Tolerance of composition changes. This parameter is

used in the simplified composition calculations. If the
maximum change of the mole fractions of the
hydrocarbon components in an input stream of a
separator battery is less than the tolerance bhptlz, the K-
values in each stage of the battery are not recalculated. If
this tolerance is set to zero, the K-values are recalculated
in each outer iteration of each timestep. Default is 0.0 if
number of components is 2; otherwise, 0.0005.
R5000.0.1 Well Data 3-165

3.9 Wellbore Hydraulics Tables
3.9.1 Wellbore Hydraulics Table Assignment (ITUBE)

ITUBE data must be defined along with BHPTAB data if a THP card is entered
for a multi-phase producer. This input is optional for single-phase (water and gas)
injectors and gas producers, for which simple wellbore hydraulics treatments are
available.
The ITUBE data are used with the wellbore hydraulics table data (BHPTAB and/
or BHITAB) to relate tubinghead pressure to bottomhole pressure.
ITUBE wl
ibhp1 ibhp2 . . . ibhpn
dzw1 dzw2 . . . dzwn
Definitions:
wl List of wells for which ibhp and dzw values are being
ibhp Number of the bottomhole pressure table (BHPTAB/

BHITAB card) that defines tubing pressure losses for this
well. A zero here will turn off tubing calculations.
dzw Vertical distance from the wellhead to the first set of

perforations, ft (m).
NOTE: 1. The number of ibhp and dzw values must equal the number of wells
in the well list.
2. If dzw differs from the dzw value used to construct the bottomhole
pressure table, a gravity head calculation is used to adjust from the
perforations to the reference depth of the table.

wdat (see WLWDAT card, Section 3.6.5), which must be measured
3-166 Well Data R5000.0.1

Example:
ITUBE 2 -14 18 22 24 -37 41

30*1
30*8800
WLWDAT 2 -14 18 22 24 -37 41
30*8800
THP 2 -14 18 22 24 -37 41
30*1815.
C
3.9.2 Wellbore Hydraulics Table (BHPTAB)

Must be defined if THP data is entered for a multi-phase producer.
BHPTAB data are used to relate tubinghead pressure to bottomhole pressure and
the three phase flow rates. Each table can be defined independently, and more than
one well can refer to the same BHPTAB.
BHPTAB nbhp dzw
QLIQ
QO q1 q2 . . . qk
QGAS
QEWS
GLR
GOR g1 (g2 . . . g l)
OGR
WCUT w1 (w2 . . . wm)

WGR
(ALQ (GASRATE) alq1(alq2 . . .alqj))
THP thp1 (thp2 . . . thpn)
IGLR IWCUT IQLIQ (IALQ)BHP(ITHP)

IGOR IQO
IOGR IWGR IQGAS

IQEWS
ig1 iw1 iq1 (ialq1) bhp(ithp1)(bhp(ithp2). . .bhp(ithpn))
. . . . . .
. . . . . .
. . . . . .
igl iwm iqk (ialqj) bhp(ithp1)(bhp(ithp2). . .bhp(ithpn))
R5000.0.1 Well Data 3-167

Definitions:
nbhp Number of the bottomhole pressure table being read.
dzw Vertical distance from the wellhead to the reference point

for bottomhole pressures as tabulated, ft (m).
QLIQ Alpha label indicating that values on this card are liquid
rates (oil plus water). This must be used with GLR/GOR
and WCUT.
QO Alpha label indicating that values on this card are oil

rates. This must be used with GLR/GOR and WCUT.
QGAS Alpha label indicating that values on this card are gas
rates. This must be used with OGR and WGR.
QEWS Alpha label indicating that values on this card are

equivalent total wellstream rates (total hydrocarbon rate
converted to gas rate at standard conditions). This must
be used with OGR and WGR.
q Liquid or oil rates, STB/D (STM3/D), or gas rates,

MSCF/D (SM3/D). Values can be unequally spaced.
GLR Alpha label indicating that values on this card are gas-
liquid ratios. This must be used with either QLIQ or QO.
GOR Alpha label indicating that values on this card are gas-oil
ratios. This must be used with either QO or QLIQ.
OGR Alpha label indicating that values on this card are oil-gas
ratios. This must be used with either QGAS or QEWS.
g Gas-liquid or gas-oil ratios, SCF/STB (SM3/STM3), or

oil-gas ratios, STB/MMSCF (STM3/KSM3). Values can
be unequally spaced.
WCUT Alpha label indicating that water-cut values are read on

this card. This must be used with either QLIQ or QO.
WGR Alpha label indicating that values on this card are water-
gas ratios. This must be used with either QGAS or
QEWS.
w Water-cut values, fraction, or water-gas ratios, STB/

MMSCF (STM3/KSM3). Values can be unequally
spaced.
ALQ Alpha label indicating that values on this card are either
gaslift gas rates or user-defined artificial lift quantity
values.
3-168 Well Data R5000.0.1

GASRATE Alpha label indicating that the values on this card are
gaslift gas rates. If this keyword is specified, then ALQ
well data (Section 3.9.6) will be ignored and the gaslift
gas rate for the well will be used instead. This also
means that ratios on the GLR/GOR card consist of
produced gas only, not total gas.
alq Gaslift gas rates, MSCF/D (SM3/D) or artificial lift

quantity values, as defined by the user. Values can be
unequally spaced.
THP Alpha label indicating that tubinghead pressures are read

on this card.
thp Tubinghead pressure values, psia (kPa). Values can be

unequally spaced.
IGLR Alpha label indicating that the values read in the column
under this heading are gas-liquid ratio indices. This must
be used with GLR.
IGOR Alpha label indicating that the values read in the column
under this heading are gas-oil ratio indices. This must be
used with GOR.
IOGR Alpha label indicating that the values read in the column
under this heading are oil-gas ratio indices. This must be
used with OGR.
IWCUT Alpha label indicating that the values read in the column
under this heading are water-cut indices. This must be
used with WCUT.
IWGR Alpha label indicating that the values read in the column
under this heading are water-gas ratio indices. This must
be used with WGR.
IQLIQ Alpha label indicating that the values read in the column
under this heading are liquid rate indices. This must be
used with QLIQ.
IQO Alpha label indicating that the values read in the column
under this heading are oil rate indices. This must be used
with QO.
IQGAS Alpha label indicating that the values read in the column
under this heading are gas rate indices. This must be used
with QGAS.
R5000.0.1 Well Data 3-169

IQEWS Alpha label indicating that the values read in the column
under this heading are equivalent total wellstream rate
indices. This must be used with QEWS.
IALQ Alpha label indicating that the values read in the column
under this heading are artificial lift quantity indices. This
must be used with ALQ.
BHP(ITHP) Alpha label indicating that the values read in the columns
under this heading are bottomhole pressure values for
each tubinghead pressure input. Parentheses must appear
in this alpha label.
igl Index referring to the l-th ratio value read.
iwm Index referring to the m-th water-cut value read.
iqk Index referring to the k-th rate value read.
ialqj Index referring to the j-th gaslift rate or artificial lift

quantity value read.
bhp(ithp) The bottomhole pressure value, psia (kPa),

corresponding to the indicated ratio, water-cut, and rate
values. The corresponding tubinghead pressure is the thp
value that would correspond to ithp. The number of
bottomhole pressure values on this card must equal the
number of thp values on the THP card.
NOTE: An ITUBE value must be specified for each well which is to use one of
the BHPTAB tables.
Example
C TUBING SIZE = 3.500 OD = 2.992 ID
C SEPARATOR PRESSURES: 215. 315. 665. 665. 665.
C FLOW LINE LENGTHS: 0. 0. 4000. 10000. 18000.
C HALF WELL RATES TO REFLECT HALF WELLS
BHPTAB 1 8800.
QLIQ 50. 250. 500. 1000. 2000. 5000.
GLR 300. 750. 1500. 5000. 20000.
WCUT 0.000 0.500
THP 215. 315. 815. 1315. 1815.
C REMAINDER OF TABLE
3-170 Well Data R5000.0.1

3.9.3 Wellbore Hydraulics Table Switching (NEWBHPTAB)

The NEWBHPTAB card allows the user to set alternate bottomhole pressure
tables for a well when, at the existing THP limit, its rate becomes too low, its gas
ratio becomes too high, and/or its water ratio becomes too high.
The definition and units of the RATE, GRATIO, and WRATIO data are the
same as that specified in the corresponding bottomhole pressure table. This
means the current table to which the well is assigned, not the one to which it
might be switched.
NEWBHPTAB wl
RATE
ibhp1 ibhp2 ... ibhpn
q1 q2 ... qn
GRATIO
jbhp1 jbhp2 ... jbhpn
g1 g2 ... gn
WRATIO
kbhp1 kbhp2 ... kbhpn
w1 w2 ... wn
Definitions:
wl List of wells for which table number and constraint

values are being entered (see Section 1.5.2).
ibhp Bottomhole pressure table number to which the well will

be assigned when its production rate (QLIQ/QO/QGAS/
QEWS) falls below the corresponding q value.
q Threshhold production rate such that when the well’s

production rate falls below this value, the bottomhole
pressure table number will be changed. The unit of q is
the same as that specified in the corresponding
bottomhole pressure table (BHPTAB) to which the well is
currently assigned.
jbhp Bottomhole pressure table number to which the well will

be assigned when its gas ratio (GLR/GOR/OGR) exceeds
the corresponding g value.
g Threshhold gas ratio such that when the well’s GLR/

GOR/OGR exceeds this value, the bottomhole pressure
table number will be changed. The unit of g is the same
as that specified in the corresponding bottomhole
pressure table (BHPTAB) to which the well is currently
assigned.
R5000.0.1 Well Data 3-171

kbhp Bottomhole pressure table number to which the well will

be assigned when its water ratio (WCUT/WGR) exceeds
the corresponding w value.
w Threshhold water ratio such that when the well’s WCUT/

WGR exceeds this value, the bottomhole pressure table
number will be changed. The unit of w is the same as
that specified in the corresponding bottomhole pressure
table (BHPTAB) to which the well is currently assigned.
NOTE: 1. The number of ibhp, q, jbhp, g, kbhp, and w values must be equal
the number of wells in the well list.
2. A bottomhole pressure table switch will occur at most once for each
limit type. For example, once a switch is made for low production rate
the well will not switch back to the original table if the rate rises back
above the specified threshold value.
3. One, two, or all three sets of 3 lines of data may be entered under one
NEWBHPTAB card. The same well list applies to the sets of data.
4. The prior form of this data (no headings, only one line each of table
numbers and rates) is accepted and is interpreted as RATE data.
3-172 Well Data R5000.0.1

3.9.4 Wellbore Hydraulics Table for Injectors (BHITAB)

Must be defined if ITUBE data is entered for an injection well for which THP
data is also entered.
BHITAB data are used to relate tubinghead discharge pressure to bottomhole

injection pressure and injection rate. Each table can be defined independently, and
more than one well can refer to the same BHITAB. The phase being injected need
only be specified if metric units are being used, in which case a units conversion
must be performed.
⎛ ⎞
BHITAB nbhi dzw ⎜ W ⎟
⎝ G⎠
QI qi1 qi2 ...qik
THP thp1 (thp2 ...thpn)
IQI BHP ( ITHP )

ITHP BHP ( IQI )
iqi 1 bhp ( ithp 1 ) (bhp ( ithp 2 ) … bhp ( ithp n ) )
ithp 1 bhp ( iqi 1 ) bhp ( iqi 2 ) … bhp ( iqi k )
. . . . . ..
. . . . . ..
iqi k bhp ( ithp 1 ) (bhp ( ithp 2 ) … bhp ( ithp n ) )
ithp n bhp ( iqi 1 ) bhp ( iqi 2 ) … bhp ( iqi k )
Definitions:
nbhi Number of the bottomhole injection pressure table being

read.
dzw Vertical distance from the wellhead to the reference point

for bottomhole injection pressures as tabulated, ft (m).
W Alpha label, for metric units input only, indicating that

the rates are water injection rates, for appropriate units
conversion.
G Alpha label, for metric units input only, indicating that

the rates are gas injection rates, for appropriate units
conversion.
QI Alpha label indicating that values on this card are

injection rates.
R5000.0.1 Well Data 3-173

qi Injection rates, water, STB/D (STM3/D), or gas, MSCF/

D (SM3/D). Values can be unequally spaced.
THP Alpha label indicating that values on this card are

tubinghead injection pressures.
thp Tubinghead injection pressure values, psia (kPa). Values

can be unequally spaced.
IQI Alpha label indicating that the values read in the column
under this heading are injection rate indices.
BHP(ITHP) Alpha label indicating that the values read in the columns
under this heading are bottomhole injection pressure
values for each tubinghead injection pressure input.
Parentheses must appear in this alpha label.
ITHP Alpha label indicating that the values read in the column
under this heading are tubinghead injection pressure
indices.
BHP(IQI) Alpha label indicating that the values read in the columns
under this heading are bottomhole injection pressure
values for each injection rate input. Parentheses must
appear in this alpha label.
iqik Index referring to the k-th injection rate value read.
bhp(ithp) The bottomhole injection pressure value, psia (kPa),

corresponding to the indicated rate and tubinghead
pressure values. The number of bottomhole pressure
values on this card must equal the number of thp values
on the THP card.
ithpn index referring to the n-th tubinghead injection pressure

value read.
bhp(iqi) The bottomhole injection pressure value, psia (kPa),

corresponding to the indicated rate and tubinghead
pressure values. The corresponding injection rate is the qi
value that would correspond to iqi. The number of
bottomhole pressure values on this card must equal the
number of qi values on the QI card.
3-174 Well Data R5000.0.1

Examples:
BHITAB 1 9400.
QI 1 500 1000 2000 3000 4000 5000 6000 7000 8000
THP 15. 200 500 1000
ITHP BHP(IQI)
1 4304 4297 4276 4219 4134 4017 3854 3681 3471 3219
2 4489 4482 4467 4404 4319 4202 4039 3866 3656 3404
3 4789 4776 4759 4706 4624 4504 4349 4166 3956 3704
4 5289 5272 5249 5186 5106 5004 4859 4679 4456 4204
3.9.5 Additive Correction to BHP Tables (BHPADD)

This card is used in conjunction with the THP, ITUBE, and BHPTAB cards.
The BHPADD card is used to provide an additive correction term to the value of
bottomhole pressure obtained from the BHP tables.
BHPADD wl
bhpadd1 bhpadd2 . . . bhpaddn
Definitions:
wl List of production wells for which bhpadd values are

bhpadd Additive correction to apply to the value of bottomhole

pressure obtained from the BHP tables for the well, psi
(kPa). Value may be positive or negative. Default is 0.0
psia.
NOTE: The number of bhpadd values must equal the number of wells in the well
list.
3.9.6 Artificial Lift Quantity (ALQ)

The ALQ card is used to specify an artificial lift quantity, which can be used as an
additional parameter in the interpolation of the BHPTAB tables. If the ALQ
parameter in the BHPTAB is table for a well is specifically identified as gaslift
GASRATE, then the ALQ data for that well is not required and will not be used if
entered.
ALQ wl
alq1 alq2 ... alqn
Definitions:
R5000.0.1 Well Data 3-175

wl List of production wells for which alq values are being

alq Artificial lift quantity value for the well. Units are
defined by the user. Default is 0.0.
NOTE: The number of alq values must equal the number of wells in the well list.
3.10 Gas Producers

The algorithm for gas producers described below is activated for a well by
assigning a gas producer THP table to the well (GTHPWL card). If this table is not
assigned, the algorithm described in the Wellbore Hydraulics section (Section 3.9)
is used.
The algorithm implemented in VIP-EXECUTIVE for handling tubinghead

pressure constraints for gas producers is based on the "average pressure and
temperature method" as described on pp. 103-104 of Gas Production Operations
by H. Dale Beggs (Reference 1). (Note that the algorithm for tubinghead pressure
constraints for gas and water injectors also is based on this method.) Generally
speaking, the rate and corresponding bottomhole pressure of a constrained well
occurs at the intersection of the inflow and outflow performance curves for the
well. To calculate the flowing bottomhole pressure for the outflow performance
curve:
1. divide the wellbore into equal-length intervals,
2. starting at the wellhead, determine the bottomhole pressure of the first interval
using the input tubinghead pressure constraint and other properties,
3. use the bottomhole pressure of the first interval as the tubinghead pressure of
the second interval to calculate the bottomhole pressure of the second interval,
4. continue this process until the bottomhole pressure of the last interval is
calculated; this is the flowing bottomhole pressure of the well for the outflow
curve.
Properties needed by the "average pressure and temperature method", and their
source in VIP-EXECUTIVE, are as follows:
1. Gas flow rate - constant over entire wellbore.
2. Average temperature - linear interpolation between surface

temperature on GASTHP card and reservoir
temperature TRES.
3. Average z-factor and average viscosity - table lookup in THPGTB table at

interval tubinghead pressure and
temperature.
3-176 Well Data R5000.0.1

4. Inside diameter of tubing and tubing roughness factor - DIAM card
5. Effective tubing length and vertical distance from wellhead to first set of
perforations - TUBE card
NC
·
6. Gas gravity - ∑ ( mol. wt. ) * ( production composition ) ⁄ 28.96
j j
j=1
The TUBE and DIAM cards (Section 3.11.1 and 3.11.2) as described for injectors
must be specified for gas producers that will use tubinghead pressure constraints.
The BHPITN card (Section 3.8.1) may optionally be specified.
3.10.1 Assignment of Gas Producer THP Tables (GTHPWL)
GTHPWL wl
ithgtb1 ithgtb2 . . . ithgtbn
Definitions:
wl List of wells for which tables are being assigned (see

Section 1.5.2).
ithgtb Number of the gas producer THP table (THPGTB card)

that defines the z-factors and viscosities in the wellbore
for this well.
NOTE: The number of ithgtb values must equal the number of wells in the well
list.
3.10.2 Gas Well THP Calculation Data (GASTHP)
⎛ ⎞
GASTHP ⎜ INTERVALS ⎟ (SURFTEMP)(LGRMAX)
⎝ LENGTH ⎠
⎛ intthg ⎞
⎜ ⎟ (stmthg)(lgrmax)
⎝ length ⎠
Definitions:
intthg Number of intervals into which the wellbore length will

be divided. Default is 5.
R5000.0.1 Well Data 3-177

length Approximate length of each interval in the wellbore, ft

(m).
stmthg Surface temperature in the wellbore at the wellhead, °F

(°C). Default is TRES.
lgrmax Maximum allowed liquid-gas ratio for a gas producer

using tubinghead pressure, STB/MMSCF (STM3/
KSM3). Default is 10 STB/MMSCF.
3.10.3 Z-factor/Viscosity Tables for Gas Producer THP (THPGTB)
THPGTB itab
PRESSURE pres1 pres2 . . . presk
(TEMP temp1 (temp2 . . . tempm))
IPRES (ITEMP) Z VISC
ip1 (it1) z1 visc1
. . . .
. . . .
. . . .
ipk (itm) zkm visckm
Definitions:
itab Number of the gas producer THP table being read.
PRESSURE Alpha label indicating that pressure values are read on

this card.
pres Pressure values, psia (kPa). Values can be unequally

spaced.
TEMP Alpha label indicating that temperature values are read

on this card. This card is optional.
temp Temperature values, °F (°C). Values can be unequally

spaced.
IPRES Alpha label indicating that the values read in the column
under this heading are pressure indices.
ITEMP Alpha label indicating that the values read in the column
under this heading are temperature indices. This label can
be included only if a TEMP card was input.
Z Alpha label indicating that the values read in the column

under this heading are z-factors.
VISC Alpha label indicating that the values read in the column
under this heading are viscosities.
3-178 Well Data R5000.0.1

ipk Index referring to the k-th pressure value read.
itm Index referring to the m-th temperature value read. This

index can be included only if a TEMP card was input.
zkm The z-factor value corresponding to the indicated

pressure (and temperature) value(s).
visckm The viscosity value corresponding to the indicated

pressure (and temperature) value(s), cp (cp).
NOTE: If the pressure or temperature values cannot fit on one card, then
continuation cards can be used; that is,
PRESSURE pres1 pres2. . .

... presk
R5000.0.1 Well Data 3-179

3.11 Single Phase Injectors

The algorithm for single phase injectors described below is automatically used for
such a well unless ITUBE data has been input for the well.
The algorithm implemented in VIP-EXECUTIVE for handling tubinghead

pressure constraints for single phase injectors is based on the “average pressure
and temperature method” as described on pp. 103-104 of Gas Production
Operations by H. Dale Beggs (Reference 1).
3.11.1 Tubing Length Assignment (TUBE)

Must be defined if THP data are entered for an injector.
The TUBE data are used in conjunction with the DIAM data to relate tubinghead
pressure to bottomhole pressure.
TUBE wl
tl1 tl2 . . . tln
dzw1 dzw2 . . . dzwn
Definitions:
wl List of wells for which tl and dzw values are being

tl Effective tubing length, ft (m). Includes the equivalent

tubing length of any downhole equipment.
dzw Vertical distance from the wellhead to the first set of

perforations, ft (m).
NOTE: 1. The number of tl and dzw values must equal the number of wells in
the well list.

wdat (see WLWDAT card, Section 3.6.5), which must be measured
3-180 Well Data R5000.0.1

3.11.2 Tubing Diameter/Friction Factor (DIAM)

Must be defined if THP data are entered for an injector.
The DIAM data are used in conjunction with the TUBE data to relate tubinghead
pressure to bottomhole pressure.
DIAM wl
diam1 diam2 . . . diamn
eps1 eps2 . . . epsn
Definitions:
wl List of wells for which diam and eps values are being
diam Inside diameter of the tubing, inches (centimeters).
eps Tubing roughness factor, inches (centimeters).
NOTE: 1. The number of diam and eps values must equal the number of wells
in the well list.
2. Friction factors are calculated by the Jain equation (Reference 3).
3.11.3 Specify Density and Viscosity Values (WTRTHP)

The WTRTHP card applies to water injectors on tubinghead pressure control.
The WTRTHP card is used to specify the density and viscosity values that are
input to the "average pressure and temperature method" for water injectors on
tubinghead pressure control. Internally calculated values are used if this data is
not entered.
WTRTHP wl
DENSITY dens1 dens2 . . . densn
VISCOSITY visc1 visc2 . . . viscn
Definitions:
wl List of water injection wells for which dens and visc

values may be specified (see Section 1.5.2).
DENSITY Alpha label indicating that the following values are water
densities, gm/cc (gm/cc). Default is to compute a value
internally.
R5000.0.1 Well Data 3-181

VISCOSITY Alpha label indicating that the following values are water
viscosities, cp (cp). Default is to use the vw input on the
constants card in VIP-CORE (Section 2.2.4).
NOTE: 1. The number of dens and visc values, if specified, must equal the
2. Both the DENSITY and VISCOSITY cards need not be specified. The
program will accept either one or both.
3.12 Pattern Balancing (Not available in VIP-THERM)
3.12.1 Pattern Balancing Option (PATTN)

The PATTN card is used to specify whether the pattern balancing option is to be
used.
ON
PATTN ATWAG
OFF
Defintions:
ON Alpha label indicating that the pattern balancing option is

to be used.
ATWAG Alpha label indicating that the pattern balancing option

with automatic WAG option is to be used. This option is
currently compatible only with the miscible option.
OFF Alpha label indicating that the pattern balancing option

will not be used. This is the default.
NOTE: The pattern balancing option is not compatible with the following options:
the water voidage replacement option, the gas voidage replacement
option, and the general injection region option.
The PATNCI and PATNPP cards are required to define a pattern. The
NPTNMX parameter on the DIM card is used to define the maximum
number of patterns.
Currently, the ATWAG option is only available with the miscible option.
If the option is chosen, the ATWGVA, ATWGCL, and ATWGCT cards
must also be entered.
3-182 Well Data R5000.0.1

Example:
PATTN ON
3.12.2 Assign Central Injection Wells to a Pattern or Turn Off Pattern

Balancing (PATNCI )
The PATNCI card is used to assign appropriate central injection wells to a pattern.
Each central injection well can only be assigned to one pattern.
⎛ WAG ratio ⎞
PATNCI npn ⎜ ⎟ voidf wl
⎝ ATWAG tcycle ⎠
or
⎛ ⎞
WAG ratio
PATNCI npn ⎜ ⎟ voidf
⎝ ATWAG tcycle ⎠
nw lyrl
(data card may be repeated as necessary)
or
PATNCI npnOFF
Definitions:
npn Pattern number to which the injection wells are assigned.
WAG Alpha label indicating that the injectors in a pattern are a

pair of WAG injectors (one water injector and one gas
injector).
ratio WAG ratio at reservoir conditions.
ATWAG Alpha label indicating that the injector in a pattern is an

automatic WAG (explicit) injector.
tcycle Automatic WAG cycle period, months.
voidf Voidage factor for a pattern. Voidage times voidage

factor is the voidage injection target.
wl List of injection wells for a pattern (see Section 1.5.2).

Production from all layers will be used in the voidage
calculation.
R5000.0.1 Well Data 3-183

nw Injection well number or well name.
lyrl List of layers to be used in the voidage calculation.
OFF Alpha label indicating that the pattern balancing option

for the pattern will be turned off.
NOTE: If the WAG option is selected, two wells, one water injector and one gas
injector, must be specified. Both wells must have the same layers for the
voidage calculation. The calculated voidage target will be distributed to
the WAG injectors according to the WAG ratio.
If the WAG option is not selected and multiple injection wells are assigned
to a pattern, the voidage calculation layers specified for each injector may
not overlap.
The parameter ratio may be set to zero, implying a gas injector only. But
two wells must still be defined.
Example:
PATNCI 1 1.0 2
PATNC I 2 0.8
3 1 -3
4 4 -6
PATNC I 3 OFF
PATNCI 4 WAG 2.0 0.9 1 5
3-184 Well Data R5000.0.1

3.12.3 Assign a Peripheral Production Well and Production Fractions to

Multiple Patterns (PATNPP)
The PATNPP card is used to assign a peripheral production well to multiple
patterns.
PATNPP nw ⎛ EDGE ⎞ ⎛ ALL ⎞

⎝ INNER⎠ ⎝ LIQUID⎠
pnl
(prodf1 prodf2... prodfn)
Definitions:
nw Peripheral production well number or name.
EDGE Alpha label indicating that the producer is a boundary

producer. The summation of the production fractions
over all patterns for each boundary producer must be less
than one.
INNER Alpha label indicating that the producer is an interior

producer. This is the default. The production fractions for
each interior producer must sum up to one over all
patterns.
ALL Alpha label indicating that the pattern’s voidage is

calculated using all three phases. This is the default.
LIQUID Alpha label indicating that the pattern’s voidage is

calculated using liquid only.
pnl List of patterns to which a peripheral productor is being

assigned (see Section 1.5.2).
prodf Production fractions for the production well being used

in pattern’s voidage calculation. For an interior producer,
default is the inverse of the number of patterns to which
the well is assigned. For a boundary producer, production
fractions must be specified.
NOTE: If specified, the number of prodf values must equal the number of
patterns in the pattern list.
The production fractions must be specified when the EDGE option is

used.
If the INNER option is selected and the production fractions for a

production well are not specified, the default fraction for each pattern is
R5000.0.1 Well Data 3-185

the inverse of the number of patterns to which the well is assigned.
Example:
PATNPP 1 EDGE
1
0.25
PATNPP 2 EDGE LIQUID
1 2
2*0.25
PATNPP 3 INNER
1 2 3 4
1 3
0.4 0.6
3.12.4 Same Perforations in Pattern Gas and Water Injectors (WAGPERF)

The WAGPERF card is used to insure that gas and water injectors in a pattern
have the same perforations. If the perforations in only one injector are defined, the
other injector will have the same perforations with the same properties. If the
perforations in both wells do not match, the perforation data in one well (by
default, the water well) is honored. The keyword GASWELL stipulates that the
gas well perforations are to be honored instead.
⎛ OFF ⎞
WAGPERF ⎜ ⎟
⎜ ⎟
⎝ ON ( GASWELL ) ⎠
Definitions:
OFF Alpha label indicating that the same perforation option is

OFF. This is the default if the card is not entered.
ON Alpha label indicating that the same perforation option is

ON, with the water injector being the honored one. This
is the default when WAGPERF with no other parameters
is entered.
GASWELL Alpha label indicating that the gas injector perforation

data is honored, instead of the water injector.
3-186 Well Data R5000.0.1

3.12.5 Voidage Calculation Based on GOR (PTNGOR)

The PTNGOR card is used to activate the option that voidage is to be computed
using liquid phases only if the producer gas-oil ratio is greater than the user-
specified value.
PTNGOR ptngor
Definition:
ptngor Gas-oil ratio, SCF/STB (SM3/STM3). If the producer

gas-oil ratio is greater than ptngor, liquid voidage is to
be used instead of total voidage. Default is to use total
voidage.
3.12.6 Hydrocarbon Volumes and Angles (ATWGVA)

The ATWGVA card is used to assign the hydrocarbon pore volumes and angles
for the wedges between a peripheral producer and pattern injectors. This card
must be input if the automatic WAG option is invoked.
ATWGVA nw
pnl
PIVOL pivol1 pivol2 ... pivoln
PIAGL piagl1 piagl2 ... piagln
Definitions:
nw Peripheral production well number or well name.
pnl List of patterns to which a peripheral producer is being

assigned.
pivol Hydrocarbon volume for the wedge between the

producer and the injector of each pattern on the specified
pattern list, MSCF (SM3).
piagl Wedge angle open to flow at the injector of each pattern

on the specified pattern list, radians.
NOTE: The number of pivol and piagl values must equal the number of patterns
in the pattern list.
R5000.0.1 Well Data 3-187

Example:
ATWGVA 8
1 2
PIVOL 3388000. 6776000.
PIAGL 1.5708 1.5708
3.12.7 MI Injection Target and Allocation Parameters (ATWGCL)

The ATWGCL card is used to specify the total MI injection target for the
automatic WAG option and some user-controlled category allocation control
parameters.
ATWGCL
MITAG mitarg
(PCTFQ pctfq)
(PCTMI nctmi)
(PCTMN nctmn)
Definitions:
mitarg Total MI injection target for all automatic WAG patterns,

MCSF/month (SM3/month).
pctfq Interval at which the allocation of pattern status will be

recalculated, months. Minimum is 4 months.
nctmi Minimum number of allocation intervals a new pattern

should be kept at Very Favorable status.
nctmn Minimum number of allocation intervals a pattern should

be kept at the current status following a status change.
Example:
ATWCGL
MITAG 96000.
PCTFQ 12.
PCTMI 3
PCTMN 2
3-188 Well Data R5000.0.1

3.12.8 Category Definitions and Injection Fractions (ATWGCT)

The ATWGCT card is used to specify fractions of the total throughput for each
category and fraction of the total MI injection target allocated for each category.
ATWGCT
pcttpf1 pcttpf2 pcttpf3
pctmif1 pctmif2 pctmif3
Definitions:
pcttpfi Fractions of the total throughput for the Very Favorable,

Normal, and Less Favorable categories, respectively.
Sum of the three must not exceed 1.0.
pctmifi Fractions of the MI target allocated to the Very

Favorable, Normal, and Less Favorable categories,
respectively. Must sum up to 1.0.
Example:
ATWGCT
0.2 0.5 0.2
0.4 0.5 0.1
NOTE: Each of the automatic WAG patterns is assigned as a Very Favorable (VF),
Normal (N), Less Favorable (LF), or Suspended (S) category based on the
pattern’s returned MI ratio. The VF group is defined as the best patterns
(with lowest returned MI) whose combined throughput rates (reservoir
liquid + gas) total pcttpf1 of the total throughput. This group is allocated
pctmif1 of the targeted MI. A suspended pattern will not receive any MI
allocation.
R5000.0.1 Well Data 3-189

3.13 Non-Darcy Gas Flow (Not available in VIP-THERM)

Two features modelling non-Darcy gas flow near wells are included in the well
model: (1) pressure dependent density and viscosity, and (2) rate dependent well
skin. These two features can be invoked separately.
A pressure dependent gas density and viscosity is specified by the WNDGDV

card.
A rate dependent skin factor can be specified for a well using the WDNDG card
or, for each perforation, using the FPERF card. When the rate dependent skin
factor option is specified, the well index cannot be zero. A well index equal to
zero is a special case which means adjusting the well index to honor both the rate
and bottomhole pressure constraints. In such case, rate dependent skin factor does
not have effective meanings. Thus, as error message will print in the output and
the simulation run will be terminated.
3.13.1 Non-Darcy Gas Density and Viscosity Option (WNDGDV)

The WNDGDV card is used to specify the method for the calculation of pressure
dependent gas density and viscosity for the well model.
PP
WNDGDV RG (relerrndim)
STD
Definitions:
PP Pseudo pressure option.
RG Russel Goodrich option.
STD Standard option. This is the default.
relerr Maximum relative error to be used in the integration of

density to viscosity ratio for pseudo pressure option.
Default maximum relative error is 0.01.
ndim Maximum number of intervals to be used in the

integration is 2(ndim-1). The default ndim is 7; thus the
default maximum number of intervals is 64.
NOTE: The pseudo pressure method uses an integration average between the
gridblock pressure and the wellbore pressure adjusted to the gridblock
depth to calculate density to viscosity ratio. The trapezoidal rule with
Romberg’s extrapolation method is used for the integration.
3-190 Well Data R5000.0.1

The Russell Goodrich method uses an average of the gridblock pressure

and the wellbore pressure adjusted to the gridblock depth to calculate the
injection and production gas density and viscosity.
STD option uses the gridblock pressure to calculate the wellbore viscosity
and density. The bottomhole pressure is not included in the calculation.
Relerr and ndim are used only when the PP option is selected.
Example:
WNDGDV PP 0.005 8
3.13.2 Specify Rate-Dependent Skin Factors for Non-Darcy Gas Flow

(WDNDG)
The WDNDG card is used to specify well rate dependent skin factors for non-
Darcy gas flow.
⎛ INVK ⎞
⎜ ⎟
WDNDG ⎜ INVKH ⎟ wl
⎜ ⎟
⎝ CON ⎠
wd1 wd2 ... wdn
Definitions:
INVK Inverse thickness option is used to allocate the well skin

factor to its perforations. This is the default.
INVKH Inverse thickness-permeability option is used to allocate

the well skin factor to its perforations.
CON Each perforation has the same rate dependent skin factor
(the input wd value).
wl List of wells for which wd values are being entered (see

Section 1.5.2).
wd Rate dependent skin factor, D/MSCF (D/SM3).
NOTE: The number of wd values must equal the number of wells in the well list.
The perforation skin factors are calculated from the input well skin factor.
When new perforation information is specified in the FPERF card, the
program recalculates the skin factor for each perforation.
Example:
R5000.0.1 Well Data 3-191

WDNDG 1 -5
5*0.001
3.14 Automatic Recompletion Units
3.14.1 Recompletion Unit Status and Limit Data (RCMPPERF)

The RCMPPERF card is used to define the automatic recompletion units for
wells. A TSTPRF card must be active for this option to be operational.
⎛ SHUTIN ⎞
RCMPPERF ⎜ ⎟
⎝ NOSHUTIN ⎠
WELL RCMPUNT(other headings)
nw unit(other data)
(Data cards are repeated as necessary to describe all the
units for each applicable well.)
Definitions:
WELL Column heading for nw - the well number which must be

entered for each data card. For multiple units in the single
well the alpha label X can be substituted for the well
number on each data card after the first.
RCMPUNT Column heading for unit - a recompletion unit for this

well. Values must lie between 1 and the largest unit
number specified for this well on the FPERF card.
SHUTIN Keyword indicating that if a well is about to be shutin for

reasons such as minimum rate or no BHPTAB
intersection, and if a unit with status AUTO is available,
open that unit instead of shutting in the well.
NOSHUTIN Keyword indicating that, even if a unit with status AUTO

is available, continue with the well shutin process. This is
the default.
STATUS Column heading for status - the producing status of the

performations in this unit. The possible values are:
OPEN Perforations are open to production (i.e.,

perforation status remains unchanged).
This is the default.
AUTO Perforations are currently closed. The

unit is eligible to be opened when an
open unit is shut for limit violations.
3-192 Well Data R5000.0.1

SHUT Perforations are closed. They can be

opened only by subsequent RCMPPERF
data.
OILMIN Column heading for oilmin - minimum total oil rate for a
unit, STB/D (STM3/D). A violation causes the
perforations in the unit to be closed and another unit (if
available) to be opened. Default is 0.
GASMIN Column heading for gasmin - minimum total gas rate for
a unit, MSCF/D (SM3/D). A violation causes the
available) to be opened. Default is 0.
GASMAX Column heading for gasmax - maximum total gas rate

for a unit, MSCF/D (SM3/D). A violation causes the
available) to be opened. Default is 1.E20.
WTRMAX Column heading for wtrmax - maximum total water rate

for a unit, STB/D (STM3/D). A violation causes the
available) to be opened. Default is 1.E20.
GORMAX Column heading for gormax - maximum total gas-oil

ratio for a unit, SCF/STB (SM3/STM3). A violation
causes the perforations in the unit to be closed and
another unit (if available) to be opened. Default is 1.E20.
GLRMAX Column heading for glrmax - maximum total gas-liquid

ratio for a unit, SCF/STB (SM3/STM3). A violation
causes the perforations in the unit to be closed and
another unit (if available) to be opened. Default is 1.E20.
LGRMAX Column heading for lgrmax - maximum total liquid-gas

ratio for a unit, STB/MMSCF (STM3/KSM3). A
violation causes the perforations in the unit to be closed
and another unit (if available) to be opened. Default is
1.E20.
WCTMAX Column heading for wctmax - maximum total water-cut

for a unit, fraction. A violation causes the perforations in
the unit to be closed and another unit (if available) to be
opened. Default is 1.
DPBHMX Column heading for dpbhmx - maximum drawdown

constraint for a unit, psia (kPa). A violation causes the
available) to be opened. Default is to not check this
constraint.
R5000.0.1 Well Data 3-193

TABLE Column heading for ibhptb - BHP table number to use

for the well when this unit is opened. Default is to not
change the table number.
STMMAX Column heading, in VIP-THERM only, for stmmax-

maximum total steam rate for a unit, STB/D (STM3/D).
A violation causes the perforations in the unit to be
closed and another unit, if available, to be opened.
Default is I.E.20.
SORMAX Column heading, in VIP-THERM only, for SORMAX-

maximum total steam-oil ratio for a unit, STB(CWE)/
STB (STM3(CWE)/STM3). A violation causes the
perforations in the unit to be closed and another unit, if
available, to be opened. Default is I.E.20.
NOTE: This data may only be specified if the dimension nrcmun is greater than
zero.
At least one of the other headings must appear on the title card along with
the WELL and RCMPUNT headings.
Any number of the other headings may be specified, up to and including

all of them. For any unspecified status or limit, the previously input value
or the default value will be used.
The recompletion unit number must be less than or equal to the maximum
unit number specified for the well on the FPERF card.
Example:
RCMPPERF
WELL RCMPUNT WCTMAX STATUS
OILMIN
1 1 0.95 OPEN
100.0
X 2 0.90 AUTO
100.0
X 3 0.95 AUTO
100.0
X 4 0.95 AUTO
100.0
X 5 0.99 AUTO
100.0
2 1 0.85 OPEN
100.0
X 2 0.85 AUTO
100.0
X 3 0.85 AUTO
3-194 Well Data R5000.0.1

100.0
X 4 0.85 AUTO
100.0
3.14.2 Order for Opening Recompletion Units (RCMPOR)

The RCMPOR card is used to define the order in which recompletion units should
be considered for opening.
RCMPOR wl
iu1 iu2 ... iuk
Definitions:
wl List of wells to which this unit order list applies (see see
Section 1.5.2).
iu Order in which the recompletion units should be

considered for opening when a currently open unit is
closed for a limit violation.
NOTE: This data may only be specified if the dimension nrcmun is greater than
zero.
A unit number may not be specified more than once in the list.
The unit number must be less than or equal to the maximum unit number
specified for the well on the FPERF card.
An order list must be specified for a well if any units with status AUTO
are to be opened.
Example:
RCMPOR 1 5
1 2 3 4 5
R5000.0.1 Well Data 3-195

3.15 WAG (Water-Alternating-Gas) Wells
3.15.1 WAG Injection Well Definition (WAG)

A WAG card must precede a QMAXWG card for WAG injectors.
⎛ STD ⎞ ⎛ GATHER ⎞
⎜ ⎟ ⎜ ⎟
WAG ⎜ RES ⎟ ⎜ FLOSTA ⎟ (KEYCMP)cwinjcginjncycle(GFIRST) ( GLAST ) wl
⎜ ⎟
FSTD ⎟
⎜ AREA
⎟ ( SHUTIN )
⎜ ⎜ ⎟
⎝ FRES ⎠ ⎝ FIELD ⎠
cwinji cginji
( INITSLUG )
X X
Definitions:
STD Standard conditions, STB/D (STM3/D) for water injectors,

MSCF/D (SM3/D) for gas injectors. This is the default.
FSTD A fraction of the total surface production rate of the injected

phase within a specified level of the well management hier-
archy (see below).
FRES A fraction of the total fluid withdrawal (at reservoir condi-

tions) within a specified level of the well management hier-
archy (see below).
upon which replacement is based may be specified. The well management level
may also be specified for MI injectors with STD or RES specification to identify
the level upon which the MI composition determined from the MI plant in the
major gas sales option is to be used for the injection composition. In this case,
YINJ cards for MI injectors should be omitted and the MI plant calculation for the
selected well management level must be invoked (see PLANT card in Section
4.5). The well management levels are:
GATHER Gathering Center. This is the default for FSTD or FRES

specification.
AREA Area.
FIELD Field. This is the default for STD and RES specification
with MI plant in the major gas sales option.
3-196 Well Data R5000.0.1

If a gas conditioning plant in the major gas sales option is present, and keyword
DIST is specified in the GASCOND card, a portion of the FSTD gas injectors
may be assigned to receive the key component (component icomp in the
GASCOND card) removed from the sales gas stream using the following
keywords:
KEYCMP Alpha label indicating that the key component stream

removed from the sales gas in the gas conditioning plant
will be injected into the gas injectors specified in this WAG
card. These gas injectors must be specified as FSTD injec-
tors and a GASCOND card with keyword DIST must also
be specified.
cwinj Cumulative water injection volume per cycle, in standard

units, STB (STM3), if either STD or FSTD is specified; in
reservoir units, rb, if either RES or FRES is specified. There
is no default value.
cginj Cumulative gas injection volume per cycle, in standard

units, MSCF (SM3), if either STD or FSTD is specified; in
reservoir units, rb, if either RES or FRES is specified. There
is no default value.
ncycle Total number of WAG cycles to be simulated. There is no

default value.
GFIRST Alpha label indicating that the WAG cycling starts with gas
injection. Default is water to be injected first.
GLAST Alpha label indicating that after the WAG cycling, injectors
defined on this card will be switched to a gas injector.
Default is the wells will be switched to a water injector.
SHUTIN Alpha label indicating that after the WAG cycling, injectors
defined on this card will be shut-in. Default is the wells will
be switched to a water injector.
wl List of all injection wells with rates specified in this manner

INITSLUG Alpha label indicating that initial slug sizes are being
entered. When this card is omitted, the cwinj and cginj
from the WAG card are used for all slug sizes.
cwinji Initial water slug size, in standard units, STB (STM3), if

either STD or FSTD is specified; in reservoir units, rb, if
either RES or FRES is specified. Enter the alpha label X if
this value should be the same as cwinj from the WAG card.
cginji Initial gas slug size, in standard units, MSCF (SM3), if

either STD or FSTD is specified; in reservoir units, rb, if
either RES or FRES is specified. Enter the alpha label X if
this value should be the same as cginj from the WAG card.
NOTE: 1. Optionally, exactly one of the labels STD, RES, FSTD, and FRES
R5000.0.1 Well Data 3-197

may be specified. If none is specified, STD is the default.
2. Optionally, if either FSTD or FRES is specified, exactly one of the

labels GATHER, FLOSTA, AREA, and FIELD may be specified. If
none is specified, GATHER is the default.
3. Optionally, if either STD or RES is specified and the major gas sales
option (with MI plants) for a well management level is invoked, the
well management level (label GATHER, FLOSTA, AREA, or FIELD)
may be specified to identify the level upon which the calculated MI
composition from the MI plant is to be used as the injection
composition. In this case, the injection composition (YINJ card) may
be omitted (the input of YINJ card will cause the calculated MI
composition to be ignored). If none is specified, FIELD is the default.
4. When a production well is converted to an injection well, any

previously input WLIMIT, GLIMIT, or QMIN data will be ignored,
and the ECOLIM unit will be set to the injection phase. Also, if the
producer’s bhp value is the default value 0 psia, then the bhp value
will be changed to 10,000 psia. Otherwise, previously input BHP or
5. Anytime a WAG injection well is specified or respecified as either

STD or RES, and the wells are not to be identified as MI wells (with
MI plant in the major gas sales option), the composition of the
injected gas must be defined using the YINJ card.
6. Optionally, if an FSTD WAG injection well is specified and a

GASCOND card with keyword DIST is also present, keyword
KEYCMP may be specified.
7. Specifying a WAG card for a shut-in well will cause the well to be
“turned back on”.
8. For WAG injectors, values of cwinj, cginj, and ncycle must be

specified. The simulator will automatically switch the wells between
water injection and gas injection based on the user specified
cumulative injection volumes per cycle (cwinj & cginj). The WAG
cycling may either start with water injection (default) or gas injection
(if GFIRST is specified). After ncycle cycles, the wells will be
switched to regular water injectors (default), or regular gas injectors
(if GLAST is specified), or shut-in wells (if SHUTIN is specified).
For WAG injectors, QMAXWG cards must be used to specify both
the maximum water injection rate and the gas injection rate (i.e.,
QMAX cards are omitted and replaced by QMAXWG cards).
Optionally, a WAG well may have the same bhp and wdat values
(using a standard BHP card) or different bhp and wdat values (using
a BHPWAG card) or water and gas injection. The user may also
specify the first timestep size after each changeover through a
DTWAG card.
Example:
WAG FSTD FIELD 300000. 450000. 30 GFIRST SHUTIN 21 -30
3-198 Well Data R5000.0.1

3.15.2 Maximum Rates for WAG Injectors (QMAXWG)

Must be preceded by a WAG card.
The QMAXWG card defines the maximum water and gas injection rates a WAG
injector is allowed to inject.
QMAXWG wl
qmaxw1 qmaxw2 ... qmaxwn
qmaxg1 qmaxg2 ... qmaxgn
Definitions:
wl List of wells for which qmaxw and qmaxg values are

qmaxw Maximum water injection rate at which the WAG injector is

allowed to inject. Units are determined by the WAG card.
There is no default.
qmaxg Maximum gas injection rate at which the WAG injector is

allowed to inject. Units are determined by the WAG card.
NOTE: 1. During water injection, the WAG well injects at a rate of qmaxw
unless this causes a violation of one of the other constraints defined
by the user. Similarly, the WAG well injects at a rate of qmaxg
during gas injection unless this causes a violation of one of the other
constraints defined by the user. In these events, the constraint is
observed, which causes a rate reduction.
2. The number of qmaxw and qmaxg values must equal the number of
wells in the well list.
3. For the FSTD injection option, qmaxw or qmaxg is the fraction of the
total surface production rate of the injected phase within the
appropriate level. For the FRES injection option, qmaxw or qmaxg
is the fraction of the total reservoir volume production rate within the
appropriate level.
4. For WAG injectors (WAG card), the QMAXWG card must be used and
the QMAX card must be omitted.
Example:
C
WAG STD 300000. 450000. 30 21 -30
QMAXWG 21 -30
5*5000. 5*7000.
5*12000. 5*15000.
R5000.0.1 Well Data 3-199

3.15.3 Bottomhole Pressure for WAG Injectors (BHPWAG)

To invoke BHPWAG constraints, the user must define a productivity/injectivity
index (Section 3.6).
The BHPWAG card allows the user to define separate limiting bottomhole
pressures during water and gas injection for WAG injectors.
BHPWAG wl
bhpw1 bhpw2 ... bhpwn
wdatw1 wdatw2 ... wdatwn
bhpg1 bhpg2 ... bhpgn
wdatg1 wdatg2 ... wdatgn
Definitions:
wl List of wells for which bhpw, wdatw, bhpg, and wdatg

bhpw Limiting bottomhole pressure for a WAG injector during

water injection, psia (kPa); i.e., maximum allowed pressure
for a WAG injector during water injection. Default is
10,000 psia.
wdatw Depth to which the limiting bottomhole pressure, bhpw, is

referenced, ft (m).
bhpg Limiting bottomhole pressure for a WAG injector during

gas injection, psia (kPa); i.e., maximum allowed pressure
for a WAG injector during gas injection. Default is 10,000
psia.
wdatg Depth to which the limiting bottomhole pressure, bhpg, is

referenced, ft (m).
NOTE: 1. The number of bhpw, wdatw, bhpg, and wdatg values must equal
the number of wells in the well list.
2. For WAG injectors, BHP and/or WLWDAT cards may be entered

instead of BHPWAG cards. If a BHP card is entered, the same
bhp values will be used for water and gas injection. If a
WLWDAT card is entered, the same wdat values will be used
for water and gas injection.
Example:
C Specify bhp for WAG Injectors

BHPWAG 1 -150
150*5000.
150*8800.
3-200 Well Data R5000.0.1

150*4500.
150*8800.
3.15.4 Injection Temperature for WAG injectors (TINJWAG, VIP-THERM Only)

The TINJWAG card allows the user to define separate injection temperatures
during water and gas injection for WAG injectors in VIP-THERM. Steam quality
and injection pressure for water injection are specified with the QUAL and PINJ
cards as for standard injectors.
TINJWAG wl
tinjw1 tinjw2 ... tinjwn
tinjg1 tinjg2 ... tinjgn
Definitions:
wl List of wells for which tinjw and tinjg are being specified
tinjw Injection temperature for water injection, degrees F

(degrees C).
tinjg Injection temperature for gas injection, degrees F (degrees

C).
3.15.5 Timestep Controls for WAG Injectors (DTWAG)

The DTWAG card defines the maximum first timestep sizes following each
changeover for WAG injectors specified in the WAG card.
DTWAG dtwtr dtgas
Definitions:
dtwtr The maximum first timestep size (days) following the

changeover from gas injection to water injection for WAG
injectors, days.
dtgas The maximum first timestep size (days) following the

changeover from water injection to gas injection for WAG
injectors, days.
Example:
DTWAG 1.5 1.0
R5000.0.1 Well Data 3-201

3.16 WBSIM (Gridded Wellbore) Well Definition (Not Available in

VIP-THERM)
Horizontal flow into the wellbore (first vertical column of gridblocks) is
calculated through normal Darcy radial flow equations, with the addition of an
optional skin factor to adjust the transmissivity from gridblock 2 to gridblock 1 in
the perforated layer. The keyword, COMPERF, is used to define the
"perforations", which will then actually replace the reservoir transport terms for
flow between gridblock 2 (reservoir) and gridblock 1 (wellbore) for the specified
layers. The initial setup is to have no perforations at time zero. Perforations can
be changed at any time in the simulator through the use of this keyword input. It is
important to note that each set of COMPERF data are modifications to the
perforations, and are not complete replacements. They may be entered any
number of times throughout the simulator time.
3.16.1 WBSIM Well Perforations (COMPERF)
COMPERFcorrel (rough)(diam) (vcmult)(rdamp) (card 1)

[K]
[H]
L [KH] (SKIN) (LEN) (ROUGH) (DIAM) (card 2)
[K H]
[k]
[h]
l [kh] (skin) (len) (rough) (diam) (card 3)
[k h]
[Repeat data card as necessary for subsequent perforations.]
Although the last four variables are optional, they are position dependent, such
that if a variable is to be introduced, all of the variables before it must also be
introduced.
3-202 Well Data R5000.0.1

Definitions:
correl Name of the two-phase wellbore flow correlation to be

used. This must always be specified. The options are:
NOSLIPNo phase slippage considered.
HAGEDOHagedorn and Brown
DUNROSDunns and Ross
BEGGSBeggs and Brill
AZIZAziz, Govier, Fogarasi
ORKISZOrkiszewski
GRIFFIGriffith, Lau, Hon, Pearson
rough Optional wellbore roughness, ft(m). If entered as -1., it

will not be used. Otherwise, every interval [layer] in the
wellbore will be set to this value.
diam Optional wellbore diameter, ft(m). If entered as -1., it will

not be used. Otherwise, every interval [layer] in the
wellbore will be set to this value.
vcmult Optional scale factor for the Turner minimum gas flow
velocity necessary to lift liquid drops. Default value is
1.0.
rdamp Optional damping factor for phase migration at velocities

below the minimum lift velocity. Default is 1.0. At
upward flow velocities less than the minimum lift
velocity, the mixture density gradient is replaced by the
following damped liquid and vapor phase gradients in the
respective phase potentials.
vc – v
ρ ml = ρ m + ( ρ l – ρ m ) ⋅ ⎛ ------------------------------------------------
-⎞
⎝ v c + ( rdamp – 1 ) ⋅ v⎠
vc – v
ρ mg = ρ m + ( ρ g – ρ m ) ⋅ ⎛ ------------------------------------------------
-⎞
⎝ v c + ( rdamp – 1 ) ⋅ v⎠
Immediately following the COMPERF data entry line there must be another line
of keywords defining the types of data that will be entered next in redefining the
wellbore ’perforations’.
R5000.0.1 Well Data 3-203

Definitions:
L Column heading for l, the layer number for which this

perforation data applies.
K Column heading for k, the permeability of this

perforation, md.
H Column heading for h, the thickness of this perforation,

ft(m).
KH Column heading for kh, the permeability-thickness

product of this perforation, md-ft(md-m).
SKIN Column heading for skin, the skin factor for this
perforation.
LEN Column heading for len, the actual wellbore length

within this layer, ft(m).
ROUGH Column heading for rough, the wellbore roughness,

ft(m).
DIAM Column heading for diam, the wellbore diameter within

this layer, ft(m).
3-204 Well Data R5000.0.1

3.16.2 Dynamic Vertical Flow Transport Parameters Calculation

All vertical flow transport parameters for the first column of gridblocks (wellbore)
are calculated dynamically for each timestep, with special treatment for the phase
mobilities. These calculations are as follows :
■ Phase mobilities for flow in the wellbore are based on the mixture viscosity,
instead of the phase viscosity.
■ If the gas flow velocity is greater than the minimum gas lift velocity, the
gravity gradients in the wellbore are based on the mixture density, instead of
the individual phase densities. If the gas flow velocity is less than the
minimum gas lift velocity, the damped phase gradients are used instead of the
individual phase gradients.
■ The pressure drop in the wellbore can be described as the sum of the pressure
drops due to friction, gravity, and kinetic energy. The kinetic energy pressure
loss is usually quite small and is neglected. At the start of each timestep, the
gas and liquid superficial velocities are calculated based on the converged
conditions at the end of the previous timestep. From this, the Reynold’s
number and friction factor are calculated for each segment from the specified
correlation, after which the average mixture velocity and then the equivalent
Darcy velocity are calculated. The effective wellbore vertical permeability
(Kwe) is then calculated, and held constant over the timestep.
■ Phase "relative permeabilities" in the wellbore are set equal to the phase
saturations, with the exception that krg = α * Sg, where α is slippage factor
greater than or equal to 1.0, which allows the gas phase to flow at an equal or
greater velocity than the liquid phase. The slippage is obtained from the
specified correlation.
R5000.0.1 Well Data 3-205

3.17 Automatic Cycle Control (VIP-THERM)
NOTE: Note: An AUTOCYCLE card must be entered in the utility data to

use this option.
This option is designed to dramatically reduce the user effort required to make
predictive runs for cyclic steam operations,when the schedules of the well cycles
are controlled by measurable conditions. However,it is implemented in general
such that any process involving wells alternating between injection and
production can be automatically controlled.
Wells are automatically switched between injection and production based on a

user-selected set of available constraints. Each cycle consists of an injection, a
soak, and a production phase. The order of the cycle phases may be specified, i.e.
cycles may be defined as injection/soak/production or as production/injection/
soak. The latter allows automatic control of the length of a primary production
period, since all switching and well constraints may be specified by cycle.
A VIP-EXEC Autocycle report is automatically written to the output file on each

status change (start, stop, phase switching, abort,etc.) for each cyclic well, which
gives well status, action taken, and the reason for the action taken. For output
purposes, the time at the end of any cyclic wells' injection or production phase
(tcpe, which is computed as described in the following sections) is treated as if a
TIME/DATE card were entered at tcpe. For example, a PRINT WELLS TIME
card will result in well summaries printed to the output file at the end of each
injection or production phase for any cyclic well. A PRINT WELLS TNEXT
card will apply only at the first subsequent time at which a cyclic wells' injection
or production phase ends, or at the next input TIME/DATE card, whichever
occurs first.
Required data (CYCLETABLE, CYCLIC and CSTART) and optional data

(CSTOP and CPERF) are described in the following sections.
3.17.1 Cycle Tables (CYCLETABLE)

Each cycle table is assigned a cycle table number. Wells are defined as cyclic and
assigned to cycle table numbers with the CYCLIC card as defined in the next
section.
The cycle table specifies the well types of the injector (CINJ card and producer
(CPROD card), the constraints to be used for switching from injection to (soak/)
production (ITOP card), the constraints to be used for switching from production
to injection (PTOI card), and the values of the switching constraints and well
constraints (CYCLE data). Optionally, constraints for aborting cyclic injection/
production may be entered (ABORT card), which if violated result in shutting the
well in.
3-206 Well Data R5000.0.1

CYCLETABLE (PFIRST) ict

CINJ W STD GATHER
G RES FLOSTA
FSTDAREA
FRES FIELD
CPROD W STD
O RES
G MOLES
ALL
LIQUID
ITOP A IPLABEL1 A IPLABEL2 ... A IPLABELnip
O O O
PTOI A PILABEL1 A PILABEL2 ... A PILABELnip
O O O
(ABORT ALABEL1 ALABEL2 ... ALABELna)
CYCLE DTSOAK QMAXI BHPI DEPI (TINJ) (QUAL) (PINJ) QMAXP BHPP DEPP SLABELS
1 dtsoak qmaxi bhpi depi (tinj) (qual) (pinj) qmaxp bhpp depp sl(ns)
( 2 dtsoak qmaxi bhpi depi (tinj) (qual) (pinj) qmaxp bhpp depp sl(ns) )
( . . . . . . . . . . . . )
( . . . . . . . . . . . . )
(ncyc dtsoak qmaxi bhpi depi (tinj) (qual) (pinj) qmaxp bhpp depp sl(ns) )
Definitions: (the constraint values in the CYCLE data, shown in lower case, are
defined along with their corresponding alpha labels)
PFIRST Alpha label indicating that the cycle phase order is

injection/soak. The default order is injection/soak/
production.
ict Cycle table number.
CINJ card Alpha labels specifying the injector well type for the
cyclic well(s) assigned to this table. See Section 3.4.2
(INJ card) for label definitions.
CPROD card Alpha labels specifying the producer well type for the
cyclic well(s) assigned to this table. See Section 3.4.1
(PROD card) for label definitions.
ITOP Alpha label indicating that the following alpha labels

define the constraints to be used for switching from
injection to (soak/)production. The subscriptsshown in
the format do not appear in the data deck.
R5000.0.1 Well Data 3-207

A, O Each switching constraint label on the ITOP card must be

preceded by an A or an O. A indicates 'and', and O
indicates 'or'. Switching will occur if all of the 'and'
constraints are violated or if any of the 'or' constraints are
violated.
nip The number of ITOP constraints specified. May be any

number greater than zero and less than or equal to 4.
IPLABELn Any of the following alpha labels, for n equals 1 to nip,

defining constraints to be used for switching from
injection to (soak/)production;
Switch if (and/or):
QMINI Injection rate is less than or equal to qmini, STB/D

(STM3/D) for water injectors or MSCF/D (SM3 D) for
gas injectors.
CMAX Cumulative injection is greater than or equal to cmax,

MSTB (KSTM3) for water injectors or MMSCF (KSM3)
for gas injectors.
DTMINI Injection phase length is greater than or equal to dtmini,

Days.
DTMAXI Injection phase length is equal to dtmaxi, Days.
PTOI Alpha label indicating that the following alpha labels

define the constraints to be used for switching from
production to injection. The subscripts shown in the
format do not appear in the data deck.
A, O Each switching constraint label on the PTOI card must be

preceded by an A or an O. A indicates 'and', and O
indicates 'or'. Switching will occur if all of the 'and'
constraints are violated or if any of the 'or' constraints are
violated.
npi The number of PTOI constraints specified. May be any

number greater than zero and less than or equal to 8.
PILABELn Any of the following alpha labels, for n equals 1 to npi,

defining constraints to be used for switching from
production to injection;
Switch if (and/or):
QOMIN Oil production rate is less than or equal to qomin, STB/D

(STM3/D).
QGMIN Gas production rate is less than or equal to qgmin,

MSCF/D (SM3/D).
3-208 Well Data R5000.0.1

WCMAX Water cut is greater than or equal to wcmax, fraction.

Note that the water cut includes all produced steam in
VIP-THERM.
OIRMAX Ratio of cumulative produced oil in production phase to

cumulative injection in previous injection phase is
greater than or equal to oirmax, MSTB/MSTB CWE
(KSTM3/KSTM3 CWE) for CINJ W or MSTB/MMSCF
(KSTM3/KSM3) for CINJ G.
GIRMAX Ratio of cumulative produced gas in production phase to

cumulative injection in previous injection phase is
greater than or equal to girmax, MMSCF/MSTB CWE
(KSM3/KSTM3 CWE) for CINJ W or MMSCF/MMSCF
(KSM3/KSM3) for CINJ G.
TMIN Average wellblock temperature is less than or equal to

tmin, degrees F (degrees C). Allowed in VIP-THERM
only
DTMINP Production phase length is greater than or equal to

dtmini, Days.
DTMAXP Production phase length is equal to dtmaxi, Days.
na Number of abort constraint labels specified on the

ABORT card.
ABORT Alpha label indicating that the na alpha labels which

follow define the constraints to be used for aborting the
cycles, shutting the well in. All abort constraints except
for DTMXPA are checked at the end of each each
production phase.
ALABELn Any of the following alpha labels, for n equals 1 to na:
DTMXPA Abort if production phase length is greater than or equal

to dtmxpa.
QOAPMN Abort if average oil production rate over the last set of
injection/soak/production phases is less than or equal to
qoapmn, STB/D (STM3/D).
QGAPMN Abort if average gas production rate over the last set of
injection/soak/production phases is less than or equal to
qgapmn, MSCF/D (SM3/D).
WCAVMX Abort if average water cut in the production phase

(cumulative water produced / cumulative water produced
+ cumulative oil produced) is greater than or equal to
wcavmx, STB/STB (STM3/STM3).
R5000.0.1 Well Data 3-209

OIRMIN Abort if ratio of cumulative oil produced in production

phase to cumulative injection in previous injection phase
is less than or equal to oirmin, STB/STB (STM3/STM3)
for CINJ W or STB/MSCF (STM3/SM3) for CINJ G.
This is referred to as the oil-steam ratio (OSR) in cyclic
steam operations.
GIRMIN Abort if ratio of cumulative gas produced in production

phase to cumulative injection in previous injection phase
is less than or equal to girmin, MMSCF/MSTB (KSM3/
KSTM3) for CINJ W or STB/MSCF (KSM3/KSM3) for
CINJ G.
ns The total number of constraint labels specified on ITOP,

PTOI, and ABORT cards, ns = nip + npi + na.
CYCLE First alpha label on column header card containing alpha

labels for all required well constraints and containing the
set of all ns alpha labels for constraints specified on
ITOP, PTOI, and ABORT cards (SLABELS).
DTSOAK Column header for length of soak phase dtsoak, Days.

Required.
QMAXI Column header for maximum injection rate qmaxi. Units

are determined by the CINJ card.
Required.
BHPI Column header for maximum bottomhole pressure during

injection bhpi, psia (kPa).
Required.
DEPI Column header for reference depth corresponding to

bhpi, depi, ft (m).
Required.
TINJ Column header for injection temperature tinj, degrees F

(degrees C). Required in VIP-THERM, not allowed
otherwise.
QUAL Column header for injected steam quality qual, mass

fraction steam. Required in VIP-THERM with CINJ W,
not allowed otherwise.
PINJ Column header for injected steam pressure pinj, psia

(kPa). Required in VIP-THERM with CINJ W when any
cycle value for qual is equal to zero or one, not allowed
otherwise.
QMAXP Column header for maximum production rate. Units are

determined by the CPROD card. Required.
3-210 Well Data R5000.0.1

BHPP Column header for maximum bottomhole pressure

during production bhpp, psia (kPa).
Required.
DEPP Column header for reference depth corresponding to

bhpp, depp, ft (m).
Required.
ncyc The number of cycles for which data are specified. If

equal to one, then the data are constant for all cycles. If
greater than one, then NCYCMX must be specified on
the DIM card.
sl(ns) The values of the ns switching constraints, defined above

with their corresponding alpha labels.
NOTE: 1. Any number (greater than zero) of ITOP, PTOI, and ABORT constraint
labels may be entered in any order. Columns may be defined on the
CYCLE card in any order.
2. The program is dimensioned for a maximum of 10 cycle tables and for

a maximum of 1 cycle entry per cyclic table (ncyc = 1). These dimensions
may be changed through specification of NCYCTM and NCYCMX on the
DIM card.
3. Timestep size will be modified in order to exactly satisfy the

DTSOAK, O DTMINI, O DTMAXI, O DTMINP, and O DTMAXP
switching constraints. It is also modified to exactly satisfy the 'A' DT
constraints if all of the other 'A' constraints are satisfied at the time the
timestep size is computed. Timestep size is not altered to attempt to satisfy
any of the other switching constraints exactly; they are simply checked for
violation at the beginning of each timestep. Therefore, the maximum
timestep size should not be greater than the maximum allowable error in
the predicted lengths of the cycle phases, unless the phase lengths are
controlled only by time constraints.
4. Other well constraints not included in the cycle table and described in
Section 3.5, for example WLIMIT, GLIMIT, PRFLIM, YINJ, QSTMX,
and GORPEN, may also be entered as desired or required (YINJ is
required for cyclic gas injectors), and they apply to the appropriate cycle
phase.
5. Options for treatment of production and injection wells described in

Section 3.4, such as WINJMOB, GINJMOB, ITNSTP, ITNSTQ, and
ITNGRE may be entered as desired and apply to the appropriate cycle
phase.
6. Cycling of any well will be automatically aborted for any well in which
the cumulative injection in an injection phase, or the cumulative oil and
gas production in a production phase, is zero.
7. If all defined wells are cyclic, then the run will be automatically
R5000.0.1 Well Data 3-211

terminated after the cycling of all wells have either finished (completed
the specified maximum number of cycles in the CYCLIC data), been
aborted, or been stopped (CSTOP card).
3.17.2 Cyclic Well Definition (CYCLIC)

Cyclic wells are defined with the CYCLIC card analogously to definitions of
other well types with the PROD, INJ, or WAG cards. Their locations and
perforations are defined as for all wells by WELL and FPERF cards. Subsets of
the total number of perforations defined on the FPERF card may be defined as
open to injection or open to production using the CPERF card as described in the
next section.
Wells specified on the CYCLE card are assigned to cycle tables and are assigned a
maximum number of cycles to complete.
CYCLIC wl
ict1 ict2 ... ictn
ncyc1 ncyc2 ... ncycn
Definitions:
wl List of wells for which values are being specified (see

Section 1.5.2).
ict Cycle table number.
ncyc Maximum number of cycles to perform.
NOTE: 1. QMAX, QMIN, ECOLIM, BHP, TINJ, QUAL, and PINJ cards should
be omitted for cyclic wells. These constraints are represented in the cycle
table.
2. Wells completing the specified maximum number of cycles are shut in.
3. The cycle table must be defined before a well is assigned to it.
3.17.3 Cycle Phase Perforation Status (CPERF)
NOTE: FPERF and CYCLIC data must precede CPERF data.
All perforations open to either injection or production are specified on the FPERF
card. The CPERF card may optionally be used to define the subset of total
perforations open to injection and to production, either statically or by cycle
number. If the number of cycles for which data is specified, ncyc, is equal to one,
3-212 Well Data R5000.0.1

then the data are constant for all cycles. All wells in the well list on a single
CPERF card must contain the same number of perforations. A single set of
perforation status values are specified which apply to all wells in the well list.
CPERF wl
1 i1 i2 ...
inp
X p1 p2 ...
pnp
( 2 i1 i2 ...
inp )
( X p1 p2 ...
pnp )
( . )
( . )
( ncyc i1 i2 ... inp )
( X p1 p2 ... pnp )
Definitions:
wl List of wells for which values are being specified (see

Section 1.5.2).
np The number of perforations per well.
ncyc The number of cycles for which dataare specified. If

equal to 1, then the data are constant for all cycles. If
greater than one, then NCYCMX must be specified on
the DIM card.
X Alpha label indicating productionperforation status

values follow for the cycle number defined on the
previous card.
i1 i2 .. inp Status for each of the np perforationsfor the cycle

injection phase in order of their definition on the FPERF
card. A value of 0 indicates closed, a value of 1 indicates
open.
p1 p2 .. pnp Status for each of the np perforations for the cycle

production phase in order of their definition on the
FPERF card. A value of 0 indicates closed, a value of 1
indicates open.
R5000.0.1 Well Data 3-213

NOTE: 1. The program is dimensioned by default for a maximum value of ncyc

of 1. This value may be changed with the NCYCMX parameter on the
DIM card.
2. If it is desired to change any of the FPERF data by cycle phase for

perforations which are open to both injection and production, then two
perforations should be defined in the same location in the FPERF data,
with injection properties assigned to one and production properties
assigned to the other. The CPERF card can then be used to inject with
injection perforation values and to produce with production perforation
values.
3. If a well using the CPERF option is reperforated with an FPERF card,

the status values are all reset to open. CPERF data may be re-entered after
the FPERF data.
3.17.4 Start Cycle (CSTART)

The CSTART card must follow all CYCLETABLE and CYCLIC data and
initiates the cycles by well or for all cyclic wells in the specified well management
levels. Optionally, cycling in the wells or well management levels may be
specified as starting after completion of all cycling in another well or well
management level.
CSTART WELL inum

GATHER
FLOSTA
AREA
FIELD
(AFTER inuma)
Definitions:
inum List of well or well management level names or numbers

to start cycling. The rules for inum are the same as for
well lists (see Section 1.5.2).
AFTER, inuma Optional alpha label indicating that the start of cycling
for each well or for each well in the well management
level in the inum list follows completion of all cycling in
the corresponding well or well management level in the
inuma list.
NOTE: 1. AFTER cannot be used with CSTART FIELD.
2. The inum value is arbitrary for CSTART FIELD; it may be omitted.
3. A wells' cycling is completed when it has performed the maximum

specified number of cycles, when is has been aborted, or when it has been
3-214 Well Data R5000.0.1

stopped (CSTOP).
4. Specification of multiple CSTART cards which apply to the same well

will result in a warning message being written to the output file, unless
they are separated by a new CYCLIC specification for the well (see note 5
below). The first input CSTART card (after the CYCLIC card) which
applies to a given well will be honored.
5. Any cyclic well may be restarted, beginning with cycle number 1, by

re-entering CYCLIC and CSTART cards for the well. Any pre-existing
CPERF data for the well will be retained.
3.17.5 Stop Cycle (CSTOP)

The CSTOP card may appear anywhere in the recurrent data after the
corresponding CSTART card and terminates the cycle(s) for the specified well(s)
or for all wells in the specified well management level.
CSTOP WELL inum

GATHER
FLOSTA
AREA
FIELD
Definitions:
inum List of well or well management level names or numbers

to stop cycling. The rules for inum are the same as for
well lists (see Section 1.5.2)
NOTE: 1. The first CSTOP card input which applies to a given well is honored.
Subsequent CSTOP cards applying to that well are ignored.
2. Specifying a CSTOP card for a well which has not been started by a
CSTART card, or which has not started to cycle due to AFTER
constraints, will override the CSTART/AFTER cards, and will result in a
warning message being written to the output file.
3. A cyclic well that is stopped by a CSTOP card can be restarted by

subsequent input of CYCLIC and CSTART cards for the well. The cycle
number is reset to 1 in this case.
R5000.0.1 Well Data 3-215

3.18 Condensate Banking

In gas condensate reservoirs, a liquid phase appears near the wellbore when the
pressure in this region drops below the dewpoint. Initially, the liquid is immobile.
Gas relative permeability is also decreased. The degree of decrease depends on
the saturation of the liquid phase and the shape of the gas relative permeability
curve. In a normal coarse grid system, the decline in gas productivity is
underestimated because the gas saturation used for well productivity calculations
is that of the entire gridblock. Condensate banking more closely approximates the
loss of gas productivity by integrating mobility from the bottomhole flowing
pressure to the gridblock pressure. Gas saturation can be related to the pressure
by certain simple assumptions.
To use condensate banking, both the CNDBNK and CNDBWL keywords must be
specified.
When velocity dependency is applied to wells, the condensate banking option is

automatically activated for every production well. The parameters on the
condensate banking control cards are ignored, except for the number of intervals
to be used for the numerical integration. By default, four intervals are used in
each phase region. Condensate banking can be used with or without velocity
effects. 00
3.18.1 Condensate Banking Calculation Parameters (CNDBNK)

The CNDBNK card is used to turn on the condensate banking option and to adjust
the numerical integration parameters. Usually, it is sufficient to just use the
CNDBNK keyword without any additional parameters, which indicates that a
trapezoid rule with four intervals will be used for the integration.
⎛ ⎞
CNDBNK ⎜ TRAP nint ⎟
⎝ ROM ndim ( eps ) ⎠
Definitions:
TRAP Numerical integration is performed using the trapezoidal

integration method. If the CNDBNK keyword is entered
with no other parameters, this is the default method used.
nint Number of integration intervals used for the trapezoidal

method. The default number of intervals is 4.
3-216 Well Data R5000.0.1

ROM Numerical integration is performed using the Romberg

method, which sets the number of integration intervals
depending on the maximum relative error specified by
eps.
ndim The maximum number of integration intervals used by

the Romberg method is calculated as 2**(ndim-1). The
actual number of intervals used may be less than this
number, but it cannot exceed it. By default, ndim is set
to 7, which in turn sets the maximum number of intervals
to 64.
eps The maximum relative error used to determine the

number of integration intervals appropriate for Romberg
integration. By default, eps is set to 0.01. The ndim
parameter must precede eps.
Example:
C Use default condensate banking integration parameters CNDBNK
3.18.2 Selective Application of Condensate Banking (CNDBWL)

Condensate banking may be selectively turned on for a list of wells. It may also
be applied to all wells within a gathering center, a flow station, an area, or the
field. Condensate banking will not be automatically used for any well by use of
just the CNDBNK keyword.
To selectively apply condensate banking to particular wells, the CNDBWL

keyword is used in the following form:
⎛ ON ⎞
CNDBWL WELL ⎜ ⎟ wl
⎝ OFF ⎠
Definitions:
WELL Indicates that condensate banking will be selectively

turned on or off for the wells in the following list.
ON Indicates condensate banking will be applied.
OFF Indicates condensate banking will not be applied.
wl List of wells for which the condensate banking data

applies (see Section 1.5.2).
R5000.0.1 Well Data 3-217

To selectively apply condensate banking to all the wells in a particular well group
hierarchy, the CNDBWL keyword is used in the following form:
GATHER
FLOSTA ⎛ ON ⎞
CNDBWL inum ⎜ ⎟
AREA ⎝ OFF ⎠
FIELD
Definitions:
GATHER Turn condensate banking on or off for the specified

gathering center.
FLOSTA Turn condensate banking on or off for the specified flow

station.
AREA Turn condensate banking on or off for the specified

area.
FIELD Turn condensate banking on or off for the field.
inum Number of the member in the specified well management

level.
ON Turn condensate banking on for the specified well group.
OFF Turn condensate banking off for the specified well group.
3-218 Well Data R5000.0.1

3.19 Well Index Multipliers

The well index multiplier option allows the user to simulate the effect of
phenomena such as water scaling on the well index of producing wells. The
computed multiplier is determined from a table of multipliers as a function of
historical maximum water cut, cumulative reservoir total production, or
cumulative reservoir water production.
3.19.1 Assignment of WI Multiplier Tables (WIMUWL)
WIMUWL wl
itab1 itab2...itabn
Definitions:
wl List of wells for which tables are being assigned (see

Section 1.5.2).
itab Number of the WI multiplier table for this well. Default

is 0.
NOTE: The number of itab values must equal the number of wells in the well list.
A value of 0 for itab denotes that the multiplier option is disabled for the
well.
When the corresponding itab table uses one of the cumulative reservoir
production options, setting itab for the well forces the algorithm to do the
table lookup for the well as a whole. A subsequent FPERF card for this
well with iwim entered will switch to table lookup for each perforation.
3.19.2 WI Multiplier Tables (WIMULTAB)
WIMULTAB itab
WCUT
RESTOT WIMULT
RESWAT
val1 wimult1
. .
. .
. .
valn wimultn
Definitions:
R5000.0.1 Well Data 3-219

itab Number of the WI multiplier table being read.
WCUT Alpha label indicating that this column contains water-

cut data. The order of the WCUT and WIMULT columns
may be reversed.
RESTOT Alpha label indicating that this column contains

cumulative reservoir total production data. The order of
the RESTOT and WIMULT columns may be reversed.
RESWAT Alpha label indicating that this column contains

cumulative reservoir water production data. The order of
the RESWAT and WIMULT columns may be reversed.
WIMULT Alpha label indicating that this column contains WI

multipliers. The order of the WCUT and WIMULT
columns may be reversed.
val For WCUT, historical maximum water cut, fraction. For

RESTOT, cumulative reservoir total production, mrb
(krm3). For RESWAT, cumulative reservoir water
production, mrb (krm3). Values must increase
monotonically and may be unequally spaced.
wimult WI multipliers.
3.19.3 Outer Iteration Number (ITNWIMULT)

The ITNWIMULT card is used to set the outer iteration number after which the
WI multiplier will not be updated.
This data applies only to the WI multiplier tables with the WCUT option.
ITNWIMULT itnwim
Definition:
itnwim Outer iteration number. Default is 1 and the maximum

value is 3.
NOTE: In order to insure good material balance, if itnwim is greater than 1, the
itnmin value on the ITNLIM card must be greater than itnwim.
3-220 Well Data R5000.0.1

3.19.4 Reset Cumulative Reservoir Production (RESETCUM)

By default, well and perforation cumulative reservoir production (for the WI
multiplier table option only) is computed from the time a well starts producing.
The RESETCUM card allows the user to force these cumulatives to be reset to
zero at the time the data is entered.
RESETCUM wl
Definitions:
wl List of wells for which the well and perforation

cumulative reservoir production values are reset to zero
Example:
DIM NWIMMX NWIMV

2 6
WIMULTAB 1
WCUT WIMULT
0.0 1.0
0.2 0.8
0.5 0.5
0.8 0.3
1.0 0.1
WIMULTAB 2
WCUT WIMULT
0.0 1.0
0.1 0.8
0.3 0.5
0.6 0.3
0.7 0.2
1.0 0.01
WIMUWL A-01 A-02
2 1
ITNWIMULT 1
R5000.0.1 Well Data 3-221

3-222 Well Data R5000.0.1

Chapter
4
00000 Well Management Level Data
4.1 Introduction
00 Reporting of production/injection results and various production/injection
constraints may be given at the gathering center, flow station, area, and/or field
levels. (Only one field exists in the model. All areas are attached to the field.) The
following data cards set up the hierarchy among the levels.
4.2 Well Management Levels
4.2.1 Well Management Level Definition (GATHER, FLOSTA, AREA)
GATHER igc (gcname) fsnum (card 1)

FLOSTA ifs (fsname) areanm (card 2)
AREA iar arname (card 3)
00 Definitions:
GATHER Alpha label indicating a gathering center is being

defined.
igc Gathering center number.
gcname Gathering center name. The first character in the name

must be alphabetic unless the name is immediately
preceded by the character #. Only the first eight (8)
characters of the name are retained. Default is blanks.
fsnum Flow station number to which this gathering center

belongs. Default is 1.
FLOSTA Alpha label indicating a flow station is being defined.
ifs Flow station number.
fsname Flow station name. The first character in the name must
be alphabetic unless the name is immediately preceded
by the character #. Only the first eight (8) characters of
the name are retained. Default is blanks.
R5000.0.1 Well Management Level Data 4-223

areanm Area number to which this flow station belongs.

Default is 1.
AREA Alpha label indicating an area is being defined.
iar Area number.
arname Area name. The first character in the name must be

alphabetic unless the name is immediately preceded by
the character #. Only the first eight (8) characters of the
name are retained. Default is blanks.
4.2.2 Fraction of Time Management Level is Onstream (ONTIME)

00 Ontime factors do not apply to injection wells using either of the FSTD or FRES
00 The ONTIME card is used to specify the fraction of the time that a well is actually
producing/injecting. The fraction is applied to the well rate after the rate has been
determined by QMAX or pressure constraints and after the well minimum rate
(QMIN), water cut (WLIMIT), and GOR (GLIMIT) checks.
00 Ontime factors may be input at the well level or at any other level of well
management. The effective ontime factor for a well will be the one specified at the
lowest level of the well hierachy; that is, the first user-specified factor found in
this order:
1. the well,
2. the appropriate gathering center,
3. the appropriate flow station,
4. the appropriate area,
5. the field.
GATHER ⎛ ⎞
FLOSTA ⎜ ALL ⎟
ONTIME inum ⎜ ⎟ ontime ⎛ MULT ⎞
PROD ⎝ ALLWELLS⎠
AREA ⎜ ⎟
FIELD
⎝ INJ ⎠
00 Definitions:
Alpha label indicating the level of the well management hierarchy to which
the specified ontime factor applies:
4-224 Well Management Level Data R5000.0.1

GATHER Gathering center.
AREA Area.
FIELD Field.

level.
Alpha label indicating that the ontime value applies to:
ALL All the wells. This is the default.
PROD Producing wells only.
INJ Injecting wells only.
ontime Fraction of the time that each well is actually producing/

injecting. Default is 1.0.
MULT Alpha label indicating that the ontime factor specified on

this card will be a multiplier to any previously specified
ontime factor at the AREA level or below. The value on
this card will apply if no ontime factors have previously
been specified. This may only be input if FIELD was
entered.
ALLWELLS Alpha label indicating that the ontime factor applies to

all wells of the appropriate type (ALL, PROD, or INJ) in
the field, superceding any previously entered factor. This
may only be input if FIELD was entered.
NOTE: 1. One and only one of the GATHER, FLOSTA, AREA, or FIELD
labels must be specified. There is no default. When FIELD is
specified the inum entry may be omitted or the value 1 may be input;
no other value will be accepted.
2. One and only one of the ALL, PROD, or INJ labels may be specified.
If none is specified, ALL is assumed.

4.3 Production and Injection Targeting
4.3.1 Production Target (PTARG)

00 A PTARG card is used to define a maximum production rate for a gathering
center, a flow station, an area, or the field.
GATHER O
PTARG
FLOSTA
inum
W
qtarg ⎛ LFTGAS ⎞
AREA G ⎝ NOLFTGAS⎠
L
FIELD
00 Definitions:
the specified maximum production rate applies:
AREA Area.
FIELD Field.

level.
Alpha label indicating the maximum rate is based on:
O Oil production, STB/D (STM3/D).
W Water production, STB/D (STM3/D).
G Gas production, MSCF/D (SM3/D).
L Liquid production, STB/D (STM3/D).
qtarg Maximum production rate.
LFTGAS Alpha label indicating that the gas production target

qtarg also includes the amount of gaslift gas used in the
specified level of well management. This option applies
only when the label G is specified.

NOLFTGAS Alpha label indicating that the gas production target

qtarg does not include gaslift gas. This is the default.
This option applies only when the label G is specified.
00 Notes:
1. For predictive well management, a different format of PTARG card should be

used. Refer to Chapter 5 of this manual.
2. One and only one of the GATHER, FLOSTA, AREA, or FIELD labels must
be specified. There is no default. When FIELD is specified the inum entry
may be omitted, or the value 1 may be input; no other value will be accepted.
3. One and only one of the O, W, G or L labels must be specified. There is no

default. Separate maxima can be established for oil, water, gas, and liquid by
reading multiple PTARG cards.
4. The oil, water, gas and liquid maxima may be exceeded by the tolerance
factors specified on the TRGTOL card before violations occur.
5. The maximum rate criteria are satisfied first at the gathering center level, then
the flow station level, then the area level, and finally at the field level. The
order in which phase targets are checked at any well management level is
determined by the data specified using the TRGORD card. If the TRGORD
card is not specified, the default order is: oil, gas, liquid, water.
6. The method used to satisfy the maxima may be specified on the TRGOPT
card.
7. The LSCALE card may be used to specify how well rates should be
recomputed when reductions are necessary. The choices are linear scaling or
rigorous recomputation.
8. Wells whose rates have been reduced due to targeting are designated by
TARG in the production well summary.
9. Well rates will never be reduced below trgqmn, except possibly by the AVG
method.
10. The labels LFTGAS and NOLFTGAS apply only when the label G is
specified.
00 Example:
00 PTARG FIELD 1 O 150000

PTARG GATHER 2 L 50000
PTARG AREA 1 G 10000 LFTGAS

4.3.2 Production Target History Option (PTARGH)

00 A PTARGH card is used to activate the option that production targets are honored,
even if well production rates must be increased above their specified maxima.
ON
PTARGH
OFF
00 Definitions:
ON Alpha label indicating that the production target history

option is to be used.
OFF Alpha label indicating that the production target history

option is not to be used. This is the default.
NOTE: 1. When the PTARGH option is on and a production rate in a member of

a well management level falls below its user-specified production
target (PTARG), a scaling algorithm is used to increase the rates in
appropriate wells. An appropriate well is a well in the affected
member of well management whose production rate is at the specified
well maximum (QMAX).
2. Only one pass through the appropriate wells is undertaken. If a well

cannot produce at its new increased rate, it will produce what it can
and the target will not be reached.
3. When the PTARGH option is on, the LSCALE option must be off;
i.e., the perforation rates will be recalculated, not scaled. OFF is the
default value for LSCALE.

4.3.3 Production Target Frequency (PTGFRQ)

00 The PTGFRQ card is used to control the frequency with which the ordered lists of
wells (i.e., GOR, WCUT) used in production targeting are created.
MONTHS
PTGFRQ freq DAYS
TSTEPS
00 Definitions:
freq Frequency with which the ordered lists of wells used in

the production targeting calculations will be created.
Default is every timestep.
MONTHS Alpha label that sets the unit for freq to months.
DAYS Alpha label that sets the unit for freq to days.
TSTEPS Alpha label that sets the unit for freq to timesteps.
NOTE: 1. When the TEST card frequency for attempting to reopen one or more
shut-in wells causes the test to occur when the targeting is being
delayed by the PTGFRQ data, the test will be deferred until the next
time the full targeting algorithm is performed.
2. Within the simulator the date on a DATE card is considered to be the

beginning of that day. For example, if output is desired at the end of
March 1988, the date card should contain 1/4/88 and not 31/3/88.
Thus the MONTHS option on the frequency card will force a timestep
to start at the date 1/month/year.

4.3.4 Options for Reduction of Rates to Meet Target (TRGOPT)

00 A TRGOPT card is used in conjunction with the PTARG card to define the
method of reducing the phase rate of wells to meet the specified phase targets.
SCALE
AVG
GOR
⎛ GATHER ⎞ O
WCUT
⎜ FLOSTA
⎟ WRATE
TRGOPT ⎜ inum ⎟ G
⎜ AREA ⎟ W GRATE
⎝ FIELD ⎠ L AVGGOR
AVGWOR
AVGLOR
AVGWCT
00 Definitions:
NOTE: If the well management data is not entered, the option entered
will apply for all members of all well management levels.
the specified option applies:
AREA Area.
FIELD Field.

level.
Alpha label indicating the option is specified for:
O Oil phase.
W Water phase.
G Gas phase.
L Liquid phase.

Alpha label indicating the action to be taken when the sum of the oil
deliverabilities of producing wells exceeds the specified phase targets:
SCALE Scale the rates of all wells to exactly hit the target. This is
the default if the TRGOPT card is omitted for oil and
liquid targets. This option can be selected for any phase
target.
AVG Reset the rates of appropriate wells to an average rate.

*
That is, if a well’s oil rate is designated as WPO i , then
the reset rates will be
*
WPO i = min (WPOi , AVG),
where AVG has been computed to satisfy

*
Oil Target = ∑ WPOi
i
This option can be selected for any phase target.
GOR Reduce the production rate of the highest GOR wells to a

user-specified minimum rate (TRGQMN card) until the
phase target is reached. This is the default if the TRGOPT
card is omitted for gas target.
WCUT Reduce the production rate of the highest water-cut wells

to a user-specified minimum rate (TRGQMN card) until
the phase target is reached. This is the default if the
TRGOPT card is omitted for water target.
WRATE Reduce the production rate of the highest water rate wells
the phase target is reached.
GRATE Reduce the production rate of the highest gas rate wells
the phase target is reached.
AVGGOR For gas target, reset the rates of appropriate wells to an

average rate based on GOR; the set of wells to be reduced
will be those whose GOR is above a calculated target.
For oil and liquid targets, scale back the highest GOR
wells.
AVGWOR Reset the rates of appropriate wells to an average rate

based on water-oil ratio. The set of wells to be reduced
will be those whose water-oil ratio is above a calculated
target. This option can only be selected for water target.
AVGLOR Reset the rates of appropriate wells to an average rate

based on liquid-oil ratio. The set of wells to be reduced

will be those whose liquid-oil ratio is above a calculated

target. This option can only be selected for liquid target.
AVGWCT Scale back the highest water-cut wells. This option can
only be selected for oil target.
NOTE: When entered, one and only one of the GATHER, FLOSTA, AREA, or
FIELD labels can be specified. There is no default. When FIELD is
specified the inum entry may be omitted, or the value 1 may be input; no
other value will be accepted.
One and only one of the O, W, G, or L labels must be specified. There is

no default. Separate options can be specified for oil, water, gas, and liquid
by reading multiple TRGOPT cards.
One and only one of the SCALE, AVG, GOR, WCUT, WRATE, GRATE,
AVGGOR, AVGWOR, AVGLOR, or AVGWCT labels must be specified.
A well’s rate is never reduced below trgqmn by the SCALE, GOR,

WCUT, WRATE, and GRATE methods. The AVG, AVGGOR, AVGWOR,
AVGLOR, and AVGWCT methods can drop a well below trgqmn,
although it is highly unlikely this would ever occur.
The options specified on a TRGOPT card for gas and water phase targets
are ignored when GASWAT has been chosen on the TRGORD card. In
this case the rate at the highest GOR well is reduced to TRGQMN, then
the rate of the highest water-cut well is reduced to TRGQMN, then the
next highest GOR well, then the next highest water-cut well, etc., until the
target(s) is (are) met.

4.3.5 Order for Checking Phase Targets (TRGORD)

00 The TRGORD card is used in conjunction with the PTARG and TRGOPT cards to
define the order for reducing the various phase rates of wells to meet specified
phase production targets.
⎛ GATHER ⎞
⎜ FLOSTA
⎟
TRGORD ⎜ inum ⎟ OIL GAS LIQUID WATER
⎜ AREA ⎟ OIL LIQUID GASWAT
⎝ FIELD ⎠
00 Definitions:
NOTE: If the well management data is not entered, the ordering entered
will apply for all members of all well management levels.
the specified ordering applies:
AREA Area.
FIELD Field.

level.
Alpha label indicating the option is specified for checking targets for:
OIL Oil phase.
GAS Gas phase.
LIQUID Liquid phase.
WATER Water phase.
GASWAT Gas and water simultaneously. This method involves

decreasing rates of wells to TRGQMN until the target(s)
is (are) met in the following order: highest GOR, highest
water-cut, next highest GOR, etc.

other value will be accepted.
The default ordering is: OIL GAS LIQUID WATER
The TRGORD card can only be used in one of the formats described
above; i.e., either the four OIL, WATER, GAS, and LIQUID labels must
be specified or the OIL, LIQUID, and GASWAT labels must be specified -
each set of labels can be in any order. The order in which phases are
specified determines the order in which various phase targets are checked
at each level of well management, starting from the gathering center.

4.3.6 Minimum Rate for Use in Targeting Calculations (TRGQMN)

00 A TRGQMN card is used to define the minimum rate to which the well rate is cut
back when a phase target is being satisfied at any well management level.
O
G
TRGQMN wl
W
LIQUID
trgqmn1 trgqmn2 ... trgqmnn
00 Definitions:
Alpha label indicating the minimum production rates are being specified for:
O Oil phase, STB/D (STM3/D).
G Gas phase, MSCF/D (SM3/D).
W Water phase, STB/D (STM3/D).
LIQUID Liquid phase, STB/D (STM3/D).
wl List of wells for which trgqmn values are being

trgqmn Minimum rate to which the well’s rate is cut back when
meeting a phase target. Default is 0.
NOTE: The number of trgqmn values must equal the number of wells in the well
list.
00 Examples:
00 TRGQMN O 2 -14 18 22 24 -37 41

30*0.0

4.3.7 Well Rate Maximum Tolerances (TRGTOL)

00 The TRGTOL card is used to specify the factor by which each of the oil, gas
water, and liquid maxima may be exceeded before violations occur.
⎛ GATHER ⎞
⎜ FLOSTA
⎟
TRGTOL ⎜ inum ⎟ opttol gpttol wpttol (lpttol)
⎜ AREA ⎟
⎝ FIELD ⎠
00 Definitions:
NOTE: If the well management data is not entered, the tolerances

entered will apply for all members of all well management levels.
the specified tolerances applies:
AREA Area.
FIELD Field.

level.
opttol Factor by which oil maxima may be exceeded before a

violation occurs. Default is 0.05.
gpttol Factor by which gas maxima may be exceeded before a

wpttol Factor by which water maxima may be exceeded before a

lpttol Factor by which liquid maxima may be exceeded before

a violation occurs. Default is 0.05.
other value will be accepted

4.3.8 Injection Target (ITARG)

00 An ITARG card is used to define a maximum injection rate for a gathering center,
a flow station, an area, the field, or an injection region.
GATHER
FLOSTA
W
ITARG AREA inum qtarg
G
FIELD
INJREG
00 Definitions:
the specified maximum injection rate applies:
AREA Area.
FIELD Field.
INJREG Injection region.

level.
W Water injection, STB/D (STM3/D).
G Gas injection, MSCF/D (SM3/D).
qtarg Maximum injection rate.
NOTE: 1. One and only one of the GATHER, FLOSTA, AREA, FIELD, or
INJREG labels must be specified. There is no default. When FIELD is
specified the inum entry may be omitted, or the value 1 may be input;
2. One and only one of the W or G labels must be specified. There is no

default. Separate maxima can be established for water and gas by
reading multiple ITARG cards.
3. The maximum rate criteria are satisfied first at the gathering center
level, then the flow station level, then the area level, and finally at the
field level.

4. All wells in the tested level are cut by the same factor if there is an
excess of injectivity (unless the UNIFORM option is used).
5. Wells whose rates have been reduced due to targeting are designated
by WTAR (or GTAR) in the injection well summary.
6. Well rates will never be reduced below qmin.
7. When the injection region option is used, the ITARG cards for the
other well management levels (gathering center, flow station, area)
are ignored.
00 Example:
00 ITARG INJREG 1 W 50000

ITARG INJREG 2 W 50000
ITARG INJREG 1 G 70000
ITARG INJREG 2 G 70000
4.3.9 Well Rate Scaleback Options with Targeting (LSCALE)

00 An LSCALE card is used to change the procedure that is used to recalculate the
layer rates for multi-perforation wells whose rates are being reduced to meet
specified targets. The keyword LSCALE is derived from linear scaling, and will
determine whether the perforation rates are scaled back linearly, or whether they
are rigorously recalculated.
ON
LSCALE
OFF

00 Definitions:
00 Alpha label indicating the procedure to be used:
ON Use linear scaling of each of the perforation rates of each

well by its respective rate reduction factor.
OFF Recalculate the perforation rates for each well based on

its reduced total well rate, maintaining an equilibrium
bottomhole flowing pressure profile. This is the default
procedure.
NOTE: The specified procedure is used for both production targets and injection
targets.

4.4 Minimum Rates
4.4.1 Minimum Production Rates (PRDMIN)

00 A PRDMIN card is used to define a minimum production rate for a gathering
center, a flow station, an area, or the field. When this value is violated in a
member of one of these levels, this member is "shut-in". This means that all of the
producers, or all of the wells, attached to that member of the well management
hierarchy are shut-in.
GATHER
O
PRDMIN
FLOSTA
inum prdmin ⎛ ALL ⎞
AREA
W ⎝ ONLY⎠
G
FIELD
00 Definitions:
the specified minimum production rate applies:
AREA Area.
FIELD Field.

level.
Alpha label indicating the minimum rate is based on:
prdmin Minimum production rate.
ALL Alpha label indicating all wells in member inum are shut
in if the minimum rate is not met. This is the default.
ONLY Alpha label indicating only the production wells in

member inum are shut in if the minimum rate is not met.

2. One and only one of the O, W, or G labels must be specified. There is

no default. Separate minima can be established for oil, water, and gas
by reading multiple PRDMIN cards.
3. The minimum rate criteria are satisfied first at the gathering center
level, then the flow station level, and then the area level.
4. The minimum rate criteria at the field level is checked after the
successful completion of each timestep. If any field minimum
constraint is violated, a restart record is written and the run is
terminated. This restart record contains the data from the beginning of
this timestep. This will happen regardless of whether ALL or ONLY
is specified.
5. When starting from the restart record described in the previous note,
remember that the specified minima will still be in effect. Unless the
minima are decreased or more production brought online, the field
will immediately shut in.
4.4.2 Minimum Injection Rates (INJMIN)

00 An INJMIN card is used to define a minimum injection rate for a gathering center,
a flow station, an area, or the field. When this value is violated in a member of one
of these levels, this member is "shut-in". This means that all of the injectors, or all
of the wells, attached to that member of the well management hierarchy are shut-
in.
GATHER
INJMIN
FLOSTA
inum
W
injmin ⎛ ALL ⎞
AREA G ⎝ ONLY⎠
FIELD
00 Definitions:
the specified minimum injection rate applies:
AREA Area.

FIELD Field.

level.
Alpha label indicating the minimum rate is based on:
W Water injection, STB/D (STM3/D).
G Gas injection, MSCF/D (SM3/D).
injmin Minimum injection rate.
ALL Alpha label indicating all wells in member inum are shut
in if the minimum rate is not met. This is the default.
ONLY Alpha label indicating only the water (or gas) injection
wells in member inum are shut in if the minimum rate is
not met.
2. One and only one of the W or G labels must be specified. There is no

default. Separate minima can be established for water and gas by
reading multiple INJMIN cards.
3. The minimum rate criteria are satisfied first at the gathering center
level, then the flow station level, and then the area level.
4. The minimum rate criteria at the field level is checked after the
successful completion of each timestep. If any field minimum
constraint is violated, a restart record is written and the run is
terminated. This restart record contains the data from the beginning of
the timestep. This will happen regardless of whether ALL or ONLY is
specified.
5. When starting from the restart record described in the previous note,
remember that the specified minima will still be in effect. Unless the
minima are decreased or more injection brought online, the field will
immediately shut in.

4.5 Gas Cycling (Not available in VIP-THERM)
4.5.1 Shrinkage Gas Specification (GASSKG)

00 The GASSKG card is used to specify the shrinkage gas rate to be removed from
the total surface production rate of gas for use with gas injectors on any of the
GATHER
FLOSTA
GASSKG inum [QRATE q] [FPROD f]
AREA
FIELD
00 Definitions:
the specified shrinkage gas rate applies:
AREA Area.
FIELD Field.

level.
QRATE Shrinkage gas rate, MSCF/D (SM3/D).
q Fixed rate.
FPROD Fraction of the total surface production rate to be used as

the shrinkage gas rate.
f Fraction of production rate.
NOTE: One and only one of the GATHER, FLOSTA, AREA, or FIELD levels
must be specified. There is no default. When FIELD is specified the inum
entry may be omitted, or the value 1 may be input; no other value will be
accepted.
Data specified at the lower level of well management will be added to that
at the higher level of well management.
If both the QRATE and FPROD labels are specified, the shrinkage gas rate

is the specified rate plus the fraction of the surface production rate. (q + f *
the surface production rate).
00 Examples:
00 C ***** SHRINKAGE GAS RATE

C
GASSKG GATHER 1 QRATE 100. FPROD 0.1
4.5.2 Fuel Gas Specification (GASFUL)

00 The GASFUL card is used to specify the fuel gas rate to be removed from the total
surface production rate of gas for use with gas injectors on any of the reinjection
options.
GATHER
FLOSTA
GASFUL inum [QRATE q] [FPROD f] (PLANT)
AREA
FIELD
00 Definitions:
the specified fuel gas rate applies:
AREA Area.
FIELD Field.

level.
QRATE Fuel gas rate, MSCF/D (SM3/D).
q Fixed rate. If a GASCOND card is input and the number

of the member in the well management level specified on
this GASFUL card is also specified on a PLANT card, q
will be the amount excluding component icomp
identified or the GASCOND card.

the fuel gas rate.

f Fraction of production rate. If a GASCOND card is input

and the number of the member in the well management
level specified on this GASFUL card is also specified on
a PLANT card, the production rate to which the fraction
applies will be the amount excluding component icomp
identified or the GASCOND card.
PLANT Alpha label indicating that the fuel gas specified on this
card will be removed from the outlet gas stream of the MI
plant. If this label is omitted, the fuel gas will be removed
from the production gas stream (prior to any plant
calculation).
accepted.
If both the QRATE and FPROD labels are specified, the fuel gas rate is the
specified rate plus the fraction of the surface production rate. (q + f * the
surface production rate).
Up to two GASFUL cards may be input for any member of a well

management level: one with and the other without the alpha label PLANT.
In this case, two fuel gas streams will be removed: one from the produced
gas stream and the other from the outlet gas stream of the MI plant.
00 Examples:
00 C ***** FUEL GAS RATE

C
GASFUL GATHER 1 QRATE 200. FPROD 0.1
GASFUL GATHER 1 QRATE 300. PLANT

4.5.3 Sales Gas Specification (GASSLS)

00 The GASSLS card is used to specify the sales gas rate to be removed from the
total surface production rate of gas for use with gas injectors on any of the
GATHER
FLOSTA
GASSLS inum [QSALES q][FPROD f] [FPO gor] (PLANT)
AREA
FIELD
00 Definitions:
the specified sales gas rate applies:
AREA Area.
FIELD Field.

level.
QSALES Sales gas rate, MSCF/D (SM3/D).
q Fixed rate.

the sales gas rate.
FPO Fraction of the total surface oil production rate to be used

as the sales gas rate.
gor Fraction of oil production rate in GOR units, MSCF/STB

(SM3/STM3).
PLANT Alpha label indicating that a gas conditioning plant will

be included to process the sales gas where component
icomp on the PLANT card will be removed from the
sales gas stream. In this case, the value q on this
GASSLS card and the production rate to which the
fraction f applies represent the component icomp-free

amount. The removed component icomp amount will be

recombined with the reinjected gas stream.
accepted.
The sales gas rate is the specified rate plus the fraction of the surface gas
production rate plus the fraction of the surface oil production rate. (q + f *
the surface gas production rate + gor * the surface oil production rate).
The default values for q, f, and gor are zero.
00 Examples:
00 C ***** SALES GAS RATE

C
GASSLS GATHER 1 QSALES 500. FPROD 0.7
GASSLS GATHER 2 FPO 0.5
4.5.4 Makeup Gas Specification (GASMKP)

00 The GASMKP card is used to specify the maximum makeup gas rate to be added
to the pool of gas available for reinjection (produced minus sales minus shrinkage
minus fuel) for use with gas injectors on any of the reinjection options.
GATHER
FLOSTA QMAKE q FPROD f
GASMKP inum
AREA QPOOL q FSALES f
FIELD
00 Definitions:
the specified makeup gas rate applies:
AREA Area.
FIELD Field.


level.
QMAKE Maximum makeup gas rate, MSCF/D (SM3/D).
QPOOL Total injected gas rate, MSCF/D (SM3/D). The

maximum makeup gas rate would be: (pool rate + sales
rate + shrinkage rate + fuel rate - production rate).
q Gas rate.

the makeup gas rate.
FSALES Fraction of the sales gas rate to be used as the makeup

gas rate.
accepted.
Only one of the FPROD or FSALES labels can be specified.
If both the QMAKE and FPROD labels are specified, the makeup gas rate
is the specified rate plus the fraction of the production rate. (q + f * the
surface production rate).
If both the QMAKE and FSALES labels are specified, the makeup gas
rate is the specified rate plus the fraction of the sales gas rate. (q + f * the
sales gas rate).
Neither the FPROD nor the FSALES labels can be specified with the
QPOOL label.
When the QPOOL option is specified, the makeup gas rate will not be
allowed to be negative. That is, the pool rate is not allowed to be less than
the production rate minus the sales rate minus the shrinkage rate minus the
fuel gas rate.
Either a YINJMK card or a YREINJ card must be specified for the same
member of the well management level input on the GASMKP card. The
required volume of makeup gas at this composition will be added to the
produced gas available for reinjection to compute the overall composition
of the injected gas.
00 Examples:

00 C ***** MAKEUP GAS RATE

C
GASMKP GATHER 1 QMAKE 100. FPROD 0.2
GASMKP GATHER 2 QPOOL 300.
4.5.5 Makeup MI Specification (MIMKP)

00 For the four-component miscible option, the MIMKP card is used to specify the
makeup MI rate to be added to the pool of MI available for reinjection for use with
MI injectors on any of the reinjection options.
GATHER
FLOSTA
MIMKP inum QMAKE q
AREA
FIELD
00 Definitions:
the specified makeup MI rate applies:
AREA Area.
FIELD Field.

level.
QMAKE Makeup MI rate, MSCF/D (SM3/D)
q MI rate.
levels must be specified. There is no default. When FIELD is
2. Data specified at the lower level of well management will be added to

that at the higher level of well management.
3. This card may be input only if the four-component miscible option is

invoked.

00 Example:
00 C*****MAKEUP MI RATE
C
MIMKP FIELD QMAKE 500.
4.5.6 Effective Gas Injection Target (ETRGOP)

00 The ETRGOP card is used to select the method of checking the total gas injection
rate for each level of well management. The effective target is defined as the
minimum of the gas available for reinjection and the user-specified injection
target.
ALL
ETRGOP FIELD
NONE
00 Definitions:
ALL Effective target is checked for all levels of well

management.
FIELD Effective target is checked for the field level only.
NONE Effective target is not used. This is the default.
NOTE: When the ALL option is selected, the effective target instead of the
specified target will be checked at all levels of well management. When
the FIELD option is selected, the specified injection target will be checked
at each gathering center, flow station, and area. The effective target will be
checked at the field level. When the NONE option is selected, the
specified injection target will be checked at each level of well
management.
When the general injection region option is used, the ETRGOP card will
be neglected. The specified injection target will be checked in each
injection region. Then, the effective target will be checked at the field
level.
00 Examples:
00 C *****EFFECTIVE TARGET
ETRGOP FIELD

4.5.7 Makeup Gas Composition (YINJMK)

00 The YINJMK card is used to specify the composition of the makeup gas for use
with gas injectors on any of the reinjection options.
GATHER
FLOSTA
YINJMK inum (PROD) (card 1)
AREA
FIELD
yinjmk1 yinjmk2 . . . yinjmknc (card 2)
00 Definitions:
the specified gas composition applies:
AREA Area.
FIELD Field.

level.
PROD Alpha label indicating that the composition of the

produced gas should be used as the composition of the
makeup gas. If a composition is input on the following
card, it will be ignored.
yinjmkk Mole fraction of component k in the gas. A value must be

specified for each of the components, and the values must
sum exactly to 1.0. This data need not be input if PROD
was specified.
specified the inum entry may be omitted, or the value 1 may be
input; no other value will be accepted.
2. A YINJMK card or a YREINJ card for the appropriate level of the

well management hierarchy must be entered when the GASMKP
card is input.

3. As many data cards (card 2) as necessary may be used to specify a

yinjmk value for each component.
4.5.8 Reinjected Gas Composition (YREINJ)

00 The YREINJ card is used to specify the composition of the reinjected gas for use
with gas injectors on any of the reinjection options.
GATHER
FLOSTA
YREINJ inum (PROD)
AREA
FIELD
yreinj1 yreinj2 ... yreinjnc
00 Definitions:
the specified gas composition applies:
AREA Area.
FIELD Field.

level.
PROD Alpha label indicating that the composition of the

produced gas should be used as the composition of the
reinjected gas. If a composition is input on the following
card, it will be ignored.
yreinjk Mole fraction of component k in the gas. A value must be

specified for each of the components, and the values must
sum exactly to 1.0. This data need not be input if PROD
was specified.

2. The data on the YREINJ card overrides the composition of the

reinjected gas calculated internally.
3. A YINJMK card or a YREINJ card for the appropriate level of the

well management hierarchy must be entered when the GASMKP card
is input.
4. As many data cards as necessary may be used to specify a yreinj

value for each component.
4.5.9 Liquid Recovery Factors (RECFAC)

00 The RECFAC card is used to specify the fraction of each component in the gas
stream that can be recovered as a liquid at the gas plant for use with gas injectors
on any of the reinjection options. Alternatively, if the four-component miscible
option is invoked, the input recovery factor for component 3 will be treated as the
MI recovery factor and the recovered MI (plus makeup MI, if applicable) will be
used for MI injectors (see INJ card, Section 3.4.2).
RECFAC
recfac1 recfac2 . . . recfacnc
00 Definition:
recfack Fraction of component k in the gas stream that can be

recovered as a liquid at the gas plant. A value must be
specified for each of the components. For the four-
component miscible option, recfac will be treated as the
MI recovery factor for MI reinjection.
NOTE: 1. If the RECFAC card is not entered, the fractions are assumed to be
0.0.
2. As many data cards (card 2) as necessary may be used to specify a

recfac value for each component.

4.5.10 Invoke Major Gas Sales Option (PLANT)

00 The PLANT card is used to invoke the major gas sales option and to specify the
member of the well management hierarchy for which the major gas sales
algorithm applies.
GATHER
ON FLOSTA
PLANT iwmll
OFF AREA
FIELD
00 Definitions:
Alpha label indicating the major gas sales option (NGLPLANT, MIPLANT,
or GASCOND card) is to be applied to the numbers of the members in the
well management level specified on this card:
ON The major gas sales calculation is to be performed for the

well management level specified on this card.
OFF The major gas sales calculation will not be performed for
the well management level specified on this card. This is
the default.
Alpha label indicating well management level:
GATHER Gathering Center.
AREA Area.
FIELD Field.
iwmll List of numbers of the members in the specified well

management level. If FIELD is the specified well
management level, iwmll must be omitted.
NOTE: The major gas sales calculation will be performed only for those members
of the well management hierachy explicitly appearing on a PLANT card.
00 Examples:
00 PLANT ON GATHER 1 3 -6
PLANT ON FIELD

4.5.11 Gas Conditioning for Sales Gas and Fuel Gas (GASCOND)
GASCOND icomp (VENT)

(DIST idist)
00 Definition:
icomp Hydrocarbon component number to be removed from the

sales gas stream in the gas conditioning plant, if the
keyword PLANT is specified on the GASSLS card. Also,
all input (GASFUL card) and output fuel gas amounts
will exclude amounts of component icomp (i.e.,
component icomp-free amounts).
VENT Alpha label indicating that component icomp removed

from the sales gas stream will not be combined with the
reinjected gas stream and will be vented.
DIST Alpha label indicating that component icomp removed

from the sales gas stream will not be combined with the
reinjected gas stream and will be uniformly distributed
into a user-specified number of FSTD gas injectors (Type
A injectors identified by keyword KEYCMP in the INJ
card) using Method idist. Keyword DIST may be
specified only if a GINJOP UNIFORM card is also
specified.
idist Integer 1 through 3 indicating method number for the

distribution of the reinjected gas stream and component
icomp stream into FSTD gas injectors. In all three
methods, component icomp stream will be uniformly
distributed into all above mentioned Type A injectors. In
Method 1, the reinjected gas stream will be uniformly
distributed into all FSTD gas injectors not identified as
Type A injectors (i.e., Type B injectors). In Method 2, the
reinjected gas stream will be distributed into all FSTD
gas injectors (i.e., all Type A and Type B injectors) with
the constraint that all injectors have the same total gas
(component icomp and/or reinjected gas) injection rate.
In Method 3, the reinjected gas stream will be uniformly
distributed into all FSTD gas injectors (i.e., all Type A
and Type B injectors). If the component icomp and/or the
reinjected gas rate exceeds the total injectivity and
cutback of the injection rate is necessary, the component
icomp stream will be vented first.

NOTE: In the major gas sales option, the GASCOND card is used to remove one
component (e.g., CO2) from a sales gas stream. The removed component
amount will then either be recombined with the reinjected gas (i.e., the
outlet gas stream of the MI plant and any available makeup gas), vented
(through keyword VENT), or uniformly distributed into Type A gas
injectors (through keyword DIST). The DIST option may be specified
only if the UNIFORM method in the gas reinjection option (GINJOP card)
is chosen. If both VENT and DIST are not specified, the component
icomp stream will be recombined with the reinjected gas stream for
reinjection. Furthermore, the input fuel gas amount on the GASFUL card
and the output fuel gas amount in the gas handling report are component
icomp-free amount.
00 Examples:
00 GASCOND 2 DIST 2
4.5.12 Natural Gas Liquid (NGL) Plant Data Input (NGLPLANT)

00 The NGLPLANT card is used in the major gas sales option to allow the produced
gas stream (minus fuel and shrinkage gas) in any well management level to be
processed in an NGL plant to remove NGL from the stream.
NGLPLANT
NKEY ikey (PLUS)
KEYCMP
PLNTRY
pr1,1 pr1,2 ... pr1,j ... pr1,NI
pr2,1 pr2,2 ... pr2,j ... pr2,NI
. . . .
. . . .
. . .
00 Definitions:
NKEY Alpha label indicating that the key component number or

the key component plus fraction number is to be read.
The cards KEYCMP and PLNTRY defined below should
follow the NKEY card.
ikey The number of the key component or the key component

plus fraction to be used in the liquid recovery fraction

table look up. In the key component case, the mole

fraction of the key component is used for the table look
up of component liquid recovery values, whereas in the
key component plus fraction case, the sum of the well
stream over all mole fraction from the key component
plus all the following components are used in the table
look up.
PLUS Alpha label indicating the key component plus fraction is

to be used in the table look up.
KEYCMP Alpha label indicating the key component mole fractions

or the key component plus over all mole fractions are to
be entered. These are the key component mole fractions
or the sum of key component plus mole fractions that are
to be used in the liquid recovery fraction table look up.
vkcmp The value of the key component mole fraction or the sum
of the key component plus fraction to be used as an
interpolation value. There are NI number of interpolation
point values to be read. They should be on one card and
should cover the range of values that are to be expected
in the run. The range of values on this card should be
between 0. and 1. NI is determined by the number of
values read on the card. The vkcmp values on this card
must be in descending order.

separated to the liquid stream.

the liquid stream in the NGL Plant. The liquid recovery
the key component mole fraction or the key component
plus mole fraction and one value must be entered for NI
points and for each component. The data must be ordered
so that the liquid recovery fractions should be entered for
component 1 for all values of key component plus
fraction interpolation points (NI). The next card is for
component 2 recovery fractions at NI points. This
continues until all component values have been read. In
all there should be (NI * NC) values read. The values
must be between 0. and 1.
NOTE: In the major gas sales option, the produced gas stream in any well
management level may be processed in an NGL plant and/or a MI plant to
remove NGL and/or MI. Sales gas is then removed from the output gas
stream, and the remaining gas is combined with the makeup gas to form

the reinjected gas stream.
The feed composition of an NGL plant (or an MI plant if no NGL plant

included) is the composition of the total stock tank gas stream for any well
management level, while output NGL and gas streams are determined by
the molar liquid recovery fractions. If a MIPLANT tables is also input, the
output gas stream from the NGLPLANT will be fed into the MIPLANT.
The outlet MI composition from the MI plant for well management level
will be used as the injection composition for MI injectors attached to the
level (see the INJ card).
A PLANT card must be entered to invoke the NGL calculation for any
well management level.
The feed, outlet liquid (NGL and gas rates and compositions can be
printed as part of the separator report using the keyword SEP on the
PRINT card.
00 Examples:
00 C=========================================
C NGL PLANT
C =========================================
NGLPLANT
NKEY 6 PLUS
KEYCMP
.9999 .108 .104 .098 .075 .065 .047 .028 .018 .010 .000
PLNTRY
.0240 .0240 .0240 .0220 .0170 .0140 .0100 .0050 .0030 .0020 .0020
.0070 .0070 .0070 .0060 .0050 .0040 .0030 .0010 .0010 .0000 .0000
.0610 .0610 .0590 .0560 .0430 .0370 .0270 .0140 .0090 .0060 .0060
.1790 .1790 .1750 .1690 .1370 .1220 .0920 .0550 .0400 .0290 .0290
.4680 .4680 .4640 .4530 .4000 .3710 .3050 .2200 .1770 .1480 .1480
.9960 .9960 .9960 .9960 .9940 .9930 .9890 .9790 .9690 .9590 .9590
1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000
1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000

4.5.13 Miscible Injectant (MI) Plant Data Input (MIPLANT)

00 The MIPLANT card is used in the major gas sales option to allow the produced
gas stream (minus fuel and shrinkage gas) in any well management level to be
processed in an MI plant to remove MI from the stream.
MIPLANT
NKEY ikey (PLUS)
KEYCMP
PLNTRY
pr1,1 pr1,2 ... pr1,j ... pr1,NI
pr2,1 pr2,2 ... pr2,j ... pr2,NI
. . . .
. . . .
. . .
00 Definitions:


look up.

to be used in the table loop up.




the liquid stream in the MI Plant. The liquid recovery
NOTE: In the major gas sales option, the produced gas stream in any well
management level may be processed in an NGL plant and/or a MI plant to
remove NGL and/or MI. Sales gas is then removed from the output gas
stream, and the remaining gas is combined with the makeup gas to form
the reinjected gas stream.
The feed composition of an NGL plant (or an MI plant if no NGL plant

included) is the composition of the total stock tank gas stream for any well
management level, while output NGL and gas streams are determined by
the molar liquid recovery fractions. If a MIPLANT tables is also input, the
output gas stream from the NGLPLANT will be fed into the MIPLANT.
The outlet MI composition from the MI plant for well management level
will be used as the injection composition for MI injectors attached to the
level (see the INJ card).
A PLANT card must be entered to invoke the MI calculation for any well
management level.
The feed, outlet liquid (MI and gas rates and compositions can be printed
as part of the separator report using the keyword SEP on the PRINT card.
The MI plant summary table also contains the reinjected lean gas

composition.
00 Examples:
00 C=========================================
C MI PLANT
C =========================================
MIPLANT
NKEY 6 PLUS
KEYCMP
.9999 .108 .104 .098 .075 .065 .047 .028 .018 .010 .000
PLNTRY
.0240 .0240 .0240 .0220 .0170 .0140 .0100 .0050 .0030 .0020 .0020
.0070 .0070 .0070 .0060 .0050 .0040 .0030 .0010 .0010 .0000 .0000
.0610 .0610 .0590 .0560 .0430 .0370 .0270 .0140 .0090 .0060 .0060
.1790 .1790 .1750 .1690 .1370 .1220 .0920 .0550 .0400 .0290 .0290
.4680 .4680 .4640 .4530 .4000 .3710 .3050 .2200 .1770 .1480 .1480
.9960 .9960 .9960 .9960 .9940 .9930 .9890 .9790 .9690 .9590 .9590
1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000
1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000 1.000

4.5.14 Liquified Petroleum Gas (LPG) Plant Data Input (LPGPLANT)

00 The LPGPLANT card is used in the major gas sales option to allow the produced
gas stream (minus fuel and shrinkage gas) or the outlet gas from the NGLPLANT
(if an NGLPLANT is specified) in any well management level to be processed in
an LPG plant to remove LPG from the stream.
LPGPLANT
NKEY ikey (PLUS)
KEYCMP
vkcmp1 vkcmp2 .... vkcmpj .... vkcmpNI
PLNTRY
pr1,1 pr1,2 .... pr1,j .... pr1,NI
pr2,1 pr2,2 .... pr2,j .... pr2,NI
. . . . . .
. . . . . .
pri,1 pri,2 .... pri,j .... pri,NI
. . . . . .
prNC,1 prNC,2 .... prNC,j .... prNC,NI
interpolation point, j=1 to number of interpolation values, NI.
Repeat for all components, i=1 to the number of components, NC)
00 Definitions:


look up.

to be used in the table loop up.




the liquid stream in the LPG Plant. The liquid recovery
NOTE: In the Major Gas Sales Option, the outlet gas stream of the NGL plant (if
specified) is processed in the LPG plant. If a MIPLANT table is also input,
the outlet gas stream from the LPG plant will be fed into the MI plant. The
feed, outlet liquid (LPG) and gas rates and compositions can be printed as
part of the separator report using keyword SEP on the PRINT card.

4.5.15 Maximum Feed Rate to NGL Plant (NGLFED)

00 The NGLFED card specifies the maximum feed rate to the NGL plant for use with
the NGLPLANT on the Major Gas Sales Option.
GATHER
FLOSTA
NGLFED inum QRATE q
AREA
FIELD
00 Definitions:
the specified maximum NGL feed rate applies:
AREA Area.
FIELD Field.

level.
QRATE Maximum NGL feed rate, MSCF/D (SM3/D).
q Maximum rate.
accepted.
00 Examples:
C***** Maximum NGL Feed Rate

C
NGLFED FIELD QRATE 100000.

4.5.16 Maximum NGL Rate (NGLOUT)

00 The NGLOUT card specifies the maximum NGL rate from the NGL plant for use
with the NGLPLANT on the Major Gas Sales Option.
GATHER
FLOSTA
NGLOUT inum QRATE q
AREA
FIELD
00 Definitions:
the specified maximum NGL rate applies:
AREA Area.
FIELD Field.

level.
QRATE Maximum NGL rate, MSCF/D (SM3/D).
q Maximum rate.
accepted.
00 Examples:
C***** Maximum NGL Rate

C
NGLOUT AREA 1 QRATE 10000.

4.5.17 Maximum Feed Rate to LPG Plant (LPGFED)

00 The LPGFED card specifies the maximum feed rate to the LPG plant for use with
the LPGPLANT on the Major Gas Sales Option.
GATHER
FLOSTA
LPGFED inum QRATE q
AREA
FIELD
00 Definitions:
the specified maximum LPG feed rate applies:
AREA Area.
FIELD Field.

level.
QRATE Maximum LPG feed rate, MSCF/D (SM3/D).
q Maximum rate.
accepted.
00 Examples:
C***** Maximum LPG Feed Rate

C
LPGFED FIELD QRATE 100000.

4.5.18 Maximum LPG Rate (LPGOUT)

00 The LPGOUT card specifies the maximum LPG rate from the LPG plant for use
with the LPGPLANT on the Major Gas Sales Option.
GATHER
FLOSTA
LPGOUT inum QRATE q
AREA
FIELD
00 Definitions:
the specified maximum LPG rate applies:
AREA Area.
FIELD Field.

level.
QRATE Maximum LPG rate, MSCF/D (SM3/D).
q Maximum rate.
accepted.
00 Examples:
C***** Maximum LPG Rate

C
LPGOUT AREA 1 QRATE 10000.

4.6 Basic Gas Reinjection (GINJOP) (Not Available in VIP-

THERM)
00 A gas reinjection option other than the standard option of a well injecting a
fraction of the production in a member in a well management level exists in VIP-
EXECUTIVE. Under the new option, maximum rates are specified for the wells.
If the sum of well injectivities exceeds the available reinjection gas, the rates are
decreased by resetting the gas injection rates of appropriate wells to an average
rate. That is, if a well’s rate is designated as WIGi, then the reset rates will be
*
00 WIG i = min (WIGi, AVG),
00 where AVG has been computed to satisfy
*
00 Gas Target = ∑ WIGi
i
00 If the sum of well injectivities falls below the available reinjection gas, the gas
injection rates of appropriate wells are scaled-up.
00 The GINJOP card is used to define the gas reinjection option to be used.
GINJOP STD
UNIFORM
STD Alpha label indicating that the standard gas reinjection

option is to be used. This is the default.
UNIFORM Alpha label indicating the gas reinjection option with

uniform distribution of rate to wells to match the
available reinjection gas rate will be used.
NOTE: 1. The GINJOP UNIFORM card must be entered before any QMAX
cards.
2. For the UNIFORM option gas injection wells must be specified as

either FSTD or FRES (INJ card), then assigned to the appropriate
level of well management.
3. Also for the UNIFORM option the definition of qmax on the QMAX
cards is the maximum gas injection rate, even though the well type is
FSTD or FRES.

4.7 Injection Regions (Not available in VIP-THERM)

00 Water and gas reinjection may be controlled through the use of injection regions.
These are separate and independent of the other levels of well management to
which water and gas injectors are assigned. Voidage replacement, pressure
maintenance and gas project prioritization are allowed in the injection regions.
00 An injection region is defined by three dimensional grids. An injector can be

assigned to one region only. An injector which does not physically exist within a
region can still be assigned to it. If the user assigns gridblocks to injection regions
but not the injection wells, the program assigns the injection region for the
injector according to the location of the top perforation. A producer may be
completed in more than one region. The program automatically matches the
completion zones for a producer to the corresponding regions.
00 The maximum water injection to the field is the minimum of the field injection
target, and the sum of the field production and the specified water source (the
IRSRCW card). The maximum gas injection to the field is the minimum of the
specified field injection target and the field available gas. The field available gas
is the field production plus gaslift gas (from the previous timestep) plus makeup
gas specified by the GASMKP card plus makeup gaslift gas minus the shrinkage
gas minus the fuel gas minus the gaslift gas (at present timestep) minus the sales
gas. If gaslift gas is not part of the gas handling loop, the gaslift gas and makeup
gaslift gas are not included in the calculation.
4.7.1 Define the Injection Region Option (RINJOP)

00 The RINJOP card is used to define the injection region option to be used.
STD NODIST UNIFORM

RINJOP
INJREG REDIST PROPTN
00 Definitions:
STD Alpha label indicating that the standard reinjection option

(with well management levels instead of injection
regions) is to be used. This is the default.
INJREG Alpha label indicating that injection regions will be used

for water and gas injection.
NODIST Alpha label indicating that the redistribution option will

not be used for injection regions. This is default.
REDIST Alpha label indicating that the redistribution option will

be used for injection regions.

UNIFORM Alpha label indicating that equal amount of fluid will be

distributed to each voidage controlled (FRES) well under
the same region. This is default.
PROPTN Alpha label indicating that the amount of fluid distributed

to each voidage controlled well in a region will be
proportional to the well injectivity.
NOTE: The RINJOP INJREG card must be entered before any QMAX cards.
For the INJREG option, injection wells under net voidage control and/or
pressure maintenance must be specified as FRES (INJ card), but the well
management level is ignored.
For the INJREG option, the definition of qmax on the QMAX card is the
maximum injection rate at reservoir condition when the well type is
FRES.
The NODIST, REDIST, UNIFORM, PROPTN options can be selected

only when the INJREG option is chosen.
For the REDIST option, the injection fluid available to each region is the
maximum field injection rate times the percentage for the region specified
in the IRPCTA card. If no percentages are input, then each injection region
will be assigned the fraction, 1/(number of regions with defined voidage
controlled wells). If the amount of fluid injected in a region is less than the
available amount for the region, this extra amount of fluid will be
redistributed to other regions according to the region’s injectivities.
For the PROPTN option, the amount of fluid calculated from the voidage
and pressure maintenance control is distributed to the voidage controlled
wells according to the injectivities.
For the UNIFORM option, the amount of fluid calculated from the
voidage and pressure maintenance control is equally distributed to the
voidage controlled wells.
When the PERCENT option in the IRDIST card is selected, the amount of
fluid calculated from the voidage and/or pressure maintenance control is
neglected. Therefore, neither PROPTN nor UNIFORM option is used.

00 Example 1:
00 C ***** INJECTION REGION OPTION

C
RINJOP INJREG
00 Example 2:
00 ***** INJECTION REGION WITH PROPTN OPTION

C
RINJOP INJREG PROPTN
4.7.2 Assign Name to Injection Region (INJRNM)

00 The INJRNM card is used to assign a name to an injection region.
INJRNM nir injrnm
00 Definitions:
nir Injection region number.
injrnm Injection region name. The first character in the name

must be alphabetic unless the name is immediately
preceded by the character #. Only the first eight (8)
characters of the name are retained. Default is blanks.
00 Examples:
00 INJRNM 1 lNJRO1
INJRNM 2 lNJRO2
INJRNM 3 lNJRO3
INJRNM 4 lNJRO4
INJRNM 5 lNJRO5
4.7.3 Maximum Source Water Injection Rate (IRSRCW)

00 The IRSRCW card is used to specify the maximum source water injection rate
available to the field, in conjunction with the injection region option.
IRSRCW irsrcw

00 Definition:
irsrcw Maximum source water injection rate available to the

field when using the injection region option, STB/D
(STM3/D). Default is 0.
00 Examples:
00 C ***** SOURCE WATER

C
IRSRCW 1000000
4.7.4 Assign Injection Wells to Injection Regions (INJRGR)

00 The INJRGR card is used to assign appropriate injection wells to injection
regions.
INJRGR wl
nir1 nir2 . . . nirn
00 Definitions:
wl List of injection wells for which injection region numbers

are being assigned (see Section 1.5.2).
nir Injection region number to which the well is assigned.
NOTE: The number of nir values must equal the number of wells in the well list.
The INJRGR card may be omitted if the INJREGN card has been used to
assign gridblocks to injection regions. In this case, wells will be assigned
to the appropriate injection region based on the location of the first
completion zone.
If FIELD distribution data are specified on the IRDIST card, both the
INJRGR and INJREGN cards maybe omitted. In this case all appropriate
injection wells will be assigned to injection region number one.
If any INJRGR card has been entered, the program assumes that all
injectors have been explicitly assigned to regions. Thus, no injectors will
be assigned automatically based on the perforation locations.

00 Examples:
00 INJRGR 15
1
INJRGR 16 38
2*2
4.7.5 Distribution Percentage of Injection Rate to Injection Regions (IRPCTA)

00 The IRPCTA card is used to assign injection rate distribution percentages to
injection regions.
IRPCTA nir
pct1 pct2 . . . pctm
00 Definitions:
nir List of injection regions to which the following

percentages apply. (The list nir has the same format as
the well list wl.) (see Section 1.5.2)
pct Percentage to be used for appropriate distribution of

injection rate to the injection regions.
NOTE: The number of pct values must equal the number of regions in the
injection region list.
If the percentage for a region will be required, then it should be input. If no

percentages are input, then each injection region will be assigned the
fraction 1/(number of areas with defined wells). The percentage for a
region is required when the PERCENT option is used in the IRDIST card
or when the REDIST option is selected in the RINJOP card.
The sum of the percentages of all injection regions must be no greater than
100.
4.7.6 Assign Gridblocks to Injection Regions (INJREGN)

00 The INJREGN card is used to assign gridblocks to injection regions.
INJREGN nir (NOCASCADE)

i1 i2 j1 j2 k1 k2 (gridname)
00 Definitions:

nir Injection region number to which gridblocks are being

assigned.
NOCASCADE Alpha label indicating that this region number should not
be cascaded to any grids located within the gridblocks
defined in the data specified.
i1, i2 Gridblock range in the x direction.
j1, j2 Gridblock range in the y direction.
k1, k2 Gridblock range in the z direction.
gridname Name of the grid to which this gridblock range applies. If

the gridname is not entered, the data is assumed to apply
to the root grid.
NOTE: If FIELD distribution data are specified on the IRDIST card, the
INJREGN card may be used to restrict which gridblocks will be used for
pressure and voidage calculations (using nir = 1). In this case only
injection region number one is used.
INJREGN data must be input for INJREG distribution using ALL or

LIQUID voidage (IRDIST card).
00 Examples:
00 C ***** INJECTION REGION

INJREGN 1
68 78 1 1 5 10
4.7.7 Specify How Distribution of Injection Fluid is to Occur (IRDIST)

00 The IRDIST card is used to specify how distribution of fluid is to occur in the
injection regions.
(TYPVDG)(PRMEXP) ⎛
FIELD TRGPRS⎞ ⎛ RFRPRS⎞
IRDIST (TYPPRS)(VDGFCT)(INFLUX)
INJREG ⎝ PGRAD ⎠ ⎝ DELTAP⎠
[inum] (typvdg) (prmexp) ⎛

trgprs⎞ ⎛ rfrprs⎞ (typprs)(vdgfct)
⎝ pgrad ⎠ ⎝ deltap⎠
(influx)
00 Definitions:
00 Alpha label indicating the corresponding datum on the following card(s) is:

FIELD Field number (must be 1). This label must follow the
IRDIST keyword.
INJREG Number of the injection region to which the remaining

data apply. This label must follow the IRDIST keyword.
TYPVDG Type of distribution of injection rate to the injection

region or the field.
PRMEXP Exponent on the pressure maintenance term.
TRGPRS Target pressure for pressure maintenance.
RFRPRS Reference pressure for pressure maintenance.
PGRAD Targeted rate of pressure decline or increase for pressure

maintenance.
DELTAP Difference between reference pressure and target

pressure for pressure maintenance.
TYPPRS Type of average pressure for pressure maintenance.
VDGFCT Multiplying factor to be applied to the voidage.
INFLUX Indicates that aquifer influx is to be subtracted from the

voidage.
inum Field number (must be 1) or region number to which the

following data apply.
typvdg Type of distribution of injection rate to the injection

regions. There is no default.
ALL Voidage calculation using all three

phases.
LIQUID Voidage calculation using liquid only.
PERCENT Use specified percentage(s). (IRPCTA

card.)
prmexp Exponent of the pressure term. Stored value will be

integer. Specify the value 0 if pressure maintenance
option is not to be used. The alpha label X may be
specified to maintain current value. Default is 0.
trgprs Target pressure to use for the pressure maintenance

option, psia (kPa). The alpha label X may be specified to
maintain current value. There is no default.

rfrprs Reference pressure to use for the pressure maintenance

option, psia (kPa). The alpha label X may be specified to
pgrad Targeted rate of pressure increase/decline to use for the

pressure maintenance option, psi/day (kPa/day). The
alpha label X may be specified to maintain current value.
deltap Difference between reference pressure and target

pressure to use for the pressure maintenance option, psi
(kPa). The alpha label X may be specified to maintain
current value. There is no default.
typprs Type of average pressure to use with pressure

maintenance. The alpha label X may be specified to
PVWEIGHT Pore volume-weighted average.
HCWEIGHT Hydrocarbon pore volume-weighted

average.
vdgfct Multiplying factor to be applied to the voidage. The

alpha label X may be specified to maintain current value.
Default is 1.0.
influx Indicates whether aquifer influx is to be subtracted from

voidage. The alpha label X may be specified to maintain
current value.
NO Do not subtract aquifer influx from

voidage value. This is the default.
YES Subtract aquifer influx from voidage

value.
NOTE: IRDIST FIELD data will be used only if no IRDIST INJREG data have
been read.
Producers to be used for voidage calculations are determined by their

completion locations relative to the injection region gridblock
assignments. If a producer is completed in more than one region, the
actual production from the completions in each region will be used to
determine voidage for each region.
If FIELD distribution is input, but no INJREGN cards have been input,

then the entire field is treated as the injection region. If INJRGR cards
have also been omitted, all appropriate injection wells are assigned to
injection region one.
For the injection rate distribution type typvdg:

ALL or LIQUID must be specified for pressure maintenance.
When ALL or LIQUID are used with FIELD, the field injection rate
at reservoir conditions is then allocated to the injection regions using
percentages.
When PERCENT is used with FIELD, the field injection rate at surface
conditions (the minimum of the field production rate plus the injection
source and the specified field injection target) is then allocated to the
injection regions using percentages.
The reference pressure rfrprs must exceed both the target pressure
trgprs and the computed average pressure.
The pairs of data rfrprs/trgprs and pgrad/deltap may not occur on the
same IRDIST card. These options are mutually exclusive.
00 Examples:
00 C
IRDIST INJREG TYPVDG VDGFCT INFLUX
1 ALL 1.0 NO
4.7.8 Forced Gas Injection Into Injection Regions (IRGAS)

00 The IRGAS card is used to activate the forced gas injection option, in conjunction
with the injection region option, and to define the α and β parameters for the
forced gas regions.
IRGAS nir or IRGAS OFF

ON
alpha1 alpha2 ... alpham
beta1 beta2 ... betam
00 Definitions:
nir List of injection regions to which the following α and β

parameters apply. (The list nir has the same format as the
well list wl.) (see Section 1.5.2)
OFF Alpha label indicating that the forced gas injection option
is now inactive. The alpha and beta parameters will be
retained in case the option is ever reactivated.
ON Alpha label indicating that the forced gas injection option

is to be reactivated.

alpha α parameter for a forced gas region. See Notes for an

explanation of its usage.
beta β parameter for a forced gas region. See Notes for an

explanation of its usage.
NOTE: The number of alpha and beta values must equal the number of regions
in the injection region list.
The values of alpha and beta must lie between 0. and 1., inclusive.
The sum of the beta values over all forced gas regions must be 1.
Wells defined as forced gas injectors inject gas even if pressure

maintenance criteria are violated. Such an option is useful when the
flaring of excess produced gas is not allowed.
Under the forced gas option (IRGAS card specified), the forced gas
injectors are those gas injectors for which FRES is specified on the INJ
card. FRES gas injectors may only exist in forced gas regions; i.e., those
for which α’s and β’s are specified. No FRES gas injector may exist in a
non-forced gas region.
The injection gas rate is distributed to the injection regions as follows:
Define:
ΩR entire reservoir
ΩF forced gas regions
α α parameter for each forced gas region
β β parameter for each forced gas region
qGI well gas injection rate for non-FRES wells
QGI non-FRES injection rate in each region, =ΣqGI
QGI total gas injection rate in each region
QGP total gas production rate from each region

net
Q GPF net field gas production rate
≡ ∑ QGP ( i ) – ( sales + fuel + shrinkage ) + makeup

iεΩ R
QRINJ gas production rate minus non-FRES gas injection

rate
net
≡ Q GPF – ∑ QGI ( i )
iεΩ R

For each non-forced gas injection region k,
Q GI ( k ) = Q GI ( k )
For each forced gas injection region i,
⎧ ⎫
α ( i )Q GP ( i ) ⎪ ⎪
Q GI ( i ) = -------------------------------------- ⋅ min ⎨ ∑ α ( j )Q GP ( j ), Q RINJ ⎬
⎪ jεΩ ⎪
∑ α ( j )QGP ( j ) ⎩ F ⎭
jεΩ F
⎛ ⎧ ⎫⎞
+ β ( i ) ⎜ Q RINJ – min ⎨ ∑ α ( j )Q GP ( j ), Q RINJ ⎬⎟
⎝ ⎩ jεΩ ⎭⎠
F
+ Q GI ( i )
Note that in all cases
net
∑ QGI ( i ) = Q GPF
iεΩ R

4.7.9 Select Gas Project Prioritization Option (PRIOP)

00 The PRIOP card is used to activate the gas prioritization option within the general
injection region option. The INJREG label must have been input on the RINJOP
card to use this option.
ON
PRIOP
OFF
00 Definitions:
ON Alpha label indicating that the gas prioritization option

will be used.
OFF Alpha label indicating that the gas prioritization option is

not used. This is the default.
00 Examples:
00 C ***** GAS PRIORITIZATION OPTION

C
PRIOP ON
4.7.10 Assign Name to Gas Project (PROJNM)

00 The PROJNM card is used to assign a name to a gas project.
PROJNM nproj projnm
00 Definitions:
nproj Project number.
projnm Project name. The first character in the name must be

alphabetic unless the name is immediately preceded by
the character #. Only the first eight (8) characters of the
name are retained. Default is blanks.
00 Examples:
00 C ***** NAME OF THE GAS PROJECT
00 C
PROJNM 1 MGI
PROJNM 2 IMGI
PROJNM 3 GS

4.7.11 Assign Gas Injection Wells to Projects (PROJWL)

00 The PROJWL card is used to assign the appropriate gas injection wells to the
projects.
PROJWL wl
nproj1 nproj2 . . . nprojn
00 Definitions:
wl List of gas injection wells for which projects are being

assigned (see Section 1.5.2).
nproj Project number to which the well is assigned.
NOTE: The number of nproj values must equal the number of wells in the well
list.
Only a gas injection well can be assigned to a project. The FRES well type
in the injection region option is a net voidage injection well. Since water
injection follows gas injection in the prioritization option, the user cannot
specify FRES gas injection wells in the option.
00 Examples:
00 C ASSIGN GAS INJECTORS TO PROJECTS

PROJWL 1 -4
1212
4.7.12 Prioritize Gas Projects (PRIIR)

00 The PRIIR card is used to prioritize gas projects in injection regions. If a priority
is to be skipped in an injection region, the user should specify project 0 for that
priority.
INJREG
PRIIR irl
FIELD
nproj1 nproj2 ... nprojn
00 Definitions:
INJREG Injection region option is used to prioritize the projects.
FIELD Field option is used to prioritize the projects.

irl List of injection regions to which prioritization is being

assigned (the injection region list irl has the same format
as the well list wl). (see Section 1.5.2)
nprojn Assign a project number to priority n.
00 Examples:
00 C ***** PRIORITIZE PROJECTS

C
PRIIR INJREG 1 -3
1 3 4 2 5
PRIIR INJREG 4
1 0 3 4 5
4.8 Voidage Injection by Guide Rate (Not available in VIP-THERM)

00 A guide rate voidage injection scheme has been implemented in VIP-
EXECUTIVE. The INJ and the QMAX cards are modified when the new scheme
is used. The FRES and FSTD options define the wells under new voidage
replacement control. The GATHER, FLOSTA, AREA, and FIELD option on the
INJ card indicates the well management level upon which the gas injection
composition is based. The QMAX card specifies the maximum injection rate even
though the well type is FRES or FSTD.
00 Two input option cards, INJTAR and INJGR, are added. The INJTAR card
specifies the injection target and the INJGR card specifies the guide rate.
00 Note that any additional injection rate data (INJA) is ignored when this option is
used.
4.8.1 Maximum Injection Target for a Group (INJTAR)

00 The INJTAR card is used to specify the maximum injection target for a group.
RSTD
GATHER RRES
FLOSTA W FSTD
INJTAR inum qtarg
AREA G FRES
FIELD FRESN
OFF
00 Definitions:

00 Alpha label indicating the level of the well management hierarchy to which
the maximum injection rate applies:
FLOSTA Flow Station.
AREA Area.
FIELD Field.

level.
W Water injection.
G Gas injection.
RSTD Rate specified is at surface condition, STB/D (STM3/D)

for water and MSCF/D (SM3/D) for gas.
RRES Rate specified is at reservoir condition, RB/D (M3/D).
FSTD Rate specified is a fraction of the phase production rate.
FRES Rate specified is a fraction of total voidage.
FRESN Rate specified is a fraction of net voidage.
OFF This keyword turns voidage injection by guide rate off

for all injection wells of this type (W or G). All injectors
of this type should be respecified for proper operation.
qtarg The maximum injection rate if either the RSTD or RRES

option is used. The fraction of the production rate if
either the FSTD, FRES, or FRESN option is used.
NOTE: If the RSTD or FSTD option is used, then the well should be defined with
the FSTD option on the INJ card. If the RRES, FRES, or FRESN option is
used, then the well should be defined with the FRES option on the INJ
card.
One and only one of the GATHER, FLOSTA, AREA, or FIELD labels
accepted.
One and only one of the W or G labels must be specified. There is no

default.
One and only one of the RSTD, RRES, FSTD, FRES, or FRESN
labels must be specified. There is no default.

The QMAX card specifies the maximum injection rate even though the
well type is FRES or FSTD.
4.8.2 Injection Guide Rate for a Group (INJGR)

00 The INJGR card is used to specify the injection guide rate for a group.
WELL GURTS grate

GATHER W GURTR grate
INJGR inum
FLOSTA G VOID
AREA VOIN
00 Definitions:
00 Alpha label indicating the level of the well management hierarchy to which
the injection guide rate applies:
WELL Well.
AREA Area.

level.
W Water injection.
G Gas injection
GURTS Guide rate in surface units will be input, STB/D or

MSCF/D (STM3/D or SM3/D).
GURTR Guide rate in reservoir units will be input, rb/D (rm3/D).
VOID Guide rate is set to voidage.
VOIN Guide rate is set to net voidage.
grate Guide rate for GURTS and GURTR options.
NOTE: If the VOID or VOIN option is used, then the guide rate need not be
specified and will be ignored if it is input.

For WELL, only the GURTS or GURTR option can be chosen.
One and only one of the WELL, GATHER, FLOSTA, or AREA labels
must be specified. There is no default.
One and only one of the W or G labels must be specified. There is no

default.
One and only one of the GURTS, GURTR, VOID, or VOIN labels
must be specified. There is no default.
4.9 Water Injection Pumps (Not available in VIP-THERM)

00 Groups of water injectors are commonly controlled by the same pump system,
especially in offshore situations, where a large number of injectors are often
driven from one pump system on an offshore platform. The discharge pressures of
these pump systems vary (usually decreasing) with flow rate delivered, so it is
inappropriate to assume that water injectors coupled to such a pump system
operate at a constant tubinghead pressure independent of the total flow rate
delivered by the pump system.
00 Water injectors connected to a common injection pump system can be modeled

accurately in VIP-EXECUTIVE by using the water injector pump system option.
Injectors connected to a common pump system must be defined within the same
gathering center. This gathering center is then assigned to a table of pump
discharge pressure (thp) versus flow rate using the IPUMP card. Finally the pump
characteristics may be defined using the PMPTAB card. The user may define
multiple pump tables and assign more than one gathering center to the same pump
table in much the same way that bottomhole pressure tables are now used.
4.9.1 Assign Injector Pump Characteristics Tables (IPUMP)

00 IPUMP data must be defined along with PMPTAB data if gathering center water
injectors are to be controlled by pump characteristics tables.
00 The IPUMP card allows the user to assign a table of water injector pump
characteristics to the water injectors in a gathering center.
IPUMP gl
ipmp1 ipmp2 . . . ipmpn
00 Definitions:
gl List of gathering centers for which the ipmp values are

being entered. (The gathering center list gl has the same
format as well lists wl). (see Section 1.5.2)

ipmp Number of the pump table (PMPTAB card) that defines

the pump characteristics for this gathering center.
NOTE: The number of ipmp values must equal the number of gathering centers
in the gathering center list.
4.9.2 Water Injection Pump Discharge Pressure (PMPTAB)

00 A PMPTAB card must be defined if an IPUMP card is entered for a
gathering center.
00 PMPTAB data are used to relate a water injection pump discharge pressure
(tubinghead pressure) to the flow rate delivered by the pump.
PMPTAB npmp
QPMP THP
q1 thp1
. .
. .
. .
qn thpn
00 Definitions:
npmp Number of the pump table being read.
QPMP Alpha label indicating that this column contains pump

flow rates.
THP Alpha label indicating that this column contains pump

discharge pressures.
q Pump flow rates, STB/D (STM3/D).
thp Pump discharge pressures, psia (kPa).
NOTE: 1. The number of pump flow rates and pump discharge pressure values
must be less than or equal to NPMPV (see DIM data).
2. The total number of pump tables must be less than or equal to

NPMPMX (see DIM data).
4.9.3 Convergence Criteria (WTRPUMP)

00 The WTRPUMP card allows the user to set the convergence criteria for the water

injection pump algorithm.
WTRPUMP itnpmp pmptol
00 Definitions:
itnpmp Maximum number of pump pressure iterations. Default is

10.
pmptol Rate tolerance for convergence of the pump pressure

iterations, STB/D (STM3/D). Default is 10 STB/D.

4.10 Gaslift
00 To invoke gaslift, THP data must also be defined.
4.10.1 Gaslift Allocation (QLIFT)

00 A QLIFT card is used to explicitly place a well on gaslift, to take a well off gaslift,
or to explicitly allocate the amount of lift gas going to the well.
QLIFT wl
qlift1 qlift2 . . . qliftn
00 Definitions:
wl List of production wells for which qlift values are being

qlift The rate, MSCF/D (SM3/D), at which lift gas is injected

into a production well:
A positive value causes a constant allocation of lift gas to

the well.
A zero value takes the well off gas lift.
A negative value causes invocation of an automatic

allocation procedure for the well. (See QLIFTA card)
NOTE: 1. The number of qlift values must equal the number of wells in the
well list.
2. If a well is on gaslift, one of the following indicators appears in the

GAS LIFT STATUS column of the production well summary:
SPEC Specified, a positive qlift value has been

supplied.
GLRTAB Optimal GLR table used to allocate lift gas

rate; a negative qlift value has been
supplied.
PFMCRV Performance curve algorithm used to

allocate lift gas rate; a negative qlift value
has been supplied.
*VLE Gaslift removed from well due to violation

of minimum gaslift efficiency constraint
GLEFMN.

*GLE Gaslift removed from well based on lift

efficiency when a gaslift gas shortage
occurs; a negative qlift value has been
supplied.
*WCT Gaslift removed from well based on water-

cut when a gaslift gas shortage occurs; rate
originally calculated using optimum LGR
table.
*SCL Gaslift gas rate scaled back due to a gaslift

gas shortage; a negative qlift value has been
supplied.
*HIT Gaslift gas removed from well that was

designated on the PFMCRV option hit list.
GLRMIN Gaslift gas rate reduced to honor the

specified glr minimum; rate originally
calculated using the PFMCRV algorithm.
GLRMAX Gaslift gas rate reduced to honor the

specified glr maximum; rate originally
calculated using the PFMCRV algorithm.
3. The gaslift rate is used by the program only to determine the flowing
bottomhole pressure which corresponds to the user-specified
tubinghead pressure limit. Gaslift is otherwise transparent to the user;
i.e., the gaslift rate is NOT included in daily gas production. Gaslift
can be used only on wells for which a THP card is entered.

4.10.2 Gaslift Gas Source (QLIFTA)

00 To invoke automatic gaslift for a well, a QLIFT card with a negative value
must be defined.
00 A QLIFTA card is used to specify the amount of available gaslift gas for
automatic allocation, the allocation method and the fraction of produced gas also
available as gaslift gas. The source of available gaslift gas is not
00 specified, merely its volume. The data are order dependent. If an item is left off it
is set to its default value, overriding any previously input value.
⎛ ⎞
GATHER ⎜ OPTTAB ⎟
⎜ TABGLE ⎟ ⎛ ⎞
QLIFTA
FLOSTA
inum qlifta ⎜ ⎟ ⎜ ALLWLS
⎟ (gasfct)
AREA
⎜ TABWC ⎟ ⎝ LFTWLS ⎠
⎜ TABSCL ⎟
FIELD ⎜ ⎟
⎝ PFMCRV ⎠
00 Definitions:
00 Alpha label indicating the level of the well management hierarchy to which the
specified gaslift gas data apply:
AREA Area.
FIELD Field.

level.
qlifta Amount of gaslift gas per day available for injection into
all of the production wells which are on automatic
allocation of gaslift gas, MSCF/D (SM3/D).
OPTTAB Alpha label indicating that optimal GLR tables are to be

used to compute the gaslift gas injection rate for each
well on automatic allocation of gaslift gas. (See
GLRTAB card)
TABGLE Alpha label indicating that wells will be shut in based on

gaslift efficiency when a gaslift shortage exists. The

gaslift gas injection rates are computed using the optimal

GLR tables.
TABWC Alpha label indicating that wells will be shut in based on

water cut when a gaslift shortage exists. The gaslift gas
injection rates are computed using the optimal GLR
tables.
TABSCL Alpha label indicating that gaslift gas injection rates will
be scaled back when a gaslift shortage exists. The gaslift
gas injection rates are computed using the optimal GLR
tables.
PFMCRV Alpha label indicating that the performance curve option

is to be used to calculate gaslift gas rates.
ALLWLS Alpha label causing a fraction of the gas produced from

this member of the well management hierarchy during
one timestep to be used as additional gaslift gas during
the next timestep. This is the default.
LFTWLS Alpha label causing a fraction of the gas produced from

only those wells in this member of the well management
hierarchy on gaslift during one timestep to be used as
additional gaslift gas during the next timestep.
gasfct Fraction of the produced gas to be used as gaslift gas.

Default is zero.
2. Gaslift gas is automatically allocated among those wells for which a

negative qlift value was entered on a QLIFT card.
3. The gaslift gas calculation using the optimal GLR tables is done
during the first outer iteration of each timestep. The calculated gaslift
gas rate is used for subsequent iterations.
4. For each well on automatic allocation, the gaslift gas rate is checked
against the allowable maximum defined on the GLGMAX card. If a
violation occurs the rate is reset to the maximum.

4.10.3 Optimal GLR Tables for Gaslift (GLRTAB)

00 GLRTAB data are used to relate gas-liquid (or gas-oil) ratio to flow rate and water
cut (and possibly pressure) for the computation of gaslift gas rates. More than one
well can refer to the same GLRTAB.
GLRTAB nglr
QLIQ
q1 q2 . . . qk
QO
WCUT wcut1 (wcut2 . . . wcutl)
(PRESSURE pres1 (pres2 . . . presm))
IQLIQ GLR
IWCUT (IPRES)
IQO GOR
iwcut1 iq1 (ip1) glr1

. . . .
. . . .
. . . .
iwcutl iqk (ipm) glrlkm
00 Definitions:
nglr Number of the optimal GLR table being read.
QLIQ Alpha label indicating that values on this card are liquid
rates (oil plus water). This must be used with GLR.
QO Alpha label indicating that values on this card are oil

rates. This must be used with GOR.
q Liquid or oil rates, STB/D (STM3/D). Values can be

unequally spaced.
WCUT Alpha label indicating that water-cut values are read on

this card.
wcut Water-cut values, fraction. Values can be unequally

spaced.

this card. This card is optional.

spaced.

IWCUT Alpha label indicating that the values read in the column
under this heading are water-cut indices.
IQLIQ Alpha label indicating that the values read in the column
under this heading are liquid rate indices. This must be
used with QLIQ.
IQO Alpha label indicating that the values read in the column
under this heading are oil rate indices. This must be used
with QO.
IPRES Alpha label indicating that the values read in the column
under this heading are pressure indices. This label can be
included only if a PRESSURE card was input.
GLR Alpha label indicating that the values read in the column
under this heading are gas-liquid ratios. This must be
used with QLIQ.
GOR Alpha label indicating that the values read in the column
under this heading are gas-oil ratios. This must be used
with QO.
iwcutl Index referring to the l-th water-cut value read.
ipm Index referring to the m-th pressure value read. This

index can be included only if a PRESSURE card was
input.
iqk Index referring to the k-th rate value read.
glrlkm The gas-liquid (gas-oil) ratio value corresponding to the

indicated water-cut, rate, and pressure values, SCF/STB
(SM3/STM3).
4.10.4 Optimal GLR Table Pointer for Gaslift (GLRTBP)

00 This card is used in conjunction with the GLRTAB card.
00 A GLRTBP card is used to specify the optimal GLR table to which a well on
automatic allocation of gaslift gas points.
GLRTBP wl
iglrtb1 iglrtb2 . . . iglrtbn
00 Definitions:
wl List of production wells for which iglrtb values are being


iglrtb The number of the optimal GLR table (GLRTAB card)

that defines the gas-liquid ratio, including lift gas, for this
well.
NOTE: 1. The number of iglrtb values must equal the number of wells in the
well list.
2. If an iglrtb value has not been specified for a well, the GLR table
pointer value used will be the same as the BHP table pointer input on
the ITUBE card.
4.10.5 Maximum Well Gaslift Gas Rate (GLGMAX)

00 A GLGMAX card is used to limit the gaslift gas rate for a well whose lift rate is
allocated automatically.
00 GLGMAX Card for WELLS
GLGMAX WELL wl
glgmax1 glgmax2 . . . glgmaxn
00 GLGMAX card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
GLGMAX inum glgmax
AREA
FIELD
00 Definitions for wells:
wl List of wells for which maximum gaslift gas rates are

glgmax Maximum gaslift gas rate for the well MSCF/D (SM3/
D).
00 Definitions for well management levels:
the specified maximum gaslift gas rate applies:

AREA Area.
FIELD Field.

level.
glgmax Maximum gaslift gas rate, MSCF/D (SM3/D). Default is

0.
NOTE: 1. If GLGMAX is specified at the well level, the number of glgmax

values must equal the number of wells in the well list.
2. If GLGMAX is specified by well management level, one and only

one of the GATHER, FLOSTA, AREA, or FIELD labels must be
specified. There is no default. When FIELD is specified the inum
entry may be omitted, or the value 1 may be input; no other value will
be accepted.
3. Only wells on automatic allocation of lift gas are checked against the
maximum.
4.10.6 Minimum Well Gaslift Gas Rate (GLGMIN)

00 A GLGMIN card is used to limit the gaslift gas rate for a well whose lift rate is
allocated automatically.
00 GLGMIN Card for WELLS
GLGMIN WELL wl
glgmin1 glgmin2 . . . glgminn
00 GLGMIN card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
GLGMIN inum glgmin
AREA
FIELD
00 Definitions for wells:
wl List of wells for which minimum gaslift gas rates are

glgmin Minimum gaslift gas rate for the well MSCF/D (SM3/D).

00 Definitions for well management levels:
the specified minimum gaslift gas rate applies:
AREA Area.
FIELD Field.

level.
glgmax Maximum gaslift gas rate, MSCF/D (SM3/D). Default is

0.
NOTE: 1. If GLGMIN is specified at the well level, the number of glgmin

values must equal the number of wells in the well list.
2. If GLGMIN is specified by well management level, one and only one

of the GATHER, FLOSTA, AREA, or FIELD labels must be
entry may be omitted, or the value 1 may be input; no other value will
be accepted.
3. Only wells on automatic allocation of lift gas are checked against the
minimum.
4.10.7 Additive Correction to GLR Tables (GLRADD)

00 This card is used in conjunction with the GLRTAB card.
00 The GLRADD card is used to provide an additive correction term to the value of
gas-liquid (or gas-oil) ratio obtained from the optimal GLR tables.
GLRADD wl
glradd1 glradd2. . . glraddn
00 Definitions:
wl List of production wells for which glradd values are

glradd Additive correction to apply to the value of gas-liquid (or

gas-oil) ratio obtained from the optimal GLR tables for

the well, SCF/STB (SM3/STM3). Value may be positive

or negative. Default is 0.0 SCF/STB.
NOTE: The number of glradd values must equal the number of wells in the well
list.
4.10.8 Time Interval for Gaslift Gas Rate Calculations (TESTGL)

00 The TESTGL card is used to specify the time interval between gaslift gas rate
calculations for automatic allocation of gaslift gas.
TESTGL tincg
00 Definition:
tincg Time interval between gaslift gas rate calculations for

automatic allocation of gaslift gas, days. Default is 0
days, causing calculations every timestep.
NOTE: The calculations are scheduled for the time at which the TESTGL card is
read plus tincg days. Until the simulation reaches that time, no
calculations will be performed. Timesteps are not adjusted to hit the time
exactly. Once the calculations are done, the new scheduled time will be
tincg days farther into the simulation.
4.10.9 Minimum Gaslift Efficiency (GLEFMN)

00 The GLEFMN card is used to specify a minimum gaslift efficiency to test against
each well on gaslift.
GLEFMN glefmn
00 Definition:
glefmn Minimum gaslift efficiency, STB/MMSCF (STM3/

KSM3); if the gaslift efficiency of a well, calculated as
oil production rate/gaslift gas rate, drops below glefmn,
the well will be taken off gaslift.
4.10.10 Performance Curve Option Data (PFMCRV)

00 The PFMCRV option enables the user to calculate gaslift gas rates based on the
lift efficiencies of the wells, where lift efficiency is defined as the incremental oil

produced (STB/D) per increment of gaslift gas (MMSCF/D).
PFMCRV
(GLRMIN glrmin)
(GLRMAX glrmax)
(LIFTEFF eff)
(MAXSCALE scale)
(GLDAMP gldamp)
⎛ ON
⎞
⎜ EFFSCL ( WARNING )⎟
⎝ OFF ⎠
⎛ ON
⎞
⎜ TOTGAS ⎟
⎝ OFF ⎠
(HITLIST wl)
⎛ WGLRMIN wl ⎞
⎜ ⎟
⎝ wglr 1 wglr 2 … wglr n ⎠
⎛ TIME ⎞
⎜ OUTFILE (freq)⎟
⎜ TNEXT ⎟
⎝ OFF ⎠
00
00 Definitions:
glrmin Minimum gas-liquid ratio with which to compare the

gas-liquid ratio at the performance curve operating
points, SCF/STB (SM3/STM3). The well’s gaslift gas
rate will be reset to honor this minimum. Default is 0.
glrmax Maximum gas-liquid ratio with which to compare the

gas-liquid ratio at the performance curve operating
points, SCF/STB (SM3/STM3). The well’s gaslift gas
rate will be reset to honor this maximum. Default is
1.E10.
eff Desired lift efficiency of the allocated gaslift gas rate

(i.e., the slope of the performance curve at the optimal
operating point), STB/MMSCF (STM3/KSM3). Default
is 10 STB/MMSCF.
scale Maximum scaleback factor to use in the algorithm for

reducing gaslift gas rates to meet target, fraction.
gldamp Damping factor a used in the SP gaslift optimization

algorithm of the Surface Pipeline Network option

(Section 10.19.9), fraction. Default is 0. Value must be

between 0. and 1., inclusive.
EFFSCL Alpha label indicating whether the uniform lift efficiency

scaleup option is to be used.
ON Keyword indicating the option is on.
OFF Keyword indicating the option is off.

WARNING Alpha label indicating that non-

convergence warning messages
generated by this option should be
printed. Default is to not print them.
TOTGAS Alpha label indicating how lift efficiency is to be

calculated.
ON Keyword indicating lift efficiency is to

be calculated as a function of total gas
(produced gas plus gaslift gas).
OFF Keyword indicating lift efficiency is to

be calculated as a function of gaslift gas.
HITLIST Alpha label indicating that the specified wells on this

card are to have their gaslift gas rates removed when the
total allocated lift rate exceeds the available lift gas.
wl List of wells on the hit list - each well

must be named, ranges of wells will not
be accepted.
WGLRMIN Alpha label indicating that the following data are

minimum gas-liquid ratios below which the wells are not
to be reduced during the scale-back step of reducing
gaslift gas rates.
wl List of wells for which gas-liquid ratio

values are being specified (see Section
1.5.2).
wglr Minimum gas-liquid ratios, SCF/STB

(SM3/ STM3). Default is 0.
OUTFILE Alpha label indicating that for the gaslift gas

optimization option (Section 4.11) performance curve
data for each well is to be written to the file named
<casename>_pfmcrv.out.

TIME Alpha label that causes the file to be

written each time the DATE or TIME
card is encountered.
TNEXT Alpha label that causes the file to be

written only the next time a DATE or
TIME card is encountered.
OFF Alpha label that causes the file not to be

written. This is the default.
freq A number that causes the file to be

written after every freq timestep (each
timestep cut counts as a timestep).
NOTE: Usage of this option requires that the BHPTAB wellbore hydraulics tables
have been input with a sufficient range to cover all of the oil, water, and
total gas (produced reservoir gas plus gaslift gas) rates that may be
encountered with the gaslift calculations. It should be noted that the
wellbore hydraulics algorithm will extrapolate outside of the table range,
if necessary. Warning messages are printed for table extrapolations. This
feature provides the user with a mechanism for determining gaslift gas
allocation without having to generate optional gas-liquid/gas-oil ratio
tables. An internal table is generated and user-supplied data determines the
point at which the gaslift gas rate is found.
The data related to the HITLIST, MAXSCALE and WGLRMIN keywords

is ignored when the EFFSCL option is turned on.
When WGLRMIN data is entered, the number of gas-liquid ratio values

must equal the number of wells in the well list.
4.10.11 Gaslift Gas in Gas Handling Loop (GLGOP)

00 The GLGOP card is used to assign the gaslift gas as part of the gas handling loop.
OPEN
GLGOP
CLOSE
00 Definitions:
OPEN Gaslift gas in part of the gas handling loop.
CLOSE Gaslift gas is not included in the gas handling loop. This
is the default.
00 Reinjection volumes are calculated based on the sum of produced and gaslift gas.
At any given time, the amount of gas in the loop will be:

00 [produced + makeup - shrinkage - fuel + previous gas lift +

makeup gas lift = sales + injection + current gas lift]
00 Examples:
00 C ***** GASLIFT GAS IS PART OF THE GAS HANDLING LOOP

C
GLGOP OPEN
4.10.12 Makeup Gaslift Gas Specification (QLIFTM)

00 The QLIFTM card is used to specify the makeup gaslift gas rate, when gaslift gas
is part of the gas handling loop (GLGOP OPEN).
GATHER
FLOSTA
QLIFTM inum qrate (frate)
AREA
FIELD
00 Definitions:
00 Alpha label indicating the level of well management hierarchy to which the
makeup gaslift gas rate applies:
AREA Area.
FIELD Field.

level.
qrate Makeup gaslift gas rate, MSCF/D (SM3/D).
frate Fraction of the surface production rate.
NOTE: If both qrate and frate are specified, the makeup gaslift gas rate is the
specified rate plus the fraction of the surface production rate. (qrate + frate
* the surface production rate).
00 Examples:
00 C ***** MAKEUP GASLIFT GAS RATE

QLIFTM GATHER 1 100. 0.1

QLIFTM GATHER 2 50.
4.11 Multi-level Optimization of Gaslift Gas Utilization
4.11.1 Introduction
00 The primary function of this algorithm is to optimize (i.e., minimize) the gaslift
gas required to meet the specified oil targets at any specified group level. It can
only be used for oil phase targets. The optimization is performed by finding the
maximum common gaslift gas operating efficiency at which the target rate can be
met.
4.11.2 Specifications
00 There are several specifications required to invoke the optimization. These are:
n QLIFTA (Section 4.10.2) data specifying PFMCRV for each level at which
the optimization is requested.
n PTARG (Section 4.3.1) data specifying an O (oil) target for the level.
n TRGOPT (Section 4.3.4) data, for phase O, specifying the SCALE option for
reduction of the oil rate to meet the target. This is the default if no TRGOPT
data for phase O is input.
n PFMCRV (Section 4.10.10) data introduced, including the optional OUTFILE

label.
n EFFSCL (Section 4.10.10) efficiency scaling specified.
n One or more wells on automatic gaslift gas allocation, (see QLIFT, Section
4.10.1).
00 For each well on automatic gaslift gas allocation using the performance curve
option, a performance curve is constructed at the start of each specified Newton
iteration, describing the relationship of oil production rate versus gaslift gas
utilized. These curves will be used in the optimization algorithm to determine the
maximum common operating efficiency (minimum total gaslift gas requirement)
required to meet the oil target. No gaslift gas will be used if the target can be met
without any gaslift gas.
00 In order to have smooth and continuous relationships for the gaslift performance
for the wells, a multi-segmented second-order curve fit is employed for the
function of oil rate versus the log of gaslift gas rate. The derivative of this
function is then used to determine the current operating efficiency at any gaslift
gas rate within the interval.

4.11.3 Gaslift Optimization Outer Iteration Number (ITNGLG)
ITNGLG nitglg
nitglg Maximum number of iterations per timestep at which to

perform the gaslift gas optimization algorithm. Default is
1.

4.12 Automatic Drilling Option

00 The parameter NRIGTOT must be greater than zero on the DIM card to activate
the automatic drilling option.
00 The total number of rigs defined by all DRLRIG and WRKRIG cards may not
exceed the dimension NRIGTOT.
4.12.1 Drilling Rig Definition (DRLRIG)

00 The DRLRIG card is used to define the drilling rigs available at any well
management level and all levels below it. Rigs can be added or removed at any
time.
GATHER ADD
irigs
DRLRIG FLOSTA inum REPLACE (wktim) (mvtim)
ALL
AREA SUBTRACT
FIELD
00 Definitions:
the specified rig is available:
AREA Area.
FIELD Field.

level.
ADD Alpha label indicating irigs rigs should be added to the

number of rigs available.
REPLACE Alpha label indicating the rigs specified should replace

any previously specified rigs for this member of well
management.
SUBTRACT Alpha label indicating irigs rigs should be subtracted.
irigs Number of rigs.

ALL Alpha label indicating all rigs currently assigned are to be

subtracted.
wktim Time required to complete a workover, days. Default is

0.
mvtim Time required to move a rig, days. Default is 0.
NOTE: 1. ALL can be used only with SUBTRACT. If irigs is used to subtract
rigs, they are subtracted from the bottom of the list.
2. One and only one of the GATHER, FLOSTA, AREA, or FIELD

4.12.2 List of Wells in Drilling Queues (DRILLQUEUE)

00 The DRILLQUEUE card is used to define sets of wells to be drilled in the
automatic drilling option, either automatically based on rig availability or when
specified group targets cannot be met.
⎛ NEW ⎞ ⎛ ⎞
DRILLQUEUE n ⎜ APPEND ⎟ ⎝
AUTO
⎠ (name)
⎝ OFF
⎠ NORIGS
GATHER
FLOSTA
ALL
GROUP AREA
list
FIELD
INJREG
.
.
.
GROUP . . .
TARGETS [targets]
POTENTIAL [phase] (thrate)
00 wl
qmax1 qmax2 ... qmaxn
00 Definitions:
n Drilling queue number. This is required.
NEW Alpha label indicating that this data replaces any

previously specified data for this drilling queue. This is

the default if none of the labels NEW, APPEND, or OFF

is entered.
APPEND Alpha label indicating that this data is in addition to any

previously specified data for this drilling queue.
OFF Alpha label indicating that this drilling queue no longer

exists. All previously entered data for this queue is
erased. No data (GROUP, TARGETS, POTENTIAL,
well list or qmax) may be entered after the
DRILLQUEUE card.
AUTO Alpha label indicating that this drilling queue is not

subject to any conditions. The wells will be drilled in the
order specified as long as rigs are available. Only one
drilling queue may be designated as AUTO; a previously
designated AUTO drilling queue will lose that
designation.
NORIGS Alpha label indicating that wells are to be drilled from

this queue independent of rig availability. This applies
only for the targeting option; NORIGS may not be
specified for the AUTO queue.
name Drilling queue name. This should only be entered when a

new queue is being defined. It will be ignored if
APPEND is specified for a queue with previously entered
data.
GROUP This record is used to define the members of the well

management hierarchy that will be checked for not
meeting targets. If one or more of the targets is not met,
the next available well in the well list will be drilled. The
well management hierarchy levels are:
GATHER Gathering center

FLOSTA Flow station
AREA Area
FIELD Field
INJREG Injection region
Note that multiple GROUP cards can be entered.
ALL Alpha label indicating that all the members of this level
are to be included.
list One or more names or numbers of members of this level

to be included. This may be left blank, or the number 1
must be specified, if FIELD is entered.

TARGETS This record is used to define which production targets

(PTARG) or injection targets (ITARG) are to be checked
for the drilling option. Production and injection targets
may not both be specified for a queue. Also, only
injection targets may be specified if the INJREG
group is entered for this queue.
The rates used to compare against targets are the sums of

the well rates before possible reductions due to surface
network constraints and/or targeting. See DRLTRG card
for the specification of the targets against which the rates
are compared.
One or more of the following may be entered on the

TARGETS card:
OILPROD Oil production target

LIQPROD Liquid production target
GASPROD Gas production target
WATPROD Water production target
GASINJ Gas injection target
WATINJ Water injection target
POTENTIAL This record is used to designate that, when the next

available well in the queue is to be determined, the
eligible well with the greatest flow potential is chosen.
One of the following may be entered for phase on the
POTENTIAL card:
OILPROD Oil production

LIQPROD Liquid production
GASPROD Gas production
WATPROD Water production
GASINJ Gas injection
WATINJ Water injection
thrate Threshold rate above which a well must flow to be a

drilling candidate with the POTENTIAL option. Units:
STB/D (STM3/D) for oil, water, liquid, and MSCF/D
(KSM3/D) for gas. Default is 0.
wl List of wells in this drilling queue. All data necessary for

each of these wells is assumed to have been entered by
the time the well is drilled. The rate type MULTRT is
not allowed for a well in a drill queue.
qmax Maximum production/injection rate for each well to be

drilled. The units of this rate depend on the well type (see
QMAX card).
00

00 Example:
00 DRILLQUEUE 2
GROUP GATHER 1 3
GROUP FLOSTA 4
TARGETS OILPROD GASPROD
10 11 13 -15 12 20
7*1500
4.12.3 Target Specification (DRLTRG)

00 The DRLTRG card is used to specify the how the target used in the
DRILLQUEUE algorithm is to be computed.
00 If a DRLTRG card is not entered for a target type specified in the

DRILLQUEUE data, the target rate checked will default to 1.2 times the
appropriate production/injection target.
GPROD
GATHER
OPROD
FLOSTA MULT
AREA WPROD
DRLTRG inum drltrg INCR
FIELD LPROD
RATE
INJREG GINJ
WINJ
00 Definitions:
the specified data applies:
AREA Area.
FIELD Field.
INJREG Injection Region.

level.

GPROD Alpha label indicating that the data on this card applies to
gas production target specified on the DRILLQUEUE
card.
OPROD Alpha label indicating that the data on this card applies to
oil production target specified on the DRILLQUEUE
card.
WPROD Alpha label indicating that the data on this card applies to
water production target specified on the DRILLQUEUE
card.
LPROD Alpha label indicating that the data on this card applies to
liquid production target specified on the DRILLQUEUE
card.
GINJ Alpha label indicating that the data on this card applies to
gas injection target specified on the DRILLQUEUE card.
WINJ Alpha label indicating that the data on this card applies to
water injection target specified on the DRILLQUEUE
card.
drltrg Value used to compute the target rate to be checked;

definition depends on input of MULT, INCR, or RATE.
Units: for MULT, drltrg is a multiplier; for INCR and
RATE, unit is STB/D (STM3/D) for oil, water, liquid,
and is MSCF/D (KSM3/D) for gas.
MULT Alpha label indicating that the target rate to be checked is

drltrg times the appropriate production/injection target.
INCR Alpha label indicating that the target rate to be checked is

the sum of drltrg and the appropriate production/
injection target.
RATE Alpha label indicating that the target rate to be checked is

drltrg.
NOTE: 1. The only data not required is inum if FIELD is entered. When
FIELD is specified the inum entry may be omitted, or the value 1
may be input; no other value will be accepted.

4.12.4 Drilling of Replacement Wells (DRILLWELL)

00 The DRILLWELL card is used to define triggering conditions related to
production or injection data for wells, and the replacement well to be drilled if any
of the triggering conditions are met. Note that the keyword ENDDRILLWELL
must be entered to end the DRILLWELL data.
DRILLWELL ⎛ NEW ⎞
⎝ APPEND ⎠
00 WELL (triggers) DRILL (QMAX) (RIGS)
00 n (values) m (qmax) (rigs)

(Data card is repeated as necessary.)
00 ENDDRILLWELL
00 Definitions
NEW Alpha label indicating that this data replaces any

previously specified DRILLWELL data. This is the
default if neither NEW nor APPEND is entered.
APPEND Alpha label indicating that this data is added to any

previously specified DRILLWELL data.
WELL Column header for a well or set of wells for which a well
will be drilled if any of the trigger conditions are met.
This column is required. See definition of n for the
specification of this data.
DRILL Column heading for the well, or the drilling queue from
which a well will be selected, to be drilled if any of the
trigger conditions are met. This column is required.
QMAX Column heading for the maximum rate at which the

drilled well will be set. This must be input if a well is
specified in the DRILL column. The value, or the label
X, will be ignored if a drilling queue is specified in the
DRILL column. The units of the rate depend on the well
type of the drilled well (see PROD card (Section 3.4.1),
or INJ card(Section 3.4.2)).
RIGS Column heading for YES or NO, indicating whether rig

availability should be checked when drilling the
replacement well. If this column is not specified, YES is
assumed.

triggers At least 1 trigger must be entered. The following

column headings are available to trigger the automatic
drilling of a replacement well:
Well is an injector:
MAXQGI Maximum gas injection

MAXQWI Maximum water injection
MINQGI Minimum gas injection
MINQWI Minimum water injection
Well is a producer:
MAXQG Maximum gas production

MAXQO Maximum oil production
MAXQW Maximum water production
MAXQLIQ Maximum liquid production
MINQG Minimum gas production
MINQO Minimum oil production
MINQW Minimum water production
MINQLIQ Minimum liquid production
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
n Name or number of the well that will be shut in if any of

the trigger conditions are met. If a group of wells is
specified, each well in the group will be checked against
the trigger conditions. A group may be defined by
specifying one of the following (the number 1 must be
entered for FIELD):
GATHER #
FLOSTA #
AREA #
FIELD #
INJREG #

m Name or number of the well to be drilled
OR
The keyword QUEUE followed by the name or number

of the drilling queue. In this case, the next available well
(by specified order or potential) in the queue is drilled.
If a group of wells is specified under WELL and m is a

single well, the first well to meet a trigger condition will
be shut in and well m will be drilled. If m is a drill queue,
wells in the group will continue to be checked until either
all are shut in or the drilling queue is empty.
rigs One of either YES or NO, indicating whether rig

availability should be checked when drilling the
replacement well.
NOTE: 1. The alpha label X may be entered in any trigger column for which
data for this well is not wanted. That trigger will not be checked.
2. Once a well is replaced, it is permanently shut in. If crossflow had

been specified for the shut-in well, that is turned off also.
00 Example:
00 DRILLWELL
WELL MINQO MAXQW MAXQGI DRILL QMAX
00 PROD8 50 2000 X PROD8A 5000
INJ2 X X 1000000 QUEUE INJ2Q 100000
GATHER 2 75 3000 X PRDGC2 5000
ENDDRILLWELL

4.12.5 Elapsed Time to Drill a Well (WLDRTIME)

00 The WLDRTIME card is used to define the time necessary to complete the
drilling of a well in the automatic drilling option.
00 WLDRTIME Card for WELLS
WLDRTIME WELL wl
delt1 delt2 ... deltn
00 WLDRTIME Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
WLDRTIME inum delt
AREA
FIELD
00 Definitions: for wells
wl List of wells for which elapsed times are being specified

delt Time necessary to complete the drilling of a well, days.

Default is 0.
00 The number of delt values must equal the number of wells in the well list.
00 Definitions: for well management levels
the specified elapsed time applies:
GATHER Gathering Center

FLOSTA Flow Station
AREA Area
FIELD Field

level.
delt Time necessary to complete the drilling of a well in the

specified well management level, days. Default is 0.

NOTE: 1. Elapsed times can be input at the well level or at any other level of
well management. The effective elapsed time for a well will be the
one specified at the lowest level of the well hierarchy: i.e., the first
user-specified number found in the order: well, the appropriate
gathering center, the appropriate flow station, the appropriate area,
and the field.
2. If WLDRTIME is specified by well management level one and only

one of the GATHER, FLOSTA, AREA, or FIELD labels must be
entry may be omitted or the value 1 may be input; no other value will
be accepted.
00 Example:
00 WLDRTIME FIELD 1 100

WLDRTIME WELL 1 -10
10*75

4.13 Automatic Well Workovers

00 This section describes an automatic well workover package.
00 The parameter NRIGTOT must be greater than zero on the DIM card to activate
the automatic workover module.
00 Required data for this option to be functional are: WRKRIG, WRKRTO,

WRKFRQ, and WRKCOEF.
00 The user should refer to the DIM card for additional dimensioned variables used
for workovers. The workover report can be obtained by using the keyword
WRKRPT on the OUTPUT card.
00 When using the GLIMIT or WLIMIT card, the PLUG option can not be used with
the new workover module.
00 The PRFLIM option cannot be used with the automatic workover module.
00 The total number of rigs defined by all WRKRIG and DRLRIG cards may not
exceed the dimension NRIGTOT.
4.13.1 Workover Rig Definition (WRKRIG)

00 The WRKRIG card is used to define the workover rigs available at any well
management level and all levels below it. Rigs can be added or removed at any
time.
GATHER
ADD
FLOSTA irigs
WRKRIG inum REPLACE wktim mvtim
AREA ALL
SUBTRACT
FIELD
00 Definitions:
the specified rig is available:
AREA Area.
FIELD Field.


level.
ADD Alpha label indicating irigs rigs should be added to the

number of rigs available.
REPLACE Alpha label indicating the rigs specified should replace

any previously specified rigs for this member of well
management.
SUBTRACT Alpha label indicating irigs rigs should be subtracted.
irigs Number of rigs.
ALL Alpha label indicating all rigs currently assigned are to be

subtracted.
wktim Time required to complete a workover, days.
mvtim Time required to move a rig, days.
NOTE: ALL can be used only with SUBTRACT. If irigs is used to subtract rigs,
they are subtracted from the bottom of the list.
The data wktim and mvtim are required for ADD and REPLACE.
accepted.
4.13.2 Relative Number of Workovers (WRKRTO)

00 The WRKRTO card defines the relative number of each type of workover to
perform.
WRKRTO opnrto gclrto wclrto
00 Definitions:
opnrto Number of opening workovers. Default is 0.
gclrto Number of gas closing workovers. Default is 0.
wclrto Number of water closing workovers. Default is 0.
NOTE: First opnrto opening workovers will be performed, followed by gclrto

gas closing workovers, followed by wclrto water closing workovers,

followed by opnrto opening workovers, etc. A value of zero implies no

workovers of that type are to be performed.
If this card is omitted no workovers will be performed.
4.13.3 Workover Calculation Frequency (WRKFRQ)

00 The WRKFRQ card is used to specify the frequency with which the workover
calculations are performed when predictive well management (PWM) is not used.
The workover calculations are automatically performed whenever PWM
calculations are done.
MONTHS
WRKFRQ freq DAYS
TSTEPS
00 Definitions:
freq Frequency with which the workover calculations will be

performed. Default is 99999 timesteps.
NOTE: Within the simulator the date on a DATE card is considered to be the
beginning of that day. For example, if output is desired at the end of March
1988, the date card should contain 1/4/88 and not 31/3/88. Thus the
MONTHS option on the frequency card will force a timestep to start at the
date 1/month/year.

4.13.4 Elapsed Time Between Workovers (WRKDLT)

00 The WRKDLT card is used to define the elapsed time between the end of a
workover and the beginning of the next.
00 WRKDLT Card for WELLS
WRKDLT WELL wl
delt1 delt2. . .deltn
00 WRKDLT Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
WRKDLT inum delt
AREA
FIELD
wl List of wells for which elapsed times are being specified

delt Elapsed time that must occur between the end of a

workover and the beginning of the next workover on a
well, days. Default is 0.
00 The number of delt values must equal the number of wells in the well list.
the specified elapsed time applies:
AREA Area.
FIELD Field.

level.
delt Elapsed time that must occur between the end of a

workover and the beginning of the next workover on a

well under the specified well management level, days.

Default is 0.
NOTE: Elapsed times can be input at the well level or at any other level of well
management. The effective elapsed time for a well will be the one
specified at the lowest level of the well hierarchy: i.e., the first user-
specified number found in the order: well, the appropriate gathering
center, the appropriate flow station, the appropriate area, and the field.
If WRKDLT is specified by well management level one and only one of

the GATHER, FLOSTA, AREA, or FIELD labels must be specified. There
is no default. When FIELD is specified the inum entry may be omitted or
the value 1 may be input; no other value will be accepted.
4.13.5 Workover Failure Rate (WRKFAIL)

00 The WRKFAlL card defines the failure rate of workovers.
WRKFAIL ifail
00 Definition:
ifail Frequency of workover failure. Default is 0.
00 Every ifail-th workover will fail, if ifail is positive. A non-positive value implies
that workovers never fail.
4.13.6 Well Limit for Automatic Shutoffs (WRKWLM)

00 The WRKWLM card defines global gas-oil ratio and water-cut limits below
which a well will not be considered a candidate for automatic shutoffs for gas and
water, respectively.
WRKWLM gorwlm wctwlm
00 Definitions:
gorwlm Well gas-oil ratio limit below which a well will not be
considered a candidate for automatic gas shutoff, SCF/
STB (SM3/STM3). Default is wells are always eligible.
wctwlm Well water-cut limit below which a well will not be

considered a candidate for automatic water shutoff,
fraction. Default is wells are always eligible.

4.13.7 Workover Benefit Function Limits (WRKLIM)

00 The WRKLIM card is used to define workover benefit function limits.
00 WRKLIM Card for WELLS
WRKLIM WELL wl
(OPMIN opmin1 opmin2 ... opminn)
(GPMIN gpmin1 gpmin2 ... gpminn)
(WPMIN wpmin1 wpmin2 ... wpminn)
(MINQO minqo1 minqo2 ... minqon)
(MINQG minqg1 minqg2 ... minqgn)
(MINQW minqw1 minqw2 ... minqwn)
(MAXWCUT mxwc1 mxwc2 ... mxwcn)
(MAXGOR mxgor1 mxgor2 ... mxgorn)
(MINWCUT mnwc1 mnwc2 ... mnwcn)
(MINGOR mngor1 mngor2 ... mngorn)
(WSMIN wsmin1 wsmin2 ... wsminn)
(GSMIN gsmin1 gsmin2 ... gsminn)
00 WRKLIM Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
WRKLIM inum
AREA
FIELD
(OPMIN opmin)
(GPMIN gpmin)
(WPMIN wpmin)
(MINQO minqo)
(MINQG minqg)
(MINQW minqw)
(MAXWCUT mxwc)
(MAXGOR mxgor)
(MINWCUT mnwc)
(MINGOR mngor)
(WSMIN wsmin)
(GSMIN gsmin)
wl List of wells for which workover limit data is being

opmin Minimum workover benefit value for oil perforations,

STB/D (STM3/D). Default is 0.

gpmin Minimum workover benefit value for gas perforations,

MSCF/D (SM3/D). Default is 0.
wpmin Minimum workover benefit value for water perforations,

minqo Minimum oil rate in an openable (oil) perforation, STB/D

minqg Minimum gas rate in an openable (gas) perforation,

minqw Minimum water rate in an openable (water) perforation,

mxwc Maximum water cut in an openable (oil or gas)

perforation, fraction. Default is 1.
mxgor Maximum gas-oil ratio in an openable (oil) perforation,

SCF/STB (SM3/STM3). Default is 1.E20.
mnwc Minimum water cut in a shutable (water) perforation,

fraction. Default is 0.
mngor Minimum gas-oil ratio in a shutable (gas) perforation,

SCF/STB (SM3/STM3). Default is 0.
wsmin Minimum workover benefit value for water shutoffs,

gsmin Minimum workover benefit value for gas shutoffs,

00 The number of opmin, gpmin, wpmin, minqo, minqg, minqw, mxwc, mxgor,
mnwc, mngor, wsmin, and gsmin values must equal the number of wells in the
well list.
AREA Area.
FIELD Field.

level.

opmin Minimum workover benefit value for oil perforations,

gpmin Minimum workover benefit value for gas perforations,

wpmin Minimum workover benefit value for water perforations,

minqo Minimum oil rate in an openable (oil) perforation, STB/D

minqg Minimum gas rate in an openable (gas) perforation,

minqw Minimum water rate in an openable (water) perforation,

mxwc Maximum water cut in an openable (oil or gas)

perforation, fraction. Default is 1.
mxgor Maximum gas-oil ratio in an openable (oil) perforation,

SCF/STB (SM3/STM3). Default is 1.E20.
mnwc Minimum water cut in a shutable (water) perforation,

fraction. Default is 0.
mngor Minimum gas-oil ratio in a shutable (gas) perforation,

SCF/STB (SM3/STM3). Default is 0.
wsmin Minimum workover benefit value for water shutoffs,

gsmin Minimum workover benefit value for gas shutoffs,

NOTE: Workover limit values can be input at the well level or at any other level of
well management. The effective values for a well will be the one specified
at the lowest level of the well hierarchy; i.e., the first user-specified
number found in the order: well, the appropriate gathering center, the
appropriate flow station, the appropriate area, and the field.
If WRKLIM is specified by well management level, one and only one of

4.13.8 Group Numbers for "Group 1" (WRKGP1)

00 The WRKGP1 card is used to define the "Group 1" group number in which a well

lies. This allows more flexibility in the use of the benefit functions.
00 WRKGP1 Card for WELLS
WRKGP1 WELL wl
igp11 igp12 . . . igp1n
00 WRKGP1 Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
WRKGP1 inum igp1
AREA
FIELD
wl List of wells for which group numbers are being

igp1 "Group 1" group number for the well. Default is

NWRKG1+1.
00 The number of igp1 values must equal the number of wells in the well list.
the specified "Group 1" group number applies:
AREA Area.
FIELD Field.

level.
igp1 "Group 1" group number for each well under the
specified well management level. Default is
NWRKG1+1.
NOTE: "Group 1" group numbers can be input at the well level or at any other
level of well management. The effective "Group 1" group number for a

well will be the one specified at the lowest level of the well hierarchy; i.e.,
the first user-specified number found in the order: well, the appropriate
gathering center, the appropriate flow station, the appropriate area, and the
field.
If WRKGP1 is specified by well management level, one and only one of

4.13.9 Group Numbers for "Group 2" (WRKGP2)

00 The WRKGP2 card is used to define the "Group 2" group number in which a well
lies. This allows more flexibility in the use of the benefit functions.
00 WRKGP2 Card for WELLS
WRKGP2 WELL wl
igp21 igp22 . . . igp2n
00 WRKGP2 Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
WRKGP2 inum igp2
AREA
FIELD
wl List of wells for which group numbers are being

igp2 "Group 2" group number for the well. Default is

NWRKG2+1.
00 The number of igp2 values must equal the number of wells in the well list.
the specified "Group 2" group number applies:

AREA Area.
FIELD Field.

level.
igp2 "Group 2" group number for each well under the
NWRKG2+1.
NOTE: "Group 2" group numbers can be input at the well level or at any other
level of well management. The effective "Group 2" group number for a
well will be the one specified at the lowest level of the well hierarchy; i.e.,
the first user-specified number found in the order: well, the appropriate
gathering center, the appropriate flow station, the appropriate area, and the
field.
If WRKGP2 is specified by well management level one and only one of

4.13.10 “Group 1” Default Coefficients (WRKCF1)

00 WRKCF1 card for GROUPS
WRKCF1 GROUP gl
coef11 coef12 . . . coef1n
00 WRKCF1 card for WELLS
WRKCF1 WELL wl
00 Definitions: for groups
gl List of groups for which "Group 1" coefficients are being

coef1 "Group 1" coefficients for each well in the group. Default
is 1.
00 The number of coef1 values must equal the number of groups in the group list.

wl List of wells for which "Group 1" coefficients are being

coef1 "Group 1" coefficient to use for the well. Default is 1.
00 The number of coef1 values must equal the number of wells in the well list.
NOTE: The default values for "Group 1" coefficients for each well in the group
can be specified by using the first form of the card. Subsequently, the
defaults can be changed for specific wells by specifying coefficients by
well.
4.13.11 “Group 2” Default Coefficients (WRKCF2)

00 WRKCF2 card for GROUPS
WRKCF2 GROUP gl
00 WRKCF2 card for WELLS
WRKCF2 WELL wl
00 Definitions: for groups
gl List of groups for which "Group 2" coefficients are being

coef2 "Group 2" coefficients for each well in the group. Default
is 1.
00 The number of coef2 values must equal the number of groups in the group list.
wl List of wells for which "Group 2" coefficients are being

coef2 "Group 2" coefficient to use for the well. Default is 1.
00 The number of coef2 values must equal the number of wells in the well list.
NOTE: The default values for "Group 2" coefficients for each well in the group
can be specified by using the first form of the card. Subsequently, the
defaults can be changed for specific wells by specifying coefficients by

well.
4.13.12 Coefficients for Workover Benefit Functions (WRKCOEF)

00 WRKCOEF Card for WELLS
WRKCOEF WELL wl
A a1 a2 . . . an
B b1 b2 . . . bn
C c1 c2 . . . cn
D d1 d2 . . . dn
E e1 e2 . . . en
00 WRKCOEF Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
WRKCOEF inum a b c d e
AREA
FIELD
wl List of wells for which benefit function coefficients are

A Alpha label indicating coefficients for oil perforations.
B Alpha label indicating coefficients for gas perforations.
C Alpha label indicating coefficients for water perforations.
D Alpha label indicating coefficients for gas shutoff.
E Alpha label indicating coefficients for water shutoff.
a Oil perforation coefficients for wells. Default is 0.
b Gas perforation coefficients for wells. Default is 0.
c Water perforation coefficients for wells. Default is 0.
d Gas shutoff coefficients for wells. Default is 0.
e Water shutoff coefficients for wells. Default is 0.

00 The number of a, b, c, d and e values must equal the number of wells in the well
list.
the specified workover benefit function coefficients apply:
AREA Area.
FIELD Field.

level.
a Oil perforation coefficient for each well under the

specified well management level. Default is 0.
b Gas perforation coefficient for each well under the

c Water perforation coefficient for each well under the

d Gas shutoff coefficient for each well under the specified

well management level. Default is 0.
e Water shutoff coefficient for each well under the

00 Note:
00 The benefit functions for workovers are defined as:
00 BFop =GP1i * GP2j * ( a * Op+ b * Gp+c * Wp)

BFgs =GP1i * GP2j * ( d * Gs )
BFws =GP1i * GP2j * ( e * Ws )
00 where:
BFop opening benefit function,
BFgs gas shutoff benefit function,
BFws water shutoff benefit function,
GP1i i-th Group 1 coefficient (WRKCF1),

GP2j j-th Group 2 coefficient (WRKCF2),
Op workover benefit for oil perforations, defined as the sum

of oil rates in openable perforations,
Gp workover benefit for gas perforations, defined as the sum

of gas rates in openable perforations,
Wp workover benefit for water perforations, defined as the

sum of water rates in openable perforations,
Gs workover benefit for gas shutoffs, defined as the sum of

gas rates in shutable perforations,
Ws workover benefit for water shutoffs, defined as the sum

of water rates in shutable perforations.
00 Only one of the coefficients a, b and c can be nonzero.
00 The coefficients b and d cannot both be nonzero.
00 The coefficients c and e cannot both be nonzero.
00 Benefit function coefficients can be input at the well level or at any other level of
well management. The effective coefficient values for a well will be the one
specified at the lowest level of the well hierarchy; i,e., the first user-specified
number found in the order: well, the appropriate gathering center, the appropriate
flow station, the appropriate area, and the field.
00 If WRKCOEF is specified by well management level, one and only one of the
GATHER, FLOSTA, AREA, or FIELD labels must be specified. There is no
default. When FIELD is specified the inum entry may be omitted or the value 1
may be input; no other value will be accepted.
4.13.13 Debug Output (WRKDBG)

00 The WRKDBG card is used to obtain debug output during the workover
calculations.
WRKDBG kwrkdb
00 Definition:
kwrkdb Level of debug output:
3 Well and workover reports are printed

after completion of workovers, If set to -

3, the rig distribution table is also

printed.
2 Workover report is printed after

completion of workovers, If set to -2, the
rig distribution table is also printed.
1 Rig distribution table is printed at the

end of input.
0 No debug output. This is the default.
4.14 Fluid Tracking (Not available in VIP-THERM)
4.14.1 Fluid Tracking Option (TRACK)

00 The TRACK card is required to use the fluid tracking option.
00 The TRACK card is used to define data relating to the fluid tracking option.
TRACK
(WTC wtc1 wtc2 ... wtcnfl)
(WTV wtv1 wtv2 ... wtvnfl)
(CONDENSATE retrog cgas)
(TRKTOL trktlo trktlg)
(NOWELL)
(TRCKOF)
00 Definitions:
wtc Weighting factor for each tracked fluid used in the

calculation of the mass transfer terms for condensation.
Default is 1.0.
wtv Weighting factor for each tracked fluid used in the

calculation of the mass transfer terms for vaporization.
Default is 1.0.
retrog Number of the retrograde tracked fluid.
cgas Number of the tracked fluid which forms retrograde.
trktlo Oil phase residual tolerance. If the tolerance is violated, a

warning message is written. Default is 0.00001.
trktlg Gas phase residual tolerance. If the tolerance is violated,

a warning message is written. Default is 0.00001.

NOWELL Alpha label specifying that production information on the

well level will not be written into the track file. Default is
to write the information.
TRCKOF Turns off tracking from this point on.
NOTE: The number of wtc and/or wtv values must equal the number of tracked
fluids.
4.14.2 Tracked Fluid Number (YINJT)

00 The YINJT card allows the user to specify the number of the tracked fluid into
which the injected gas will go.
YINJT wl
yinjt1 yinjt2 ... yinjtn
00 Definitions:
wl List of gas injection wells for which yinjt values are

yinjt Number of the tracked fluid into which the injected gas
will go. Default is 0, indicating that the injected gas will
not be tracked.
NOTE: The number of yinjt values must equal the number of wells in the well
list.
4.14.3 Activates Tracked Fluid Composition Output (OPRSYS)

00 The OPRSYS card activates the output of produced tracked fluid compositions,
by pressure system, to Fortran unit 37. This output can only be obtained for
predictive well management cases (PREDICT card) and the frequency of output is
controlled by the WTRACK card. It should be entered in the TRACK data group.
OPRSYS (GATHER)

00 Definition:
GATHER Alpha label that causes output to be by pressure system,

on a gathering center level. The default is that output will
be on a flow station level.
00 Information in the output file is organized in the form of time records. Each time
record contains the following information (format):
00 ITIME,TIME (I10,E15.7)
NC,NFLTRK,NGCFS,NPRSYS (4l5)
start ISYS loop (ISYS=1 ,NPRSYS)
ISYS (’PSYS ’ ,I5)
start IGC loop (IGC=1 ,NGCFS)
IGC (for LFSTRK=.TRUE.) (’FLST ’ ,I5)
IGC (for LFSTRK=.FALSE.) (’GC ’ ,I5)
((ZZ(I,J,IGC,ISYS) ,I=1 ,NC) ,J=1 ,NFLTRK) (8E15.7)
((YY(I,J,IGC,ISYS) ,I=1 ,NC) ,J=1 ,NFLTRK) (8E15.7)
end ISYS loop
end IGC loop
00 where:
ITIME Time step number.
TIME Time from the start of simulation, days,
NC Number of hydrocarbon components.
NFLTRK Number of tracked fluids.
NGCFS A number equal to the number of gathering stations or

flow stations depending on the value of the logical
LFSTRK.
NPRSYS Number of pressure systems.
LFSTRK Logical variable, which is set to .TRUE. when the output

on the flow station level is requested (default).
Otherwise, LFSTRK is set to .FALSE.
ZZ(I,J,K,L) Total molar production rate (moles/day) of the

component I, produced as the track fluid J, from the flow
station (gathering center) K, and pressure system L.
YY(I,J,K,L) Gas molar production rate (moles/day) of the component

I, produced as the track fluid J, from the flow station
(gathering center) K, and pressure system L.

4.15 Water Tracking (Not available in VIP-THERM)
4.15.1 Tracked Water Mixing Parameter (FTWMIX)

00 The FTWMIX card allow the user to specify how much of the insitu (connate)
water in a block will be considered mobile, in calculating the fractional flow of
each tracked water type. The irreducible water saturation (Swirr) can be
completely bypassed, or can be partially replaced by other water types. This does
not affect total water flow, but only the allocation of this water flow among the
various tracked water types.
FTWMIX ftwmix
00 Definition:
ftwmix Tracked water mixing parameter; 0.0 ≤ ftwmix ≤ 1.0. A

value of 0.0 implies that insitu water below the
irreducible water saturation for the block is immobile. A
value of 1.0 implies that all of the insitu water is mobile
and that Swirr will be composed of a mix of tracked
water types. Any value in between will yield a linear
combination of the two. The default is 1.0.
4.15.2 Tracked Water Type Number (WINJT)

00 The WINJT card allows the user to specify the index number of the tracked water
type into which the injected water will go.
WINJT wl
winjt1 winjt2 ... winjtn
00 Definitions:
wl List of water injection wells for which winjt values are

winjt Number of the tracked water type into which the injected
water will go. Default is 0, indicating that the injected
water will not be tracked.
NOTE: The number of winjt values must equal the number of wells in the well
list.


Chapter
5
00000 Predictive Well Management1
5.1 Introduction
00 This section describes the data required to use the predictive well management
(PWM) option in VIP-EXECUTIVE. The PREDICT card must appear on every
run, including any history runs, of a sequence of runs in which predictive well
management may be used. A WMITN card with a value greater than zero is
required to invoke the PWM calculations. The variable dimensioned arrays used
in PWM are described in the DIM card.
00 THP and PTARG cards are used in both basic well management and predictive
well management. If used for PWM data specifications, the formats described in
this section should be used.
00 When the PRINT FIELD option is selected and PWM is active, in addition to the
field production and injection reports, a report of production by pressure system
will be printed.
00 This section is divided into three parts: the first part describes the keywords
common to both "NEW" PWM and "MGOR" PWM; the second part describes the
keywords used in NEW PWM; and the third part describes the keywords used in
MGOR PWM.
00 The number of pressure systems (NPRSYS on the DIM card) must be two for
MGOR PWM.
00 Artificial lift is available only for pressure system one in MGOR PWM.
1. Not available in VIP-THERM
R5000.0.1 Predictive Well Management 5-335

5.2 Keywords Common to NEW PWM and MGOR PWM
5.2.1 Predictive Well Management (PREDICT)

00 If the PREDICT card is entered, it must occur along with other utility data.
NEW
PREDICT
MGOR
00 Definitions:
PREDICT Alpha label that causes arrays that will be used in

predictive well management to be defined.
NEW "NEW" predictive well management algorithm. This is

the default.
MGOR "MGOR" predictive well management algorithm.
00 The PREDICT card must appear on every run, including any history runs, of a
sequence of runs in which predictive well management may be used.
00 The predictive well management package will not be executed unless a nonzero
value for the number of outer iterations using predictive well management is
specified in the recurrent data (see WMITN card).
5.2.2 Number of Outer Iterations Each Timestep (WMITN)

00 The WMITN card must be entered to use predictive well management.
WMITN nitn (ipwmspn)
00 Definition:
nitn Number of outer iterations in each timestep that will use

predictive well management. Default is 0.
ipwmspn Frequency of predictive well management calls with

which surface pipeline network calculations will be done.
Default is to do the surface pipeline network calculations
every call to predictive well management. This value
may be entered only if the surface pipeline network
option has been licensed.
5-336 Predictive Well Management R5000.0.1

00 The WMITN card and the PREDICT card supply the enabling data for predictive
well management. Both are necessary to use this option.
00 The WMITN card defines the number of outer iterations in each timestep that will
use the predictive well management set of routines to calculate well rates and
bottomhole pressures.
00 It is recommended that the number of iterations be held to a small value, say 1 or

2. Larger values will probably degrade convergence considerably.
5.2.3 Pressure Systems and Lift Methods Available (PWMGC)

00 The PWMGC card is used to define which pressure systems and artificial lift
methods are available in each gathering center. Producers in gathering centers
with LIFT specified, for which no qlift has been input, will automatically have a
negative qlift assigned.
PWMGC GATHER SYSTEM (LIFT)

igc1 sysnmi (liftnm)
X sysnmj (liftnm)
igc2 sysnmk (liftnm)
. . .
. . .
00 Definitions:
GATHER Alpha label indicating that the first entry on subsequent

cards defines the gathering center number.
SYSTEM Alpha label indicating that the second entry on

subsequent cards defines a pressure system available to
the gathering center.
LIFT Alpha label indicating that the third entry on subsequent

cards, if entered, defines an artificial lift method attached
to the pressure system.
igc Gathering center number. For each gathering center the

igc number may only be specified once.
X Alpha label indicating that the data on this card applies to

the most recently specified gathering center number.
sysnm Pressure system name.
liftnm Artificial lift method name.

5.2.4 Tubinghead Pressure (THP)
THP wl
sysnm1 thp11 thp12. . .thp1n
sysnm2 thp21 thp22. . .thp2n
. . .
. . .
. . .
00 Definitions:
wl List of wells for which thp values are being entered (see
Section 1.5.2).
sysnm Name of the pressure system to which the thp values on

this card apply.
thp Tubinghead pressure limit when the well points to the

appropriate pressure system, psia (kPa).
NOTE: For predictive well management a tubinghead pressure value must be

specified for each well for each pressure system to which the well may be
produced.
The number of thp values on any of the cards must equal the number of
wells in the well list.
To invoke THP constraints for a well, the user must also define a
productivity index, BHPTAB data, and ITUBE / SYSTB data.
5.2.5 Production Target Data (PTARG)

00 A PTARG card is used to define a maximum production rate for a gathering
center, a flow station, an area, or the field, or for the subunits sysnm within each
entity.
GATHER O
PTARG FLOSTA inum ⎛ TOTAL ⎞ G qtarg (coil cwat cgas (cwct)) ⎛ LFTGAS ⎞
⎝ sysnm⎠ ⎝ NOLFTGAS⎠
AREA W
FIELD VEL

00 Definitions:
Alpha label indicating the level of well management hierarchy to which the
specified maximum production rate applies:
AREA Area.
FIELD Field.

level.
Alpha label indicating to which subunit (or total) the maximum rate applies:
TOTAL Alpha label indicating the maximum rate applies to the

specified member as a whole, not to a particular pressure
system. This is the default.
sysnm Name of the pressure system to which the maximum rate

applies.
VEL “Velocity,” user-defined units (see NOTE below).
qtarg Maximum production rate or “velocity.”
coil Coefficient of the oil rate term; “velocity” option only.
cwat Coefficient of the water rate term; “velocity” option only.
cgas Coefficient of the gas rate term; “velocity” option only.
cwct Minimum water cut for “velocity” option to be invoked.

Optional.
LFTGAS Alpha label indicating that the gas production target

qtarg also includes the amount of gaslift gas used in the
specified level of well management. This option applies
only when the label G is specified.

NOLFTGAS Alpha label indicating that the gas production target

qtarg does not include gaslift gas. This is the default.
This option applies only when the label G is specified.
NOTE: In predictive well management mode, one and only one of TOTAL or
sysnm may be specified. If neither is input TOTAL is assumed. Separate
maxima can be established for each pressure system by inputting multiple
PTARG cards.
accepted.
One and only one of the O, W, G, or VEL labels must be specified. There
is no default. The label VEL applies only when the label GATHER is
specified. Separate maxima can be established for oil, water and gas by
reading multiple PTARG cards.
The oil, water and gas maxima may be exceeded by the tolerance factors
specified on the TRGTOL card before violations occur.
The labels LFTGAS and NOLFTGAS apply only when the label G is
specified.
The values coil, cwat, cgas, and, optionally, cwct, must be entered if and
only if the label VEL is specified.
When the “velocity” option is invoked, the following “velocity” is

computed: coil x (oil rate) + cwat x (water rate) + cgas x (gas rate). This
quantity is then checked against the qtarg value in the same manner as
the production maxima. If cwct is entered, the computed watercut must be
larger than this in order for the “velocity” to be checked.
00 Examples:
00 PTARG FIELD 1 TOTAL G 6861

PTARG GATHER 2 SYS1 W 50000
PTARG AREA 1 LPSYS G 100000 LFTGAS

5.2.6 Frequency of PWM Calculations (PWMFRQ)
MONTHS
PWMFRQ freq DAYS
TSTEPS
00 Definitions:
freq Frequency with which the PWM calculations will be

performed. Default is 99999 timesteps.
00 The PWMFRQ card is used to specify the additional frequency with which the
PWM algorithm is performed. The PWM algorithm is automatically performed at
every DATE/TIME card.
00 Within the simulator the date on a DATE card is considered to be the beginning of
that day. For example, if output is desired at the end of March 1988, the date card
should contain 1/4/88 and not 31/3/88. Thus the MONTHS option on the
frequency card will force a timestep to start at the date 1/month/year.
5.2.7 Bottomhole Pressure Tables (SYSTB)

00 The SYSTB card specifies the bottomhole pressure table to be used when a well
points to a pressure system with or without lift.
SYSTB wl
sysnm1 (liftnm1) itb11 itb12. . .itb1n
sysnm2 (liftnm2) itb21 itb22. . .itb2n
00 Definitions:
wl List of wells for which table pointers are being assigned


sysnm Name of the pressure system to which the table pointers

on this card apply.
liftnm Name of the artificial lift method to which the table

pointers on this card apply.
itb Bottomhole pressure table pointer.
NOTE: The number of table pointers on each card must equal the number of wells
in the well list.
If a pointer for a well for a lift method is not input, the table pointer will
default to the value for the appropriate pressure system.
If a pointer for a well for a pressure system is not input, the table pointer
will default to the value specified on the ITUBE card for the well.
5.2.8 Define Pressure Systems for Wells During History (HISTSYS)

00 The HISTSYS card is used to define the pressure system for each well during the
history period. This data is used to print production reports by pressure system
during the history period.
00 HISTSYS Card for WELLS
HISTSYS WELL wl
sysnm1 sysnm2 . . . sysnmn
00 HISTSYS Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
HISTSYS inum sysnm
AREA
FIELD
wl List of wells for which pressure systems are being

sysnm Pressure system name for the well.
00 The number of sysnm values must equal the number of wells in the well list.

Alpha label indicating the level of the well management hierachy to which the
specified pressure system name applies:
AREA Area.
FIELD Field.

level.
sysnm Pressure system name for each well under the specified
well management level.
NOTE: Pressure system names can be input at the well level or at any other level
of well management. The effective pressure system for a well will be the
one specified at the lowest level of the well hierarchy; i.e., the first user-
If HISTSYS is specified by well management level, one and only one of

5.2.9 Defining Pressure Systems (PRSYS)

00 The PRSYS card defines the names of the PWM pressure systems.
PRSYS sysnm1 sysnm2. . . sysnmNPRSYS
00 Definition:
sysnm sysnm1 is the name of the pressure system with the

lowest tubinghead pressure, sysnm2 is the name of the
pressure system with the next higher tubinghead
pressure, etc.
NOTE: The pressure system names can be up to eight (8) characters long. If this
card is omitted the pressure systems are denoted as SYS1, SYS2, ...,SYSn.
The user can selectively use default names by specifying X for a name in
the above card.

00 Examples:
00 If NPRSYS = 3, the following are valid PRSYS cards:

PRSYS SYSTM1 SYSTM2 SYSTM3
PRSYS LOWPRS X HIGHPR (here X = SYS2)
PRSYS SYS1 SYS2 SYS3
5.2.10 Artificial Lift Method Names (ARTLFT)

00 The ARTLFT card defines the names of the artificial lift methods.
ARTLFT alftnm1 alftnm2 ... alftnmNPWMAL
00 Definition:
alftnm Name of artificial lift method #n
00 The artificial lift method names can be up to eight (8) characters long. If this card
is omitted, the default name for lift method #1 is GASLFT.
5.2.11 Tolerance for Production Rates (PWMTLP, NONPWM, TRGPWM)

00 The PWMTLP card is used to define the tolerance within which the rates in non-
PWM timesteps must fall. It also defines the action to perform if a violation
occurs.
GATHER
FLOSTA inum ⎛ TOTAL
⎞ O
PWMTLP ⎜ ⎟ G
AREA ALL ⎝ sysnm ⎠ W
FIELD
STOP
NONPWM tolr1 WARN
WMAN
STOP
TRGPWM tolr2 WARN
WMAN

00 Definitions:
AREA Area.
FIELD Field.

level.
ALL Alpha label indicating the tolerance applies to all

members in the specified well management level.
TOTAL Alpha label indicating the data applies to the specified

member as a whole, not to a particular pressure system.
sysnm Name of the pressure system to which the data applies.
Alpha label indicating the tolerance applies to the rates:
O Oil production
G Gas production.
W Water production.
NONPWM Alpha label indicating the data on this card applies to the
comparison of the rates from non-PWM timesteps to the
PWM timestep.
tolr1 Tolerance within which the rate for a non-PWM timestep

must fall. That is, a violation occurs if
(RATE(PWM) - RATE(NON-PWM))/RATE(PWM) > tolr1
Default is to not do the comparison if the NONPWM

card is not input.
TRGPWM Alpha label indicating the data on this card applies to the
comparison of the rates from non-PWM timesteps to the
targets.
tolr2 Tolerance within which the rate for a non-PWM timestep

must fall. That is, a violation occurs if

(RATE(NON-PWM) - TARGET) / TARGET > tolr2
Default is to not do the comparison if the TRGPWM card

is not input.
Alpha label indicating the action to take if a violation occurs:
STOP Write a restart record and stop the run.
WARN Write a warning message and continue the run.
WMAN Repeat this timestep performing the PWM algorithm.
NOTE: One and only one of the GATHER, FLOSTA, AREA, or FIELD labels
must be specified. There is no default, When FIELD is specified the inum
entry may be omitted or the value 1 may be input; no other value will be
accepted.
One and only one of the O, W, or G labels must be specified. There is no

default.
One and only one of TOTAL or sysnm may be specified. If neither is

input TOTAL is assumed. Separate tolerances can be established for each
pressure system by inputting multiple PWMTLP cards.
Either one or both of the NONPWM and TRGPWM cards may be input.
5.2.12 Oil Incremental Benefit with Gaslift (PWMOBN)

00 The PWMOBN card is used to specify the oil incremental benefit with gaslift.
PWMOBN bnf
00 Definition:
bnf Fraction of the non-lifted oil rate above which gaslift

must improve in order to be eligible. Default is 0.05.
5.2.13 Maximum PWM Timestep Size (DTPWM)

00 The DTPWM card is used to specify the maximum allowable timestep size for a
predictive well management timestep.
DTPWM dtpwm
00 Definition:

dtpwm Maximum allowable timestep size that can be used for a

predictive well management timestep, days. Default is no
size restriction.
5.2.14 Write PWM Report to File (PWMFILE)

00 The PWMFILE card is used to request a report of pressure system production
rates written in spreadsheet format to FORTRAN Unit 63.
⎛ ⎞
⎜ TIME ⎟
PWMFILE ⎜ TNEXT ⎟ ( freq )
⎜ ⎟
⎝ OFF ⎠
00 Definitions:
TIME Alpha label that causes the file to be written each time a
TIME or DATE card is encountered. Default is not to
write on the basis of TIME or DATE cards.
TNEXT Alpha label that causes the file to be written only the next
time a TIME or DATE card is encountered. Default is not
to write on the basis of the next TIME or DATE card.
OFF Alpha label that causes the file not to be output. It is

equivalent to specifying a frequency of 99999.
freq A number that causes the file to be written after every

freq timesteps (each timestep cut counts as one timestep).
Default is 99999.
NOTE: At least one of the values, TIME, TNEXT, OFF, or freq must appear on the
PWMFILE card. Either TIME or TNEXT may appear with freq.
The records are written to FORTRAN Unit 63, which may not be saved
unless the appropriate commands are added to the job control stream.
5.2.15 Debug Output (PWMDBG)

00 The PWMDBG card is used to obtain debug output during the PWM calculations.
PWMDBG idbg (NEXTONLY)

(ALL)
00 Definitions:

idbg Level of debug output for "NEW" PWM":
3 Well and well management output for each pass.
2 Well management output for each pass.
1 Well management output for each step.
idbg Level of debug output for "MGOR" PWM:
4 Information at the operating points for the wells

specified on the WPWMDB card, plus the reports for
lesser values of idbg.
3 Well management report each time rates are

decreased to honor targets, plus the reports for lesser
values of idbg.
2 Well management report at the end of each iteration

of incremental gas-oil ratio value, plus the report at
the completion of the algorithm.
1 Well management report at the completion of the

algorithm.
NEXTONLY Alpha label indicating the debug output will be printed

for the next PWM calculations only. This is the default.
ALL Alpha label indicating the debug output will be printed

for all subsequent PWM calculations.

5.3 Keywords for NEW PWM
5.3.1 Minimum Oil Rate for Producers (QOMIN)

00 The QOMIN card is used to define the minimum oil rate a well must have in order
to flow into any pressure system.
00 Each producing well must have a QOMIN value or QGMIN value, or both,
specified.
00 QOMIN Card for WELLS
QOMIN WELL wl
qomin1 qomin2 . . . qominn
00 QOMIN card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
QOMIN inum qomin
AREA
FIELD
wl List of wells for which minimum oil rates are being

qomin Minimum oil rate for the well during PWM

categorization, STB/D (STM3/D).
00 The number of qomin values must equal the number of wells in the well list.
the specified minimum oil rate applies:
AREA Area.
FIELD Field.


level.
qomin Minimum oil rate for each well under the specified well
management level during PWM categorization, STB/D
(STM3/D).
NOTE: Minimum oil rate values can be input at the well level or at any other level
of well management. The effective minimum value for a well will be the
If QOMIN is specified by well management level, one and only one of the
GATHER, FLOSTA, AREA, or FIELD labels must be specified. There is
no default. When FIELD is specified the inum entry may be omitted or
5.3.2 Minimum Gas Rate for Producers (QGMIN)

00 The QGMIN card is used to define the minimum gas rate a well must have in
order to flow into any pressure system.
00 Each producing well must have a QOMIN value or QGMIN value, or both,
specified.
00 QGMIN Card for WELLS
QGMIN WELL wl
qgmin1 qgmin2 . . . qgminn
00 QGMIN Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
QGMIN inum qgmin
AREA
FIELD
wl List of wells for which minimum gas rates are being


qgmin Minimum gas rate for the well during PWM

categorization, MSCF/D (SM3/D).
00 The number of qgmin values must equal the number of wells in the well list.
the specified minimum gas rate applies:
AREA Area.
FIELD Field.

level.
qgmin Minimum gas rate for each well under the specified well
management level during PWM categorization, MSCF/D
(SM3/D).
NOTE: Minimum gas rate values can be input at the well level or at any other
level of well management. The effective minimum value for a well will be
the one specified at the lowest level of the well hierarchy; i.e., the first
user-specified number found in the order: well, the appropriate gathering
accepted.

5.3.3 PWM Calculation Steps (PWMSTEP)

00 The PWMSTEP card is used to specify all the data needed to perform steps 2 and
3 of the new predictive well management.
PWMSTEP 2
PASS ipass (REMOVE)
BENEFIT bennam (a b c d e f g h i j)
PAFACT pa1 pa2 . . . paNPWMPA
PMFACT pm1 pm2 . . . pmNPWMPM
GATHER
FLOSTA
WMGL
AREA
FIELD
PRSYS sysnm
GORM gorm
GLRM glrm
WCUT wcut
EXCLUDE W
CUTOFF
ACTION AVG
SCALE
⎛ NOLIFTREQ
⎞
⎜ ⎟
CATEGORY ⎜ LIFTREQ ⎟ (card 1)
⎜ ⎟
⎜ LIFTONLY ⎟
⎝ MUSTFLOW ⎠
MUSTLIFT (card 2)
ALL .
sysnm .
. .
.
ENDCATEGORY
PASS ipass (REMOVE)
.
ENDSTEP

PWMSTEP 3 (STOP)
(WARN)
PASS ipass (REMOVE)
BENEFIT bennam (a b c d e f g h i j)
PAFACT pa1 pa2 . . . paNPWMPA
PMFACT pm1 pm2 . . . pmNPWMPM
GATHER
FLOSTA
WMGL
AREA
FIELD
sysnm
PRSYS
TOTAL
O SHUT
PHASE W SCALE
G AVG
PASS ipass (REMOVE)

.
ENDSTEP
00 Definitions: for PWMSTEP 2 card
PASS Alpha label indicating data for a pass is to be input.

ipass Pass number. The value of ipass can not be greater
than NPWMPS.
REMOVE Alpha label indicating the designated pass ipass
should be removed from this step.
bennam Benefit function name. See notes below for benefit
function definitions.
a,...,j Benefit function coefficients. See notes below.
PAFACT Alpha label indicating the factors to be used for each
producing area are on this card. If the card is not
input, the factors default to 1.
pa Producing area factor. Default is 1.
PMFACT Alpha label indicating the factors to be used for each
producing mechanism are on this card. If the card is
not input, the factors default to 1.

pm Producing mechanism factor. Default is 1.

WMGL Alpha label indicating the level of the well
management hierarchy to which the data for this
pass applies is on this card.
Alpha label indicating the level of the well management hierarchy:
AREA Area.
FIELD Field.
PRSYS Alpha label indicating the system to be filled during
this pass.
sysnm Name of the pressure system to be filled.
GORM Alpha label indicating the maximum producing
GOR for wells in this pass is input on this card. This
card replaces any previously specified GLRM data
for this pass.
gorm Maximum producing GOR for wells in this pass,
SCF/STB (SM3/ STM3).
GLRM Alpha label indicating the maximum producing
GLR for wells in this pass is input on this card. This
card replaces any previously specified GORM data
for this pass.
glrm Maximum producing GLR for wells in this pass,
SCF/STB (SM3/ STM3).
WCUT Alpha label indicating the maximum producing
water-cut for wells in this pass is input on this card.
wcut Maximum producing water-cut for wells in this
pass, fraction.
EXCLUDE W Alpha labels indicating that water rate constraints
are not to be checked during this pass.
ACTION Alpha label indicating the procedure for meeting the
target.
CUTOFF Assign wells in benefit function
order until target is met. This is
the default.

AVG Reset the rates of the highest rate

wells to an average rate to meet
the target. All eligible wells are
considered.
SCALE Scale all eligible wells to meet the
target.
CATEGORY Alpha labels indicating the well hydraulic categories
ENDCATEGORY that are eligible to be considered on this pass are
input between these two cards.
NOLIFTREQ Alpha label indicating, for the pressure system
categories specified on the following card(s), wells
are eligible under nolift conditions only (i.e., do not
consider lift rates in this pass). This is the default.
LIFTREQ Alpha label indicating, for the pressure system
are eligible under both lift and nolift conditions (i.e.,
if applicable the wells may appear twice in the
benefit function list: for lift and non-lift rates).
LIFTONLY Alpha label indicating, for the pressure system
are eligible under lift conditions only (i.e., only
consider gas lift rates for wells).
MUSTFLOW Alpha label indicating that the wells categorized as
MUSTFLOW on the PWMCAT card are the eligible
wells for this pass. The ALL option must be used.
The following three options are used for determining the eligible categories
for the current pass:
MUSTLIFT Alpha label indicating wells that can only flow when
lifted are eligible on this pass.
ALL Alpha label indicating all well hydraulic categories,
including MUSTLIFT, are eligible on this pass (i.e.,
every unassigned well in the list is considered).
sysnm Name of the pressure system category to be included
on this pass (i.e. , select wells which can flow to the
pressure system sysnm).
ENDSTEP Alpha label indicating the end of the PWMSTEP
data. Required.
00 Definitions: for PWMSTEP 3 card
Alpha label indicating the action to take if any targets remain in violation
following step 3:

STOP Write a restart record and stop the run.

WARN Write a warning message and continue the run.
PASS Alpha label indicating data for a pass is to be input.
ipass Pass number. The value of ipass cannot be greater
than NPWMPS.
REMOVE Alpha label indicating the designated pass ipass
should be removed from this step.
bennam Benefit function name. See notes below for benefit
function definitions.
a,...,j Benefit function coefficients. See notes below.
PAFACT Alpha label indicating the factors to be used for each
producing area are on this card. If the card is not
input, the factors default to 1.
pa Producing area factor. Default is 1.
PMFACT Alpha label indicating the factors to be used for each
producing mechanism are on this card. If the card is
not input, the factors default to 1.
pm Producing mechanism factor. Default is 1.
WMGL Alpha label indicating the level of the well
management hierarchy to which the data for this pass
applies is on this card.
Alpha label indicating the level of the well management hierarchy:
AREA Area.
FIELD Field.
PRSYS Alpha label indicating the system to be filled during

this pass.
sysnm Name of the pressure system to be filled.
TOTAL Alpha label indicating the entire well management
level member is to be checked.
PHASE Alpha label indicating which phase target is to be
checked and the action to be taken during this pass
are input on this card.
Alpha label indicating the phase target to be checked:

O Oil target.
W Water target.
G Gas target.
Alpha label indicating the action to take if a violation occurs:
SHUT Shut-in wells in the benefit function order.
SCALE Scale all eligible wells to meet the target.
AVG Reset the rates of the highest rate wells to an average
rate.
ENDSTEP Alpha label indicating the end of the PWMSTEP
data. Required.
NOTE: Multiple sets of pass data can be input for each PWMSTEP card.
The following data is required for each specified pass: BENEFIT, WMGL,
PRSYS, PHASE and CATEGORY.
Data for pass 1 must be specified.
The action CUTOFF must be used if LIFTREQ or LIFTONLY are

specified on the CATEGORY card (in step 2).
The category ALL must be used if MUSTFLOW is specified on the

CATEGORY card (in step 2).
The following is the list of available benefit functions:
BF1: PMi *PAj *(a*Qo +b*GOR+c*WCUT+d*GLGOR)
BF2: PMi * PAj * ( a + b*Qg + c*Qo + d*Qw + e*Qglg) /
( f + g*Qg + h*Qo + i*Qw + j*Qglg)
BF3: PMi* PAj* (a+Qo)**b* ( c+GOR )** d*
( e +WCUT )**f * ( g +GLGOR )**h
For benefit function BF3, the exponents b, d, f and h should be integer

values. If not, they are internally set to the nearest integer.

5.3.4 Producing Area Number (PWMWPA)

00 The PWMWPA card is used to define the producing area in which a well lies. This
allows more flexibility in the use of the benefit functions.
00 PWMWPA Card for WELLS
PWMWPA WELL wl
ipa1 ipa2 . .. ipan
00 PWMWPA Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
PWMWPA inum ipa
AREA
FIELD
wl List of wells for which producing area numbers are being

ipa Producing area number for the well. Default is

NPWMPA+1.
00 The number of ipa values must equal the number of wells in the well list.
the specified producing area number applies:
AREA Area.
FIELD Field.

level.
ipa Producing area number for each well under the specified
well management level. Default is NPWMPA+1.

NOTE: Producing area numbers can be input at the well level, or at any other level
of well management. The effective producing area number for a well will
be the one specified at the lowest level of the well hierarchy; i.e., the first
user-specified number found in the order: well, the appropriate gathering
If PWMWPA is specified by well management level, one and only one of

5.3.5 Producing Mechanism (PWMWPM)

00 The PWMWPM card is used to define the producing mechanism for a well. This
allows more flexibility in the use of the benefit functions.
00 PWMWPM Card for WELLS
PWMWPM WELL wl
ipm1 ipm2 . . . ipmn
00 PWMWPM Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
PWMWPM inum ipm
AREA
FIELD
wl List of wells for which producing mechanism numbers

are being specified (see Section 1.5.2).
ipm Producing mechanism number for the well. Default is

NPWMPM+1.
00 The number of ipm values must equal the number of wells in the well list.
the specified producing mechanism number applies:

AREA Area.
FIELD Field.

level.
ipm Producing mechanism number for each well under the

NPWMPM+1.
NOTE: Producing mechanism numbers can be input at the well level or at any
other level of well management. The effective producing mechanism
number for a well will be the one specified at the lowest level of the well
hierarchy; i.e., the first user-specified number found in the order: well, the
appropriate gathering center, the appropriate flow station, the appropriate
area, and the field.
If PWMWPM is specified by well management level, one and only one of

5.3.6 Define Well Category (PWMCAT)

00 The PWMCAT card is used to explicitly define the PWM category for a well.
( MUSTFLOW ) sysnm
PWMCAT (liftnm) wl
DECLASS
00 Definitions:
sysnm Name of the pressure system to which the wells are

explicitly categorized.
MUSTFLOW Alpha label indicating that the wells listed on this card
are eligible when MUSTFLOW is specified on the
CATEGORY card in the PWMSTEP 2 data. Also, these
wells are not eligible for rate reduction during the Step 3
process.
DECLASS Alpha label indicating that the wells are to be

declassified; i.e., remove any previous explicit
categorization.

liftnm Name of the artificial lift method to which the wells are
additionally categorized.
wl List of wells which are being explicitly categorized (see

Section 1.5.2).
5.3.7 MUSTFLOW Well Specification (MUSTFLOW)

00 The MUSTFLOW card is used to affect the eligibility of wells when
MUSTFLOW is specified on the CATEGORY card in the PWMSTEP 2 data.
Also, MUSTFLOW wells are not eligible for rate reduction during the Step 3
process.
MUSTFLOW ⎛ ON ⎞ wl
⎝ OFF⎠
00 Definitions:
ON Alpha label indicating that the wells listed on this card

are to be considered MUSTFLOW wells. This is the
default if neither ON nor OFF is specified.
OFF Alpha label indicating that the wells listed on this card
are not to be MUSTFLOW wells.
wl List of wells which are either being assigned or

unassigned as MUSTFLOW wells (see Section 1.5.2).
5.3.8 Minimum Oil Rate for Wells on Gaslift (QOMINL)

00 The QOMINL card is used to define the minimum oil rate a well on gaslift must
have in order to flow into any pressure system.
00
00 QOMINL Card for WELLS
QOMINL WELL wl
qominl1 qominl2... qominln
00
00

00 QOMINL Card for WELL MANAGEMENT LEVELS
GATHER
FLOSTA
QOMINL inum qominl
AREA
FIELD
wl List of wells for which minimum oil rates are being

qominl Minimum oil rate for the well on gaslift during PWM
categorization, STB/D (STM3/D).
00 The number of qominl values must equal the number of wells in the well list.
Alpha label indicating the level of the well management hierachy to which the
specified minimum oil rate applies:
AREA Area.
FIELD Field.

level.
qominl Minimum oil rate for each well under the specified well
management level on gaslift during PWM categorization,
STB/D (STM3/D).
NOTE: Minimum oil rate values can be input at the well level or at any other level
of well management. The effective minimum value for a well will be the
If the qominl value is not specified for a well, the qomin value will be
used.

accepted.
5.3.9 Execute Normal Targeting Procedure (PWMTRG)

00 The PWMTRG card is used to force the execution of the normal targeting
procedure for checking well management level production constraints, even
during PWM iterations.
PWMTRG ON
OFF
00 Definitions:
00 ON Alpha label indicating that the normal targeting

procedure should be used to check production
constraints.
00 OFF Alpha label indicating that the normal targeting

procedure should not be used. This is the default if the
card is not entered.
5.3.10 Frequency of Pressure System Switching (PRSDLT)

00 The PRSDLT card is used to define the length of time a well must be assigned to a
pressure system before it can be switched to another.
PRSDLT frqsys1 frqsys2 ...frqsysNPRSYS
00 Definition:
00 frqsys Length of time a well must be assigned to this pressure

system before it can be switched to another pressure
system, days. The alpha label X may be entered instead
of a value to indicate the value should not be changed.
5.3.11 Well Rate Control (PWMWCN)

00 The PWMWCN card is used to specify how wells are to be handled during non-
PWM iterations and timesteps. Wells are either considered bottomhole pressure
controlled wells, where the bottomhole pressure limit is the value from the last

PWM iteration, or rate controlled.
BHP
OIL
PWMWCN WATER
GAS
LIQUID
00 Definitions:
BHP Alpha label indicating that the wells should be treated as

bottomhole pressure controlled. This is the default.
OIL Alpha label indicating that the wells should be treated as

oil rate controlled.
WATER Alpha label indicating that the wells should be treated as

water rate controlled.
GAS Alpha label indicating that the wells should be treated as

gas rate controlled.
LIQUID Alpha label indicating that the wells should be treated as

liquid rate controlled.

5.4 Keywords for MGOR PWM
5.4.1 Separator Battery Numbers (SYSSEP)

00 The SYSSEP card is used to specify the separator battery number to be used when
a well points to a pressure system.
SYSSEP wl
sysnm1 ibt11 ibt12 ... ibt1n
sysnm2 ibt21 ibt22 ... ibt2n
00 Definitions:
wl List of wells for which separator battery numbers are

being assigned (see Section 1.5.2).
sysnm Name of the pressure system to which the separator

battery numbers on this card apply.
ibt Separator battery number.
NOTE: The number of separator battery numbers on each card must equal the
If a battery number for a well for a pressure system is not input, the
separator battery number will default to the value specified on the WELL
card for the well.
5.4.2 MGOR Option Data (PRMGOR)

00 The PRMGOR card is used to specify the data needed to execute the marginal
gas-oil ratio (MGOR) option of the predictive well management algorithm.
PRMGOR (FGRBGN)(FGRINC)(WCUTLM)(FIXGL)(EFF)
⎛ ON ⎞⎛ ON ⎞
(fgrbgn)(fgrinc)(wcutlm)⎜ ⎟⎜ ⎟
⎝ OFF ⎠⎝ OFF ⎠
00 Definitions:
fgrbgn Initial value of field total incremental gas-oil ratio

(TIGOR) at which to start the well assignment, SCF/STB
(SM3/STM3). Default is 1000 SCF/STB.

fgrinc TIGOR increment to use during the algorithm, SCF/STB

(SM3/STM3). Default is 500 SCF/STB.
wcutlm Water-cut value above which a well will not be allowed

to produce, fraction. Default is 1.
FIXGL Indicates the method of placing wells on gaslift:
ON Fixed gaslift gas rate. Wells are either on

gaslift at the rate corresponding to the user-
specified efficiency or not at all.
OFF Variable gaslift gas rate. The allocated gaslift

gas rate may range from zero to the rate
corresponding to the user-specified efficiency.
EFF Indicates the method of determining the lift efficiency to

use in the gaslift gas calculations under the performance
curve option:
ON User-specified table of water-cut versus

efficiency (EFFTAB card).
OFF User-specified value (PFMCRV card). This is

the default.
5.4.3 Water-Cut Versus Efficiency Table (EFFTAB)

00 EFFTAB data are used to relate lift efficiency to the water-cut of the well.
EFFTAB
WCUT EFF
wcut1 eff1
wcut2 eff2
.
wcutn effn
00 Definitions:
WCUT Alpha label indicating that this column contains water-

cut values.
EFF Alpha label indicating that this column contains lift

efficiency values.
wcut Water-cut values, fraction.
eff Lift efficiency values for use in the performance curve

option, STB/MMSCF (STM3/KSM3).

NOTE: An EFFTAB card must be input if the EFF ON option is specified on the
PRMGOR card.
The number of water-cut (or efficiency) values must be no greater than

100.
5.4.4 Specify Wells Included in Well Debug Report (WPWMDB)

00 The WPWMDB card specifies the wells for which debug output is desired when
the well debug option is specified on the PWMDBG card.
WPWMDB wl
00 Definitions:
wl List of wells for which debug output is requested (see

Section 1.5.2).


Chapter
6
00000 Output Control
6.1 Introduction
00 VIP-EXECUTIVE can generate a variety of output:
1. Timestep Summaries
2. Iteration Summaries
3. Array Reports
4. Well, Well Layer, Well Status Change, and Perf Status Change Summaries
5. Separator Reports
6. Production/Injection Reports at any well management level
7. Potential production/injection reports.
8. Simulation Statistics
9. Region Summaries
10. Well RFT Reports
11. Restart Records
12. VDB File for Post-Processing Well and Array Data
13. Plot Files for Post-Processing Well Data
14. Map Files for Post-Processing Array Data
15. Relative Permeability Files for Pseudo Function Generation
16. Echo printing of time-dependent input data
00 The user can control the content and frequency of output of all items except the
timestep summaries.
R5000.0.1 Output Control 6-369

6.2 Print/Map Arrays and Parameters (OUTPUT, MAPOUT)

00 The OUTPUT card and MAPOUT card are used to specify which arrays are to be
printed and written to the map file, respectively. The OUTPUT card is also used to
enter parameters which cause specific actions to be taken.
00 The MAPOUT card may be entered only if a MAP card was specified in the VIP-
CORE data set.
OUTPUT array1 ... arraym param1 . . . paramn

MAPOUT array1 ... arrayk
MAPOUT NONE
00 Definitions:
OUTPUT Alpha label that causes the specified arrays to be

included in the array report, or the specified action to
occur.
MAPOUT Alpha label that causes the specified arrays to be written

to the map file.
NONE Alpha label that causes no arrays to be written to the map

file.
array Alpha label of those arrays being defined on either an

OUTPUT card or a MAPOUT card:
P Pressure.
PSAT Saturation pressure.
PDAT Datum pressure.
PMIN Minimum pressure. Available only when

the irreversible rock compaction option
is in use.
PCGO Gas-oil capillary pressure.
PCWO Water-oil capillary pressure.
PCGW Gas-water capillary pressure. Available

only when the GASWATER option is in
use.
SO Oil saturation.
SW Water saturation.
6-370 Output Control R5000.0.1

SG Gas saturation.
SOM Normalized mobile oil saturation.
SWM Normalized mobile water saturation.
RS Solution gas-oil ratio.
RV Solution oil-gas ratio.
BOF Oil formation volume factor.
BG Gas formation volume factor.
GOR Total gas-oil ratio.
WCUT Water cut.
RSW Solution gas-water ratio. Available only

when the CO2 option is in use.
VISO Oil phase viscosity.
VISG Gas phase viscosity.
VISW Water viscosity.
DENO Oil phase density.
DENG Gas phase density.
PV Pore volume including compaction

effects.
TX X direction transmissibility including

compaction effects.
TY Y direction transmissibility including

compaction effects.
TZ Z direction transmissibility including

compaction effects.
TR R direction transmissibility including

compaction effects.
TTHETA Angular-direction transmissibility

including compaction effects.
ITRAN Transmissibility region.
KRO Relative permeability of the oil phase.

Keywords KROX+, KROX-, KROY+,

KROY-, KROZ+, KROZ- can be used

for directional relative permeabilities in
X+, X-, Y+, Y-, Z+, Z- directions,
respectively.
KRG Relative permeability of the gas phase.

Keywords KRGX+, KRGX-, KRGY+,
KRGY-, KRGZ+, KRGZ- can be used
respectively.
KRW Relative permeability of the water phase.

Keywords KRWX+, KRWX-, KRWY+,
KRWY-, KRWZ+, KRWZ- can be used
respectively.
ISAT Relative permeability/capillary pressure

table pointers.
ISATI Imbibition relative permeability/

capillary pressure table pointers.
API API gravity of the liquid phase.

Available only when the PVT
interpolation option is in use.
TEX Matrix-fracture exchange

transmissibility (VIP-DUAL only).
IFT Interfacial tension. Available only when

the IFT option is in use.
PHFLAG Phase equilibrium condition, (see

GIBBS, Section 8.1.1). Available only
when the GIBBS option is in use.
HG Fractional height of gas-oil contact in a

block (VE cases only).
HW Fractional height of water-oil contact in

a block (VE cases only).
FLOWO Flow of oil out of the 6 faces: negative I,

positive I, negative J, positive J, negative
K, positive K. Six arrays are written.

FLOWG Flow of gas out of the 6 faces: negative I,

positive I, negative J, positive J, negative
K, positive K. Six arrays are written.
FLOWW Flow of water out of the 6 faces:

negative I, positive I, negative J, positive
J, negative K, positive K. Six arrays are
written.
OIP Total oil volume, surface conditions.
GIP Total gas volume, surface conditions.
WIP Total water volume, surface conditions.
FGIP Free gas volume.
OCIP Condensate in free gas.
TDL -X, +Y diagonal transmissibility

including compaction effects, available
only with NINEPT option.
TDR +X, +Y direction diagonal

transmissibility including compaction
effects, available only wth NINEPT
option.
PVMUL Pore volume multiplier, ratio of current

value to reference value.
PVMULW Water-induced pore volume multiplier,

ratio of current value to reference value.
TXMUL X-direction transmissibility multiplier,

TYMUL Y-direction transmissibility multiplier,

TZMUL Z-direction transmissibility multiplier,

TRMUL R-direction transmissibility multiplier,

TTMUL Angular direction transmissibility

multiplier, ratio of current value to
reference value.

CN Capillary number. Available only when

the VELCTY CN option is in use.
FNDG Non-Darcy gas flow mobility

multiplication factor. Available only
when the VELCTY NDARCY option is
in use.
PTHLD Threshold pressure.
STBDT Maximum IMPES stable timestep size.
SAL Water salinity. Available only when the

PVTWSAL tables are entered in VIP-
CORE.
The following array names are valid on OUTPUT and

MAPOUT cards only in VIP-THERM:
T Temperature.
00 TXT X-direction thermal transmissibility.
00 TYT Y-direction thermal transmissibility.
00 TZT Z-direction thermal transmissibility.
00 TRT R-direction thermal transmissibility.
00 TTT Theta-direction thermal transmissibility.
00 DENW Liquid water phase density.
00 VISW Liquid water phase viscosity.
00 HLOS Heat loss rate.
00 CHLOS Cumulative heat loss.
00 SOR Steam-oil ratio.
00 HOIL Oil phase enthalpy.
00 HGAS Gas phase enthalpy.
00 HWAT Water phase enthalpy.
00 αFβγ Flow rate arrays. A FLOWS card must

be input in VIP-CORE (VIP-CORE
Section 2.2.19.3) in order to print these
arrays. α, β, and γ are unit, phase, and

direction symbols which are specified as

follows. γ may be omitted to print phase
flows in all directions. γ and β may be
omitted to print flows of all phases in all
directions
00 α = V, N, M for volumetric, molar, or mass flow rate.
00 β = O, G, or W for oil, gas, or liquid water phase.
00 γ = X(R) flow in from i-1 for cartesian (radial)

grid.
00 γ = Y(T) flow in from j-1 for cartesian (radial)

grid
00 γ=Z
00 γ=E flow in from i+1, j-1 for cartesian grid

with 9-point.
00 γ=W flow in from i-1, j-1 for cartesian grid

with 9-point.
param Alpha label on an OUTPUT card causing an action to be

taken:
SHFTOG Instructs the program to shift all oil and

gas production/injection units by a factor
of 1000 for output purposes. For
example, cumulative gas production will
change from MMSCF to BSCF.
SHFTW Instructs the program to shift all water

production/injection units by a factor of
1000 for output purposes. For example,
water production rate will change from
STB/D to MSTB/D.
TSSUM Causes a timestep summary that includes

all timesteps to be printed at the end of
the run. FORTRAN Unit 15 is used to
store the timestep summary data. Once
this keyword is specified it cannot be
turned off and is not affected by
subsequent OUTPUT cards.
TSSUMG Causes a timestep summary of gas lift

usage to be printed at the end of the run.

Once this keyword is specified it cannot

be turned off and is not affected by
TSSMFG Causes a timestep summary of flared gas

(gas available for reinjection not actually
injected) to be printed at the end of the
run. Once this keyword is specified it
cannot be turned off and is not affected
by subsequent OUTPUT cards.
TSSDAT Causes the date instead of the timestep

number and the time in days to be
printed on the timestep summary at the
end of the run. Once this keyword is
specified, it cannot be turned off and is
not affected by subsequent OUTPUT
cards.
WELRPT Causes a report of well status changes to

be printed at the end of the run. Once this
keyword is specified, it cannot be turned
off and is not affected by subsequent
OUTPUT cards.
PRFRPT Causes a report of perforation status

changes to be printed at the end of the
run. Once this keyword is specified, it
cannot be turned off and is not affected
CPUWMG Causes a report of CPU time within well

management to be printed as part of the
PRINT SIM simulation statistics report.
Once this keyword is specified, it cannot
be turned off and is not affected by
CNVFAIL Causes the detailed iteration summary to

be printed when a convergence failure
occurs. This option is on unless turned
off by use of the CNVFLOFF keyword.
CNVFLOFF Turns off the printing of the detailed

iteration summary when a convergence
failure occurs.
HCPVTS Causes hydrocarbon-pore-volume-

weighted average pressure to be printed
in the timestep summaries instead of

total-pore-volume-weighted average
pressure.
WRKRPT Causes an automatic workover report to

be printed at the end of the run. Once this
OUTPUT cards.
RCMRPT Causes a report of recompletion unit

status changes to be printed at the end of
the run. Once this keyword is specified,
it cannot be turned off and is not affected
PCDON Causes condensate rate and condensate

yield to be printed in well, gathering
center, flow station, area, field, and well
group compositional summaries.
PCDOFF Turns off the printing of condensate rate

and condensate yield in well, gathering
center, flow station, area, field, and well
group compositional summaries.
PCCD Causes cumulative condensate volume

to be printed in well, gathering center,
flow station, area, field, and well group
compositional summaries. Once this
OUTPUT cards.
RCDON Causes condensate rate and condensate

yield to be printed in region
compositional summary.
RCDOFF Turns off the printing of condensate rate

and condensate yield in region
RCCD Causes cumulative condensate volume

to be printed in region compositional
summary. Once this keyword is
specified, it cannot be turned off and is
not affected by subsequent OUTPUT
cards.
LCDON Causes condensate rate and condensate

yield to be printed in well layer

LCDOFF Turns off the printing of condensate rate

and condensate yield in well layer
NOTE: 1. If a MAP card was specified in VIP-CORE and the MAPOUT card is
either omitted or entered with no subsequent keywords, the 4 arrays P,
SO, SG, and SW are, by default, written to the map file. In VIP-
THERM, T is also written by default.
2. To turn off the writing of any of the arrays listed in this section,
specify the card MAPOUT NONE.
3. If the OUTPUT card is omitted or entered with no subsequent

keywords, no array reports are printed.
4. All of the alpha labels must appear on one OUTPUT/MAPOUT card.

If necessary the continuation character ’>’ can be used.
5. The order of the alpha labels is not significant. All are optional.
6. Each OUTPUT/MAPOUT card supersedes and replaces the previous

OUTPUT/MAPOUT card.
7. For output of arrays RS, RV, BOF, BG, GOR, SOR, WCUT, OIP, GIP,
FGIP, or OCIP, separator battery assignments must be made for each
reservoir region (REGSEP card) except for dead oil runs in VIP-
THERM. The calculations for each gridblock use the separator
battery defined for the output region to which the gridblock is
assigned.
8. The options PCDON, RCDON, LCDON, PCDOFF, RCDOFF,

LCDOFF, PCCD, and RCCD are used to specify whether the
condensate rates, condensate yields, and cumulative condensate
volumes are included in the output of compositional summaries
specified by the PRINT card options WELCMP, WLLCMP, GCCMP,
FSCMP, ARCMP, REGCMP, FLDCMP, and WGPCMP.
These condensate printing options should be selected carefully

because they require additional flash calculations which could
significantly increase the CPU time. The cumulative well/region
condensate volume is zero when the PCCD/RCCN option is first
specified unless the CCNDN option is used on the CPLOT card. If the
CCNDN option and any of the well, gathering center, flow station,
area, or field classes are selected on the CPLOT card, the cumulative
well condensate volume is calculated starting from time zero.
Likewise, if the CCNDN option and the REGION class are selected
on the CPLOT card, the cumulative region condensate volume is
calculated starting from time zero.
00 Examples:
00 OUTPUT P SW SG
MAPOUT TX SOM DENO

6.3 Array Print Windows (OUTWINDOW)

00 The OUTWINDOW card is used to specify windows within the grid system for
which values of the arrays listed on the OUTPUT, OUTX, OUTY, OUTZ, etc.
cards are to be printed.
00 Currently the frequency of array printing is controlled by the PRINT ARRAYS

card and each array requested on any of the OUTPUT-type cards is printed in its
entirety for every grid. When windows are specified the frequency is still
controlled by the PRINT ARRAYS card; for each requested array on the
OUTPUT-type cards, all specified windows of gridblock values are printed.
ADD
OUTWINDOW ⎛ DELETE wname …⎞
⎝ 1 ⎠
i2 j2 k2 ⎛ ONLYCHILDREN ⎞
(gridname) ii j1 k1 ⎜ ⎟ ( wname )
NX NY NZ ⎝ ALSOCHILDREN ⎠
.
.
.
ENDWINDOW
00 Definitions:
ADD Alpha label indicating that the specified windows are

added to the current list. The default is to replace the
current list with the specified windows.
DELETE Alpha label indicating that the listed windows are to be

removed from the current list. It is an error if no such
named window exists. No data cards or ENDWINDOW
card may be entered when DELETE is used.
wnamei Alphanumeric name of the window to be deleted from

the list. At least one name must be input after the
DELETE label.
gridname Name of the grid refinement to which this window

applies. If not specified, the window is assumed to apply
to the root grid.
Gridblock locations, relative to gridname, are defined by indices I, J, K in

reference to the (x, y, z) or (r, θ, z) grid. The gridblocks contained in the
window are those lying in the portion of the grid defined by:

i1 ≤ I ≤ i2
j1 ≤ J ≤ j2 00
k1 ≤ K ≤ k2
NX Alpha label indicating that the value of i2 should be set to

nx (or nr).
NY Alpha label indicating that the value of j2 should be set to

ny (or ntheta).
NZ Alpha label indicating that the value of k2 should be set

to nz.
ONLYCHILDREN Alpha label indicating that a window is not created for

the blocks in grid gridname, but windows are created
for each child grid that exists within this set of blocks.
Each window thus created will have the same name.
ALSOCHILDREN Alpha label indicating that, in addition to creating a

window in grid gridname, windows are created for
each child grid that exists within this set of blocks.
Each window thus created will have the same name.
wname Alphanumeric name of this window or set of windows.
ENDWINDOW Alaph label indicating the end of the window data. This
card may not be entered if the DELETE data is entered.
NOTE: If neither ONLYCHILDREN nor ALSOCHILDREN is specified, a single

window is created.
The maximum number of windows is 250.
00 Example:
OUTWINDOW
ROOT 3 7 2 5 1 NZ WIN1
GASCAP 3 NX 3 NY 2 4 WIN2
4 4 7 7 1 NZ ALSOCHILDREN WIN3
ENDWINDOW

6.4 Content and Frequency of Printed Output (PRINT)

00 The PRINT card allows the user to control the content and frequency of printed
output. If the PRINT card is omitted, only the timestep summaries and the
simulation statistics report at the end of the run are printed.
⎛ TIME ⎞
PRINT param1 param2 . . . paramn ⎜ ⎟ ( freq )
⎜ TNEXT ⎟
⎝ OFF ⎠
00 Definitions:
param Alpha label of those report(s) being defined:
ITER Detailed iteration summary. For IMPES

only, the residuals will not be
recomputed after convergence. This is
the default.
ITERL Detailed iteration summary. This option

forces the residuals to be recomputed
after convergence.
WELLS Well production summary and well

injection summary.
WSTRM Include in the TSFM surface facility

report the compositions of various
production streams for each well. The
facility report is automatically printed
whenever PRINT WELLS is active and
only if the TSFM surface facility model
option is in use.
REGIONS Region report. To compute fluids-in-

place the hydrocarbon moles in each
region are flashed to the surface.
REGBLK Region report. To compute fluids-in-

place the hydrocarbon moles in each
gridblock are flashed to the surface. The
surface quantities are summed over the
regions. This is the method used by VIP-
CORE to compute initial fluids-in-place.
REGOG Region report. Same as REGIONS

except that reservoir oil and gas

compositions are printed instead of total

compositions and total moles for each
phase are added.
REGBOG Region report. Same as REGBLK

except that reservoir oil and gas
compositions are printed instead of total
compositions and total moles for each
phase are added.
ARRAYS Array reports.
SEP Separator battery report, with

compositional and volumetric
information at all stages and at surface
conditions.
SEPS Short form of the separator battery

report, with information only for surface
conditions.
FIELD Field production and injection

summaries. In addition to the field
production and injection reports, a report
of production by pressure system will be
printed if predictive well management is
active.
WLLYR Well production and injection summaries

detailed by layers for active wells only.
Also controls the plot records written;
i.e., only the layers for active wells are
written to the plot file. Also controls the
special layer output reports for WBSIM
runs.
WLLYRS Well production and injection

summaries, detailed by layers for all
wells. Also controls the plot records
written; i.e., the layers for all wells are
written to the plot file. Also controls the
special layer output reports for WBSIM
runs.
WLGRP Well production and injection

summaries, for well groups defined by
the user (see the WLGRP card for
details).
WLHIS Well production and injection histories

written to FORTRAN Unit 40.

GCLYR Gathering center production and

injection summaries detailed by layers.
FSLYR Flow station production and injection

summaries detailed by layers.
ARLYR Area production and injection

FLLYR Field production and injection

WLPOT Well potential production summary and

well potential injection summary.
FLPOT Field potential production summary and

field potential injection summary.
WELCMP Well production and injection

compositional summaries.
WLLCMP Well production and injection

compositional summaries detailed by
well perforations.
GCCMP Gathering center production and

injection compositional summaries.
FSCMP Flow station production and injection

gathering centers.
ARCMP Area production and injection

gathering centers.
REGCMP Region production and injection

compositional summaries.
FLDCMP Field production and injection

gathering centers.
WGPCMP Well group production and injection

compositional summaries detail by
wells.
RFT Well RFT report. For vertical wells the

report includes gridblock information for
each layer. For deviated wells this
information is printed only for each
perforation.

RFTFILE Well RFT report written to FORTRAN

Unit 18.
FACUTL Facility utilization summary.

Information will be printed for any well
management entity for which production
targets were specified.
FACFIL Facility utilization summary written to

FORTRAN Unit 57.
MGOR Marginal gas-oil ratio report. Available

only if the PREDICT MGOR option has
been specified.
SIM Simulation statistics. This report is

automatically printed at the end of the
run. The report includes time simulated,
timestep information, and, when
available, CPU information for the
current run and for cumulative
simulation runs.
TSSUM Timestep summary report. This

parameter is used to control the
frequency of entries in the timestep
summary report produced at the end of
the run.
SSSUM Spread sheet summary report written to

FORTRAN Units 72-77. The files to be
written and the quantities written on
each file are controlled by the SSSUM
card.
SSSUMR Same as SSSUM except that each time a

file is written, it is rewound and the
header, if requested, is written at the top.
WLSUM Well production and injection summaries

detailed by layers written to FORTRAN
Unit 1
TRACK Tracking output on FORTRAN unit 17.
TRACKW Water tracking report.
FLUX Boundary flux summaries.
TIME Alpha label that causes all reports named on this card to
be printed each time a TIME or DATE card is

encountered. Default is not to print on the basis of TIME

or DATE cards.
TNEXT Alpha label that causes all reports named on this card to
be printed only the next time a TIME or DATE card is
encountered. Default is not to print on the basis of the
next TIME or DATE card.
OFF Alpha label that causes all reports named on this card to
not be printed. It is equivalent to specifying a frequency
of 99999.to
freq A number that causes reports named on this card to be

printed after every freq timesteps (each timestep cut
counts as one timestep). Default is 99999.
NOTE: 1. At least one of the report labels given above must appear on the
PRINT card. If a report label appears on more than one PRINT card,
the frequency specified on the last PRINT card applies.
2. At least one of the values, TIME, TNEXT, OFF, or freq, must appear
after the report label(s) on the card. Either TIME or TNEXT may
appear with freq, but not with each other.
3. Different frequencies of printing can be used for each report label.
4. Any number of PRINT cards may appear in any data group.
5. If an ARRAYS label is specified on the PRINT card, but no array

names are specified on an OUTPUT card, then no array reports are
printed.
6. For the RFT/RFTFILE reports the OUTRFT card must be used to

specify the wells to be included.
7. For compositional summaries (i.e., the WELCMP, WLLCMP,

GCCMP, FSCMP, ARCMP, REGCMP, FLDCMP, and WGPCMP
options), the user can use the options PCDON, RCDON, LCDON,
PCDOFF, RCDOFF, LCDOFF, PCCD, and RCCD on the OUTPUT
card to specify whether the condensate rates, condensate yields, and
cumulative condensate volumes will be included in the output.
8. Three additional output reports will be printed when using the

WBSIM option. These are all printed at the same frequency as the
PRINT WLLYR report. These include: [1] an output table at the start
of the timestep containing the effective wellbore permeability for the
step, Moody friction factor, mixture density, delta-P friction, phase
velocities, critical velocities [minimum gas flow velocities to lift
insitu liquids], Reynold’s numbers, and alpha and beta parameters for
all of the wellbore segments, [2] an output table at the end of the
timestep for the wellbore perforations, showing the production/
injection rates and gas-oil ratios and water cuts, production and
injection cumulatives, and reservoir and wellbore pressures, and [3]

an output table presenting a profile of all of the wellbore segments,

containing the insitu saturations, average densities and viscosities,
alpha and beta flow parameters, effective wellbore permeabilities, and
wellbore pressures.
00 Examples:
00 PRINT REGION TIME
6.5 Buildup Pressure Output Control (BUILDUP)

00 The BUILDUP option is designed to allow the user to simulate the effects of
shutting in a well without actually shutting it in.
00 This option cannot be used for producers with rate specified with QMULT.
BUILDUP wl
time1 ... timen
comp1 ... compn
grad1 ... gradn
00 Definitions:
wl List of wells for which buildup data is specified (see

Section 1.5.2).
time Time in hours for shut in.
comp Total compressibility of fluids and formation near the

well, psi-1 (kPa-1). A value of zero causes the
compressibility to be computed internally. The
compressibility comp is given by
comp = cr + Soco + Sgcg + Swcw ,
where cr, co, cg, and cw are the compressibilities of rock,

oil, gas, and water, respectively, and So, Sg, and Sw are
oil, gas, and water saturations, respectively.
grad Average gradient of fluids in the well measured in the

field, psi/ft (gm/cc). A value of zero causes the gradient
to be computed internally.
00 This option computes and writes to a formatted results file corrected buildup
pressures for wells. This information is written on Fortran unit 30. The calculation
of buildup pressure in multi-layered wells is based on a development of the
Peaceman equations. When a BUILDUP card appears in a recurrent data group,
the requested information will be output at the time corresponding to the next

TIME or DATE card only. Buildup pressure is calculated for each perforated layer
in requested wells at the shut in time specified by the user. The number of time,
comp and grad values must equal the number of wells in the well list.
00 In field tests a single buildup pressure is measured for a well, not for each
perforation. Therefore, a single buildup pressure must be obtained from the layer
values. There is no unique weighting method to determine the single buildup-
pressure value. The weighting scheme adopted here is the production-rate-
weighted buildup pressure.
00 Note that the total compressibility and the density should be the estimated values
obtained in the field during the buildup test. Users should be cautious in using the
default values computed by the simulator.
6.6 Write Files (WPLOT, WMAP, WMAPOLD, WREST, WFLUX,

WFILE, WCPLOT)
⎛ TIME ⎞
writef ⎜ ⎟ ( freq )
⎜ TNEXT ⎟
⎝ OFF ⎠
00 writef can be one of the following:

WPLOT, WMAP, WMAPOLD, WREST, WFLUX, WFILE, WCPLOT
00 Definitions:
TIME Alpha label that causes the appropriate file or record to

be written each time a TIME or DATE card is
encountered. Default is not to write on the basis of TIME
or DATE cards.
TNEXT Alpha label that causes the appropriate file or record to

be written only the next time a TIME or DATE card is
encountered. Default is not to write on the basis of the
next TIME or DATE card.
OFF Alpha label that causes the appropriate file or record to

not be output. It is equivalent to specifying a frequency
of 99999.
freq A number that causes the appropriate file or record to be

written after every freq timesteps (each timestep cut
counts as one timestep). Default is 99999.

WPLOT The WPLOT card controls the writing of data to the vdb
file or to the plot file (FORTRAN Unit 11) that can be
used to plot the production/injection performance of
individual wells, well management levels, regions, and
the field. These plots are generated by a plotting program
that is separate from VIP-EXECUTIVE. WPLOT can
only be used if a PLOT card was included in the
utility data.
WMAP The WMAP card invokes the writing of array data to the
vdb file or to the map file (FORTRAN Unit 27). Maps of
this array data are generated by a program that is separate
from VIP-EXECUTIVE. WMAP can only be used if a
MAP card was included in the initialization data.
WMAPOLD The WMAPOLD card invokes the writing of SIMOUT

map files on FORTRAN Unit 9 (output of selected array
data). Maps of this array data are generated by a program
that is separate from VIP-EXECUTIVE. WMAPOLD
can only be used if a MAPOLD card was included in
the initialization data.
WREST The WREST card controls the writing of restart records

on FORTRAN Unit 2. If no WREST cards are used, no
user-specified restart records are written during the
recurrent portion of the simulation. A restart record is
automatically written after initialization.
WFLUX The WFLUX card controls the writing of a file, on

FORTRAN Unit 16, that contains boundary flux data for
input into a subsequent simulation model. WFLUX can
only be used if a FLUX card was included in the
initialization data.
WFILE The WFILE card controls the writing of a special well

file to FORTRAN Unit 71.
WCPLOT The WCPLOT card controls the writing of data to the

vdb file or to the cplot file (FORTRAN Unit 26) that can
be used to plot the production/injection compositional
performance of individual wells, well management
levels, regions, and the field. These plots are generated
by a plotting program that is separate from VIP-
EXECUTIVE. WCPLOT can only be used if a
CPLOT card was included in the initialization data.
NOTE: At least one of the values, TIME, TNEXT, OFF, or freq, must appear on
the writef card. Either TIME or TNEXT may appear with freq.
Files will not be saved unless the appropriate commands are added to the

job control stream. Information is only written out to the appropriate file
when one of the writef commands is encountered.
00 Examples:
00 To write data out to the PLOT file at every TIME (or DATE card)
and every 30 timesteps:
00 WPLOT TIME 30
6.7 Save Temporary Restarts (WLASTR)
⎛ TIME ⎞
WLASTR ⎜ ⎟ ( freq )
⎜ TNEXT ⎟
⎝ OFF ⎠
00 Definitions: As defined for WREST (Section 6.6).
NOTE: The WLASTR option writes restart records according to the time or
frequency specified retaining only the last restart record written,
essentially to provide a recovery mechanism for jobs that terminate
abnormally due to time limits, etc. It supplements rather than replaces the
restart records written as a result of the WREST card(s).
At each time a restart record is written, if the previous restart record was a
temporary one (one written by a WLASTR card) it is first removed before
the current restart record is written.
Restart records written by a WLASTR card do not replace ones written by

WREST cards.
6.8 Write Fluid Tracking Data (WTRACK)
⎛ TIME ⎞
WTRACK (INPLACE) ⎜ ⎟ ( freq )
⎜ TNEXT ⎟
⎝ OFF ⎠
00 Definitions:
INPLACE Alpha label indicating that reservoir in-place tracked

fluid moles should also be written to the file.

TIME Alpha label that causes a record to be written each time a

TIME or DATE card is encountered. Default is not to
write records on the basis of TIME or DATE cards.
TNEXT Alpha label that causes a record to be written only the

next time a TIME or DATE card is encountered. Default
is not to write records on the basis of the next TIME or
DATE card.
OFF Alpha label that causes the record not to be output. It is

freq A number that causes records to be written after every

freq timesteps (each timestep cut counts as one
timestep). Default is 99999.
NOTE: The WTRACK card controls the writing of fluid tracking results into a
separate file. WTRACK can only be used if a TRACK card was
included in the initialization data.
At least one of the values, TIME, TNEXT, OFF, or freq, must appear on
the WTRACK card. Either TIME or TNEXT may appear with freq.
Tracking records are written on FORTRAN Unit 17, but may not be saved
unless the appropriate commands are added to the job control stream.
If no WTRACK cards are used, no tracking records are written.

6.9 Print/Map Mole Fractions (OUTX, OUTY, OUTZ, OUTXT,

OUTYT, OUTZT, MAPX, MAPY, MAPZ, MAPXT, MAPYT,
MAPZT)
outf cmpid1 cmpid2 ... cmpidk
00 outf can be one of the following:

OUTX, OUTY, OUTZ, OUTXT, OUTYT, OUTZT
MAPX, MAPY, MAPZ, MAPXT, MAPYT, MAPZT
00 Definitions:
cmpid Alpha label identifying a component whose mole

fractions will be included in the array reports/map file.
Only those components named will be printed/mapped.
OUTX Print liquid mole fractions.
OUTY Print vapor mole fractions.
OUTZ Print overall hydrocarbon mole fractions.
OUTXT Print tracked liquid mole fractions.
OUTYT Print tracked vapor mole fractions.
OUTZT Print tracked overall hydrocarbon mole fractions.
MAPX Map liquid mole fractions.
MAPY Map vapor mole fractions.
MAPZ Map overall hydrocarbon mole fractions.
If the diffusion option is on (Section 8.11), diffusion

fluxes for the specified component will also be mapped.
See the Diffusion chapter in the VIP-CORE Reference
Manual for more information.
MAPXT Map tracked liquid mole fractions.
MAPYT Map tracked vapor mole fractions.
MAPZT Map tracked overall hydrocarbon mole fractions.
NOTE: 1. If the user wishes to print/map arrays of mole fractions, they must
explicitly select the components to be output on one of the above
cards.

2. When the tracked mole fraction arrays are requested, the order of
printing is: all requested components for tracked fluid 1, all requested
components for tracked fluid 2, etc.
3. In VIP-THERM, H2O may be specified for cmpid on the OUTY,

OUTYT, MAPY, or MAPYT cards for the water mole fraction in the
vapor phase.
6.10 Format of Mole Fraction Array Print (ALLCOMP)

00 The ALLCOMP card is used to specify how mole fraction arrays (selected with
OUTX, OUTY, OUTZ, OUTXT, OUTYT, OUTZT) are to be printed. The default
mode is to print each component of a mole fraction array individually. When
ALLCOMP is specified, all requested components of a mole fraction array (e.g.
liquid mole fraction) are printed in a vertical column for each gridblock.
ALLCOMP ⎛ ON ⎞
⎝ OFF⎠
00 Definitions:
ON Alpha label indicating that all requested components of a

mole fraction array are printed in a vertical column for
each gridblock. This is the default if neither ON nor OFF
is specified.
OFF Alpha label indicating that all requested components of a

mole fraction array are printed individually. This is the
default when no ALLCOMP card is entered.
6.11 Tracked Water Type Fractions (OUTWT, MAPWT)
OUTWT tknamw1 tknamw2... tknamwk

MAPWT tknamw1 tknamw2... tknamwn
00 Definitions:
tknamw Alpha label identifying the tracked water type for which
the fractional saturations of that fluid will be included in
the array reports/map file. Only those tracked water types
named will be printed/mapped.

6.12 Specify Which Separator Batteries to Process (OUTSEP)

00 The user may control the amount of output produced by the program for separator
battery reports by specifying which batteries should be processed. If no battery
designation follows the OUTSEP label, no battery report will be printed.
⎛ ibat
⎞ ⎛ idfbat ⎞
OUTSEP ⎜ ⎟ ⎜ DEF ⎟
⎝ ALL ⎠ ⎝ ALL ⎠
00 Definitions:
ibat List of user-defined separator batteries. No VIP-CORE

generated default separator batteries can be specified
here.
ALL Alpha label indicating that reports for all user-defined

separator batteries should be generated.
DEF Alpha label indicating that the remaining data on the

OUTSEP card apply to default separator batteries.
idfbat List of default separator batteries. A value of -npvt,

where npvt is the number of a PVT table (VIP-
ENCORE) or npvt is 1 (VIP-COMP), will cause the use
of one of the default separator batteries defined by VIP-
CORE.
ALL Alpha label indicating that reports for all default

separator batteries should be generated.
NOTE: Each OUTSEP card supersedes and replaces the previous OUTSEP card.
00 Example:
00 OUTSEP 1

6.13 Reservoir Region Separator Battery Assignment (REGSEP)

00 The REGSEP card is used to assign separator batteries to output regions for
surface volume calculations. If the number of separators is increased for this run,
then a REGSEP card will be required to handle region assignment.
00 In order to calculate surface volumes to be included in region reports, VIP-

EXECUTIVE must have a separator battery assignment for each reservoir region.
The battery assignments are also needed if the arrays RS, GOR, WCUT, OIP, GIP,
FGIP, or OCIP are to be printed or mapped.
REGSEP ibat1...ibatnreg
00 Definitions:
ibat Separator battery number for each output region.

Alternatives include the battery number of a separator
input in the separator data (Surface Separation Data), a
value of -npvt which accesses a default separator, and a
value of 0:
ibati = nbat (input battery)

= -npvt (default separator)
= 0
A value of 0 will result in the default value -1 being used

for surface volume calculations in VIP-CORE, and no
surface volumes will be reported for that region report in
the simulation modules.
nreg Maximum output region number defined in the

IREGION data.
NOTE: REGSEP data is passed from VIP-CORE to the simulation module, but
under certain circumstances the value may be changed. If a default
separator battery was specified in VIP-CORE, and REGSEP is not input in
the simulation module, then the value from VIP-CORE will be changed to
1 if Separator 1 has been input or -1 if Separator 1 has not been input. If
any other default separator is desired for a region, then the REGSEP card
must be specified in the simulation module. To specify a default separator
ibat should be set to -npvt, where npvt is a PVT table number (VIP-
ENCORE) or npvt is 1 (VIP-COMP).

6.14 Compute Potentials for Plot File (PLOTPTN)

00 The PLOTPTN card controls whether well and well management level potential
production and injection rates are computed for inclusion in the plot file. If
PLOTPTN ON has not been specified, the 5 potential rate variables in the plot
files will have value zero.
ON
PLOTPTN
OFF
00 Definitions:
ON Alpha label indicating potential production and injection

rates are to be included in the plot files.
OFF Alpha label indicating potential production and injection

rates are to show as zeroes in the plot files. This is the
default.
6.15 Printout Processed Well Cards (PRINTOUT)

00 The PRINTOUT card controls the printout of the processed well and table data
cards.
ON
PRINTOUT
OFF
00 Definitions:
ON Alpha label indicating all processed recurrent data cards

are to be printed. This is the default.
OFF Alpha label indicating that the printing of well and

tabular data will be suppressed.

6.16 Logical Unit for Timestep Summary Output (IPRTSS)

00 The IPRTSS card is used to define the FORTRAN logical unit onto which the end-
of-run timestep summary output will be written. This summary output is identical
to the timestep summary in the main output file and is controlled by the TSSUM
and TSSDAT keywords on the OUTPUT card and the TSSUM keyword on the
PRINT card.
IPRTSS iunit
00 Definition:
iunit FORTRAN logical unit number for the timestep

summary report. Default is to not write this summary to a
file.
NOTE: The user should specify a unit number that is not used for another file.
6.17 Specify Wells Included in Well RFT Report (OUTRFT)

00 The OUTRFT card is used to specify the wells to be included in the well RFT
report (RFT or RFTFILE on the PRINT card).
OUTRFT wl
00 Definition:
wl List of wells for which an RFT report will be generated.
NOTE: Each OUTRFT card supersedes and replaces the previous OUTRFT card.

6.18 Spreadsheet Files (SSSUM)

00 The SSSUM card is used to specify options and variables to appear in the
spreadsheet summary files. By specifying separate SSSUM cards, a spreadsheet
summary file may be obtained for each of the following: field, area, flow station,
gathering center, well, region, node. The FORTRAN units used are, respectively,
Unit 72, Unit 73, Unit 74, Unit 75, Unit 76, Unit 77, Unit 80. All variables that are
plotted can be written to be the spreadsheet summary files. The frequency of the
output is controlled by the SSSUM parameter on the PRINT card.
00 The member number, time, and member name are automatically written in the
first three fields of each requested spreadsheet file.
00 A maximum of 33 variables may be written to any spreadsheet summary file.
00 Information for the node spreadsheet file may be found in Section 10.18.2, “Node
Spreadsheet File (SSSUM)”.
00 The optional SSSID card is used to specify an alphanumeric run identification

label, up to eight characters, which can be written to the spreadsheet files as
specified by the RUNID keyword. This label is useful when spreadsheet data from
different runs are combined in a single file by the user. This option is only
available in VIP-THERM.
(SSSID sssid)
FIELD
AREA
FLOSTA
SSSUM GATHER (TAB)(HEADER)(RUNID) varnm1 varnm2 ... varnmn
WELL
REGION
NODE
00 Definitions:
Alpha label indicating the spreadsheet summary file to which the subsequent
data applies:
FIELD Field.
AREA Area.

WELL Well.
REGION Output region.
NODE Node.
TAB Alpha label indicating that the columns will be separated

by a tab character. Omission will result in columns
separated by a comma.
HEADER Alpha label indicating that a title line, column header

line, and a units line should be included in the file at each
time.
RUNID Alpha label indicating that the run identification label

specified on the SSSID card will be written as a column
in the spreadsheet file. Available only in VIP-THERM.
varnm Alpha label specifying one or more of the following

variables:
The following may be used for any of the files:
DATE Calendar date.
TSNUM Timestep number.
QGP Gas production rate.
QOP Oil production rate.
QWP Water production rate.
QGI Gas injection rate.
QWI Water injection rate.
CGP Cumulative gas production.
COP Cumulative oil production.
CWP Cumulative water production.
CGI Cumulative gas injection.
CWI Cumulative water injection.
RESVOL Reservoir production/injection:
1. Reservoir oil production rate.

2. Reservoir gas production rate.

3. Reservoir water production rate.

4. Reservoir gas injection rate.
5. Reservoir water injection rate.
6. Cumulative reservoir oil produced.
7. Cumulative reservoir gas produced.
8. Cumulative reservoir water produced.
9. Cumulative reservoir gas injected.
10. Cumulative reservoir water injected.
The following may be used for any file except REGION:
GLG Gaslift gas injection rate.
CGLG Cumulative gaslift gas injection.
MGOR Marginal gas-oil ratio.
POTQGP Gas potential production rate.
POTQOP Oil potential production rate.
POTQWP Water potential production rate.
POTQGI Gas potential injection rate.
POTQWI Water potential injection rate.
OGR Oil-gas ratio.
WGR Water-gas ratio.
WCUT Water cut.
GOR Gas-oil ratio.
WOR Water-oil ratio.
SAL Water salinity.
The following may be used for FIELD or REGION only:
TPVP Total PV-weighted average pressure.
HCPVP Hydrocarbon PV-weighted average

pressure.
HCPVPD HCPV-weighted average pressure at

datum.
GIP Gas-in-place.
OIP Oil-in-place.

WIP Water-in-place.
OREC Percent oil recovery.
GREC Percent gas recovery.
AQNFLX Water influx from analytical aquifers.
PZ P/Z (Equal to P in VIP-THERM).
The following may be used for WELL only:
PERF1P Gridblock pressure of first perforation.
PAVE Mobility-weighted average well

pressure.
BHP Well bottomhole pressure.
THP Well tubinghead pressure.
DRDWNP Well average drawdown pressure.
BLDP Well buildup pressure.
ONTIME Ontime factor.
DAYSP Days well has produced.
DAYSI Days well has injected.
PLFS TSFM plant liquid flow stream.
CPLFS TSFM cumulative plant liquid flow

stream.
PRGAS TSFM plant residual gas.
CPRGAS TSFM cumulative plant residual gas.
EQWL TSFM equivalent total wellstream.
CEQWL TSFM cumulative equivalent total

wellstream.
GCNAME Name of gathering center to which well

belongs.
GCNUM Number of gathering center to which

well belongs.
RCMUNT Active recompletion unit number.

The following may be used for WELL or GATHER only:
FSNAME Name of the flow station to which well/

gathering center belongs.
FSNUM Number of the flow station to which

well/gathering center belongs.
The following may be used for WELL, GATHER, or

FLOSTA only:
ARNAME Name of area to which well/gathering

center/flow station belongs.
ARNUM Number of areas to which well/gathering

center/flow station belongs.
The following may be used for GATHER, FLOSTA,

AREA, or FIELD only:
WELLS Number of active:
1. Total wells.
2. Producers.
3. Gaslift producers.
4. Water injectors.
5. Gas injectors.
NGL From the NGLPLANT:
1. Feed rate.
2. Liquid rate.
3. Vapor rate.
4. Cumulative produced.
LPG From the LPGPLANT:
1. Feed rate.
2. Liquid rate.
3. Vapor rate.
MI From the MIPLANT:
1. Feed rate.
2. Liquid rate.
3. Vapor rate.
GSHNDL Gas handling quantities:

1. Shrinkage gas rate.

2. Fuel gas rate.
3. Sales gas rate.
4. Makeup gas rate.
5. Available injection gas rate.
6. Makeup fuel gas rate.
7. Flared gas rate (FIELD only).
8. Cumulative shrinkage gas.
9. Cumulative fuel gas.
10. Cumulative sales gas.
11. Cumulative makeup gas.
12. Cumulative flared gas (FIELD only).
The following may be used for FIELD or AREA only:
GFO Gas field operations (single or

multiple contracts):
1. DCQ.
2. ACQ.
3. Potential gas production rate.
4. Gas sales rate.
5. Cumulative sales gas.
6. Number of cycles in first pass.
varnm Additional alpha labels specifying variables valid in VIP-

THERM only:
The following may be used for any of the files:
QEP Energy production rate.
QSTP Steam production rate.
QRLP Reservoir liquid production rate.
QEI Energy injection rate.
CEP Cumulative energy production.
CSTP Cumulative steam production.
CRLP Cumulative reservoir liquid production.
CEI Cumulative energy injection.
The following may be used for FIELD or REGION only:
EIP Energy in place.
STIP Steam in place.

QHL Heal loss rate.
CHL Cumulative heat loss.
PVSI Pore volumes steam injected.
PVOP Pore volumes oil produced.
FIOP Fraction of initial oil produced.
The following may be used for REGION only:
QRGP Reservoir gas production rate.
QROP Reservoir oil production rate.
QRWP Reservoir water production rate.
QRSP Reservoir steam production rate.
QRGI Reservoir gas injection rate.
QRWI Reservoir H2O injection rate.
CRGP Cumulative reservoir gas production.
CROP Cumulative reservoir oil production.
CRWP Cumulative reservoir water production.
CRSP Cumulative reservoir steam production.
CRGI Cumulative reservoir gas injection.
CRWI Cumulative reservoir H2O injection.
QBGP Boundary reservoir gas outflow rate.
QBOP Boundary reservoir oil outflow rate.
QBWP Boundary reservoir water outflow rate.
QBSP Boundary reservoir steam outflow rate.
QBEP Boundary energy outflow rate.
QBGI Boundary reservoir gas inflow rate.
QBOI Boundary reservoir oil inflow rate.
QBWI Boundary reservoir water inflow rate.
QBSI Boundary reservoir steam inflow rate.

QBEI Boundary Energy inflow rate.
CBGP Cumulative boundary reservoir gas

outflow.
CBOP Cumulative boundary reservoir oil

outflow.
CBWP Cumulative boundary reservoir water

outflow.
CBSP Cumulative boundary reservoir steam

outflow.
CBEP Cumulative boundary energy outflow
CBGI Cumulative boundary reservoir gas

inflow.
CBOI Cumulative boundary reservoir oil

inflow.
CBWI Cumulative boundary reservoir water

inflow.
CBSI Cumulative boundary reservoir steam

inflow.
CBEI Cumulative boundary energy inflow.
NOTE: 1. All of the alpha labels must appear on one SSSUM card. If necessary
the continuation character ’>’ can be used.
2. One and only one of the FIELD, AREA, FLOSTA, GATHER, WELL,
or REGION labels must be specified.
3. Except for TAB and HEADER, the order of the alpha labels is the
order the variables will appear in the file.
4. The member number, simulation time, and member name are

automatically written in the first three fields of the file.
5. Each SSSUM card for a specific level (FIELD, etc) supersedes and
replaces the previous SSSUM card for that level.
6. A FLOWS card must be input in the initialization utility data in order

to write the region boundary rates and cumulatives (QB* and CB*) in
VIP-THERM.
00 Example:
00 SSSUM WELL TAB HEADER DATE QOP BHP

SSSUM FIELD HEADER TAB DATE COP PZ
6.19 Well Average Pressure Calculation (OUTPAVG)

00 The OUTPAVG card is used to specify the method for computing the well average
pressure in the production/injection summaries and output to the plot file. The
choices are mobility-weighted datum pressure average or one of several patterns.
OUTPAVG STD
or
OUTPAVG PATTERN (DATUM) iptn

(GRIDBLOCK)
or
OUTPAVG PATTERN (DATUM) (card 1)

(GRIDBLOCK)
iptn1 . . . iptnNZ (card 2)
00 Definitions:
STD Alpha label indicating that the mobility-weighted datum

pressure average is to be computed. This is the default.
PATTERN Alpha label indicating one of the possible patterns is to

be used to compute the well average pressure.
DATUM Alpha label indicating that the well average datum

pressure is to be computed. This is the default for a
pattern calculation.
GRIDBLOCK Alpha label indicating that the well average gridblock

pressure is to be computed.
iptn Pattern type:
1 Square pattern of size 1 gridblock by 1 gridblock
2 5-spot pattern
3 Square pattern of size 3 gridblocks by 3

gridblocks

gridblocks


gridblocks

gridblocks
0 Exclude this layer from the calculation.
NOTE: 1. In the second format, the iptn pattern will be used for each block in
the well.
2. Each OUTPAVG card supersedes and replaces the previous

OUTPAVG card.
3. For the PATTERN option, all perforations are used in the calculation,
including inactive or shut-in perforations.
6.20 Print Well Indices (PRWI)

00 The PRWI card causes an immediate printout of the well index for each well.
PRWI
6.21 Print Well Properties Summary (PRWSTA)

00 The PRWSTA card causes an immediate printout of the well properties for each
well.
PRWSTA
6.22 Track File Format (TFORM)

00 The TFORM card is used to control the format of fluid tracking results file, the
writing of which is controlled by the WTRACK card.
TFORM [FORM]
[BINARY]
00 Definitions:

TFORM Keyword indicating that the track file format is to be

specified. If the TFORM card is omitted, formatted
records are written to the track files (.trk and .tps files).
FORM Keyword indicating that formatted records are to be

written to the track files.
BINARY Keyword indicating that binary records are to be written

to the track files.
NOTE: The TFORM card should appear only once (before the first DATE or
TIME card) in each restart run, and different formats may be specified for
successive restart runs. Since this information is stored in the restart
record, this card needs only appear once (at time zero) if the same format
is to be used throughout the entire simulation.
00 Examples:
00 C TO SPECIFY BINARY TRACK FILES

TFORM BINARY
6.23 Boundary Flux File Format (FXFORM)
FXFORM [FORM]
[BINARY]
00 Definitions:
FORM Alpha label indicating that a formatted flux file is to be

written or read-in. This is the default.
BINARY Alpha label indicating that a binary flux file is to be

written or read-in.
NOTE: The FXFORM card specifies either formatted or binary flux file is to be
written (in the output mode of the boundary flux option) or read-in (input
mode of the boundary flux option).
00 Examples:
C***** Boundary Flux File Format

FXFORM BINARY

6.24 Print by Cross-Sections (CROSS)

00 The CROSS card causes arrays to be printed by cross-sections (vertical planes),
instead of by areal planes. This card is necessary only if the user wishes to change
the printout from what was used in VIP-CORE.
CROSS
⎛ ON ⎞
⎝ OFF⎠
00 Definitions:
ON Alpha label indicating that arrays are to be printed by

cross-sections (vertical planes). This is the default if
neither ON nor OFF is specified.
OFF Alpha label indicating that arrays are to be printed by

areal planes.
6.25 Grouping Wells (WLGRP)

00 The WLGRP card is used to define well groups which are used for reporting
purposes and/or for easily setting maximum well rates. The well group report will
be printed when the keyword WLGRP is included on the PRINT card. The
QMAXGR card (see following section) is used to set the maximum rate for all
wells in a group.
WLGRP grpnum (grpnam)

wl
00 Definitions:
grpnum Group number.
grpnam Group name of up to eight (8) characters. The first

character in the name must be alphabetic unless the name
is immediately preceded by the character #.
wl List of wells belonging to the group. If the group number

is equal to zero, then the well numbers included in the
well list are removed from all well groups.
NOTE: Well groups can be formed or modified by means of new WLGRP cards.
At least one WLGRP card should be included for each group. This card
specifies the group number, the group name, and the list of wells
belonging to the group. Each well can belong to only one group. If a well

was included in one group and then it is included in a second group, this
well is automatically deleted from the first group. If several WLGRP cards
are included with the same group number, then all wells specified in these
cards will belong to one group. To remove a well from the group, the
number of this well should be included in the WLGRP card with a zero
group number.
00 Examples:
00 In this example, the names GROUP_1 and GROUP_2 are assigned to

Group 1 and Group 2. Initially Wells 25, 26, 29, 2, 6, and 12 are included
in Group 1 and Wells 27, 28, and 30 are included in Group 2. Then Well
29 is removed from Group 1, Well 31 is added to Group 2, and Well 26 is
moved from Group 1 to Group 2.
00 WLGRP 1 GROUP_1
25 26 29
WLGRP 1
2 6 12
WLGRP 2 GROUP_2
00 27 28 30
PRINT WLGRP TIME
...
...
...
DATE 1 7 1987
WLGRP 0
29
WLGRP 2
26, 31
6.26 Group Specification of Maximum Well Rates (QMAXGR)

00 The QMAXGR card used to set the maximum well rates for all wells in a well
group defined with the WLGRP card. The QMAX and QMAXGR cards are order-
dependent.
QMAXGR grp qmaxgr
00 Definitions:
00 grp Group name or group number.
qmaxgr Maximum well rate to assign to each of the wells in the

well group. For each well the unit of this rate depends on

the well’s type. That is, whatever unit would have applied
on the QMAX card applies here.
6.27 Plot File Well Specification (PLOTLIST)

00 The PLOTLIST card is used to specify which wells are to be included in the well
plot file and/or the well layer plot file.
PLOTLIST WELL ON ALL

WLLYR O FF wl
00 Definitions:
WELL Alpha label indicating that the data on this card applies to
the well plot file.
WLLYR Alpha label indicating that the data on this card applies to
the well layer plot file.
ON Alpha label indicating that the specified wells are to be

included in the plot file.
OFF Alpha label indicating that the specified wells are to be

excluded from the plot file.
ALL Alpha label indicating that the data on this card applies to
all wells.
wl List of wells to which the data on this card applies (see

Section 1.5.2).
NOTE: 1. If the PLOTLIST card is not entered, all wells are included in the plot
file.
2. To restrict the wells on the plot file, all wells must first be excluded
(OFF), then the desired wells included (ON).
00 Example:
00 PLOTLIST WELL OFF ALL

PLOTLIST WELL ON D*

6.28 Spreadsheet Well Specification (SPRLIST)

00 The SPRLIST card is used to specify which wells are to be included in the well
spreadsheet file, and, possibly, in what order.
00 The SPRLIST card may also be used to specify nodes for the node spreadsheet file
ON
SPRLIST WELL O FF ALL
ORDER wl
ORDEROFF
00 Definitions:
WELL Alpha label indicating that the data on this card applies to
the well spreadsheet file.
ON Alpha label indicating that the specified wells are to be

included in the spreadsheet file. If an active ordered list
currently exists and a well does not already exist in the
list, it will be appended.
OFF Alpha label indicating that the specified wells are to be

excluded from the spreadsheet file.
ORDER Alpha label indicating that a new ordered list of wells is

being created. Only these wells will be written.
ORDEROFF Alpha label indicating that the order option is turned off.
No wells will be output to the spreadsheet file until
turned on by a subsequent SPRLIST card.
Since ORDEROFF excludes all wells automatically,

neither the keyword ALL nor a list of wells need be
entered.
all wells.
wl List of wells to which the data on this card applies (see

section 1.5.2).
NOTE: 1. If the SPRLIST card is not entered, all wells are included in the
spreadsheet file.
2. To restrict the wells on the spreadsheet file, all wells must first be
excluded (OFF), then the desired wells included (ON).

00 Example:
00 SPRLIST WELL OFF ALL

SPRLIST WELL ON PROD*

6.29 Results File Formats

00 The PLOT, CPLOT and MAP files written out by VIP-EXECUTIVE can be post-
processed by a variety of programs. To facilitate user access to these files, the
content and formats are described below. Each line corresponds to a different
record. The "Type" column specifies the variable type for each field in the record.
The "Format" column specifies the format used to write the record to a formatted
file.
00 The meanings of the symbols in the "Type" column are:
C*4 CHARACTER*4
C*6 CHARACTER*6
C*8 CHARACTER*8
C*20 CHARACTER*20
C*80 CHARACTER*80
I INTEGER
R REAL
6.29.1 Plot File Organization
Once, at top of file 00
Type Format Record
C*6 10A6 PLOT <FORM | BIN> 1.1.1 <simulator><simulator version> [DUAL]

C*20 2A20 <casename><case parent>
C*80 A80 <title1>
C*80 A80 <title2>
C*80 A80 <title3>
I 10I5 <# classes> <day> <month> <year> <nx> <ny> <nz> <# comps>
C*8 10A8 <class #1 name> <class #2 name> ...
I 10I5 <# variables in class #1> <# variables in class #2> ...
Loop for each class
C*4 18A4 TIME <variable #1 name> <variable #2 name> ...
end loop for class
Repeated for each requested time

Data for each class is output only if requested 00
Type Format Record
WELL Class
C*8 A8 WELL
R 5G15.5 <timestep #> <time> <# wells> <max # wells> 1
Loop for each well
C*8 8A8 <well name> <well #> 0 <1st perf i><1st perf j><gc #><fs #><area #>
R 1P6E13.6 <variable #1 value> < variable #2 value> ...
end loop for well

WLLYR Class
C*8 A8 WLLYR
R 5G15.5 <timestep #> <time> <# wells> <max # wells> <max # perfs>
Loop for each well
C*8 8A8 <well name><well #><# perfs><1st perf i><1st perf j><gc#><fs #><area #>
Loop for each perf
C*8 2A8 <perf gridblock #> <layer name>
R 1P6E13.6 <variable #1 value> <variable #2 value> ...
end loop for perf
end loop for well
GATHER Class
C*8 A8 GATHER
R 5G15.5 <timestep #> <time> <# gathering centers> <max # gc’s> 1
Loop for each gathering center
C*8 8A8 <gc name> <gc #> 0 0 0 <gc #> <fs #> <area #>
end loop for gathering center
FLOSTA Class
C*8 A8 FLOSTA
R 5G15.5 <timestep #> <time> <# flow stations> <max # fs’s> 1
Loop for each flow station
C*8 8A8 <fs name> <fs #> 0 0 0 0 <fs #> <area #>
end loop for flow station
AREA Class
C*8 A8 AREA
R 5G15.5 <timestep #> <time> <# areas> <max # areas> 1
Loop for each area
C*8 8A8 <area name> <area #> 0 0 0 0 0 <area #>
end loop for area
REGION Class
C*8 A8 REGION
R 5G15.5 <timestep #> <time> <# regions> <max # regions> 1
Loop for each region
C*8 8A8 <region name> <region #> 0 0 0 0 0 0
end loop for region
FIELD Class
C*8 A8 FIELD
R 5G15.5 <timestep #> <time> 1 1 1
C*8 8A8 FIELD 1 0 0 0 0 0 0
C*8 A8 STOP (only at end-of-file)

NOTE: See the PLOT card in Utility Data for a list of valid Class names. The
current set of variable names can be obtained from the example below.
Well Pressures written to the PLOT file depend on parameters set during
the run. By default, PTOP is the pressure of the top perforated block,
PAVE is a mobility weighted block pressure at datum (mobility of the well
production/injection phase) and BHP is the bottomhole flowing pressure
at datum (DRDN is (PAVE-BHP)). The datum depth defaults to the depth
of the first equilibration region, but can be set with a BHP or THP card.
These pressures are modified by the OUTPAVG and BUILDUP cards. In
contrast, all layer pressures are at depth.
The variables beginning with the character "?" denote temporary positions
in the plot file. These may be used for future development without
changing the size of the plot records.
00 Examples:
00 Plot File - Based on "PLOT ALL FILE"
PLOT FORM 5.0.0 EXEC v1998r

TEST
VIP TEST MODEL
EXAMPLE FOR DOCUMENTATION PURPOSES
7 1 1 1992 18 6 3 3
WELL WLLYR GATHER FLOSTA AREA REGION FIELD
39 25 26 25 27 23 35
TIMEQGP QOP QWP QGI QWI CGP COP CWP CGI CWI PTOPPAVEBHP THP DRDNPBLDQGLG
CGLGDYSPDYSIMGORPLF CPLFPRG CPRGETW CETWPQGPPQOPPQWPPQGIPQWIOGR WGR ?TM1
?TM2?TM3?TM4?TM5
TIMEIX JY KZ QOP QGP QWP GOR WC PRESPDATBHP QGI QWI ROP RGP RWP RGI
RWI DTOPDBOTPLOSPWDPPLENPANVPANA
TIMEQGP QOP QWP QGI QWI CGP COP CWP CGI CWI CGV QGLGCGLGMGORPQGPPQOPPQWP
PQGIPQWIOGR WGR ?TM1?TM2?TM3?TM4?TM5
TIMEQGP QOP QWP QGI QWI CGP COP CWP CGI CWI QGLGCGLGMGORPQGPPQOPPQWPPQGI
PQWIOGR WGR ?TM1?TM2?TM3?TM4?TM5
TIMEQGP QOP QWP QGI QWI CGP COP CWP CGI CWI QGLGCGLGMGORPQGPPQOPPQWPPQGI
PQWIOGR WGR QSG CSG ?TM1?TM2?TM3?TM4?TM5
TIMECGP COP CWP CGI CWI PAVDPAVTPAVHGIP OIP WIP QOP QGP QWP QGI QWI OGR
WGR ?TM1?TM2?TM3?TM4?TM5
TIMEQGP QOP QWP QGI QWI CGP COP CWP CGI CWI PAVTPAVHGIP OIP WIP QGLGCGLG
MGORP/Z PQGPPQOPPQWPPQGIPQWIOGR WGR ORECGRECQSG CSG ?TM1?TM2?TM3?TM4?TM5
WELL
14.000 274.00 3.0000 20.000 1.0000
PRD 8 0 5 2 1 1 1
1.280376E+02 5.242931E+02 9.459076E+01 0.000000E+00 0.000000E+00 3.521548E+04
1.439770E+05 2.142366E+04 0.000000E+00 0.000000E+00 2.724752E+03 2.693599E+03
2.453844E+03 0.000000E+00 2.397549E+02 0.000000E+00 0.000000E+00 0.000000E+00
2.740000E+02 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 4.094837E+03 7.387733E+01 0.000000E+00 0.000000E+00

0.000000E+00 0.000000E+00 0.000000E+00

INJ1 1 0 3 3 1 1 1
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 5.495544E+02 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 1.422169E+05 2.819950E+03 2.750626E+03
2.837861E+03 0.000000E+00-8.723476E+01 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 2.740000E+02 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00
INJ6 6 0 3 3 1 1 1
0.000000E+00 0.000000E+00 0.000000E+00 2.594420E+02 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 6.894230E+04 0.000000E+00 2.775718E+03 2.760035E+03
2.761008E+03 0.000000E+00-9.733106E-01 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 2.740000E+02 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00
WLLYR
14.000 274.00 3.0000 20.000 100.00
INJ1 1 1 3 3 1 1 1
255 K3
3.000000E+00 3.000000E+00 3.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 2.819950E+03 2.750626E+03 2.907185E+03 0.000000E+00
5.495544E+02 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 5.557241E+02
5.754000E+03 5.780000E+03 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00
INJ6 6 1 3 3 1 1 1
39 K1
3.000000E+00 3.000000E+00 1.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 2.775718E+03 2.760035E+03 2.776692E+03 2.594420E+02
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 2.778621E+02 0.000000E+00
5.700000E+03 5.727000E+03 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00
PRD 8 2 5 2 1 1 1
23 K1
5.000000E+00 2.000000E+00 1.000000E+00 2.913259E+02 7.329747E+01 2.062178E+01
2.515996E+02 6.610653E-02 2.724752E+03 2.686124E+03 2.492472E+03 0.000000E+00
0.000000E+00 3.322876E+02 0.000000E+00 2.085887E+01 0.000000E+00 0.000000E+00
5.700000E+03 5.733000E+03 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00
131 K2
5.000000E+00 2.000000E+00 2.000000E+00 2.329666E+02 5.474043E+01 7.396899E+01
2.349711E+02 2.409918E-01 2.754788E+03 2.703844E+03 2.504788E+03 0.000000E+00
0.000000E+00 2.639768E+02 0.000000E+00 7.481309E+01 0.000000E+00 0.000000E+00
5.733000E+03 5.766000E+03 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00
GATHER
14.000 274.00 1.0000 5.0000 1.0000
1 0 0 0 1 1 1
1.943243E+03 7.093291E+03 1.114112E+03 2.594420E+02 3.353396E+03 5.335137E+05
1.943689E+06 2.220256E+05 6.894230E+04 8.946251E+05 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 3.650234E+03 5.733261E+01 0.000000E+00 0.000000E+00 0.000000E+00

0.000000E+00 0.000000E+00
FLOSTA
14.000 274.00 1.0000 5.0000 1.0000
1 0 0 0 0 1 1
1.943243E+03 7.093291E+03 1.114112E+03 2.594420E+02 3.353396E+03 5.335137E+05
1.943689E+06 2.220256E+05 6.894230E+04 8.946251E+05 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
3.650234E+03 5.733261E+01 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00
AREA
14.000 274.00 1.0000 5.0000 1.0000
1 0 0 0 0 0 1
1.943243E+03 7.093291E+03 1.114112E+03 2.594420E+02 3.353396E+03 5.335137E+05
1.943689E+06 2.220256E+05 6.894230E+04 8.946251E+05 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
3.650234E+03 5.733261E+01 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00
REGION
14.000 274.00 1.0000 1.0000 1.0000
1 0 0 0 0 0 0
5.332544E+05 1.944172E+06 2.220256E+05 6.894230E+04 8.946251E+05 2.651545E+03
2.661513E+03 2.658203E+03 1.711230E+07 6.371604E+07 3.296248E+07 7.094940E+03
1.942356E+03 1.114112E+03 2.594420E+02 3.353396E+03 3.116205E+00 3.051307E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
FIELD
14.000 274.00 1.0000 1.0000 1.0000
FIELD 1 0 0 0 0 0 0
1.943243E+03 7.093291E+03 1.114112E+03 2.594420E+02 3.353396E+03 5.335137E+05
1.943689E+06 2.220256E+05 6.894230E+04 8.946251E+05 2.661513E+03 2.658203E+03
1.711230E+07 6.371604E+07 3.296248E+07 0.000000E+00 0.000000E+00 0.000000E+00
2.860177E+03 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
3.650234E+03 5.733261E+01 3.116205E+00 3.051307E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
STOP
6.29.2 Compositional Plot File Organization
Once, at top of file 00
Type Format Record
C*6 10A6 PLOT <FORM | BIN> 5.0.0 <simulator><simulator version> [DUAL]

C*20 2A20 <casename><case parent>
C*80 A80 <title1>
C*80 A80 <title2>
C*80 A80 <title3>
I 10I5 <# classes> <day> <month> <year> <nx> <ny> <nz> <# comps>
C*8 10A8 <class #1 name> <class #2 name> ...
I 10I5 <# variables in class #1> <# variables in class #2> ...
Loop for each class
C*4 18A4 TIME <variable #1 name> <variable #2 name> ...
end loop for class

Repeated for each requested time

Data for each class is output only if requested 00
Type Format Record
WELL Class
C*8 A8 WELL
R 5G15.5 <timestep #> <time> <# wells> <max # wells> 1
Loop for each well
C*8 8A8 <well name> <well #> 0 <1st perf i><1st perf j><gc #><fs #><area #>
R 1P6E13.6 <variable #1 value> < variable #2 value> ...
end loop for well
WLLYR Class
C*8 A8 WLLYR
R 5G15.5 <timestep #> <time> <# wells> <max # wells> <max # perfs>
Loop for each well
C*8 8A8 <well name><well #><# perfs><1st perf i><1st perf j><gc#><fs #><area #>
Loop for each perf
C*8 2A8 <perf gridblock #> <layer name>
end loop for perf
end loop for well
GATHER Class
C*8 A8 GATHER
R 5G15.5 <timestep #> <time> <# gathering centers> <max # gc’s> 1
C*8 8A8 <gc name> <gc #> 0 0 0 <gc #> <fs #> <area #>
end loop for gathering center
FLOSTA Class
C*8 A8 FLOSTA
R 5G15.5 <timestep #> <time> <# flow stations> <max # fs’s> 1
Loop for each flow station
C*8 8A8 <fs name> <fs #> 0 0 0 0 <fs #> <area #>
end loop for flow station
AREA Class
C*8 A8 AREA
R 5G15.5 <timestep #> <time> <# areas> <max # areas> 1
Loop for each area
C*8 8A8 <area name> <area #> 0 0 0 0 0 <area #>
end loop for area
REGION Class
C*8 A8 REGION

R 5G15.5 <timestep #> <time> <# regions> <max # regions> 1

Loop for each region
C*8 8A8 <region name> <region #> 0 0 0 0 0 0
end loop for region
FIELD Class
C*8 A8 FIELD
R 5G15.5 <timestep #> <time> 1 1 1
C*8 8A8 FIELD 1 0 0 0 0 0 0
NOTE: See the CPLOT card in uility data for a list of valid Class names. The
current set of variable names can be obtained from the example below.
00 Examples:
00 Cplot File - Based on "CPLOT ALL FILE"
PLOT FORM 5.0.0 EXEC v1998r

TEST
VIP TEST MODEL
7 1 1 1992 18 6 3 3
WELL WLLYR GATHER FLOSTA AREA REGION FIELD
21 14 21 21 21 21 21
TIMEQ1P Q2P Q3P C1P C2P C3P X1P X2P X3P Y1P Y2P Y3P Q1I Q2I Q3I C1I C2I
C3I QCDPYCDPCCDP
TIMEQ1P Q2P Q3P X1P X2P X3P Y1P Y2P Y3P Q1I Q2I Q3I QCDPYCDP
C3I QCDPYCDPCCDP
C3I QCDPYCDPCCDP
C3I QCDPYCDPCCDP
C3I QCDPYCDPCCDP
C3I QCDPYCDPCCDP
WELL
14.000 274.00 3.0000 20.000 1.0000
PRD 8 0 5 2 1 1 1
3.405392E+02 2.014404E+02 6.630428E+02 9.365748E+04 5.532673E+04 1.820668E+05
1.112212E-02 2.304266E-01 7.584513E-01 9.841481E-01 3.693783E-03 1.215812E-02
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00
INJ1 1 0 3 3 1 1 1
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00

0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00

0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00
INJ6 6 0 3 3 1 1 1
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
5.450015E+02 1.021878E+02 3.406259E+01 1.448249E+05 2.715467E+04 9.051556E+03
0.000000E+00 0.000000E+00 0.000000E+00
WLLYR
14.000 274.00 2.0000 20.000 100.00
INJ6 6 1 3 3 1 1 1
39 K1
0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00 0.000000E+00 5.450015E+02 1.021878E+02 3.406259E+01
0.000000E+00 0.000000E+00
PRD 8 2 5 2 1 1 1
23 K1
1.947711E+02 1.122778E+02 3.679337E+02 1.112236E-02 2.312086E-01 7.576690E-01
9.840874E-01 3.720505E-03 1.219207E-02 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00
131 K2
1.457680E+02 8.916255E+01 2.951092E+02 1.112182E-02 2.294493E-01 7.594289E-01
9.842236E-01 3.660599E-03 1.211581E-02 0.000000E+00 0.000000E+00 0.000000E+00
0.000000E+00 0.000000E+00
GATHER
14.000 274.00 1.0000 5.0000 1.0000
1 0 0 0 1 1 1
5.145818E+03 2.819694E+03 8.822700E+03 1.412639E+06 7.732170E+05 2.416716E+06
1.112383E-02 2.394468E-01 7.494294E-01 9.829879E-01 4.237121E-03 1.277496E-02
5.450015E+02 1.021878E+02 3.406259E+01 1.448249E+05 2.715467E+04 9.051556E+03
0.000000E+00 0.000000E+00 0.000000E+00
FLOSTA
14.000 274.00 1.0000 5.0000 1.0000
1 0 0 0 0 1 1
5.145818E+03 2.819694E+03 8.822700E+03 1.412639E+06 7.732170E+05 2.416716E+06
1.112383E-02 2.394468E-01 7.494294E-01 9.829879E-01 4.237121E-03 1.277496E-02

5.450015E+02 1.021878E+02 3.406259E+01 1.448249E+05 2.715467E+04 9.051556E+03

0.000000E+00 0.000000E+00 0.000000E+00
AREA
14.000 274.00 1.0000 5.0000 1.0000
1 0 0 0 0 0 1
5.145818E+03 2.819694E+03 8.822700E+03 1.412639E+06 7.732170E+05 2.416716E+06
1.112383E-02 2.394468E-01 7.494294E-01 9.829879E-01 4.237121E-03 1.277496E-02
5.450015E+02 1.021878E+02 3.406259E+01 1.448249E+05 2.715467E+04 9.051556E+03
0.000000E+00 0.000000E+00 0.000000E+00
REGION
14.000 274.00 1.0000 1.0000 1.0000
1 0 0 0 0 0 0
5.145818E+03 2.819694E+03 8.822700E+03 9.051556E+03 0.000000E+00 0.000000E+00
1.112475E-02 2.394976E-01 7.493776E-01 9.834299E-01 4.013149E-03 1.255697E-02
5.450015E+02 1.021878E+02 3.406259E+01 1.448249E+05 2.715467E+04 9.051556E+03
0.000000E+00 0.000000E+00 0.000000E+00
FIELD
14.000 274.00 1.0000 1.0000 1.0000
FIELD 1 0 0 0 0 0 0
5.145818E+03 2.819694E+03 8.822700E+03 1.412639E+06 7.732170E+05 2.416716E+06
1.112383E-02 2.394468E-01 7.494294E-01 9.829879E-01 4.237121E-03 1.277496E-02
5.450015E+02 1.021878E+02 3.406259E+01 1.448249E+05 2.715467E+04 9.051556E+03
0.000000E+00 0.000000E+00 0.000000E+00
STOP
6.29.3 Map File Organization
VIP-CORE 00
Type Format Record
C*6 10A6 MAP <FORM | BIN> 1.0.1 <simulator><simulator version> [DUAL]

C*80 A80 <title1>
C*80 A80 <title2>
C*80 A80 <title3>
I 8I5 2 <day><month><year><nx><ny><nz><# comps>
R G15.5 <inner radius for radial model; 0. otherwise>
C*8 2A8 INIT RECURR
I 2I5 <# of INIT arrays> <# of RECURR arrays>
C*4 18A4 <INIT array #1 name><INIT array #2 name> ...
C*4 18A4 <RECURR array #1 name><RECURR array #2 name> ...
C*8 10A8 <component #1 name> <component #2 name> ...
C*8 A8 INIT
R 3G15.5 0 0.0 <# of INIT arrays>
Loop for each INIT array
R 1P6E13.6 <array value i> , i = 1, ..., number of gridblocks
end loop for INIT array
C*8 A8 STOP

Simulation Modules - Repeated for each requested time 00
Type Format Record
C*8 A8 RECURR
R 3G15.5 <timestep #><time><# of RECURR arrays>
Loop for each RECURR array
R 1P6E13.6 <array value i>, i = 1, ..., number of gridblocks
end loop for RECURR array
C*8 A8 WLOC
R 3G15.5 <timestep #><time><number of perforations>
Loop for each perforation
I 3I5 <well number><perforation status><gridblock number>
end loop for perforation
NOTE: Perforation Status values are as follows

0Shut in
1Gas Injector
2Water Injector
3Solvent Injector
4Producer
00 Examples:
00 CORE Map File Format -Based on "MAPOLD P SG SW FORM"
MAP FORM 1.0.1 CORE v1998r

VIP TEST MODEL
2 1 1 1992 18 6 3 3
.00000E+00
INIT RECURR
54 3
DX DY DZ DEP DZN POR KX KY KZ ISATIPVTIEQUTMX TMY TMZ ?FX ?FY DXB
DYB DZB DZBNMDEPPVR TXR TYR TZR MLTXMLTYMLTZP SG SW SWM PSATSO SOM
PDATX1 Y1 Z1 X2 Y2 Z2 X3 Y3 Z3 PV TX TY TZ API KH GOC WOC
P SG SW
LIGHT HEAVY1 HEAVY2
INIT
.00000E+00 .00000E+00 54.000
6.220000E+02 6.220000E+02 6.220000E+02 6.220000E+02 6.220000E+02
6.220000E+02
.....
.....
STOP

00 EXEC Map File Format - Based on "MAPOLD P SG SW FORM"
RECURR
.00000E+00 .00000E+00 3.0000
2.952821E+03 2.952821E+03 2.952821E+03 2.953362E+03 2.953904E+03 2.953904E+03
2.951562E+03 2.940778E+03 2.933616E+03 2.926477E+03 2.924697E+03 2.922384E+03
.....
.....
WLOC
.00000E+00 .00000E+00 .00000E+00
RECURR
14.000 274.00 3.0000
2.760746E+03 2.757746E+03 2.762810E+03 2.761857E+03 2.756173E+03 2.758267E+03
2.753419E+03 2.737406E+03 2.730219E+03 2.720897E+03 2.715025E+03 2.713665E+03
.....
.....
WLOC
14.000 274.00 4.0000
8 4 23
8 4 131
1 2 255
6 1 39
STOP

6.29.4 Hydrocarbon Track File Organization

00 The hydrocarbon track file is written by the simulation modules. Information in a
track file is organized in the form of records. There are three types of records: the
header record, the production time record, and the in-place time record. The
frequency of output of these records is controlled through use of the WTRACK
card.
Header Record - Written only once at time = 0. 00
Type Format Record
I 4I10 <# tracked fluids> <max # wells> <max # gc’s> <# comps>
C*80 A80 <title1> <title2> <title3>
C*6 10A6 <tracked fluid #1 name> <tracked fluid #2 name> ...
I 3I5 <day> <month> <year>
R*8,I F12.3,I10 0.0 <number of gridblocks>
R*8 8E15.7 <flag array value i>, i = 1, ..., number of gridblocks
R*8 8E15.7 <initial gas saturation value i>, i = 1, ..., number of gridblocks
In-Place Time Record - Repeated for each requested time 00
Type Format Record
C*8 A8 IN PLACE
R*8,I F12.3,I10 <time> <number of gridblocks>
Loop for each gridblock
C*6,I A6,I5 BLOCK <gridblock number>
Loop for each tracked fluid
R*8 8E15.7 <tracked gas mole fraction value i>, i = 1, ..., # components
End loop for tracked fluid
R*8 8E15.7 <gas mole fraction value i>, i = 1, ..., # components
R*8 8E15.7 <tracked total mole fraction value i>, i = 1, ..., # components
R*8 8E15.7 <total mole fraction value i>, i = 1, ..., # components
End loop for gridblock
R*8 8E15.7 <gas saturation value i>, i = 1, ..., number of gridblocks

Well Production Time Record - Repeat for each requested time Output
if NOWELL has not been specified with TRACK card. 00
Type Format Record
C*8 A8 WELLS
R*8,I F12.3,I10 <time> <# wells>
Loop for each well
C*4,I A4,I5 WELL <well #>
End loop for well
Production Time Record - Repeated for each requested time 00
Type Format Record
C*8 A8 GATHER
R*8,I F12.3,I10 <time> <# gc’s>
C*4,I A4,I5 GC <gc #>
End loop for gathering center


Chapter
7
Simulator Control
00000
7.1 Timestep Control

00 VIP-EXECUTIVE moves the reservoir model through a succession of timesteps.
The interval of time between states is called the “timestep.” Within each timestep
the simulator performs “outer iterations,” that is, Newton iterations, to resolve the
non-linear changes in pressures and saturations which may occur over the
timestep. In most cases “inner iterations” are performed within each outer
iteration to iteratively solve the linearized system of equations for the changes in
reservoir variables between successive Newton steps. (If the direct linear solver is
used, then no inner iterations are required.)
00 VIP-EXECUTIVE can select its own timesteps. They are constrained only by (1)
the maximum changes in reservoir variables specified on the DT card, or (2) by
gridblock throughput limitations when the IMPES formulation is used (see
IMPSTAB card). Timestep size is altered automatically to hit exactly the times or
dates on TIME or DATE cards. Under automatic timestep control maximum
pressure, saturations, vapor fraction, and total composition changes sometimes are
exceeded slightly to save the work required to repeat the timestep.
00 The number of outer iterations (Newton steps) performed during a timestep is

governed by the ITNLIM, TOLD, and TOLR cards. The TOLD and TOLR cards
establish two sets of criteria for convergence of a timestep. The TOLD card
specifies one set of convergence criteria based on the maximum changes in the
primary unknowns over the last Newton step. Convergence of the outer iterations
over a timestep is achieved when none of the changes in ΔP, ΔS, (ΔSw), ΔV (ΔSg),
or ΔZ which occurred during the previous iteration are larger in absolute value
than the corresponding tolerances established on the TOLD card. A second set of
tests for convergence is defined by the TOLR cards. When the material balance
error for each phase in each gridblock is less than the tolerances specified on the
TOLR card, the conservation equations are assumed to have been solved and the
timestep is concluded. The TOLD tests are independent of the TOLR tests. Either
set of convergence tests can signal convergence of the timestep even if the other
has not yet been satisfied. The ITNLIM card specifies the minimum and
maximum number of outer iterations to be used for a timestep, as well as
bounding limits for the maximum changes in the primary unknowns for any
Newton step. Should any of these limits be exceeded, VIP-EXECUTIVE will
damp the entire solution vector, such that the reduced changes now honor the
R5000.0.1 Simulator Control 7-427

maximum changes specified on the DT card, and then perform another outer
iteration. For this reason, an excessively small value for any of the iteration limits
slows or even prevents convergence. Failure to converge the outer iterations of a
timestep within itnmax outer iterations will normally cause the timestep to be
repeated. A timestep will also be repeated if the tolerances on the DT card are
exceeded, if the maximum changes are being checked (see the optional second
line following the DT card below).
7.1.1 Timestep Controls (DT)

00 The DT card defines the timestep size and the maximum changes allowed during
the timestep.
DT dt dtmin dtmax dpmax (dtmpmx) dsmax dvmax dzmax (dtswmx)(card 1)
BOTH ⎛ BOTH ⎞ BOTH BOTH BOTH ⎛ BOTH ⎞

DTONLY
⎜ MAXONLY
DTONLY
⎟ DTONLY DTONLY DTONLY
⎜ MAXONLY
DTONLY
⎟
MAXONLY
NONE p
⎝ NONE T⎠ MAXONLY
NONE
MAXONLY MAXONLY
NONE v NONE z
⎝ NONE ⎠
s t
(card 2)
00 Definitions:
dt Timestep size, days. A negative value triggers the use of

automatic timestep control. Here, the next timestep is +dt
in length; thereafter, the program chooses timestep size
within user constraints. Omit the remaining variables on
this card if dt is positive.
dtmin Minimum timestep size, days. Default is 1 day.
dtmax Maximum timestep size, days. Default is 100 days.
dpmax Maximum pressure change allowed during a time-step,

psia (kPa). Default is 300 psia for the IMPES
formulation; 500 psia for the implicit formulation.
dtmpmx Maximum temperature change allowed during a

timestep, °F(°C). Default is 100°F. Enter only in VIP-
THERM.
dsmax Maximum saturation change allowed during a timestep

using the IMPES formulation. Maximum change in water
saturation allowed during a timestep using the implicit
formulation. Default is 0.03 for the IMPES formulation;
0.1 for the implicit formulation.
dvmax Maximum change in vapor fraction allowed during a

timestep using the IMPES formulation. Maximum
7-428 Simulator Control R5000.0.1

change in gas saturation allowed during a timestep using

the implicit formulation. Default is 0.04 for the IMPES
formulation; 0.1 for the implicit formulation.
dzmax Maximum change in total mole fraction allowed during a

timestep. Default is 0.03 for the IMPES formulation; 0.1
for the implicit formulation.
dtswmx Maximum tracked water saturation change allowed

during a timestep. Default is 0.1.
BOTH Alpha label indicating that the appropriate maximum will

be used for both checking the maximum change over the
timestep and timestep size calculation. This is the default
for a problem using the IMPES formulation.
DTONLY Alpha label indicating that the appropriate maximum will

be used for timestep size calculation only. The maximum
change check will be ignored. This is the default for a
problem using the implicit formulation.
MAXONLY Alpha label indicating that the appropriate maximum will

be used for checking the maximum change over the
timestep only. The timestep size calculation will ignore
this constraint.
NONE Alpha label indicating that the appropriate maximum will

be ignored completely.
NOTE: 1. The DT card may contain dt only, all values through dpmax, all
values through dzmax, or all values. No other combinations are
allowed.
2. A value of zero may be input for dt. At time = 0, this causes the first
timestep to be of size dtmin and subsequent timestep sizes to be
under automatic timestep control. At time > 0, the timestep size
calculation remains under automatic timestep control, allowing the
user to change the other parameters without having to set the timestep
size.
3. Timestep size is altered automatically to coincide exactly to the times

or dates specified on TIME and DATE cards, even when fixed
timesteps are used.
4. Under automatic timestep control the maximum pressure, saturation,

vapor fraction (gas saturation) and composition changes specified on
the DT card are sometimes exceeded by a small amount to save the
work required to repeat the timestep. If they are exceeded by a large
amount (MAXOVR card), the timestep will be repeated. The
maximum number of timesteps cuts is three by default, but it may be
respecified using the TCUT card.

5. Card 2 is an optional card that allows the user to control when the
maximum constraints will be used. The data is order dependent; e.g.,
if an alpha is needed for dvmax, then one must also be specified for
dpmax and dsmax.
6. The optional last parameter can be specified to enable timestep

control as a function of the maximum changes in the saturation of any
of the tracked water types. This parameter will be used in the timestep
size calculation only, and will not result in a timestep cut-back if its
value is exceeded during a timestep.
7.1.2 Timestep Size After Rate Changes (DTQMAX)

00 The DTQMAX card defines the timestep size to use for the first timestep
following well rate changes (QMAX/QMULT cards).
DTQMAX dtqmax
00 Definition:
dtqmax Timestep size to be used for the first timestep following

the input of rate changes (QMAX/QMULT cards), days.
NOTE: 1. The value of dtqmax will apply only if automatic timestep control is
on.
2. If no dtqmax value is input, or if a value less than or equal to 0 is

specified, automatic timestep size selection will be used.
3. If a DT card is entered at the same time as rate changes, the value of

dt on that card will be honored.

7.1.3 Outer Iteration Controls (ITNLIM)
ITNLIM itnmin itnmax (dplim) (dtlim) (dswlim) (dvlim) (dzlim)
00 Definitions:
itnmin Minimum number of outer iterations per timestep

required before convergence is allowed. Default is 1.
itnmax Maximum number of outer iterations per timestep.

Failure to converge will normally cause the timestep to
be repeated. Default is 10.
dplim Maximum pressure change allowed during any single

outer iteration, psia (kPa). Default is 450 psia for the
IMPES formulation; 750 psia for the implicit
formulation.
dtlim Maximum temperature change allowed during any single

outer iteration, °F(°C). Default is 150°F. Enter only in
VIP-THERM.
dswlim Maximum change in water saturation allowed during any

single outer iteration. Default is 0.045 for the IMPES
dvlim Maximum change in vapor fraction allowed during any

single outer iteration using the IMPES formulation.
Maximum change in gas saturation allowed during any
single outer iteration using the implicit formulation.
Default is 0.06 for the IMPES formulation; 0.15 for the
implicit formulation.
dzlim Maximum change in total composition allowed during

any single outer iteration using the IMPES formulation.
Maximum change in primary phase composition allowed
during any single outer iteration using the implicit
formulation. Default is 0.045 for the IMPES
NOTE: For each of the maximum changes on this card, if the value is not entered
but the corresponding maximum change is entered on the DT card, then
the default value is set to the product of the value on the DT card and
MAXOVR (MAXOVR card).

7.1.4 Control Convergence Failures and Timestep Cuts (TCUT)

00 The TCUT card is used to control simulator treatment of convergence failures and
timestep cuts.
nfails
TCUT ( nctol )
OFF
00 Definitions:
nfails Maximum number of convergence failures permitted

during a single timestep. Default is 3.
OFF Alpha label that causes the simulator to ignore

convergence failures.
nctol Maximum number of timestep cuts for any reason

permitted during a single timestep. Default is 3.
NOTE: 1. After each convergence failure the timestep size is cut by a factor of 2
and the timestep is retried, if OFF was not specified.
2. After nctol-1 timestep cuts in a single timestep, the timestep size is

set equal to dtmin (see DT card).
3. If a convergence failure occurs for a timestep size of dtmin, an

additional attempt is made using a timestep size of 0.1*dtmin.
4. If more than nfails convergence failures (or possibly nfails+1; see

note 3) or more than nctol timestep cuts occur during a single
timestep, the run is terminated and a restart record is written at the end
of the last successful timestep.
5. The keyword OFF causes the simulator to ignore convergence failures

in determining the acceptability of a timestep. The result of the
timestep will be accepted (subject to the tolerances on the DT card)
without regard to the inadequate closure of the material balance
equations. This will frequently lead to poor material balances in the
model.
6. If it was not already printed, an iteration summary will be printed for

a timestep that has a convergence failure unless the CNVFLOFF
keyword has been specified on the OUTPUT card.
00 Example:
00 TCUT 10 10

7.1.5 Control Treatment of IMPES Stability (IMPSTAB)

00 The IMPSTAB card is used to control simulator treatment of IMPES stability
restrictions. By default, the simulator calculates the maximum timestep size for
which IMPES is a stable formulation (based on volumetric and molar throughput)
and forces the timestep to be no larger than this value.
ststar
IMPSTAB (V98)
( stslim ) ( mxstsc ) ( FLOWIN )
OFF
( NOCUTS )
ON
00 Definitions:
V98 Alpha label that causes the version 98 algorithm to be

used.
ststar Fraction of the maximum stable IMPES timestep to use

as the target for each calculation of timestep size. Default
is .9.
OFF Alpha label that causes the simulator to ignore IMPES

stability restrictions.
ON Alpha label that causes the simulator to take IMPES

stability restrictions into account using the most recent
values of ststar, stslim, and mxstsc.
stslim Largest fraction of the maximum stable IMPES timestep

at which the simulator is permitted to run. Default is 1.0.
NOCUTS Alpha label that causes the simulator to ignore violations

of the stslim limit.
mxstsc Maximum number of timestep reductions due to

violation of the stslim limit on a single timestep. Default
is 3.
FLOWIN Alpha label indicating that flow both into and out of
blocks is to be checked for stability. Default is to only
check the flow out of blocks.

NOTE: 1. Unless OFF is specified, for each timestep the timestep size will be
set equal to ststar times the maximum stable IMPES timestep,
provided that this timestep would satisfy the constraints imposed by
the DT card.
2. Unless OFF or NOCUTS is specified, the simulator will enforce the

stslim limit. If the chosen timestep exceeds stslim times the
maximum stable IMPES timestep, it is immediately reduced to the
target value. This reduction is not counted as a timestep cut.
3. After mxstsc-1 timestep reductions on a single timestep, the timestep

size is set equal to dtmin (see DT card).
4. If more than mxstsc reductions are required on a single timestep due

to the stslim limit, the run is terminated and a restart record is written
at the end of the last successful timestep.
5. The maximum stable IMPES timestep is constrained by the total

volumetric throughput (based on a Buckley-Leverett-type analysis)
and by the possible composition changes for each phase in each
gridblock. Complete details are available in a separate document.
Inactive blocks are ignored.
6. The parameters are order-dependent and must be specified if

subsequent parameters are input.
7.1.6 Maximum Variable Change Overshoot (MAXOVR)

00 The MAXOVR card is used to control when a timestep cut occurs due to
maximum variable changes over a timestep. If any variable changes relative to its
maximum allowed (from the DT card) more than the factor specified on this card,
a timestep cut will occur. Does not aply to VIP-THERM.
MAXOVR maxovr
00 Definition:
maxovr Maximum variable change factor above which a timestep

cut will occur. Default is 1.5.

7.1.7 Convergence Tolerance on Unknowns (TOLD)
TOLD tolp (tolt) tols tolv tolz
00 Definitions:
tolp Convergence tolerance used to test the pressure changes

occurring in each gridblock during each Newton (outer)
iteration, psia (kPa). Default is 0.1 psia.
tolt Convergence tolerance used to test the changes in

temperature occurring in each gridblock during each
outer iteration, °F(°C). Default is 100°F. Enter only in
VIP-THERM.
tols Convergence tolerance used to test the changes in water

saturation occurring in each gridblock during each outer
iteration. Default is 0.0001.
tolv Convergence tolerance used to test the changes in vapor

fraction (IMPES) or gas saturation (implicit) occurring in
each gridblock during each outer iteration. Default is
0.0001.
tolz Convergence tolerance used to test the changes in total

composition (IMPES) or primary phase composition
(implicit) occurring in each gridblock during each outer
iteration. Default is 0.0001.
NOTE: 1. Convergence is achieved when none of the pressure, saturation, vapor

fraction (gas saturation), or composition changes occurring over the
previous iteration are larger in absolute value than the corresponding
tolerances.
2. The TOLD tests are independent of the TOLR tests. If either set of
convergence tests is satisfied no further outer iterations are performed
and the timestep is concluded.
3. A negative value for a tolerance causes that variable to be ignored in

the convergence check.
4. A zero value for any of the tolerances forces non-convergence based

on maximum changes.

7.1.8 Convergence Tolerance on Residuals (TOLR)

00 The TOLR card is used to define a set of convergence tolerances based on how
well the conservation equations are resolved. Separate tolerances are specified for
the water material balance equation and for the sum of the hydrocarbon material
balance equations, and they can be in terms of relative reduction or absolute
values. For the relative reductions, the values are relative to the largest residuals
encountered during the first itnmax/2 outer iterations, which is normally the
residuals at the start of the first iteration. If relative reductions are being used and
the maximum residual is less than 1E-4, the relative reduction for that constituent
will not be required.
TOLR tolrw tolhc (tole)

( ABSTOL ) ( ABSRES ) (SUM) (MAX)
( RELTOL ) ( RELRES )
00 Definitions:
tolrw Convergence tolerance used to test the water "residual".

This tolerance measures how well the water material
balance equation for each gridblock has been solved.
Default is 0.001.
tolhc Convergence tolerance used to test the hydrocarbon

"residual". This tolerance measures how well the
hydrocarbon material balance equations for each
gridblock have been solved. Default is 0.001.
tole Convergence tolerance used to test the energy balance

“residual.” This tolerance measures how well the energy
balance equations for each gridblock have been solved.
Default is 0.001. Enter only in VIP-THERM.
ABSTOL Alpha label indicating that the water and hydrocarbon

residuals are to be checked directly against tolrw and
tolhc, respectively. This is the default in VIP-COMP or
VIP-ENCORE if the TOLR card is input but neither
ABSTOL nor RELTOL are specified.
RELTOL Alpha label indicating that the water and hydrocarbon

residuals must be decreased from the values at the
beginning of the timestep by at least the factors tolrw and
tolhc, respectively. This is the default in VIP-THERM,
and this is the default in VIP-COMP or VIP-ENCORE if
no TOLR card is input.
ABSRES Alpha label indicating that the residuals to be checked are

calculated simply as the maximum residuals over all
gridblocks. This is the default.

RELRES Alpha label indicating that the residuals to be checked are

calculated as the maximum over all gridblocks of the
water residual divided by the water volume (tolrw), the
hydrocarbon residual divided by the number of
hydrocarbon moles (tolhc), and, in VIP-THERM, the
energy residual divided by the total energy (tole).
SUM Alpha label indicating that convergence is to be achieved

if the sum over all gridblocks of the water, hydrocarbon,
and energy residuals (absolute) are reduced below the
tolerances as defined by the ABSTOL/RELTOL settings.
This is the default in VIP-THERM.
MAX Alpha label, valid only in VIP-THERM, indicating that

only the maximum residuals over all gridblocks are to be
checked, as is the default in VIP-COMP and VIP-
ENCORE.
NOTE: 1. When the residual error in each material balance equation in each
gridblock (or over all gridblocks, for the SUM option) satisfies the
appropriate tolerance, the equations are assumed to have been solved
and the timestep is concluded.
2. The TOLR tests are independent of the TOLD tests. If either set of
convergence tests is satisfied, no further outer iterations are
performed and the timestep is concluded.
3. For the combination of ABSTOL and ABSRES, the units of tolrw

and tolhc are STB/D (STM3/D) and lb-moles/D (lb-moles/D),
respectively. In VIP-THERM, the unit of tole is Btu/D (kj/D).
4. For fluid tracking cases, the recommended tolerance type is ABSTOL

RELRES.
7.1.9 Saturation Convergence Tolerance for OPTMBL and VOLBAL (TOLSCN)
TOLSCN errsat
00 Definition:
errsat Convergence tolerance used to test the saturation

constraint equation. Default is 0.005.
NOTE: When using the OPTMBL option or the VOLBAL option, errsat is used
to test for convergence of the saturation constraint equation.

7.1.10 Well Convergence Tolerance for OPTMBL and VOLBAL (TOLWCN)
TOLWCN errwel
00 Definition:
errwel Convergence tolerance used to test the well constraint

equation. Default is 0.00001 for OPTMBL and 0.01 for
VOLBAL.
NOTE: When using the OPTMBL option or the VOLBAL option, errwel is used
to test for convergence of the well constraint equation.
7.1.11 Maximum Allowable Material Balance Error (ABORT)

00 The ABORT card defines the maximum allowable material balance error. When
this is reached, the program automatically terminates. This automatic termination
control is activated only by data entry.
ABORT ew ehc ee
00 Definitions:
ew Maximum allowed water material balance error before

the program terminates.
ehc Maximum allowed hydrocarbon material balance error

before the program terminates.
ee Maximum allowed energy balance error before the

program terminates. Enter only in VIP-THERM.
NOTE: 1. Both values ew and ehc must be included on the card in the above
order. A zero entry is ignored. An ee value is also required for VIP-
THERM.
2. The program compares the normalized cumulative balance error to

these constraints at the end of each timestep.
00 Example:
00 ABORT 0.001 0.001

7.1.12 Minimum BHP Damping Factor (CBHPMN)

00 The CBHPMN card is used to set the minimum BHP damping factor. A value of
1.0 will cause the CHKBHP subroutine to be ignored. Allowed values are 0 ≤
cbhpmn ≤ 1.0.
CBHPMN cbhpmn
00 Definitions
cbhpmn Minimum BHP damping factor. Default is 0.05.
7.1.13 Table Extrapolation Control (CHKTAB)
PVT
CHKTAB BHP (nex)

ALL
NONE
00 Definitions:
PVT Alpha label that allows the simulator to extrapolate the

PVT/K-value table during look-ups.
BHP Alpha label that allows the simulator to extrapolate the

production and injection BHP tables during look-ups.
ALL Alpha label that allows the simulator to extrapolate both

the PVT/K-value and BHP tables during look-ups. This
is the default.
NONE Alpha label that causes the simulator to stop rather than
extrapolate outside the table boundaries.
nex Number of table extrapolations allowed before run is

terminated. Default is 0.
00 The CHKTAB card is used to control the action taken when table look-ups require
extrapolation outside the range of the defined data. This is generally not
encouraged and can lead to convergence problems. By default, extrapolation
warning messages are printed in the output file, along with the offending values. If
the NONE option is specified then the model will write a restart record at the end
of the last acceptable timestep and the run will be terminated. The PVT, BHP and
ALL options will write warning messages until nex extrapolations have been

performed, then the run will be terminated (as above). A value of zero for nex will
suppress run termination. Tables checked for extrapolation include the black-oil
PVT/K-value tables (end of timestep only) and the wellbore hydraulics (BHPTAB
tables and BHITAB tables (every occurrence)).
7.1.14 Timestep Size Factors (MXDTCF, MXDTFC, DTCUTF)
MXDTCF mxdtcf
MXDTFC mxdtfc
DTCUTF dtcutf
00 Definitions:
mxdtcf Maximum timestep size increase factor after a successful

timestep. Default is 5.0.
mxdtfc Maximum timestep size increase factor after timestep

had to be cut due to a convergence failure. Default is
1.25.
dtcutf Timestep size cutback factor following a convergence

failure. Default is 0.5.

7.2 Matrix Solution Options

00 For each outer iteration, VIP-EXECUTIVE must solve one or more large linear
systems of equations. This step is usually the most expensive activity performed
during an outer iteration. The choice of matrix solver can have a very large impact
on the overall cost of the simulation. VIP-EXECUTIVE offers both direct and
iterative matrix solvers for this task.
00 Direct Solver
GAUSS Gaussian elimination with the D4 ordering of unknowns.
00 Iterative Solvers
BLITZ Preconditioned Generalized Minimum Residual Method

(Reference 5).
EXCEL Generalized Incomplete Factorization Preconditioning.
00 A matrix solver should probably be specified at the beginning of every simulation

run, but it may be defaulted. At time = 0, the default is BLITZ for single grid runs
and CBLITZ (see Section 13.5 for these parameters) for multigrid runs. At time >
0 the matrix solver choice and parameters are retrieved from the restart file.
00 EXCEL and BLITZ are available for both the IMPES and fully implicit
formulation options. With certain restrictions, BLITZ and EXCEL can be invoked
for reservoir models that use either the FAULT option or the PINCHOUT option.
Each of these options generates nonstandard connections between gridblocks.
00 A connection is standard when a gridblock, identified by the coordinates (i, j, k),

connects to an adjoining gridblock with coordinates of one of the forms:
00 (i-1, j, k)
(i+1, j, k)
(i, j-1, k)
(i, j+1, k)
(i, j, k-1)
(i, j, k+1)
00 A nonstandard connection is called logically vertical when the connection exists

between gridblock (i, j, k) and one of the gridblocks:
00 (i-1, j, *)
(i+1, j, *)
(i, j-1, *)
(i, j+1, *)
00 where * denotes any value less than or equal to NZ other than k. A nonstandard

connection to any other gridblock is called logically nonvertical.
7.2.1 Gaussian Elimination (GAUSS)

00 Invokes Gaussian elimination.
GAUSS
NOTE: 1. Use of Gaussian elimination maximizes the probability of successful

convergence, but it also tends to increase computer time and storage
requirements.
2. This option does not allow for faults.
7.2.2 Iterative Solver (EXCEL)

00 EXCEL is an iterative solver, available for both the IMPES and fully implicit
options. It will handle all types of nonstandard connections, including logically
nonvertical ones. For an explanation of this method, see Reference 4.
EXCEL
( ITER ) (ilu) (north) (rtol) (nit)
( NOITER )
00 Definitions:
ITER Alpha label indicating that an EXCEL iteration summary

should be printed.
NOITER Alpha label indicating that an EXCEL iteration summary

should not be printed. This is the default.
ilu Incomplete factorization level in EXCEL. Default is 0.
north Number of orthogonalizations used in EXCEL.

Minimum value is 4, maximum value is 20. Default is 10.
rtol Tolerance for convergence of EXCEL. Default is 0.001.
nit Maximum number of iterations allowed in EXCEL.

Minimum value is 5. Default is 25.
NOTE: The ITER/NOITER label is optional and may be omitted. The other
parameters are order-dependent and must be specified if subsequent
parameters are input.

7.2.3 Iterative Solver (BLITZ)

00 BLITZ is an iterative solver, available for both the fully implicit and IMPES
options. For an explanation of this method, see Reference 5.
BLITZ param1 . . . paramn (card 1)

value1 . . . valuen (card 2)
00 Definitions:
ITER A BLITZ iteration summary should be printed. No entry

should be made on card 2 corresponding to this entry.
NOITER A BLITZ iteration summary should not be printed. This

is the default. No entry should be made on card 2
corresponding to this entry.
NORTH Maximum number of orthogonalizations for the

generalized conjugate residual method in BLITZ. Default
is 10.
RTOL Norm (EUCLIDEAN) residual reduction ratio

convergence criterion in BLITZ. Default is .005.
NIT Maximum number of iterations allowed in BLITZ.

Default is 20.
JLUN Preconditioning option in BLITZ for multi-variable

equations (IMPLICIT):
0 = Reduced system/diagonal scaling.

1 = Reduced system/ILU(0).
2 = Line Gauss-Seidel.
3 = Modified Nested Factorization, Option 1.
4 = Diagonal scaling.
5 = MVP default, Option 1.
6 = MVP, Option 2
Default is 1 without faults and 2 with faults.
JLU1 Preconditioning option in BLITZ for single-variable

equations (IMPES or CPR):
-1 = D4 Gauss (direct solution).

0 = Reduced system/diagonal scaling.
1 = Reduced system/ILU(0).
2 = Line Gauss-Seidel.

6 = MVP, Options .
7 = MVP, Option 2.
If the reservoir model does not have faults, default is 1

for IMPES and 3-D constrained pressure residual
problems and is -1 for 2-D constrained pressure residual
problems. With faults, the default is 3.
PTOL Residual norm reduction ratio convergence criterion for

pressure solution (for implicit formulation with jcor=1).
Default is .005.
JCOR Constraint option associated with the pressure solution

(available with implicit formulation only if jcpr=1;
always available with IMPES formulation):
0 = no constraints.
1 = use line constraints.
Default is 1.
JCPR Constrained pressure residual method option (implicit

formulation only):
0 = no pressure predictor step.

1 = use pressure predictor step.
Default is 1.
JOPTN Ordering option for line constraints for multi-variable

equations (IMPLICIT):
0 = Automatic determination.
3-D Problems:
1 = XYZ 3 = XZY 5 = YZX
2 = YXZ 4 = ZXY 6 = ZYX
2-D Problems:
1 = XY or XZ
2 = YX or ZX
Default is 0 for unfaulted problems. With faults, default

is 2 for 2-D problems, 6 for 3-D problems with
NY < NX, and 4 otherwise.

JOPT1 Ordering option for line constraints for single-variable

equations (IMPES or CPR):
0 = Automatic
3-D Problems:
1 = XYZ 3 = XZY 5 = YZX
2 = YXZ 4 = ZXY 6 = ZYX
2-D Problems:
1 = XY or XZ
2 = YX or ZX
Defaults are the same as joptn.
JGAUS Solution method for line constraints when jcor=1:
0 = Iterative solution
1 = Direct solution
Default is 0 for 3-D problems. Must be 1 for 2-D
problems.
ADJTOL Turns on the adjustable linear tolerance algorithm with

default values for TOLMN, TOLMX, TOLST and
TOLEX. No entry should be made on card 2
TOLMN Turns on the adjustable linear tolerance algorithm and

specifies the minimum value of linear tolerance to be
used throughout the simulation. Default is RTOL so that,
if RTOL is defaulted, then TOLMN defaults to 5.E-03
but, if RTOL is specified, then TOLMN is set to the
specified RTOL value. TOLMN must range between 0.0
and 1.0.
TOLMX Turns on the adjustable linear tolerance algorithm and

specifies the maximum value of linear tolerance to be
used throughout the simulation. Default is 0.5. TOLMX
must range between 0.0 and 1.0.
TOLST Turns on the adjustable linear tolerance algorithm and

specifies the value of linear tolerance to be used in the
first Newton step of each timestep. Default is
max(TOLMX, 5 * RTOL). TOLST must be less than
TOLMX and greater than or equal to 0.0.
TOLEX Turns on the adjustable linear tolerance algorithm and

specifies the value of the exponent in the power law used
to control the reduction of the linear solver tolerance as
the Newton iteration nears convergence. Default is 3.0.
TOLEX must be nonnegative.

NOTE: A less storage intensive algorithm may be requested by specifying a

negative value for NORTH. For example, to specify six orthogonalizations
with this algorithm, use NORTH=-6. This algorithm will cause an
increased amount of execution time, approximately equal to an extra
iteration.
00 Examples
00 BLITZ ITER
00 BLITZ ITER NIT TOLST JLUN

15 0.3 3
00 BLITZ ADJTOL PTOL RTOL
00 1.E-5 1.E-4
7.2.4 Bad Solution Indicator (SLVCUT)

00 The SLVCUT card is used to activate the option to have the solver return a bad
solution indicator when convergence seems to be failing or very slow. In this
case, a convergence failure is assumed and the timestep will be repeated,
potentially saving a large number of iterations.
SLVCUT ON (itn)
O FF
00 Definitions:
ON Alpha label indicating that the timestep will be repeated

when the solver returns a bad solution indicator after
Newton iteration itn. This is the default if the card is
entered without specifying ON or OFF.
OFF Alpha label indicating that the option is off. This is the
default if the SLVCUT card is not entered.
itn Newton iteration after which the bad solution indicator

would be returned. Default is 1.

7.3 Implicit Well Options
7.3.1 Implicit Well Calculations in IMPES Grids (IMPWEL)

00 The IMPWEL card is used to specify the level of implicitness in the well rate
equations to be used for wells within IMPES grids. The default is OFF, which
uses the standard IMPES formulation for the wells, with the rates implicit in
pressure, only. If the feature is set to ON, the well rate equations will be implicit
in saturations, also. This requires additional work in reducing the possible well
constraint equations, but in most cases, it will result in larger, stable timestep sizes
for runs involving IMPES grids.
IMPWEL ON
O FF
00 Definitions:
ON Alpha label indicating that well constraint equations are

to be set up and that these equations are to be implicit in
both pressure and relative permeabilities.
OFF Alpha label indicating that well constraint equations are

to be set up and that these equations are to be implicit in
pressure only. This is the default.
NOTE: 1. The implicit well option may not be used with the following options:
Ž VE
Ž CO2 in water
2. If IMPWEL is used in conjunction with OPTMBL and if any FRES or

FSTD reinjection wells are active, it is recommended to also set
ITNSTQ to 1 iteration, in order to reduce the number of outer
iterations that might result when the production rates are updated.
The well convergence tolerance, TOLWCN, applies to both
production and injection wells

7.4 Automatic Parameter Settings (FASTSIM)

00 The FASTSIM card is used to activate a number of parameter settings, regardless
of what has been introduced before it. For additional tuning, the user can then
reintroduce parameter settings, following the FASTSIM data line, to override
the defaulted settings.
00 The data lines listed below are actually entered into the edited data stream, so they
will appear on the echo print of the data. However, the data listed are the FIELD
units equivalents. If the run is being made in METRIC or LAB units, the
necessary conversions are made accordingly, and the echo print will reflect the
proper specified operating units.
00 FASTSIM is coded such that it will work regardless of formulation (IMPES,

IMPLICIT, or mixed).
FASTSIM
00 The following data lines are inserted into the data deck:
00 DT -1.0 1.0 183.0 1000.0 0.05 0.05 0.05

BOTH BOTH NONE BOTH
DTMPL 1000.0 0.20 0.20 0.20
BOTH BOTH NONE BOTH
ITNLIM 1 10 1500.0 0.25 0.50 0.25
ITNMPL 1500.0 0.50 0.99 0.50
MAXOVR 2.0
TOLR 0.001 0.001 RELTOL SUM
TOLD 1.0 0.01 0.01 0.01
TOLWCN 0.001
TOLSCN 0.005
ITNSTP 3
ITNSTQ 3
ITNGRE 3
ITNTHP 3
IMPTHP ON
IMPSTAB 1.1 1.3
DTQMAX 5.0
00 In addition, the solver defaults, depending on the grid system, as well as a number
of solver parameters (some are BLITZ (Section 7.2.3), some CBLITZ (Section
13.5), some both):
00 NIT = 50
NORTH = 49
JLUN =4
JLU1 =3
JCOR =1
JOPT1 =6

JOPTN =6
NBEPS =0
JCPR =1
RTOL = 0.001
PTOL = 0.001
Solver iteration summary turned off
00 For multigrid problems, additional settings are made:
00 NOPTG =6
NITG = 1, but for radial grids NITG = 3
RTOLG = 0.001
JCPR =0
00 For a parallel run:
00 NBEPS =3
00 Also, for a LAB units run, the following changes are made:
00 dt = 0.001 hours
dtmin = 0.001 hours
dtmax = 1.0 hour
dtqmax = 0.01 hours

7.5 Interactive Suspend Option

00 The INTERACTIVE card allows the user to suspend execution at the beginning of
the current timestep. Execution will resume when the program detects the
existence of a file named vip_interactive_resume in the directory in which the
program is running. The content of the file does not matter, only its existence.
00 Optionally, through the FILE keyword on the INTERACTIVE card, a file may be
specified that contains recurrent data to be read immediately upon resumption of
execution. If any errors are detected in the data in this file, or if the file does not
exist at the time execution is resumed, execution will go back into suspend mode.
00 The default is for suspension to occur at the beginning of every timestep once the
option has been turned on. The BATCH keyword on the INTERACTIVE card
instructs the program to only suspend at the beginning of this timestep. Normal
execution will resume after this one suspension.
00 The BATCH card causes the interactive suspend option to be immediately turned
off. This card would be input in the file designated by FILE on the
INTERACTIVE card or possibly in the original dataset at a future TIME or DATE
card.
00 Two files are created in the running directory by this option. The file named
vip_interactive_status is created at the time of the suspension. It contains the
current time-of-day and current date. It will also indicate if any errors were found
in the specified data file. These errors are written to a file named
vip_interactive_errors.
00 Note that the entire block of data that contains the INTERACTIVE card is read
before execution is suspended. The only data that will be read when execution is
resumed is the data contained in the file designated by FILE on the
INTERACTIVE card.
00 It is important to remember that the three files vip_interactive_status,

vip_interactive_resume, and vip_interactive_errors exist only in the directory in
which the program is running. They will not be in the working directory from
which a remote-execution job was submitted.
00 A potential problem exists regarding TIME cards when execution resumes. The
program searches for what it assumes is the unique TIME or DATE card following
the INTERACTIVE card. In general this is no problem unless the TIME PLUS
option is used on the card following INTERACTIVE. An exact replica of this
card could have existed in the deck before the INTERACTIVE, causing the
resumed execution to start in the wrong part of the dataset. To avoid the problem
make sure all TIME PLUS cards are unique; extra spaces will do.

7.5.1 Interactive Card (INTERACTIVE)
INTERACTIVE (BATCH) (SLEEP slpsec) (FILE filenm)
00 Definitions:
INTERACTIVE Alpha label indicating that the interactive suspend option

is on.
BATCH Alpha label indicating that the execution should suspend

only at the beginning of this timestep. Normal execution
resumes after this one suspension. The default is to
suspend execution at the beginning of each timestep.
SLEEP Alpha label indicating that the number of sleep seconds is

being entered.
slpsec The number of seconds between checks for the existence

of the resume file. Default is 5 seconds.
FILE Alpha label indicating that a file containing recurrent

data is being specified that should be read when
execution is resumed.
filenm The pathname to the file from which data should be read.

7.5.2 BATCH Card (BATCH)
BATCH
00 Definition:
BATCH Alpha label indicating that the interactive suspend option

is to be immediately turned off.
00 Examples
00 Run starts at 1/1/2000. Suspend execution after each of first 2 years. Enter new
data each time.
00
…
START
…
DATE 1 1 2001
INTERACTIVE BATCH FILE /home/user/data
…
DATE 1 6 2001
…
00 DATE 1 1 2002
INTERACTIVE BATCH FILE /home/user/data
…
00

7.6 Interactive Recurrent Data Changes

00 Changes to the recurrent data can be made while the simulation is in progress.
1. The user needs the process identification (pid) of the run so as to be able to
send a signal to the process. The pid can be obtained by issuing the unix ‘ps’
command on the machine that is executing the simulation. The pid is also
written to Fortran Unit 15 which is referred to as the timestep summary file
elsewhere. The user can type the unix ‘head’ command on the timestep
summary file and get the pid from the first line of the file.
2. The user then sends the unix hangup signal to the process by the following
unix command.
kill -HUP pid
Once the simulator receives the hangup signal it will continue executing the
current timestep, then searches the recurrent data file for the last DATE
(TIME) line read, writes relevant information to the output and status output
files (Fortran Units 6 and 25), and suspends itself.
3. On some systems, the output to the standard output file (Fortran Unit 6) may
be buffered so the interrupt acknowledgement message may not appear in that
output file (*.out) until after the job is continued. The simulation module can
flush any buffers to the status output file (Fortran Unit 25, *.status).
Recurrent data should NOT be modified until one of those files includes
acknowledgement that it is safe to do so.
4. The user should then edit the output file, or use the unix ‘tail’ command to
read the program messages and find which lines of the recurrent data file may
be changed. In general any line following and including the last line read may
be changed, while none of the preceding lines should be changed.
5. When the user is finished with the data changes, the simulation can be
continued by sending the unix continue signal to the process.
kill -CONT pid
6. The user should check the output file to see if the data changes have been
accepted and that the run is progressing.
NOTE: The hangup signal may be used repeatedly during a run. Recurrent data
changes are not required to continue a run.


Chapter
8
Miscellaneous Options
00000
8.1 Energy Minimization Phase Equilibrium (VIP-COMP)
8.1.1 Invoking the Gibbs Algorithm (GIBBS)
GIBBS (tcrit) (maxitr) (tskip) (tpbyp) (txbyp) (tfbyp) (itngbs)
00 Definitions:
tcrit Tolerance value in the test for the critical condition.

Default is 0.15.
maxitr Maximum number of iterations allowed in the Gibbs

energy minimization process. Default is 30.
tskip Tolerance value in the test to skip the phase equilibrium

calculations for two-phase blocks. Default is 0.05.
tpbyp Tolerance value for block pressure change, psi (kPa).

Default is 1 psi.
txbyp Tolerance value for composition change. Default is 0.01.
tfbyp Tolerance value for the stability function. Default is

0.015.
itngbs Maximum number of outer iterations that phase stability

test is performed on for single-phase hydrocarbon
gridblocks. Default is 5.
00 This card invokes the phase stability test and Gibbs energy minimization
algorithm for phase equilibrium calculations. The GIBBS card automatically
activates the feature which identifies gridblocks near the critical point and allows
large changes of oil saturation, gas saturation, and vapor fraction in these blocks
during simulation. All parameters on the card are optional, but they are order
dependent and must be specified through the last value required. Parameters not
specified will be set equal to their defaults. PHFLAG on the OUTPUT card will
print the phase equilibrium condition in each gridblock for the IMPES
formulation. Codes are as follows:
R5000.0.1 Miscellaneous Options 8-455

0. Two phase block.
1. Single-phase block. The fluid is gas.
1.1 Single-phase block. The fluid is gas and is determined to

be far from the two-phase region.
1.5 Single-phase block. The fluid is supercritical and is far

from the critical point.
2. Single-phase block. The fluid is oil.
2.1 Single-phase block. The fluid is oil and is determined to

be far from the two-phase region.
-3. Two-phase block. The fluid is near the critical point at the
end of the timestep.
-3.5 Two-phase block. The fluid is near the critical point at the
beginning of the timestep.
-1. Single-phase block. The fluid is supercritical. The fluid is

near the critical point at the end of the timestep.
-1.25 Single-phase block. The fluid is supercritical. The fluid is

near the critical point at the beginning of the timestep.
-1.5 Single-phase block. The fluid is gas and is near the

critical point.
-2.5 Single-phase block. The fluid is oil and is near the critical
point.
-1.75 Single-phase block. The fluid is gas. The fluid has

changed phase during the timestep.
-2.75 Single-phase block. The fluid is oil. The fluid has

changed phase during the timestep.
00 For a simulation run starting at time = 0 and the GIBBS card was input in VIP-
CORE, the GIBBS option will automatically be on unless a GIBOFF card is
specified in the initial set of recurrent data. The default values noted above will be
used if no GIBBS card is input.
8-456 Miscellaneous Options R5000.0.1

8.1.2 Turning Off the Gibbs Algorithm (GIBOFF)
GIBOFF
00 The GIBOFF card is used to turn off the Gibbs energy minimization algorithm
from this timestep onward. The Gibbs algorithm may only be reinvoked by
respecifying the GIBBS card.
8.2 Successive Substitution Flash Data (VIP-COMP)
8.2.1 Definition of Flash Calculation Method (FLASH)

00 The FLASH card allows the user to define the flash calculation method and
maximum allowable iterations for reservoir and surface flashes. The two available
methods are accelerated successive substitution and Newton-Raphson with
successive substitution preconditioning. The default method for reservoir flashes
is accelerated successive substitution. The default method for surface flashes is
Newton-Raphson.
RES
FLASH maxss maxnr (ACC)
SURF
00 Definitions:
maxss Maximum number of successive substitution iterations

allowed for a flash calculation. Default is 5 for flashes to
surface conditions and 20 for flashes to reservoir
conditions.
maxnr Maximum number of Newton-Raphson iterations

allowed for a flash calculation. Default is 10 for flashes
to surface conditions and 0 for flashes to reservoir
conditions.
RES Alpha label indicating that the data on this card applies to
flashes to reservoir conditions.
SURF Alpha label indicating that the data on this card applies to
flashes to surface conditions.
ACC Alpha label indicating that accelerated successive

substitution flash calculations will be performed.

NOTE: 1. One and only one of the RES or SURF labels must be specified. There
is no default. Separate FLASH cards can be input for RES and SURF.
2. If a FLASH card with the RES option is not input, then ACC
(accelerated successive substitution) is the default. If a FLASH card
with the SURF option is not input, accelerated successive substitution
calculations are not performed. When a FLASH card is input, ACC
must be specified to invoke the option.
8.2.2 Control of Flash Calculations (KMAX)

00 VIP-EXECUTIVE allows the input of data which controls the use of the
accelerated successive substitution flash calculation. By default, phase behavior
calculations are imbedded in the Newton-Raphson mass balance calculations.
Only when a block becomes two-phase, and a flash calculation is to be performed,
is the accelerated successive substitution preconditioning used. However, for
difficult fluids near their critical point, it may be advantageous to provide a more
robust flash treatment. The data cards described below should be entered only for
fluids that have shown some difficulty in phase behavior convergence. The use of
this data may significantly affect computation time.
KMAX KMAX2 KAC KAC2 ⎛ PSAT ⎞ (SS) (EST) (card 1)

⎝ NOPSAT⎠
kmax kmax2 kac kac2 (card 2)
00 Definitions:
KMAX Alpha label for maximum iterations during

preconditioning for gridblocks becoming two-phase.
KMAX2 Alpha label for maximum iterations during

preconditioning for mass balance calculations.
KAC Alpha label for maximum acceleration steps to be

performed during preconditioning for gridblocks
becoming two-phase.
KAC2 Alpha label for maximum acceleration steps to be

performed during preconditioning for mass balance
calculations.
PSAT Alpha label indicating that the saturation pressure

calculation will be performed for all single phase blocks.

NOPSAT Alpha label indicating that the saturation pressure

calculation will be bypassed for blocks that have
previously failed the saturation pressure calculation.
SS Alpha label indicating that phase equilibrium

calculations in the mass balance calculation should be
bypassed. This option should be used only for near-
critical fluids that have not converged without this
option.
EST Alpha label indicating that the flash calculation should

use estimates of initial K-values from a correlation
instead of from current phase compositions at the
beginning of phase behavior calculations. This option
should be used only for near-critical fluids which have
difficulty converging.
kmax Maximum number of iterations during preconditioning

for gridblocks becoming two-phase. If X is entered for
this field, the default value is 50. If this card is not
entered, the default value is 15.
kmax2 Maximum number of iterations during preconditioning

for mass balance calculations. If X is entered for this
field, the default value is 50. If this card is not entered,
the default value is 0.
kac Maximum number of acceleration steps during

preconditioning for gridblocks becoming two-phase. If X
is entered for this field, the default value is 10. If this card
is not entered, the default value is 2.
kac2 Maximum number of acceleration steps during

preconditioning for mass balance calculations. If X is
entered for this field, the default value is 10. If this card is
not entered, the default value is 1.
00 Examples:
00 (1) KMAX KMAX2 KAC KAC2

X X X X
00 is equivalent to
00 KMAX KMAX2 KAC KAC2

50 50 10 10
00 (2) Omitting the data cards from input is equivalent to:
00 KMAX KMAX2 KAC KAC2

15 0 2 1

NOTE: Any occurrence of this data supersedes previous occurrences of this data.
8.3 Gas Percolation Algorithm (GASPERC) (Not available in VIP-

THERM)
OFF
GASPERC
ON
00 Definitions:
OFF Alpha label that causes the gas percolation algorithm to

not be used. This is the default if the card is not input.
ON Alpha label that causes the gas percolation algorithm to

be used.
8.4 Gas Remobilization Option (GASRMON) (Not available in VIP-

THERM)
00 The gas remobilization option models the remobilization of trapped gas resulting
from gas expansion during pressure blowdown. The option may be turned on any
time during the simulation. To invoke this option, gas remobilization tables must
be input in the initialization module input data set (see Section 4.3.9, Gas
Remobilization Option, of the VIP-CORE Reference Manual).
GASRMON grmdsw
00 Definitions:
GASRMON Alpha label indicating that the gas remobilization option

is invoked at the time specified in the preceding TIME/
DATE card. This option may only be invoked once in a
simulation run and may not be turned off after it is
invoked.
grmdsw Incremental water saturation increase (from the gridblock

historic minimum water saturation) as a fraction of total
pore volume beyond which a gridblock may be
considered as a gas expansion gridblock and hence is
subject to remobilization calculation. The default value
for grmdsw is 0.02.

NOTE: A gridblock is subject to remobilization calculation only if all of the

following conditions are met at the time this option is invoked.
1. The water saturation must be greater than the historical minimum

water saturation (Swmin) plus the user-controlled incremental
saturation (grmdsw), i.e., Sw > Swmin + grmdsw.
2. The gas saturation must be less than or equal to the trapped gas
saturation (Sgtr,m) corresponding to the gridblock historical maximum
gas saturation (Sgmax,m), i.e., Sg ≤ Sgtr,m(Sgmax,m).
3. The gridblock historical maximum gas saturation must be greater than

its critical gas saturation, i.e., Sgmax,m > Sgc,m.
00 Example:
00 TIME 3650.
C
C Turn on Gas Remobilization Option
C
GASRMON 0.05

8.5 Modified Land’s Constant for Hysteresis (MODLAND)

00 The MODLAND card is used to specify the form of Land’s constant to use for
both gas phase and oil phase hysteresis in calculating the trapped saturations.
⎛ ON
⎞
MODLAND ⎜ ⎟
⎝ OFF ⎠
00 Definitions:
ON Alpha label indicating that the modified Land’s constant

is to be used. This is the default if neither ON nor OFF is
specified.
1 1
C = --------------------------
- – --------------------------
-
S nwr – S nwc S nwi – S nwc
OFF Alpha label indicating that the original Land’s constant is

to be used:
1 - – ---------
1-
C = ---------
S nwr S nwi
This is the default if the MODLAND card is not

specified.
NOTE: Snwr= residual non-wetting phase saturation.

Snwi = maximum historical non-wetting phase
saturation.
Snwc= critical non-wetting phase saturation.

8.6 Modifying VIP-CORE Array Data

00 OVER and VOVER cards may be used to modify certain gridblock arrays that are
read or computed in VIP-CORE. The OVER card is used to apply a constant
arithmetic operation to a portion of the grid system. The VOVER card modifies
the specified array data with an individual value for each changed gridblock.
8.6.1 Override Modification (OVER)

00 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 the OVER card, it is
generally less confusing to have "sets" of OVER cards, with each set modifying
only one array.
00 OVER (NOCONVERT) array (array) (array) (array)

(GRID name)
i2 j2 k2
i1 j1 k1 #v (v2) (#v (v2)) (#v (v2)) (#v (v2))
NX NY NZ
(Repeat as necessary)
00 Definitions:
NOCONVERT Alpha label indicating that the values entered for these
arrays are in internal units, ignoring whether the user has
specified METRIC or LAB.
OVER Alpha label indicating that changes are to be made to the

specified arrays:
ISAT Relative permeability/capillary

pressure table pointers.

capillary pressure table pointers for
hysteresis.
ITRAN Transmissibility region identifier.
TX(TR) X(R) direction transmissibilities.

TY(TTHETA) Y(Theta) direction transmissibilities.
TZ Z direction transmissibilities.
TKWEXP Fractional flow exponent for

extraneous tracked water types.
CR Rock compressibilities, psi-1 (kPa-1).
PV Effective pore volumes, rb (m3). The

only operation allowed is = (equal).
PVDEF Pore volume multipliers due to

deformation, fraction. This multiplier
is applied after the effects of
compressibility and compaction.
Default is 1.
KX X- (or R-) direction permeabilities,

md.
KY Y- (or Theta-) direction permeabilities,

md.
KZ Z-direction permeabilities, md
GRID Data applies to a particular grid.
00 name Name of the grid. Default is ROOT.
00 Gridblock locations are defined by indices I, J, K in reference to the (x,y,z) or

(r,θ,z) grid. Modifications are applied to array elements lying in the portion of
the grid defined by:
i1 ≤ Ι ≤ 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:
+ 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: Both PV and PVDEF may not be entered on OVER/VOVER cards within
the same recurrent time block.
The porosity deformation option (PORDEF in VIP-CORE) may not be

active if any of the arrays CR, PV, PVDEF, KX, KY, KZ are entered.
When one of the PV or PVDEF arrays is entered, an iterative method is

used to recompute the pressures, compositions, saturations, etc., such that
precise material balance is maintained.
When any of the permeability arrays KX, KY, KZ are entered, the relative
ratio of each gridblock permeability to its original permeability. These
factors are then applied to the appropriate standard, non-standard, and
wellbore transmissibilities for all flows.
8.6.2 Override Modification, VIP-DUAL (OVER)

00 The following are additional arrays available when the DUAL option is invoked.
Their use and effect is analogous to the normal use of the OVER card.

(GRID name)
i2 j2 k2
i1 j1 k1 #v (v2) (#v (v2)) (#v (v2)) (#v (v2))
NX NY NZ
00 Definition:

specified arrays:
ISATF Fracture relative permeability/

ISATIF Fracture imbibition relative

permeability/capillary pressure table
pointers for hysteresis.
ITRANF Fracture transmissibility region

identifier.

TXF (TRF) X(R)-direction fracture

transmissibilities.
TYF(TTHETF) Y(Theta)-direction fracture

transmissibilities.
TZF Z-direction fracture transmissibilities.
TEX Exchange transmissibilities.
CRF Fracture rock compressibilities, psi-1

(kPa-1).
PVF Fracture effective pore volumes, rb

(m3). The only operation allowed is =
(equal).
PVDEFF Fracture pore volume multipliers due

to deformation, fraction. This
multiplier is applied after the effects of
Default is 1.
KXF X- (or R-) direction fracture

permeabilities, md.
KYF Y- (or Theta-) direction fracture

permeabilities, md.
KZF Z-direction fracture permeabilities, md
8.6.3 Individual Value Override Modification (VOVER)

00 The VOVER card 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 locations describing the gridblocks to be changed. The
second card contains the altered values for those gridblocks. A new VOVER card
and its corresponding data cards are read for each different portion of the grid
system being altered.
00 VOVER (NOCONVERT) array

(GRID name)
i2 j2 k2
i1 j1 k1 (op)
NX NY NZ
values as necessary
00 Definitions:

NOCONVERT Alpha label indicating that the values entered for this
array are in internal units, ignoring whether the user has
specified METRIC or LAB.
array One of the following array names to be alterered:
ISAT Relative permeability/capillary

pressure table pointers.

capillary pressure table pointers for
hysteresis.
ITRAN Transmissibility region identifier.
TX(TR) X(R) direction transmissibilities.
TY(TTHETA) Y(Theta) direction transmissibilities.
TZ Z direction transmissibilities.
TKWEXP Fractional flow exponent for

extraneous tracked water types.
CR Rock compressibilities, psi-1 (kPa-1).
PV Effective pore volumes, rb (m3). The

only operation allowed is EQ (equal).
PVDEF Pore volume multipliers due to

deformation, fraction. This multiplier
is applied after the effects of
Default is 1.
KX X- (or R-) direction permeabilities,

md.
KY Y- (or Theta-) direction permeabilities,

md.
KZ Z-direction permeabilities, md
00 name Name of the grid. Default is ROOT.
00 Gridblock locations are defined by indices I, J, K in reference to the (x,y,z) or

(r,θ,z) grid. Modifications are applied to array elements lying in the portion of

the grid defined by:
i1 ≤ Ι ≤ 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.
op an optional keyword that defines the operation to apply to

the array. Any of the following labels may be used:
ADD Add.
SUB Subtract.
DIV Divide.
MULT Multiply.
EQ Equal. This is the default.
00 Enough values must be read to replace all array elements in the designated
portion of the grid. The number of values required is:
00 (k2 - k1 + 1) * (j2 - j1 + 1) * (i2 - i1 + 1) .
00 The order of replacement is by x-direction (r-direction) rows. All rows for the
first xy (rθ) plane are entered in order of increasing J index, followed by the
remaining planes in order of increasing K index.
NOTE: Only one array can be changed with each VOVER card.
Both PV and PVDEF may not be entered on OVER/VOVER cards within

the same recurrent time block.
The porosity deformation option (PORDEF in VIP-CORE) may not be

active if any of the arrays CR, PV, PVDEF, KX, KY, KZ are entered.
When one of the PV or PVDEF arrays is entered, an iterative method is

used to recompute the pressures, compositions, saturations, etc., such that
precise material balance is maintained.
When any of the permeability arrays KX, KY, KZ are entered, the relative
ratio of each gridblock permeability to its original permeability. These
factors are then applied to the appropriate standard, non-standard, and
wellbore transmissibilities for all flows.
8.6.4 Individual Value Override Modification, VIP-DUAL (VOVER)

00 The following are additional arrays available when the DUAL option is invoked.
Their use and effect is analogous to the normal use of the VOVER card.


(GRID name)
i2 j2 k2
i1 j1 k1 (op)
NX NY NZ
values as necessary
00 Definitions:
array One of the following array names to be altered:
ISATF Fracture relative permeability/

ISATIF Fracture imbibition relative

permeability/capillary pressure table
pointers for hysteresis.
ITRANF Fracture transmissibility region

identifier.
TXF(TRF) X(R) direction fracture

transmissibilities.
TYF(TTHETF) Y(Theta) direction fracture

transmissibilities.
TZF Z direction fracture transmissibilities.
TEX Exchange transmissibilities.
CRF Fracture rock compressibilities, psi-1

(kPa-1).
PVF Fracture effective pore volumes, rb

(m3). The only operation allowed is
EQ (equal).
PVDEFF Fracture pore volume multipliers due

to deformation, fraction. This
multiplier is applied after the effects of
Default is 1.
KXF X- (or R-) direction fracture

permeabilities, md.
KYF Y- (or Theta-) direction fracture

permeabilities, md.
KZF Z-direction fracture permeabilities, md

8.6.5 Modifying Fault Connection Transmissibilities (FTRANS)

00 The FTRANS card may be used to modify the transmissibilities across arbitrary
connections between gridblocks. No new fault connections may be established.
The data must specify a VIP-CORE generated fault connection or a standard
connection. If a standard connection is specified, the regular transmissibility array
will be changed (this could also have been accomplished using OVER/VOVER).
FTRANS
(GRID name1 (name2))
i1 j1 k1 i2 j2 k2 t tt
(repeat as necessary)
00 Definitions:
name1 Name of grid1. Default is ROOT.
name2 Name of grid2. Default is name1.
i1 X(R) direction index for the block on the "left" of the

fault.
j1 Y(Theta) 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(R) direction index for the block on the "right" of the

fault.
j2 Y(Theta) direction index for the block on the "right" of

the fault.
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.
tt Thermal transmissibility for the connection across the

fault. This replaces any other transmissibility defined for
the pair of blocks. Units for tt are the same as those for
thermal transmissibilities read for the standard arrays.
Enter in VIP-THERM only (required).

8.6.6 Modifying Fault Connection Transmissibilities, VIP-DUAL (FTRANF)

00 The FTRANF card may be used to modify the transmissibilities across arbitrary
connections between fracture gridblocks. No new fault connections may be
established. The data must specify a VIP-CORE generated fault connection or a
standard connection. If a standard connection is specified, the regular
transmissibility array will be changed (this could also have been accomplished
using OVER/VOVER).
FTRANF (card 1)
i1 j1 k1 i2 j2 k2 t (card 2)
(repeat as necessary) (card 3)
00 Definitions:
i1 X(R) direction index for the fracture block on the "left"

of the fault.
j1 Y(Theta) direction index for the fracture block on the

"left" of the fault.
k1 Z direction index for the fracture block on the "left" of

the fault.
i2 X(R) direction index for the fracture block on the "right"

of the fault.
j2 Y(Theta) direction index for the fracture block on the

"right" of the fault.
k2 Z direction index for the fracture 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
fracture blocks. Units for t are the same as those for
transmissibilities read for the standard fracture
transmissibility arrays.

8.7 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 (Section 1.6), FAULTS (Section 6.2),
OVER (Section 7.2) and VOVER (Section 7.4) options in the VIP-CORE
Reference Guide. Both standard and non-standard transmissibility connections if
any are multiplied. 00
MULTFL fname tmul

Definition: 00
MULTFL Alpha character keyword.
fname Name or number identifying the fault or group of grid

block to be operated upon.
tmul Transmissibility multiplier.
8.8 Inter/Intra Region Transmissibility Multiplier (MULTIR)

The MULTIR keyword is used to modify the transmissibilities between and
within regions. The transmissibility regions are defined using the ITRAN(F) array
data (Section 5.26 in VIP-CORE. In VIP-EXEC, the ITRAN(F) array can be
modified using the OVER (Section 8.6.1) and VOVER options (Section 8.6.3). 00
MULTIR
itr1 itr2 tmul (X) (Y) (Z)
Definition: 00
itr1, itr2 Positive integer values identifying transmissibility

regions. The transmissibility regions are defined using
the ITRAN(F) arrays (Section..). 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.
NOTE: The MULTIR option in VIP-EXEC always operates on both

standard and non-standard connections.
8.9 Pressure Threshold for Limiting Grid Block to Grid Block Flow
(PTHLD)
00 The PTHLD keyword is used to define threshold pressures for limiting flow
between grid blocks that are part of an identifiable interface. 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.
00 Grid blocks can be assigned to an interface using the FNAME parameter on the
MULT (Section 1.6), FAULTS (Section 6.2), OVER (Section 7.2) and VOVER
(Section 7.4) options in VIP-CORE. Interfaces can also be defined between
transmissibility regions. Transmissibility regions are defined using the ITRAN(F)
array data (Section 5.25 and Section 5.26 in VIP-CORE. In VIP-EXEC, the
ITRAN(F) array can be modified using the OVER (Section 8.6.2) and VOVER
options (Section 8.6.3). The threshold pressure applies to both standard and non-
standard connections. The threshold pressure arrays can be printed or mapped
using PTHLD on the OUTPUT or MAPOUT keywords.
PTHLD fname Pthreshold
or
PTHLD itr1 itr2 Ptreshold

EQUIL
00 Definition:
PTHLD Alpha character keyword.
fname Name or number identifying the fault or group of grid

blocks that describe an interface.
itr1, itr2 Positive integer values identifying transmissibility

regions. Transmissibility regions are defined using the
ITRAN(F) arrays (). The threshold pressure will apply
to all connections across the interface defined by itr1
and itr2. Itr1 and itr2 cannot be the same.

Pthreshold Value of threshold pressure.
EQUIL This will calculate threshold pressures for each

connection at the interface such that there will
be no flow at initial conditions. The threshold
pressures are set to the maximum phase potential
difference for a particular connection.
This option is only allowed at time = 0.0.
NOTE: Pressure threshold values for a particular interface replace any

previous values assigned to that interface.
00 Example:
00 PTHLD NW-SE 100

PTHLD 1 2 200
PTHLD 2 3 EQUIL
00 If any connection across the named interface NW-SE,are also shared across
regions 1 and 2, or 2 and 3, then the pressure threshold values for these
connections will be those from the latest specification.

8.10 Phase Identification (PHASID)

00 When two hydrocarbon phases first appear in a gridblock, by default the simulator
identifies the denser phase as the oil phase and the other phase as the gas phase. In
some cases, especially when CO2 is injected, the evolving gas phase may actually
be initially denser than the oil phase. After a short time, the gas phase would again
become less dense than the oil phase. The symptom of this phenomenon is the
appearance of a gas phase during the simulation that is denser than the oil phase.
To prevent this from happening, the PHASID option provides an alternative
means for identifying the oil or gas phases, based on composition. By default, the
PHASID keyword (with no other parameters) will identify the phase with the
greatest mole fraction of the heaviest component as the oil phase. Alternatively,
the user can tag the oil or gas phase as the one that contains the greatest mole
fraction of any one component.
⎛ ⎞
PHASID ⎜ OIL cmpid⎟
⎝ GAS ⎠
00 Definitions:
OIL Alpha label indicating that the oil phase will be identified
as the phase that has the greatest mole fraction of
component cmpid.
GAS Alpha label indicating that the gas phase will be

identified as the phase that has the greatest mole fraction
of component cmpid.
cmpid The alphanumeric component identifier. This identifier

must have been previously identified on the
COMPONENTS input card of VIP-CORE.
00 Examples:
C Identify the oil phase as the phase that has the greatest mole
C fraction of the heaviest component.
PHASID
C Identify the gas phase as the phase that has the greatest mole
C fraction of component CO2.
PHASID GAS CO2

8.11 Diffusion Activation/Deactivation (DIFFUSION)

The DIFFUSION card activates or deactivates the diffusion fluxes in VIP-EXEC.
By default, diffusion is on when the DIFFUSION keyword is entered in VIP-
CORE without the inclusion of the INITONLY keyword.
The DIFFUSION card must have been entered in VIP-CORE.
⎛ OFF ⎞
DIFFUSION ⎜ ⎟
⎝ ON ⎠
00 Definitions:
OFF Alpha label indicating that diffusivity calculations are to

be turned off.
ON Alpha label indicating that diffusivity calculations are to

be turned back on, or remain on. This is the default if
neither OFF nor ON is entered.
00

Chapter
9
Polymer Option (VIP-POLYMER)1
00000
9.1 Polymer Physical Property Data

00 NOTE: Do not use the POLYMER option with the VOLBAL (Section 2.2.5)
option.
00 The polymer physical property data for VIP-POLYMER can be introduced at any
point within the recurrent data. However the data can only be read once.

00 If entered the DIM card(s) must immediately follow the RUN/STORAGE
card, or be the first card(s) in the deck.
00 The POLYMER option allows additional changes to the default dimensions.

00 Definitions:
param Alpha labels of those dimension parameters being

defined.
NCPDIM Number of polymer concentration points for each salinity

curve in the reconstructed polymer properties tables.
Default is 51.
NCPMAX Maximum number of different polymer property regions.

Default is 1.
NESMAX Maximum number of salinity curves in each polymer

properties table. Default is 1.
NSLUG Maximum number of steps in a polymer slug. Default is

4. See PSLUG card.
size The value or size of the corresponding parameter.
1. Available as a separately licensed option. Not available in VIP-THERM.
R5000.0.1 Polymer Option (VIP-POLYMER) 9-477

9.1.2 Polymer Mode (POLYMER)

00 The POLYMER card must be followed by the polymer physical property cards.
The POLYMER card puts the model in the polymer mode and will subsequently
solve the polymer and electrolyte equations and include the polymer physical
properties in the calculations.
POLYMER
9.1.3 Polymer Concentration/Salinity Table (POLYT)

00 The polymer concentration/salinity table defines the rock and fluid properties that
depend on polymer concentration and salinity: polymer phase viscosity at zero
shear rate, polymer adsorption, and the permeability reduction factor. These
properties can be alternatively defined by functions as described in Section 9.1.4.
POLYT npt (NOPRTI) (PRTR) (card 1)

ESALT PERM POR (card 2)
csep perm por (card 3)
CP VP0 CPADS RK (card 4)
cp vp0 cpads rk (card 5)
00 Definitions:
POLYT Alpha label indicating that the data on the following

cards are the polymer concentration/salinity table.
npt The table number. This value corresponds to the values

of the IPOLYT array defined by either an OVER or
VOVER card. (Section 9.6).
NOPRTI Alpha label indicating that the following table will not be
printed on output. Default prints table.
PRTR Alpha label indicating that the reconstructed table will be

printed on output. Default does not print the
reconstructed table.
00 The values shown on Card 3 must appear in the order shown.
csep Effective salinity of the following table values, meq/ml.
perm Absolute permeability for the permeability reduction

factor input on the following cards, md.
por Porosity for the permeability reduction factor input on

the following cards, fraction.
9-478 Polymer Option (VIP-POLYMER) R5000.0.1

00 The values on Card 5 must appear in the order shown.
00 There must be a minimum of two Card 5 data cards.
cp Polymer concentration, ppm. Values must increase

consecutively.
vp0 Polymer phase viscosity at zero shear rate, cp. Values

must increase with increasing polymer concentration.
cpads Polymer adsorption, lb/ac-ft (g/m3) of bulk reservoir

volume. Values must increase with increasing polymer
concentration. Polymer adsorption is instantaneous and
irreversible.
rk Permeability reduction factor, defined as the permeability

to brine divided by the permeability to polymer solution.
Values must increase with increasing polymer
concentration. Permeability reduction is only applied to
the aqueous phase and is considered irreversible.
NOTE: 1. Cards 2 through 5 can be repeated as necessary up to NESMAX times

for each POLYT card. The values of csep within a particular table
must increase consecutively, and a zero value is not allowed. The
POLYT card can be repeated NCPMAX times. NESMAX and
NCPMAX are defined by the DIM card (Section 9.1.1).
2. The use of the POLYT table option to define the polymer/salinity

dependent properties disallows the use of the function option POLYF.

9.1.4 Polymer Concentration/Salinity Functions (POLYF)

00 The polymer concentration/salinity functions define the rock and fluid properties
that depend on polymer concentration and salinity: polymer phase viscosity at
zero shear rate; polymer adsorption; and the permeability reduction factor. These
properties can be alternatively defined by tables as described in Section 9.1.3.
POLYF npf (card 1)

AP1 AP2 AP3 SSLOPE (card 2)
ap1 ap2 ap3 sslope (card 3)
ADP1 ADP2 BP (card 4)
adp1 adp2 bp (card 5)
BRK CRK (card 6)
brk crk (rkmax) (card 7)
00 Definitions:
POLYF Alpha label indicating that the data on the following

cards are the polymer concentration/salinity functions
parameters.
npf The functions number. This value corresponds to the

values of the IPOLYT array defined by either an OVER
or VOVER card Section 9.6).
00 Card 2 indicates that the data being read are polymer phase viscosity at zero
shear rate parameters. The values on the data cards following this card appear
in the order shown on this card. They must appear in the order shown.
ap1 Viscosity parameter (ppm-1) (meq/ml)1/sslope.
sslope Slope of log (viscosity) versus log (effective salinity)

(dimensionless).
00 Card 4 indicates that the data being read are polymer adsorption parameters.
The values on the data cards following this card appear in the order shown on
this card.
adp1 Polymer adsorption parameter (lb/ac-ft)/(ppm), (g/m3)/

(ppm).

adp2 Polymer adsorption parameter (lb/ac-ft)/(ppm)/(meq/ml).
bp Polymer adsorption parameter (1/ppm).
00 Card 6 indicates that the data being read are permeability reduction factor
parameters. The values on the data cards following this card appear in the
order shown on this card.
brk Permeability reduction parameter (1/ppm).
crk Permeability reduction parameter. A positive value

calculates RKMAX as a function of permeability,
porosity, water saturation and salinity (darcy1/2) (ppm1/
3
).
A negative value uses |crk| as the value of RKMAX,

hence independent of permeability, porosity water
saturation and salinity. (dimensionless).
rkmax The rkmax cutoff for calculated RKMAX, used when crk
is positive, such that RKMAX ≤ rkmax (dimensionless).
Default = 10.
NOTE: 1. Cards 1 through 7 can be repeated as necessary up to NCPMAX

times. NCPMAX is defined by the DIM card (Section 9.1.1).
2. When the function option POLYF is chosen to define the polymer/

salinity dependent properties, the table option POLYT is not allowed.
9.1.5 Non-Newtonian Viscosity Cards (SHEAR)

00 The effect of shear rate on the viscosity of the polymer phase is modeled by
Meter’s (Reference 6) equation. The equivalent shear rate for multiphase flow in
porous media is according to Hong’s (Reference 7) approximation. The required
parameters are introduced by the following cards.
SHEAR nsh (GRID) (card 1)

GAMMAC GAMHF POWN (card 2)
gammac gamhf pown (card 3)
00 Definitions:
SHEAR Alpha label indicating that the data being read are shear
rate viscosity parameters.

nsh Polymer property region number corresponding to the

values of the IPOLYT array defined by the OVER or
VOVER cards. (Section 9.6)
GRID Alpha label indicating that the shear rate is a scalar

property and calculated using the magnitude of the
velocity vector at the gridblock center.
gammac Constant related to the power law exponent for non-

Newtonian fluid viscosity. It is used to calculate the
equivalent shear rate for fluid flow vs. porous media.
Values of gammac range from 0.78 to 1.0.
gamhf Shear rate (1/sec) at which the polymer phase viscosity is

equal to the average of the polymer solution viscosity at
zero shear rate and of the water viscosity.
pown Exponent in Meter’s (Reference 6) viscosity equation.
NOTE: 1. If GRID is not specified, shear rate is calculated as a vector property.

The directional property is calculated at the block faces.
2. When multiple polymer property regions are read, the method used
for calculating shear rate is that specified on the last SHEAR card
read.
3. Shear rate adjusted viscosities for well calculations require equivalent

block radius and well radius data entered using the RFLOW or
FPERF cards. Wells at the edge of the reservoir also require
FLOANG data.

9.1.6 Polymer Inaccessible Pore Volume Card (EPHIP)

00 The polymer inaccessible pore volume is introduced by the EPHIP card. Polymer
inaccessible pore volume is used to model the phenomenon of polymer molecules
propagating faster than the solvent for flow in porous media.
EPHIP nep ephip
00 Definition:
nep Polymer property region number corresponding to the

VOVER cards (Section 9.6).
ephip Effective polymer porosity normalized by the true

porosity, φp/φ.
9.1.7 Cation Exchange Cards (IONEX)

00 The exchange of monovalent and divalent cations between the aqueous phase and
the clays is modeled using electrostatic association (Reference 8). The required
parameters are introduced by the following cards.
IONEX nex (card 1)

QV XKC (card 2)
qv xkc (card 3)
00 Definitions:
IONEX Alpha label indicating that the data being read are cations
exchange parameters.
nex Polymer property region number corresponding to the

VOVER cards (Section 9.6).
qv Cation exchange capacity of the reservoir rock. (meq/ml

of P.V.).
xkc Cation exchange constant (meq/ml)-1.

9.1.8 Effective Divalent Salinity Cards (CSEP)

00 Divalent cations affect the polymer properties more than the monovalent cations.
An effective divalent salinity is the equivalent monovalent salinity which gives
the same polymer properties. In general the effective divalent salinity is a multiple
of the divalent salinity. The required parameters are introduced by the following
cards.
CSEP (card 1)
BETAP CSE1 (card 2)
betap cse1 (card 3)
00 Definitions:
CSEP Alpha label indicating that the data being read are
effective divalent salinity parameters.
betap Multiplier for the effective divalent salinity

(dimensionless).
cse1 Salinity value below which the polymer properties are

considered to be independent of salinity (meq/ml).
9.1.9 Salinity Units Card (SUNITS)

00 The electrolyte concentrations can be specified in units of either meq/ml or ppm.
(Section 9.6) The SUNITS card indicates which type of unit to use.
⎛ MEQ ⁄ ML ⎞
SUNITS ⎜ ⎟
⎝ PPM ⎠
00 The SUNITS card can be used more than once to change the units of the data
being read and printed. The default is MEQ/ML.

9.2 Injectors
9.2.1 Polymer Concentration (CPINJ)

00 An INJ card specifying the well as a water injector must precede a CPINJ
card.
00 The CPINJ card is used to specify the concentration of polymer injected for water
injection wells in VIP-POLYMER.
CPINJ wl (card 1)
cpw1 cpw2 . . .cpwn (card 2)
00 Definitions:
wl List of wells for which cpw values are being specified

cpw Polymer concentration being injected in the well. Units

are ppm.
NOTE: The number of cpw values must equal the number of wells in the well list.
9.2.2 Anion (Chloride) Concentration (CLINJ)

00 An INJ card specifying the well as a water injector must precede a CLINJ
card.
00 The CLINJ card is used to specify the anion (chloride) concentration for water
injection wells in VIP-POLYMER.
CLINJ wl (card 1)
clw1 clw2 . . .clwn (card 2)
00 Definitions:
wl List of wells for which clw values are being specified

clw Anion concentration of the water being injected in the

well. Units are meq/ml (ppm).
NOTE: The number of clw values must equal the number of wells in the well list.

9.2.3 Divalent Cation (Calcium) Concentration (CAINJ)

00 An INJ card specifying the well as a water injector must precede a CAINJ
card.
00 The CAINJ card is used to specify the divalent cation (calcium) concentration for
water injection wells in VIP-POLYMER.
CAINJ wl (card 1)
caw1 caw2 . . .cawn (card 2)
00 Definitions:
wl List of wells for which caw values are being specified

caw Divalent cation concentration of the water being injected

in the well. Units are meq/ml (ppm).
NOTE: The number of caw values must equal the number of wells in the well list.
9.2.4 Polymer Slug Definition (PSLUG)

00 An INJ card specifying the well as a water injector must precede a PSLUG
card.
00 The PSLUG card is used to define a polymer slug. A Polymer slug consists of a
series of steps. Each step is defined by a polymer concentration and size.
PSLUG well cpw1 size1 (cpw2 size2) ...(cpwn sizen)
00 Definitions:
well Well number or name for which data is being defined.
cpwn Polymer concentration of step n. Units are ppm.
sizen Polymer size of step n. Units are Lb (kg).


00 The POLYMER option allows additional FPERF parameters.
FPERF (card 1)
WELL ........ (RADBP) (RADWP) ...... (card 2)
........ (radbp) (radwp) ...... (card 3)
(Card 3 is repeated as necessary to describe
all the perforations for each well being perforated)
00 Definitions:
RADBP Colummn heading for radbp, ft (m), the equivalent

radius of the gridblock used for calculating the shear rate
effective polymer viscosity. Default is radb, or rb from
the RFLOW card. A value less than or equal to zero will
result in zero shear rate polymer viscosity for well inflow
calculations.
RADWP Colummn heading for radwp, ft (m), the wellbore radius.

Default is radw, or rw from the RFLOW card. This
value is used for calculating the shear rate effective
polymer viscosity for well inflow calculations. A value
less than or equal to zero will result in a zero shear rate
polymer viscosity.
9.3 Instantaneous Gel Model

00 An aqueous phase containing polymer in the reservoir can be gelled
instantaneously provided the polymer concentration is above a certain cut off
value. The gelled phase is considered immobile and the initial gel saturation is
equal to the water saturation in the gridblock at the time specified. The gelled
phase has the same compressibility as the aqueous phase. The water relative
permeability in a gridblock containing a gel phase is calculated as follows:
00 krw(Sw) = krw(Sw + Sgel) - krw(Sgel)
00 Polymer and electrolytes are not allowed to flow out of a gridblock that has a gel
saturation.
9.3.1 Gel Data (GEL)
GEL (cpgel) (PRINT)

00 Definitions:
cpgel Polymer concentration cut off, ppm (Default is 0.0)
PRINT Prints gel saturation array.
NOTE: Both cpgel and PRINT are order dependent.
9.3.2 Permeability Reduction Multiplier (RKMULT)
RKMULT (rkm) (PRINT)
00 Definitions:
rkm Aqueous phase permeability reduction multiplier

(Default is 1.0). rkm modifies the current rk as follows:
rk = 1. + (rk - 1) * rkm
PRINT Prints the modified rk array.
NOTE: Both rkm and PRINT are order dependent.
9.4 Print/Map Arrays and Parameters (OUTPUT, MAPOUT)

00 The POLYMER option allows additional arrays for the OUTPUT and/or
MAPOUT cards.
OUTPUT array1 . . . arraym

MAPOUT array1 . . . arrayk
00 Definitions:
array Alpha label of those arrays being defined on either an

OUTPUT card or a MAPOUT card:
CPW Polymer concentration in aqueous phase,

ppm.
CPA Adsorbed polymer, lb/ac-ft bulk

reservoir.
CPTOT Total polymer concentration on a pore

volume basis (ppm).

CPTOT = SW * CPW + CPADS
RK Permeability reduction factor.
VISW0 Polymer phase viscosity at zero shear

rate, cp.
VISW Effective polymer phase viscosity

(includes shear rate effects), cp. This
results in the output of 3 arrays: x
direction shear, y direction shear and z
direction sheer.
SHEAR Shear rate, 1/sec. This results in the

output of the 3 directional arrays.
CSEP Effective salinity for calculating the

salinity dependent polymer properties,
(meq/ml).
NAW Sodium concentration in aqueous phase,

(meq/ml).
NAA Adsorbed sodium concentration, (meq/

ml P.V.).
NATOT Total sodium concentration, (meq/ml

P.V.).
CLW Chlorine concentration in aqueous

phase, (meq/ml).
CLTOT Total chlorine concentration, (meq/ml

P.V.).
CAW Calcium concentration in aqueous phase,

(meq/ml).
CAA Adsorbed calcium concentration, (meq/

ml P.V.).
CATOT Total calcium concentration, (meq/ml

P.V.).
IPOLYT Polymer properties region index.

9.5 Timestep Controls (DT)

00 The POLYMER option allows additional parameters for the DT card.
DT . . . . . . . dcpmax dclmax dcamax
00 Definitions:
dcpmax Maximum change in total polymer concentration allowed

during a timestep, ppm. Default is 50 ppm.
dclmax Maximum change in total anion concentration allowed

during a timestep, meq/ml pore volume. Default is 0.1
meq/ml.
dcamax Maximum change in total divalent ion concentration

allowed during a timestep, meq/ml pore volume. Default
is 0.1 meq/ml.
NOTE: 1. The use of dcpmax requires that all values on the DT card, through
dzmax, be specified, as defined above.
2. The use of dclmax requires dcpmax to be specified and-the use of
dcamax requires dclmax to be specified.

9.6 Modifying VIP-CORE Array Data
9.6.1 Override Modification (OVER)

00 The following are additional arrays available when the POLYMER option is
invoked. Their use and effect is analogous to the normal use of the OVER card
(Section 8.6.1).

(GRID name)
i2 j2 k2
i1 j1 k1 #v (v2) (#v (v2)) (#v (v2)) (#v (v2))
NX NY NZ
00 Definition:

specified arrays:
IPOLYT POLYMER properties table pointers.
CLW Anion concentration of the aqueous

phase, meq/ml (ppm).
CAW Divalent cation concentration of the

aqueous phase, meq/ml (ppm).
9.6.2 Individual Value Override Modification (VOVER)

00 The following are additional arrays available when the POLYMER option is
invoked. Their use and effect is analogous to the normal use of the VOVER card.

(GRID name)
i2 j2 k2
i1 j1 k1 (op)
NX NY NZ
values as necessary
00 Definitions:
array One of the following array names to be defined or

altered:
IPOLYT POLYMER properties table pointers.

CLW Anion concentration of the aqueous

phase, meq/ml (ppm).
CAW Divalent cation concentration of the

aqueous phase, meq/ml (ppm).

Chapter
10
Surface Pipeline Network Option1
10.1 General Information

The surface pipeline network option may be used to define a production network
and/or an injection network. These networks must be independent of each other;
i.e. a node may exist in only one network and production and injection wells may
not point to the same node.
Before using the injection network option, please read “Understanding Injection
Network Allocations and Node Pressures in VIP” on page 10-574.
Input data of the surface pipeline network option can be divided into the following
major groups:
1. Profiles of temperature, temperature gradient, inclination angle, valve

coefficient, and choke correlation.
2. Pipe, well tubing, and valve data.
3. Link data.
4. Node data. (pressure and rate constraints, partial separation data).
5. Node connection data.
6. Data of well connections to nodes.
7. Satellite oil field production data.
8. Pseudo well modeling.
9. General parameters.
10. Output information.
1. Available as a separately licensed option. Not available in VIP-THERM
R5000.0.1 10-493
11. Integration with predictive well management.
12. Production well optimization.
These groups will be described in the following sections.
Surface pipeline network data can be changed during a reservoir simulation after
the DATE or TIME card.
Input of some surface pipeline network data is position-dependent. Profile data

must precede pipe and well tubing data. Data of the flow devices (BHPTAB,
BHITAB, pipe, and well tubing data) must precede link data. Link and flow
device data must precede node and well connection data.
The hydraulic tables (BHPTAB or BHITAB) can be used for the description of the
multi-phase fluid flow in the flow devices of the surface pipeline network system.
Besides, the BHPTAB hydraulic table can be applied for the determination of the
pressure gradients in pipelines and well tubing. Input format of the BHPTAB or
BHITAB hydraulic tables has not changed. However, their parameters have
different definitions, which are described below. An option has been developed to
generate five-dimensional hydraulic tables for any well tubing string and/or any
connection between nodes of the surface pipeline network system.
Each node of the surface pipeline network system can have any number of input
connections. Each node may also have multiple output connections under two
possible scenarios:
1. One active connection with additional potential output connections. The

simulator can automatically select an output connection if fluid rate drops
below a minimum value.
2. Multiple active connections. The fluid volume in each active connection is

assigned using splitting factors. No robust hydrodynamic calculations are
made for the allocation of the fluid to the connections.
The surface pipeline network model has a general “tree-like” structure with any
number of node levels. However, loops can not be included.
As with nodes, wells may be connected to more than one node under two possible
scenarios:
1. One active connection with additional potential output connections. The

simulator can automatically select a well connection to a node if the NEW
predictive well management option is active (PREDICT NEW).
2. Multiple active connections. The fluid volume in each active connection is

assigned using splitting factors. No robust hydrodynamic calculations are
made for the allocation of the fluid to the connections.
10-494 Surface Pipeline Network Option R5000.0.1

The pseudo well option is provided to model some parts of the reservoir or
satellite oil fields which are connected to the surface pipeline network system but
which are not represented in the reservoir model. Inflow performance correlations
are applied for the definition of pseudo well production rates. Most available well
management features can be used for these wells.
Names of profiles, pipes, well tubings, valves, links, and nodes can not be longer
than eight characters. The first character in the name must be alphabetic unless the
name is immediately preceded by the character #.
The simplified heat transfer analysis option applies only to production networks.
When the water salinity option is active, the surface pipeline network option does
not take into account any salinity values.
The following gathering system will be used as an example in the keyword

descriptions:
pipe3 Node4
Node3 pipe3
pipe1 pipe2 link1
Node2 Node5
Node1 pipe6
Wellhead pipe3
tubing1 tubing2 link2 BHPTAB link3
Well1 Well4 Well5 Well 6 Well 7
R5000.0.1 Surface Pipeline Network Option 10-495

10.2 Flow Modeling in Well Tubing Strings

All capabilities for modeling of multiphase compositional flow in devices of the
surface pipeline network system can be applied for flow modeling in well tubing
from a wellbore to a wellhead. Therefore, CURVE, PIPES, TUBING, VALVES,
BHPTAB, BHITAB, LINK, and WELCON cards can be applied for flow
modeling in well tubing strings. This part of the surface pipeline network option
can be used independently from the more general surface pipeline network
modeling.
The following data in the specified sequence must be provided to apply these
capabilities for flow modeling in well tubing strings:
• tubinghead pressure (THP cards);
• profiles of temperature, temperature gradient, inclination angle, valve

coefficient, and choke correlation, if required (CURVE cards);
• hydraulic table, pipe, well tubing, and/or valve data, if required (BHPTAB,
BHITAB, PIPES, TUBING, VALVES, and/or LINK cards);
• well tubing connection data (WELCON cards).
Example:
C
C In the following example, a well string for Well 1 consists of
C 3 tubing sections with different diameters, thicknesses, lengths,
C and temperature distributions. They are connected using Link LINK1.
C The well string for Well 2 is modeled by tubing TUBIN4.
C
THP 1 2
750 750
TUBINGS
NN NAME DIAMET THICKN ROUGHN LENGTH TEMPUP TEMPDW PDCORR
1 TUBIN1 1.128 0.619 0.00001 590 400 397.3 HAGEDORN
2 TUBIN2 1.375 0.75 0.00001 17501 397.3 316.1 HAGEDORN
3 TUBIN3 1.338 0.820 0.00001 3458 316.1 300 HAGEDORN
4 TUBIN4 1.338 0.820 0.00001 21100 400 300 HAGEDORN
LINK 1 LINK1
C NN Name Type Num_Drop Pressure_Correction IPVT
1 TUBIN1 TUBING 1 0. 2
2 TUBIN2 TUBING 1 10 1
WELCON
WELL TUBCON TUBCNT WDZ WDAT
1 LINK1 LINK 20500 21000
2 TUBIN4 TUBING 20900 21000
C

10.3 Application of Hydraulic Tables for Modeling Flow in Flow

Devices
Hydraulic tables (BHPTAB or BHITAB) can be used for modeling of the fluid
flow in the flow devices of the surface pipeline network system.
The five-dimensional hydraulic table (BHPTAB) defines pressure at the inlet of

the flow device (BHP) as a tabular function of pressure at the outlet of this device
(THP), liquid rate (QLIQ), gas-oil ratio (GOR), water cut (WCUT), and artificial
lift quantity value (ALQ). Alternatively, oil or gas rate (QO or QG) may be used
instead of the liquid rate, and gas-liquid or oil-gas ratios (GLR or OGR) may be
used instead of the gas-oil ratio, and water-gas ratio (WGR) may be used instead
of the water cut. The artificial lift quantity is an additional input variable which
may be pipe inclination angle, gas-lift rate, pump efficiency or power, etc.
The two-dimensional hydraulic table (BHITAB) defines pressure at the inlet of

the flow device (BHP) as a tabular function of pressure at the outlet of this device
(THP) and the liquid or gas rate (QI).
Pressure, temperature, and the PVT table number (in non-thermal problems),
which are used for the determination of the volumetric rates, are determined in the
LINK card.
10.4 Application of Look-Up Tables for Pressure Gradient

Determination in Pipes
A five-dimensional hydraulic table (BHPTAB) can be used for modeling of
pressure gradient in different pipe locations. In this case, the hydraulic table
BHPTAB defines pressure (BHP) at the beginning of a pipe interval with the
specified length (dzw) as a tabular function of the pressure (THP) at the end of
this interval, liquid rate (QLIQ), gas-oil ratio (GOR), water cut (WCUT), and
inclination angle (ALQ). Alternatively, oil or gas rate (QO or QG) may be used
instead of the liquid rate, and gas-liquid or oil-gas ratios (GLR or OGR) may be
used instead of the gas-oil ratio, and water-gas ratio (WGR) may be used instead
of the water cut.
The pressure gradient at the current pipe location L is calculated as a difference of

the pressures at the end and the beginning of a pipe interval divided by the interval
length:
dP THP – BHP
------- ( L ) = -----------------------------
-
dL dzw

10.5 Profiles of Temperature, Inclination Angle, Valve Coefficient,

Choke Correlation, and PVT Tables (CURVE)
10.5.1 Temperature Profile (CURVE TEMPPR)

A temperature profile determines a temperature distribution in pipes and well
tubing. It is used to relate temperature in different pipe locations to variable pipe
length.
CURVE TEMPPR tname

LENGTH length1 length2 . . . lengthn
TEMP temp1 temp2 . . . tempn
Definitions:
TEMPPR Alpha label indicating that the temperature profile is

input.
tname Name of the temperature profile.
LENGTH Alpha label indicating that the values on this card are
pipe length values. The values of the pipe length must
be input in increasing order.
length Length of the pipe from the inlet to the current
position, ft (m).
TEMP Alpha label indicating that the values on this card are
temperature values.
temp Temperature in the current pipe position, °F (°C).
NOTE: 1. Values of length and temperature can be input on several cards.
2. The linear interpolation technique is used for the determination of

temperature between the entries of the temperature profile.
3. In general, this data defines a fluid temperature profile. But, in the

simplified heat transfer analysis option (HEATTR = 1 in the NETPAR
card), this data defines an ambient temperature profile.
Examples:
C
C Two temperature profiles.
C
CURVE TEMPPR TEMPPR1
LENGTH 0 3000 5000 6000

TEMP 150 140 130 120

C
CURVE TEMPPR TEMPPR3
LENGTH 0
8500
TEMP 60 160
10.5.2 Temperature Gradient Profile (CURVE TMGRPR)

A temperature gradient profile determines a temperature gradient distribution in
pipes and well tubing strings. It is used to relate temperature gradient in different
pipe locations to subsea depth.
CURVE TMGRPR tname

DEPTH depth1 depth2 ... depthn
TEMP temp1 temp_grad2... temp_gradn
Definitions:
TMGRPR Alpha label indicating that the temperature gradient

profile is input.
tname Name of the temperature gradient profile.
DEPTH Alpha label indicating that the values on this card are
subsea depths. The values of the subsea depth must be
input in increasing order.
depth Subsea depth, ft (m).
temperature or temperature gradient values.
temp Temperature at the first subsea depth, depth1, °F (°C).
temp_grad Temperature gradient at the current subsea depth, °F/
feet (°C/m).
NOTE: 1. Values of subsea depth and temperature gradient can be input on several
cards.
2. In general, this data defines a fluid temperature gradient profile. But, in

the simplified heat transfer analysis option (HEATTR = 1 in the
NETPAR card), this data defines an ambient temperature gradient
profile.

Example:
C
CURVE TMGRPR temgrpr
DEPTH 0 1369 5962
TEMP 60 0.022 0.021
10.5.3 Elevation Profile (CURVE ELEVPR)

An elevation profile relates inclination angle at different pipe locations to the
cumulative pipe length from the beginning position of the pipe segment. The
beginning position of the pipe is the end of the pipe closest to the well.
CURVE ELEVPR ename

LENGTH length1 length2 . . . lengthn
ANGLE angle1 angle2 . . . anglen
Definitions:
ELEVPR Alpha label indicating that the elevation profile is

input.
ename Name of the elevation profile.
LENGTH Alpha label indicating that the values on this card are
cumulative pipe lengths. The values of length must be
length Cumulative length of the pipe from the beginning
position of the pipe segment to the position at which
the inclination applies, ft (m).
ANGLE Alpha label indicating that the values on this card are
inclination angle values.
angle Inclination angle from the horizontal axis at this
position of the pipe, degrees (radians).
NOTE: Values of length and inclination angle can be input on several cards.
Examples:
C
C Three elevation profiles.
C
CURVE ELEVPR ELEVPR1
LENGTH 2000 3000 4000 5000 6000
ANGLE 0 5 8 12 0

C
LENGTH 2000 3000 4000 5000 6000
ANGLE 3 5 8.4 12 4
C
LENGTH
4200 8400
ANGLE 95 97
10.5.4 Valve Coefficient Profile (CURVE VCPR)

Valve coefficient profile relates valve coefficient in a valve model to valve setting.
CURVE VCPR vname

SET set1 set2 . . . setn
VC vc1 vc2 . . . vcn
Definitions:
VCPR Alpha label indicating that the valve coefficient profile

is input.
vname Name of the valve coefficient profile.
SET Alpha label indicating that the values on this card are
valve settings. The values of valve setting must be
set Valve setting.
VC Alpha label indicating that the values on this card are
valve coefficients.
vc Valve coefficient.
NOTE: 1. Values of valve setting and valve coefficient can be input on several
cards.
2. The linear interpolation technique is used for the determination of the

valve coefficient between the entries of the valve coefficient profile.
Examples:
C
C Two “dummy” valve coefficient profiles.
C
CURVE VCPR VC1

SET 1 2 3 4
VC 5.4 0.8 0.3 0.01
C
CURVE VCPR VC2
SET 1 2
3 4
VC 3.8 2.7
0.8 0.1
10.5.5 Choke Correlation (CURVE IDPR)

Choke correlation relates choke internal diameter in a Perkins choke model to
choke setting.
CURVE IDPR cname

SET set1 set2 . . . setn
ID id1 id2 . . . idn
Definitions:
IDPR Alpha label indicating that the choke correlation is

input.
cname Name of the choke correlation.
SET Alpha label indicating that the values on this card are
choke settings. The values of choke setting must be
set Choke setting.
ID Alpha label indicating that the values on this card are
choke inner diameters.
id Choke inner diameter, in (cm).
NOTE: 1. Values of choke setting and diameter can be input on several cards.

choke diameter between the entries of the choke correlation table.
3. Choke correlation must be defined to apply the Perkins choke model. It

must be input before the Perkins choke model description in the
VALVES card.
Example:

C WILLIS 0.75 Choke

C
CURVE IDPR C0201
C
C Choke setting in degrees
SET 20.5 21 21.5 22 22.5 23 ..........
C Choke inner diameter in inches
ID 0.014465 0.034404 0.050908 0.065789 0.079637 0.092741 ......
10.5.6 PVT Property Table Profile (CURVE IPVTPR)

A PVT property table profile determines a relationship between a PVT table
number and temperature. It is used to relate fluid PVT properties to temperature in
different elements of the surface pipeline network system in black-oil models.
CURVE IPVTPR iname

TEMP temp1 temp2 . . . tempn
IPVT ipvt1 ipvt2 . . . ipvtn
Definitions:
IPVTPR Alpha label indicating that the PVT property table

profile is input.
iname Name of the PVT property table profile.
temperatures.
temp Temperature, °F (°C). Temperature values must be
IPVT Alpha label indicating that the values on this card are
PVT property table numbers.
ipvt PVT property table number.
NOTE: 1. Temperature values and PVT property table numbers can be input on
several cards.

fluid PVT properties between the temperature entries of the PVT
property profile.
Examples:
C
C PVT property table profiles.
C
CURVE IPVTPR PVTPROFI

TEMP 52 60 100 200

IPVT 4 3 2 1
10.6 Pipe Data (PIPES)

Parameters of horizontal or inclined pipes are input after the PIPES keyword. A
five-dimensional hydraulic table (BHPTAB) can be used for the determination of
the pressure gradient at different pipe locations instead of the analytical
correlations. In this case, the hydraulic table number should be input with a minus
sign in the PDCORR column.
PIPES
NN param1 param2 . . . paramn
num1 value11 value21 . . . valuen1
.
.
.
numm value1m value2m . . . valuenm
Definitions:
NN Alpha label indicating that the pipe number is input in

this column.
num Pipe number. The pipe numbers must be input in
increasing order.
param Alpha labels of those pipe parameters being defined.
The following parameters can be input: DIAMETER,
THICKNESS, ROUGHNESS, LENGTH, ANGLE,
YOUNG, NAME, PRESIN, TEMPUP, TEMPDW,
PDCORR, DHCOR, ELEVPR, TEMPPR, TMGRPR,
HTC, GRPGCR, FRPGCR, ACPGCR.
DIAMETER Pipe inner diameter, in (cm). This parameter must be
input.
THICKNESS Pipe thickness, in (cm). This parameter must be input.
ROUGHNESS Pipe roughness factor, in (mm). This parameter must
be input.

LENGTH Pipe total length, ft (m). One of the parameters

elevation profile (ELEVPR) or pipe total length
(LENGTH) must be input. If ELEVPR is input,
LENGTH is ignored, in which case the total pipe
length is set to the last entry in the LENGTH row of
the elevation profile.
ANGLE Pipe inclination angle from the horizontal axis,
degrees (radians). This parameter is ignored if pipe
elevation profile (ELEVPR) is input. Default is zero.
YOUNG Young modules, million psia (million kPa). The
default value of this parameter is defined on the
NETPAR card.
NAME Pipe name.
PRESIN Pressure increment, psia (kPa). A second order Runge-
Kutta procedure with an automatic selection of
integration intervals is applied for the numerical
solution of the pipe flow equations. The integration
interval is selected to assure that the pressure drop in
this interval is not larger than the pressure increment
PRESIN. The default value of this parameter is
defined on the NETPAR card.
TEMPUP Upstream temperature of the pipe for production,
downstream temperature of the pipe for injection, °F
(°C). This parameter is ignored if the temperature
profile is input. The default value of this parameter is
TEMPDW Downstream temperature of the pipe for production,
upstream temperature of the pipe for injection, °F
(°C). This parameter is ignored if the temperature
profile is input. The default value of the parameter is
PDCORR Pressure drop correlation for two-phase flow (see Note
1). The following correlations can be used:
NOSLIP without slip effect;
DUKLER Dukler II with Flanigan
correction for elevation;
DUKEAT Dukler II with Eaton holdup
and Flanigan correction for
elevation;
BEGGS Beggs and Brill;
ANSARI Ansari;

ANSBEG Ansari, for deviation angle

between 45o and 135o and
between 225o and 315o
(measured from horizontal);
Beggs and Brill, otherwise;
-n Use hydraulic table
(BHPTAB) number n to
determine the pressure
gradient in the pipe.
Default is BEGGS.
DHCOR Downhill correction flag. The downhill correction
(meaning ignore elevation pressure gradient) is
applied if the value of this parameter is one. The
downhill correction is not used if a value of zero is
input. Only the values zero and one may be entered.
Default is zero.
ELEVPR Name of the elevation profile, from the CURVE
ELEVPR card.
TEMPPR Name of the temperature profile, from the CURVE
TEMPPR card.
TMGRPR Name of the temperature gradient profile, from the
CURVE TMGRPR card.
HTC Pipe heat transfer coefficient, BTU/(hr*ft2*0F)
( W/(m2*0K)). This parameter is applied only in the
simplified heat transfer analysis option (HEATTR = 1
in the NETPAR card). Defaults to HTCPIPE in the
NETPAR card.
GRPGCR Correction factor for the gravity pressure gradient.
FRPGCR Correction factor for the friction pressure gradient.
ACPGCR Correction factor for the acceleration pressure
gradient.
value The value of the corresponding parameter.

NOTE: 1. During the pressure drop calculation, if it is determined that only a

single-phase fluid exists (i.e., only gas or only liquid), the NOSLIP
correlation will be used. The PDCORR option entered by the user (or
defaulted) is only used for two-phase flow.
2. The default values of the pressure gradient correction factors GRPGCR,

FRPGCR, and ACPGCR are defined in the NETPAR card. They can be
automatically adjusted using the TBADJ or TUNING options.
2. In the simplified heat transfer analysis option (HEATTR = 1 in the

NETPAR card), TEMPUP and TEMPDW are ambient temperatures;
otherwise they are fluid temperatures.
Examples:
C
C Parameters of six pipelines.
C
PIPES
NN NAME DIAMET THICKN ROUGHN PRESIN TEMPUP TEMPDW PDCORR LENGTH
1 PIPE1 4. 0.2 0.0001 500 100. 60. BEGGS 10000
2 PIPE2 4. 0.2 0.0001 500 100. 60. BEGGS 5000
C
PIPES
NN NAME DIAMET THICKN ROUGHN PRESIN TEMPUP TEMPDW PDCORR LENGTH ANGLE
3 PIPE3 16 0.2 0.0006 500 100. 60. BEGGS 10000 3
C
PIPES
NN NAME DIAMET THICKN ROUGHN PRESIN ELEVPR TEMPUP TEMPDW PDCORR
4 PIPE4 4. 0.2 0.0001 500 ELEVPR1 100 60 DUKLER
C
PIPES
NN NAME DIAMET THICKN ROUGHN PRESIN LENGTH ANGLE TEMPPR PDCORR
5 PIPE5 4. 0.2 0.0001 500 6000 4. TEMPPR2 BEGGS
C
C Hydraulic table (BHPTAB) with Number 2 is used for
C the determination of the pressure gradient in Pipe 6.
C
PIPES
NN NAME DIAMET THICKN ROUGHN PDCORR ELEVPR PRESIN
6 PIPE6 4. 0.2 0.0001 -2 ELEVPR1 200

10.7 Tubing Data (TUBING)

The parameters of vertical or inclined well tubing are input after the TUBING
keyword.
TUBING
.
.
.
Definitions:
NN Alpha label indicating that the well tubing number is

input in this column.
num Well tubing number. The well tubing numbers must be
param Alpha labels of those tubing parameters being defined.
The following parameters can be input: DIAMETER,
THICKNESS, ROUGHNESS, LENGTH, DEPTH,
YOUNG, NAME, PRESIN, TEMPUP, TEMPDW,
PDCORR, ELEVPR, TEMPPR,TMGRPR, HTC,
GRPGCR, FRPGCR, ACPGCR.
DIAMETER Well tubing inner diameter, in (cm). This parameter
must be input.
THICKNESS Well tubing thickness, in (cm). This parameter must be
input.
ROUGHNESS Well tubing roughness coefficient, in (mm). This
parameter must be input.
LENGTH Well tubing total length, ft (m). One of the parameters
elevation profile (ELEVPR), total length (LENGTH),
or subsea depth (DEPTH) must be input. If the
ELEVPR is input, LENGTH is ignored, in which case
the total length is set to the last entry in the LENGTH
row of the elevation profile. The total length is assumed
to be the true vertical length if on ly the true vertical
length is input. The tubing inclination angle is
calculated using values of the true vertical length and
total length, if the elevation profile is not input.

DEPTH True vertical length of well tubing, ft (m). That is, this
is the length of the projection of the tubing onto the
vertical axis. The value will always be less than or
equal to LENGTH. This parameter is ignored if the
elevation profile is input. The true vertical length is
assumed to be the total length if only the total length is
input. The tubing inclination angle is calculated using
the true vertical length and total length if the elevation
profile is not input.
YOUNG Young modules, million psia (million kPa). The default
value of this parameter is defined on the NETPAR card.
NAME Well tubing name.
PRESIN Pressure increment, psia (kPa). A second order Runge-
Kutta procedure with an automatic selection of
integration intervals is applied for the numerical
solution of the pipe flow equations. The integration
interval is selected to assure that the pressure drop in
this interval is not larger than the pressure increment
PRESIN. The default value of this parameter is defined
on the NETPAR card.
TEMPUP Upstream temperature of the well tubing for
production, downstream temperature of the well tubing
for injection, °F (°C). This parameter is ignored if the
temperature profile is input. The default value of this
parameter is defined on the NETPAR card.
TEMPDW Downstream temperature of the well tubing for
production, upstream temperature of the well tubing for
injection, °F (°C). This parameter is ignored if the
temperature profile is input. The default value of this
parameter is defined on the NETPAR card.
PDCORR Pressure drop correlation for two-phase flow (see Note
1). The following correlations can be used:
NOSLIP without slip effect;
HAGEDORN Hagedorn and Brown;
DUNROS Duns and Ross;
BEGGS Beggs and Brill;
AZIZ Aziz and Govier;
ORKISZEWSKI Orkiszewski;
GRIFFITH Griffith, Lau, Hon, and Pear-
son;

HAG-BEG Hagedorn and Brown, for

deviation angle between 45o
and 135o and between 225o
and 315o (measured from
horizontal); Beggs and Brill,
otherwise;
ANSARI Ansari;
ANSBEG Ansari, for deviation angle
between 45o and 135o and
between 225o and 315o
(measured from horizontal);
Beggs and Brill, otherwise;
-n Use hydraulic table
(BHPTAB) number n to
determine the pressure
gradient in the pipe.
Default is BEGGS.
ELEVPR Name of the elevation profile, from the CURVE
ELEVPR card.
TEMPPR Name of the temperature profile, from the CURVE
TEMPPR card.
TMGRPR Name of the temperature gradient profile, from the
CURVE TMGRPR card.
HTC Tubing heat transfer coefficient, BTU/(hr*ft2*0F)
(W/(m2*0K)). This parameter is applied only in the
in the NETPAR card). Defaults to HTCTUB in the
NETPAR card.
GRPGCR Correction factor for the gravity pressure gradient.
FRPGCR Correction factor for the friction pressure gradient.
ACPGCR Correction factor for the acceleration pressure gradient.
NOTE: 1. During the pressure drop calculation, if it is determined that only a

single-phase fluid exists (i.e., only gas or only liquid), the NOSLIP
correlation will be used. The PDCORR option entered by the user (or
defaulted) is only used for two-phase flow.
2. The default values of the pressure gradient correction factors GRPGCR,

FRPGCR, and ACPGCR are defined in the NETPAR card. They can be
automatically adjusted using the TBADJ or TUNING options.

3. In the simplified heat transfer analysis option (HEATTR = 1 in the

NETPAR card), TEMPUP and TEMPDW are ambient temperatures;
otherwise they are fluid temperatures.
Examples:
C
C Well tubing parameters.
C
TUBING
NN NAME DIAMET THICKN ROUGHN PRESIN DEPTH LENGTH TEMPPR PDCORR
1 TUBIN1 4. 0.2 0.0001 500 8400 8500 TEMPPR2 ORKISZ
TUBING
NN NAME DIAMET THICKN ROUGHN PRESIN ELEVPR TEMPUP TEMPDW
2 TUBIN2 4. 0.2 0.0001 400 ELEVPR3 160 60

10.8 Valve Data (VALVES, VALSET)

Valve or choke parameters are input after the VALVES card. The VALVEC valve
model or PERKINS choke model can be applied.
The VALVEC valve model predicts subcritical pressure drop across a valve using
the following equation6,7:
Q tot Q tot
p out – p in = – CVX ( X ) -----------------------
ρ
where:
pout is the pressure at the outlet of the valve in psia (kPa);
pin is the pressure at the inlet of the valve in psia (kPa);
Qtot is the total mass rate of the fluid in lb. per sec., which is calculated as a
sum of the mass rates of the oil, gas, and water phases;
ρ is the density of the mixture in lb. per cu.ft.
CVX(X) is the valve coefficient which depends on a valve setting X. The user
should define the valve coefficients for the different valve settings using a
valve coefficient profile (CURVE VCPR).
The oil, gas, or liquid mass rate can be used (instead of the total mass rate) for the
definition of the pressure drop in a valve.
The PERKINS choke model represents critical and sub-critical multiphase fluid
flow across a choke. The following input is required to apply the Perkins choke
model:
1. Input a choke correlation which relates choke setting with choke inner
diameter after the CURVE IDPR card.
2. Define the PERKINS model, a choke correlation name, and inner diameter of
tubing segment with embedded choke using keywords MODEL, IDPR, and
TUBID.
3. Apply choke model in well connections to nodes, node connections, or links.
A pressure control valve or a flow control valve is simulated as follows: The

pressure control valve model automatically selects the valve coefficient CVX or
the choke setting from a specified range. This coefficient or choke setting
minimizes the absolute value of the difference between a valve upstream pressure
and a target pressure. The valve coefficient range is defined by a valve coefficient
profile and a valve status. If the valve status is “OPEN”, the whole range of the
valve coefficient profile is used in the calculations. If the valve status is

“CLOSE”, the valve coefficient range consists only from the first entry of the
valve coefficient profile. In the flow control valve model, the valve coefficient is
defined as one of the end points of the valve coefficient profile. If the valve status
is “OPEN”, the valve coefficient is determined as the last entry in the valve
coefficient profile. If the valve status is “CLOSE”, the valve coefficient is selected
as the first entry in the valve coefficient profile. In the flow control valve/choke,
the valve/choke setting can be input in the VALSET card.
VALVES
..
Definitions:
NN Alpha label indicating that the valve number is input

in this column.
num Valve number. The valve numbers must be input in
increasing order.
param Alpha labels of those valve parameters being defined.
The following parameters can be input: NAME,
MODEL, IDPR, TUBID, TEMPUP, TEMPDW,
VCPR, TYPE, CONTROL, TARGET, STATUS,
MAXPRD.
NAME Valve name.
MODEL VALVEC valve model (default) or PERKINS choke
model.
IDPR Name of the choke correlation from the CURVE IDPR
card. This parameter must be defined if the PERKINS
model is used.
TUBID Inner diameter of a tubing segment with choke, in
(cm). This parameter must be defined if the PERKINS
model is used.
TEMPUP Upstream temperature of the valve for production,
downstream temperature of the valve for injection, °F
(°C). The default value of this parameter is defined on
the NETPAR card.
TEMPDW Downstream temperature of the valve for production,
upstream temperature of the valve for injection, °F
(°C). The default value of this parameter is defined on
the NETPAR card.

VCPR Name of the valve coefficient profile from the

CURVE VCPR card. This parameter must be defined
if the VALVEC model is used.
TYPE Valve type. One of the following mass rates is used to
calculate the pressure drop in the valve:
OIL;
GAS;
LIQUID;
ALL.
Default is ALL.
CONTROL Valve control. A pressure control valve or a flow
control valve can be simulated as follows:
PRESUP;
FLOW.
Default is FLOW. The target pressure must be input if
the pressure control option is used.
TARGET Target pressure, psia (kPa). This parameter is used
only in the valve or choke model with the upstream
pressure control.
STATUS Valve status: CLOSE or OPEN. Default is CLOSE.
MAXPRD Maximum pressure drop in a choke/valve, psia (kPa).
Default is 2000 psia.
Examples:
C Valve parameters.
VALVES
NN NAME TEMPUP TEMPDW CONTROL STATUS VCPR TYPE TARGET
1 VALVE1 20. 14.4 PRESUP OPEN VC1 OIL 2000.
2 VALVE2 20. 14.4 PRESUP CLOSE VC2 OIL 70.
C Choke parameters.
VALVES
NN NAME MODEL IDPR TUBID TEMPUP TEMPDW
3 W0001C PERKINS C0201 5.875 172 172
VALSET
valve_name1 valve_setting1
valve_name2 valve_setting2
.. ..

Definitions:
valve_name Valve/choke name or number. It must be defined in

the VALVES card before it can be referenced in the
VALSET card.
valve_setting Valve/choke setting. It is used only if the FLOW valve
control is defined in the VALVES card.

10.9 Link Data (LINK)

A link simulates the flow of the multi-phase fluids in
• well tubing and casing,
• connections between wellheads and nodes of the surface pipeline network

system, and
• connections between nodes.
Each link has only one inlet and one outlet. A link can be constructed from several
flow device models sequentially connected with each other. The following models
of the flow devices can be used in the link:
• pipe,
• well tubing,
• valve,
• five-dimensional hydraulic table (BHPTAB),
• two-dimensional hydraulic table (BHITAB) with the liquid rate as input

variable (BHLTAB),
• two-dimensional hydraulic table (BHITAB) with the gas rate as input variable
(BHVTAB).
If the hydraulic tables are applied for the determination of the pressure drop in
some flow device included in the link, the volumetric rates are determined from
flash calculations. Pressure, temperature, and PVT table number, which are used
in these calculations, can be input on the LINK card.
LINK link_number (link_name)
1 nm1 tp1 ⎛ n um pcor ⎛ ipvt1 alq1 temp 1 pres 1⎞ ⎞ (IPVTW ipvtw1)

⎝ 1 1 ⎜ IBAT ibat 1 alq 1 ⎟⎠
. ⎝ ⎠
.
tpn ⎛⎜ num pcor ⎛
ipvt n alq n temp n pres n⎞ ⎞
n nmn (IPVTW ipvtwn)
n n ⎜ ⎟⎟
⎝ ⎝ IBAT ibat n alq n ⎠⎠
Definitions:
link_number Link number. The link numbers should be input in

increasing order.
link_name Link name.

n Sequential number of the flow device. All flow

devices in the link must be numbered starting from the
upstream link inlet.
nm Flow device name or number. A value of the NN or
NAME parameter in the PIPES, TUBING, or
VALVES card should be input in this column. Or, a
hydraulic table number (nbhp or nbhi) from the
BHPTAB or BHITAB card can be used.
tp Flow device type:
PIPE;
TUBING;
VALVE;
BHPTAB;
BHLTAB (the BHITAB hydraulic table with the
liquid rate as the input variable);
BHVTAB (the BHITAB hydraulic table with the
vapor rate as the input variable).
num The determination of the pressure drop on the flow
device is sequentially repeated num times. Default is
one.
pcor Additive pressure correction to apply to the value of
pressure at the upstream inlet of the flow device, psia
(kPa). Default is zero.
ipvt Flash calculations in the flow device are performed
using the "table" ipvt.
For black-oil models, ipvt is a PVT property table
number or a PVT property profile name (CURVE
IPVTPR).
For compositional models, ipvt is an equation-of-state
table number.
For models using EOSINT, ipvt is an EOSINT table
number (equilibrium region number).
For device types BHPTAB, BHLTAB, and BHVTAB,
the default is to assign Separator 1 if it has been
defined or the default separator for PVT region 1 if it
has not been defined.
If the first flow device in the link is PIPE, TUBING, or
VALVE, default is one. For all other devices of these
types in the link, default is the PVT table number of
the previous device.

IBAT Alpha label designating that the separator battery

model is to be used for the determination of
volumetric rates instead of a PVT table or an equation-
of-state. This parameter is used only in a model of a
flow device described by the hydraulic table
(BHPTAB or BHITAB).
ibat Separator battery number. Alternatives include the
battery number of a separator input in the separator
data (Surface Separator Data), or a value of -npvt
which accesses a default separator. This parameter
must follow the IBAT alpha label.
alq Artificial lift quantity. This parameter is used only in a
model of the flow device described by the hydraulic
table (BHPTAB or BHITAB). Default is zero.
temp Temperature applied in flash calculations for the
determination of volumetric rates, °F (°C). This
parameter is used only in a model of a flow device
described by the hydraulic table (BHPTAB or
BHITAB). The default value of this parameter is
pres Pressure applied in the flash calculations for the
determination of volumetric rates, psia (kPa). This
parameter is used only in a model of a flow device
described by the hydraulic table (BHPTAB or
BHITAB). The default value of this parameter is
IPVTW Alpha label designating that a water PVT table
number or a water PVT profile name is to be read.
ipvtw Water PVT property table number or water PVT
property profile name (Section 10.15.1) from which
water PVT calculations in the flow device are
performed. For the first flow device in the link, default
is one. For all other devices in the link, default is the
table number or profile name of the previous device.

Examples:
C
C Link definitions.
C
LINK 1 LINK1
C NN Name Type Numberr_Devices Pressure_Correction
1 PIPE4 PIPE 1 0.
2 PIPE5 PIPE 2 2.
3 VALVE1 VALVE 2 5.
LINK 2 LINK2
1 1 BHPTAB 1 0
LINK 3 LINK3
1 1 BHLTAB 1 10.
LINK 4 LINK4
1 1 BHPTAB 1 0. IBAT -1

10.10 Node Data (NODES)

The following information about nodes of the surface pipeline network system are
input after the NODES keyword:
• node name and number,
• name and level of the “normal” VIP well management structure (gathering
center, flow station, area, or field) which corresponds to the node,
• pressure system assigned to the node,
• number of a separator battery attached to the node,
• rate and pressure constraints at the node,
• parameters of a partial fluid separation in the node.
NOTE: Before using the injection network option, please read

“Understanding Injection Network Allocations and Node Pressures in
VIP” on page 10-574.
NODES
..
Definitions:
NN Alpha label indicating that the node number is input in

this column.
num Node number. The node numbers must be input in
increasing order.
param Alpha labels of those node parameters being defined.
The following parameters can be input: NAME,
WMN, WML, PRSYS, IBAT, QO, QG, QW, QL,
PMIN, PMAXI, TEMP, QOMIN, QGMIN, FRO,
FRG, FRW, FRGFO, GASSPM, REMOVE, REINJ,
PTARG. See Section 10.19.5 for additional parameters
related to the well optimization option.
NAME Node name.

WMN Name or number of the gathering center, flow station,

area, or field which corresponds to the node. Default is
zero.
WML Level of the VIP well management structure which
corresponds to the node:
GATHER Gathering Center;
FLOSTA Flow Station;
AREA Area;
FIELD Field.
Default value is GATHER.
PRSYS Name or number of the pressure system assigned to
the node. This parameter is applicable only if the
predictive well management option (PREDICT NEW)
is used. Default is one.
IBAT Number of the separator battery attached to the node.
The corresponding separator battery model is used for
the determination of the fluid volumetric rates at the
node. If a negative value is input, the default separator
is used. Default is one if separator battery one is
defined. Otherwise, default is -1.
QO Maximum produced oil rate at the node, STB/D
(STM3/D). Default is 1.E+15.
QG Maximum produced or injected gas rate at the node,
MSCF/D (SM3/D). Default is 1.E+15.
QW Maximum produced or injected water rate at the node,
STB/D (STM3/D). Default is 1.E+15.
QL Maximum produced liquid rate at the node, STB/D
(STM3/D). Default is 1.E+15.
PMIN Minimum pressure for production nodes, psia (kPA).
Default is -1.E+9, meaning no constraint. Input value
must not be less than 14.7 psia.
PMAXI Maximum pressure for injection nodes, psia(KPA).
Default is 1.E+9.
TEMP Fluid temperature in the node, oF (oC), for the
in the NETPAR card). This value replaces the
internally calculated value of fluid temperature.

QOMIN Minimum oil rate at the node, STB/D (STM3/D). If

the oil rate in the node outlet is less than the minimum
value and potential node connections (OUTCN2, etc.)
are defined in the NODCON card, then the active node
connection can be automatically changed. Only
potential node connections will be considered. Next
potential connection will be selected as the active
connection if pressure in the corresponding output
node is less than pressure in the current output node.
Default is -1.E+9.
QGMIN Minimum gas rate at the node, MSCF/D (SM3/D). If
the gas rate in the node outlet is less than the minimum
value and potential node connections (OUTCN2, etc.)
are defined in the NODCON card, then the active node
connection can be automatically changed. Only
potential node connections will be considered. Next
potential connection will be selected as the active
connection if pressure in the corresponding output
node is less than pressure in the current output node.
Default is -1.E+9.
FRO Fraction of the oil rate in the node inlet supplied to the
node outlet. The inlet oil rate is calculated using the
separator model (IBAT) assigned to the node. It is
assumed that the remaining fraction (1-FRO) of the
inlet oil rate is partially separated in the node. Default
is one.
FRG Fraction of the gas rate in the node inlet supplied to the
node outlet. The inlet gas rate is calculated using the
separator model (IBAT) assigned to the node. It is
assumed that the remaining fraction (1-FRG) of the
inlet gas rate is partially separated in the node. Default
is one.
FRW Fraction of the water rate in the node inlet supplied to
the node outlet. It is assumed that the remaining
fraction (1-FRW) of the inlet water rate is partially
separated in the node. Default is one.
FRGFO Oil rate fraction. If FRGFO is entered, the gas rate in
the node outlet is calculated as the FRGFO fraction
times the oil rate in the node inlet. The outlet gas rate
is also limited by the inlet gas rate. If both FRG and
FRGFO fractions are input, then the gas rate in the
node outlet is determined as the maximum value of the
inlet gas rate multiplied by FRG and the inlet oil rate
multiplied by FRGFO.

GASSPM Maximum rate of gas that can be partially separated in

the node, MSCF/D (SM3/D). All gas in excess of the
maximum gas separation capacities is supplied to the
output flow line of the node. Default value is 1.E+15.
REMOVE Well rate modifier indicator. If YES is entered and the
node is assigned to a well management level using
keywords WML and WMN, then gas rates and/or
water rates of all production wells connected to the
node will be adjusted for targeting calculations taking
into account gas and/or water partial separation in the
node. The REMOVE YES option can be applied only
in the node assigned to the gathering center
(GATHER) well management level. Default is NO,
meaning that the well production rates are not to be
adjusted.
REINJ Gas re-injection indicator. If YES is entered and the
node is assigned to a well management level using
keywords WML and WMN, then gas partially
separated in the node will be available for re-injection
in the corresponding well management level. The
REINJ YES option can be applied only in the node
assigned to the gathering center (GATHER) well
management level. Default is NO.
PTARG YES indicates that any constraints specified in this
NODES data (parameters QO, QG, QW, QL) are
interpreted as if read on PTARG cards (Section 4.3.1.)
The well management level and number are specified
using parameters WML and WMN, respectively. The
parameter WMN is required when PTARG is entered.
A gas production constraint entered in this manner
includes gas lift gas unless the GASLIF parameter on
the NETPAR card (Section 10.17) is set to zero. The
value NO indicates to use the standard surface pipeline
network algorithm. NO is the default if the PTARG
parameter is not entered.
Examples:
C
C Node parameter input.
C
NODES
NN NAME IBAT PMIN
1 NODE1 1 -1.E+9
2 NODE2 2 -1.E+9
3 NODE3 1 1620.

C
NODES
NN NAME QO QL
4 NODE4 26500 1.E+15
C
C Gas partial separation in Node 5.
C
NODES
NN NAME WMN WML IBAT FPG GASSPM REMOVE QL
5 NODE5 1 GATHER 3 0.2 20000 YES 3000
10.10.1 Gas Partial Processing Optimization (PPOPT)

A gas partial processing optimization procedure is implemented. The procedure is
executed in the first num_out outer iterations of the next timestep after input of
the PPOPT card. An optimum fraction of gas supplied to an output flow line of
each node with partial processing is determined. This fraction is applied in
timesteps between the partial processing optimization calculations. The optimum
gas fraction is determined minimizing an objective function subject to constraints
on maximum amount of the separated gas and minimum fraction of gas supplied
to the node output flow line. The objective function is determined as a linear
combination of the field oil, gas, and water rates with the user-supplied
coefficients. The optimum control problem is sequentially solved for each node
for which GASSPM and FRG/FRGFO data was entered in the NODES card.
The PPOPT card must be input to apply the gas partial processing optimization
procedure. The coefficients of the objective function and number of outer
iterations in which the optimization procedure is executed are input in this card. If
PPOPT OFF is input, the optimum partial separation fractions, calculated in the
previous execution of the optimum gas partial processing optimization procedure,
will be ignored, and the “normal” partial processing algorithm will be executed.
ON num out oil coef gas coef water coef

PPOPT
OFF
Definitions:
num_out Number of outer iterations in which the partial

processing optimization will be executed.
oil_coef Coefficient of field oil production term in the
objective function.
gas_coef Coefficient of field gas production term in the
objective function.

water_coef Coefficient of field water production term in the

objective function.
Example:
C
C Execute the partial processing optimization procedure in
C three outer iterations of the next time step.
C Use field oil production as the objective function.
PPOPT ON 3 1 0 0

10.11 Node Connection Data (NODCON)

The NODCON card is used to define output connections for each node of the
surface pipeline network model.
NODCON
NODE param1 param2 . . . paramn
nm1 value11 value21 . . . valuen1
nm2 value12 value22 . . . valuen2
.
.
.
nmm value1m value2m . . . valuenm
Definitions:
NODE Alpha label indicating that this column will contain a

name or number of a node.
nm Name or number of the node. A value of NN or a
NAME parameter previously defined in the NODES
card should be used in this column.
The following parameters can be input: OUTCON,
OUTNOD, OUTCNT, SPFCT, OUTCN2, OUTND2,
OUTCT2, SPFCT2, OUTCN3, OUTND3, OUTCT3,
SPFCT3, OUTCN4, OUTND4, OUTCT4, SPFCT4,
OUTCN5, OUTND5, OUTCT5, SPFCT5, OUTCN6,
OUTND6, OUTCT6, SPFCT6, IPVT, IPVTW.
OUTCON Name or number of the output connection. A value of
NN or a NAME parameter from the PIPES, TUBING,
or VALVE cards should be used in this column. Also,
a link name (link_name) or number (link_number)
from the LINK card can be input.
OUTNOD Name or number of the output node. A value of NN or
a NAME parameter from the NODES card should be
used in this column. The output connection defined in
column “OUTCON” links the node from column
“NODE” and the node from column “OUTNOD”.
OUTCNT Output connection type:
PIPE,
TUBING,
VALVE,
LINK.

Default is PIPE.
SPFCT Fluid splitting factor for the output connection.
Default is 1.
OUTCNi, Name or number of additional output connections. A
i = 2, 3, 4, 5, 6 value of NN or a NAME parameter from the PIPES,
TUBING, or VALVE cards should be used in this
column. Also, a link name (link_name) or number
(link_number) from the LINK card can be input.
OUTNDi, Name or number of additional output nodes. A value
i = 2, 3, 4, 5, 6 of NN or a NAME parameter from the NODES card
should be used in this column. The output connection
defined in column “OUTCNi” links the node from the
column “NODE” and the node from column
“OUTNDi”.
OUTCTi, Type of additional output connections.
i = 2, 3, 4, 5, 6
PIPE,
TUBING,
VALVE,
LINK.
Default is PIPE.
SPFCTi, Fluid splitting factor for the output connections. A
i = 2, 3, 4, 5, 6 non-zero value indicates the output connection is
active. The non-zero splitting factors are normalized to
the value one. Default is zero.
IPVT Flash calculations in the output connection are
performed using the "table" ipvt.
IPVTPR).
table number.
Default is one.
IPVTW Water PVT property table number or water PVT
water PVT calculations in the output connection are
performed. Default is one.

Examples:
C
C Nodes connection input.
C
NODCON
NODE OUTNOD OUTCON OUTCNT
NODE1 NODE3 PIPE1 PIPE
NODE2 NODE3 PIPE2 PIPE
NODE3 NODE4 3 PIPE
C
C Node connection switching in Node 5
C
NODES
NN NAME PMIN IBAT QOMIN
4 NODE4 650 1 -1.E+9
5 NODE5 -1.E+9 1 10000.
6 NODE6 165 2 -1.E+9
C
C “Active” and “potential” connections for Node 5.
C
NODCON
NODE OUTNOD OUTCON OUTND2 OUTCN2
NODE5 4 PIPE3 NODE6 PIPE3

10.12 Lift Gas Composition (YINJA)

The YINJA card is used to specify the lift gas composition for production wells.
It is assumed that the DISSOL fraction of the gaslift gas has the composition
specified in the YINJA card. The composition of the other part of the gaslift gas is
assumed to be equal to the composition of the produced gas. The DISSOL fraction
can be input in the WELCON card(s).
YINJA wl
yinja1 yinja2... yinjanc
Definitions:
wl List of production wells for which lift gas

compositions are being specified (see Section 1.5.2).
yinjak The mole fraction of component k in the lift gas
stream. A value must be specified for each of the
components and the values must sum exactly to 1.0.

10.13 Well Connection Data (WELCON)

Data of well connections are input after the WELCON keyword, including tubing
connections (from wellbore to wellhead) and well connections to nodes of the
surface pipeline network system.
WELCON
WELL param1 param2 . . . paramn
wn1 value11 value21 . . . valuen1
wn2 value12 value22 . . . valuen2
.
.
.
wnm value1m value2m . . . valuenm
Definitions:
WELL Alpha label indicating that a name or number of a

production or injection well is input in this column.
wn Name or number of a production or injection well.
The following parameters can be input: TUBCON,
TUBCNT, IPVTTB, WDZ, WDAT, WELHEAD,
OUTCON, OUTNOD, OUTCNT, SPFCT, OUTCN2,
OUTCN3, OUTCN4, OUTCN5, OUTCN6,
OUTND2, OUTND3, OUTDN4, OUTND5,
OUTND6, OUTCT2, OUTCT3, OUTCT4, OUTCT5,
OUTCT6, SPFCT2, SPFCT3, SPFCT4, SPFCT5,
SPFCT6, GLVDZ, DISSOL, IPVTOC, BHTEMP,
IPVTWT, IPVTWC.
TUBCON Name or number of well tubing connection:
A value of NN or a NAME parameter from the PIPES,
TUBING, or VALVE card;
A link name (link_name) or number (link_number)
from the LINK card.
TUBCNT Tubing connection type:
PIPE,
TUBING,
VALVE,
LINK.
Default is TUBING.

IPVTTB Flash calculations in the well tubing are performed

using the "table" ipvt.
IPVTPR).
table number.
Default is one.
WDZ Subsea depth of the first perforation, ft (m).
WDAT Subsea depth to which the flowing bottomhole
pressure is referenced, ft (m).
WELHEAD Wellhead subsea depth, ft (m). A negative value
should be input if a depth above sea level is desired.
OUTCON Name or number of the output connection. A value of
NN or a NAME parameter from the PIPES, TUBING,
or VALVE cards should be used in this column. Also,
a link name (link_name) or number (link_number)
from the LINK card can be input.
OUTNOD Name or number of the output node. A value of the
NN or a NAME parameter from the NODES card
should be used in this column. The output connection
defined in column “OUTCON” links the well from
column “WELL” and the node from column
“OUTNOD”.
OUTCNT Output connection type:
PIPE,
TUBING,
VALVE,
LINK.
Default is PIPE.
SPFCT Fluid splitting factor for the output connection.
Default is one.
OUTCNi, Name or number of additional output connections. A
i=2,3,4,5,6 value of NN or a NAME parameter from the PIPES,
TUBING, or VALVE cards should be used in this
column. Also, a link name (link_name) or number
(link_number) from the LINK card can be input.

OUTNDi, Name or number of additional output nodes. A value

i=2,3,4,5,6 of NN or a NAME parameter from the NODES card
should be used in this column. The i-th output
connection defined in column “OUTCN(i)” links the
well from column “WELL” and the node from column
“OUTND(i)”.
OUTCTi, Type of additional output connections:
i=2,3,4,5,6
PIPE,
TUBING,
VALVE,
LINK.
Default is PIPE.
SPFCTi, Fluid splitting factor for the output connection. A non-
i=2,3,4,5,6 zero value indicates the output connection is active.
The non-zero splitting factors are normalized to the
value one. Default is zero.
GLVDZ Subsea depth of the gaslift valve, ft (m).
DISSOL Percent of the lift gas that dissolves in the well fluid.
IPVTOC Flash calculations in the output connections are
performed using the "table" ipvt.
IPVTPR).
table number.
Default is one.
BHTEMP Bottomhole temperature, 0F (oC). This parameter is
used only if the heat transfer analysis is applied for the
determination of the temperature distribution in well
tubing string. Default is an ambient temperature in the
well bottomhole.
IPVTWT Water PVT property table number or water PVT
water PVT calculations in the well tubing are

IPVTWC Water PVT property table number or water PVT

water PVT calculations in the output connections are
NOTE: When the WELCON card is used in combination with the ITUBE/TUBE
card for a production or injection well, the dzw parameter on the ITUBE/
TUBE card means subsea depth of the first perforation.
NOTE: Well “potential” connections OUTND(i), i=2,3,4,5,6 are applied only if the
surface pipeline network option is used in combination with the predictive
well management option (PREDICT NEW). In this case, the predictive well
management option is used for the well allocation to the pressure systems.
Well connections to nodes are automatically modified after the well
allocation to the pressure systems. Well management levels and pressure
systems must be defined for all “potential” nodes in the NODES cards using
keywords WML, WMN, and PRSYS.
Examples:
C
C Well connection input.
C
WELCON
WELL TUBCON TUBCNT OUTNOD OUTCON OUTCNT
1 TUBIN1 TUBING NODE1 LINK1 LINK
4 TUBIN2 TUBING NODE2 PIPE5 PIPE
5 LINK2 LINK NODE3 LINK1 LINK
C
C “Active” and “potential” connections of Well 7.
C
WELCON
WELL TUBCON TUBCNT OUTNOD OUTCON OUTND2 OUTCN2
7 LINK3 LINK NODE5 PIPE3 NODE2 PIPE3
C
C Flow in tubing of Well 6 is described by Hydraulic Table 1.
C
ITUBE 6
1
8335
WLWDAT 6
8300
C
WELCON
WELL OUTNOD OUTCON OUTCNT

6 NODE5 PIPE6 PIPE

C
C 2 "active" connections with equal fluid distributions of well 8.
C
WELCON
WELL TUBCON TUBCNT OUTNOD OUTCON OUTND2 OUTCN2 SPFCT2
8 LINK3 LINK NODE5 PIPE3 NODE2 PIPE3 1.0

10.14 Satellite Field Production Data (NODSOURCE and

SOUCOM)
In some cases, production from several reservoir oil fields are processed in shared
surface facilities. An option has been implemented to represent production from
satellite oil fields in integrated reservoir and surface pipeline network modeling.
Oil, gas, and water rates of the satellite oil fields and their fluid compositions can
be input as functions of time using the NODSOURCE and SOUCOM cards.
Satellite production modeling impacts pressure drop calculations in flow lines and
the targeting procedure in different well management levels, because satellite
production increases the amount of fluids supplied to pipelines and different
levels of the well management structure.
NODSOURCE
NODES node1 node2 . . . noden
(OIL oil_rate1 oil_rate2 . . . oil_raten)
(GAS gas_rate1 gas_rate2 . . . gas_raten)
(WATER water_rate1 water_rate2 . . . water_raten)
Definitions:
node Name or number of a node to which a satellite field is

connected. The node must have been defined in the
NODES card as a value of NN or a NAME parameter.
oil_rate Oil rate of the satellite field connected to the node,
STB/D (STM3/D).
gas_rate Gas rate of the satellite field connected to the node,
MSCF/D (SM3/D).
water_rate Water rate of the satellite field connected to the node,
STB/D (STM3/D).
NOTE: If some node with satellite connections is assigned to a well management

level using keywords WML and WMN in the NODES card, the satellite
production will be added to the production in this level and all higher levels.
Otherwise, the satellite production will not be added to the production in
different well management levels and it only impacts pressure drop
calculations in flow lines.

Example:
NODSOURCE
NODES NODE1
OIL 8537
GAS 18636
WATER 5751
SOUCOM node
comp1 comp2 . . . compnc
Definitions:
node Name or number of a node to which a satellite field is

connected. The node must have been defined in the
NODES card as a value of NN or a NAME parameter.
compk Molar fraction of the k-th hydrocarbon component in
satellite field fluids, fraction.
NOTE: NC molar fractions must be input. They can be input in several lines. The
sum of the molar fractions must be equal to one.
Example:
SOUCOM NODE1
0.0059000 0.4185992 0.0444999 0.0318999 0.0124000 0.0157 0.0179
0.0803058 0.1127808 0.0882468 0.1085218 0.0632459

10.15 Production Fluids from Different PVT Units

Production fluids from different PVT regions (PVT units) are modeled in the
surface pipeline network.
10.15.1 Water PVT Profile (SPNPVW)

The SPNPVW card is used to define a water PVT profile. Water density and
viscosity are a function of pressure and, optionally, temperature.
SPNPVW iprof nmprof

PRESSURE pres1 pres2 ... presk
(TEMP temp1 temp2 ... tempm
IPRES (ITEMP) DENS VIS
ip1 (it1) dens1 vis1
. ( . ) . .
. ( . ) . .
. ( . ) . .
ipk (itm) denskm viskm
Definitions:
iprof Number of the water PVT profile table being read.

nmprof Water PVT profile name.
this card.
spaced.
TEMP Alpha label indicating that temperature values are read
on this card. This card is optional.
temp Temperature values, oF (oC). Values can be unequally
spaced.
IPRES Alpha label indicating that the values read in the
column under this heading are reservoir pressure
indices.
ITEMP Alpha label indicating that the values read in the
column under this heading are temperature indices.
This label can be included only if a TEMP card was
input.
DENS Alpha label indicating that the values read in the
column under this heading are densities.

VIS Alpha label indicating that the values read in the

column under this heading are viscosities.
ipk Index refering to the k-th pressure value read.
itm Index refering to the m-th temperature value read.
This index can be included only if a TEMP card was
input.
denskm The density value corresponding to the indicated
pressure (and temperature) value(s), gm/cc.
viskm The viscoity value corresponding to the indicated
pressure (and temperature) value(s), cp.
Example:
SPNPVW 1 WPR1
PRESSURE 14.7 8000
TEMP 60 160
IPRES ITEMP DENS VIS
1 1 1.02 1.17
2 1 1.05 1.14
1 2 1.00 0.42
2 2 1.02 0.45
10.15.2 Surface Network PVT Unit (SPNPVT)

The SPNPVT card is used to assign hydrocarbon and water PVT tables to PVT
units.
SPNPVT mu
un1 un2) ... unmu
ipvt1 ipvt2) ... ipvtmu
ipvtw1 ipvtw2) ... ipvtwmu
Definitions:
mu Total number of PVT units. If mu is zero, the SPN

PVT Unit option will not be activated.
un List of PVT units.
ipvt Hydrocarbon PVT table numbers or PVT profile
names assigned to the corresponding PVT units.
ipvtw Water PVT table numbers or water PVT profile names
(Section 10.15.1) assigned to the corresponding PVT
units.

Example:
SPNPVT 5
1 2 3 4 5
PRF1 PRF2 1 2 3
WPR1 WPR1 WPR1 1 1
10.15.3 Well PVT Unit (SPNPTU)

The SPNPTU card is used to assign PVT unit numbers to wells.
SPNPTU wl
un1 un2 . . . unn
Definitions:
wl List of wells for which PVT unit numbers are being

pres PVT unit numbers.
FPERF
WELL . . . . (SPNPTU) . . . .
. . . . (spnptu) . .
Definitions:
SPNPTU Column heading for spnptu, the SPN PVT unit for this
well perforation. Default is the well’s PVT unit if the
SPNPTU (Section 10.15.3) card for the well is specified.
Otherwise, default is the gridblock’s equilibium region
number.

10.16 Pseudo Well Option

In some cases, sections of an oil/gas field are not represented in a reservoir model
but wells located in these sections are connected to the surface pipeline network
system. The pseudo well option has been implemented to represent production
from wells (which are not included in the reservoir model) using well inflow
correlations. The pseudo well option also can be used for satellite oil field
modeling. In this case, each satellite oil field should be represented as a pseudo
well.
The pseudo well option has been implemented only for production wells.
As a minimum, the following input are required for modeling each pseudo well:
• the WELL card to assign a gathering center and a separator battery,
• the PROD card to define the well type,
• the FPERF card. Default values of reservoir pressure and fluid composition in
the pseudo well are computed as averaged values from the perforated
gridblocks defined with this card. The PSEUPRES and PSEUXY cards can be
used to overwrite the default values,
• the QMAX card to set the maximum production rate,
• three BHITAB tables to use in the well inflow performance correlations,
• the PSEUTAB card to assign the corresponding well inflow correlations (the
BHITAB tables) to the pseudo well.
In addition, most well management options (for example, BHP, THP, QMIN,
ITUBE, WELCON, etc) can be used for the pseudo wells.
The production from the pseudo well can be included in the reservoir material
balance calculations using the PSEUWS card(s). Also, the PSEUWS card can be
used to convert a pseudo well to a “normal” production well or a “normal” well to
a “pseudo” well.
The following three well inflow correlations must be defined for each pseudo
well:
1. Bottomhole pressure as a two-dimensional tabular function of resevoir

pressure and production rate (oil, gas, water, or liquid).
2. Gas-oil ratio (or gas-liquid ratio, or oil-gas ratio) as a two-dimensional tabular

function of resevoir pressure and production rate (oil, gas, water, or liquid).
3. Water cut (or water-gas ratio) as a two-dimensional tabular function of

resevoir pressure and production rate (oil, gas, water, or liquid).

Also, a special option has been provided to define tubinghead pressure as a tabular
two-dimensional function of resevoir pressure and production rate (oil, gas,
water, or liquid). For this option, a tubing string model must be assigned to the
pseudo well in the WELCON card. The simulator internally calculates bottomhole
pressure for each entry of the two-dimensional BHITAB table. Then, it determines
parameters of Bendakhia and Aziz’s inflow performance relationships (see SPE
Paper 19823: H. Bendakhia and K. Aziz “Inflow Performance Relationships for
Solution-Gas Drive Horizontal Wells” presented in the 64th Annuak Technical
Conference and Exhibition held in San Antonia, TX, October 8-11, 1989) using a
curve fitting procedure.
10.16.1 Inflow Performance Correlations (BHITAB)

Three inflow performance correlations must be defined for each pseudo well:
BHP/THP, GLR/GOR/OGR, and WCUT/WGR.
⎛ O ⎞
⎜ G
⎟
BHITAB nbhi ⎜ ⎟
⎜ W ⎟
⎝ L ⎠
QI q1 q2 ... qk
QLIFT g1 g2 ... gk
PRES p1 p2 ... pn
BHP ( IQ )
THP ( IQ )
GLR ( IQ )
IPRES GOR ( IQ )
OGR ( IQ )
WCUT ( IQ )
WGR ( IQ )
ipres1 par(iq1) par(iq2) ... par(iqk)

...
...
...
ipresn par(iq1) par(iq2) ... par(iqk)
Definitions:
nbhi Number of the inflow performance table being read.

O Alpha label indicating that oil rates are entered on the
QI line. This is the default.

G Alpha label indicating that gas rates are entered on the

QI line.
W Alpha label indicating that water rates are entered on
the QI line.
L Alpha label indicating that liquid rates are entered on
the QI line.
QI Alpha label indicating that values on this card are
production rates.
q Production rates; oil, water and liquid, STB/D (STM3/
D), or gas MSCF/D (SM3/D). Values can be
unequally spaced and must increase monotonically.
QLIFT Alpha label indicating that values on this card are
gaslift gas rates.
g Gaslift gas rates, MSCF/D (SM3/D). The number of
values must equal the number of values on the QI
card.
PRES Alpha label indicating that values on this card are
reservoir pressure.
p Reservoir pressure values, psia (kPa). Values can be
unequally spaced and must increase monotonically.
IPRES Alpha label indicating that the values read in the
column under this heading are reservoir pressure
indices.
BHP(IQ) Alpha label indicating that the values read in the
column under this heading are bottomhole pressure
values for each production rate input. Parentheses
must appear in this alpha label.
THP(IQ) Alpha label indicating that the values read in the
column under this heading are tubinghead pressure
values for each production rate input. Parentheses
must appear in this alpha label. The simulator
internally calculates bottomhole pressure for each
entry of the two-dimensional BHITAB table. Then, it
determines parameters of Bendakhia and Aziz’s
inflow performance relationships using a curve fitting
procedure.
GLR(IQ) Alpha label indicating that the values read in the
column under this heading are gas-liquid ratio values
for each production rate input. Parentheses must

GOR(IQ) Alpha label indicating that the values read in the

column under this heading are gas-oil ratio values for
each production rate input. Parentheses must appear in
this alpha label.
OGR(IQ) Alpha label indicating that the value read in the
column under this heading are oil-gas ratio values for
this alpha label.
WCUT(IQ) Alpha label indicating that the values read in the
column under this heading are water cut values for
this alpha label.
WGR(IQ) Alpha label indicating that the values read in the
column under this heading are water-gas ratio values
for each production rate input. Parentheses must
ipresn Index refering to the n-th reservoir pressure entry
read.
par(iq) Value of corresponding parameter,
psia (kPa) if BHP or THP;
SCF/STB (SM3/STM3) if GLR or GOR;
STB/SCF (STM3/SM3) if OGR;
fraction if WCUT;
STB/SCF (STM3/SM3) if WGR;
for corresponding production rate. The corresponding
production rate is the q value that would correspond to
iq. The number of parameter values on this card must
equal to the number of q values on the QI card.
NOTE: 1. Liquid rate (L) must be used with gas-liquid ratios (GLR(IQ)).
Oil rate (O) must be used with gas-oil ratios (GOR(IQ)).
Gas rate (G) must be used with oil-gas ratios (OGR(IQ)).
Liquid rate (L) or oil rate (O) must be used with water cuts
(WCUT(IQ)).
Gas rate (G) must be used with water-gas ratios (WGR(IQ)).
2. When tubinghead pressures (THP(IQ)) are input, the first rate entry q1
must be zero.
3. QLIFT data may only be entered when tubinghead pressures (THP(IQ))

are input.
4. Bottomhole pressures/tubinghead pressures may not exceed the

maximum reservoir pressure pn.
5. A tubinghead pressure correlation may be assigned to only one pseudo

well.

Example:
C Inflow performance Curve for Well TB04

BHITAB 26 O
QI 140 280 420 560 700 840 980 1120 1260 1400
PRES 4604
IPRES BHP(IQ)
1 4509 4410 4310 4211 4112 4012 3913 3813 3714 3614
C
C Gas-Oil Ratio Curve for Well TB04
BHITAB 27 O
QI 140 280 420 560 700 840 980 1120 1260 1400
PRES 4604
IPRES GOR(IQ)
1 1289 1330 1344 1350 1354 1356 1358 1360 1361 1362
C
C Water Cut Curve for Well TB04
BHITAB 28 O
QI 140 280 420 560 700 840 980 1120 1260 1400
PRES 4604
IPRES WCUT(IQ)
1 .598 .674 .693 .702 .707 .711 .713 .715 .716 .717
10.16.2 Correlation Assignments (PSEUTAB)

Assignments of inflow performance correlations (BHITAB tables) to each pseudo
well are input using the PSEUTAB card.
PSEUTAB well ibhp ig iw
Definitions:
well Well name or well number of a pseudo well.

ibhp BHITAB table number which defines bottomhole
pressure or tubinghead pressure as a tabular function
of production rate and reservoir pressure (BHP(IQ) or
THP(IQ)).
ig BHITAB table number which defines gas-liquid ratio,
or gas-oil ratio, or oil-gas ratio as a tabular function of
production rate and reservoir pressure (GLR(IQ), or
GOR(IQ), or OGR(IQ)).
iw BHITAB table number which defines water cut or
water-gas ratio as a tabular function of production rate
and reservoir pressure (WCUT(IQ) or WGR(IQ)).

Example:
PSEUTAB TB04 26 27 28
10.16.3 Reservoir Pressure (PSEUPRES)

Reservoir pressure used in inflow performance correlations for pseudo wells can
be input using the PSEUPRES card.
PSEUPRES wl
pres1 pres2 . . . presn
Definitions:
wl List of pseudo wells for which reservoir pressure

pres Reservoir pressure value, psia (kPa), used in inflow
performance correlations for the corresponding
pseudo well. If a value of –1 is entered as a reservoir
pressure or the PSEUPRES card is not entered for a
pseudo well, the average reservoir pressure in
gridblocks with open well perforations is used.
Example:
PSEUPRES TB04 TB06 TB07

4604 4700 -1
10.16.4 Compositions (PSEUXY)

Compositions of liquid and vapor hydrocarbon phases for pseudo wells can be
input using the PSEUXY card.
PSEUXY wl
x1 x2 ... xk ... xnc
y1 y2 ... yk ... ync
Definitions:
wl List of pseudo wells for which compositions of liquid

and vapor hydrocarbon phases are being entered (see
Section 1.5.2).

xk Molar fraction of the k-th hydrocarbon component in

the liquid phase of fluids produced in the
corresponding pseudo wells, fraction. If a value of -1
is entered as the first component fraction or the
PSEUXY card is not entered for a pseudo well, the
average values of the compositions in gridblocks with
open well perforations are used.
yk Molar fraction of the k-th hydrocarbon component in
the vapor phase of fluids produced in the
corresponding pseudo well, fraction.
Example:
PSEUXY TB04 TB06

.8934337E-01 .4506625E+00 .5055475E-01 .3244427E-01 .5654376E-02 >
.1570380E-01 .1594286E-01 .7097116E-01 .9432530E-01 .6633679E-01 >
.6332303E-01 .4473776E-01
.1156343E+00 .7543256E+00 .5447269E-01 .2560875E-01 .3748278E-02 >
.9230980E-02 .6947261E-02 .1682564E-01 .1040004E-01 .2378132E-02 >
.4222647E-03 .6095310E-05
PSEUXY TB07
-1 0 0 0 0 0 0 0 0 0 0 0
100000000000
10.16.5 Well Status (PSEUWS)

The production from pseudo wells can be included in the reservoir material
balance calculations using the PSEUWS card(s). Also, the PSEUWS card can be
used to convert pseudo wells to “normal” production wells or “normal”
production wells to “pseudo” wells.
TABLE ⎛ IGNORE ⎞
PSEUWS ⎝ INCLUDE ⎠ wl
NORMAL
Definitions:
wl List of pseudo wells for which data is being entered

TABLE Alpha label indicating that the wells in the specified
list are to be considered as “pseudo” wells.
NORMAL Alpha label indicating that the pseudo wells in the
specified list are to be considered as “normal”
production wells.

IGNORE Alpha label indicating that production from the pseudo

wells in the specified list is to be excluded from
reservoir material balance calculations. This option is
not compatible with NORMAL.
INCLUDE Alpha label indicating that production from the wells
in the specified list is to be included in reservoir
material balance calculations.
NOTE: If the PSEUTAB cards are used for some production wells these wells are
considered as pseudo wells and inflow performance correlations are applied
from production modeling in these wells. In some time during the
simulation, you can switch these wells to “normal” wells using the PSEUWS
card(s). Later you can convert them back to the pseudo wells (again applying
the PSEUWS cards) if it is required.
The IGNORE option can be applied only for pseudo wells.
Example:
PSEUWS NORMAL TB04 TB05

PSEUWS TABLE INCLUDE TB07

10.17 General Parameters of the Surface Pipeline Network System

(NETPAR)
General parameters of the surface pipeline network system can be divided into the
following groups:
• default parameters of pressure calculations in pipes and well tubing strings

(YOUNG, PRESIN),
• parameters and tolerances which are used in the phase-equilibrium

calculations (TOLRKV, TOLRTC, TOLRPC, TOLRSP, TOLCP, TOLCMC,
MAXFLI, MAXSSI),
• parameters and tolerances that are applied for the determination of the
pressure distribution in the surface pipeline network system (PS, TS, TNET,
MAXNIT, PRRTOL, RTRTOL, TIMEIN, TIMEST, OUTITR, GASLIF,
OUTFIL, FRLOSS),
• parameters of the simplified heat transfer analysis option for production

networks only (HEATTR, SHCOIL, SHCGAS, SHCWAR, HTCPIPE,
HTCTUB),
• pressure gradient correction factors (GRPGCR, FRPGCR, ACPGCR), and
• parameters used for sonic velocity calculations (SVLOIL, SVLGAS,

SVLWAT).
NETPAR
param1 param2 . . . paramn
value1 value2 . . . valuen
Definitions:

The following parameters can be input:
YOUNG, PRESIN,
TOLRKV, TOLRTC, TOLRPC, TOLRSP, TOLCP,
TOLCMC, MAXFLI, MAXSSI,
PS, TS, TNET, MAXNIT, PRRTOL, RTRTOL,
TIMEIN, TIMEST, OUTITR, GASLIF, OUTFIL,
FRLOSS,
HEATTR, SHCOIL, SHCGAS, SHCWAT,
HTCPIPE, HTCTUB,
GRPGCR, FRPGCR, ACPGCR,

SVLOIL, SVLGAS, SVLWAT

PIPE AND TUBING DEFAULT PARAMETERS
YOUNG Default value of the Young modules (see descriptions
of the YOUNG keyword in the PIPES and TUBING
cards), million psia (million kPa). Default is 30.E+6
psia.
PRESIN Default value of the pressure increment (see
descriptions of the PRESIN keyword in the PIPES and
TUBING cards), psia (kPa). Default is 400 psia.
PARAMETERS OF FLASH CALCULATIONS
MAXFLI Maximum number of iterations allowed for phase-
equilibrium calculations. Default is 20.
MAXSSI Maximum number of successive-substitution
iterations allowed for phase-equilibrium calculations.
The successive-substitution procedure is used as the
preconditioning step in the phase-equilibrium
calculations. Default is 4.
TOLRKV Relative K-value tolerance. It is assumed that the
phase equilibrium calculations converge in an iteration
when the maximum value of relative K-value changes
is less than the tolerance TOLRKV and a matrix of
second derivatives of the Gibbs free energy function is
positive-definite. Default is .005.
TOLCP Chemical potential tolerance. It is assumed that the
phase equilibrium calculations converge in an iteration
when the maximum value of absolute differences
between chemical potentials in liquid and vapor
hydrocarbon phases is less than the tolerance TOLCP
and a matrix of second derivatives of the Gibbs free
energy function is positive-definite. Default is .0001.
TOLRTC Relative temperature tolerance. The phase equilibrium
computations are not repeated if relative changes of
temperature, pressure, and composition are less than
the corresponding tolerances TOLRTC, TOLRPC, and
TOLCMC, and if the relative difference between the
current pressure and the previously calculated
saturation pressure is larger than TOLRSP. Default is
.01.

TOLRPC Relative pressure tolerance. The phase equilibrium

computations are not repeated if relative changes of
pressure, temperature, and composition are less than
the corresponding tolerances TOLRPC, TOLRTC, and
TOLCMC, and if the relative difference between the
.001.
TOLCMC Composition tolerance. The phase equilibrium
computations are not repeated if the maximum value
of composition changes and relative changes of
pressure, and temperature are less than the
corresponding tolerances TOLCMC, TOLRPC, and
TOLRTC, and if the relative difference between a
.001.
TOLRSP Saturation pressure tolerance. The phase equilibrium
computations are not repeated if the relative difference
between the current pressure and the previously
calculated saturation pressure is larger than TOLRSP,
and if relative changes of pressure, temperature, and
composition are less than the corresponding tolerances
TOLRPC, TOLRTC, and TOLCMC. Default is .001.
PARAMETERS OF SURFACE PIPELINE
NETWORK CALCULATIONS
TS Standard temperature, °F (°C). Default is 60°F (15°C).
PS Standard pressure, psia (kPa). Default is 14.65 psia
(101.325 kPa or 1.03353 kg/cm2).
TNET Default value of temperature in nodes of the surface
pipeline network system, °F (°C). Default is 60°F
(15°C).
TIMEIN Time increment between two sequential recalculations
of production rates using the surface pipeline network
option, days. Default is 99999 days.
TIMEST Maximum number of timesteps between two
sequential recalculations of production rates using the
surface pipeline network option. Default is 1.
OUTITR Maximum number of outer iterations in which the
surface pipeline network calculations are executed.
Default is 2.
MAXNIT Maximum number of iterations allowed in the surface
pipeline network calculations. Default is 100.

PRRTOL Relative pressure tolerance. It is assumed that the

surface pipeline network calculations converge if the
relative difference between bottomhole pressure
values on the inflow performance curve (defined by a
wellbore model) and outflow performance curve
(defined by the surface pipeline network model) is less
than the tolerance PRRTOL in any production well
connected to the surface pipeline network system.
Default is .0001.
RTRTOL Relative rate tolerance. It is assumed that the surface
pipeline network calculations converge if the relative
difference between values of the specified rate and the
calculated rate in a node of the surface pipeline
network system is less than the tolerance RTRTOL.
Default is .001.
GASLIF Gaslift indicator. Gaslift rates are included in the
surface pipeline network calculations if the value of
this parameter is one. They are excluded from these
calculations only if a value of zero is input. Default is
one.
OUTFIL Fortran unit number used for the output of the tubing
report. Default is 30.
FRLOSS Friction loss indicator. The friction loss between
perforations of a horizontal or inclined well will be
computed if the value of this parameter is one. It will
be ignored if the value is zero. Default is zero.
PARAMETERS OF HEAT TRANSFER ANALYSIS
(Applies only to production networks.)
HEATTR Heat transfer analysis indicator. This parameter must
be set to one to apply the simplified heat transfer
analysis option for the determination of the
temperature distribution in the network. The option is
not used if the parameter value of zero is input.
Default is zero.
SHCOIL Specific heat capacity of oil, BTU/(lbm*oF)
(J/(kg*oK). This parameter is applied only if the
simplified heat transfer analysis option is used.
Default is 0.53 BTU/(lbm*oF).
SHCGAS Specific heat capacity of gas, BTU/(lbm*oF)

SHCWAT Specific heat capacity of water, BTU/(lbm*oF)

HTCPIPE Default value of heat transfer coefficient of pipes,
BTU/hr*ft2*oF), (W/(m2*oK). This parameter is
applied only if the simplified heat transfer analysis
option is used. Default is 1.0 BTU/(hr*ft2*oF).
HTCTUB Default value of heat transfer coefficient of tubing,
BTU/(hr*ft2*oF), (W/(m2*oK). This parameter is
applied only if the simplified heat transfer analysis
option is used. Default is 3.0 BTU/(hr*ft2*oF).
GRPGCR Correction factor for gravity pressure gradient in pipes
and tubing, fraction. Default is 1.0.
FRPGCR Correction factor for friction pressure gradient in pipes
and tubing, fraction. Default is 1.0.
ACPGCR Correction factor for acceleration pressure gradient in
pipes and tubing, fraction. Default is 0.0.
SVLOIL Sonic velocity of oil, ft/s (m/s). Default is 3000 ft/s.
SVLGAS Sonic velocity of gas, ft/s (m/s). Default is 1200 ft/s.
SVLWAT Sonic velocity of water, ft/s (m/s). The default value is
2700 ft/s.
value Value of the corresponding parameter.
NOTE: In-situ fluid velocity in pipes and tubing strings is limited by the fluid sonic
velocity. The sonic velocity of the multiphase fluid which depends on
properties of oil, gas, and water is calculated using Gould’s method. If the in-
situ fluid velocity in pipes and tubing strings exceeds 95% of the fluid sonic
velocity, it is reduced to this value.
Examples:
C
C General parameter input.
C
NETPAR
PS TS MAXNIT PRRTOL TIMEIN
14.7 60. 30 1.E-4 15

10.18 Output of Surface Pipeline Network Information

Results of the well tubing string and surface pipeline network calculations can be
output in the following reports:
• node report,
• node spreadsheet.
• tubing report, and
• automatic tuning reports (see Chapter 11).
They also can be output in the plot file.
Five-dimensional hydraulic tables can be generated for any well tubing string and/
or any connection between nodes of the surface pipeline network system at any
time during the simulation.
10.18.1 Node Report in Print File

Pressures and rates at different nodes of the surface pipeline network system can
be output in the print file using the modified WLGRP card with the keyword
NODES. The information will be printed for nodes specified after the WLGRP
card. Also, a well report will be output for all production or injection wells
connected to the specified nodes through the surface pipeline system. The
frequency of the node and group report output can be controlled by the PRINT
WLGRP card.
WLGRP grpnum (grpnam) NODES

node_list
Definitions:

character in the name must be alphabetic unless the
NODES Alpha label indicating that node report will be
generated.
node_list List of surface pipeline network nodes belonging to
the group. A value of NN or a NAME parameter from
the NODES card can be input in this list.

Examples:
WLGRP 1 WELLGR1 NODES

NODE1 2 4
WLGRP 2 NODES
5
10.18.2 Node Spreadsheet File (SSSUM)

The SSSUM card, with the NODE keyword, is used to specify options and
variables to appear in the node spreadsheet summary file. See section 6.18 for a
description of the other types of spreadsheet files that may be requested. The
node spreadsheet file is written to FORTRAN Unit 80. The frequency of the
output is controlled by the SSSUM parameter on the PRINT card.
No variables are automatically written to this file. Each must be explicitly

requested.
SSSUM NODE (TAB) (HEADER) varnm1 varnm2 ... varnmn
Definitions:
NODE Alpha label indicating that the subsequent data applies to

the node spreadsheet file.
TAB Alpha label indicating that the columns will be separated

by a tab character. Omission will result in columns
separated by a comma.
HEADER Alpha label indicating that a title line, column header

line, and a units line should be included in the file at each
time.
varnm Alpha label specifying one or more of the following

variables:
NUMBER Node number.
NAME Node name.
TIME Simulation time.
DATE Calendar date.
TSNUM Timestep number.
QGP Gas production rate.
QOP Oil production rate.

QWP Water production rate.
CGP Cumulative gas production.
COP Cumulative oil production.
CWP Cumulative water production.
QGI Gas injection rate.
QWI Water injection rate.
CGI Cumulative gas injection.
CWI Cumulative water injection.
TEMP Node temperature.
PRES Node pressure.
WMLVL Associated well management level.
WMNAME Well management member name.
WMNUM Well management member number.
NOTE: 1. All of the alpha labels must appear on one SSSUM card. If necessary,
the continuation character ‘>‘ can be used.
2. The alpha label NODE must be specified to obtain the node

spreadsheet file.
3. Except for TAB and HEADER, the order of the alpha labels is the
order the variables will appear in the file.
4. Each SSSUM NODE card supercedes and replaces the previous

SSSUM NODE card.

10.18.3 Spreadsheet Node Specification (SPRLIST)

The SPRLIST card is used to specify which nodes are to be included in the node
spreadsheet file.
SPRLIST NODE ON ALL

O FF nodelist
Definitions:
NODE Alpha label indicating that the data on this card applies to
the node spreadsheet file.
ON Alpha label indicating that the specified nodes are to be

included in the spreadsheet file.
OFF Alpha label indicating that the specified nodes are to be

excluded from the spreadsheet file.
all nodes.
nodelist List of nodes to which the data on this card applies.
NOTE: 1. If the SPRLIST card is not entered, all nodes are included in the
spreadsheet file.
2. To restrict the nodes on the spreadsheet file, all nodes must first be
excluded (OFF), then the desired nodes included (ON).

10.18.4 Tubing Report

A tubing report can be output for any set of wells at any time during simulation.
Pressure, temperature, hold-up, flow regime, pressure gradient, in situ velocities,
and densities at different subsea depths of well tubing strings are included in the
report. Values of these variables are printed at the subsea depths defined in the
CURVE ELEVPR card. If the CURVE ELEVPR card is not used for some tubing
segment, the values of the specified variables are printed in the inlet and outlet of
the tubing segment. The tubing report is generated in Fortran unit OUTFIL, which
can be input in the NETPAR card. The default unit number is 30.
The following steps are required to print the tubing report:
1. Group all wells for which the tubing reports must be generated in some well
group using the WLGRP card;
2. Include the TUBING keyword in the WLGRP card;
3. Determine frequencies of the tubing report output in the PRINT WLGRP card.
WLGRP grpnum (grpnam) TUBING

well_list
Definitions:

character in the name must be alphabetic unless the
TUBING Alpha label indicating that tubing report will be
output.
well_list List of wells for which the tubing report will be
generated.
Examples:
WLGRP 3 WELLGR3 TUBING

WELL1 WELL2
PRINT WLGRP TIME

10.18.5 Surface Pipeline Network Information in Plot File

Pressure and rates at different nodes of the surface pipeline network system will
be output in the plot records if the keyword PLOT is included in the Utility Data,
the keyword WPLOT is included in the recurrent data, and:
1. when the vdb file is being written, the SURFACE class of data is requested on
the PLOT card,
2. when the plot file is being written, the GATHER class of data is requested on
the PLOT card.
10.18.6 Generation of Hydraulic Tables (HTOUTPUT)

Five-dimensional hydraulic tables can be generated for any well tubing string and/
or any connection between nodes of the surface pipeline network system at any
time during the simulation. The hydraulic table constructs pressure at the inlet of
the connection (well tubing string or connection between nodes) as a five-
dimensional tabular function of pressure at the outlet of the connection, liquid
rate, gas-oil ratio, water cut, and gas-lift rate. Alternatively, oil or gas rate may be
used instead of the liquid rate, oil-gas ratio may be used instead of the gas-oil
ratio, and water-gas ratio may be used instead of the water cut.
If the HTOUTPUT is requested for some well, the hydraulic table will be
generated for the tubing string of this well. If the HTOUTPUT is requested for
some node, the hydraulic table will be generated for the output connection
between this node and the node of the higher level.
Liquid or gas hydraulic tables can be generated. For the generation of the liquid
hydraulic table, outlet pressure entries (PRESSURE card), liquid or oil rate entries
(QLIQ or QO card), gas-oil ratio entries (GOR card), and water cut entries
(WCUT card) must be input. Optionally, the gas-lift rate entries (GASLIFT card)
may also be input. For the generation of a gas hydraulic table, outlet pressure
entries (PRESSURE card), gas rate entries (QGAS card), oil-gas ratio entries
(OGR card), and water-gas entries (WGR card) must be input.
The hydraulic table is generated at the end of the timestep following the
specification of the HTOUTPUT card.
Hydraulic tables can be generated only for wells (and/or nodes) with non-zero
production rates at the end of the timestep following the specification of the
HTOUTPUT card. Also, the well tubing strings (node connections) for which the
output of the hydraulic tables are requested must be assigned to the wells (nodes)
in the WELCON (NODCON) cards. The corresponding WELCON (NODCON)
cards must be input before the HTOUTPUT card.

The generated hydraulic tables can be output in BHPTAB format or they can be
output in spreadsheet format. If the BHPTAB format is applied, the hydraulic
table can be used as input data in a VIP-EXEC data set.
The generated hydraulic tables are stored internally in VIP, and they can be used
in LINK cards. However, they can be referenced in the LINK cards only after the
DATE/TIME card following the HTOUTPUT input.
If the hydraulic table is generated for a well tubing string, the THP values in the
table are the values of tubinghead pressure at the subsea depth of the wellhead
which is input as WELHEAD in the corresponding WELCON card. The BHP
values in the table are the values of bottomhole pressure at the reference depth.
The reference depth is defined as the subsea depth of the first active perforation if
it is smaller than the subsea depth of the tubing string bottom. Otherwise, the
reference depth is determined as the subsea depth of the tubing string bottom. The
subsea depth of the first active perforation can be input by the user in the
WELCON card as the WDZ parameter. If it is not input, the subsea depth of the
first active perforation is determined by the simulator as the subsea depth of the
top of the first open perforation with non-zero permeability-thickness. The
difference between the reference depth and the wellhead subsea depth is printed as
the third parameter in the BHPTAB card.
If the hydraulic table is generated for a node, the THP values in the table are the
values of pressure at the outlet of the connection between this node and the node
of the higher level. The BHP values in the table are the values of pressure at the
inlet of the connection. The difference between the subsea depth of the connection
inlet and the subsea depth of the connection outlet is printed as the third parameter
in the BHPTAB card.
Values of oil and gas rates required for the construction of the hydraulic table are
determined using the separator battery assigned to the corresponding well (node)
in the WELL (NODES) card as the IBAT parameter.
The number of the gas-oil ratio (oil-gas) entries must be input in the GOR (OGR)
card. Values of the gas-oil ratio entries are calculated internally by varying the
liquid mole fraction in the range from 0.05 to 0.95, or the range specified by the
user, with equally spaced intervals.
Number of entries, minimum value, and maximum value must be input in each of
the PRESSURE, QLIQ/QO/QGAS, WCUT/WGR, and GASLIFT cards. Values
of each of the entries will be equally spaced.

HTOUTPUT
WELLS w1
tnw 1 tnw 2 … tnw n
NODES n1
tnn 1 tnn 2 … tnn n
PRESSURE nnp pmin pmax
QLIQ
QO nnq qmin qmax
QGAS
GOR nng gmin gmax

OGR
WCUT nnw wmin wmax

WGR
(GASLIFT nngl glmin glmax)
(FILENUMBER un (SPREADSHEET))
Definitions:
WELLS Alpha label indicating that the well list is input in this
card.
wl List of wells for which hydraulic tables should be
generated. (See Section 1.5.2)
tnw Hydraulic table numbercorresponding to each well.
The table number should not exceed NBHPMX
defined in the DIM card.
NODES Alpha label indicating that the node list is input in this
card.
nl List of nodes for which hydraulic tables should be
generated. (See Section 1.5.2)
tnn Hydraulic table number corresponding to each node.
The table number should not exceed the NBHPMX
limit defined in the DIM card.
PRESSURE Alpha label indicating that the outlet pressure entries
in the hydraulic tables are described in this card.

nnp Number of outlet pressure entries (THP) in the

hydraulic tables. The number of outlet pressure entries
should not exceed the NBHPQ limit defined in the
DIM card.
pmin Minimum value of the outlet pressure entries (THP) in
the hydraulic tables, psia (kPa).
pmax Maximum value of the outlet pressure entries (THP) in
the hydraulic tables, psia (kPa).
QLIQ Alpha label indicating that the liquid rate entries in the
hydraulic tables are described in this card. This must
be used with PRESSURE, GOR, and WCUT.
QO Alpha label indicating that the oil rate entries in the
be used with PRESSURE, GOR, and WCUT.
QGAS Alpha label indicating that the gas rate entries in the
be used with PRESSURE, OGR, and WGR.
nnq Number of liquid, oil, or gas rate entries in the
hydraulic tables. The number of the rate entries should
not exceed the NBHPQ limit defined in the DIM card.
qmin Minimum value of the liquid or oil rate entries, STB/D
(STM3/D), or the gas rate entries, MSCF/D (SM3/D)
in the hydraulic tables.
qmax Maximum value of the liquid or oil rate entries, STB/
D (STM3/D), or the gas rate entries, MSCF/D (SM3/
D) in the hydraulic tables.
GOR Alpha label indicating that the gas-oil ratio entries in
the hydraulic tables are described in this card. This
must be used with QLIQ and QO.
OGR Alpha label indicating that the oil-gas ratio entries in
the hydraulic tables are described in this card. This
must be used with QGAS.
nng Number of gas-oil ratio or oil-gas ratio entries in the
hydraulic tables. The number of gas-oil ratio or oil-gas
ratio entries should not exceed the NBHPQ limit
gmin Minimum value of the liquid mole fraction, to be used
in computing gas-oil ratio or oil-gas ratio. Default is
0.05.

gmax Maximum value of the liquid mole fraction, to be used

in computing gas-oil ratio or oil-gas ratio. Default is
0.95.
WCUT Alpha label indicating that the water cut entries in the
be used with QLIQ and QO.
WGR Alpha label indicating that the water-gas ratio entries
in the hydraulic tables are described in this card. This
must be used with QGAS.
nnw Number of water cut or water-gas ratio entries in the
hydraulic tables. The number of water cut or water-gas
ratio entries should not exceed the NBHPQ limit
wmin Minimum value of the water cut entries, fraction, or
water-gas ratio entries, STB/MMSCF (STM3/KSM3)
wmax Maximum value of the water cut entries, fraction, or
water-gas ratio entries, STB/MMSCF (STM3/KSM3)
GASLIFT Alpha label indicating that the gas-lift rate entries in
the hydraulic tables are described in this card. This can
be used with QLIQ or QO.
nngl Number of gas-lift rate entries in the hydraulic tables.
The number of gas-lift rate entries should not exceed
the NBHPQ limit defined in the DIM card.
glmin Minimum value of the gas-lift rate entries in the
hydraulic tables, MSCF/D (SM3/D).
glmax Maximum value of the gas-lift rate entries in the
hydraulic tables, MSCF/D (SM3/D).
FILENUMBER Alpha label indicating that the FORTRAN logical unit
for the output of the hydraulic tables is input in this
card.
un FORTRAN logical unit for the output of the hydraulic
tables. Default is 6.
SPREADSHEET Alpha label indicating that the hydraulic tables must
be output in spreadsheet format. If the
SPREADSHEET keyword is not input, the hydraulic
tables are output in BHPTAB format.
NOTE: 1. The number of tnw values must equal the number of wells in the well
list.

2. The number of tnn values must equal the number of nodes in the node
list.
3. The total number of inlet pressure values (BHP), which is equal to nnp
* nng * nnw * nng1, should not exceed the NBHPV limit defined in the
DIM card.
4. One and only one of the QLIQ, QO, or QGAS labels must be
specified.
5. One and only one of the GOR or OGR labels must be specified.
6. One and only one of the WCUT or WGR labels must be specified.
Example:
C
C Apply Link LINK1 for tubing string modeling in Well WELL1
C
LINK 1 LINK1
C NN Name Type Num Pressure_CorrectionIPVT
1 TUBIN1 TUBING 1 0. 2
WELCON
WELL TUBCON TUBCNT WDZ WDAT
WELL1 LINK1 LINK 20500 21000
C
C Generate hydraulic table with Number 5 for Well WELL1
C
HTOUTPUT
WELLS WELL1
5
PRESSURE 11 1000 2000
QLIQ 11 1000 40000
GOR 4
WCUT 6 0 0.95
GASLIFT 2 0 6000
FILENUMBER 30 SPREADSHEET
.
.
C
C Apply the generated hydraulic table in Link LINK1 after DATE card following
C the HTOUTPUT input.
C
DATE 1 12 2002
C
.
.

LINK 1 LINK1
C NN Name Type Num Pressure_Correction Separator
1 5 BHPTAB 1 0. IBAT 1

10.19 Production Well Optimization Option

The production well optimization option allocates well production rates and
selects the surface network connections through the maximization of the
following objective function:
pn
Objective Function = ∑ ( coj qoj + cgj qgj + cgj qglgj + cwj qwj )
j = p1
where:
• qo, qg, qglg, and qw are the oil production, gas production, gaslift gas injection,
and water production rates, respectively, and
• the objective coefficients, coj, cgj, and cwj, are specified by the user.
The well rates are constrained by maximum oil rate, total gas (production gas and
gaslift gas) rate, liquid rate and well velocity specified at the well level. They are
also constrained by maximum rates and velocity at the nodes. By assuming
constant gas-oil ratio, water cut and total gas-liquid ratio, the problem is
simplified to a linear optimization problem. The SLATEC (Sandia, Los Alamos,
Air Force Weapons Laboratory Technical Exchange Committee) library, linear
programming package dsplp is incorporated into VIP to solve this linear
optimization problem.
10.19.1 Default Dimensions (DIM)

Definition:
MXLSPN Maximum number of levels for the surface pipeline

network structure. Default is 5.
10.19.2 Objective Coefficients (OBJCOEF)

The OBJCOEF card is used to assign objective coefficients for wells. This card is
required to turn on the production well optimization option.
OBJCOEF wl
headings
values

Definitions:
wl List of wells for which objective coefficients are being

specified (see Section 1.5.2). If the well list is not input,
the coefficients are assumed to apply to all production
wells.
OIL Column heading for Co, the objective coefficient for oil
rate, (STB/D)-1, ((STM3/D)-1). Default is zero.
GAS Column heading for Cg, the objective coefficient for gas
rate, (MSCF/D)-1, ((SM3/D)-1). Default is zero.
WATER Column heading for Cw, the objective coefficient for

water rate, (STB/D)-1, ((STM3/D)-1). Default is zero.
NOTE: 1. For the optimization option to be performed, at least one well with
non-zero objective coefficient must be specified.
2. All 3 headings do not have to be specified for a well, but the omitted
coefficients are set to zero. That is, previously specified coefficients
are not retained.
Examples:
C
C DEFINE OBJECTIVE COEFFICIENTS FOR ALL
C PRODUCTION WELLS
C
OBJCOEF
OIL GAS WATER
1. 0. 0.
10.19.3 Lock Well Rates (LOCK)
LOCK wl
ON
OFF
Definitions:
wl List of wells for which lock status is being specified (see

Section 1.5.2). If the well list is not input, the lock status
is assumed to apply to all production wells.
ON This list of wells will be locked from production well

optimization.

OFF This list of wells will not be locked from production well
optimization. This is the default.
Example:
C
C LOCK WELL W32 AND E12A FROM PRODUCTION WELL
C OPTIMIZATION
C
LOCK W32 E12A
ON
10.19.4 Surface Network Optimization Control (NTOPTC)

The NTOPTC card is used to control the well and node reconnections in the
production well optimization option. This card is required each time when the
well and node reconnections are considered.
NTOPTC
param1 param2 . . . paramn
value2 value2 . . . valuen
Definitions:
param Alpha label of those control parameters being defined.

The following parameters can be input:
DOBJMN Minimum increment of the objective function for a well

to change its connection to another node. Default is zero.
A value of zero means that the reconnection of wells to
other nodes is not allowed. Default is 0.
NWSWT Maximum number of reconnections allowed for wells.

Default is 0.
SIMPL Indicates whether the simplified method for the well rates
calculation will be applied. The simplified method
calculates well rates according to the new tubinghead
pressure and it assumes that other well rates are not
affected by the reconnection. YES means to use the
simplified method; NO means not to use it. Default is
NO.
NCYCLES Maximum number of search cycles performed in well

connection optimization. One search cycle is defined as
the procedure that all eligible wells have been tested for
other potential reconnections. This parameter does not
apply to node connection optimization. Default is 1.

DOBJND Minimum increment of the objective function for a node

to change its connection to another node. A value of zero
means that the reconnection of wells to other nodes is not
allowed. Default is 0.
NWSWT Maximum number of reconnections allowed for nodes.

Default is 0.
VELRST Indicates whether velocity limits are to be reset if the

specified velocity limits are violated. YES means to
reset; NO means not to reset. Default is NO.
NOTE: When this card is entered, all data is reset to default values.
Example:
C
C MAXIMUM 10 WELL RECONNECTIONS ARE ALLOWED.
C EACH RECONNECTION NEEDS TO AT LEAST INCREASE
C THE OBJECTIVE FUNCTION BY 100. MAXIMUM 2 SEARCH
C CYCLES ARE ALLOWED.
C
NTOPTC
DOBJMN NWSWT SIMPL NCYCLES
100. 10 YES 2
10.19.5 Node Data (NODES)
NODES
num1 value2 value2 . . . valuen
Definitions:
NN Alpha label indicating that the node number is input in

this column.
num Node number. The node number must be input in

increasing order.
param Alpha labels of those node parameters being defined. The

following parameters are used for the well optimization
option: QO, QG, QOMIN, QGMIN, PMAX, MAXVEL,
VELWCU. PMAX, MAXVEL, VELWCU are new
parameters.
PMAX Maximum pressure at the node for the changes of the

node connection to be considered, psia (kPa). This

parameter can be input only when the optimization

option is used. If the node pressure is larger than the
maximum pressure and several potential node
connections are defined in the NODCON card, node
reconnection will be considered. Default is –1.E15. If the
user wants to turn off node reconnection, this parameter
needs to be set to a large value.
MAXVEL Maximum velocity at the node if the water cut is greater

than the value specified by the VELWCU parameter, ft/
sec (m/sec).
VELWCU Minimum water cut for the maximum velocity constraint

for the node to be activated, fraction.
10.19.6 Well Connection Data (WELCON)
WELCON
WELL param1 param2 . . . paramn
wn1 value2 value2 . . . valuen
Definitions:
WELL Alpha label indicating that this column will contain a

name or number of a production well.
wn Name or number of a production well. A value of the N

or NAME parameter from the WELL card should be used
in this column.
param Alpha labels of those well parameters being defined. The

following parameters are added for the well optimization
option: QOMIN, QGMIN, PMAX.
QOMIN Minimum oil rate at the well, STB/D(STM3/D). This

parameter is applied only if the optimization option is
used. If the oil rate is less than the minimum value and
several potential well connections are defined, well
reconnection will be considered. Default is –1.E9.
QGMIN Minimum gas rate at the well, MSCF/D(SM3/D). This

parameter is applied only if the optimization option is
used. If the gas rate is less than the minimum value and
reconnection will be considered. Default is –1.E9.

PMAX Maximum pressure for the changes of the well

connection to be considered, psia(kPa). This parameter
is applied only if the optimization option is used. If the
well pressure is larger than the maximum pressure and
reconnection will be considered. Default is –1.E15. If the
user wants to turn off well reconnection, this parameter
needs to be set to a large value.
10.19.7 Maximum Velocity Constraints (WLVEL)
WLVEL (wl)
MAXVEL (VELWCUT)
mxvel (wcut)
Definitions:
wl List of wells for which maximum well velocity data is

being specified (see Section 1.5.2). If the well list is not
input, the data is assumed to apply to all production
wells.
MAXVEL Alpha label indicating that the maximum velocity for a

well connection will be entered.
VELWCUT Alpha label indicating that the minimum water cut for a
velocity constraint to be activated will be entered.
mxvel Maximum velocity for a well connection, ft/sec (m/sec).
wcut Minimum water cut for the velocity constraint specified

by MAXVEL to be activated, fraction. Default is 1.
10.19.8 Output Well and Node Connection Changes (PRTSWT)

The PRTSWT card is used to print surface network connection changes to the
FORTRAN file named <casename>.conn_chg.
PRTSWT ON
OFF
Definitions:
ON Well and node connection changes will be printed.

OFF Well and node connection changes will not be printed.

10.19.9 Gaslift Optimization Using Performance Curves (PFMCRV)

When the production well optimization option has been specified and gaslift
performance curve data (PFMCRV, Section 4.10.10) has been entered, a separable
programming (SP) gaslift optimization algorithm (SPE 29124, Fang and Lo,
1995) is used to calculate gaslift rates for the wells.
The SP procedure has three major steps:
1. Construct a gaslift performance curve (oil rate versus lift gas rate) for every
well on automatic gaslift allocation:
a. Start with zero gaslift rate for the well.
b. Calculate the corresponding oil rate and gas-liquid ratio for that well.
c. If the gas-liquid ratio is smaller than the user-specified minimum gas-

liquid ratio (glrmin or wglr in PFMCRV data), ignore this point (do not
add this point onto the gaslift performance curve). Increase the lift gas
rate and go to Step b. If the gas-liquid ratio is larger than the user-
specified maximum gas-liquid ratio (glrmax in PFMCRV data), stop.
d. If the gaslift rate is nonzero, calculate the slope of the gaslift performance
curve.
e. If the slope of the gaslift performance curve is positive, increase the

gaslift rate and go to Step b. If the gaslift rate is negative, go to Step f.
f. Check the slope of the gaslift performance curve starting from the last
point and ending at the first point. Cut the gaslift performance curve at the
point where the slope of the curve is less than or equal to the user-
specified minimum gaslift efficiency coefficient (eff in PFMCRV data).
2. Formulate the gaslift optimization problem as a linear programming problem

using the gaslift performance curves constructed in Step 1. Solve the
optimization problem and obtain the optimal gaslift rate qlg1 for each well.
Denote the optimal objective function value (oil rate) as f.
3. Formulate a new optimization problem to minimize the absolute discrepancy

between the pre-optimization gaslift rate, denoted as qlg0 and the optimal
gaslift rate qlg1 by allowing the optimal oil rate obtained in Step 2 to decrease
from f to (1-a) f, where a is called a relaxation factor or a damping factor
(gldamp in PFMCRV data). The purpose of this step is to minimize the gaslift
rate oscillations. This step is optional.

10.20 Integration of Surface Pipeline Network and Predictive Well

Management
The predictive well management option (PREDICT NEW) has been integrated
with the surface pipeline network option. The integrated tools can be effectively
used for well assignments to different pressure systems and well rate optimization.
The predictive well management option is applied for the well allocations to the
pressure systems. The surface pipeline network option is used for tubing head
pressure and well rate calculations from pressure drop relationships in reservoir,
tubing string, and flow lines. Well connections to nodes are automatically
modified after well allocation to the pressure system.
The following input is required to combine two options:
1. Define all headers to which production wells can be connected as nodes of the
surface pipeline network system. Assign well management level and pressure
system for header nodes using keywords WML, WMN, PRSYS in the
NODES card.
2. Determine current and potential well connections to headers using the

keywords OUTNOD, OUTND2, OUTND3, OUTND4, OUTND5, and
OUTND6 in the WELCON card. The OUTNOD keyword must be used for
the current connection. The keywords OUTND2, OUTND3, OUTND4,
OUTND5, and OUTND6 are used for potential connections.
10.20.1 Number of Outer Iterations Each Timestep (WMITN)

The WMITN card must be entered to use predictive well management.
WMITN nitn (nspnc)
Definition:
nitn Number of outer iterations in each timestep that will use

predictive well management. Default is 0.
nspnc Frequency of the surface pipeline network calculations.

Default is 1.
The WMITN card and the PREDICT card supply the enabling data for predictive
well management. Both are necessary to use this option.
The WMITN card defines the number of outer iterations in each timestep that will
use the predictive well management set of routines to calculate well rates and
bottomhole pressures.

It is recommended that the number of iterations be held to a small value, say 1 or

2. Larger values will probably degrade convergence considerably.
If the surface pipeline network option is used in combination with predictive well
management, the surface pipeline network procedure is executed each nspnc-th
execution of the predictive well management procedure. In this case, tubinghead
pressure in production wells for each pressure system are recalculated only when
the surface pipeline network procedure is executed. The TIMEIN, TIMEST, and
OUTITR parameters defined in the NETPAR card are ignored and the frequencies
of the surface pipeline network calculations are controlled by WMITN and
PWMFRQ cards. When nspnc is equal to one, the surface pipeline network
procedure in executed in the same outer iterations and the same timesteps as the
predictive well management procedure.

10.21 Understanding Injection Network Allocations and Node

Pressures in VIP
When using the injection network capability within VIP, it is important to
understand how injection rates are allocated to the wells. There are four basic
methods of specifying injection targets when using an injection network. These
are:
• Specification of individual well targets (QMAX) with no group targets
• Specification of group targets using ITARG
• Specification of group targets using injection regions
• Specification of node targets on the NODES card
When injection network data is defined, VIP will use the network data to calculate
rates for all wells connected to the network. If there are no rate constraints on the
network NODE cards, these rates will always be pressure limited. If there are rate
constraints on the NODE cards, the constraints will be accounted for in the
network solution. Once the network is solved VIP will check for non-network
group targeting. At this point the individual well rates will be allocated based on
normal VIP group targeting methods. If no additional group targets are specified
then each calculated well rate will be checked against the well’ s QMAX target
and cut back to the QMAX target if necessary. If the ITARG or INJECTION
REGION options are used VIP will take the following steps:
• Check each well 's calculated rate against its QMAX target and cut back the
injection rate to QMAX if necessary
• Sum the rates for all wells in the specified group
• If the sum of the rates is less than the specified group target then no further cut
backs will be performed
• If the sum of the rates is greater than the specified group target then each well
will be allocated a portion of the group 's target as a ratio of its current rate to
the sum of the rates.
Regarding reported node pressures, the reported pressure may not correspond to
the actual pressure required for the given output node or wellhead pressure. If all
wells which branch out from a node are pressure limited then the reported
pressure should correspond to the pressure actually required for the given flow
rates in the output connections. However, if any wells are rate limited (either
through QMAX targets or cut backs due to group targeting), then chokes are
implied to exist in the connections to those wells and the reported node pressure
will correspond to the MAXIMUM pressure that node requires to deliver the
reported flow rates.

All of the examples shown below contain injection network data as shown below.
In summary, there are seven water injection wells connected to a central platform
through a series of manifolds and connections. Please refer to this network data
when examining the results for the following examples.

10.21.1 Examples
The input data injection network data for the examples to follow is shown below.
INJECTION NETWORK DATA
PIPES
NN NAME DIAMETER THICKNESS ROUGHNESS LENGTH TEMPUP TEMPDW PDCORR
1 pipe1 4 0.2 0.001 500 60 60 DUKLER
2 pipe2 4 0.2 0.001 2000 60 60 DUKLER
3 pipe3 4 0.2 0.001 3500 60 60 DUKLER
C
TUBING
NN NAME DIAMETER THICKNESS ROUGHNESS LENGTH DEPTH TEMPUP TEMPDW PDCORR
1 TUB1W1 4 0.2 0.001 425 361 150 150 BEGGS
2 TUB2W1 4 0.2 0.001 12001 12001 150 150 HAGEDORN
C
LINK 1 LINK1
1 1 TUBING
2 2 TUBING
C
NODES
NN NAME ! pmaxi ! qW
C
1 node1 ! 12000.0 ! 8000
2 node2 ! 2400.0 ! 8500
3 node3 ! 12000.0 ! 7500
4 node4 ! 3600.0 ! 7500
C
NODES
NN NAME pmaxi ! QW
C
5 node5 8000.0 ! 30000
C
NODCON
NODE OUTCON OUTCNT OUTNOD
C
C
node4 pipe2 pipe node1
C

10.1.0.1 Injection Network with No Group Targeting
Example 1 below is a model with an injection network and no group targets. All
wells have QMAX targets of 10,000 STBD. From the injection network
calculations, wells I1, I2, I3, I4, and I7 have pressure limited rates less than
QMAX and wells I5 and I6 have pressure limited rates greater than QMAX. Thus,
the actual injected rates for wells I1, I2, I3, I4, and I7 are the calculated pressure
limited rates while the injected rates for wells I5 and I6 correspond to the QMAX
value. Additionally, since wells I1, I2, I3, I4, and I7 are pressure limited, the
pressures reported at nodes 1, 2, 4, and 5 should correspond to the pressures
required for the given flow rates. The pressure reported at node 3 will be the
MAXIMUM pressure required to deliver the specified rates to wells I5 and I6.
One of the well connections will have an implied choke. Additionally, since all
wells downstream of node 3 are rate limited, the pressure drop from node 5 to
node 3 will not be a true representation of the described equipment because of an
implied choke in the connection.
EXAMPLE 1
No Group Targeting
WELL GROUP # 1 ()
WELL DAILY INJECTION PRESSURES, PSIA

------------------------------- -------------------- -----------------------
PERF LOCATION GRID BOTTOM TUBING
------------- GAS WATER BLOCK HOLE HEAD
NO. NAME I J LAYER STAT MSCF/D STB/D DATUM DATUM
--- -------- --- --- ----- ---- --------- --------- ------- ------ ------
9 I1 2 10 2- 4 PLIM 0. 9899.88 7821. 8747. 7129.
10 I2 2 29 3- 5 PLIM 0. 5121.88 8130. 12324. 7279.
11 I3 2 20 3- 5 PLIM 0. 9967.41 8099. 10731. 7262.
15 I7 10 10 1- 3 PLIM 0. 9976.28 7886. 10084. 7103.
13 I5 29 10 2- 5 QMAX 0. 10000. 7623. 9073. 4226.
14 I6 18 10 1- 5 QMAX 0. 10000. 7369. 7986. 3157.
12 I4 23 27 4- 5 PLIM 0. 4897.79 8543. 13049. 7983.
========= =========
WELL GROUP TOTALS 0. 59863.
NODES OF GROUP # 1 ()
NODE DAILY INJECTION PRESSURES, PSIA

------------------------------- -------------------- -----------------------

10.1.0.2 Injection Network with Group Targeting Using ITARG
Example 2 is identical to Example 1 with the addition of group targeting through

the use of an ITARG card. In this case the group target is 50000 STBD while the
sum of the individual well rates (with cut backs for exceeding QMAX targets
already accounted for) is 60442.0 STBD. The actual injection rate for each well
will thus be the ratio of its current target rate to the sum multiplied against the
group target. From the potential report in the output file, the rate for well I1 was
9987.19. Taking this rate as a ratio to the group summation gives well I1 16.524%
of the group target, or 8261.2 STBD. Also, from the potential report, the rate for
well I5 is 51680 STBD. As this exceeds the wells QMAX target of 10000 STBD,
the QMAX target becomes the calculated well rate. This is then taken as a ratio to
total group production to give well I5 16.544% of the group s target injection.
This calculates out to 8272.4 STBD. Regarding node pressures, since all wells are
on rate target control, all reported pressures will correspond to MAXIMUM
pressures required for delivery of the specified rates. For example, the 4670 psia
reported at node 2 will be the maximum pressure required to deliver 8261.7 STBD
to well I1 and 8266.48 STBD to well I7.
EXAMPLE 2
ITARG Group Targeting
WELL GROUP # 1 ()

------------------------------- -------------------- -----------------------
--- -------- --- --- ----- ---- --------- --------- ------- ------ ------
9 I1 2 10 2- 4 WTAR 0. 8261.71 7675. 8449. 3546.
10 I2 2 29 3- 5 WTAR 0. 4394.29 7952. 11558. 6503.
11 I3 2 20 3- 5 WTAR 0. 8266.34 7900. 10085. 5157.
15 I7 10 10 1- 3 WTAR 0. 8266.48 7725. 9547. 4627.
13 I5 29 10 2- 5 WTAR 0. 8272.31 7507. 8706. 3800.
14 I6 18 10 1- 5 WTAR 0. 8272.31 7298. 7809. 2916.
12 I4 23 27 4- 5 WTAR 0. 4266.56 8293. 12222. 7155.
========= =========

------------------------------- -------------------- -----------------------
------------- GAS WATER

10.1.0.3 Injection Regions for Group Targets
Example 3 uses injection regions instead of ITARG cards for group targets. The
allocation calculations are identical to those used for ITARG allocations. In this
example, target injection rate is controlled by voidage replacement and exceeds
the sum of the individual well rates. Thus, no further cut backs are performed and
the injection well rates are identical to those shown in example 1. The node
pressures reported in this case are identical to those of example 1.
EXAMPLE 3
Injection Region
WELL GROUP # 1 ()

------------------------------- -------------------- -----------------------
--- -------- --- --- ----- ---- --------- --------- ------- ------ ------
9 I1 2 10 2- 4 PLIM 0. 9899.88 7821. 8747. 7129.
10 I2 2 29 3- 5 PLIM 0. 5121.88 8130. 12324. 7279.
11 I3 2 20 3- 5 PLIM 0. 9967.41 8099. 10731. 7262.
15 I7 10 10 1- 3 PLIM 0. 9976.28 7886. 10084. 7103.
13 I5 29 10 2- 5 QMAX 0. 10000. 7623. 9073. 4226.
14 I6 18 10 1- 5 QMAX 0. 10000. 7369. 7986. 3157.
12 I4 23 27 4- 5 PLIM 0. 4897.79 8543. 13049. 7983.
========= =========

------------------------------- -------------------- -----------------------

10.1.0.4 Injection Regions with Network Node Targets
Example 4 uses a water constraint on a NODE card with no further group targets.
In this case this corresponds to a field target of 50000 STBD. The calculated rates
indicate wells I2, I3, I4, and I7 are target limited while QMAX targets of 10000
STBD limit I1, I5, and I6. As the rate limits are actually included as part of the
network calculations instead of being applied afterwards, the rate and pressure
distributions in the case may be substantially different than in the other 3 cases.
Note that node pressures reported in this example appear to be much more
physically consistent than in the other 3 examples.
EXAMPLE 4
Network Node Targets
WELL GROUP # 1 ()

------------------------------- -------------------- -----------------------
--- -------- --- --- ----- ---- --------- --------- ------- ------ ------
9 I1 2 10 2- 4 QMAX 0. 10000. 7824. 8760. 4490.
10 I2 2 29 3- 5 QMAX 0. 2607.25 7537. 9687. 4633.
11 I3 2 20 3- 5 QMAX 0. 6924.28 7749. 9580. 4617.
15 I7 10 10 1- 3 QMAX 0. 7880.43 7684. 9422. 4491.
13 I5 29 10 2- 5 QMAX 0. 10000. 7617. 9066. 4777.
14 I6 18 10 1- 5 QMAX 0. 10000. 7364. 7982. 4803.
12 I4 23 27 4- 5 QMAX 0. 2579.98 7741. 10120. 5070.
========= =========

------------------------------- -------------------- -----------------------
10.21.2 Summary
In summary, it is important to understand that any rate limited well or node
connection implies the presence of a choke which is not actually present in the
network equipment description. The presence of this implied choke may result in
what may seem to be physically inconsistent node pressures as described in
Examples 1-3. As a well or node connection becomes rate limited, this implies a
choke is being adjusted, which will result in a pressure drop through the choke,
which is not accounted for in hydraulic tables, or flow correlation calculations.

Chapter
11
Automatic Tuning Procedures
11.1 General Information

Automatic tuning procedures have been implemented to improve the match
between field observations and simulator predictions of
· well bottomhole pressure,
· well tubinghead pressure,
· pressure in headers and flow lines of the surface pipeline network system,
· well oil, gas, and water production rates.
Parameters of well perforations, tubing strings, and pipelines of the surface

pipeline network system can be automatically adjusted from the user specified
ranges to improve the match.
“Static” and “dynamic” tuning procedures have been implemented. In “static”

tuning procedures TBADJ and WIADJ, parameters of tubing string models
(TBADJ) and well indices (WIADJ) are adjusted to match tubinghead or
bottomhole pressure in production wells with specified well production rates at
one “snapshot” of time. The “static” procedures are executed only in one timestep
- the next timestep after the TBADJ and/or WIADJ input. The “dynamic” tuning
procedure TUNING can be applied to match field observations in specified time
intervals. The TBADJ, WIADJ, and TUNING procedures are described below.
11.2 Well Index Adjustment Procedure (WIADJ) and Tubing String

Parameter Adjustment Procedure (TBADJ).
The WIADJ and TBADJ procedures are designed to match well tubinghead
pressure (or bottomhole pressure) in production wells with specified well rates. A
well index is selected from a specified range in the WIADJ procedure for each
“tuned” well. Parameters of the tubing string are selected from specified ranges in
the TBADJ procedure. The procedures can be applied for all wells in the model or
for a subset of wells at any time during the simulation. They are executed for a
user specified number of outer iterations in the next timestep after the WIADJ/
TBADJ input. If both TBADJ and WIADJ procedures are applied for some
R5000.0.1 Automatic Tuning Procedures 11-581

production well, the TBADJ procedure is executed first, then the WIADJ
procedure, then the BHPADD parameters are adjusted. In the TBADJ procedure,
the gravity pressure gradient is adjusted first, then the friction pressure gradient is
modified.
If the tubinghead pressure is specified for some well, a second order optimization
procedure is applied to select parameters of the well tubing string and/or well
index from the user specified ranges by minimizing the difference between inflow
and outflow bottomhole pressure,. The inflow bottomhole pressure is calculated
using the specified well rate, gridblock pressure, and inflow relationships in well
perforations. The outflow pressure is determined using the specified tubinghead
pressure and pressure drop relationships in the well tubing string. Molar rates of
the hydrocarbon components required for the definition of the pressure drop in the
tubing string are calculated from inflow correlations in well perforations.
If the bottomhole pressure is specified, the well index is calculated from the
specified well rate, gridblock pressure, and inflow relationships in well
perforations. Only the WIADJ procedure can be applied in this case.
A multiplier of well indices by perforations is determined in the WIADJ

procedure. Therefore, the user specified profile of well indices by perforations is
maintained and properly scaled. This multiplier is used in all future timesteps, or
until well indices for well perforations are redefined using the FPERF, WI, PI, or
RFLOW cards.
Correction factors (GRPGCR and FRPGCR) for the gravity and friction pressure
gradients in all tubing segments of each “tuned” well are selected in the TBADJ
procedure. These correction factors are used in all future timesteps, until they are
redefined in the TUBING or PIPES cards.
The tuning procedures can be applied together with the predictive well
management option PREDICT NEW. In this case, the tuning procedure is applied
after the predictive well management algorithm is used to select the pressure
system and gas-lift rate for each tuned well. If the predictive well management
option is used in combination with the surface pipeline network option and the
optional keyword NOCPRS is included in the TBADJ/WIADJ card, the pressure
system is not selected and the existing pressure system is applied for each tuned
well. The existing pressure system is determined as the pressure system of the first
node in the WELCON card to which the “tuned” well is connected.
If the NEWWEL keyword is included in the TBADJ/WIADJ card, the tuning

procedures are executed only for new wells that are selected for drilling in the
correspondent time in the automatic drilling option.
The following input is required for the application of the TBADJ and WIADJ
procedures:
11-582 Automatic Tuning Procedures R5000.0.1

1. Define a group of wells that need to be tuned using the WLGRP card. This
step is not required if all wells in a reservoir model need to be tuned.
2. Input well rate type (oil, gas, water, liquid, QMULT, etc.) in the PROD card
for each “tuned” well. This rate type is applied in the TBADJ and WIADJ
procedures.
3. Input instantaneous well rate for each “tuned” well in the QMAX or QMULT
card. A well performance can be tuned only if the well rate is larger that zero.
The rate of each “tuned” well can be automatically defined as the average
well rate in the gathering center to which the well is assigned. To apply this
option, keyword RGCAVR must be included in the TBADJ/WIADJ card.
4. Define well tubinghead pressure for each tuned well in the THP card. If the
predictive well management option is applied, the tubinghead pressure for the
selected pressure system is applied in the tuning procedures. If the surface
pipeline option is applied, the tubinghead pressure is calculated using pressure
drop relationships in flow lines. The tubinghead pressure input is not required
in this case.
5. Input the WIADJ and/or TBADJ cards after the proper DATE card. Define in
the WIADJ/TBADJ cards:
· group name or number, if the tuning procedure must be executed for some group
of wells;
· ranges of tuning parameters;
· number of outer iterations in which the tuning procedures must be executed;
· convergence parameters of the tuning procedure.
Results of the WIADJ and TBADJ tuning procedures are output in Fortran unit
30.
⎛ RGCAVR ⎞
⎜ RGCAVO ⎟
WIADJ (noutit) (NOCPRS) (SHUTPF) ⎜⎜ RGCAVG
⎟
⎟ (NEWWEL) (wlgrp)
⎜ ⎟
⎜ RGCAVW ⎟
⎝ RGCAVL ⎠
(nwiit mxwic mxwil prrtol pratol aprtol avrmul)

⎛ RGCAVR ⎞
⎜ RGCAVO ⎟
⎜ ⎟
TBADJ (noutit)(NOCPRS)(SHUTPF) ⎜ RGCAVG ⎟ (NEWWEL) (TOTAL) (wlgrp)
⎜ ⎟
⎜ RGCAVW ⎟
⎝ RGCAVL ⎠
(ngpgit nfpgit mxgpgc mxfpgc mnbhpa mxbhpa prrtol pratol aprtol avrmul)

Definitions:
noutit Number of outer iterations of a timestep in which

WIADJ/TBADJ procedures will be executed. Default
is one.
NOCPRS Alpha label indicating that production well
assignments to pressure systems must not be changed
in outer iterations in which the WIADJ/TBADJ
procedure is executed. This keyword can be applied
only if the WIADJ/TBADJ procedure is used with the
predictive well management option (PREDICT NEW)
and the surface pipeline network option.
SHUTPF Alpha label indicating that the status of all
perforations will be changed to OFF in the WIADJ/
TBADJ procedure for production wells with
QMAX=0.
RGCAVR Alpha label indicating that average oil/gas/water/
liquid rates in corresponding gathering centers will be
applied for tuning production wells with well type
PROD O/G/W/LIQUID. The maximum well rates of
these wells (QMAX) are set to the average gathering
center rate multiplied by the avrmul factor. The
average gathering center rates are calculated based on
the well production rates in the previous timestep. The
RGCAVR option can not be used in the first timestep
after a restart.
RGCAVO Alpha label indicating that average oil rates in
corresponding gathering centers will be applied in the
WIADJ/TBADJ procedures. The well type of “tuned”
wells is set to PROD O. The maximum well rates of
center oil rate multiplied by the avrmul factor. The
average gathering center oil rates are calculated based
on the well production rates in the previous timestep.
The RGCAVO option can not be used in the first
timestep after a restart.
RGCAVG Alpha label indicating that average gas rates in
wells is set to PROD G. The maximum well rates of
center gas rate multiplied by the avrmul factor. The
average gathering center gas rates are calculated based
on the well production rates in the previous timestep.
The RGCAVG option can not be used in the first
timestep after a restart.

RGCAVW Alpha label indicating that average water rates in

wells is set to PROD W. The maximum well rates of
center water rate multiplied by the avrmul factor. The
average gathering center water rates are calculated
based on the well production rates in the previous
timestep. The RGCAVW option can not be used in the
first timestep after a restart.
RGCAVL Alpha label indicating that average liquid rates in
wells is set to PROD LIQUID. The maximum well
rates of these wells (QMAX) are set to the average
gathering center liquid rate multiplied by the avrmul
factor. The average gathering center liquid rates are
calculated based on the well production rates in the
previous timestep. The RGCAVL option can not be
used in the first timestep after a restart.
NEWWEL Alpha label indicating that the WIADJ/TBADJ
procedure will be applied only for new wells selected
for drilling in the automatic drilling procedure. The
well group number/name wlgrp must be input in this
case. The new wells will be automatically assigned to
this group, while all existing wells will be
automatically removed.
TOTAL Alpha label indicating that correction factors for total
pressure gradient in well tubing strings will be
determined in the TBADJ procedure. Maximum
number of iterations and maximum total correction
factor can be input as ngpgit and mxgpgc,
respectively. Parameters nfpgit and mxfpgc are
ignored.
wlgrp Well group name or number. The WIADJ/TBADJ
procedure will be executed for all production wells in
the specified well group. The procedure will be
executed for all production wells if wlgrp is not input.
nwiit Maximum number of iterations of the WIADJ
optimization procedure. Default is 10.
mxwic Maximum change of well index, in percent (%). It is
assumed that the well index multiplier can be changed
in the range from 1/(1+.01mxwic) to (1+.01mxwic).
Default is 50%.

mxwil Maximum perforation well index value. Default is 30.

prrtol Pressure relative convergence tolerance. If the
absolute value of relative differences between inflow
and outflow bottomhole pressure is less than prrtol in
some iteration, the WIADJ/TBADJ procedure
converges. Default is .0001.
pratol Pressure absolute convergence tolerance, psia (kPA).
If the absolute value of differences between inflow
and outflow bottomhole pressure is less than pratol,
the WIADJ/TBADJ procedure converges. Default is 3
psia.
aprtol Adjustment parameter relative convergence tolerance.
If the absolute value of the relative change of a tuning
parameter is less than aprtol, the WIADJ/TBADJ
procedure converges. Default is .0001.
avrmul Average gathering center rate multiplier. This
parameter is applied only if one of the RGCAVR,
RGCAVO, RGCAVG, RGCAVW, or RGCAVL
options is used. Default is one.
ngpgit Maximum number of iterations used in the TBADJ
procedure for the calculation of the gravity pressure
gradient correction factor. Default is 10.
nfpgit Maximum number of iterations used in the TBADJ
procedure for the calculation of the friction pressure
gradient correction factor. Default is 10.
mxgpgc Maximum change of the gravity pressure gradient, in
percent (%). It is assumed that the gravity pressure
gradient correction factor can be changed in the range
from 1/(1+.01mxgpgc) to (1+.01mxgpgc). Default is
30%.
mxfpgc Maximum change of the friction pressure gradient, in
percent (%). It is assumed that the friction pressure
gradient correction factor can be changed in the range
from 1/(1+.01mxfpgc) to (1+.01mxfpgc). Default is
30%.
mnbhpa Minimum bottomhole pressure adjustment BHPADD,
psia (kPA). The default value is 0.
mxbhpa Maximum bottomhole pressure adjustment BHPADD,
psia (kPA). The default value is 0.

NOTE: If Parameters NOCPRS, SHUTPF, RGCAVR, RGCAVO, RGCAVG,

RGCAVW, RGCAVL, NEWWEL, noutit, wlgrp, prrtol, pratol, and/or
avrmul are input in both TBADJ and WIADJ cards in the same
simulation time, values of these parameters from the last card will be
applied in both TBADJ and WIADJ procedures.
Example:
C
C Apply the WIADJ procedure for Wells WELL1 and WELL2
C
WLGRP 1 TUNE_WELLS
WELL1 WELL2
C Number Use Average Apply Existing Tuned Well
C Outer GC Rate Pressure System Group Name
C Iterations Well Assignments
WIADJ 1 RGCAVR NOCPRS TUNE_WELLS
C Maximum Number Maximum Change Maximum Index in
C of Iterations of Well Index % Well Perforations
100 30 20

11.3 Dynamic TUNING Procedure

A tuning procedure has been implemented to match field measurements in
specified time intervals by adjusting parameters of the well perforation, tubing
string, and surface pipeline network models.
The simulations are automatically repeated several times (passes) in the specified
time interval. Values of history matching relative error functions are determined in
each pass. If these values are less than the user specified tolerances, or the number
of the passes exceeds its limit, the tuning procedure is terminated. Otherwise, new
values of adjusted parameters are selected at the end of each pass and the next
pass is executed.
The start of the tuning time interval is defined by the TIME/DATE card after
which the TUNING card is included. The end of the tuning time interval is
determined by next TIME/DATE card following the ENDTUNING card.
The history matching relative error functions for oil, gas, and water production
rates of the i-th production well are defined as follows:
N
C M
∑ cqi ( tj ) [ Qqi ( tj ) – Qqi ( tj ) ]
ε qi = j----------------------------------------------------------------------
=1
N
-, …, q = o, g, w.
M
∑ cqi ( tj ) [ Qqi ( tj ) ]
j=1
Where:
M
Q qi ( t j ) , q=o,g,w are measurements of oil, gas, and water production rates of the
i-th well at the simulation time tj. They are input using the QMULT card after the
corresponding TIME/DATE card;
C
Q qi ( t j ) , q=o,g,w are calculated oil, gas, and water production rates of the i-th
well at the simulation time tj. They are determined at the end of the timestep after
each TIME/DATE card in the tuning time interval;
N is the number of TIME/DATE cards in the tuning time interval;
c qi ( t j ) , q=o,g,w are the error function coefficients which can be input by the user
using the TERC cards. The default values of these coefficients are one.
The error function for gas-oil ratio or gas-liquid ratio can be applied instead of the
error function for gas rate using the GOR or GLR keywords in the TUNING card.

The error function for water cut or water-gas ratio can be applied instead of the
error function for water rate using the WCUT or WGR keywords in the TUNING
card.
The history matching relative error functions for pressure at well bottomhole,
tubinghead, and nodes of the surface pipeline network system are determined as
follows:
N
C M
∑ cpi ( tj ) [ Ppi ( tj ) – Ppi ( tj ) ]
ε pi = j---------------------------------------------------------------------
=1
N
-, …, p = b, t, n.
M
∑ cpi ( tj ) [ Ppi ( tj ) ]
j=1
Where:
M
P pi ( t j ) , p=b,t,n are measurements of bottomhole pressure, tubinghead pressure,
and node pressure in the i-th well or i-th node at the simulation time tj. They are
input using the TBHP, TTHP, and TPRND cards after the corresponding TIME/
DATE card;
C
P pi ( t j ) , p=b,t,n are calculated bottomhole pressure, tubinghead pressure, and
node pressure in the i-th well or i-th node at the simulation time tj. They are
determined at the end of the timestep after each TIME/DATE card in the tuning
time interval;
c pi ( t j ) , p=b,t,n are the error function coefficients which are input using the TBHP,
TTHP, and TPRND cards. Defaults of these coefficients are one.
If the RELERR keyword is included in the TUNING card, the error functions are
calculated as follows:
N C M
[ Q qi ( t j ) – Q qi ( t j ) ]
ε qi = ∑ c qi ( t j ) ---------------------------------------------, q = o, g, w.
M
[ Q qi ( t j ) ]
j=1
A similar expression is used for the pressure error functions in this case.
The tuning procedure is terminated when values of the relative error functions are
less than the tolerances specified by the user in the MAXRER and MAXRNE
cards or the numbers of passes for the different steps of the tuning procedure
exceeds the maximum values.
The following steps are executed sequentially in the tuning procedure:

1. Tune parameters of well perforations and well indices. The maximum number
of simulator passes in this step (maxnip) is input by the user in the TUNING card.
In each pass, the simulation is executed in the time interval defined by the
TUNING and ENDTUNING cards.
2. Set M to the maximum node level.
3. Tune parameters of output flow lines for all nodes of Level M.
4. Reduce node Level M by one. Repeat Step 3 if M is larger than one.
5. Tune parameters of flow lines connecting well heads to nodes of the surface
pipeline network system, if M is equal to one.
6. Tune parameters of well tubing strings. The maximum number of simulator

passes (maxnil) in each of Steps 3, 5, and 7 is specified by the user in the
TUNING card.
If parameter maxnil is input as a negative number, the parameters of flow lines,

well lines, and tubing strings are tuned simultaneously. In this case, the absolute
value of parameter maxnil is the maximum number of passes in this step.
If keyword RNP is included the TUNING card, pressures in nodes of Levels M+1,
M+2, ... are reset to their measured values in Step 3 of the tuning procedure.
Otherwise, the calculated values are applied.
If keyword RTHP is included the TUNING card, tubinghead pressures in

production wells are reset to their measured values in Step 6 of the tuning
procedure. Otherwise, the calculated values are applied.
A range of parameter multiplier changes must be specified to tune any parameter.

A maximum parameter change dmax (in percent) is input by the user. It is
assumed that the parameter multiplier can be changed in the range from
max((1-.01dmax), (1 + .01dmin)), to (1+dmax). The minimum parameter
changes for well perforations and flowlines are input in the MNPFCF and
MNFLCF cards.
The well indices can be adjusted within the user specified ranges to match
bottomhole pressure measurements in production wells. The ranges of the well
indices are specified in the TWELL cards.
If the bottomhole pressure measurements are not available, they can be estimated
by the simulator, using tubinghead pressure and pressure drop relationships in
well tubing strings. The keyword TCBHP must be included in the TUNING card
to use this option.

The following well perforation parameters can be tuned within the user specified
ranges to improve the history match between field measurements and predictions
of the oil, gas, and water production rates:
• endpoints of gas and water relative permeability curves in well perforations,
• permeability thickness (KH) values in well perforations,
• water and gas relative permeabilities at residual oil saturation in well

perforations.
The ranges of the well perforation parameters are specified in the TWELL and/or
TFPERF cards.
The following parameters of tubing strings can be adjusted within the user
specified ranges to match well inflow and outflow bottomhole pressures:
• roughness,
• length,
• diameter,
• pressure gradient,
• pressure drop in well chokes.
The ranges of the well tubing string parameters are specified in the TTUBING
cards.
The following parameters of well flowlines connecting wellheads to nodes of the

surface pipeline network system can be adjusted within the user specified ranges
to match measurements of well tubinghead pressure:
• roughness coefficient,
• length,
• diameter,
• pressure gradient,
• pressure drop in well chokes.
The ranges of the well flowline parameters are specified in the TWLFL cards.
The following parameters of output flowlines of nodes can be adjusted within the
user specified ranges to match measurements of node pressure:
• roughness coefficient,

• length,
• diameter,
• pressure gradient.
The ranges of the parameters of the node output flowlines are specified in the
TSPN cards.
Inactive perforations with status OFF specified in the FPERF card can be
automatically turned ON if predicted oil, gas or water production rates in the well
are significantly less than their measurements. The MINRER card is used to
activate this option.
The calculated adjustment factors for well perforation, tubing string, well
flowline, and pipeline parameters can be printed if keywords PRADJFPERF and/
or PRTUBSPN are included in the TUNING card. These adjustment factors can
be input to the simulator in the cards ADJFPERF, ADJTUBING, ADJWLFL,
ADJSPN, and ADJWI. Therefore, the TUNING procedure can be executed in one
history matching run to calculate the adjustment factors and print them. In all
other runs, these adjustment factors can be used as input and the TUNING
procedure is not required.
The adjustment factors calculated in different passes of the tuning procedure can
be output if debug print is requested using keyword PRDEBUG in the TUNING
card.
The tuning procedure results for wells and/or nodes can be output to two
spreadsheet files if keywords PRWLRP and/or PRNDRP are included in the
TUNING card. The measurements and predictions of the oil, gas, and water well
production rates, bottomhole pressure, and tubinghead pressure for different times
in the tuning time interval are output to the well spreadsheet file (Fortran unit 30).
The measurements and predictions of the oil, gas, and water rates and pressure in
the nodes of the surface pipeline network system are output to the node
spreadsheet file (Fortran unit 69).
Input to the TUNING procedure can be divided into the following groups:
• Determination of general parameters (tuning time interval, types of error

functions, and output requests) (TUNING, ENDTUNING).
• Convergence parameters (MAXRER, MAXRNE).
• Definition of tuning parameter ranges (TWELL, TFPERF, TTUBING,

TWLFL, TSPN, MNPFCF, MNFLCF).
• Request for the activation of inactive perforations (MINRER), if it is required.
• Field measurements (QMULT, TBHP, TTHP, TPRND).

• Adjustment factors (ADJFPERF, ADJTUBING, ADJWLFL, ADJSPN,

ADJWI).
The convergence parameters (MAXRER, MAXRNE), the tuning parameter

ranges (TWELL, TFPERF, TTUBING, TWLFL, TSPN, MNPFCF, MNFLCF),
and the MINRER card must be input immediately following the TUNING card as
one package of data.
The field measurements (QMULT, TBHP, TTHP, TPRND) can be input at any
time in the tuning time interval.
The adjustment factors (ADJFPERF, ADJTUBING, ADJWLFL, ADJSPN,

ADJWI) can be input independently from the TUNING procedure at any time
during a simulation.
11.3.1 General Parameters (TUNING, ENDTUNING)

The start of the tuning time interval is defined by the TIME/DATE card after
which the TUNING card is included. The end of the tuning time interval is
determined by the next TIME/DATE card following the ENDTUNING card.
⎛ ⎞ ⎛ ⎞
⎜ GRATE ⎟ ⎜ WRATE ⎟
TUNING (maxnip maxnil) ⎜ GOR ⎟ ⎜ WCUT ⎟ (param)
⎜ ⎟ ⎜ ⎟
⎝ GLR ⎠ ⎝ WGR ⎠
ENDTUNING
Definitions:
maxnip Maximum number of simulation passes used for

tuning parameters of well perforations. Default is 10.
maxnil Maximum number of simulation passes used for
tuning parameters in EACH level of the surface
pipeline network structure. If the maxnil is negative,
the parameters of flowlines, well lines, and tubing
strings are tuned simultaneously. In this case, the
absolute value of maxnil is the maximum number of
the simulation passes used for tuning of the surface
pipeline network parameters. Default is 5.
GRATE Alpha label indicating that well gas production rates
will be applied in error function calculations. This is
the default.

GOR Alpha label indicating that well gas-oil ratio will be

applied in error function calculations.
GLR Alpha label indicating that well gas-liquid ratio will be
WRATE Alpha label indicating that well water production rates
will be applied in error function calculations. This is
the default.
WCUT Alpha label indicating that well water cut will be
WGR Alpha label indicating that well water-gas ratio will be
The following additional parameters may be entered:
RELERR Alpha label indicating that relative error functions will
be applied.
RNP Alpha label indicating that measured pressure in a
node will be used for tuning parameters in all nodes
from lower levels. If this keyword is not included, the
calculated pressure will be applied.
RTHP Alpha label indicating that measured well tubinghead
pressure will be used for tuning parameters of tubing
strings. If this keyword is not included, the calculated
tubinghead pressure is applied.
TCBHP Alpha label indicating that output bottomhole pressure
calculated from pressure drop calculations in tubing
strings will be used for tuning well indices. If this
keyword is not included, the measured bottomhole
pressure is applied.
PRWLRP Alpha label indicating that a well report in spreadsheet
format will be generated in Fortran unit 30.
Measurements and predictions of oil, gas, and water
well production rates, bottomhole pressure, and
tubinghead pressure for different times in the tuning
time interval are included in this report before and
after tuning.
PRNDRP Alpha label indicating that a node report in
spreadsheet format will be generated in Fortran unit
69. Measurements and predictions of oil, gas, and
water well production rates, and pressure in nodes for
different times in the tuning time interval are included
in this report before and after tuning.

PRADJFPERF Alpha label indicating that adjustment factors for well

perforation parameters and well indices will be printed
in the output file at the end of the tuning procedure.
The adjustment factors are printed in the format for
cards ADJFPERF and ADJWI.
PRTUBSPN Alpha label indicating that adjustment factors for
parameters of well tubing strings, well flowlines, and
surface pipeline network will be printed in the output
file at the end of the tuning procedure. The adjustment
factors are printed in the format for cards
ADJTUBING, ADJWLFL, and ADJSPN.
PRFPER Alpha label indicating that well perforation parameters
in FPERF format will be printed in the output file at
the end of the tuning procedure.
PRDEBUG Alpha label indicating a debug report will be printed in
the output file at the end of each pass of the tuning
procedure.
Example:
C
C Start the TUNING procedure at Jan. 1, 1998
C
DATE 01 01 1998
TUNING GOR WCT PRWLRP PRNDRP PRADJFPERF PRTUBSPN
......
......
C
C End the TUNING procedure at Jun 1, 1998
C
ENDTUNING
DATE 01 06 1998
11.3.2 Convergence Tolerances (MAXRER and MAXRNE)

The MAXRER and MAXRNE cards must be input in the group of data
immediately following the TUNING card.
MAXRER oilrtl (gasrtl watrtl bhprtl)
MAXRNE prnrtl (biortl)

Definitions:
oilrtl Relative tolerance for oil rate error functions, fraction.

Default is 0.01.
gasrtl Relative tolerance for gas rate error functions,
fraction. Default is 0.01.
watrtl Relative tolerance for water rate error functions,
fraction. Default is 0.01.
bhprtl Relative tolerance for bottomhole pressure error
functions, fraction. Default is 0.01.
prnrtl Relative tolerance for tubinghead error functions and
pressure error functions in nodes of the surface
pipeline network system, fraction. Default is 0.01.
biortl Relative tolerance for differences in inlet and outlet
bottomhole pressure, fraction. Default is 0.01.
Examples:
MAXRER 0.002 0.002 0.002 0.002
MAXRNE 0.002 0.002

11.3.3 Parameter Ranges (TWELL, TFPERF, TTUBING, TWLFL, TSPN,

MNPFCF, MNFLCF)
The TWELL, TFPERF, TTUBING, TWLFL, TSPN, MNPFCF, and MNFLCF
cards must be input in the group of data immediately following the TUNING card.
Ranges of adjusted parameters of well perforations are specified in the TWELL

and TFPERF cards.
Ranges of adjusted parameters of well tubing strings are specified in the

TTUBING card.
Ranges of adjusted parameters of well flowlines connecting wellheads to nodes of

the surface pipeline network system are specified in the TWLFL card.
Ranges of adjusted parameters of flowlines connecting nodes of the surface

pipeline network system are specified in the TSPN cards.
Minimum values of correction factors for perforation parameters are specified in

the MNPFCF card.
Minimum values of correction factors for flowline parameters are specified in the
MNFLCF card.
A parameter will not be adjusted if a range of parameter changes is not defined in

the appropriate TWELL, TFPERF, TTUBING, TWLFL, or TSPN card. Therefore,
the default values of the maximum parameter changes dmax are zero.
TWELL (well_list)
(DWI) (DSWR) (DSGR) (DKH) (DKRW) (DKRG)
(dmax) (dmax) (dmax) (dmax) (dmax) (dmax)
TFPERF
WELL (DSWR) (DSGR) (DKH) (DKRW) (DKRG)
wn (dmax) (dmax) (dmax) (dmax) (dmax)
The last card is repeated as necessary to describe all the
perforations for each well being tuned.
TTUBING (well_list)
(DDIAM) (DLENGTH) (DROUGH) (DPRGR)
(dmax) (dmax) (dmax) (dmax)
TWLFL (well_list)

TSPN (node_list)
MNPFCF dminDSWR (dminDSGR dminDKRW dminDKRG dminDKH dminDWI)
MNFLCF dminDROUGH (dminDDIAM dminDLENGTH dminDPRGR)
Definitions:
well_list List of production wells for which maximum

parameter changes are input in the TWELL,
TTUBING, or TWLFL cards (see Section 1.5.2). If the
well list is not input, the maximum parameter changes
are assumed to apply to all production wells.
node_list List of nodes for which maximum parameter changes
are input in the TSPN card. If the node list is not input,
the maximum parameter changes are assumed to apply
to all nodes of the surface pipeline network system.
wn Well number or well name (TFPERF card). The well
number or name must be entered for each data card.
For multiple completions in a single well, the alpha
label X must be substituted for the well number or
well name on each data card after the first.
WELL Alpha label indicating that this field will contain a
well number, a well name, or the alpha label X.
DWI Alpha label indicating that this field will contain a
maximum well index change.
DSWR Alpha label indicating that this field will contain a
maximum change of endpoints of the water relative
permeability curve in well perforations.
DSGR Alpha label indicating that this field will contain a
maximum change of endpoints of the gas relative
DKH Alpha label indicating that this field will contain a
maximum change of permeability thicknesses in well
perforations.
DKRW Alpha label indicating that this field will contain a
maximum change of the water relative permeability at
residual oil saturation in well perforations.

DKRG Alpha label indicating that this field will contain a

maximum change of the gas relative permeability at
DDIAM Alpha label indicating that this field will contain a
maximum change of diameter of well tubing
(TTUBING), well output flowline (TWLFL), or node
output flowline (TSPN).
DLENGTH Alpha label indicating that this field will contain a
maximum change of length of well tubing
DROUGH Alpha label indicating that this field will contain a
maximum change of roughness coefficient in well
tubing (TTUBING), well output flowline (TWLFL),
or node output flowline (TSPN).
DPRGR Alpha label indicating that this field will contain a
maximum change of pressure gradient in well tubing
dmax Maximum change of the corresponding parameter,
percent (%). It is assumed that the parameter
multiplier can be changed in the range from max((1-
.01dmax), (1 + .01dmin)) to (1+.01dmax). Default
is zero.
dmin Minimum change of the corresponding parameter,
percent (%). It is assumed that the parameter
multiplier can be changed in the range from max((1-
.01dmax), (1 + .01dmin)) to (1+.01dmax). The value
of dmin can not be positive and must be larger than
-100. Default is -99.9.
Examples:
C
C Allow changes of well indices, endpoints of water relative permeability curves,
C water relative permeability, and KH values in well perforations of
C Wells WELL1 and WELL2 by 20%, 10%, 20%, and 30%, respectively.
C
TWELL WELL1 WELL2
DWI DSWR DKRW DKH
20 10 20 30
C
C Allow changes of roughness coefficients and pressure gradient in tubing
C strings of all wells by 50% and 40%

C
TTUBING
DROUGH DPRGR
50 40
11.3.4 Activation of Inactive Perforations (MINRER)

The MINRER card must be input in the group of data immediately following the
TUNING card.
MINRER roilmin (rgasmin rwatmin rkhmin frfoil frfgas frfwat)
Definitions:
roilmin Minimum oil relative error, fraction. An inactive

perforation in a production well is considered for
activation only if the oil relative error function
(calculated minus measured oil production rate) is
negative and its absolute value is larger than roilmin.
Default is 1.E+10.
rgasmin Minimum gas relative error, fraction. An inactive
activation only if the gas relative error function
(calculated minus measured gas production rate) is
negative and its absolute value is larger than rgasmin.
Default is 1.E+10.
rwatmin Minimum water relative error, fraction. An inactive
activation only if the water relative error function
(calculated minus measured water production rate) is
negative and its absolute value is larger than rwatmin.
Default is 1.E+10.
rkhmin Minimum relative permeability thickness (KH) value,
fraction. An inactive perforation in a production well
is considered for activation only if the ratio of KH *
WIL in this perforation to the maximum KH * WIL in
active perforations is larger than rkhmin. Default is
0.1.

frfoil Minimum oil fractional flow coefficient, fraction. An

inactive perforation in a production well is considered
for activation only if the oil relative error function in
the well is negative, its absolute value is larger than
roilmin, the perforation relative KH value is larger
than rkhmin, and the oil fractional flow coefficient in
this perforation is larger than frfoil. Default is 0.1.
frfgas Minimum gas fractional flow coefficient, fraction. An
inactive perforation in a production well is considered
for activation only if the gas relative error function in
the well is negative, its absolute value is larger than
rgasmin, the perforation relative KH value is larger
than rkhmin, and the gas fractional flow coefficient in
this perforation is larger than frfgas. Default is 0.1.
frfwat Minimum water fractional flow coefficient, fraction.
An inactive perforation in a production well is
considered for activation only if the water relative
error function in the well is negative, its absolute value
is larger than rwatmin, the perforation relative KH
value is larger than rkhmin, and the water fractional
flow coefficient in this perforation is larger than
frfwat. Default is 0.1.
Examples:
MINRER 1.E+10 0.1 0.1 0.1 1.E+10 0.2 0.2

11.3.5 Field Measurements and Error Function Coefficients (QMULT, TBHP,

TTHP, TPRND, TERC)
Field measurements of well bottomhole pressure, well tubinghead pressure, and
pressure in nodes (TBHP, TTHP, TPRND) as well as error function coefficients
(TERC) can be input at any time in the tuning time interval defined by the
TUNING and ENDTUNING cards.
Field measurements of oil, gas, and water rates in production wells can be input
using the QMULT cards.
If field measurements (TBHP, TTHP, TPRND, QMULT) are not input after some
TIME/DATE card in the tuning time interval, values from the previous input are
applied. Before the tuning time interval, they are set to zero. It is assumed that a
measurement is not available if a zero value of this measurement is input.
TBHP well_list
bhp1 bhp2... bhpn
(efc1 efc2... efcn)
TTHP well_list
thp1 thp2... thpn
(efc1 efc2... efcn)
TPRND node_list
prnd1 prnd2...prndn
(efc1 efc2... efcn)
TERC (well_list)
(OIL) (GAS) (WATER)
(efc) (efc) (efc)
Definitions:
well_list List of production wells for which field measurements

and/or error function coefficients are input in the
TBHP, TTHP, or TERC cards (see Section 1.5.2). If
the well list is not input in the TERC card, the error
function coefficients are assumed to apply to all
production wells.
node_list List of nodes for which pressure measurements and
error function coefficients are input in the TPRND
card.

bhp Bottomhole pressure measurement in a production

well, psia (kPA).
thp Tubinghead pressure measurement in a production
well, psia (kPA).
prnd Node pressure measurement, psia (kPA).
OIL Alpha label indicating that this field will contain an
error function coefficient for the well oil rate.
GAS Alpha label indicating that this field will contain an
error function coefficient for the well gas rate.
WATER Alpha label indicating that this field will contain an
error function coefficient for the well water rate.
efc Coefficient of the corresponding error function.
NOTE: The number of the bhp/thp/prnd values must equal to the number of
wells/nodes in the well/node list.
Examples:
C
C Input rate and pressure measurements for Wells WELL1 and WELL2
C
QMULT WELL1 WELL2
200 320 !Oil rates
6210 7340 !Gas rates
4 400 !Water rates
TBHP WELL1 WELL2
4230 4920
TTHP WELL1 WELL2
1210 1310
C
C Pressure measurements in Node NODE3
C
TPRND NODE3
650

11.3.6 Adjustment Factors (ADJWI, ADJFPERF, ADJTUBING, ADJWLFL,

ADJSPN)
The ADJWI, ADJFPERF, ADJTUBING, ADJWLFL, and ADJSPN cards can be
input at any time during a simulation.
ADJWI well_list
adfc1 adfc2... adfcn
ADJFPERF
WELL (DSWR) (DSGR) (DKH) (DKRW) (DKRG)
wn (adfc) (adfc) (adfc) (adfc) (adfc)
The last card is repeated as necessary to describe all the
perforations for each well for which parameters are being
adjusted.
ADJTUBING (well_list)
(adfc) (adfc) (adfc) (adfc)
ADJWLFL (well_list)
ADJSPN (node_list)
Definitions:
well_list List of production wells for which simulation

parameters are being adjusted (see Section 1.5.2).
node_list List of nodes for which simulation parameters of
output flowlines are being adjusted.
wn Well number or well name. The well number or name
must be entered for each data card. For multiple
completions in a single well, the alpha label X must be
substituted for the well number or well name on each
data card after the first.
WELL Alpha label indicating that this field will contain a
well number, a well name, or the alpha label X.

DSWR Alpha label indicating that this field will contain an

adjustment factor for endpoints of the water relative
DSGR Alpha label indicating that this field will contain an
adjustment factor for endpoints of the gas relative
DKH Alpha label indicating that this field will contain an
adjustment factor for permeability thicknesses in well
perforations.
DKRW Alpha label indicating that this field will contain an
adjustment factor for the water relative permeability at
DKRG Alpha label indicating that this field will contain an
adjustment factor for the gas relative permeability at
DDIAM Alpha label indicating that this field will contain an
adjustment factor for diameter of well tubing
(ADJTUBING), well output flowline (ADJWLFL), or
node output flowline (ADJSPN).
DLENGTH Alpha label indicating that this field will contain an
adjustment factor for length of well tubing
DROUGH Alpha label indicating that this field will contain an
adjustment factor for roughness coefficient in well
tubing (ADJTUBING), well output flowline
(ADJWLFL), or node output flowline (ADJSPN).
DPRGR Alpha label indicating that this field will contain an
adjustment factor for pressure gradient in well tubing
adfc Adjustment factor of the corresponding parameter,
percent (%). The parameter multiplier will be defined
as 1 + .01adfc.
Examples:
C
C Adjust well indices, endpoints of water relative permeability curves,
C water relative permeability, and KH values in well perforations of
C Well WELL1 by 18%, 4%, 17%, and -5%, respectively.

C
ADJWI WELL1
18
ADJFPERF
WELL DSWR DKRW DKH
WELL1 4 17 -5
X 4 17 -5
C
C Adjust roughness coefficient and pressure gradient in a tubing
C string of Well WELL1 by 27% and 32%, respectively.
C
ADJTUBING WELL1
DROUGH DPRGR
27 32
11.3.7 Output of Automatic Tuning Results

The adjustment factors for well perforation, tubing string, well flowline, and
pipeline parameters calculated in the TUNING procedure can be printed if
keywords PRADJFPERF and/or PRTUBSPN are included in the TUNING card.
The adjustment factors calculated in different passes of the tuning procedure can
be output if the debug print is requested using keyword PRDEBUG in the
TUNING card.
The tuning procedure results for wells and/or nodes can be output to two
spreadsheet files if keywords PRWLRP and/or PRNDRP are included in the
TUNING card. The measurements and predictions of the oil, gas, and water well
production rates, bottomhole pressure, and tubinghead pressure for different times
in the tuning time interval are output to the well spreadsheet file (Fortran unit 30).
The measurements and predictions of the oil, gas, and water rates and pressure in
the nodes of the surface pipeline network system are output to the node
spreadsheet file (Fortran unit 69).


Chapter
12
Gas Field Operations (GFO) Option
12.1 Introduction
The Gas Field Operations (GFO) option provides a set of tools which have been
developed to assist the engineer in simulating various forms of gas deliverability
requirements found in many gas sales contracts. The principle factors involved
are as follows:
1. Annual contract -- For the number of years specified for the GFO contract, the
simulation time is advanced one year at a time, rather than through the use of
TIME or DATE cards. The contract must start on the first day of a month.
2. Multiple contracts -- The annual contract may actually be a set of contracts,

each corresponding to an area in the simulation model. All contracts start on
the same date.
3. DCQ - Daily Contracted Quantity -- This is the average daily rate for each
contract that must be delivered for the entire contract year.
4. Seasonality profile factors -- Monthly adjustment factors to adjust the DCQ

for the different seasons. Actual production for each month for each contract
is the DCQ times the profile factor for the month.
5. Swing factors -- There are several different variations with the use of the
swing factors, but in general and with varying conditions, the field, or each
contract area, must be capable of producing at a rate of DCQ times the swing
factor. If not, the DCQ must be reduced to a value which would allow this
excess capacity to be available at any time during the contract year. These
swing factors are specified monthly, just like the profile factors, and should be
equal to or greater than the profile factors.
6. Sales gas rate -- For GFO, the gas targets (DCQ's) are sales gas rates,
accounting for gas production minus gas consumption (fuel gas) and
shrinkage gas, plus extraneous gas imported from outside of the field.
7. ACQ - Annual Contracted Quantity -- This is equal to DCQ times the number
of days in the contract year.
8. Estimation of delivery capacity (maximum deliverability when all targets are

removed).
R5000.0.1 Gas Field Operations (GFO) Option 12-609

9. Multiple simulations of each contract year -- Normally at least two passes are
made through each contract year, depending on which DCQ contract option
(DCQCON) is being used. Pass 1 will be testing to ensure that the swing
constraints for each contract can be met and, if so, pass 2 will be made using
the seasonality profile factors. If the swing constraints cannot be met for each
contract, the appropriate DCQ values are reduced, and another pass 1 cycle is
performed.
10. Simulator output -- No output will be produced during the pass 1 simulations,
with the exception of the basic timestep summary lines so that the engineer
can monitor the progress of the simulation. Requested reports, using data not
included in an Annual Scheduling File (ASF), will be generated after the
completion of the pass 2 simulation of the annual contract, and any new input
data may be entered at the end of any contract. If additional reports and/or
data changes are required during a contract year, they must be set up in an
Annual Scheduling File.
12.2 Gas Field Operations Data (GFO)

This set of data controls the functionality of the gas contract for one or more
years. For the initial introduction, all data lines must be specified (optional data
elements may be defaulted). However, for subsequent entries such as extending a
contract, only the number of years is required. The current simulation time at the
beginning of a contract must correspond to the first day of a month.
GFO NYEARS (MAXCYC) (MONTH) (CUMTOL) (RDFAC)
(maxcyc) ⎛⎝ NO ⎞⎠
YES
nyears (cumtol) (rdfac)
(CONTRACT (area))
(SWING swJAN ... swDEC)
(PROFILE prJAN ... prDEC)
(TAKE tkJAN ... tkDEC)
(DCQ) (DCQCON) (DCQLIM) (DCQANT)
⎛ YEAR ⎞
⎜ INSTANT ⎟
(dcq) ⎜ ⎟ (dcqlim) (dcqant)
⎜ ACQ ⎟
⎜ month ⎟
⎝ NO ⎠
(CONTRACT (area))
ENDGFO
Definitions:
12-610 Gas Field Operations (GFO) Option R5000.0.1

NYEARS Alpha label indicating that the entry in the appropriate

position on the following card is the number of years for
the contract(s). This entry is required.
MAXCYC Alpha label indicating that the entry in the appropriate

position on the following card is the maximum number of
DCQ reduction cycles in the first pass.
MONTH Alpha label indicating that the entry in the appropriate

position on the following card denotes whether the
simulation is forced to end a timestep at the beginning of
each month.
CUMTOL Alpha label indicating that the entry in the appropriate

position on the following card is the tolerance to use
when checking the gas production target(s).
RDFAC Alpha label indicating that the entry in the appropriate

position on the following card is the additional DCQ
reduction factor.
nyears Number of years in the contract(s). This entry is

required.
maxcyc Maximum number of DCQ reduction cycles in the first

pass of each contract year. When this number of cycles
has been performed, the second pass is performed.
Default is 5 if the MAXCYC entry is never included on a
GFO card.
YES Alpha label indicating that the simulation is forced to end

a timestep at the beginning of each month.
NO Alpha label indicating that the simulation is not forced to

hit the beginning of each month. This is the default if the
MONTH entry is never included on a GFO card.
cumtol Tolerance to use when checking the gas production

target(s) fraction. The DCQ will be reduced, and another
cycle performed, if the actual gas produced is not within
the tolerance of the required amount. Default is 0.9999 if
the CUMTOL entry is never included on a GFO card.
rdfac Additional DCQ reduction factor, fraction. When the

DCQ is reduced based on actual production divided by
required production, it is further multiplied by this factor
to help speed convergence. Default is 0.99 if the RDFAC
entry is never included on a GFO card.
CONTRACT Alpha label indicating that subsequent data (up to another

CONTRACT card or the ENDGFO card) applies to this

contract. At least one CONTRACT must have been

entered in the first set of GFO data.
area Area number or name. Specifying this data implies that

the multiple contracts option will be used, and that all the
production wells in this area are part of this contract
group. If this data is not entered, all production wells in
the field are considered to be in the single contract group.
SWING Alpha label indicating that the following 12 values on

this card are monthly swing factors for this contract.
sw Monthly swing factors for this contract, starting with

January. There must be 12 values. Default is 1.0 for each
factor if SWING is never included in GFO data.
PROFILE Alpha label indicating that the following 12 values on

this card are the monthly profile factors for this contract.
pr Monthly profile factors for this contract, starting with

January. There must be 12 values. Default is 1.0 for each
factor if PROFILE is never included in GFO data.
TAKE Alpha label indicating that the following 12 values on

this card are the monthly gas take factors for this
contract.
tk Monthly gas take factors for this contract, starting with

January fraction. There must be 12 values. Default is 1.0
for each factor if TAKE is never included in the GFO
data.
DCQ Alpha label indicating that the entry in the appropriate

position on the following card is the initial daily
contracted quantity (DCQ) for this contract. This must
be entered in the first set of GFO data.
DCQCON Alpha label indicating that the entry in the appropriate

position on the following card is the DCQ swing
condition for this contract. This must have been entered
in the first set of GFO data.
DCQLIM Alpha label indicating that the entry in the appropriate

position on the following card is the DCQ limiting factor
per cycle for this contract.
DCQANT Alpha label indicating that the entry in the appropriate

position on the following card is the anticipated DCQ
reduction factor per year for this contract.

dcq Initial daily contracted quantity for this contract, MSCF/

D (SM3/D). This must have been entered in the first set
of GFO data.
One of the next 5 entries must have been entered in the DCQCON position in
the first set of GFO data.
YEAR Alpha label indicating that the field, or contract area,

must be able to produce at the DCQ multiplied by the
monthly swing factor for the entire contract year.
INSTANT Alpha label indicating that the field, or contract area,

must be able to raise its production rate from DCQ times
profile to DCQ times swing for an instant at any time in
the contract year.
ACQ Alpha label indicating that the field must be able to

produce at DCQ times swing continuously until it has
produced the annual contracted quantity (ACQ). This
may not be used with the multiple contracts option.
month Possible values: JAN, FEB, MAR, APR, MAY, JUN,

JUL, AUG, SEP, OCT, NOV, DEC. The field must be
able to produce at DCQ times swing continuously until it
has produced a fraction of its annual contracted quantity
proportional to the sum of profile factors up to the end of
the specified month. This may not be used with the
multiple contracts option.
NO Alpha label indicating that the swing requirement will

not be tested. The DCQ will not be reduced even if the
field cannot produce at DCQ times profile.
dcqlim DCQ limiting factor per cycle for this contract, fraction.
The DCQ may not be reduced by more than this factor
times the original DCQ for each cycle for this set of GFO
data. Default is 0.0 (allowing unlimited reduction) if the
DCQLIM entry is never included in GFO data.
dcqant Anticipated DCQ reduction factor per year for this

contract, fraction. At the beginning of each subsequent
contract year, the current DCQ will be further multiplied
by this factor. Default is 1.0 if the DCQANT entry is
never included in GFO data.
ENDGFO Alpha label indicating the end of this set of GFO data.
Required. Simulation of the GFO contract year(s) begins
immediately at this point.
NOTE: 1. Almost all of the data that can be entered with the GFO card is
remembered when subsequent GFO data is entered. The only

required data in subsequent GFO data is NYEARS.
2. If area is specified on any CONTRACT card, then all CONTRACT

cards must have an area specified.
3. The data DCQ, DCQCON, DCQLIM, and DCQANT may all be

entered on one card or may be entered in any combination on multiple
cards.
4. When the maximum number of cycles, maxcyc, has been performed

during the first pass, the second pass is performed with the reduced
DCQ calculated at the end of that last cycle.
5. A contract year must start on the first day of a month.
6. Simulator output (e.g. WPLOT 1, PRINT WELLS TIME) that is

active at the time GFO data is entered is handled as follows:
a. TIME - the output is generated at the end of each

contract year.
b. TNEXT - the output is generated at the end of the last year
of the contract.
c. freq - the data is ignored and is not remembered when
the contract ends.

12.3 Annual Scheduling File (ASF)

An Annual Scheduling File (ASF) is required if any data changes or output reports
are required during the contract year. Once introduced, the ASF will remain in
effect for subsequent contract years, until replaced by another ASF.
ASF
(recurrent data)
(MONTH month)
(recurrent data)
(MONTH month)
.
.
.
ENDASF
Definitions:
ASF Alpha label indicating the beginning of the Annual

Scheduling File.
MONTH Alpha label indicating that a timestep will end at exactly

the beginning of the specified month.
month Month at which the timestep will end. Possible values:

JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP,
OCT, NOV, DEC.
recurrent data Any recurrent data allowed by the simulator except for
the keywords listed in the notes below.
ENDASF Alpha label indicating the end of the Annual Scheduling

File.
NOTE: 1. The data within the Annual Scheduling File is read and applied during
each GFO contract year.
2. A new ASF/ENDASF set of data replaces the previously specified set

of data.
3. To turn off the Annual Scheduling File, enter ASF/ENDASF with no

data in between.
4. Data entered between the ASF card and the first MONTH card (or the
ENDASF card if no MONTH card) applies at the beginning of each
contract year.
5. A MONTH card is not allowed for the month at which the contract
begins.

6. If multiple MONTH cards are entered, they must occur

chronologically following the month at which the contract begins.
7. The following data cards are not allowed within an ASF/ENDASF set
of data: TIME, DATE, STOP, END, WELL, WREST, WLASTR,
BLITZ, CBLITZ, TUNING, GFO, ASF.
8. Simulator output entered within the Annual Scheduling File is

handled as follows:
a. TIME - the output is generated at the beginning of each

month specified on a MONTH card and at the
end of each contract year.
b. TNEXT - the output is generated at the beginning of the
next month specified on a MONTH card or at the
end of the contract year, whichever occurs first.
c. freq - the output is generated every freq timesteps.

Chapter
13
Local Grid Refinement1
13.1 Introduction
The use of the Local Grid Refinement (LGR) option in VIP-EXECUTIVE
requires only a relatively small amount of additional input data. This involves
primarily the location of the well perforations relative to the grid refinements,
which must be specified unless the well is located entirely in the ROOT grid.
Other input data provide options for significantly improving the CPU run time
performance, particularly for multi-grid system runs involving mixed levels of
implicitness.
13.2 Formulation Options

In VIP-THERM, only IMPLICIT is allowed.
In VIP-COMP and VIP-ENCORE, two formulation options are available for use
with multi-grid systems; IMPES and IMPLICIT. The formulation option may be
switched at the beginning of any restart run. If no formulation specification is
entered in a run starting from initial conditions, the IMPES form of the finite
difference equations will be used. If no formulation specification is entered in a
restart run, the formulation will be the same as used during the previous run.
Unless otherwise specified, the same formulation option will be used for all of the
grids. However, significant CPU time savings may be achieved by varying the
level of implicitness to be used with each of the grids.
13.2.1 Formulation Specification by Grid (IMPGRID) (VIP-COMP or VIP-

ENCORE)
If entered, the IMPGRID/ENDIMPGRID data must occur along with other
utility data and should follow any IMPES/IMPLICIT data.
The IMPGRID keyword indicates that the following lines will declare the finite
difference formulation to be used for specific grids. This data must be followed by
an ENDIMPGRID keyword.
1. Available as a separately licensed option.
R5000.0.1 Local Grid Refinement 13-617

IMPGRID
gridnamei formulationi
ENDIMPGRID
Definitions:
IMPGRID Alpha label indicating the beginning of the formulation

specification data by grid.
gridnamei Name of the grid, as specified in the grid refinement data

in the initialization data set.
formulationi Type of finite difference formulation to be used for this

grid. It must be either IMPES or IMPLICIT. This can be
changed at the start of any restart run.
ENDIMPGRID Alpha label indicating the end of the formulation

specification data by grid.
Example:
IMPLICIT
C
RESTART 0
C
IMPGRID
ROOT IMPES
OILCOLMN IMPES
ENDIMPGRID
C
START
In this example, the IMPLICIT card first sets the formulation to IMPLICIT for all
grids. Then the ROOT grid and the OILCOLMN grid are reset to IMPES, leaving
all the radial well grids using the IMPLICIT formulation.
13.2.2 Turn Off Pressure Interpolation (NOPINT)

If entered, the NOPINT card must occur along with other utility data. This
option is not saved on the restart file and thus must be respecified at the
beginning of each run.
The NOPINT card is used to turn off the default pressure interpolation calculation
across grids. The default procedure is to do linear interpolations for pressures in
the parent block boundaries opposite refined gridblocks. This interpolation is
performed in all three directions, if there is communication in the respective
directions. However, for comparisons to results from previous simulator versions,
13-618 Local Grid Refinement R5000.0.1

this procedure may be turned off, resulting in the usage of constant pressures
across the parent gridblocks. In VIP-THERM the NOPINT card also turns off an
equivalent temperature interpolation calculation.
NOPINT
13.3 Activate/Deactivate Grids (Not available in VIP-THERM)

At initial conditions, all grid refinements are assumed to be active. However, any
refinement may be deactivated and/or reactivated at any time during the simulator
run. This feature may be used to achieve significant CPU time savings by
activating refined grids only during the simulation time at which there is
significant activity occurring within the grid. If a grid refinement is deactivated,
then all sub-refinements [children] of the grid are also deactivated. When a grid
refinement is activated, then all grid refinements which contain it [parents] are
also activated.
Only the pore volumes and transmissibilities at initial conditions are preserved
and reinstated as necessary, as grid refinements are deactivated and reactivated.
When a grid refinement that has been active for one or more timesteps is
deactivated, new values for the unknowns (pressure, composition, saturations,
etc.) are calculated for each of the gridblocks that had been refined in the parent
grid, such that precise material balance is maintained. When a grid is activated
after having been inactive for one or more timesteps, the unknowns of the parent
gridblocks are propagated directly to the refined gridblocks, again preserving
material balance. The activation/deactivation procedure is performed after all
input for the time interval has been read.
ACTIVATE gridname1 gridname2 . . . . gridnamen

DEACTIVATE gridname1 gridname2 . . . . gridnamem
Definitions:
ACTIVATE Alpha label indicating that the following named grids are
to be activated.
gridnamei Names of the grid refinements to be activated. If this list

contains only the keyword ALL, then all grid refinements
will be activated.
DEACTIVATE Alpha label indicating that the following named grids are
to be deactivated.
gridnamej Names of the grid refinements to be deactivated.

Example:
ACTIVATE ALL
DEACTIVATE WELL21 WELL28 WELL35
13.4 Timestep Controls

For multi-grid systems which may involve mixed levels of implicitness, it may be
necessary to have separate sets of maximum change parameters for both the
iteration and the timestep. To accomplish this, two new optional keywords have
been implemented: DTMPL and ITNMPL. When a DT keyword is read, the
maximum change parameters for both the IMPES grids and the IMPLICIT grids
are set to the values specified on the DT card. Also when an ITNLIM keyword is
read, the maximum change parameters for both the IMPES grids and the
IMPLICIT grids are set to the values specified on the ITNLIM card. If different
values are desired for the IMPLICIT grids, the DTMPL and ITNMPL keywords
must be used to specify the maximum change parameters for the IMPLICIT grids
only.
13.4.1 Timestep Controls for IMPLICIT Grids (DTMPL) (VIP-COMP or VIP-

ENCORE)
The DTMPL card defines the maximum changes allowed during the timestep for
IMPLICIT grids only. The values are order dependent, but only as many as
necessary need be entered. They will not affect the values used for IMPES grids.
DTMPL dpmax (dsmax) (dvmax) (dzmax) (card 1)
BOTH BOTH BOTH BOTH

DTONLY DTONLY DTONLY DTONLY
(card 2)
MAXONLY MAXONLY MAXONLY MAXONLY
NONE NONE NONE NONE
Definitions:
dpmax Maximum pressure change allowed during a timestep in

IMPLICIT grids, psi (kPa). Default is 500 psi.
dsmax Maximum water saturation change allowed during a

timestep in IMPLICIT grids. Default is 0.1.
dvmax Maximum gas saturation change allowed during a

dzmax Maximum change in total mole fraction allowed during a


The optional second card can be input to modify the usage of the new maximum
changes as to whether the appropriate maximum will be used for checking the
maximum change over the timestep, calculating the next timestep size, both of
these, or none.
Example:
DT -1 1 93 100 .03 .10 .04

DTMPL 300 .10 .10 .10
13.4.2 Iteration Controls for IMPLICIT Grids (ITNMPL) (VIP-COMP or VIP-

ENCORE)
The ITNMPL card defines the maximum changes allowed for each outer iteration
for IMPLICIT grids only. The values are order dependent, but only as many as
necessary need be entered. They will not affect the values used for IMPES grids.
ITNMPL dplim (dswlim) (dsglim)(dzlim)
Definitions:
dplim Maximum pressure change allowed during any single

outer iteration in IMPLICIT grids, psi (kPa). Default is
300 psia.
dswlim Maximum water saturation change allowed during any

single outer iteration in IMPLICIT grids. Default is 0.1.
dsglim Maximum gas saturation change allowed during any

single outer iteration in IMPLICIT grids. Default is 0.1.
dzlim Maximum change in primary phase composition allowed

during any single outer iteration in IMPLICIT grids.
Default is 0.1.
Example:
ITNLIM 1 10 100 .03 .10 .04

ITNMPL 300 .10 .10 .10

13.5 Matrix Solution Option (CBLITZ)

A new matrix solver package, CBLITZ, has been developed specifically for the
composite system of linear equations. CBLITZ is an iterative solver, using the
Preconditioned Generalized Minimum Residual (GMRES) method. CBLITZ must
be used for all multi-grid systems and for three-dimensional radial single-grid
systems using the FLOW360 feature. Other single-grid systems may still use
BLITZ, EXCEL, or GAUSS.
CBLITZ (param1) . . . (paramn) (card 1)

(value1) . . . (valuen) (card 2)
Definitions:
CBLITZ Alpha label indicating that the CBLITZ solver is to be

used for this run.
ITER A CBLITZ iteration summary should be printed. No

entry should be made on card 2 corresponding to this
entry.
NOITER A CBLITZ iteration summary should not be printed. This

is the default. No entry should be made on card 2
NORTH Maximum number of orthogonalizations used by the

GMRES method. Default is 10.
NIT Maximum number of CBLITZ iterations allowed.

Default is 20.
NITG Maximum number of subgrid iterations on each grid to

be performed for each CBLITZ iteration. Default is 1 for
Cartesian refinements and 3 for radial refinements.
NOPTG Ordering option for line constraints for each grid. The
grid ordering can have a significant effect upon
convergence. Typically a grid should be ordered first in
the direction of the strongest transmissibility, then in the
next strongest direction, etc. Also it may be beneficial to
order first in the direction of the smallest grid dimension,
then in the direction of the next smallest grid dimension,
etc. A value of 0 allows CBLITZ to determine the
ordering for each grid. Default is 0.
0 = Automatic determination.

3-D Problems:
1 = XYZ 3 = XZY 5 = YZX
2 = YXZ 4 = ZXY 6 = ZYX
2-D Problems:
1 = XY or XZ
2 = YX or ZX
NBEPS Composite grid preconditioning:
0= Sequential preconditioning
1= BEPS preconditioning
2= FAC preconditioning
Default is 2 when JCPR=1; default is 0 otherwise.
NHARM Preconditioning method for the subgrids. The current

implementation utilizes nested factorization, and the
input value is not used.
JCPR Constrained pressure residual method (CPR) option:
0= No pressure predictor step.

1= Use pressure predictor step.
Default is 1 if any grid is implicit.
RTOL Norm (EUCLIDEAN) residual reduction ratio

convergence tolerance parameter for the composite
system. Default is .005.
RTOLG Norm (EUCLIDEAN) residual reduction ratio

convergence tolerance parameter for each grid. Default is
.005.
ADJTOL Turns on the adjustable linear tolerance algorithm with

default values for TOLMN, TOLMX, TOLST and
TOLEX. No entry should be made on card 2
TOLMN Turns on the adjustable linear tolerance algorithm and

specifies the minimum value of linear tolerance to be
used throughout the simulation. Default is RTOL so that,
if RTOL is defaulted, then TOLMN defaults to 5.E-03
but, if RTOL is specified, then TOLMN is set to the
specified RTOL value. TOLMN must range between 0.0
and 1.0.
TOLMX Turns on the adjustable linear tolerance algorithm and

specifies the maximum value of linear tolerance to be
used throughout the simulation. Default is 0.5. TOLMX
must range between 0.0 and 1.0.

TOLST Turns on the adjustable linear tolerance algorithm and

specifies the value of linear tolerance to be used in the
first Newton step of each timestep. Default is
max(TOLMX, 5 * RTOL). TOLST must be less than
TOLMX and greater than or equal to 0.0.
TOLEX Turns on the adjustable linear tolerance algorithm and

specifies the value of the exponent in the power law used
to control the reduction of the linear solver tolerance as
the Newton iteration nears convergence. Default is 3.0.
TOLEX must be nonnegative.
NOTE: The pressure predictor step (JCPR=1) should only be used in conjuction with
the implicit formulation.
Example:
CBLITZ NORTH RTOL NITG RTOLG

20 .002 3 .002
13.5.1 CBLITZ Parameters by Grid (CBLGRID)

Three of the CBLITZ parameters can be modified on a grid-by-grid basis,
providing additional flexibility and efficiency for the solution of the linear system
of equations. If this data is introduced, it must immediately follow the CBLITZ
data. Any one, two, or all three of the parameter names may be introduced in any
order following the keyword CBLGRID. These parameters may be particularly
helpful with multi-grid systems involving mixed levels of implicitness. This data
must be followed by an ENDCBLGRID keyword.
CBLGRID (NITG) (NOPTG) (RTOLG)

gridname1 (nitg1) (noptg1) (rtolg1)
gridname2 (nitg2) (noptg2) (rtolg2)
. . . .
gridnamen (nitgn) (noptgn) (rtolgn)
ENDCBLGRID

Definitions:
CBLGRID Alpha label indicating that the following data will modify
some of the CBLITZ parameters on a grid- by-grid basis.
gridnamei Name of the grid.
NITG Alpha label indicating that this column of data will

change the maximum number of subgrid iterations for the
specified grid.
nitgi Maximum number of subgrid iterations to be performed

for this grid for each CBLITZ iteration.
NOPTG Alpha label indicating that this column of data will

change the ordering for the specified grid.
noptgi Gridblock ordering for the specified grid.
RTOLG Alpha label indicating that this column of data will

change the grid convergence tolerance for the specified
grid.
rtolgi Grid convergence tolerance for the specified grid.
ENDCBLGRID Alpha label indicating the end of the CBLITZ parameter

input by grid.
Example:
CBLGRID NITG
ROOT 1
OILCOLMN 1
ENDCBLGRID
From the previous example, the NITG parameter was first initialized to 3 for all
grids. Then with the above example data, the NITG parameter is reset to 1 for both
the ROOT grid and the OILCOLMN grid. Thus the CBLITZ solver would
perform a maximum of three subgrid iterations on each of the implicit radial well
grids and one subgrid iteration on the ROOT and OILCOLMN grids for each
CBLITZ iteration.

13.6 Well Data Options

For multi-grid systems, it may be necessary to specify in which grid(s) that the
well resides, in addition to the standard IW and JW well location. If no additional
data is entered, the well is assumed to be in the ROOT grid, and the IW and JW
are relative to that grid. However, if the well perforations are in one or more of the
grid refinements, then the grid name must be specified on either the WELL card
or the FPERF card. If the well perforations are all within the same grid, then the
grid may be specified on the WELL card. If the well perforations are in two or
more grids, then the grid must be specified for each of the perforations, along with
the proper IW and JW relative to the grid.
13.6.1 Well Name and Location (WELL)
WELL . . . . (GRID) . . . .
. . . . (gridname) . .
Definitions:
GRID Alpha keyword indicating that this field will contain the
grid name in which the well is perforated.
gridname Name of the grid in which this well is perforated. If

entered, the iw, jw well location must be relative to this
grid.
Example:
WELL N NAME IW JW GRID

1 P1 X X P1
2 P2 X X P2
3 P3 26 23 OILCOLMN
4 P4 X X P4
5 P5 5 10 OILCOLMN
6 P6 X X P6
8 P8 X X P8
9 P9 X X P9
10 P10 X X P10
11 P11 X X P11
13 P13 X X P13
15 P15 X X P15
FPERF
WELL . . . . (GRID) . . . .
. . . . (gridname) . .

Definitions:
GRID Column heading for gridname, the name of the grid in

which this well perforation is located. The iw, jw and l, if
entered for the perforation, must be relative to this grid.
NOTE: 1. If the well is in a radial grid and numerical values for (IW, JW) have not
been specified in the FPERF data or in any previous WELL name and
location data, then perforations will be automatically generated in
IW=1, for JW=1,2,...,NTHETA for the radial grid.
2. For radial wells the alpha label X can be specifed for IW and JW.
3. This is for radial refinements and root grid with FLOW360 option. For
perforations in the first ring (IW=1) the following applies:
dθ
wil = --------------------------------------------------------
radb
ln ⎛ ------------⎞ + skin + Sr
⎝ radw⎠
where dθ is the gridblock angle. The default radb is the gridblock
centroid (log mean radius with BLOCKTR option). The default radw is
ri.
Example:
FPERF
WELL L KH GRID IW JW
1 1 4320 P1 X X
X 2 972 P1 X X
2 1 872 P2 X X
X 2 84 P2 X X
4 1 648 P4 X X
6 1 2800 P6 X X
X 2 112 P6 X X

13.7 Assign Gridblocks to Injection Regions (INJREGN)

See Section 4.5.6 for further discussion.
INJREGN nir (NOCASCADE)

i1 i2 j1 j2 k1 k2 (gridname)
Definitions:
NOCASCADE Alpha label indicating that this region number should not
be cascaded to any grids located within the gridblocks
defined in the data specified.
gridname Name of the grid to which this gridblock range applies. If

the gridname is not entered, the data is assumed to apply
to the root grid.
NOTE: If NOSASCADE is not entered, the region number will be cascaded to lower
level grids contained within these ranges.
13.8 Options Restricted to Use with Single-Grid Systems Only

n Boundary Flux Option
n Pattern Well Average Pressure Option
n Pattern Element Option
13.9 Arbitrary Gridblock Connections (FTRANS)
FTRANS
(GRID name1 (name2))
i1 j1 k1 i2 j2 k2 t tt
(repeat as necessary)
Definitions:
name1 Name of grid1. Default is ROOT.
name2 Name of grid2. Default is name1.
See Section 8.6.5 for additional definitions.

13.10 Override Modification (OVER)

(GRID name)
i2 j2 k2
i1 j1 k1 #v (v2) (#v (v2)) (#v (v2)) (#v (v2))
NX NY NZ
Definitions:
name Name of the grid. Default is ROOT.
NOTE: Operations only apply to the specified grid, i.e., no propagation.
13.11 Value Override (VOVER)

(GRID name)
i2 j2 k2
i1 j1 k1 (op)
NX NY NZ
values as necessary
Definitions:
name Name of the grid. Default is ROOT.
NOTE: Operations only apply to the specified grid, i.e., no propagation.


Chapter
14
00000 Tracer Option1
14.1 Introduction
This is short description of a set of tools which have been developed to improve
and expand the simulation capabilities in the analysis and interpretation of tracer
tests and in the design and performance analysis of secondary recovery projects.
The tools are built around the particle tracking method which allows accurate
simulation of tracer flow associated with convection and physical dispersion. The
method is nearly numerical dispersion free and allows accurate simulation of
tracer flow in field scale simulation. The algorithm is implemented in VIP-
EXECUTIVE and allows simulation of tracer flow within the framework of three-
dimensional, multi-phase, non-steady state reservoir simulation. In addition to
accurate simulation of tracer flow the software allows: (1) tracking of fronts in
flooding operations; (2) construction of three-dimensional flow trajectories and
streamlines of velocity field; (3) calculation of the areal sweep; (4) visualization
and animation of tracer flow. Both gas and water tracers are allowed in the tracer
option. Tracers can be phase partitioning or non-partitioning . Tracers can
partition between gas/oil, oil/water, gas/oil/water or gas/water (see note following
Section 14.2.3). 00
14.2 VIP Tracer Option Input Data Description

All tracer option related input cards in the simulation modules fall into three
sections: Utility Data, Recurrent Data, and Output Control Data. The run control
data of the Utility Data section include three parameters in the DIM card which
change the default dimension of the parameters used in the tracer option and the
FRONT card which invokes the front tracking option. The TRACER card and the
TRACIN card are recurrent data. The TRACER card defines some parameters and
specifies options which will be used in the simulation run. The TRACIN card
controls the tracer injection. And, finally, the Output Control Data database
section includes the WTRACE card and the WTRPLOT card which control output
to the tracer, and the PRINT TRACER card which controls tracer option output to
the simulator output file. 00
1. Available as a separately licensed option. Not available in VIP-THERM.
R5000.0.1 Tracer Option 14-631


The card allows the user to change the default dimensions on any run starting
from initial conditions (time zero) and to increase the dimensions passed on to a
restart. 00
DIM NPRTM NTRCEM NTRWLM

nprtm ntrcem ntrwlm
00 Definitions:
NPRTM Alpha label for the maximum of the total number of

tracer particles to be defined in this run. Default is 5000.
nprtm The value of the corresponding parameter.
NTRCEM Alpha label for the maximum number of tracers to be

ntrcem The value of the corresponding parameter.
NTRWLM Alpha label for the maximum number of simultaneous

tracer injectors to be defined in this run. (Maximum
number of TRACIN cards for this run. See section
12.2.4). Default is 2.
ntrwlm The value of the corresponding parameter.
14.2.2 Activate Front Tracking Option (FRONT)

00 If entered the FRONT card must occur along with other utility data.
The FRONT card activates the front tracking option. It allows tracking of the
injected water front in a unit mobility ratio displacement (water-water
displacement) or the water front in an oil displacement by water. To use the front
tracking option the user must inject tracer (TRACIN card) at the moment when
the water injection starts. By default, activation of the tracer option in VIP-CORE
does not automatically activate the front tracking option. This option cannot be
used with the gas tracer option. 00
FRONT (WWDSP)
00 Definition:
WWDSP Optional alpha label indicating that this is water-water

displacement. Default is oil-water displacement.
14-632 Tracer Option R5000.0.1

14.2.3 Define Parameters for Tracer Option (TRACER)

This group of input cards defines some parameters for tracer option calculations.
The TRACER card indicates the beginning of the group. The remaining cards
must closely follow. Most of the cards are optional. The card order within the
group is not important. This group of cards belongs to the recurrent utility data
cards of the simulation modules and can appear several times within the input data
set if it is necessary to redefine some of the parameters later into the run. 00
TRACER ntrcw ntrcg (nsubt)

(NAMES name1 name2 ... namentrcw + ntrcg)
⎛ ⎞
⎜ ⎛ Kw ⎞ Kg ⎟
⎜ KVALUE ntr ⎜ ⎟ ⎟
cname1 ( cname2 fac )
⎜ trname ⎝ P KW ⎠ ⎟
⎝ P KG ⎠
⎛ ⎛ ⎞ ⎞
⎜ ⎜ W⎟ ⎟
⎜ ISO ⎜ G⎟ dspl⎟
⎜ ⎜ ⎟ ⎟
⎝ ⎝ O⎠ ⎠
⎛ ⎛ ⎞ ⎞
⎜ ⎜ W⎟ ⎟
⎜ ANISO ⎜ G⎟ dspl dspt⎟
⎜ ⎜ ⎟ ⎟
⎝ ⎝ O⎠ ⎠
(BOUNDARY xdir ydir zdir)

(CENTER)
(ORIGIN)
(TRCOFF)
Definitions: 00
ntrcw Number of water tracers to be used in the run.
ntrcg Number of gas tracers to be used in the run.
nsubt Number of tracer substeps per simulator timestep.

Default is 1.
NAMES Alpha label indicating that names of tracers follow on

this card.
namei Name of tracer i. An alphanumeric label containing up to

8 characters.
KVALUE Alpha label for specifying the k-value of a partitioning

tracer. Default is non partitioning.

ntr Tracer identification number.
trname Tracer identification name.
Kw Oil/water tracer partitioning k-value (constant).

Definition: (Mole fraction of tracer in the oil phase)/
(Mole fraction of tracer in the aqueous phase)
Kw = -0.5 is interpreted as Kw = infinite, and the tracer is
a non partitioning oil tracer.
Kg Gas/oil tracer partitioning k-value (constant).

Definition: (Mole fraction of tracer in the gas phase)/
(Mole fraction of tracer in the oil phase).
Kg = -0.5 is interpreted as Kg = infinite, and the tracer is
a non partitioning gas tracer.
cname1 Hydrocarbon component name used to compute Kg

internally by the simulator. Kg = k-value of cname1.
cname2 Hydrocarbon component name used to compute Kg

internally by the simulator as a linear combination of the
k-values of cname1 and cname2.
Kg = (k-value of cname1)* fac +
(k-value of cname2)*(1-fac)
fac Weighting factor for computing Kg from the

k-values of cname1 and cname2.
P, KW, KG Alpha labels indicating that (pressure, kvalue) table data

pairs will follow. When entering both KW and KG data,
either can be terminated by a value of -1 in the
appropriate pressure column. The model interpolates
these data in the ln(K) vs. ln(P) space.
ISO Alpha label which turns on isotropic dispersion

calculations. Defines the value of dispersivity coefficient.
ANISO Alpha label which turns on anisotropic dispersion

calculations. Defines the values of longitudinal and
transversal dispersivity coefficients.
W Alpha label indicating the dispersivity specified is for the

water phase. Default applies to all three phases.
G Alpha label indicating the dispersivity specified is for the

gas phase. Default applies to all three phases.
O Alpha label indicating the dispersivity specified is for the

oil phase. Default applies to all three phases.
dspl Longitudinal dispersivity, ft. Default is 0.

dspt Transversal dispersivity, ft. Default is 0.
BOUNDARY Alpha label which defines boundary conditions in the x,

y, and z directions. Physical dispersion of tracer is
modeled by appropriate random adjustment of particle
positions at the end of the timesteps. This adjustment
may bring a particle outside the model. Particles can also
cross the boundary with convective flow due to large
timesteps.The user can prevent this by defining
appropriate boundary conditions.
xdir, ydir, zdir Alpha labels (FLOW, NOFLOW) which define boundary
conditions for dispersion calculations in the x, y, and z
directions, respectively. The FLOW label indicates that
particles can cross the boundary, and the NOFLOW label
specifies that particles will be reflected by the boundary.
Default is NOFLOW.
CENTER Alpha label which overrides default well locations in the

grid blocks.
ORIGIN Alpha label specifying that there is a well at the origin of

the radial grid system.
TRCOFF Alpha label which turns off tracer option calculation.
NOTE: 1. For a water tracer, Kg is optional on the KVALUE line, while for a
gas tracer, Kw is optional on the KVALUE line.
2. For any tracer, if both Kw and Kg are defined, then three phase, gas/
oil/water partitioning will be modeled. (This will reduce to gas/water
partitioning if the oil phase is missing)
3. Gas/water tracer partitioning can be modeled as described by note 2,

or by setting Kw = 1, and defining Kg as the ratio (mole fraction of
tracer in the gas phase)/(mole fraction of tracer in the water phase), or
by setting Kg = 1, and defining Kw as the ratio (mole fraction of
tracer in the gas phase)/(mole fraction of tracer in the water phase).
Example:
00 TRACER 0 3 2 ! FOR 3 GAS TRACERS

NAMES C-14 Co-60 SR-90
CENTER
ISO 1.
BOUNDARY FLOW FLOW NOFLOW
14.2.4 Inject Tracer (TRACIN)

The TRACIN card defines the tracer injections. Parameters in the card are order

dependent. 00
TRACIN ntr itrwell npart (nplanes) (trcvol) (trconc) (al1 al2)
00 Definitions:
ntr A tracer number from the list of tracers, or a tracer name

from those defined by the NAMES card.
itrwell The well number or name of the well injecting the tracer.
npart The number of tracer particles to be introduced with this

tracer injection.
nplanes The number of planes along which to place new particles.

Default is 1 plane.
trcvol The volume of traced water or gas to be injected, in bbls.

Default is 1 bbl.
trconc The concentration of tracer injected. Default is 1.0
al1 al2 The values of two angles which define the sector near the
well to place the particles. The angles are counter-
clockwise with the positive direction of x-axis, degrees.
al1 is the starting angle, al2 is the sector angle. Default is
the full circle around the well.

14.2.5 Write Map Records to Database (WTRACE)

00 This card controls map output to the tracer data base.
⎛ TIME ⎞
WTRACE ⎜ ⎟ ( freq )
⎜ TNEXT ⎟
⎝ OFF ⎠
00 Definitions:
TIME Alpha label that causes the record to be written each time
a TIME or DATE card is encountered. Default is not to
print on the basis of TIME or DATE cards.
TNEXT Alpha label that causes the record to be written only the
is not to print on the basis of the next TIME or DATE
card.

freq A number that causes the record to be written after every

freq timesteps. Default is 99999.
14.2.6 Write Plot Records to Database (WTRPLOT)

00 This card controls map output to the tracer data base.
⎛ TIME ⎞
WTRPLOT ⎜ ⎟ ( freq )
⎜ TNEXT ⎟
⎝ OFF ⎠
00 Definitions:
card.



14.2.7 Write Records to Tracer File (WTRDBG)

00 This card controls output to the tracer output file (Fortran unit 38).
⎛ TIME ⎞
WTRDBG ⎜ ⎟ ( freq )
⎜ TNEXT ⎟
⎝ OFF ⎠
00 Definitions:
card.



14.2.8 Write Tracer Summary (PRINT TRACER)

The PRINT card has an additional alpha label which causes output of the tracer
summary report. 00
⎛ TIME ⎞
PRINT TRACER ⎜ ⎟ ( freq )
⎜ TNEXT ⎟
⎝ OFF ⎠
00 Definition:
TRACER Alpha label that causes the tracer summary report to be

written to the simulator output file.
card.




Chapter
15
Parallel Computing1
00000
15.1 Parallel Grid Assignment
15.1.1 Introduction
Assignment of parallel processors to grids is a critical task to maintain parallel
efficiency. The goal of processor assignment should be to maximize efficeincy
while at the same time minimizing the required parallel resources. Since a red/
black ordering is used in the linear equation solution, for any parallel simulation
the maximum efficiency for the solver is achieved by assigning two neighboring
grids to each processor so that calculations on “red” and/or “black” grids are
performed in an alternating fashion on the same processor. On the other hand, for
compositional simulations in which the solver CPU time is not dominant, the
maximum parallel performance can be obtained with each grid being assigned to a
separate processor.
15.1.1 Processor Mapping File

The mapping of grids to processors is assigned in the standard input file to the
simulator (i.e., fortran Unit 6). This file is generated automatically by the PAVA
job submittal panel. For command line execution the following information is
required. The file contains four types of information: the location of the
EXECFIL for VIP-EXEC, the location of restart files for the parallel restarts, the
grid and processor information and the assignment of processors to grids. Each
line of input data for the mapping file is described below: 00
execfil
restart
nproc ngrids idebug
gridi processor
gridi+1 processor
. .
. .
. .
gridngrids processor
1. Not yet available in VIP-THERM.
R5000.0.1 Parallel Computing 15-641

Definitions: 00
execfil Fully qualified name of the execfil.dat file input to VIP-

EXEC.
restart Fully qualified name of the restart file read by VIP-

EXEC.
nproc Number of processors.
ngrids Number of grids.
idebug Debug control flag.
idebug = 0 for no debug output

idebug = 1 will produce debug output from all
processors.
gridi Particular grid assigned to a particular processor. Grids

are identified by numbers as printed in the process id file
of VIP-CORE, (fortran unit 15).
processor Processor number assigned to grid. Processor number can

be any number between 1 and nproc inclusive.
Example Data: 00
8 grids plus ROOT grid and 4 processors
Grid2 Grid3 Grid4 Grid5
Grid6 Grid7 Grid8 Grid9
15-642 Parallel Computing R5000.0.1

The mapping file would appear as follows:
/vip/usr/xxx/execfil.dat
/vip/usr/xxx/casei.rst
4 9 0
1 1
2 1
3 1
4 2
5 2
6 3
7 3
8 4
9 4
The ROOT grid is always grid number 1.
R5000.0.1 Parallel Computing 15-643

15-644 Parallel Computing R5000.0.1

References
References
1. Beggs, H. Dale, Gas Production Operations, OGCI Publications, pp. 103-104
(1984).
2. Peaceman, D.W., "Interpretation of Well-Block Pressures in Numerical

Reservoir Simulation", Soc. Pet. Engr. J., pp. 183-194 (June, 1978).
3. Jain, A.K., "An Accurate Explicit Equation for Friction Factor", J. Hydraulics
Div. ASCE, Vol 2, No. Hy5 (May, 1976).
4. Wallis, J.R., "Incomplete Gaussian Elimination as a Preconditioning for

Generalized Conjugate Gradient Acceleration", SPE 12265 presented at the
Seventh SPE Symposium on Numerical Simulation, San Francisco (1983).
5. Wallis, J.R., Kendall, R.P., and Little, T.E.: "Constrained Residual

Acceleration of Conjugate Residual Methods", paper SPE 13536 presented at
the Eighth SPE Symposium on Reservoir Simulation, Dallas (1985).
6. Meter, D.M. and Bird, R.B., "Tube Flow of Non-Newtonian Polymer

Solutions: Part I Laminar Flow and Rheological Models", AICHE Journal,
Vol. 10, No. 6, Nov. 1964, p. 1143-1150.
7. Hong, C., "Development of a 2-D Micellar/Polymer Simulator", PhD.

Dissertation, The University of Texas at Austin, 1982.
8. Hirasaki, G.J., "Ion Exchange with Clays in the Presence of Surfactant", Soc.
Pet. Eng. J. (April 1982), p. 181-192.
9. Modine, A.D., Coats,K.H., and Wells, M.W., "A Superposition Method for
representing Wellbore Crossflow in Reservoir Simulation," SPE 20746
presented at the 65th Annual Technical Conference and Exhibition of the
Society of Petroleum Engineers, New Orleans (1990).
10. Young, L.C., "Equation of State Compositional Modeling on Vector

Processors", SPE paper 16023 presented at the Ninth SPE Symposium on
Reservoir Simulation, San Antonio, Texas, February 1-4, 1987.
11. Peng, D.Y., and Robinson, D.B., "A New Two-Constant Equation of State", I
and E.C. Fundamentals (1976) 15, No. 1, pp. 59-64.
12. Redlich, O., and Kwong, J.N.S., "On the Termodynamics of Solutions V. - An
Equation of State Fugacities of Gaseous Solutions", Chemical Review (1949)
Vol. 44, pp.52-63.
R5000.0.1 References R-645

13. Odeh, A.S., “An Equation for Calculating Skin Factor Due to Restricted
Entry”, JPT, June 1980, pp. 964 - 965.
R-646 References R5000.0.1

Keyword
Index
000000Keyword Index ANSBEG 10-506, 10-510

AP1 9-480
AP2 9-480
AP3 9-480
APPEND 4-306, 4-310
ARCMP 6-383
A AREA 2-65, 2-66, 3-118, 3-196, 3-207, 3-214,
3-215, 3-218, 4-223, 4-225, 4-226, 4-
A 3-207, 4-327 230, 4-233, 4-236, 4-237, 4-240, 4-241,
ABORT 3-207, 7-438 4-243, 4-244, 4-246, 4-247, 4-249, 4-
ABSRES 7-436 251, 4-252, 4-254, 4-264, 4-265, 4-266,
ABSTOL 7-436 4-267, 4-283, 4-284, 4-290, 4-295, 4-
ACC 8-457 296, 4-301, 4-304, 4-306, 4-308, 4-311,
ACPGCR 10-504, 10-508, 10-548 4-313, 4-315, 4-318, 4-321, 4-323, 4-
ACQ 12-610 325, 4-328, 5-339, 5-343, 5-345, 5-349,
ACTION 5-352 5-351, 5-352, 5-353, 5-358, 5-360, 5-
ACTIVATE 13-619 362, 6-397, 10-521
ADD 4-304, 4-316, 6-379, 8-468 ARLYR 6-383
ADDNGL 3-114 ARRAYS 6-382
ADJFPERF 11-605 ARTLFT 5-344
ADJSPN 11-605 ASF 12-615
ADJTOL 7-445, 13-623 ATWAG 3-182, 3-183
ADJTUBING 11-605 ATWGCL 3-188
ADJWI 11-605 ATWGCT 3-189
ADJWLFL 11-605 ATWGVA 3-187
ADP1 9-480 AUTO 3-192, 4-306
ADP2 9-480 AUTOCYCLE 2-74
AFTER 3-214 AVG 4-231, 5-352, 5-353
ALABEL 3-207 AVGGOR 4-231
ALL 2-65, 2-66, 3-115, 3-185, 3-207, 4-225, 4- AVGLOR 4-231
240, 4-242, 4-250, 4-305, 4-306, 4-316, AVGWCT 4-232
5-345, 5-347, 5-352, 6-393, 6-410, 6- AVGWOR 4-231
411, 7-439, 10-514, 10-556 AZIZ 3-203, 10-509
ALLCOMP 6-392
ALLWELLS 4-225
ALLWLS 4-291
ALQ 3-167, 3-175
B
ALSOCHILDREN 6-380
B 4-327
ANGLA 3-90
BATCH 7-451, 7-452
ANGLE 10-500, 10-504
BEGGS 3-100, 3-203, 10-505, 10-509
ANGLV 3-90
BENEFIT 5-352, 5-353
ANISO 14-633
BETAP 9-484
ANSARI 10-505, 10-510
R5000.0.1 KI-647
BHITAB 3-173, 10-541 CPERF 3-213

BHLTAB 10-517 CPINJ 9-485
BHP 3-112, 3-157, 5-364, 7-439 CPLOT 2-66
BHP(IQ) 10-542 CPROD 3-207
BHP(IQI) 3-173 CPUWMG 6-376
BHP(ITHP) 3-167, 3-173 CRK 9-480
BHPADD 3-175 CROSS 6-408
BHPI 3-207 CSE1 9-484
BHPITN 3-164 CSEP 9-484
BHPP 3-207 CSTART 3-214
BHPTAB 3-167, 10-517 CSTOP 3-215
BHPWAG 3-200 CUMTOL 12-610
BHTEMP 10-530 CURVE ELEVPR 10-500
BHVTAB 10-517 CURVE IDPR 10-502
BINARY 2-69, 6-406, 6-407 CURVE IPVTPR 10-503
BLITZ 7-443 CURVE TEMPPR 10-498
BOTH 7-428, 13-620 CURVE TMGRPR 10-499
BOUNDARY 14-633 CURVE VCPR 10-501
BP 9-480 CUTOFF 5-352
BRK 9-480 CYCLE 3-207
BUILDUP 6-386 CYCLETABLE 3-207
CYCLIC 3-212
C
D
C 1-48, 4-327
CAINJ 9-486 D 4-327
CATEGORY 5-352 DAMP 2-63
CBHPMN 7-439 DATE 2-74, 2-77
CBLGRID 13-624 DATUM 6-405
CBLITZ 13-622 DAYS 4-229, 4-317, 5-341
CCNDN 2-66 DBOT 3-86
CENTER 14-633 DCQ 12-610
CHKTAB 7-439 DCQANT 12-610
CINJ 3-207 DCQCON 12-610
CLINJ 9-485 DCQLIM 12-610
CLOSE 4-300, 10-514 DDIAM 11-598, 11-599, 11-605
CNDBNK 3-216 DEACTIVATE 13-619
CNDBWL 3-217, 3-218 DECLASS 5-360
CNDN 2-66 DEF 6-393
CNVFAIL 6-376 DELETE 6-379
CNVFLOFF 6-376 DELTAP 4-275
COMP 3-105, 3-107 DENS 10-537
COMPERF 3-202 DENSITY 3-181
CON 3-191 DEPI 3-207
CONDENSATE 4-330 DEPP 3-207
CONTRACT 12-610 DEPTH 10-499, 10-508
CONTROL 10-513 DHCOR 10-504
CORERST 2-58 DHTOP 3-87
CP 9-478 DIAM 3-90, 3-181, 3-202
CPADS 9-478 DIAMETER 10-504, 10-508
KI-648 R5000.0.1
DIFFUSION 8-476 ENDCBLGRID 13-624

DIM 2-58, 9-477, 10-565, 14-632 ENDDRILLWELL 4-310
DISSOL 10-530 ENDGFO 12-610
DIST 4-255 ENDIMPGRID 13-618
DIV 8-468 ENDINC 1-49
DJKSEP 3-103 ENDPOINT 3-122, 3-124, 3-125
DKH 11-598, 11-605 ENDSEP 3-103
DKRG 11-598, 11-605 ENDSTEP 5-352, 5-353
DKRW 11-598, 11-605 ENDTUNING 11-594
DLENGTH 11-598, 11-599, 11-605 ENDWINDOW 6-379
DLIQ 3-105, 3-107 EPHIP 9-483
DOBJMN 10-567 EQ 8-468
DOBJND 10-568 EQUIL 8-473
DPBHMX 3-160, 3-193 ESALT 9-478
DPRGR 11-598, 11-599, 11-605 EST 8-458
DRILL 4-310 ETRGOP 4-250
DRILLQUEUE 4-305 EXCEL 7-442
DRILLWELL 4-310 EXCLUDE 5-352
DRLRIG 4-304 EXPONENT 3-147
DRLTRG 4-308
DROUGH 11-598, 11-599, 11-605
DRYTRG 3-114
DSGR 11-598, 11-605 F
DSWR 11-598, 11-605
DT 7-428, 9-490 FACFIL 6-384
DTCUTF 7-440 FACUTL 6-384
DTMPL 13-620 FASTSIM 7-448
DTONLY 7-428, 13-620 FGRBGN 5-365
DTOP 3-86 FGRINC 5-365
DTPWM 5-346 FIELD 2-65, 2-66, 3-118, 3-196, 3-207, 3-214,
DTQMAX 7-430 3-215, 3-218, 4-225, 4-226, 4-230, 4-
DTSOAK 3-207 233, 4-236, 4-237, 4-240, 4-242, 4-243,
DTWAG 3-201 4-244, 4-246, 4-247, 4-249, 4-250, 4-
DUKEAT 10-505 251, 4-252, 4-254, 4-264, 4-265, 4-266,
DUKLER 10-505 4-267, 4-275, 4-281, 4-283, 4-290, 4-
DUNROS 3-203, 10-509 295, 4-296, 4-301, 4-304, 4-306, 4-308,
DWI 11-598 4-311, 4-313, 4-315, 4-318, 4-321, 4-
323, 4-325, 4-328, 5-339, 5-343, 5-345,
5-349, 5-351, 5-352, 5-353, 5-358, 5-
360, 5-362, 6-382, 6-397, 10-521
E FILE 7-451
FILENUMBER 10-560
E 4-327 FIXGL 5-365
ECOLIM 3-135 FLASH 8-457
EDGE 3-185 FLDCMP 6-383
EFF 5-365, 5-366 FLLYR 6-383
EFFSCL 4-298 FLOANG 3-156
EFFTAB 5-366 FLOSTA 2-65, 2-66, 3-118, 3-196, 3-207, 3-
ELEVPR 10-504, 10-508 214, 3-215, 3-218, 4-223, 4-225, 4-226,
END 2-78 4-230, 4-233, 4-236, 4-237, 4-240, 4-
ENDASF 12-615 241, 4-243, 4-244, 4-246, 4-247, 4-249,
ENDCATEGORY 5-352 4-251, 4-252, 4-254, 4-264, 4-265, 4-
R5000.0.1 KI-649
266, 4-267, 4-283, 4-284, 4-290, 4-294, GASCOND 4-255

4-296, 4-301, 4-304, 4-306, 4-308, 4- GASFUL 4-244
311, 4-313, 4-315, 4-318, 4-321, 4-323, GASINJ 4-307
4-324, 4-328, 5-339, 5-343, 5-345, 5- GASLIF 10-548
349, 5-351, 5-352, 5-353, 5-358, 5-360, GASLIFT 10-560
5-362, 6-397, 10-521 GASMAX 3-193
FLOW 10-514, 14-635 GASMIN 3-193
FLOWIN 7-433 GASMKP 4-247
FLOWVEC 2-71 GASPERC 8-460
FLPOT 6-383 GASPLANT 3-110
FLUX 6-384 GASPROD 4-307
FM 3-97 GASRATE 3-167
FORM 2-65, 2-66, 2-69, 6-406, 6-407 GASRMON 8-460
FPERF 3-83, 9-487, 10-539, 13-626 GASSKG 4-243
FPO 4-246 GASSLS 4-246
FPROD 4-243, 4-244, 4-246, 4-248 GASSPM 10-520
FREQUENCY 3-147 GASTHP 3-177
FRES 3-117, 3-196, 3-207, 4-283 GASWAT 4-233
FRESN 4-283 GASWELL 3-186
FRG 10-520 GATHER 2-65, 2-66, 3-118, 3-196, 3-207, 3-
FRGFO 10-520 214, 3-215, 3-218, 4-223, 4-225, 4-226,
FRLOSS 10-548 4-230, 4-233, 4-236, 4-237, 4-240, 4-
FRO 10-520 241, 4-243, 4-244, 4-246, 4-247, 4-249,
FROM 3-128 4-251, 4-252, 4-254, 4-264, 4-265, 4-
FRONT 14-632 266, 4-267, 4-283, 4-284, 4-290, 4-294,
FRPGCR 10-504, 10-508, 10-548 4-296, 4-301, 4-304, 4-306, 4-308, 4-
FRW 10-520 311, 4-313, 4-315, 4-318, 4-321, 4-323,
FSALES 4-248 4-324, 4-328, 4-331, 5-337, 5-339, 5-
FSCMP 6-383 343, 5-345, 5-349, 5-351, 5-352, 5-353,
FSLYR 6-383 5-358, 5-359, 5-362, 6-398, 10-521
FSTD 3-117, 3-196, 3-207, 4-283 GAUSS 7-442
FTRANF 8-471 GCCMP 6-383
FTRANS 8-470, 13-628 GCLYR 6-383
FTWMIX 4-333 GE 8-464
FVEG 3-89 GEL 9-487
FVEGF 3-97 GFIRST 3-196
FVEW 3-88 GFO 12-610
FVEWF 3-97 GIBBS 8-455
FXFORM 6-407 GIBOFF 8-457
GINJ 4-309
GINJMOB 3-124
GINJOP 4-268
G GLAST 3-196
GLDAMP 4-298
G 3-115, 3-117, 3-135, 3-173, 3-207, 4-226, 4- GLEFMN 4-297
230, 4-235, 4-237, 4-240, 4-242, 4-283, GLGMAX 4-294
4-284, 5-339, 5-345, 5-353, 10-541, 14- GLGMIN 4-295
633 GLGOP 4-300
GAMHF 9-481 GLIMIT 3-132
GAMMAC 9-481 GLR 3-167, 4-292, 11-595
GAS 4-233, 5-364, 8-475, 10-514, 10-535, 10- GLR(IQ) 10-542
566, 11-603 GLRADD 4-296
KI-650 R5000.0.1
GLRM 5-352
GLRMAX 3-193, 4-298 I
GLRMIN 4-298
GLRTAB 4-292 IALQ 3-167
GLRTBP 4-293 IBAT 3-80, 10-516, 10-520
GLVDZ 10-530 ICMT 3-88
GOR 3-137, 3-167, 4-231, 4-292, 10-560, 11- ICMTF 3-96
595 ID 10-502
GOR(IQ) 10-543 IDPR 10-513
GORCON 3-147 IGC 3-80
GORLIM 3-147 IGLR 3-167
GORM 5-352 IGNORE 10-547
GORMAX 3-193 IGOR 3-167
GORPEN 3-146 IMPES 2-65, 13-618
GPMIN 4-320 IMPGRID 13-618
GPROD 4-309 IMPLICIT 2-64, 13-618
GRAD 3-90 IMPSTAB 7-433
GRATE 4-231, 11-594 IMPTHP 3-159
GRATIO 3-171 IMPWEL 7-447
GRID 3-80, 3-85, 3-97, 8-463, 8-465, 8-466, 8- INCLUDE 1-48, 10-547
469, 9-481, 9-491, 13-626, 13-628, 13- INCR 4-309
629 INFLUX 4-274
GRIDBLOCK 6-405 INITSLUG 3-196
GRIFFI 3-203 INJ 3-117, 4-225
GRIFFITH 10-509 INJA 3-124
GROUP 4-305, 4-325, 4-326 INJGR 4-284
GRPGCR 10-504, 10-508, 10-548 INJMIN 4-241
GSMIN 4-320 INJREG 4-237, 4-269, 4-275, 4-281, 4-306, 4-
GTHPWL 3-177 308, 4-311
GURTR 4-284 INJREGN 4-273, 13-628
GURTS 4-284 INJRGR 4-272
INJRNM 4-271
INJTAR 4-282
INNER 3-185
H INPLACE 6-389
INSTANT 12-610
H 3-86, 3-202 INTERACTIVE 7-451
HAG-BEG 10-510 INTERVALS 3-177
HAGEDO 3-203 INVK 3-191
HAGEDORN 10-509 INVKH 3-191
HBOT 3-87 IOGR 3-167
HCPVTS 6-376 IONEX 9-483
HEADER 6-397, 10-554 IPLABEL 3-207
HEATTR 10-548 IPRES 3-178, 4-292, 10-537, 10-541
HISTSYS 5-342 IPRTSS 6-396
HITLIST 4-298 IPUMP 4-285
HTC 10-504, 10-508 IPVT 10-503, 10-526
HTCPIPE 10-548 IPVTOC 10-530
HTCTUB 10-548 IPVTTB 10-530
HTOP 3-87 IPVTW 10-516, 10-526
HTOT 3-87 IPVTWC 10-530
HTOUTPUT 10-560
R5000.0.1 KI-651
IPVTWT 10-530
IQEWS 3-167 K
IQGAS 3-167
IQI 3-173 K 3-86, 3-202
IQLIQ 3-167, 4-292 KAC 8-458
IQO 3-167, 4-292 KAC2 8-458
IRDIST 4-274 KEYCMP 3-110, 3-118, 3-196, 4-256, 4-259, 4-
IRGAS 4-277 262
IRPCTA 4-273 KG 14-633
IRSRCW 4-271 KH 3-86, 3-202
ISAT 3-88 KHWI 3-90
ISATF 3-96 KMAX 8-458
ISATI 3-88 KMAX2 8-458
ISATIF 3-96 KVALUE 14-633
ISO 14-633 KVALUES 3-105, 3-107
ITARG 4-237 KW 14-633
ITEMP 3-178, 10-537
ITER 6-381, 7-442, 7-443, 13-622
ITERL 6-381
ITHP 3-173 L
ITNGLG 4-303
ITNGRE 3-127 L 3-85, 3-97, 4-226, 4-230, 10-541
ITNLIM 7-431 LAST 2-75
ITNMPL 13-621 LCDOFF 6-378
ITNSTP 3-125 LCDON 6-377
ITNSTQ 3-126 LDEST 3-101, 3-105, 3-107
ITNTHP 3-160 LE 8-464
ITNWIMULT 3-220 LEN 3-202
ITOP 3-207 LENGTH 3-90, 3-177, 10-498, 10-500, 10-504,
ITUBE 3-166 10-508
IW 3-80, 3-85, 3-97 LFRAC 3-101, 3-105, 3-107
IWCUT 3-167, 4-292 LFTGAS 4-226, 5-339
IWGR 3-167 LFTWLS 4-291
IWIM 3-88 LGR 3-131
IWIMF 3-96 LGRMAX 3-177, 3-193
LIFT 5-337
LIFTEFF 4-298
LIFTONLY 5-352
J LIFTREQ 5-352
LIMIT 3-131, 3-132
JCOR 7-444 LINK 10-516, 10-526, 10-530, 10-531
JCPR 7-444, 13-623 LIQPROD 4-307
JGAUS 7-445 LIQUID 3-115, 3-135, 3-185, 3-207, 4-233, 4-
JLU1 7-443 235, 5-364, 10-514
JLUN 7-443 LIST 1-49
JOPT1 7-445 LKCPLD 2-73
JOPTN 7-444 LOCK 10-566
JW 3-80, 3-86, 3-97 LPGFED 4-266
LPGOUT 4-267
LPGPLANT 4-262
LPROD 4-309
LSCALE 4-238
KI-652 R5000.0.1
MITAG 3-188
M MNFLCF 11-599
MNPFCF 11-599
MAP 2-69, 2-70 MOBAVB 3-163
MAPOUT 6-370, 9-488 MOBAVG 3-163
MAPWT 6-392 MOBILITY 3-142, 3-143
MAPX 6-391 MODEL 10-513
MAPXT 6-391 MODLAND 8-462
MAPY 6-391 MOLES 3-116, 3-207
MAPYT 6-391 MONTH 12-610, 12-615
MAPZ 6-391 MONTHS 4-229, 4-317, 5-341
MAPZT 6-391 MULT 4-225, 4-309, 8-468
MAX 7-436 MULTFL 8-472
MAXCYC 12-610 MULTIR 8-472
MAXFLI 10-548 MULTRT 3-115
MAXGLR 4-311 MUSTFLOW 5-352, 5-360, 5-361
MAXGOR 4-311, 4-320 MUSTLIFT 5-352
MAXNIT 10-548 MWL 3-105, 3-107
MAXOGR 4-311 MXDTCF 7-440
MAXONLY 7-428, 13-620 MXDTFC 7-440
MAXOVR 7-434 MXLSPN 10-565
MAXPRD 10-513
MAXQG 4-311
MAXQGI 4-311
MAXQLIQ 4-311 N
MAXQO 4-311
MAXQW 4-311 N 3-80
MAXQWI 4-311 NAMAX 2-58
MAXRER 11-596 NAME 3-80, 10-504, 10-508, 10-513, 10-520
MAXRNE 11-596 NAMES 14-633
MAXSCALE 4-298 NAREAX 2-58
MAXSSI 10-548 NBATMX 2-58
MAXVEL 10-568, 10-570 NBEPS 13-623
MAXWCUT 4-311, 4-320 NBHIMX 2-58
MAXWGR 4-311 NBHIQ 2-59
MAXWOR 4-311 NBHIV 2-59
MBAWG 3-162 NBHPMX 2-59
MEQ/ML 9-484 NBHPQ 2-59
MGOR 5-336, 6-384 NBHPV 2-59
MI 3-118 NCOL 1-50
MIMKP 4-249 NCPDIM 9-477
MINGOR 4-320 NCPLMX 2-59
MINQG 4-311, 4-320 NCPMAX 9-477
MINQGI 4-311 NCYCLES 10-567
MINQLIQ 4-311 NCYCMX 2-59
MINQO 4-311, 4-320 NCYCTM 2-59
MINQW 4-311, 4-320 NESMAX 9-477
MINQWI 4-311 NETPAR 10-548
MINRER 11-601 NEW 4-305, 4-310, 5-336
MINWCUT 4-320 NEWBHPTAB 3-171
MIPLANT 4-259 NEWSEP 3-112
NEWWEL 11-583, 11-584
R5000.0.1 KI-653
NEXTONLY 5-347 NPMPMX 2-60

NFSMAX 2-59 NPMPV 2-60
NGCMAX 2-59 NPRFMS 2-60
NGLFED 4-264 NPRFMX 2-60
NGLOUT 4-265 NPRFSOL 2-60
NGLPLANT 4-256 NPRFTOT 2-60
NGLRMX 2-59 NPRIMX 2-60
NGLRQ 2-59 NPROMX 2-60
NGLRV 2-59 NPRSYS 2-60
NHARM 13-623 NPRTM 14-632
NIADD 2-59 NPTNMX 2-60
NIRMX 2-60 NPWMAL 2-60
NIT 7-443, 13-622 NPWMPA 2-60
NITG 13-622, 13-624 NPWMPM 2-61
NKEY 3-110, 4-256, 4-259, 4-262 NPWMPS 2-61
NN 10-504, 10-508, 10-513, 10-520, 10-568 NRCMUN 2-61
NO 4-310, 10-523, 10-567, 10-568, 12-610 NRIGMX 2-61
NOCASCADE 13-628 NRIGTOT 2-61
NOCONVERT 8-463, 8-465, 8-466, 8-469, 9- NSLUG 9-477
491, 13-629 NSTGMX 2-61
NOCPRS 11-583, 11-584 NTHGMX 2-61
NOCUTS 7-433 NTHPGQ 2-61
NODCON 10-526 NTHPGV 2-61
NODE 6-398, 10-526, 10-554, 10-556 NTOPTC 10-567
NODES 10-520, 10-535, 10-553, 10-560, 10- NTRCEM 14-632
568 NTRWLM 14-632
NODIST 4-269 NWIMV 2-61
NODSOURCE 10-535 NWMAX 2-61
NOFLOW 14-635 NWRKG1 2-61
NOFRICTION 3-100 NWRKG2 2-61
NOHYSW 3-83 NWSWT 10-567, 10-568
NOITER 7-442, 7-443, 13-622 NX 6-380, 8-463, 8-465, 8-466, 8-469, 9-491,
NOLFTGAS 4-227, 5-340 13-629
NOLIFTREQ 5-352 NXFCON 2-61
NOLIST 1-49 NXFWEL 2-62
NONE 4-250, 6-370, 7-428, 7-439, 13-620 NY 6-380, 8-463, 8-465, 8-466, 8-469, 9-491,
NONPWM 5-344 13-629
NOOUT 2-74 NYEARS 12-610
NOPINT 13-619 NZ 6-380, 8-463, 8-465, 8-466, 8-469, 9-491,
NOPRTI 9-478 13-629
NOPSAT 8-458
NOPTG 13-622, 13-624
NOPWDEP 3-83
NORESET 3-83, 3-152, 3-153, 3-154 O
NORIGS 4-306
NORMAL 10-546 O 3-115, 3-135, 3-207, 4-226, 4-230, 4-235, 4-
NORTH 7-443, 13-622 240, 5-339, 5-345, 5-353, 10-541, 14-
NOSHUTIN 3-192 633
NOSKIP 1-50 OBJCOEF 10-565
NOSLIP 3-203, 10-505, 10-509 OFF 2-72, 2-73, 3-100, 3-159, 3-162, 3-182, 3-
NOVDB 2-70 183, 3-186, 3-217, 3-218, 4-228, 4-238,
NOWELL 4-330 4-254, 4-277, 4-280, 4-283, 4-298, 4-
KI-654 R5000.0.1
306, 5-347, 5-361, 5-363, 5-365, 6-385, OUTY 6-391

6-387, 6-389, 6-390, 6-392, 6-395, 6- OUTYT 6-391
408, 6-410, 6-411, 7-432, 7-433, 7-446, OUTZ 6-391
7-447, 8-460, 8-462, 8-476, 10-524, 10- OUTZT 6-391
556, 10-567, 10-571, 14-637, 14-638, OVER 8-463, 8-465, 9-491, 13-629
14-639
OGR 3-167, 10-560
OGR(IQ) 10-543
OIL 4-233, 5-364, 8-475, 10-514, 10-535, 10- P
566, 11-603
OILMIN 3-193 P 3-164, 14-633
OILPROD 4-307 PAFACT 5-352, 5-353
OLDINJ 3-123 PASS 5-352, 5-353
OMEGAS 3-103 PATNCI 3-183
OMEGBS 3-103 PATNPP 3-185
ON 2-73, 3-100, 3-159, 3-162, 3-182, 3-186, 3- PATTERN 6-405
217, 3-218, 4-228, 4-238, 4-254, 4-277, PATTN 3-182
4-280, 4-298, 5-361, 5-363, 5-365, 6- PCCD 6-377
392, 6-395, 6-408, 6-410, 6-411, 7-433, PCDOFF 6-377
7-446, 7-447, 8-460, 8-462, 8-476, 10- PCDON 6-377
524, 10-556, 10-566, 10-570 PCTFQ 3-188
ONLY 4-240, 4-242 PCTMI 3-188
ONLYCHILDREN 6-380 PCTMN 3-188
ONTIME 3-144, 4-224 PDCORR 10-504, 10-508
OPEN 3-192, 4-300, 10-514 PERFPT 3-99
OPMIN 4-320 PERKINS 10-513
OPROD 4-309 PERM 9-478
OPRSYS 4-331 PFIRST 3-207
OPTMBL 2-63 PFMCRV 4-291, 4-298
OPTTAB 4-290 PGRAD 4-275
ORDER 6-411 PHASE 5-353
ORDEROFF 6-411 PHASID 8-475
ORIGIN 14-633 PI 3-153
ORKISZ 3-203 PIAGL 3-187
ORKISZEWSKI 10-509 PILABEL 3-207
OUTCNi 10-527, 10-531 PINJ 3-120, 3-207
OUTCNT 10-526, 10-530 PIPE 10-517, 10-526, 10-530, 10-531
OUTCON 10-526, 10-530 PIPES 10-504
OUTCTi 10-527, 10-532 PIVOL 3-187
OUTFIL 10-548 PJACO 2-63
OUTFILE 4-298 PLANT 4-244, 4-246, 4-254
OUTITR 10-548 PLNTRY 3-110, 4-256, 4-259, 4-262
OUTNDi 10-527, 10-532 PLOT 2-65, 2-70
OUTNOD 10-526, 10-530 PLOTLIST 6-410
OUTPAVG 6-405 PLOTPTN 6-395
OUTPUT 6-370, 9-488 PLUG 3-131, 3-132, 3-134
OUTRFT 6-396 PLUGPLUS 3-131, 3-132
OUTSEP 6-393 PLUS 2-70, 2-76, 3-137, 4-256, 4-259, 4-262
OUTWINDOW 6-379 PMAX 10-568, 10-569
OUTWT 6-392 PMAXI 10-520
OUTX 6-391 PMFACT 5-352, 5-353
OUTXT 6-391 PMIN 10-520
R5000.0.1 KI-655
PMPTAB 4-286 PTARGH 4-228

POLYF 9-480 PTGFRQ 4-229
POLYMER 9-478 PTHLD 8-473
POLYT 9-478 PTNGOR 3-187
POR 9-478 PTOI 3-207
POTENTIAL 4-305 PTOL 7-444
POWN 9-481 PVDEF 2-72
PP 3-190 PVT 7-439
PPM 9-484 PVTTABLE 3-101
PPOPT 10-524 PWDEP 3-90
PRADJFPERF 11-596 PWMCAT 5-360
PRDEBUG 11-596 PWMDBG 5-347
PRDMIN 4-240 PWMFILE 5-347
PREDICT 5-336 PWMFRQ 5-341
PRES 3-101, 10-541 PWMGC 5-337
PRESIN 10-504, 10-508, 10-548 PWMOBN 5-346
PRESSURE 3-142, 3-143, 3-178, 4-292, 10- PWMSTEP 5-352, 5-353
537, 10-560 PWMTLP 5-344
PRESUP 10-514 PWMTRG 5-363
PRFLIM 3-137 PWMWCN 5-364
PRFPER 11-596 PWMWPA 5-358
PRFRPT 6-376 PWMWPM 5-359
PRFSTAT 3-97
PRIIR 4-281
PRINT 6-381, 9-487, 9-488, 14-639
PRINTOUT 6-395 Q
PRIOP 4-280
PRMEXP 4-274 QEWS 3-167
PRMGOR 5-365 QG 10-520, 10-568
PRNDRP 11-595 QGAS 3-167, 10-560
PROD 3-115, 4-225, 4-251, 4-252 QGMIN 5-350, 10-520, 10-568, 10-569
PROFILE 12-610 QI 3-173, 10-541
PROJNM 4-280 QL 10-520
PROJWL 4-281 QLIFT 4-288, 10-541
PROPTN 4-270 QLIFTA 4-290
PRRTOL 10-548 QLIFTM 4-301
PRSDLT 5-363 QLIQ 3-167, 4-292, 10-560
PRSYS 5-343, 5-352, 5-353, 10-520 QMAKE 4-248, 4-249
PRTR 9-478 QMAX 3-130, 4-310
PRTSWT 10-570 QMAXGR 6-409
PRTUBSPN 11-596 QMAXI 3-207
PRWI 6-406 QMAXP 3-207
PRWLRP 11-595 QMAXWG 3-199
PRWSTA 6-406 QMIN 3-138
PS 10-548 QMULT 3-139
PSAT 8-458 QMX 3-161
PSEUPRES 10-545 QO 3-167, 4-292, 10-520, 10-560, 10-568
PSEUTAB 10-544 QOMIN 5-349, 10-520, 10-568, 10-569
PSEUWS 10-546 QOMINL 5-361, 5-362
PSEUXY 10-545 QPMP 4-286
PSLUG 9-486 QPOOL 4-248
PTARG 4-226, 5-338, 10-520 QRATE 4-243, 4-244, 4-264, 4-265, 4-266, 4-
KI-656 R5000.0.1
267 RGCAVO 11-583, 11-584

QSALES 4-246 RGCAVR 11-583, 11-584
QSTMX 3-148 RGCAVW 11-583, 11-584
QUAL 3-120, 3-207 RIGS 4-310
QUEUE 4-312 RINJOP 4-269
QV 9-483 RK 9-478
QW 10-520 RKHKV 3-90
RKMULT 9-488
RNP 11-595
ROM 3-216
R ROUGH 3-90, 3-202
ROUGHNESS 10-504, 10-508
RADB 3-89 RRES 4-283
RADBP 9-487 RSTD 4-283
RADW 3-90 RTHP 11-595
RADWP 9-487 RTOL 7-443, 13-623
RATE 3-142, 3-143, 3-171, 4-309 RTOLG 13-623, 13-624
RCCD 6-377 RTRTOL 10-548
RCDOFF 6-377 RUN 2-57
RCDON 6-377 RUNID 6-397
RCMPOR 3-195
RCMPPERF 3-192
RCMPUNT 3-86, 3-192
RCMRPT 6-377 S
RDFAC 12-610
RECFAC 4-253 SCALE 4-231, 5-352, 5-353
REDIST 4-269 SEGREG 2-73
REGBLK 6-381 SEP 6-382
REGBOG 6-382 SEPARATOR 3-101, 3-105, 3-107
REGCMP 6-383 SEPS 6-382
REGION 2-65, 2-66, 6-398 SET 10-501, 10-502
REGIONS 6-381 SGL 3-88
REGOG 6-381 SGLF 3-96
REGSEP 6-394 SGMN 3-88
REINJ 10-520 SGMNF 3-96
RELERR 11-595 SGMX 3-88
RELRES 7-437 SGMXF 3-96
RELTOL 7-436 SGRO 3-88
REMOVE 5-352, 5-353, 10-520 SGROF 3-96
REPLACE 4-304, 4-316 SHCGAS 10-548
RES 3-116, 3-117, 3-196, 3-207, 8-457 SHCOIL 10-548
RESETCUM 3-221 SHCWAT 10-548
RESTART 2-74 SHEAR 9-481
RESTOT 3-219 SHFTOG 6-375
RESWAT 3-219 SHFTW 6-375
RFLOW 3-154 SHUT 3-193, 5-353
RFRPRS 4-275 SHUTIN 3-131, 3-132, 3-134, 3-192, 3-196
RFT 6-383 SHUTPF 11-583, 11-584
RFTFILE 6-384 SIM 6-384
RG 3-190 SIMPL 10-567
RGCAVG 11-583, 11-584 SKIN 3-89, 3-202
RGCAVL 11-583, 11-584 SKIP 1-50
R5000.0.1 KI-657
SLABELS 3-207
SLEEP 7-451 T
SLIMIT 3-134
SLVCUT 7-446 TAB 6-397, 10-554
SOR 3-134, 3-137 TABGLE 4-290
SORMAX 3-194 TABLE 3-194, 10-546
SOUCOM 10-536 TABSCL 4-291
SPFCT 10-526, 10-530 TABWC 4-291
SPFCTi 10-527, 10-532 TAKE 12-610
SPNPTU 10-539 TARGET 10-513
SPNPVT 10-538 TARGETS 4-305
SPNPVW 10-537 TBADJ 11-584
SPREADSHEET 10-560 TBHP 11-603
SPRLIST 6-411, 10-556 TCBHP 11-595
SS 8-458 TCUT 7-432
SSLOPE 9-480 TEMP 3-101, 3-178, 10-498, 10-499, 10-503,
SSSID 6-397 10-520, 10-537
SSSUM 6-384, 6-397, 10-554 TEMPDW 10-504, 10-508, 10-513
SSSUMR 6-384 TEMPPR 10-504, 10-508
STAGE 3-101, 3-105, 3-107 TEMPUP 10-504, 10-508, 10-513
START 2-76 TERC 11-603
STAT 3-89, 3-97 TEST 3-142
STATUS 3-192, 10-513 TESTGL 4-297
STBCHK 2-63 TFORM 6-406
STD 3-116, 3-117, 3-190, 3-196, 3-207, 4-268, TFPERF 11-598
4-269, 6-405 THICKNESS 10-504, 10-508
STEPNO 2-74 THP 3-112, 3-158, 3-167, 3-173, 4-286, 5-338
STMMAX 3-194 THP(IQ) 10-542
STOP 2-77, 5-346, 5-353 THPGTB 3-178
STORAGE 2-58 TIME 1-47, 2-74, 2-76, 4-300, 5-347, 6-384, 6-
SUB 8-468 387, 6-389, 6-390, 14-637, 14-638, 14-
SUBTRACT 4-304, 4-316 639
SUM 7-436 TIMEIN 10-548
SUNITS 9-484 TIMEST 10-548
SURF 8-457 TINJ 3-119, 3-207
SURFACE 2-65 TINJWAG 3-201
SURFTEMP 3-177 TITLE1 2-75
SVLGAS 10-549 TITLE2 2-75
SVLOIL 10-549 TITLE3 2-75
SVLWAT 10-549 TMGRPR 10-504, 10-508
SWING 12-610 TNET 10-548
SWL 3-87 TNEXT 4-300, 5-347, 6-385, 6-387, 6-389, 6-
SWLF 3-95 390, 14-637, 14-638, 14-639
SWMN 3-87 TO 3-128
SWMNF 3-95 TOLCMC 10-548
SWMX 3-87 TOLCP 10-548
SWMXF 3-96 TOLD 7-435
SWRO 3-87 TOLEX 7-445, 13-624
SWROF 3-95 TOLMN 7-445, 13-623
SYSSEP 5-365 TOLMX 7-445, 13-623
SYSTB 5-341 TOLR 7-436
SYSTEM 5-337
KI-658 R5000.0.1
TOLRKV 10-548
TOLRPC 10-548 U
TOLRSP 10-548
TOLRTC 10-548 UNIFORM 4-268, 4-270
TOLSCN 7-437 UNIT 3-86, 3-97
TOLST 7-445, 13-624
TOLWCN 7-438
TOTAL 3-122, 3-124, 3-125, 5-339, 5-345, 5-
353, 11-584 V
TOTGAS 4-298
TPRND 11-603 V98 7-433
TRACER 14-633, 14-639 VALSET 10-514
TRACIN 14-636 VALVE 10-517, 10-526, 10-530, 10-531
TRACK 4-330, 6-384 VALVEC 10-513
TRACKW 6-384 VALVES 10-513
TRAP 3-216 VC 10-501
TRCKOF 4-330 VCPR 10-513
TRCOFF 14-633 VDB 2-70
TRGOPT 4-230 VDEST 3-101, 3-105, 3-107
TRGORD 4-233 VDGFCT 4-274
TRGPRS 4-275 VEL 5-339
TRGPWM 5-344 VELRST 10-568
TRGQMN 4-235 VELWCU 10-568
TRGTOL 4-236 VELWCUT 10-570
TRKTOL 4-330 VENT 4-255
TS 10-548 VFRAC 3-101, 3-105, 3-107
TSFM 3-114 VIS 10-537
TSPN 11-599 VISC 3-178
TSSDAT 6-376 VISCOSITY 3-181
TSSMFG 6-376 VOID 4-284
TSSUM 6-375, 6-384 VOIN 4-284
TSSUMG 6-375 VOLBAL 2-64, 3-163
TSTEPS 4-229, 4-317, 5-341 VOVER 8-466, 8-469, 9-491, 13-629
TSTPRF 3-136 VP0 9-478
TTHP 11-603 VSHFTS 3-103
TTUBING 11-598
TUBCNT 10-530
TUBCON 10-530
TUBE 3-180
W
TUBID 10-513 W 3-115, 3-117, 3-135, 3-173, 3-207, 4-226, 4-
TUBING 10-508, 10-517, 10-526, 10-530, 10- 230, 4-235, 4-237, 4-240, 4-242, 4-283,
531, 10-557 4-284, 5-339, 5-345, 5-352, 5-353, 10-
TUNING 11-594 541, 14-633
TWELL 11-598 WAG 3-183, 3-196
TWLFL 11-598 WAGPERF 3-186
TYPE 10-513 WARN 5-346, 5-353
TYPPRS 4-274 WARNING 4-298
TYPVDG 4-274 WATER 4-233, 5-364, 10-535, 10-566, 11-603
WATINJ 4-307
WATPROD 4-307
WBGRAD 3-163
R5000.0.1 KI-659
WCPLOT 6-387 WMAN 5-346

WCTMAX 3-193 WMAP 6-387
WCUT 3-137, 3-167, 3-219, 4-231, 4-292, 5- WMAPOLD 6-387
352, 5-366, 10-560, 11-595 WMGL 5-352, 5-353
WCUT(IQ) 10-543 WMITN 5-336, 10-572
WCUTLM 5-365 WML 10-520
WDAT 10-530 WMN 10-520
WDL 3-89 WNDGDV 3-190
WDLF 3-97 WPLOT 6-387
WDNDG 3-191 WPMIN 4-320
WDZ 10-530 WPROD 4-309
WELCMP 6-383 WPWMDB 5-367
WELCON 10-530, 10-569, 11-599, 11-605 WRATE 4-231, 11-595
WELHEAD 10-530 WRATIO 3-171
WELL 2-65, 2-66, 3-80, 3-83, 3-97, 3-144, 3- WREST 6-387
192, 3-214, 3-215, 3-217, 4-284, 4-294, WRKCF1 4-325
4-295, 4-310, 4-313, 4-318, 4-320, 4- WRKCF2 4-326
323, 4-324, 4-325, 4-326, 4-327, 5-342, WRKCOEF 4-327
5-349, 5-350, 5-358, 5-359, 5-361, 6- WRKDBG 4-329
398, 6-410, 6-411, 10-530, 10-539, 10- WRKDLT 4-318
569, 11-596, 11-598, 11-605, 13-626 WRKFAIL 4-319
WELLS 6-381, 10-560 WRKFRQ 4-317
WELRPT 6-376 WRKGP1 4-323
WFILE 6-387 WRKGP2 4-324
WFLUX 6-387 WRKLIM 4-320
WGLRMIN 4-298 WRKRIG 4-315
WGPCMP 6-383 WRKRPT 6-377
WGR 3-167, 10-560, 11-595 WRKRTO 4-316
WGR(IQ) 10-543 WRKWLM 4-319
WI 3-152 WSAL 3-141
WIADJ 11-583 WSMIN 4-320
WIL 3-89 WSTR 6-381
WIMULT 3-219 WTC 4-330
WIMULTAB 3-219 WTEST 3-143
WIMUWL 3-219 WTRACE 14-637
WINJ 4-309 WTRACK 6-389
WINJMOB 3-122, 3-125 WTRDBG 14-638
WINJT 4-333 WTRMAX 3-193
WKHMULT 3-145 WTRPLOT 14-637
WLASTR 6-389 WTRPMP 4-287
WLDRTIME 4-313 WTRTHP 3-181
WLGRP 6-382, 6-408, 10-553, 10-557 WTV 4-330
WLHIS 6-382 WWDSP 14-632
WLIMIT 3-131
WLLCMP 6-383
WLLYR 2-65, 2-66, 6-382, 6-410
WLLYRS 6-382 X
WLPOT 6-383
WLSUM 6-384 X 8-472
WLTYCH 3-128 XFOFF 3-161
WLVEL 10-570 XFON 3-161
WLWDAT 3-157 XKC 9-483
KI-660 R5000.0.1
Y
Y 8-472
YEAR 12-610
YES 4-310, 10-523, 10-567, 10-568, 12-610
YINJ 3-140
YINJA 3-141, 10-529
YINJMK 4-251
YINJT 4-331
YOUNG 10-504, 10-508, 10-548
YREINJ 4-252
Z
Z 3-178, 8-472
R5000.0.1 KI-661
KI-662 R5000.0.1
Subject
Index
000000Subject Index B
Beggs and Brill correlation 3-203
bibliography A-645
BLITZ solver 7-441
A bottomhole injection pressure 3-173
bottomhole pressure
accelerated successive substitution 8-457 additive correction 3-175
activate/deactivate grids alternate 3-171
in LGR 13-619 damping factor 7-439
anion concentration 9-485, 9-487 in hydraulics table 3-167
arbitrary gridblock connections limiting 3-157
in LGR 13-628 bottomhole pressure constraints 3-148
area bottomhole pressure table
how defined 4-224 in predictive well management 5-341
injection target 4-237 boundary flux data
production and injection summaries 6-383 file format for 6-407
production target 4-226 write control 6-388
arithmetic operation boundary flux summary 6-384
applying to grid 8-463 buildup pressure
array data output control 6-386
additional for VIP-DUAL 8-465
cross-sections 6-408
from VIP-CORE, modifying 8-463
modifying for polymer 9-491 C
modifying individual values 8-466
calcium concentration 9-486
modifying values (VIP-DUAL) 8-468
cation exchange 9-483
printing 9-488
CBLITZ iterative matrix solver 13-622
printing of 6-370
CBLITZ solver 7-441
array reports 6-382
chloride concentration 9-485, 9-487
artificial lift
comments
at gathering centers 5-337
inserting lines of comments 1-48
defining methods for 5-344
artificial lift quantity 3-175 compaction regions 8-472
compositional model
automatic recompletion units 3-192
definition of 1-27
average pressure
content/frequency of output 6-381
calculation of 6-405
convergence
Aziz, Govier, Fogarasi correlation 3-203
R5000.0.1 SI-663
tolerances for 7-435

convergence failures E
how controlled 7-432
cross-sections elevation profile
printing of 6-408 in pipes 10-500
end-of- file marker 2-77
endpoint method 3-122
enthalpy
D of injected steam/water 3-121
EXCEL solver 7-441, 7-442
damping factor
external files
for bottomhole pressure 7-439
how to include 1-49
Darcy radial flow equations 3-202
extrapolation of table data 7-439
data
beginning of 2-75
columns to be read 1-50
deck layout 1-31 F
injection pressure 3-120
injection temperature 3-119 facility utilization summary 6-384
line continuation 1-50 faults
skip cards 1-50 conductive
time-dependent 2-57 solution options 2-73
dead oil model transmissibility at connections 8-470
definition of 1-27 transmissibility at connections (VIP-DU-
debug AL) 8-471
predictive well management 5-347 field
wells to be included 5-367 injection target 4-237
debug output production and injection summaries 6-383
workover calculations 4-329 production target 4-226
default dimensions 2-58 field production and injection reports 6-382
changes for POLYMER option 9-477 files
defaults controlling writing of 6-387
changes in 14-632 finite difference formulation
density in LGR 13-617
for water injectors 3-181 flash calculation 8-457
of gas, pressure-dependent 3-190 control of 8-458
deviated wells 3-80 flow modeling
dimensions hydraulic tables 10-497
changes to 14-632 in well tubing strings 10-496
default 2-58 flow station
divalent cation concentration 9-486 how defined 4-223
divalent salinity 9-484 injection target 4-237
drainage radius 3-122 production and injection summaries 6-383
drawdown production target 4-226
maximum constraint 3-160 flow vector arrays 2-71
Dunns and Ross correlation 3-203 fluid tracking 4-330
dynamic vertical flow 3-205, 3-217 output 4-331
SI-664 R5000.0.1
results file format 6-406 gradients

tracked fluid 4-331 wellbore 3-162
write control 6-389 gridded wellbore 3-202, 3-216
flux file grids
format of 6-407 activate/deactivate 13-619
formulation arbitrary gridblock connections 13-628
in LGR 13-617 arithmetic operations on 8-463
formulation options 2-64 compaction regions 8-472
FORTRAN units 1-52 injection regions 13-628
free field format see also LGR
defined 1-47 well locations in 13-626
friction loss Griffith, Lau, Hon, Pearson correlation 3-203
in wellbore 3-100
front tracking 14-632
fuel gas rate 4-244 H
fully coupled calculation 2-73
Hagedorn and Brown correlation 3-203
Hong’s approximation 9-481
G horizontal wells 3-100
hydrocarbon track file 6-424
gas conditioning 4-255 hydrocarbon volumes
gas lift assignment 3-187
how defined 4-288 hysteresis
gas percolation 8-460 Land’s constant 8-462
gas phase hysteresis 8-462
gas plant
liquid recovery factor 4-253 I
gas plant data 3-110
gas producers IMPES formulation 2-65
algorithm for 3-176 in LGR 13-617
gas rate IMPLICIT formulation 2-64
minimum for pressure systems 5-350 in LGR 13-617
gas reinjection 4-268 implicit well options 7-447
gas remobilization 8-460 inclined wells 3-100
gas sales option 4-254 include files
gas-oil ratio report 6-384 how to specify 1-49
gathering center injection rate
how to define 4-223 minimum 4-241
injection target 4-237 injection regions 4-237, 4-269
pressure systems/artificial lift 5-337 assigning gridblocks to 13-628
production and injection summaries 6-383 injection summary 6-381
production target 4-226 injection target 3-188, 4-237
Gaussian elimination 7-441, 7-442 injection wells
gel additional injection rate 3-124
instantaneous 9-487 anions/chlorides 9-485, 9-487
Gibbs energy minimization algorithm 8-455 assigning to a pattern 3-183
R5000.0.1 SI-665
cations/calcium 9-486 makeup gas rate 4-247

effective gas target 4-250 makeup MI rate 4-249
how defined 3-117 map file
how to specify pressure 3-120 array data 9-488
how to specify quality 3-120 format of 2-69
how to specify temperature 3-119 inclusion of mole fractions 6-391
mobility 3-124 organization of 6-421
polymer concentration in 9-485 specifying arrays to write 6-370
inner iterations water type tracking 6-392
definition of 7-427 marginal gas-oil ratio
input-output in predictive well management 5-365
diagram of 1-54 material balance 2-63
instantaneous gel 9-487 material balance error
interactive suspend option 7-450 maximum allowed 7-438
iteration control matrix solvers
for IMPLICIT grids 13-621 types defined 7-441
in LGR 13-620 memory requirements
iteration summary 6-381 how calculated 2-58
iterations miscible injectant plant 4-259
for predictive well management 5-336, 10- mobility 3-121
572 for injection wells 3-124
inner 7-427 mole fractions
outer 7-427 printing/mapping 6-391
multiphase compositional flow 10-496
multi-phase flow
L link data 10-516
Land’s constant 8-462

lift efficiency N
vs. water cut 5-366
lift gas natural gas liquid (NGL) plant 4-256
composition of 10-529 maximum feed rate 4-264
link data maximum rate 4-265
for multi-phase flow 10-516 Newton-Raphson method 8-457
liquid recovery factor 4-253 node connections 10-526
liquified petroleum gas (LPG) plant 4-262 node data 10-520
maximum feed rate 4-266 node spreadsheet file (SSSUM) 10-554
maximum rate 4-267 non-Darcy gas flow
local grid refinement (LGR) near wells 3-190
overview 13-617 nonlinearity 3-122
non-Newtonian fluid viscosity 9-482
M
O
makeup gas
composition of 4-251 oil incremental benefit
SI-666 R5000.0.1
with gas lift 5-346 plot file

oil phase hysteresis 8-462 format/data selection 2-65
oil rate compositional 2-66
minimum for flow to pressure system 5-349 organization of 6-413, 6-417
minimum for pressure system 5-361 polymer concentration 9-478, 9-480
Orkiszewski correlation 3-203 for injectors 9-485
outer iterations polymer data 9-477
definition of 7-427 polymer inaccessible pore volume 9-483
how controlled 7-431 pore volume
output frequency polymer inaccessible 9-483
how controlled 2-76 predictive well management
output regions data for steps 2 and 3 5-352
assigning separator batteries 6-394 debug calculations 5-347
override modification how arrays defined 5-336
in LGR 13-629 marginal gas-oil ratio 5-365
overview 5-335
producing areas 5-358
P producing mechanism 5-359
well category 5-360
parallel computing 15-641 pressure
particle tracking 14-631 constraints on 3-148
pattern balancing 3-182 of injection wells 3-120
pattern element option 3-79 threshold for limiting grid block to grid
perforation relative permeability 3-83 block flow 8-473
perforations pressure gradient
grid location of 13-627 modeling in pipes 10-497
in wells 3-83 pressure history
in wells (VIP-DUAL) 3-95 data requirements 1-30
permeability reduction multiplier 9-488 pressure system
phase equilibrium calculations 8-455 defining for each well 5-342
phase stability test 8-455 minimum gas rate 5-350
pipeline network minimum oil rate 5-349, 5-361
connecting wells to 10-530 pressure systems
general parameters 10-548 at gathering centers 5-337
node connections 10-526 printing 6-381
node data 10-520 array data 6-370
options for simulation 10-493 arrays by cross-section 6-408
pipe data 10-504 echo print 1-49
plotting output 10-558 mole fractions 6-391
printing data 10-553 pipeline network data 10-553
plot tracer summary report 14-639
pipeline network data 10-558 water type tracking 6-392
production/injection compositional perfor- well and table data 6-395
mance 6-388 well index 6-406
production/injection performance 6-388 well properties 6-406
production/injection rate 6-395 producing area
R5000.0.1 SI-667
well location in 5-358 wells to include 6-396

production history run termination 2-77
data requirements 1-30 run title
production rate how to specify 2-75
minimum 4-240 Russell Goodrich method 3-191
tolerances for 5-344
production summary 6-381
production targets 4-226 S
frequency wells created 4-229
honoring 4-228 sales gas rate 4-246
in predictive well management 5-338 salinity
minimum rate 4-235 effective divalent 9-484
order for reducing phase rate 4-233 salinity table 9-478, 9-480
reducing the phase rate 4-230 scaleback
well rate max. tolerance 4-236 well rates 4-238
production wells secondar recovery projects
assign to multiple patterns 3-185 design/analysis of 14-631
how defined 3-115 segregated flow
production/injection compositional perfor- in conductive faults 2-73
mance separator batteries
plotting of 6-388 assigning to output regions 6-394
production/injection performance separator battery number
plotting of 6-388 for predictive well management 5-365
pumps separator battery report 6-382
water injectors 4-285 selecting batteries 6-393
shear rate
effect on viscosity 9-481
R shrinkage gas rate 4-243
shutoffs
radial flow 3-154 limit for automatic shutoff 4-319
recurrent data SIMOUT map files
interactive changes to 7-453 writing of 6-388
region report 6-381 simulation statistics 6-384
reinjected gas simulator control
composition of 4-252 overview 7-427
reports single phase injectors 3-180
see printing skin factor 3-190
restart well-rate dependent 3-191
how to perform 2-74 solvers
restart records CBLITZ 13-622
defined 1-52 types defined 7-441
save temporary restarts 6-389 spreadsheet summary
write control 6-388 options and variables 6-397
results file spreadsheet summary report 6-384
control of 2-65 steam rate
RFT report 6-383 for production wells 3-148
SI-668 R5000.0.1
summary records tolerance

how written 1-52 for convergence 7-435
surface facility modeling 3-113 for production rates 5-344
surface facility report 6-381 tracer injections 14-635
surface pipeline network option 10-493 tracer output file 14-637, 14-638
surface separators tracer summary report 14-639
black-oil modeling (VIP-ENCORE) 3-104 tracer tests
compositional modeling (VIP-COMP) 3- calculation parameters 14-633
101 options for 14-631
general data for 3-101 tracking
k-values 3-107 injected water front 14-632
switching 3-112 of hydrocarbons 6-424
tracking output 6-384
transmissibility
T at fault connections 8-470
at fault connections (VIP-DUAL) 8-471
table extrapolation 7-439 trapped gas
temperature remobilization of 8-460
for injection wells 3-119 tubing diameter 3-181
temperature gradient profile tubing length 3-180
in pipes and well tubing 10-499 tubinghead discharge pressure 3-173
temperature profile tubinghead pressure
in pipes and well tubing 10-498, 10-503 calculation for gas wells 3-177
termination of run 2-77 constraints for single phase injectors 3-180
time-dependent data 2-57 defining for well list 5-338
timestep equations, set up 3-159
automatic selection of 7-427 in hydraulics table 3-167
controlling size of 2-76 iteration control 3-159
how controlled 7-427 limiting 3-158
maximum variable changes 7-434 table assignment for gas producers 3-177
timestep control tubinghead pressure constraints 3-148
for IMPLICIT grids 13-620
for polymer option 9-490
in LGR 13-620 U
timestep cuts
how controlled 7-432 units
maximum variable changes 7-434 table of 1-55
timestep size utility data 2-57
following well rate changes 7-430
how defined 7-428
maximum for IMPES 7-433 V
timestep summary
logical unit for output 6-396 value override
timestep summary report 6-384 in LGR 13-629
title valve coefficient profile 10-501, 10-502
of run 2-75 vertical wells
R5000.0.1 SI-669
name location 3-80 water-oil hysteresis 3-83

VIP-COMP well groups
overview 1-25 for reporting 6-408
surface separator modeling 3-101 well index
VIP-CORE printing of 6-406
array data, modifying 8-463 well properties
VIP-DUAL printing of 6-406
fault connection transmissibility 8-471 well tubing data 10-508
override array values 8-468 wellbore crossflow 3-161
override modification 8-465 wellbore flash control 3-164
overview 1-26 wellbore gradients 3-162
well perforations 3-95 wellbore hydraulics table
VIP-ENCORE assignment of 3-166
default separator 3-104 for injectors 3-173
overview 1-26 specification of 3-167
VIP-EXEC wells
files used 1-52 angles 3-187
overview 1-25 artificial lift quantity 3-175
sample input data 1-42 average pressure calculation 6-405
VIP-POLYMER changing well type class 3-128
default dimension changes 9-477 connections between 10-530
overview 1-27 constraints on 3-130
polymer concentration 9-478 conventional locations 3-79
salinity table 9-478 crossflow in 3-161
VIP-THERM data for 3-79
overview 1-27 data requirements 1-30
viscosity drawdown 3-160
for water injectors 3-181 dynamic vertical flow 3-205, 3-217
viscosity table economic limit 3-135
for gas wells 3-178 flash control 3-164
voidage injection flow rates
how defined 4-282 outer iteration number 3-125
volume balance 2-64 fraction of time on 3-144
gas rate 3-132
gas-oil ratio 3-132
W gas-oil ratio limits 3-137
gradients 3-162
water injector pumps 4-285 grid location of 13-626
water tracking gridded wellbore 3-202, 3-216
mixing parameter 4-333 hydrocarbon volumes 3-187
tracked water type 4-333 inclined and horizontal 3-100
water tracking report 6-384 individual performance 6-388
water type injected gas composition 3-140
tracking of 6-392 interval between tests 3-142
water-cut lift gas composition 10-529
vs. lift efficiency 5-366 limiting bottomhole pressure 3-157
SI-670 R5000.0.1
limiting tubinghead pressure 3-158

liquid-gas ratio 3-131 Z
maximum rate 3-130
maximum rate each phase 3-139 z-factor
maximum steam rate 3-148 for gas wells 3-178
maximum water cut 3-131, 3-134
MI injection target 3-188
minimum rate 3-138
mobility computation 3-124
name/location 3-79
pattern balancing 3-182
perforation tests 3-136
perforations 3-83, 3-202
perforations (in VIP-DUAL) 3-95
predictive management 5-335
pressure constraint 3-148
production and injection summaries 6-382
productivity/injectivity index 3-153
radial flow equation data 3-154
rate scaleback options 4-238
recompletion units 3-192
order for opening 3-195
see also injection/production wells
tubing diameter 3-181
tubing length 3-180
tubinghead pressure 5-338
type (production/injection) 3-114
water cut limits 3-137
water-alternating-gas injection 3-196
bottomhole pressure 3-200
maximum rates 3-199
timestep control 3-201
well index 3-152
well lists 1-51
well management 4-223
wellbore friction loss 3-100
workover rigs 4-315
workovers
automatic 4-315
benefit function limits 4-320
debug output from calculations 4-329
elapsed time between 4-318
failure rate 4-319
frequency of calculations 4-317
relative number 4-316
write files 6-387
R5000.0.1 SI-671

VIP-EXECUTIVE Reference Manual

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

VIP-EXECUTIVE Reference Manual

Uploaded by

Copyright:

Available Formats

VIP-EXECUTIVE®

Landmark Graphics Corporation

R5000.0.1 Table of Contents v

1.7 Units Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-55

vi Table of Contents R5000.0.1

3.2.2 Describe Well Perforations (FPERF) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-83

R5000.0.1 Table of Contents vii

3.5.13.2 Specification by Well (WTEST) . . . . . . . . . . . . . . . . . . . . . 3-143

viii Table of Contents R5000.0.1

Turn Off Pattern Balancing (PATNCI ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-183

R5000.0.1 Table of Contents ix

x Table of Contents R5000.0.1

4.7.4 Assign Injection Wells to Injection Regions (INJRGR) . . . . . . . . . . . . 4-272

R5000.0.1 Table of Contents xi

4.13.3 Workover Calculation Frequency (WRKFRQ) . . . . . . . . . . . . . . . . . 4-317

xii Table of Contents R5000.0.1

5.3.5 Producing Mechanism (PWMWPM) . . . . . . . . . . . . . . . . . . . . . . . . . . 5-359

R5000.0.1 Table of Contents xiii

6.21 Print Well Properties Summary (PRWSTA) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-406

xiv Table of Contents R5000.0.1

7.5 Interactive Suspend Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-450

R5000.0.1 Table of Contents xv

9.1.8 Effective Divalent Salinity Cards (CSEP) . . . . . . . . . . . . . . . . . . . . . . 9-484

Surface Pipeline Network Option

xvi Table of Contents R5000.0.1

10.11 Node Connection Data (NODCON) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-526

R5000.0.1 Table of Contents xvii

xviii Table of Contents R5000.0.1

13.6.2 Describe Well Perforations (FPERF) . . . . . . . . . . . . . . . . . . . . . . . . 13-626

R5000.0.1 Table of Contents xix

xx Table of Contents R5000.0.1

000000 About This Manual

The VIP-EXECUTIVE reservoir simulator contains the following program

VIP-ENCORE Multi-Component Black-Oil Model

VIP-COMP Equation-of-State Compositional Model

VIP-DUAL Dual-Porosity Model

VIP-POLYMER Polymer Flooding Model

VIP-THERM Thermal Model

These program modules work together to provide total flexibility in reservoir

R5000.0.1 About This Manual xxi

provide simulation capability for a dual-porosity, black-oil reservoir. If VIP-

xxii About This Manual R5000.0.1

■ VIP-EXECUTIVE Technical Reference. A detailed discussion of the

■ VIP-CORE Reference Manual. A complete summary of all keywords and

R5000.0.1 About This Manual xxiii

xxiv About This Manual R5000.0.1

The documentation for VIP-COMP, VIP-ENCORE, VIP-DUAL, VIP-

1.1.1 VIP-COMP Overview

R5000.0.1 Data Overview 1-25

1.1.2 VIP-ENCORE Overview

1.1.3 VIP-DUAL Overview

NOTE: VIP-DUAL is available as a separately licensed option.

The VIP-DUAL option simulates the performance of reservoirs which are

1-26 Data Overview R5000.0.1

1.1.4 VIP-POLYMER Overview

NOTE: VIP-POLYMER is available as a separately licensed option.

The VIP-POLYMER option simulates the performance of polymer flooded

1.1.5 VIP-THERM Option

The VIP-THERM compositional model is a fully implicit, n-component,

VIP-COMP or VIP-ENCORE initialization data may easily be converted to VIP-

1. Specify THERMAL card in VIP-CORE utility data (VIP-CORE Section

3. Replace Physical Property Constants table with VIP-THERM format (VIP-

R5000.0.1 Data Overview 1-27

5. Specify heat capacity arrays in VIP-CORE array data (VIP-CORE Sections