PIPESIM

Open Link
Schlumberger 2 Open Link

Copyright 2008 Schlumberger. All rights reserved.

No part of this manual may be reproduced, stored in a retrieval system, or translated in any form or by
any means, electronic or mechanical, including photocopying and recording, without the prior written
permission of Schlumberger Information Solutions, 5599 San Felipe, Suite 1700, Houston, TX 77056-
2722, USA.
Use of this product is governed by the License Agreement. Schlumberger makes no warranties, express,
implied, or statutory, with respect to the product described herein and disclaims without limitation any
warranties of merchantability or fitness for a particular purpose. Schlumberger reserves the right to revise
the information in this manual at any time without notice.

PIPESIM
Schlumberger 3 Open Link

Table of Contents
Open Link Reference Manual .............................................................................................................................. 5
Overview ................................................................................................................................................... 5
Modules and Interfaces ........................................................................................................................... 6
Quick Start Tutorial .............................................................................................................................................. 7
Loading and running an existing model ................................................................................................ 7
Getting results .......................................................................................................................................... 9
Changing BlackOil fluid parameters ...................................................................................................... 9
Changing a choke property ..................................................................................................................... 9
Saving the changes................................................................................................................................... 9
Case Study 1 Building a Well Model from Excel .......................................................................................... 11
Problem Outline ..................................................................................................................................... 11
Requirements.......................................................................................................................................... 11
Procedure................................................................................................................................................ 11
Step by step tutorial............................................................................................................................... 11
Case Study 2 - Nodal Analysis............................................................................................................................ 21
Problem Outline ..................................................................................................................................... 21
Requirements.......................................................................................................................................... 21
Procedure................................................................................................................................................ 21
Step by Step Tutorial ............................................................................................................................. 21
Modules and Interfaces ...................................................................................................................................... 27
ISingleBranchModel Interface.............................................................................................................. 27
IObjectProperties Interface .................................................................................................................. 31
ITubing Interface.................................................................................................................................... 32
IVertCompObj Interface ........................................................................................................................ 34
IFlowlineObj Interface .......................................................................................................................... 35
IHeatTransfer Interface ......................................................................................................................... 35
IFluid Interface....................................................................................................................................... 36
IProjectInfo Interface ............................................................................................................................ 37
IErosionCorrosion Interface................................................................................................................. 37
INetModel Interface............................................................................................................................... 38
ModelBuilder object .............................................................................................................................. 43
IBlackOil object...................................................................................................................................... 43
ISinglePointCalib object........................................................................................................................ 44
IMultiPointCalib object ......................................................................................................................... 45
IViscosityData object............................................................................................................................. 46
IThermal object ...................................................................................................................................... 47
ICompositional object ........................................................................................................................... 48
FlowCorrelations Interface................................................................................................................... 51
Single Branch Operations...................................................................................................................... 52
Systems Analysis .................................................................................................................................... 52
Pressure and Temperature Profiles ..................................................................................................... 54
Flow Correlation Matching ................................................................................................................... 55
Nodal Analysis ........................................................................................................................................ 56
Wax Deposition ...................................................................................................................................... 58
Single Branch Operations: Supporting Interfaces.............................................................................. 59
IBoundaryProps Interface..................................................................................................................... 59
IEngineOptions Interface ...................................................................................................................... 59
Gas Lift Diagnostics COM Object......................................................................................................... 59
GLWell Interface and Object................................................................................................................. 59
IGLDesign Object ................................................................................................................................... 66
IDesignParams Object ........................................................................................................................... 69
IDesignBias Object................................................................................................................................. 69
IGLValveSystem Object ......................................................................................................................... 70
Single Branch Output Reader COM ..................................................................................................... 71
PerformCurve Object............................................................................................................................. 75

PIPESIM
Schlumberger 4 Open Link

PNSReaderCOM ..................................................................................................................................... 77
Inflow Performance Calculator COM .................................................................................................. 83
Units Library ........................................................................................................................................... 85
Defined constants and strings ........................................................................................................................... 87
Object Type Identifiers .......................................................................................................................... 87
Object Properties ................................................................................................................................... 87
Tubing objects properties .................................................................................................................... 91
Artificial Lift............................................................................................................................................ 93
Completion Options............................................................................................................................... 93
IPR Types (Vertical)............................................................................................................................... 93
IPR Types (Horizontal).......................................................................................................................... 94
IPR Options (Horizontal) ...................................................................................................................... 94
Fluid Types ............................................................................................................................................. 94
Pipe Flow Types..................................................................................................................................... 94
Rate Types............................................................................................................................................... 94
Separator Types ..................................................................................................................................... 94
Single Branch Operations...................................................................................................................... 94
Unit System.......................................................................................................................................................... 96
Case Studies......................................................................................................................................................... 99
Detailed explanation of routine............................................................................................................ 99

PIPESIM
Schlumberger 5 Open Link

Open Link Reference Manual

Overview
This guide is designed to explain how to use Open Link to interface with PIPESIM from external
applications.
An overview of the functionality of Open Link is provided along with the necessary interface
functions and arguments. This allows you to load both network and single branch PIPESIM
models, query them (equipment configuration, gas lift injection, etc.), and perform simulations.
Basic Functions
The functions described in this document fall into the following categories;
Get functions - Get the results after a simulation or query an item for its current data value,
such as obtaining the choke bean size.
Set functions - Set a valve to be used in subsequent simulation, such as setting the reservoir
pressure.
Operation functions - Perform an operation on a model, such as running a simulation.
Potential Usage
The Open Link functionality could be used in the following cases:
Running PIPESIM in batch mode with a number of scenarios
Creating custom reports
Importing production data from a database and populating the models
Running PIPESIM in-conjunction with other Engineering applications. Hyprotech have already
used this functionality to link Hysys and PIPESIM.
Utilizing Open Link
The Open Link functions can be called from any of the following:
VBA macro. This could be written in Excel, Access, etc.
Visual Basic programs.
C++ programs
Supported Interfaces
INetModel: for network models and network operations
ISingleBranchModel: for single branch models and operations
Dependency MAP
Open Link can be used to access PIPESIM functionality from external programs. The programs
that can automate PIPESIM simulations are those that are defined as automation clients
according to Microsoft standards, and in the same way, Open Link is an automation server.
Typical examples of automation clients include VBA (Visual Basic for Applications) macros, which
can be written from programs such as Excel or Access, C++ and Visual Basic. Open Link provides
therefore an open architecture where you control and automate PIPESIM simulation models
through custom programs or macros without having to manually enter the data or view the results
using the graphical interface. It is assumed you are familiar with both PIPESIM and the chosen
program or programming language in which the automation code is to be written. Those new to
VBA are recommended to closely follow the Quick Start Tutorial and the Case Studies.
The Open Link functionality is distributed with the PIPESIM installation and is included in a
number of library files.
The main file is Net32COM.DLL, which normally resides in the programs directory and
provides the framework and main entry points into both networks and single branch
simulation models. Net32COM.DLL must be copied to the PIPESIM programs directory and
registered.
There are other files that support Net32COM, for instance FluidModelCOM.DLL and
FlowCorrelationCOM, which provide access to properties defined in the fluid models and flow
correlations respectively.
Each library file, in turn, defines at least one interface, which is a logical entry point into a
well-defined area of functionality. Each interface includes a number of public access functions
that set or get a specified property or just perform operations (that is run a simulation). As
an example the FluidModelCOM library defines two interfaces: IBlackOil, for black oil models
and ICompositional, to deal with compositional models. IBlackOil defines property functions

PIPESIM
Schlumberger 6 Open Link

such as API, Watercut or GasSG. These properties can be set (assigned) to a model prior to a
simulation run or they can be get (retrieved) and copied into an Excel cell.
The Modules and Interfaces section lists the modules and interfaces that are part of Open Link.
This document contains further details of the modules and interfaces, together with some code
samples. Highlighted items represent information that is new, previously unpublished or amended
from the previous PIPESIM release. The present reference guide applies to the release version
2008.
Modules and Interfaces
Module Name Interfaces Remarks
Net32COM.DLL INetModel Network models and operations
ISingleBranchModel Single branch models and operations
IObjectProperties Generic equipment properties
TubingObj Tubing specific properties and operations
InjectorObj Injector specific properties
VertCompObj Vertical completion specific properties
FlowlineObj Flowline specific properties and operations
ErosionCorrosion Erosion and corrosion settings
HeatTransfer Heat transfer properties
PSOpSystems.DLL IISystemsAnalysis Systems Analysis operation
IIPTProfile Pressure/Temp Profiles operation
IICorrMatching Flow Correlation Matching operation
NodalOp.DLL IINodalAnal Nodal Analysis Operation
FluidModelCOM.DLL IBlackOil Black Oil model properties
ICompositional Compositional model properties
SinglePointCalib BO single point calibration properties
MultiPointCalib BO multipoint calibration properties
ViscosityData BO viscosity properties
Thermal BO thermal properties
FlowCorrelationCOM.DLL CIFlowCorrelation Vertical and horizontal flow correlation
properties
UnitsCOM.DLL IUnitSystem General unit conversions
GLDiagn.DLL GLWell Gas lifted well model for diagnostics
WaxOp.DLL IWaxOp Wax deposition operation

PIPESIM
Schlumberger 7 Open Link

Quick Start Tutorial

This quick start guide shows macro code written in VBA using Microsoft Excel. Even though each
language implements its own particular syntax, the basic logic to write an Open Link code or
macro will be identical. A number of case studies along with VBA code using Excel are provided
under the ..\Case Studies\Open Link directory.
1. Before you start - you must let VBA know about the Open Link interfaces. To do this, click
on Tools | References from the main menu in the VBA window. You should now see a dialog
box like the one below.

2. Scroll down the list of available references until you find the Net32COM 1.0 Type Library.
Check the box to the left of the reference.
3. Now do the same for the FluidModelCOM 1.0 Type Library and for PNSReader 1.0 type library.
4. Click on OK to close the References window.
Loading and running an existing model
1. Load the existing network model: Small Network.bpn, which is shipped with the PIPESIM
installation and normally located in:
C:\Program Files\Schlumberger\PIPESIM\Case Studies\Network
Analysis\Small Network\
If the model were opened from the PIPESIM graphical interface it would look like the picture
below:

PIPESIM
Schlumberger 8 Open Link

2. Using the VisualBasic editor (you can quickly open it from Excel using the shortcut Alt+F11)
create a variable of the type INetModel to perform the basic interaction with the network
model. We will call it NetModel:
Dim NetModel As New NET32COMLib.INetModel
3. Open the model:
NetModel.OpenModel C:\Program Files\Schlumberger\PIPESIM\Case
Studies\Network Analysis\Small Network\Small Network.bpn
4. Run the model (asynchronously):
NetModel.RunNetwork2 False, "-B"
The first argument, in this case False tells the calculation engine not to use a restart file and the
second argument -B is an engine switch that instructs the engine to run in batch mode. For more
information on engine commands please refer to the PIPESIM help.
When executing this macro you should see the calculation engine running in the background. This
process is run asynchronously which means that the macro will continue its execution without
waiting for the simulation run to finish.
If you want your macro to stop until the engine terminates in order to, say, display a result,
then you can replace the line above by the following code:
NetModel.RunNetwork2 False, "-B"
bRunning = NetModel.GetIsModelRunning
While bRunning = True
bRunning = NetModel.GetIsModelRunning
newHour = Hour(Now())
newMinute = Minute(Now())
newSecond = Second(Now()) + 1
waitTime = TimeSerial(newHour, newMinute, newSecond)
Application.Wait waitTime
Wend
MsgBox "Finished..."
This code will run the simulation synchronously. It starts the simulation and then waits until it is
finished. It checks every one second for the engine status through a call to GetIsModelRunning.
When GetIsModelRunning it returns False indicating that the simulation run is finished, the
macro code displays a message box.

PIPESIM
Schlumberger 9 Open Link

Getting results
We would like to display some results from the simulation. The library that reads the results file is
PNSReader and we must create a variable of the type PNSCom in order to extract data from the
simulation output. The public access functions available in PNSReader are detailed in
PNSReaderCOM.
1. Create a PNSCom variable, lets call it results:
Dim results As New PNSREADERLib.PNSCom
2. Read the results file. This file is located in the same directory as the model file and has the
same file name but with the extension .pns:
results.ReadPnsFile(C:\Program Files\Schlumberger\PIPESIM\Case
Studies\Network Analysis\Small Network\Small Network.pns)
3. Get the pressure and temperature at the sink Sink_1 (see model picture above)
Dim index as Long
Dim pressure as Double
Dim temperature as Double
index = results.GetNodeIndex(Sink_1)
pressure = results.GetNodeVariableValue (index, "Pressure")
temperature = results.GetNodeVariableValue (index, "Temperature ")
In the same way variables such as LiquidRate, GasRate, MassRate, GLR or WaterCut can
be obtained for Sink_1 or any other node in the network.
Changing BlackOil fluid parameters
So far, we have opened, run and obtained results for a network model as it was originally defined
within the PIPESIM graphical interface. In this step, we will change some parameters to the
opened model. Here is where the true power of Open Link starts to show, the Excel spreadsheet
may define a range of values to be tested in the context of a what if scenario and multiple
simulation jobs may be set up to compare results for a range of input values for one or more
properties.
1. Create a BlackOil variable:
Dim BlackOil As New FLUIDMODELCOMLib.IblackOil
2. Get the BlackOil model from the network
Set BlackOil = NetModel.BlackOilDefault
The BlackOil variable has been filled with the values defined in the blackoil model in NetModel.
You can corroborate this by adding a watch with the VBA debugging tool and inspecting the
different variable fields.
3. Set a Watercut value of 15%:
BlackOil.Watercut = 15
4. Set an API value of 27.5:
BlackOil.API = 27.5
5. Set this BlackOil with a modified watercut and API back into the network:
NetModel.BlackOilDefault = BlackOil
6. You can now re-run the model with this new values, get the new results, display them in an
Excel cell or plot, etc.
Changing a choke property
1. The following piece of code sets a new value for the choke bean size in Choke which is
defined in the single branch model that corresponds to the production well Well_1.
NetModel. SetPropertyVal (Choke, Well_1, "Bean Size", 3.5,
"inches")
The above line sets bean size = 3.5 inches to Choke in Well_1. .
Saving the changes
1. Any changes made to a single branch or network model can be saved simply by calling the
SaveModel() function.
Dim bOK as Boolean
bOK = NetModel.SaveModel(C:\MyOpenLinkModels\Network.bpn)

PIPESIM
Schlumberger 10 Open Link

The argument is the full path to the file where the model will be saved. It can also be re-saved to
the original model file.
2. bOK will be TRUE (1) or FALSE (0) depending on whether the save operation succeeded or
not. As with all Open Link function calls that return a TRUE/FALSE state, a FALSE value
indicates that some kind of error condition occurred and an error description can be obtained
by calling GetLastError():
Dim Error as String
If bOK = False Then
NetModel.GetLastError Error
MsgBox errorStr
End If

PIPESIM
Schlumberger 11 Open Link

Case Study 1 Building a Well Model from Excel

Problem Outline
It is often desired to build PIPESIM well models from a corporate database. The problem can be
solved by:
1. Pasting the wells data in excel.
2. Using a VBA routine containing Open Link statements to automate the Bps files creation.
This case study illustrates the resolution of such a problem.
Requirements
It is assumed that the reader is familiar with the basics of building models in PIPESIM.
No prior knowledge of VBA (Visual Basic For Application) is required. VBA is a programming
language that is accessed from Microsoft Excel. VBA statements can be used to interact with
Microsoft Applications. These statements cannot interact with PIPESIM. Open Link is the name
given to a group of statements that can be used in VBA to interact with PIPESIM.
Procedure
1. Create a Well Model Template. (That is build a well model in PIPESIM but do not fill any of
the objects that make up the model with values). Save the well model template with the name
template.bps.
2. Organize the wells data in tabular form in Excel.
3. Write the VBA routine that will create a Bps file for each well of the spreadsheet. (The routine
will make use of the model template.bps as will be shown further down in the text).
4. Run the routine The Bps are created and stored in a directory specified in the routine.
Step by step tutorial
Create a Well Model Template
1. Open PIPESIM Open a new well performance analysis window as shown below.

2. Create the following Well Model in the opened window.

3. Save the model with the simple model description selected in both the tubing object and the
flow line object. This is done by double-clicking on both the flowline_1 and tubing_1 object,
selecting simple model in each user form and pressing on the button OK.

PIPESIM
Schlumberger 12 Open Link

4. Save the well model under the name template.bps with the following path:
D:/OpenLink/template/template.bps
Create a table of wells data in Excel (2 vertical gas wells)
1. Open Excel.
2. In the Opened workbook, select sheet 1 (the sheet should be selected by default).
3. Create the following table in Excel (4 Rows 24 Columns).

4. Start the table at the cell $A$4 and finish at the cell $X$7.
5. List of the 24 columns (A to X in order) (The values are given for each column):
A: General Data:
Index. (1,2)
Field. (Field1, Field2)
Well Number (435,436)
Gathering Station (Man1,Man2)
B: Black Oil Data:
Gas Gravity (lbs/cu.ft gas sc) /(lbs/cu.ft air sc). (62,62)
Oil API (Field1, Field2)
GOR scf/bbl (800000,900000)
Water Cut % (10,20)
C: Completion Data:
Pws Psia (Static pressure of the reservoir). (1800,3000)
Temperature F (200,200)
PI mmscf/d/psi2 (1.5053E-08,1.7427E-7)
D: Tubing Data:
Perforation MD m (2104,2104)
Perforation TVD m (2104,2102)
Tubing 1 MD m (2054,2052)
Tubing 1 ID (2.44,2.44)

PIPESIM
Schlumberger 13 Open Link

Tubing 2 MD (Casing MD) (2104,2104)

Tubing 2 ID (Casing TVD) (5.5,5.5)
E: Flow line Data:
Flow line elevation (m) (0,0)
Flow line ID (3,3)
Flow line Length km (4.305,1.212)
F:Choke Data:
Choke Size 1/64th. (95,95)
G: Production Data:
Gas Rate mmscf/d (0.041,1.39)
Well Head Pressure psia (195,250)
Pressure at the end of the flow line. psia (150,440)
6. In cell $A$8 write the template path: D:/OpenLink/template/template.bps
7. In cell $A$9 write the path in which the Bps files are to be stored:
D:/OpenLink/
8. In cell $D$11 write the surface temperature: 90 F.
9. Save the current workbook under the name Openlink.xls with the following path:
D:/OpenLink/Excel/Openlink.xls
Preliminary steps
1. Enable Macros in your workbook.
2. Select the Menu tools Sub Menu Macro Security as shown below.

PIPESIM
Schlumberger 14 Open Link

The following user form should appear:

3. Select Medium. High does not let the user run any unsigned Macros.
4. Insert a Button in the workbook that will launch the routine. First, display the Control
Toolbox Toolbars.

PIPESIM
 Schlumberger 15 Open Link

5. Then insert a button in the spreadsheet by clicking on the Command Button Icon in the
Control Toolbox; and clicking and dragging the button in the spreadsheet. This is shown
below:

Design Mode
Icon.

Command Button
Icon.

The default name of the button is CommandButton1.

Note: Clicking on the Command Button icon activates the design mode that allows you to place
buttons and other types of controls in the spreadsheet. You will need to deactivate the design
mode manually when you want the routine associated with the button to be executed when you
click on it.

PIPESIM
Schlumberger 16 Open Link

6. Next change the name of the button by right-clicking on the button CommandButton1 the
following menu should appear:

7. Click on CommandButton Object Submenu Edit. You can now change the caption of the
button CommandButton1 to: Create Well Model.
8. Open the VBA Editor Windows. As the design mode is activated, it is possible to open the VBA
editor windows by double-clicking on the button CommandButton1. The following window
should then appear:
Private Sub CommandButton1_Click()

End Sub
The window that contains the statements is called the Code window. You write VBA routines in
the Code window. The word Sub in the first line indicates to the computer that it is the beginning
of a new routine. (In effect, several routines can be written in the same Code window). The word
CommandButton1_Click in the first line indicates to the computer that the routine following can
only be executed by clicking on the button CommandButton_1. The statement End Sub indicates
to the computer that this is the end of the routine. Any routine must finish with this statement.
Activating the Open Link statements Libraries.
In order to be able to write our routine using Open Link statements we need to indicate to the
computer that we are going to use those statements. We need to activate those statements so that
they can be understood by VBA.
1. We can activate the Open Link statements by clicking on the menu Tools, submenu
References.

PIPESIM
Schlumberger 17 Open Link

You should now see a dialog box like the one below:

2. Scroll down the list of available references until you find the FluidModelCOM 1.0 Type Library.
Check the box to the left of the reference.
3. Now do the same for Net32COM 1.0 Type Library and NODALOPLib.INodalAnal.
4. Click on OK to close the reference window.
Each of the three library activated is a group of Open Link statements that can be used in VBA to
communicate with PIPESIM. These libraries will be available from Excel after having installed
PIPESIM. They need to be activated before they can be used while programming.
Note: If a routine is passed from one computer to another, and it does not work on the receiving
computer, it is because the Open Link Libraries have not been activated.
Write the VBA routine using Open Link Statements:
1. Write the following routine:
The actual workings of the routine will be explained in Case Studies.

PIPESIM
Schlumberger 18 Open Link

PIPESIM
Schlumberger 19 Open Link

PIPESIM
Schlumberger 20 Open Link

Run the routine

1. Go back to Excel and select the two wells with the mouse (by highlighting the corresponding
rows) you will have created two .bps files corresponding to the two wells of the spreadsheet.
The directory Open Link will contain the two .bps Files (shown below).

PIPESIM
Schlumberger 21 Open Link

Case Study 2 - Nodal Analysis

Problem Outline
It is required to see if our production data is consistent with what the model predicts the flow rate
should be. We will run a nodal analysis on each of the wells. The boundary conditions of the
problem are the reservoir static pressure and the outlet pressure of the model (i.e. the downstream
end of the flow line). The Stock tank gas flow rate at the operation point will be compared to the
Gas flow rate given in the production data.
Requirements
It is assumed that the reader is familiar with the PIPESIM Nodal Analysis User Form.
Procedure
You will write a VBA-Open Link routine that uses the table built in the previous case study. The
routine fills in a Nodal Analysis operation interface using the static pressure, tubing ID and Outlet
Pressure stored in Excel and then assigns this Nodal Analysis operation interface to the Well
Models created in Case study 1. Each of the models is then run. A Nodal Analysis plot (system
plot_.plt) is produced for each well. You can then check on the graphs if the stock tank flow rates
at the operation points are consistent with the production data.
Step by Step Tutorial
1. Open the Excel File (OpenLink.xls)
D:/OpenLink/Excel/Openlink.xls
2. Insert a second button in the Spreadsheet. This is done using the control toolbox as in Case
Study 1. The default name of the button will be CommandButton2.

3. Open the VBA editor. This is done as in Case Study 1 by double clicking on the button
CommandButton2. The code written for the previous case study will be visible.
Private Sub CommandButton2_Click()
End Sub

PIPESIM
Schlumberger 22 Open Link

At the end of the code, from the previous case study, the statements are visible. This is shown
below:

Write the VBA routine using Open Link statements

1. Write the routine:
The workings of the routine are explained in Case Studies.

PIPESIM
Schlumberger 23 Open Link

PIPESIM
Schlumberger 24 Open Link

PIPESIM
Schlumberger 25 Open Link

Run the routine

1. Go back to Excel and select the two wells (by highlighting the corresponding rows).
2. Press the button CommandButton_2. This runs a nodal analysis on the two .bps files
produced in Case Study 1. The contents of folder Open Link after having run the routine is
shown below:

. plt Files.

3. Clicking on the .plt files will display the following graphs:

.
Plot of Man1_435

PIPESIM
Schlumberger 26 Open Link

Plot of Man2_436

PIPESIM
Schlumberger 27 Open Link

Modules and Interfaces

NOTE:
1. Values returned as -7777 mean 'UNSET' or could not calculate do to missing data or has not
been calculated.
2. For all modules and interfaces, where applicable, required methods in are shown in RED and
those conditionally required in GREEN.
ISingleBranchModel Interface
ISingleBranchModel object - Get Methods
GetNameList (ObjectType As Long, Returns in pNameArray an array of String with
pNameArray, Count As Long) the names of objects of the given type
(ObjectType). The number of objects found is
returned in Count.
ObjectType can be any value of:
10 - Generic Source
11 - Vertical Completion
12 - Horizontal Completion
13 - Flowline
14 - Riser
15 - Zero length connector
16 - Tubing
17 - Generic Node
18 - Choke
19 - Compressor
20 - Expander
21 - Heat Exchanger
22 - Centrifugal Pump
23 - Multiphase Booster
24 - Injection Point
25 - Separator
26 - Report tool
27 - Adder/Multiplier
28 - Nodal Analysis Point
29 - Engine Keyword Tool
30 Reinjector
32 SSSV
33 Gas Lift Valve
34 Black Box
GetEquipmentInfo (EquipmentType As If ParentObject string is empty, the function is the
Long, ParentType As Long, ParentObject As same as GetNameList (). See GetNameList
String, EquipmentNames, Count As Long) () for a map to EquipmentType options.
Otherwise it returns in EquipmentNames array of
String with the names of child objects of the given
type (ObjectType) for specified ParentObject of
ParentType
GetHasArtificialLift (ObjectType As Returns 0: no artificial lift
Long, ObjectName As String, Lift As Long) 1: gas lift injection
2: ESP
-1: Object not found
ObjectType must be Tubing type (16)
ObjectName the name of the tubing
GetStartBoundaryObject (ObjectType As Returns the ObjectType (See GetNameList ())
Long, ObjectName As String) and its name of the upstream-most object in the
single branch model.

PIPESIM
Schlumberger
GetCountObjectsInProfile (Count As
Long)
GetObjectAtIndex (Index As Long,
ObjectType As Long, ObjectName As
String)
GetLastError (ErrorStr As String)
GetIsModelRunning () As Boolean
GetOperationInterface (pIOperation As
Object)
GetOperationType () As Long
GetPropertyNames (ObjectName As
String, PropNames) as Long
GetPropertyVal (ObjectName As String,
PropName As String, pValue As Double,
pUnitStr As String) As Boolean
GetPropertyValAtObjectIndex
(ObjectName As String, PropName As
String, pValue As Double, pUnitStr As
String, SubObjectType As Long, Index As
Long) As Boolean
GetPropertyStringAtObjectIndex
(ObjectName As String, PropName As
String, pValue As String, Index As Long) As
Boolean
GetPropertyType (ObjectName As String,
PropName As String) As Long
GetSensitivityInfo (ObjectType As Long,
ObjectName As String, VariableNames,
ItemReference)
GetSensitivityVariables (ObjectName As
String, VariableNames, StdQtyNames) As
Long
PIPESIM
28 Open Link
Returns the number of objects in the single
branch model
Returns the object's type and name at the
specified zero-based index. Index must between
zero and the number returned by
GetCountObjectsInProfile () minus 1.
Returns the last error message produced by the
interface.
Returns Boolean value True if the simulation
process is active
Returns the operation object
Returns Long value as the operation defined for
the model. See Defined constants and strings
Returns in PropNames the list of properties
defined for the object ObjectName. Returns the
number of properties as functions return value
For specified property (PropName) in the
specified object (ObjectName) function gets a
property value in Value and the units in UnitStr.
Return value is True if the property was retrieved
successfully, otherwise False. For implemented
PropNames see Defined constants and strings.
Gets a specified property value.
This function extends the functionality of
GetPropertyVal by allowing you to retrieve a
property from a specified sub-component within
an object. A typical use of this is when for
instance it is required to get a gas lift flowrate
(PropName) from the top (Index = 0) gas lift
injection point (SubObjectType) in the tubing
Tubing_1 (ObjectName). For available options
see Defined constants and strings
The function is similar to
GetPropertyValAtObjectIndex but for
properties defined as string
Returns the property type:
UNDEFINED -1
REAL 0 (value in strict SI units)
INT 1
DOUBLE 2
STR 3
Returns the list of variable names upon which a
sensitivity analysis can be performed for the
given object (defined by its type and name). See
GetNameList () for object type values.
ItemReference holds additional binary
information about the sensitivity that is required
by some operation module interfaces (such as the
Artificial Lift COM interface)
Requests the list of variable names and their
measurements upon which a sensitivity analysis
can be performed for the given object (defined
by name). The return value holds number of the
variables
Schlumberger
ISingleBranchModel object - Set Methods
SetOperationInterface (pIOperation As
Unknown)
SetOperationType (OperationType As
Long)
SetPropertyVal (ObjectName As String,
PropName As String, value As Double,
UnitStr As String) As Boolean
SetPropertyStringAtObjectIndex
(ObjectName As String, PropName As
String, value As String, Index As Long) As
Boolean
SetPropertyValAtObjectIndex
(ObjectName As String, PropName As
String, value As Double, UnitStr As String,
SubObjectType As Long, Index As Long) As
Boolean
SetPVTFile (bstrPVTFilename As String)
SetUnitManager (p_VarUnitManager)
ISingleBranchModel object - Properties
BlackOil As Object
Composition As Object
FlowCorrelation As Object
Fluid As FluidModel
FluidModelType As Long
GasLiftDesign As Object
GasLiftSystemProps As Object
ObjectProperties (ObjectName As String)
As ProfileObj
ProjectInfo As ProjectInfo
ProjectPath As String
FieldSurvey As Object
ErosionCorrosion As Object
Keywords As String
PIPESIM
29 Open Link
pIOperation: The interface instance to an
operation object. This function assigns the given
operation to the opened single branch model
Sets the operation type for the single branch
model. See Defined constants and strings
Sets the specified property (PropName) in the
specified object (ObjectName) to the value given
in Value in the given units (UnitStr). Function
returns True if the property was set successfully,
otherwise False. Implemented PropNames: see
Defined constants and strings.
As SetPropertyValAtObjectIndex () but for
properties defined as string
This function extends the functionality of
SetPropertyVal by allowing you to set a
property to a specified sub-component within an
object. A typical use of this is when for instance it
is required to set a gas lift flowrate (PropName)
through the top (Index = 0) gas lift injection point
(SubObjectType) in the tubing Tubing_1
(ObjectName). For available options see Defined
constants and strings.
Sets the compositional file (.pvt) to be used as the
main fluid in the simulations
Sets the Unit Manager object
Gets/sets the Black Oil fluid definition object
Gets/sets the fluid composition object
Gets/sets the Flow Correlation object
Gets/sets the FluidModel object (See
IFlowlineObj Interface)
Gets/sets the fluid type (0: black oil, 1:
compositional, 2: PVT file, 3: MFL file)
Gets/sets the Gas Lift Design object
Gets/sets the Gas Lift System Properties object
Sets/returns a ProfileObject (See
IObjectProperties Interface). Depending on the
object type of ObjectName this interface can be
set to the specific object type interface. For
instance a tubing object returns a ProfileObject,
which can be set to a TubingObj object. The
TubingObj (See ITubing Interface) contains
properties and methods to define or obtain
information from a detailed tubing object.
Returns the ProjectInfo object to access project
specific data
Sets full path name to the model file
Gets/sets the FieldSurvey object
Gets/sets the ErosionCorrosion object
Gets/sets the additional engine keywords
Schlumberger
ISingleBranchModel object - Operations
ExportEngineFiles ()
ExportEngineFiles2 (operationfile As
String) As String
ExportEngineFiles3 (nExpertMode As
Long)
KillSimulationProcess ()
NewModel (bstrModelFileName As String,
ProfileTypesList, ProfileNamesList) As
Boolean
OpenModel (bstrModelFileName As
String)
RunSingleBranchModel (bRestart As
Boolean)
RunSingleBranchModel2 (bRestart As
Boolean, EngSwitches As String,
DynamicPlot As Boolean)
RunSingleBranchModel3 (bRestart As
Boolean, EngSwitches As String,
DynamicPlot As Boolean,
ExpertExtensions As Boolean)
SaveModel (bstrPathName As String) As
Boolean
ValidateTubingConfiguration(MaxInjTV
D As Double) As Boolean
PIPESIM
30 Open Link
This function generates an ASCII file (.psm) in the
PIPESIM engine keyword language that
corresponds to the opened model. This file can
then be used with PIPESIM expert mode.
In addition to ExportEngineFiles (), this
function returns the full pathname to the
exported file (.psm) and its associated operation
file (.inc)
This function is similar to ExportEngineFiles
function but it allows to specify the format for
exported files in nExpertMode parameter:
0 default format,
1 with expert extensions
2 for ESP design
3 same as for 1 but warning is displayed if files
exist
Terminates the simulation process
Creates a new PIPESIM model.
bstrModelFileName: full path to the file where the
new model is to be saved. ProfileTypesList: a list
of object type identifiers (integer numbers) that
describe the object connectivity in the model
see Defined constants and strings for ids map.
ProfileNamesList: a list of object names for each
one of the elements of ProfileTypesList. This
variant may be empty in which case default
names will be assigned. The method returns True
if operation was successful, False otherwise
Opens the given single branch model. Filename
must be a valid PIPESIM single branch model file
(.bps).
This function must be called first when using this
interface.
Runs the currently opened model by calling the
calculation engine program as specified in the
PIPESIM installation. If bRestart is True the
simulation will load any previously restart files
(.rst files) as its initial conditions. Return value is
True for successful engine start, False otherwise.
Similar to SetOperationInterface, it also
accepts one or more switches to be passed to the
simulation engine and turns dynamic plotting
on/off.
Similar to SetOperationInterface2, it also
allows using of the Expert extensions
Saves the currently opened model to a file given
by bstrPathName. Function returns True if model
is saved, otherwise the return value is False.
This function checks the tubing configuration
above the injection point to verify that all
dimensions are properly set. If function fails the
error message is available using the GetLastError
function.
Schlumberger 31 Open Link

SetOutpoutUnits(nUnits As Integer) As This function forces the output to be written in

Boolean specified units (0 models default units, 1 Eng
units and 2 SI units).
ISingleBranchModel object Examples
VBA Sample Code
Dim SingleBranchObj As New NET32COMLib.ISingleBranchModel
Dim equipnames As Variant
Dim sensvarnames As Variant
Dim objref As Variant

Dim count As Long

'Open the model

SingleBranchObj.OpenModel C:\Program Files\Schlumberger\Pipesim\Case
Studies\Open Link\Gas Lift Performance.bps

'Export Psm file

Dim ExportFile As String
Dim OperationFile As String
ExportFile = SingleBranchObj.ExportEngineFiles2(OperationFile)

'Get object information

Dim count As Long

Dim objtype As Long
Dim objname As String

SingleBranchObj.GetCountObjectsInProfile count

'Write to the spreadsheet the list of objects in the single branch model
For indx = 0 To count - 1
SingleBranchObj.GetObjectAtIndex indx, objtype, objname
Cells(indx + 1, 1) = objname
Cells(indx + 1, 2) = objtype
Next

'Get Sensitivity Information for the tubing (type = 16) with identifier
Tub_1
SingleBranchObj.GetSensitivityInfo 16, Tub_1, sensvarnames, objref

'Write the list of sensitivity variables to the spreadsheet

Dim name As Variant
For Each name In sensvarnames
r.Cells(i, 1) = name
i = i + 1
Next
IObjectProperties Interface
ProfileObj object - Properties
Fluid As FluidModel Gets a FluidModel interface object (see
description below)
ProfileObj object - Get Methods
GetLastError () As String Returns an error description
GetPropertyNames (PropNames) As Returns in PropNames the array of properties
Long defined for the object. Functions return value is
the number of properties

PIPESIM
Schlumberger
GetValue (PropName As String, pValue,
pUnitStr As String, Index As Long) As
Boolean
ProfileObj object - Set Methods
SetValue (PropName As String, value,
UnitStr As String, Index As Long) As
Boolean
ITubing Interface
TubingObj Object - Get Methods
GetCountDownholeEquipment (Type
As Long) As Long
GetCountTubingSection () As Long
GetDeviationSurvey_SI (Type As
Long) As Variant
GetDownholeEquipment (Type As
Long, Index As Long, label As String) As
Double
GetDownholeEquipmentAtIndex
(Index As Long, Type As Long, label As
String) As Double
PIPESIM
32 Open Link
Gets the specified property (PropName) value in
Value in the given units (UnitStr). Return value is
True if the property was set successfully,
otherwise False. Implemented PropNames: see
Defined constants and strings. Index is a reserved
argument, set it to 1.
Sets the specified property (PropName) value in
Value in the given units (UnitStr). Return value is
True if the property was set successfully,
otherwise False. Implemented PropNames: see
Defined constants and strings. Index is a reserved
argument, set it to 1.
Returns the number of items specified in the
detailed tubing model of a given type of equipment
Type: any of
16 Tubing section
18 - Choke
22 - Centrifugal Pump
24 - Injection Point
25 - Separator
32 SSSV
33 Gas Lift Valve
(See Object Type Identifiers)
Similar to GetCountDownholeEquipment, but
specific to tubing sections
Returns in a Variant the matrix of doubles defined
as two columns and a variable number of rows.
The variable in each column depends in the
requested Type.
Type: 0 = md vs. tvd, 1 = md vs. angle, 2 = tvd vs.
angle
All values are in strict SI units
Returns the md (as functions return value) and the
label of a given Type of downhole equipment and
at given Index.
Type: any of
16 Tubing section
18 - Choke
22 - Centrifugal Pump
24 - Injection Point
25 - Separator
32 SSSV
33 Gas Lift Valve
Index: the 0 based positional index of the item.
Index = 0 refers to the top-most item closest to the
wellhead.
Returns the equipment type, label and md (as
functions return value) in strict SI units at a given
Index. See GetDownholeEquipment for
definition of Index
Schlumberger
GetGeothermalSurvey_SI (vbIsTVD
As Boolean) As Variant
GetTubingSection (Index As Long,
label As String) As Double
GetMDatTVD_SI (tvd As Double) As
Double
GetTVDatMD_SI (md As Double) As
Double
GetInputOK (info As String) As
Boolean
TubingObj Object -Set Methods
SetDeviationSurvey_SI (Type As
Long, Survey) As Boolean
SetGeothermalSurvey_SI (vbIsTVD
As Boolean, Survey) As Boolean
TubingObj Object -Properties
InjectionPointFluid (Index As Long)
As FluidModel
RemedialCoiledTubingEnabled As
Boolean
TubingObj Object - Operations
AddDownholeEquipment (Type As
Long, md_SI As Double, label As String)
As Long
AddGasLiftValve_SI (md As Double,
manuf As String, series As String,
portName As String, portSize As Double,
mode As String, ptro As Double, Ap As
Double, Ab As Double, nomOD As
Double, cv As Double, dpfo As Double)
As Long
PIPESIM
33 Open Link
Returns the geothermal survey in Variant matrix of
doubles defined as three columns and a variable
number of rows. The columns are defined as Depth
vs. Ambient Temperature vs. U value. Depth is
TVD if vbIsTVD = true, otherwise MD
Similar to GetDownholeEquipment, but specific
to tubing sections
Returns the md given the tvd based on the
deviation survey
Returns the tvd given the md based on the
deviation survey
Validates the tubing data and returns True if
configuration is correct, otherwise the function
returns False and info contains the error message
Sets a deviation survey to a detailed tubing model.
See GetDeviationSurvey_SI for available types.
Survey must be a variant matrix of double values
specified as a two-column table with any number
of rows (minimum 2).
Sets a geothermal survey to a detailed tubing
model.
See GetGeothermalSurvey_SI for definition of
Survey and vbIsTVD.
Gets/sets the FluidModel object for the injection
point at a given index. This function is only
applicable for compositional models. See
ISinglePointCalib object.
Enables/disables Remedial Coiled Tubing option in
configuration
Adds an equipment item to the detailed tubing
Type: any of
22 - Centrifugal Pump
24 - Injection Point
25 - Separator
32 SSSV
33 Gas Lift Valve
label: the items label
Function returns the 0 based positional index of
the added item. Index = 0 refers to the top-most
item closest to the wellhead
Adds a gas lift valve to the tubing object. Returns
the zero-based index corresponding to the valve
position with index of the topmost valve equal to 0.
Schlumberger
AddTubingSection (BottomMD_SI As
Double, label As String) As Long
ClearGasLiftValves ()
RemoveDownholeEquipment (Type
As Long, Index As Long)
RemoveTubingSection (Index As
Long)
DisplayDialog (p_VarUnitManager,
fluidtype As Integer) As Boolean
IVertCompObj Interface
VertCompObj Object - Get Methods
GetInputOK (info As String) As
Boolean
VertCompObj Object - Set Methods
SetMultipoint(value As Long) As
Boolean
SetIPRFluidType(Type As Long) As
Boolean
SetIPRTable_SI(QPPoints) As Boolean
GetConingTableData(IsUsed As
Boolean, ConedGasSG As Double,
Flowrate, GOR, WCut) As Boolean
VertCompObj Object - Operations
CalculateIPR() As Boolean
PIPESIM
34 Open Link
Adds a section of tubing
BottomMD_SI: the bottom md of the section in
strict SI units
label: the items label
Function returns the 0 based positional index of
the added section
Removes all gas lift valves from the tubing
Removes a piece of equipment of a given type and
at the given Index.
Type: any of
22 - Centrifugal Pump
24 - Injection Point
25 - Separator
32 SSSV
33 Gas Lift Valve
Index: the 0 based positional index of the item.
Index = 0 refers to the top-most item closest to the
wellhead
Similar to RemoveDownholeEquipment but
applicable to tubing sections
Function invokes tubing configuration dialog and
returns True if OK button was clicked, False
otherwise. p_VarUnitManager is a Units Manager
object and fluidtype can be one of the following
values:
0: black oil
1: composition
2: PVT file
3: MFL file
Validates the flowline data and returns True if
configuration is correct, otherwise the function
returns False and info contains the error message
Set either multipoint=1 or isochronal=0 type of
IPR data table
Set fluid type for IPR: type_liquid=0, type_gas=1
Sets the IPR table values. QPPoints is a 3-column
array of Doubles, where first column contains
Flowrate values, second column contans Pwf
values and the third one contains Pws values. All
values are in strict SI units
Returns the coning table data for the vertical
completion. IsUsed is TRUE if it is set and FALSE
otherwise, ConedGasSG contains a value for coned
gas specific gravity, Flowrate, GOR and WCut are
the one-column arrays of Doubles containing
flowrate, GOR and watercut values respectively.
All values are in Eng units
Schlumberger
DisplayDialog (p_VarUnitManager) As
Boolean
IFlowlineObj Interface
FlowlineObj Object - Properties
HeatTransfer As Object
FlowlineObj Object - Get Methods
GetInputOK (info As String) As
Boolean
FlowlineObj Object - Operations
AddProfileNode_SI (distance As
Double, elevation As Double, ambientT
As Double, uValue As Double, label As
String)
ClearDetailedProfile ()
UseDetailedProfile (UseDetailed As
Boolean)
DisplayDialog (p_VarUnitManager) As
Boolean
GetNodesCount () As Long
GetPipeOD (od as Double, units as
String)
IHeatTransfer Interface
HeatTransfer Object - Properties
UValueType As Long
IsIFCIncluded As Boolean
AmbientFluidType As Long
HeatTransfer Object - Get Methods
GetUValue (uVal as Double, units as
String)
GetPipeConductivity (dblVal as
Double, units as String)
GetAmbientFluidVelosity (dblVal as
Double, units as String)
GetBurialDepth (dblVal as Double,
units as String)
GetGroundConductivity (dblVal as
Double, units as String)
PIPESIM
35 Open Link
Function invokes Vertical Completion
configuration dialog and returns True if OK button
was clicked, False otherwise. Pass a Null variant
as the arguments value.
Gets/sets HeatTransfer object
Validates the flowline data and returns True if
configuration is correct, otherwise the function
returns False and info contains the error message
Adds a node to the flowline detailed node
description. All values must be given in strict SI
units.
Deletes all nodes in the flowline detailed profile
UseDetailed = True: instructs the flowline to use
the detailed profile description.
UseDetailed = False: use the flowlines simple
description, detailed nodes will be generated
automatically.
Function invokes flowline configuration dialog and
returns True if OK button was clicked, False
otherwise. Pass a Null variant as the arguments
value.
Function returns a number of nodes defined in a
detailed profile
Function calculates pipes OD based on coating
properties
Gets/sets U Value type. Possible values are 0 for
calculated, 1 for insulated, 2 for coated, 3 for bare
in air, 4 for bare in water and 5 for user-specified
Gets/sets a Boolean value for inside filem
coefficient. True if IFC is included in U Value and
False if it is calculated separately.
Gets/sets an ambient fluid type. 0 for air and 1 for
water.
Returns U Value and units string. Fails if
UValueType is set to calculated
Returns pipe conductivity value and units string.
Fails if UValueType is not calculated
Returns ambient fluid velocity value and units
string. Fails if UValueType is not calculated
Returns pipe burial depth value and units string.
Fails if UValueType is not calculated
Returns ground conductivity value and units string.
Fails if UValueType is not calculated
Schlumberger
GetCoatingData_SI (varData)
HeatTransfer Object - Set Methods
SetUValue (uVal as Double, units as
String)
SetPipeConductivity (dblVal as
Double, units as String)
SetAmbientFluidVelosity (dblVal as
Double, units as String)
SetBurialDepth (dblVal as Double,
units as String)
SetGroundConductivity (dblVal as
Double, units as String)
SetCoatingData_SI (varData)
IFluid Interface
FluidModel Object - Properties
Composition As Object
BlackOil As Object
FluidModelType As Long
OverrideValues As Boolean
WCutoverride_SI As Double
GORoverride_SI As Double
OGRoverride_SI As Double
LGRoverride_SI As Double
GLRoverride_SI As Double
GORoverride_Type As Integer
IsLocalFluid As Boolean
CompositionType As Long
FluidName As String
FluidModel Object - Get Methods
GetInputOK (info As String) As
Boolean
FluidModel Object - Operations
DisplayDialog (p_VarUnitManager) As
Boolean
PIPESIM
36 Open Link
Returns a pipe coating data array. First column
containts layer-specific conductivity values and a
second column containts layer thicknesses. Fails if
UValueType is not calculated
Sets U Value in specified units. Fails if UValueType
is set to calculated
Sets pipe conductivity value in specified units.
Fails if UValueType is not calculated
Sets ambient fluid velocity value in specified units.
Fails if UValueType is not calculated
Sets pipe burial depth value in specified units.
Fails if UValueType is not calculated
Sets ground conductivity value in specified units.
Fails if UValueType is not calculated
Sets a pipe coating data. Data has to be passed as
an array where first column containts layer-
specific conductivity values and a second column
containts layer thicknesses. Fails if UValueType is
not calculated
Accesses the ICompositional object (See
ISinglePointCalib object)
Accesses the IBlackOil object (Ref IBlackOil )
Retrieves the fluid model type: 0: BlackOil, 1:
Compositional, 2 PVT File, 3 MFL File
Sets/gets whether Wcut/GOR values are overridden
from the values defined in the fluid model.
Accesses the watercut override value
Accesses the GOR override value
Accesses the OGR override value
Accesses the LGR override value
Accesses the GLR override value
Accesses which GOR type is being overridden
(0=GLR, 1=GOR, 2=LGR, 3=OGR)
Sets/gets whether the object is using a local fluid
model
Sets/gets whether the local composition is a PVT
file or a defined PIPESIM composition or local
MFL file
Sets/gets a fluid name
Validates the fluid model data and returns True if
configuration is correct, otherwise the function
returns False and info contains the error message
Function invokes fluid configuration dialog and
returns True if OK button was clicked, False
otherwise. Pass a Null variant as the arguments
value.
Schlumberger
IProjectInfo Interface
ProjectInfo Object - Properties
Description As String
User As String
Job As String
Company As String
Manager As String
Remarks As String
Date As String
Field As String
WellNumber As String
Lease As String
Country As String
Address As String
Email As String
Phone As String
Fax As String
IErosionCorrosion Interface
ErosionCorrosion Object - Properties
CalculatePH As Long
CorrosionEfficiency As Double
CorrosionModel As Long
ErosionEfficiency As Double
ErosionModel As Long
ErosionRate_Eng As Double
ErosionVelocityConst As Double
GeometryConstant As Double
SandGrainSize_Eng As Double
SandProdRatio As Double
UserDefinedPH As Double
ProjectInfo Object Example
VBA Sample Code
Dim SingleBranchObj As New NET32COMLib.ISingleBranchModel
Dim equipnames As Variant
Dim sensvarnames As Variant
Dim objref As Variant
Dim count As Long
'Open the model
SingleBranchObj.OpenModel C:\Program
Link\Gas Lift Performance.bps
'Export Psm file
Dim ExportFile As String
Dim OperationFile As String
ExportFile = SingleBranchObj.ExportEngineFiles2(OperationFile)
'Get object information
PIPESIM
37 Open Link
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets string property
Gets/sets value for Actual pH property (1
calculate value, 0 use user-defined pH value)
Gets/sets corrosion efficiency value
Gets/sets value for Corrosion Model property (0
none, 1 use de Waard (1995) model )
Gets/sets erosion efficiency value
Gets/sets value for Erosion Model property (0
API 14e model, 1- SALAMA (2000))
Gets/sets acceptable erosion rate value
Gets/sets erosion velocity constant value
Gets/sets geometry constant value
Gets/sets sand grain size value
Gets/sets sand production ratio value
Gets/sets user-defined pH value
Files\Schlumberger\PIPESIM\Case Studies\Open
Schlumberger 38 Open Link

Dim count As Long

Dim objtype As Long
Dim objname As String

SingleBranchObj.GetCountObjectsInProfile count

'Write to the spreadsheet the list of objects in the single branch

model
For indx = 0 To count - 1
SingleBranchObj.GetObjectAtIndex indx, objtype, objname
Cells(indx + 1, 1) = objname
Cells(indx + 1, 2) = objtype
Next

'Get Sensitivity Information for the tubing (type = 16) with identifier
Tub_1
SingleBranchObj.GetSensitivityInfo 16, Tub_1, sensvarnames, objref

'Write the list of sensitivity variables to the spreadsheet

Dim name As Variant
For Each name In sensvarnames
r.Cells(i, 1) = name
i = i + 1
Next
INetModel Interface
INetModel Interface - Get Methods
DoesCustomKeyExists (KeyName Returns true if custom data has been stored against
as String) as Boolean the KeyName string

GetNameList (ObjectType As Long, Returns in pNameArray an array of String with the

pNameArray, Count As Long)
GetHasArtificialLift (ObjectType As
Long, ObjectName As String, Lift As
Long)
GetEquipmentInfo (EquipmentType
As Long, ParentType As Long,
ParentObject As String,
EquipmentNames, Count As Long)
names of objects of the given type (ObjectType). The
number of objects found is returned in Count.
ObjectType can be any of:
1 - Folder
2 - Source
3 - Sink
4 - Junction
5 - Branch
6 - Text Object
7 - Production Well
8 Injection Well
Returns:
0: no artificial lift
1: gas lift injection
2: ESP
-1: Object not found
ObjectType must be Tubing type (16)
ObjectName the name of the tubing
Returns the names of equipment of type
EquipmentType (See GetNameList () for the
ISingleBranch object for available types), which are
part of the single branch model of object
ParentObject of type ParentType. ParentType should
be ProductionWell (7), InjectionWell (8), or Branch
(5)

PIPESIM
Schlumberger
GetLastError (ErrorStr As String)
GetBoundaryProperties
(ObjectName As String, Pressure As
Double, Temperature As Double,
Fluidrate As Double, Fluidtype As
Long)
GetBoundaryProperties_SI
(ObjectName As String, Pressure As
Double, Temperature As Double,
Fluidrate As Double, fluidtype As Long)
GetBoundaryBlackOil (ObjectName
As String, BlackOil As Object) As
Boolean
GetBoundaryComposition
(ObjectName As String, Composition
As Object) As Boolean
GetBoundaryCompositionType
(ObjectName As String, Type As Long)
GetBoundaryPVTFile (ObjectName
As String, PVTFilename As String) As
Boolean
GetBoundaryType (ObjectName As
String, Type As Long, CurveOption As
Long)
GetCountObjectsInProfile
(NetObjectName As String) As Long
GetIsModelRunning () As Boolean
GetPropertyNames (ObjectName As
String, ParentName As String,
PropNames) As Long
GetPropertyVal (ObjectName As
String, ParentName As String,
PropName As String, pValue As Double,
pUnitStr As String) As Boolean
39 Open Link
Returns the last error message produced by the
interface
Returns the boundary properties set in the model for
object with identifier ObjectName. ObjectName must
be a boundary object (Source, Sink, Production Well
or Injection Well)
Pressures in psia
Temperatures in F
Fluidtype = 0 (liquid rate), Fluidrate in STB/D
Fluidtype = 1 (gas rate), Fluidrate in mmscf/d
Fluidtype = 2 (mass rate), Fluidrate in lb/s
Similar to GetBoundaryProperties except that this
function returns the properties in strict SI units.
Gets the BlackOil object used by the source with
identifier ObjectName. Only applicable for BlackOil
models. The function returns True in case of success
and False otherwise
Gets the Compositional object used by the source
with identifier ObjectName. Only applicable for
compositional models, The function returns True in
case of success and False otherwise
Returns the composition model location used by the
ObjectName source object:
0: object is using a locally defined composition
1: object is using a locally defined PVT file
2: object is using the models globally defined
composition or PVT file
3: object is using a locally defined MFL file
Gets the PVT file used by the source with identifier
ObjectName. Only applicable for Compositional/PVT
models
Returns the boundary condition type specified for the
ObjectName source:
Type = 0 pressure and/or flowrate specified
Type = 1 PQ curve specified
If Type = 1 then CurveOption returns:
CurveOption = 0 create curve when required
CurveOption = 1 create curve at every engine run
CurveOption = 2 use a specified PQ curve file
Returns the number of objects in the single branch
model defined for NetObjectName.
Returns True if simulation is running
Returns in PropNames the list of properties defined
for the object ObjectName. If ObjectName is defined
at the single branch level then ParentName must be
the identifier for its parent Network object. Return
value is the number of properties
For specified property (PropName) in the specified
object (ObjectName) function gets a property value in
Value and the units in UnitStr. Return value is True if
the property was retrieved successfully, otherwise
False. ParentName is the object at the network level
and should define ObjectName in its single branch
model. Implemented PropNames: see Defined
PIPESIM
Schlumberger
GetPropertyValAtObjectIndex
(ObjectName As String, ParentName As
String, PropName As String, pValue As
Double, pUnitStr As String,
SubObjectType As Long, Index As
Long) As Boolean
GetPropertyStringAtObjectIndex
(ObjectName As String, ParentName As
String, PropName As String, pValue As
String, Index As Long) As Boolean
GetSingleBranchModel
(NetObjectName As String) As
ISingleBranchModel
GetNamesInFolder(FolderName As
String, ObjectType As Long,
pNameArray, Count As Long)
GetNodeCooordinates(ObjectName
As String, pCoordArray) As Boolean
GetConnectionInfo(pBranchArray,
pSNodeArray, pENodeArray) As
Boolean
GetBoundaryCurveFile(ObjectName
As String) As String
GetCustomData(KeyName As String,
pValue) As Boolean
GetCustomKeys(pKeyNameArray) As
Boolean
GetFlowrateLimits_SI(ObjectName
as String) As Variant
INetModel Interface - Set Methods
SetBoundaryBlackOil (ObjectName
As String, BlackOil As Object) As
Boolean
SetBoundaryComposition
(ObjectName As String, Composition
As Object) As Boolean
SetBoundaryCurveFile (ObjectName
As String, CurveFileName As String) As
Boolean
40 Open Link
constants and strings
Gets a specified property value.
This function extends the functionality of
GetPropertyVal by allowing you to retrieve a
property from a specified sub-component within an
object. A typical use of this is when for instance it is
required to get a gas lift flowrate (PropName) from
the top (Index = 0) gas lift injection point
(SubObjectType) in the tubing Tubing_1
(ObjectName). ParentName is the object at the
network level and should define ObjectName in its
single branch model. For available options see
Defined constants and strings
The function is similar to
GetPropertyValAtObjectIndex () but for
properties defined as string
Returns the ISingleBranchModel object for the
NetObjectName specified
Returns in pNameArray an array of String with the
names of objects of the given type (ObjectType). The
number of objects found is returned in Count.
All allowed ObjectType values are described for
GetNameList function
Returns the array of coordinates for GUI element with
name in ObjectName parameter. Values are central
point X, central point Y, left, top, right, and bottom
Returns the array of all branch names, the array of
starting nodes and the array of ending nodes for those
branches
Returns the offline curve file name for the specified
well name
Returns a variant byte array of the custom data that
has been stored against the supplied KeyName string
Returns an array of the KeyNames strings for which
custom data has been stored
Returns a two-column array of Doubles for specified
branch. First column contains lower limits for mass
flowrate, liquid flowrate, water flowrate, oil flowrate
and gas flowrate. The second one contains upper
limits for the same rates.
Sets a BlackOil object to a given source. The function
returns True in case of success and False otherwise
Sets a compositional object to a source with identifier
ObjectName. Only applicable for compositional
models. The function returns True in case of success
and False otherwise
Sets the source boundary condition as defined by the
curve in file CurveFileName. The format of the file
must be that of a plot file revision C or later. One way
to generate a boundary file is using the Well
Performance Curves operation in PIPESIM. The
PIPESIM
Schlumberger
SetBoundaryFluidrate (ObjectName
As String, Fluidtype As Long, value As
Double, UnitStr As String)
SetBoundaryPressure (ObjectName
As String, value As Double, UnitStr As
String)
SetBoundaryPVTFile (ObjectName
As String, PVTFilename As String) As
Boolean
SetBoundarySourcePQPoints
(ObjectName As String, PQPoints,
fluidtype As Long, PressureUnits As
String, FlowrateUnits As String) As
Boolean
SetBoundaryTemperature
(ObjectName As String, value As
Double, UnitStr As String)
SetBoundaryType (ObjectName As
String, Type As Long, CurveOption As
Long)
SetPropertyVal (ObjectName As
String, ParentName As String,
PropName As String, value As Double,
UnitStr As String) As Boolean
SetPropertyValAtObjectIndex
(ObjectName As String, ParentName As
String, PropName As String, value As
Double, UnitStr As String,
SubObjectType As Long, Index As
Long) As Boolean
SetPropertyStringAtObjectIndex
(ObjectName As String, ParentName As
String, PropName As String, value As
String, Index As Long) As Boolean
SetPVTFile (bstrPVTFilename As
41 Open Link
object identified by ObjectName must be a
Production Well.
Sets the given value in the given units as fluidrate
boundary condition for source object ObjectName.
Fluidtype can be any of:
0 = liquid rate, 1 = gas rate, 2 = mass rate
Sets the given value in the given units as pressure
boundary condition for source object ObjectName.
Sets a PVT file to a given source. PVTFilename must
contain the full path to a PVT file
Sets a number of pressure and flowrate pairs as a
boundary condition to the referred ObjectName.
PQPoints is a 2-dimensional array of
pressure/temperature values. The object must be of
the type generic source. Number of data points
cannot exceed 30.
Sets the given value in the given units as temperature
boundary condition for source object ObjectName.
Sets the type of boundary condition for source object
ObjectName.
Type = 0 for pressure and flowrate boundary
condition
Type = 1 for curve
If the Type is curve (1) AND the source object is a
Production Well then CurveOption controls how the
wells-offline file is created or used:
CurveOption = 0 create automatically when required
CurveOption = 1 create automatically every time
engine is run
CurveOption = 2 use file (See
SetBoundaryCurveFile ())
Sets the specified property (PropName) in the
specified object (ObjectName) to the value given in
Value in the given units (UnitStr). Function returns
True if the property was set successfully, otherwise
False. ParentName is the object at the network level
and should define ObjectName in its single branch
model. Implemented PropNames: see Defined
constants and strings.
This function extends the functionality of
SetPropertyVal by allowing you to set a property to
a specified sub-component within an object. A typical
use of this is when for instance it is required to set a
gas lift flowrate (PropName) through the top (Index
= 0) gas lift injection point (SubObjectType) in the
tubing Tubing_1 (ObjectName) which is defined for
Well_1 (ParentName). For available options see
Defined constants and strings.
Similar to SetPropertyValAtObjectIndex ()
except that PropName is a string type property.
Sets the compositional file (.pvt) to be used as the
PIPESIM
Schlumberger
String)
SetSingleBranchModel
(NetObjectName As String, filename As
String) As Boolean
SetCustomData(KeyName As String,
pValue) As Boolean
SetFlowrateLimits_SI(ObjectName
as String, Limits)
INetModel Interface - Properties
BlackOilDefault As Object
CompositionDefault As Object
FlowCorrelation As Object
FluidModelType As Long
LocalFluid (ObjectName As String) As
FluidModel
ModelFileName As String
ModelBuilder As ModelBuilder
ProjectInfo As ProjectInfo
ErosionCorrosion As Object
UseNetErCorrSettings As Long
BottomKeywords As String
TopKeywords As String
AppVersion As String
INetModel Interface - Operations
ExportEngineFiles ()
KillSimulationProcess ()
OpenModel (bstrModelFileName As
String)
42 Open Link
main fluid in the simulations
Sets the underlying single branch model by way of its
associated .bps file to a network object.
Stores a variant array of byte data against a KeyName
string. This can be used to persist additional custom
data, and can later be retrieved by specifying the
KeyName
Sets flowrate limits for specified branch passing a
two-column array of Doubles. First column contains
lower limits for mass flowrate, liquid flowrate, water
flowrate, oil flowrate and gas flowrate. The second
one contains upper limits for the same rates.
Gets/sets the default BlackOil model to/from a
BlackOil object
Gets/sets the default composition to/from a
Composition object
Gets/sets the flow correlation properties to/from a
FlowCorrelation object
0: BlackOil, 1: Compositional, 2: PVT File, 3: MFL File
Gets/sets the Fluid object for the specified object
(ObjectName)
Returns the file path of the current model
Returns a ModelBuilder object - see ModelBuilder
Get the ProjectInfo object to access project specific
data
Gets/sets the ErosionCorrosion object
Gets/sets the flag value to use network erosion &
corrosion settings over local branches settings (if = 1)
or to use local settings overwise
Gets/sets the network engine keywords to be added at
bottom of tnt file
Gets/sets the network engine keywords to be added
on top of tnt file
Gets the version of PIPESIM
This function generates an ASCII file ( .tnt) and a
number of ASCII files (.pst) in the PIPESIM engine
keyword language that is used as input by the
calculation engine. This .tnt file can then be used with
PIPESIM expert mode.
Terminates the simulation process
Opens the given network model. Filename must be a
valid PIPESIM network model file (.bpn)
This function must be called first when using this
object.
PIPESIM
Schlumberger
RunNetwork (bRestart As Boolean)
RunNetwork2 (bRestart As Boolean,
EngSwitches As String)
SaveModel (bstrPathName As String)
As Boolean
ResetLocalErCorrSettings() As
Boolean
ModelBuilder object
SetNodeCoordinates (NodeName As
String, X As Long, Y As Long)
TopLeftCoordinate_X As Long
TopLeftCoordinate_Y As Long
BottomRightCoordinate_X As Long
BottomRightCoordinate_Y As Long
GetNodeCoordinates (NodeName As
String, X As Long, Y As Long)
GetLastError () As String
IBlackOil object
IBlackOil object - Properties
API As Double
ConingEnabled As Boolean
ConingGasSG As Double
ConingRateType As Long
ConingTable_SI As Variant
GasSG As Double
GLR_SI As Double
GOR_SI As Double
GOR_Type As Integer
LGR_SI As Double
OGR_SI As Double
SolutionGasCorrelation As Long
Watercut As Double
WaterSG As Double
Name As String
Comment As String
Calibration As Long
SinglePointCalib As Object
MultiPointCalib As Object
43 Open Link
Runs the currently opened model by calling the
calculation engine program as specified in the
PIPESIM installation.
If bRestart is True the simulation will load any
previously restart files (.rst files) as its initial
conditions.
Similar to RunNetwork and also accepts one or
more switches to be passed to the simulation engine.
Saves the currently opened model to a file given by
bstrPathName
Overrides all local erosion and corrosion settings with
the global ones
Sets the node coordinates for node object NodeName
to X, Y coordinates
Sets/returns the top left X coordinate of the graphical
panel. SetNodeCoordinates values are passed in
relation to TopLeftCoordinate_X and
TopLeftCoordinate_Y
As above for the Y coordinate
Returns the bottom right X coordinate of the
graphical panel (this is a read-only property)
As above for the Y coordinate
Gets the node X, Y coordinates for node object
NodeName
Returns the last error message produced by the object
API value
True/False
Coning gas specific gravity
0: liquid, 1: gas, 2: mass
A 3-column array with rate, gor/glr, wcut values, use
strict SI units
Black oil specific gravity
Gas/Liquid Ratio use strict SI units
Gas/Oil Ratio use strict SI units
(0=GLR, 1=GOR, 2=LGR, 3=OGR)
Liquid/Gas Ratio use strict SI units
Oil/Gas Ratio use strict SI units
0 = Lasater, 1 = Standing, 2 = Vazquez and Beggs, 3 =
Glaso, 4 = Kartoatmodjo
Water Cut
Water specific gravity
Name of the fluid
String containing the text in the comments field
Calibration type: 0 no calibration, 1 single point
and 2 - multipoint
Single point calibration data object
Multipoint calibration data object
PIPESIM
Schlumberger
Viscosity As Object
ThermalData As Object
Contaminants As Variant
IBlackOil object - Methods
SetBubblePointCalibration
(SatGas_SI As Double, Pressure_SI As
Double, Temperature_SI As Double)
GetBubblePointCalibration
(Pressure_SI As Double,
Temperature_SI As Double) As Double
IBlackOil object - Operations
SetBlob (sBlob As String)
ISinglePointCalib object
ISinglePointCalib object Get Methods
GetCalibrationAtBubblePoint
(Pressure_SI As Double,
Temperature_SI As Double, SatGas_SI
As Double) as Long
GetCalibrationAboveBubblePoint
(OFVF As Double, Density_SI as
Double, Compressibility_SI as Double,
Pressure_SI As Double,
Temperature_SI As Double) as Long
GetCalibrationBelowBubblePoint
(OFVF As Double, Density_SI as
Double, Pressure_SI As Double,
Temperature_SI As Double) as Long
GetLiveOilViscBelowBubblePoint
(Pressure_SI As Double,
Temperature_SI As Double,
LiveOilVisc_SI) as Long
GetGasViscBelowBubblePoint
(Pressure_SI As Double,
Temperature_SI As Double) as Double
GetGasZBelowBubblePoint (GasZ as
Double, Pressure_SI As Double,
Temperature_SI As Double) as Long
ISinglePointCalib object Set Methods
SetCalibrationAtBubblePoint
(SolGasCorr as Long, Pressure_SI As
Double, Temperature_SI As Double,
SatGas_SI As Double)
SetCalibrationAboveBubblePoint
(DensType as Long, OFVF As Double,
Density_SI as Double,
Compressibility_SI as Double,
44 Open Link
String containing the text in the comments field
String containing the text in the comments field
Array of Doubles for contaminant values in a
following order: CO2, H2S, N2, H2 and CO
Sets the bubble point data
Gets the bubble point data. Return value is a
Saturation Gas correlation : 0 for Lasater, 1 for
Standing, 2 for Vazquez and Beggs, 3 for Glaso, 4 for
Kartoatmodjo, 5 for De Ghetto at al or 6 for Petrosky-
Farshad
Sets data for the required fluid
sBlob = String containing black oil information
Function gets calibration data at bubble point. The
return value is Saturation Gas correlation: 0 for
Lasater, 1 for Standing, 2 for Vazquez and Beggs, 3 for
Glaso, 4 for Kartoatmodjo, 5 for De Ghetto et al. or 6
for Petrosky-Farshad
Function gets calibration data above bubble point.
The return value is density type: 0 for Density, 1 for
OFVF or 3 for Compressibility
Function gets calibration data below bubble point.
The return value is density type: 0 for Density or 1 for
OFVF
Function gets live oil viscosity data below bubble
point. The return value is Live Oil Viscosity
Correlation: 0 for Beggs & Robinson, 1 for Chew &
Connally, 2 for Kartoatmodjo, 3 for Khan, 4 for De
Ghetto et al., 5 for Hossain, 6 for Elsharkawyor 7 for
Petrosky-Farshad
Function gets gas viscosity data below bubble point.
The return value is gas viscosity.
Function gets gas Z data below bubble point. The
return value is gas Z correlation: 0 for Standing, 1 for
Hall Yarborough or 2 for Robinson et al.
Function sets calibration data at bubble point. The
acceptable values for Saturation Gas correlation are:
0 for Lasater, 1 for Standing, 2 for Vazquez and Beggs,
3 for Glaso, 4 for Kartoatmodjo, 5 for De Ghetto et al.
or 6 for Petrosky-Farshad
Function sets calibration data above bubble point.
The acceptable values for density type are: 0 for
Density, 1 for OFVF or 3 for Compressibility
PIPESIM
Schlumberger
Pressure_SI As Double,
Temperature_SI As Double)
SetCalibrationBelowBubblePoint
(DensType as Long, OFVF As Double,
Density_SI as Double, Pressure_SI As
Double, Temperature_SI As Double)
SetLiveOilViscBelowBubblePoint
(LiveOilCorr as Long, Pressure_SI As
Double, Temperature_SI As Double,
LiveOilVisc_SI)
SetGasViscBelowBubblePoint
(Pressure_SI As Double,
Temperature_SI As Double, GasVisc_SI
as Double)
SetGasZBelowBubblePoint
(GasZCorr as Long, GasZ as Double,
Pressure_SI As Double,
Temperature_SI As Double)
IMultiPointCalib object
IMultiPointCalib object Properties
OFVF as Boolean
IMultiPointCalib object Get Methods
GetCalibUnits (UnitsArray)
GetCorrelations (CorrArray)
GetTemperature (Value As Double,
Units as String)
GetCalibrationAtBubblePoint
(CalibData)
GetCalibrationAboveBubblePoint
(CalibData)
GetCalibrationBelowBubblePoint
(CalibData)
IMultiPointCalib object Set Methods
SetCalibUnits (UnitsArray)
45 Open Link
Function sets calibration data above bubble point.
The acceptable values for density type are: 0 for
Density or 1 for OFVF
Function sets live oil viscosity data below bubble
point. The acceptable values for Live Oil Viscosity
Correlation are: 0 for Beggs & Robinson, 1 for Chew
& Connally, 2 for Kartoatmodjo, 3 for Khan, 4 for De
Ghetto et al., 5 for Hossain, 6 for Elsharkawyor 7 for
Petrosky-Farshad
Function sets gas viscosity data below bubble point.
Function sets gas Z data below bubble point. The
acceptable values for gas Z correlation are: 0 for
Standing, 1 for Hall Yarborough or 2 for Robinson et
al.
True for Oil FVF or False for Oil Density
Function returns an array of Strings containing units
for Pressure, Solution Gas GOR, Oil Density, Oil
Viscosity and Gas Viscosity
Function returns an array of Longs containing
correlations for Solution Gas, OFVF, Oil Viscosity,
Gas Z factor and Gas Viscosity. Available values for
each correlation are the same as for
ISinglePointCalib methods
Function returns a calibration temperature and units.
Function gets calibration data at bubble point as an
array of Doubles. It contains values for Pressure,
Solution Gas, OFVF or Density, Oil Viscosity, Gas Z
factor and Gas Viscosity. All values are in units
supplied by GetCalibUnits method
Function gets calibration data above bubble point as
a two-dimensional array of Doubles. Each row
contains values for Pressure, Solution Gas, OFVF or
Density, Oil Viscosity, Gas Z factor and Gas Viscosity.
All values are in units supplied by GetCalibUnits
method
Function gets calibration data below bubble point as
a two-dimensional array of Doubles. Each row
contains values for Pressure, Solution Gas, OFVF or
Density, Oil Viscosity, Gas Z factor and Gas Viscosity.
All values are in units supplied by GetCalibUnits
method
Function sets units for Pressure, Solution Gas GOR,
Oil Density, Oil Viscosity and Gas Viscosity supplied
as an array of Strings
PIPESIM
Schlumberger
SetCorrelations (CorrArray)
SetTemperature (Value As Double
Units as String)
SetCalibrationAtBubblePoint
(CalibData)
SetCalibrationAboveBubblePoint
(CalibData)
SetCalibrationBelowBubblePoint
(CalibData)
IViscosityData object
IViscosityData object Properties
DeadOilCorr as Long
LiveOilCorr as Long
EmulViscosity as Long
UsatOilViscosity as Long
IViscosityData object Get Methods
GetDOPoints (Temp1 as Double,
Temp2 as Double, TUnits as String,
Visc1 as Double, Visc2 as Double,
VUnits as String)
GetUserViscTable_SI (Table)
46 Open Link
Function sets correlations for Solution Gas, OFVF, Oil
Viscosity, Gas Z factor and Gas Viscosity supplied as
an array of Longs. Available values for each
correlation are the same as for ISinglePointCalib
methods
Function sets a calibration temperature in specified
units.
Function sets calibration data at bubble point passed
as an array of Doubles. It must contain values for
Pressure, Solution Gas, OFVF or Density, Oil
Viscosity, Gas Z factor and Gas Viscosity. All values
are in units supplied by GetCalibUnits method
Function sets calibration data above bubble point
passed as a two-dimensional array of Doubles. Each
row must contain values for Pressure, Solution Gas,
OFVF or Density, Oil Viscosity, Gas Z factor and Gas
Viscosity. All values are in units supplied by
GetCalibUnits method
Function sets calibration data below bubble point
passed as a two-dimensional array of Doubles. Each
row must contain values for Pressure, Solution Gas,
OFVF or Density, Oil Viscosity, Gas Z factor and Gas
Viscosity. All values are in units supplied by
GetCalibUnits method
Dead Oil Viscosity correlation. Possible values are: 0
for Beggs & Robinson, 1 for Glaso, 2 for
Kartoatmodjo, 3 for De Ghetto et al., 4 for Hossain, 5
for Elsharkawy, 6 for Petrosky-Farshad, 7 for user
specified 2 points or 8 for user-supplied table
Live Oil Viscosity correlation. Possible values are: 0
for Beggs & Robinson, 1 for Chew & Connally, 2 for
Kartoatmodjo, 3 for Khan, 4 for De Ghetto et al., 5 for
Hossain, 6 for Elsharkawyor 7 for Petrosky-Farshad
Emulsion Viscosity Method. Possible values are: 0 for
continuous phase, 1 for volume ratio, 2 for Pipesim
Original Woelflin Loose Emulsion, 3 for Woelflin
Loose Emulsion, 4 for Woelflin Medium Emulsion, 5
for Woelflin Tight Emulsion, 6 for Brinkman, 7 for
Vand with Vand coefficients, 8 for Vand with Barnea
& Mizrahi coefficients, 9 for Vand with user-supplied
coefficients, 10 for Richardson, 11 for Leviton &
Leighton and 12 for user-supplied table
Undersaturated Oil Viscosity. Possible values are: 0
for Vasquez &Beggs, 1 for Kouzel, 2 for Kartoatmodjo,
3 for Khan, 4 for De Ghetto et al., 5 for Hossain, 6 for
Elsharkawy, 7 for Bergman & Sutton, 8 for Petrosky-
Farshad or 9 for none
Function returns temperature and viscosity values for
Dead Oil for user-specified 2-point Dead Oil Viscosity
Correlation
Function returns a two-column array of Doubles
PIPESIM
Schlumberger
GetUserEmulTable_SI (Type as
Long, Table)
GetWCutCutoff (Method as Long,
WCut As Double, Units as String)
GetEmulCoeffs (Method as Long,
Coeff1 as Double, Coeff2 as Double)
GetKouzelCoeffs (ParA as Double,
ParB as Double)
IViscosityData object Set Methods
SetDOPoints (Temp1 as Double,
Temp2 as Double, TUnits as String,
Visc1 as Double, Visc2 as Double,
VUnits as String)
SetUserViscTable_SI (Table)
SetUserEmulTable_SI (Type as Long,
Table)
SetWCutCutoff (Method as Long,
WCut As Double, Units as String)
SetEmulCoeffs (Method as Long,
Coeff1 as Double, Coeff2 as Double)
SetKouzelCoeffs (ParA as Double,
ParB as Double)
IThermal object
IThermal object Get Methods
GetConductivity (Values, Units as
String)
GetEnthropy (Values, Units as String)
ISinglePointCalib object Set Methods
SetConductivity (Values, Units as
String)
SetEnthropy (Values, Units as String)
47 Open Link
containing values for Temperature and Viscosity for
user-supplied table Dead Oil Viscosity Correlation
Function returns a three-column array of Doubles
containing values for Temperature, Viscosity Ratio
and Viscosity for user-supplied table Emulsion
Viscosity. Type equals 0 for Temperature-Viscosity
Ratio table or 1 for Temperature-Viscosity table.
Function returns a watercut cutoff method (0 for
user-defined or 1for Brauner & Ullman) and a cutoff
value and units .
Function returns a emulsion viscosity method and
user-supplied coefficients if applicable. Method
equals 9 for Vand with user-supplied coefficients, 10
for Richardson or -1 for all other chosen methods.
Function returns Kouzel coefficients for
Undersaturated Oil Viscosity
Function sets temperature and viscosity values for
Dead Oil for user-specified 2-point Dead Oil Viscosity
Correlation
Function sets a user-supplied table for Dead Oil
Viscosity Correlation passing a two-column array of
Doubles containing values for Temperature and
Viscosity.
Function sets a user-supplied table for Emulsion
Viscosity passing a three-column array of Doubles
containing values for Temperature, Viscosity Ratio
and Viscosity for. Type equals 0 for Temperature-
Viscosity Ratio table or 1 for Temperature-Viscosity
table.
Function sets a watercut cutoff method (0 for user-
defined or 1for Brauner & Ullman) and a cutoff value
in specified units.
Function sets user-supplied coefficients for
corresponding emulsion viscosity method. Method
must be 9 for Vand with user-supplied coefficients or
10 for Richardson.
Function sets Kouzel coefficients for Undersaturated
Oil Viscosity
Function returns an array of 3 Doubles containing
Gas, Oil and Water thermal conductivity values and a
units string
Function returns an array of 3 Doubles containing
Gas, Oil and Water heat capacity values and a units
string
Function sets values for Gas, Oil and Water thermal
conductivities passed as an array of 3 Doubles in
specified units
Function sets values for Gas, Oil and Water heat
capacities passed as an array of 3 Doubles in
specified units
PIPESIM
Schlumberger
ICompositional object
ICompositional object - Properties
Name As String
ICompositional object - Get Methods
GetComment () As String
GetPackage () As Boolean
GetPackageType () As Long
GetComponentList
GetComponentList (pVart, pVar, pVar2,
HydComp1 As Long, AquComp1 As
Long) As Long
GetLibraryComptBP (pVar)
GetLibraryComptMW (pVar)
GetLibraryComptOM (pVar)
GetLibraryComptPC (pVar)
GetLibraryComptSG (pVar)
GetLibraryComptTC (pVar)
GetLibraryList (pVar) As Long
GetMolarList (pVar) As Long
GetMolWeightList (pVar) As Long
48 Open Link
Name of the fluid
Returns a string containing the text in the comments
field
Returns the compositional package description, 0 =
Multiflash and 1 = SIEPs SPPTS
Returns the Compositional Package Type to use as
long integer according to the following formula:
0 = SIS Flash, 1 = Multiflash, 2 = SPPTS.
Returns the current component names list.
pVar = list of component names as an array of strings
pVar2 = list of hydrocarbon names as an array of
strings
pVar3 = list of aqueous names as an array of strings
AquComp1 = number of aqueous components
HydComp1 = number of aqueous components.
Returns total number of components
Returns the boiling points of the library components
set by SetLibraryComptCalculator.
pVar = list of boiling points as an array of doubles.
Returns the molecular weight of the library
components set by SetLibraryComptCalculator.
pVar = list of molecular weights as an array of
doubles.
Returns the acentric factors of the library
components set by SetLibraryComptCalculator.
pVar = list of acentric factors as an array of doubles.
Returns the critical pressures of the library
components set by SetLibraryComptCalculator.
pVar = list of critical pressures as an array of doubles.
Returns the specific gravities of the library
components set by SetLibraryComptCalculator.
pVar = list of specific gravities as an array of doubles.
Returns the critical temperatures of the library
components set by SetLibraryComptCalculator.
pVar = list of critical temperatures as an array of
doubles.
pVar = list of component descriptors as an array of
Booleans with the values corresponding to the
component names returned from
GetComponentList.
True = normal component
False = user defined (petroleum fraction) component.
Return value is a size of the array.
pVar = list of molar flow rates as an array of Doubles
with the values corresponding to the component
names returned from GetComponentList.
Return value is a size of the array.
pVar = list of molecular weights as an array of
doubles with the values corresponding to the
component names returned from
GetComponentList.
Return value is a size of the array.
PIPESIM
Schlumberger
GetBoilingPointList (pVar) As Long
GetSpecificGravityList (pVar) As
Long
GetCriticalPressureList (pVar) As
Long
GetCriticalTemperatureList (pVar)
As Long
GetAcentricFactorList (pVar) As
Long
ICompositional object - Set Methods
SetComment (sComment As String)
SetPackage (sPackage As Boolean)
SetPackageType (lPackageType As
Long)
SetComponentList (pVar, CompNum
As Long, pVar2, CompNum2 As Long)
SetMolarList (pVar, CompNum As
Long)
SetLibraryList (pVar, CompNum As
Long)
1
Before any set methods are called in Icompositional Interface CreateNewComposition must be called
2
After all the set methods are called from Icompositional Interface UpdateComposition must be called
PIPESIM
49 Open Link
pVar = list of boiling points as an array of doubles
with the values corresponding to the component
names returned from GetComponentList.
Return value is a size of the array.
pVar = list of specific gravities as an array of doubles
with the values corresponding to the component
names returned from GetComponentList.
Return value is a size of the array.
pVar = list of critical pressures as an array of doubles
with the values corresponding to the component
names returned from GetComponentList.
Return value is a size of the array
pVar = list of critical temperatures as an array of
doubles with the values corresponding to the
component names returned from
GetComponentList.
Return value is a size of the array.
pVar = list of acentric factors as an array of doubles
with the values corresponding to the component
names returned from GetComponentList.
Return value is a size of the array.
Sets a string in the comments field of the
compositional description 1 .
Sets the compositional package description, False =
Multiflash and true = SIEPs SPPTS.
Sets the Compositional Package Type to use. The
following values of lPackageType will set the package
as described:
0 = SIS Flash, 1 = Multiflash, 2 = SPPTS
Sets the component names list.
pVar = list of hydrocarbon names as an array of
strings
pVar2 = list of aqueous names as an array of strings
CompNum = number of hydrocarbon components
CompNum2 = number of aqueous components 2 .
pVar = list of molar flow rates as an array of doubles
with the values corresponding to the component
names set in SetComponentList ensuring that the
molar flow rates of the aqueous components come
after the molar flow rates of the hydrocarbon
components.
CompNum = total number of components
pVar = list of component descriptions as an array of
bools with the values corresponding to the
component names set in SetComponentList
ensuring that the component descriptions of the
aqueous components come after the component
descriptions of the hydrocarbon components.
CompNum = total number of components
Schlumberger
SetLibraryComptCalculator (pVar,
CompNum As Long)
SetMolwtList (pVar, CompNum As
Long)
SetPvtFile SetPvtFile (sFile As
String)
SetBoilingPointList (pVar, CompNum
As Long)
SetSpecificGravityList (pVar,
CompNum As Long)
SetCriticalPressureList (pVar,
CompNum As Long)
SetCriticalTemperatureList (pVar,
CompNum As Long)
SetAcentricFactorList (pVar,
CompNum As Long)
ICompositional object - Operations
CreateNewComposition ()
50 Open Link
pVar = list of library component names ONLY as an
array of strings.
CompNum = number of components within the above
list.
SetLibraryComptCalculator sets the library
component names within the compositional module
and calculates the component parameters.
pVar = list of molecular weights as an array of
doubles with the values corresponding to the
component names set in SetComponentList
ensuring that the molecular weights of the aqueous
components come after the molecular weights of the
hydrocarbon components.
CompNum = total number of components.
Calls the compositional pvt file reader to read the
inputted pvt file.
pVar = list of boiling points as an array of doubles
with the values corresponding to the component
names set in SetComponentList ensuring that the
boiling points of the aqueous components come after
the boiling points of the hydrocarbon components.
CompNum = total number of components
pVar = list of specific gravities as an array of doubles
with the values corresponding to the component
names set in SetComponentList ensuring that the
specific gravities of the aqueous components come
after the specific gravities of the hydrocarbon
components.
CompNum = total number of components
pVar = list of critical pressures as an array of doubles
with the values corresponding to the component
names set in SetComponentList ensuring that the
critical pressures of the aqueous components come
after the critical pressures of the hydrocarbon
components.
CompNum = total number of components
pVar = list of critical temperatures as an array of
doubles with the values corresponding to the
component names set in SetComponentList
ensuring that the critical temperatures of the aqueous
components come after the critical temperatures of
the hydrocarbon components.
CompNum = total number of components.
pVar = list of acentric factors as an array of doubles
with the values corresponding to the component
names set in SetComponentList ensuring that the
acentric factors of the aqueous components come
after the acentric factors of the hydrocarbon
components.
CompNum = total number of components
Blanks all compositional arrays and parameters in
memory
PIPESIM
Schlumberger
UpdateComposition ()
SetBlob (sBlob As String)
FlowCorrelations Interface
CIFlowCorrelation object - Get Methods
GetHorizontalCorrelationName ()
As String
GetHorizontalSourceName () As
String
GetVerticalCorrelationName () As
String
GetVerticalSourceName () As String
GetSensitivityItems (VerticalCorrs
As Boolean, Items) As Long
CIFlowCorrelation object - Set Methods
SetHorizontalCorrelation (sSource
As String, sCorrelation As String)
SetHorizUserCorrelation (sSource
As String, sCorrelation As String)
SetVerticalCorrelation (sSource As
String, sCorrelation As String)
SetVertUserCorrelation (sSource As
String, sCorrelation As String)
CIFlowCorrelation object - Properties
SwapAngle As Double
HorizontalFrictionFactor As Double
VerticalFrictionFactor As Double
VerticalHoldup As Double
HorizontalHoldup As Double
SinglePhaseCorrelation As String
Note: See the PIPESIM help for the complete list of available vertical and horizontal flow
correlations and sources.
CIFlowCorrelation object - Operations
DisplayDialog ()
DisplayDialog2 () As Boolean
3
The compositional data is provided by the call to the Ipnscom Interface
51 Open Link
Updates all compositional arrays and parameters in
memory
Sets data for the required composition
sBlob = String containing compositional information 3 .
Returns the horizontal correlation name. The
returned string is a unique keyword name.
Returns the correlations source name (such as bja,
tulsa)
Returns the vertical correlation name. The returned
string is a unique keyword name (for example
ANSAR, BJA, BBR, BBOTD)
Returns the correlations source name (such as bja,
tulsa)
Returns the 4-column array (help string, engine code,
main code and quantity class) of available sensitivity
variables in Items for Vertical (if VerticalCorrs is
True) or Horizontal (VerticalCorrs is False). Number
of items is a functions return value
Set a horizontal correlation. For example, for the
Tulsa correlation source it can be any of: BBO,
BBOTD, BBR, BBRTD, BJA, DKAGAD, DKAGAF, DR,
DRTD, LOCKMAR, LOCKMARTD, MB, NOSLIP,
OLIEMANS, XIAO.
sSource can be BJA, TULSA
Set a horizontal user correlation
Set a vertical source and correlation. For example for
the Tulsa correlation source it can be any of: TBB,
TDR, TGA, THB, TMB, TORK
Set a vertical user correlation
Vertical-Horizontal Correlation Swap Angle
Horizontal Friction Factor
Vertical Friction Factor
Vertical Holdup
Horizontal Holdup
Any of: Moody, AGA, Pan-A, Pan-B, HazWill,
Weymouth, CULSMITH
Displays PIPESIM dialog for flow correlation (this
method is obsolete, use DisplayDialog2 instead).
Displays PIPESIM dialog for flow correlation ().
Return value is True if data is changed and False
otherwise
PIPESIM
Schlumberger 52 Open Link

Single Branch Operations

Single Branch operations in PIPESIM are defined as ActiveX interfaces that can be accessed from
any model. Systems Analysis, Pressure and Temperature Profiles and Flow Correlation Matching
are housed in PSOpSystems.DLL and its ActiveX interfaces are: ISystemsAnalysis, IIPTProfile
and IICorrMatching respectively. A Nodal Analysis operation interface resides in NodalOp.DLL
and can be created by defining an object of the type IINodalAnal.
The operations ActiveX interface already defined in a single branch PIPESIM model is accessed
by calling the GetOperationInterface function for an ISingleBranchModel object. The argument
returned after a call to this function will be a COM interface of the type corresponding to the
selected operation in the PIPESIM model. A call to GetOperationType () will returned the
selected operation. See (Single Branch Operations) for a list of operation IDs. Similarly, any
operation interface can be set to the model by calling SetOperationInterface () and
SetOperationType ().
Systems Analysis
ISystemsAnalysis Object - Properties
BoundaryConds As IBoundaryProps Get/set property to access boundary conditions. See
the definition of IBoundaryProps Interface for its
methods and properties
Engine As IEngineOptions Gets the IEngineOptions object to set simulation
parameters and run the operation. See
IEngineOptions Interface for its methods and
properties
FixedInjectionDepths As Boolean Applicable to gas lifted systems, this property
sets/gets whether gas lift valves are installed in the
tubing
PermuteSensVars As Boolean Sets/gets whether the sensitivity values for the
different variables are permuted against each other or
changed in step.
MaxSensitivityVars As Long Gets the max available number of the sensitivity
variables allowed for the operation
SensitivityObject (indx As Long) As indx: the sensitivity box indx. Pass 1 for the X-axis
String variable, 0,1,2,, (MaxSensitivityVars -1) for the
corresponding sensitivity.
Returns the sensitivity object name for the specified
index.
SensitivityVariable (indx As Long) As indx: the sensitivity box indx. Pass 1 for the X-axis
String variable, 0,1,2,, (MaxSensitivityVars -1) for the
corresponding sensitivity.
Returns the sensitivity variable name for the specified
index
ISystemsAnalysis Object - Get Methods
GetIsUnset () As Boolean Returns True if the operations data is all blank
(unset)
GetLastError () As String Returns an error description after function call
failure. Must be called immediately after the call to
the failed function.

PIPESIM
Schlumberger
GetSensitivityData_SI (indx As Long,
ObjectStr As String, VarStr As String,
Values_SI, QuantClass As String)
ISystemsAnalysis Object - Set Methods
SetSensitivityData (indx As Long,
ObjectStr As String, VarStr As String,
Values_DefEng, vbActive As Boolean)
SetSensitivityData_SI (indx As Long,
ObjectStr As String, VarStr As String,
Values_SI, vbActive As Boolean,
QuantClass As String)
SetLanguage (nlLanguageID As Long)
As Boolean
ISystemsAnalysis Object - Operations
WriteOperationFile () As Boolean
DisplayDialog (p_VarUnitManager,
CloseOK As Boolean)
53 Open Link
Returns the sensitivity data specified for the
operation.
Indx: the sensitivity box indx. Pass 1 for the X-axis
variable, 0,1,2, , (MaxSensitivityVars -1) for the
corresponding sensitivity.
ObjectStr: the object name is returned here
VarStr: the sensitivity variable name is returned here
Values_SI: an array of double values in strict SI units
containing the list of sensitivity values
QuantClass: the unit class name for the selected
sensitivity variable. See Unit System for a list of unit
classes
Sets the sensitivity information.
Indx: the sensitivity box indx. Pass 1 for the X axis
variable, 0,1,2, , (MaxSensitivityVars -1) for the
corresponding sensitivity.
ObjectStr: the object name
VarStr: the sensitivity variable name
Values_DefEng: an array of double values in default
engineering units containing the list of sensitivity
values
vbActive: sets the sensitivity group active (True) or
inactive (False)
Similar to SetSensitivityData, but uses strict SI
units
indx: the sensitivity box indx. Pass 1 for the X axis
variable, 0,1,2, , (MaxSensitivityVars -1) for the
corresponding sensitivity.
ObjectStr: the object name
VarStr: the sensitivity variable name
Values_DefEng: an array of double values in default
engineering units containing the list of sensitivity
values
vbActive: sets the sensitivity group active (True) or
inactive (False)
QuantClass: measurement string (for example
temperature, pressure etc.)
Sets the user interface language
Available values for nlLanguageID are:
0x0809 English (UK)
0x0419 Russian
0x080A Spanish (Mexican)
0x0416 Portuguese (Brazilian)
0x0804 Chinese (PRC)
Function returns True if language was changed
successfully and False otherwise
Writes an ASCII file (modelname.inc) containing the
instructions to the simulation engine to run the
operation.
Displays the operations graphical interface. Pass a
Null variant as the first argument. Returns True if
dialog box was closed OK, otherwise False.
PIPESIM
Schlumberger
Pressure and Temperature Profiles
IPTProfile Object - Properties
BoundaryConds As IBoundaryProps
Engine As IEngineOptions
FixedInjectionDepths As Boolean
EnableSurveyOpts As Boolean
ProfileType As Long
SensitivityObject (indx As Long) As
String
SensitivityVariable (indx As Long) As
String
IPTProfile Object - Get Methods
GetIsUnset () As Boolean
GetLastError () As String
GetSensitivityData_SI (ObjectStr As
String, VarStr As String, Values_SI,
QuantClass As String)
IPTProfile Object - Set Methods
SetSensitivityData (ObjectStr As
String, VarStr As String,
Values_DefEng)
54 Open Link
Get/set property to access boundary conditions. See
the definition of IBoundaryProps for its methods and
properties
Gets the IEngineOptions object to set simulation
parameters and run the operation. See
IEngineOptions for its methods and properties
Applicable to gas lifted systems, this property
sets/gets whether gas lift valves are installed in the
tubing
Gets/sets whether survey data is used for profile
plotting
The default profile to be plotted initially with PSPlot:
0: Elevation vs. Pressure
1: Elevation vs. Temperature
2: Pressure vs. Total Distance
3: Temperature vs. Total Distance
indx: the sensitivity box indx. Pass 1 for the X-axis
variable, 0,1,2, , (MaxSensitivityVars -1) for the
corresponding sensitivity.
Returns the sensitivity object name for the specified
index.
indx: the sensitivity box indx. Pass 1 for the X-axis
variable, 0,1,2, , (MaxSensitivityVars -1) for the
corresponding sensitivity.
Returns the sensitivity object name for the specified
index.
Returns true if the operations data is all blank (unset)
Returns an error description after function call
failure. Must be called immediately after the call to
the failed function.
Returns the sensitivity data specified for the
operation.
ObjectStr: the object name is returned here
VarStr: the sensitivity variable name is returned here
Values_SI: an array of double values in strict SI units
containing the list of sensitivity values
QuantClass: the unit class name for the selected
sensitivity variable. See Units Library for a list of unit
classes.
Sets the sensitivity information.
ObjectStr: the object name
VarStr: the sensitivity variable name
Values_DefEng: an array of double values in default
engineering units containing the list of sensitivity
values
PIPESIM
Schlumberger
SetSensitivityData_SI (ObjectStr As
String, VarStr As String, Values_SI,
QuantClass As String)
SetSurveyData_SI (SurveyName As
String, SurveyDate As Date,
Var_MD_Pres_Temp)
SetLanguage (nlLanguageID As Long)
As Boolean
IPTProfile Object - Operations
WriteOperationFile () As Boolean
DisplayDialog (p_VarUnitManager,
CloseOK As Boolean)
Flow Correlation Matching
ICorrMatching object - Properties
BoundaryConds As IBoundaryProps
Engine As IEngineOptions
EnableSurveyOpts As Boolean
ProfileType As Long
ICorrMatching object - Get Methods
GetIsUnset () As Boolean
GetLastError () As String
55 Open Link
Same as SetSensitivityData method, but for strict SI
units
ObjectStr: the object name
VarStr: the sensitivity variable name
Values_SI: an array of double values in strict SI units
containing the list of sensitivity values
QuantClass: the unit class name for the selected
sensitivity variable. See Units Library for a list of unit
classes.
Associates field data to the operation. This data
pressure and/or temperature profiles is then plotted
along with the calculated data.
SurveyName: an arbitrary given name (such as the
well name)
SurveyDate: the survey date
Var_MD_Pres_Temp: a three-column matrix
containing measured depths, pressure and
temperature values, in that order. Units in strict SI.
Sets the user interface language
Available values for nlLanguageID are:
0x0809 English (UK)
0x0419 Russian
0x080A Spanish (Mexican)
0x0416 Portuguese (Brazilian)
0x0804 Chinese (PRC)
Function returns True if language was changed
successfully and False otherwise
Writes an ASCII file (modelname.inc) containing the
instructions to the simulation engine to run the
operation.
Displays the operations graphical interface. Pass a
Null variant as the first argument. Returns True if
dialog box was closed OK, otherwise False.
Get/set property to access boundary conditions. See
IBoundaryProps Interface for its methods and
properties
Gets the IEngineOptions object to set simulation
parameters and run the operation. See
IEngineOptions Interface for its methods and
properties
Gets/sets whether survey data is used for profile
plotting
The default profile to be plotted initially with PSPlot:
0: Elevation vs. Pressure
1: Elevation vs. Temperature
2: Pressure vs. Total Distance
3: Temperature vs. Total Distance
Returns true if the operations data is all blank (unset)
Returns an error description after function call
failure. Must be called immediately after the call to
the failed function.
PIPESIM
Schlumberger
GetSelectedCorrelation
(IsVertical As Boolean, EngineCodes)
ICorrMatching object - Set Methods
SetSurveyData_SI (SurveyName As
String, SurveyDate As Date,
Var_MD_Pres_Temp)
SetSelectedCorrelation (helpStr As
String, engineCode As String, mainCode
As String, IsVertical As Boolean,
IsSelected As Boolean)
SetLanguage (nlLanguageID As Long)
As Boolean
ICorrMatching object - Operations
WriteOperationFile () As Boolean
DisplayDialog (p_VarUnitManager,
CloseOK As Boolean)
Nodal Analysis
INodalAnal Object - Properties
CFactor As Double
EngineSwitch As String
FetkovichExp As Double
FixedInjectionDepths As Boolean
FutureAOFP As Double
FutureIPR As Boolean
IncludeFilePath As String
InflowCurveRangeLimit As Boolean
InflowObject As String
InflowVariable As String
MaxPressureForOutflow_SI As
Double
MaxRate_SI As Double
MaxRateFluidType As Long
56 Open Link
Function returns in EngineCodes the array of string
for chosen vertical flow correlations if IsVertical is
True and for horizontal correlations if IsVertical is
False
Associates field data to the operation. This data,
pressure and/or temperature profiles is then plotted
along with the calculated data.
SurveyName: an arbitrary given name (such as the
well name)
SurveyDate: the survey date
Var_MD_Pres_Temp: a three-column matrix
containing measured depths, pressure and
temperature values, in that order. Units in strict SI
Set or removes selection for the correlation specified
by engineCode depending on IsSelected value
IsVertical = True for vertical correlations, False for
horizontal.
Sets the user interface language
Available values for nlLanguageID are:
0x0809 English (UK)
0x0419 Russian
0x080A Spanish (Mexican)
0x0416 Portuguese (Brazilian)
0x0804 Chinese (PRC)
Function returns True if language was changed
successfully and False otherwise
Writes an ASCII file (modelname.inc) containing the
instructions to the simulation engine to run the
operation.
Displays the operations graphical interface. Pass a
Null variant as the first argument. Returns True if
dialog box was closed OK, otherwise False.
Sets a Constant C value
Sets/gets extra command line arguments for the
PIPESIM engine
Sets a Fetkovich n exponent value
Applicable to gas lifted systems, this property
sets/gets whether gas lift valves are installed in the
tubing
Sets a future AOFP value
Sets a flag whether to use Future IPR option (True
by default)
The full path name to the engines operation file
Allow the inflow curves to extend to the AOFP (true)
Returns/sets the inflow object name
Returns/sets the inflow variable name
Maximum pressure for the outflow curves
The maximum fluidrate in strict SI units
The maximum fluid rate type: 0: liquid, 1: gas, 2 mass
PIPESIM
Schlumberger
NumberInflowPoints As Long
NumberOutflowPoints As Long
OutflowCurveRangeLimit As Boolean
OutflowObject As String
OutflowVariable As String
OutletPressure_SI As Double
PipesimEnginePath As String
PlotToolPath As String
PsmFilePath As String
ReservoirPressure As Double
RunEngineMinimised As Long
RunPlotToolWithEngine As Long
INodalAnal Object - Get Methods
GetIsEngineActive (p_bActive As
Long)
GetIsUnset GetIsUnset (pVar As Long)
GetLastError (errorStr As String)
GetSensitivityData_SI (InflowOutflow
As Long, ObjectStr As String, VarStr As
String, Values_SI, QuantClass As String)
INodalAnal Object - Set Methods
SetSensitivityData_SI
(InflowOutflow As Long, ObjectStr As
String, VarStr As String, Values_SI,
QuantClass As String)
SetLanguage (nlLanguageID As Long)
As Boolean
INodalAnal Object - Operations
KillOperation ()
RunOperation ()
PIPESIM
57 Open Link
The number of points on each inflow curve
The number of points on each outflow curve
Allow the outflow curves to extend to the supplied
maximum flowrate
Returns/sets the outflow object name
Returns/sets the outflow variable name
Gets/sets the outlet pressure in strict SI units
The full path to the PIPESIM engine
The full path to the plotting tool (PSPlot)
The full path to the model file (.psm file)
Set a reservoir pressure. Used for future AOFP
calculations
Runs the engine in a minimised window
If True (1) shows the plotting tool (PSPlot) as the
simulation runs
Returns True (1) if the PIPESIM engine is running,
otherwise False (0)
Returns True (1) if the operations data is all blank
(unset)
Returns an error description after function call
failure. Must be called immediately after the call to
the failed function.
Returns the sensitivity data specified for the
operation.
InflowOutflow: 0: inflow data, 1 outflow data
ObjectStr: the object name is returned here
VarStr: the sensitivity variable name is returned here
Values_SI: an array of double values in strict SI units
containing the list of sensitivity values
QuantClass: the unit class name for the selected
sensitivity variable. See Unit System.
Sets the sensitivity data specified for the operation.
InflowOutflow: 0: inflow data, 1 outflow data
ObjectStr: the object name
VarStr: the sensitivity variable name
Values_SI: an array of double values in strict SI units
containing the list of sensitivity values
QuantClass: the unit class name for the selected
sensitivity variable. See Unit System.
Sets the user interface language
Available values for nlLanguageID are:
0x0809 English (UK)
0x0419 Russian
0x080A Spanish (Mexican)
0x0416 Portuguese (Brazilian)
0x0804 Chinese (PRC)
Function returns True if language was changed
successfully and False otherwise
Terminates the engine run
Runs the simulation
Schlumberger
WriteOperationFile (bOK As Boolean)
DisplayDialog (p_VarUnitManager)
DisplayDialog2 (p_VarUnitManager,
bCloseOK As Boolean)
Wax Deposition
IWaxOp Object - Properties
RunEngineMinimised As Boolean
RunPlotToolWithEngine As Boolean
PsmFilePath As String
PlotToolPath As String
IncludeFilePath As String
PipesimEnginePath As String
EngineSwitch As String
WaxProperties As Variant
IWaxOp Object - Get Methods
GetLastError() As String
GetIsUnset() As Boolean
GetIsEngineActive() As Boolean
IWaxOp Object - Set Methods
SetLanguage(nlLanguageID As Long)
As Boolean
IWaxOp Object - Operations
DisplayDialog(p_VarUnitManager As
Variant)
DisplayDialog2(p_VarUnitManager As
Variant) As Boolean
RunOperation();
KillOperation();
WriteOperationFile() As Boolean
IWaxOp2 Object - Properties
WaxMethod As Integer
58 Open Link
Writes an ASCII file containing the instructions to
the simulation engine to run the operation.
Displays the operations graphical interface. Pass a
NULL variant as the first argument.
This method is obsolete. Use DisplayDialog2
method instead
Displays the operations graphical interface. Pass a
Null variant as the first argument. Returns true if
dialog box was closed OK, otherwise false.
Runs the engine in a minimised window
If True (1) shows the plotting tool (PSPlot) as the
simulation runs
The full path to the model file (.psm file)
The full path to the plotting tool (PSPlot)
The full path name to the engines operation file
The full path to the PIPESIM engine
Sets/gets extra command line arguments for the
PIPESIM engine
Returns an error description after function call
failure. Must be called immediately after the call to
the failed function.
Returns True (1) if the operations data is all blank
(unset)
Returns True (1) if the PIPESIM engine is running,
otherwise False (0)
Sets the user interface language
Available values for nlLanguageID are:
0x0809 English (UK)
0x0419 Russian
0x080A Spanish (Mexican)
0x0416 Portuguese (Brazilian)
0x0804 Chinese (PRC)
Function returns True if language was changed
successfully and False otherwise
Displays the operations graphical interface. Pass a
NULL variant as the first argument.
This method is obsolete. Use DisplayDialog2
method instead
Displays the operations graphical interface. Pass a
Null variant as the first argument. Returns true if
dialog box was closed OK, otherwise false.
Runs the simulation
Terminates the engine run
Writes an ASCII file containing the instructions to the
simulation engine to run the operation.
WaxMethod can be one of the following values:
0: Shell;
PIPESIM
Schlumberger 59 Open Link

1: BP;
2: Schlumberger DBR;
3: None
IWaxOp3 Object - Properties
ModelIsInjectionWell As Boolean True if the model is an injection well, Flase otherwise
Single Branch Operations: Supporting Interfaces
IBoundaryProps Interface
IBoundaryProps - Properties
OutletPressure_SI As Double Gets/sets the outlet pressure in strict SI units
InletPressure_SI As Double Gets/sets the inlet pressure in strict SI units
FluidRate_SI As Double Gets/sets the fluid rate in strict SI units
CalculatedVariable As Long Gets/sets the calculated variable:
0: Outlet Pressure
1: Inlet Pressure,
2: FluidRate
FluidType As Long Gets/sets the fluidrate type:
0: liquid
1: gas
2: mass
IEngineOptions Interface
IEngineOptions - Properties
EngineSwitch As String Sets/gets extra command line arguments for the
PIPESIM engine
IncludeFilePath As String The full path name to the engines operation file
PipesimEnginePath As String The full path to the PIPESIM engine
PlotToolPath As String The full path to the plotting tool (PSPlot)
PsmFilePath As String The full path to the model file (.psm file)
RunEngineMinimised As Boolean Runs the engine in a minimised window
RunPlotToolWithEngine As Boolean If True shows the plotting tool (PSPlot) as the
simulation runs
IEngineOptions - Get Methods
GetIsEngineActive () As Boolean Returns True if the PIPESIM engine is running,
otherwise False
IEngineOptions - Operations
KillOperation () Terminates the engine run
RunOperation () Runs the simulation
Gas Lift Diagnostics COM Object
Name
The name of the COM is GLDIAGN.DLL
Supported Interfaces
GLWell interface: to model and perform diagnostics on a gas lift injected well
Dependency MAP
List of Dependencies: WELLCURVE.DLL, MFC42.DLL
GLWell Interface and Object
The GetArrayXXX functions return a one-dimensional array. The number of components in the
array is equal to the number of valves defined in the well (see the 'AddGasLiftValve5' method). The
first component in the array (index = 0) corresponds to the top valve.
GLWell Object - Get Methods
GetArrayEqCurvePressure(pVar) Returns in pVar an array of Doubles with the
equilibrium curve pressure at each valve depth
GetArrayGasRate(pVar) Returns in pVar an array of Doubles with the

PIPESIM
Schlumberger 60
GetArrayInjectionPressure(pVar)
GetArrayInjectionTemperature(pVar)
GetArrayMaxGasRate(pVar)
GetArrayProductionPressure(pVar)
GetArrayProductionTemperature(pVar)
GetArrayValveClosePressure(pVar)
GetArrayValveOpenPressure(pVar)
GetArrayValveStatus(pVar)
GetEquilibriumCurve(pVar)
GetLastError(sLastError As String)
GetProductionPressureCurve(pVar, type
As Long)
GetProductionTemperatureCurve (pVar,
type As Long)
GLWell Object - Set Methods
AddCalculatedPressureProfile (type As
Long, pVar, pressUnits As String, lenUnits As
String)
AddCalculateTempProfile (type As Long,
pVar, tempUnits As String, lenUnits As
String)
PIPESIM
Open Link
actual throughputs for each valve. Uses
Thornhill & Craver equation
Returns in pVar an array of Doubles with the
injection pressure at each valve depth
Returns in pVar an array of Doubles with the
injection temperature at each valve depth
Returns in pVar an array of Doubles with the
maximum throughputs for each valve. Uses
Thornhill & Craver equation
Returns in pVar an array of Doubles with the
production pressure at each valve depth
Returns in pVar an array of Doubles with the
production temperature at each valve depth
Returns in pVar an array of Doubles with closing
pressures for each valve
Returns in pVar an array of Doubles with
opening pressures for each valve
Returns in pVar an array of Strings with the
valve status: such as Throttling, Fully Open.
Returns in pVar a 2-dimensional array of
Doubles with {injection TVD, equilibrium
pressure} pairs in [ft, psia]. The number of data
points is variable and match the results from the
plot file.
Returns the last error message produced by
GLD.
Returns in pVar a 2-dimensional array of
Doubles with {pressure, depth} pairs in [psia, ft].
The number of data points is variable and match
the results from the plot file.
Type: if 0 depth values are MD, if 1 depth values
are TVD
Returns in pVar a 2-dimensional array of
doubles with {temperature, depth} pairs in [F, ft].
The number of data points is variable and match
the results from the plot file.
Type: if 0 depth values are MD, if 1 depth values
are TVD
Type: 0 = MD; 1 = TVD
pVar: a two dimensional array containing
Doubles {depth, pressure}
pressUnits: pressure units for the values in the
arrays
lenUnits: units for the depth values in the array.
Any of ft miles, m, km
This method can be used when the profile type
is 'Simulate' to enter an existing simulated
profile. Use in conjunction with the property
CalculatePressureProfileOnDisplay to
control the execution of PIPESIM.
Type: 0 = MD; 1 = TVD
pVar: a two dimensional array containing
Doubles {depth, temperature} tempUnits:
temperature units for the values in the arrays
lenUnits: units for the depth values in the array.
Schlumberger
AddDeviationSurvey (pVar, TVDUnits As
String, MDUnits As String)
AddEquilibriumCurve (pVar, pressUnits
As String, lenUnits As String)
AddGasLiftValve5 (type As Long, depth As
Double, Ptro As Double, ptroUnits As String,
Ap As Double, ApAb As Double, PortSize As
Double, NomOD As Double, desc As String,
Cd As Double, dpfo As Double)
AddPressureSurvey (type As Long, pVar,
pressUnits As String, lenUnits As String)
AddTemperatureSurvey (type As Long,
pVar, tempUnits As String, lenUnits As
String)
SetApi
(api As Double)
PIPESIM
61 Open Link
Any of ft miles, m, km. This method can be to
enter an existing simulated temperature profile.
If not supplied the temperature profile will be
calculated internally by the Diagnostics module.
Required if ProfileMode property is set to User
Survey AND Pressure Survey type is MD
pVar: a two dimensional array containing
Doubles {TVD, MD}
TVDUnits: units for the TVD values in the array.
Any of ft, miles, m, km
MDUnits: units for the MD values in the array.
Any of ft, miles, m, km
pVar: a two dimensional array containing
Doubles {depth, pressure}
pressUnits: pressure units for the values in the
arrays
lenUnits: units for the depth values in the array.
Any of ft, miles, m, km
This method can be used to enter an existing
equilibrium curve. Use in conjunction with the
property CalculateEqCurveOnDisplay to
control the execution of PIPESIM.
Type: valve type Any of:
0 = IPO, 1 = PPO, 2 = IPS, 3 = PPS, 4 = Orifice, 5
= Dummy
depth [ft]: valve depth
ptro: test rack pressure
ptrUnits: test rack pressure units
Ap[in2]: port area
ApAb: port area/bellows area
PortSize [in]: port size
NomOD [in]: nominal OD
Desc: valve name/model
Cd: Cd value if Cd = 0 GLD will calculate it
Dpfo [psi]: default = -7777. If default the
Venezuelan method will be used for gas
throughput calculations, if given value not equal
default value, NZ method will be used
Required if ProfileMode property is set to User
Survey
Type: 0 = MD; 1 = TVD
pVar: a two dimensional array containing
Doubles {depth, pressure}
pressUnits: pressure units for the values in the
arrays
lenUnits: units for the depth values in the array.
Any of ft, miles, m, km
Type: 0 = MD; 1 = TVD
pVar: a two dimensional array containing
Doubles {depth, temperature}
tempUnits: temperature units for the values in
the arrays
lenUnits: units for the depth values in the array.
Any of ft, miles, m, km
Optional, this parameters are written to the u2p
file
Schlumberger 62
SetGLWellProperties2 (gsg As Double,
resDepth As Double, chp As Double,
chpUnits As String, cht As Double, tht As
Double, rest As Double, surft As Double, Qgi
As Double)
SetHorizontalCorrelation (bsName As
String, HoldupFactor As Double,
FrictionFactor As Double)
SetIprTypeAndValue (IprType As Long,
IprValue As Double)
SetPressureUnits (unitStr As String)
SetProductionPressureGradient (value
As Double, unitStr As String)
SetSinglePhaseCorrelation (bsName As
String, Efficiency As Double)
SetTransferLinesParams3
(kickOffInjPressure As Double,
kickOffPres_Units As String, unloadingGrad
As Double, unloadingGrad_Units As String,
injPresDrop As Double, injPresDrop_Units
As String, locatingDPAtValve As Double,
locatingDP_Units As String, TransferFactor
As Double)
PIPESIM
Open Link
gsg: gas specific gravity
resDepth: reservoir depth [ft]
chp: injection head pressure
chpUnits: pressure units for the value entered as
chp. Any of: psia psig, bara, barg, atma, atmg,
kPa a, kPa g, kg/cm2 a, kg/cm2 g
cht: injection head temperature [F]
tht: production head temperature [F]
rest: reservoir temperature [F]
surf: surface ambient temperature [F]
Qgi: measured injection gas rate [mmscf/d]
Optional, this parameters are written to the u2p
file
Optional, these parameters are written to the
u2p file. IprType = 0 for WELLPI, IprType = 1 for
VOGEL
Call this function to specify pressure units to
display in GLD output. Any of: psia psig, bara,
barg, atma, atmg, kPa a, kPa g, kg/cm2 a,
kg/cm2 g
Required if ProfileMode property is set to
Constant Gradient
Optional, this parameters are written to the u2p
file
kickOffInjPressure: casing head pressure to
start unloading
kickOffPres_Units: the pressure units for the
above parameter
unloadingGrad: the unloading gradient
unloadingGrad_Units: Any of psi/ft, bar/m,
atm/m, kPa/m
injPresDrop: pressure drop between valves
injPresDrop_Units: Any of: psi, bar ,atm, kPa,
kg/cm2
locatingDPAtValve: Safety factor normally used
for both injection pressure operated and
production pressure operated valves. This is an
offset from the injection pressure line to the
start of the transfer (unloading) line at each
valve location. Default value for injection
pressure operated valves is 50 psi. and default
for production pressure operated valves is 100
psi
Call this function to display transfer line plots
Schlumberger 63
SetTransferLinesParams4
(kickOffInjPressure As Double,
kickOffPres_Units As String, unloadingGrad
As Double, unloadingGrad_Units As String,
injPresDrop As Double, injPresDrop_Units
As String, locatingDPAtValve As Double,
locatingDP_Units As String, SurfaceOffset
As Double, BottomOffset As Double,
BottomOffset_Units As String)
SetTransferLinesParams5
(kickOffInjPressure As Double,
kickOffPres_Units As String, unloadingGrad
As Double, unloadingGrad_Units As String,
injPresDrop As Double, injPresDrop_Units
As String, locatingDPAtValve As Double,
locatingDP_Units As String, TransferFactor
As Double, vbIsTransferPinjPprod As
Boolean)
SetTubingHeadPressure (value As
Double, unitStr As String)
SetVerticalCorrelation (bsName As
String, HoldupFactor As Double,
FrictionFactor As Double, SwapAngle As
Double)
GLWell Object - Operations
DisplayGasLiftDialog
DisplayGasLiftDialog2 (JpgFilename As
String, p_VarUnitManager, bCloseOK As
Boolean)
GLWell Object - Properties
PressureProfileMode As Long
PIPESIM
Open Link
The same as SetTransferLinesParams ()
with the added design mode parameters:
SurfaceOffset: percentage of the difference
between the operating production (wellhead)
pressure and the injection pressure. The pseudo
wellhead pressure is then the operating wellhead
pressure plus this surface offset value. Used in
Variable Gradient method in design mode.
BottomOffset: The bottom hole offset is a
pressure difference value. The pseudo flowing
bottom pressure is then the bottom hole
injection pressure minus the bottom hole offset
value. The pseudo production pressure used for
design is then a straight line drawn between the
pseudo wellhead pressure and the pseudo
bottom hole pressure. Used in Variable Gradient
method in design mode.
SetValveTemperatureFrom (long
ValveTempFrom)
This function sets the valve temperature to be
equal to :0: Production Temperature, 1: Ambient
Temperature, 2: Injection Temperature. Only
applicable in design mode
Required if ProfileMode property is set to
Constant Gradient or Variable Gradients
Optional, this parameters are written to the u2p
file
Pops up the GLD GUI
Same as DisplayGasLiftDialog but it allows to
pass Jpeg file name where plot will be stored
Mode = 0 Constant Gradient
Mode = 1 User Survey
Mode = 2 PIPESIM Calculated
Mode = 3 Variable Gradients
Use this property to set/get the pressure profile
mode.
Schlumberger
CalculateEqCurveOnDisplay As Boolean
CalculatePressureProfileOnDisplay As
Boolean
DesignMode As Boolean
Gor As Double
IterationMode As Long
LiquidRate As Double
PipesimEnginePath As String
PipesimIterationTolerance As Double
ProductionPressureGradient As Double
PsmFilePath As String
ReservoirPressure As Double
SetDisplayUnitSystem As Long
ShowAmbientTemperature As Long
ShowEquilibriumCurvePlot As Long
ShowEquilibriumCurvePlot As Long
ShowInjectionPressure As Long
ShowProductionPressurePlot As Long
ShowProductionTemperature As Long
ShowTransferLinesPlot As Long
ShowValveClosePressure As Long
ShowValveOpenPressure As Long
ValveTemperature (ValveIndx As Long) As
Double
Watercut As Double
PIPESIM
64 Open Link
If True the GLD module will calculate the
equilibrium curve just before displaying the GUI
(when calling DisplayGasLiftDialog ()). If an
existing curve has been entered with the method
AddEquilibriumCurve this property should be
set to false to avoid recalculation.
If True (AND the profile type is 'Simulate') the
GLD module will calculate the pressure profile
just before displaying the GUI (when calling
DisplayGasLiftDialog ()). If an existing profile
has been entered with the method
AddCalculatedPressureProfile this property
should be set to false to avoid recalculation.
Sets the module in design mode (True)
otherwise diagnostics mode (False). Default is
False
The gor in scf/bbl. Required if
PressureProfileMode = 3
Mode = 0 calculate flowrate {DEFAULT}
Mode = 1 calculate inlet pressure
This is applicable when PressureProfileMode
=2
The production liquid rate in bbl/d. Required if
PressureProfileMode = 3
bstrPath is the full path to a valid PIPESIM
engine
This data is required if PressureProfileMode =
2
Sets/gets the tolerance in % for the convergence
of PIPESIM iterations (default = 1 %)
The pressure gradient in psi/ft. Required if
PressureProfileMode = 0
The full path to a valid psm file
This data is required if PressureProfileMode =
2
Gets/sets the static reservoir pressure
System = 0 Engineering (DEFAULT), System = 1
SI
(default = 1)
(default = 1)
(default = 1)
(default = 1)
(default = 1)
(default = 1)
(default = 1)
(default = 1)
(default = 1)
Sets to valve at 0-based index ValveIndx (top
valve is indx = 0) the temperature given in val
[F]. See also the function
SetValveTemperatureFrom ()
The watercut in %. Required if
PressureProfileMode = 3
Schlumberger 65 Open Link

WellName As String An optional well description

GLWell Object Example
VBA Sample Code
'Create an instance of the GLWell interface

Dim obj As GLDIAGNOSTICSLib.GLWell

Set obj = New GLWell

'Display all variables using SI default units

obj.SetDisplayUnitSystem = 1

'Set the pressure units to be 'barg'

obj.SetPressureUnits barg

'Assign a name to the well

obj.WellName = Well_123

'Set the well properties

gsg = 0.64 'gas specific gravity
res_depth = 8000 'reservoir depth = 8000 ft
ch_p = 1400 'injection pressure 1400 psia
ch_t = 70 'injection temperature 200 F
tub_t = 120 'tubing head temperature 120 F
res_t = 220 'reservoir temperature 220 F
amb_t = 70 'surface ambient temp 70 F
tub_head_pres = 180 'tubing head pressure 180 psia
mqgi = 2 'measured injection gas rate 2 mmscf/d

obj.SetGLWellProperties2 gsg, res_depth, ch_p, psia,ch_t, tub_t, res_t,

amb_t, mqgi
obj.SetTubingHeadPressure tub_head_pres, psia

'Set the pressure profile type to Variable Gradients

obj.PressureProfileMode = 3

'Add 4 valves valves:

'type : IPO, PPO, IPS, PPS, ORIF, DUM
'depth in ft
'test rack pressure
'test rack pressure units
'port area
'port area over bellows area
'nominal port size
'nominal external diameter
'description
'Cd value (default 0.865)
'Delta P fully open

obj.AddGasLiftValve5 IPO, 3000, 1950 , psig, 0.013, 0.0169, 0.1250, 1.5,

Camco R20 1/8 Port, 0.865, 800

obj.AddGasLiftValve5 IPO, 4000, 1960 , psig, 0.013, 0.0169, 0.1250, 1.5,

Camco R20 1/8 Port, 0.865, 800

obj.AddGasLiftValve5 IPO, 5000, 1980 , psig, 0.013, 0.0169, 0.1250, 1.5,

PIPESIM
Schlumberger 66 Open Link

Camco R20 1/8 Port, 0.865, 800

obj.AddGasLiftValve5 IPO, 6000, 1990 , psig, 0.013, 0.0169, 0.1250, 1.5,

Camco R20 1/8 Port, 0.865, 800

obj.AddGasLiftValve5 IPO, 7000, 1995 , psig, 0.013, 0.0169, 0.1250, 1.5,

Camco R20 1/8 Port, 0.865, 800

'Display the graphical interface

obj.DisplayGasLiftDialog

'Get the status of each of the valves

Dim vtest As Variant
obj.GetArrayValveStatus vtest

IGLDesign Object
IGLDesign Object - Get Methods
GetCurrentGLValve (indx As Long, Returns the recently calculated valve parameters at
manuf As String, series As String, the specified index
portname As String, portsize As Double, manuf: manufacturer name
choke As Double, mode As String, ptro series: series name
As Double, Ap As Double, Ab As Double, portname:
nomOD As Double, Cd As Double, tvd portsize:
As Double, gasrate As Double) choke: valve choke
mode: valve type (IPO, PPO, IPS, PPS, Orifice or
Dummy)
md [ft]: valve depth
ptro: test rack pressure
Ap [in2]: port area
Ab: port area/bellows area
portsize [in]: port size
nomOD [in]: nominal OD
Cd: Cd value
GetCurrentSystem(pIValveSystem As Returns the recently calculated IGLValveSystem
Object) object
GetCurrentValveSystemCount(Valve Returns the count of recently calculated GL valves
Count As Long
GetDesignBias() As IDesignBias Returns the IDesignBias object
GetDesignParams () As IDesignParams Returns the IDesignParams object
GetGLValve (indx As Long, manuf As Returns the installed valve parameters at the
String, series As String, portname As specified index
String, portsize As Double, choke As manuf: manufacturer name
Double, mode As String, ptro As Double, series: series name
Ap As Double, Ab As Double, nomOD As portname:
Double, Cd As Double, md As Double, portsize:
gasrate As Double) choke: valve choke
mode: valve type (IPO, PPO, IPS, PPS, Orifice or
Dummy)
md [ft]: valve depth
ptro: test rack pressure
Ap [in2]: port area
Ab: port area/bellows area
portsize [in]: port size
nomOD [in]: nominal OD
Cd: Cd value

PIPESIM
Schlumberger
GetIsUnset(bUnset As Boolean)
GetProductionPressure(depth As
Double) As Double
GetProductionTemperature(depth As
Double) As Double
GetProjectData(ProjData)
GetValveSystemCount(ValveCount As
Long)
GetLastError(errorStr As String)
IGLDesign Object - Set Methods
SetCompletionParams(Params)
SetCurrentSystem(pIValveSystem As
Object)
SetFlowCorrsParams(Params)
SetFluidParameters(Params)
SetLanguage(nlLanguageID As Long)
As Boolean
SetProjectData(ProjData)
IGLDesign Object - Operations
AddDeviationSurvey(pVar_MDvsTVD_
Points)
CheckInput(Description As String) As
Boolean
DisplayGasLiftDesign(p_VarUnitMana
ger, bCloseOK As Boolean)
DisplayResults(p_VarUnitManager) As
Boolean
PerformDesign() As Boolean
IGLDesign Object - Properties
AmbientTemperature As Double
BottomHoleOffset As Double
PIPESIM
67 Open Link
Returns True is data is not set and False otherwise
Returns the production pressure
Returns the production temperature
Returns the array of strings containing project data
Returns the count of installed GL valves
Returns the last error message
Sets the completion type as String for report
purposes. String must be passed as Variant type
Sets the IGLValveSystem object
Sets the flow correlation as String for report
purposes. String must be passed as Variant type
Sets the flow correlation as String for report
purposes. String must be passed as arrays of 3 String
elements. First one is GOR/OGR value, the second is
WCut value and the last one is Api value.
Sets the user interface language
Available values for nlLanguageID are:
0x0809 English (UK)
0x0419 Russian
0x080A Spanish (Mexican)
0x0416 Portuguese (Brazilian)
0x0804 Chinese (PRC)
Function returns True if language was changed
successfully and False otherwise
Sets the Project data. The data must be passed as
array of 8 Strings. These strings are:
Project name,
Project User,
Job name,
Work Order,
Client Name,
Manager Name,
Company Name,
Model Specification
Sets user-defined deviation survey
pVar: a two dimensional array containing Doubles {
MD , TVD} in Strict_SI units
Validates the design data and returns True if data is
ok. Otherwise the return value is False and
Description contains the error message
Pops up the GLDesign GUI.
Pops up the results of the GL design calculations
Runs the engine to perform design
Schlumberger 68 Open Link

DesignInjectionPressure As Double
DesignMethod As String Can be one of the following: API, IPO-Surface Close,
Variable Gradient, PPO Design
DesignMethod_ As Long 0 for API or IPO-Surface Close,
1 for IPO-Pt Mai/Max,
2 for PPO Design
DesignSpacing As Long 0 for new spacing,
1 for current spacing
EngineFilePath As String
InjGasSpecificGravity As Double
InjGasSurfaceTemperature As
Double
InjPresDropBetweenValves As
Double
InstallCurrentSystem As Boolean
KickoffInjectionPressure As Double
LocatingDPAtValveLocation As
Double
MinimumValveInjDP As Double
MinimumValveSpacing As Double
OperatingProdPressure As Double
PackerDepth As Double
PlotToolPath As String
ProductionPressureCurve As Integer Production Pressure Curve
0 for Production Pressure Model
1 for Equilibrium Curve
PsmFilePath As String
Recommendations As String
ReservoirDepth As Double
ReservoirPressure As Double
ReservoirTemperature As Double
SurfaceOffset As Double
SurfaceOffsetDP As Double
SurfaceOffsetType As Boolean
TargetInjGasRate As Double
TransferFactor As Double
TubingName As String
UnloadingGradient As Double
UnloadingProdPressure As Double
ValveLocation As Long Top Valve location
0 for liquid to surface,
1 for liquid not to surface
ValveManufacturer As String Valve manufacturer filter value
ValveMinPortSize As Double Valve min port size filter value
ValveSeries As String Valve series filter value
ValveType As String Valve type filter value
ValveNominalOD As Double Valve size filter value
ValveTemperature As String Can be one of the following: Production, Ambient,
Injection or Unloading

PIPESIM
Schlumberger 69 Open Link

ValveTemperature_NonTop As Long Unloading temperature for non-top valve:

0 for Production
1 for Ambient
2 for Injection
3 for Unloading
ValveTemperature_Top As Long Unloading temperature for top valve:
0 for Production
1 for Ambient
2 for Injection
3 for Unloading
WellAbsorbs As Boolean
IDesignParams Object
IDesignParams Object - Properties
BracketingSpacing As Double
BracketingTVD As Double
DesignInjectionPressure As Double
InjGasSpecificGravity As Double
InjGasSurfaceTemperature As
Double
InletPressure As Double
IsBracketingEnabled As Boolean
IsPressureCondition As Boolean
KickoffInjectionPressure As Double
LiquidRate As Double
MinimumValveInjDP As Double
MinimumValveSpacing As Double
MinUnloadingLiqRate As Double
OperatingProdPressure As Double
ReservoirPressure As Double
TargetInjGasRate As Double
UnloadingGradient As Double
UnloadingProdPressure As Double
UseAnnulusGasGradient As Boolean Specifies usage of static gradient if True and
rigorous friction and elevation DP otherwise
IDesignBias Object
IDesignBias - Properties
BottomOrifCD As Double Discharge coefficient for orifice
DeltaPtroBottomValve As Double
InjPresDropBetweenValves As
Double
IsCalculateInjPresDrop As Boolean
IsPlaceIPOatBottom As Boolean
IsPlaceOrificeatBottom As Boolean
IsTransferFactorBetweenIPandPP
As Boolean
LocatingDPAtValveLocation As
Double
TransferFactor As Double

PIPESIM
Schlumberger
IGLValveSystem Object
IGLValveSystem Object - Get Methods
GetGasLiftProps(InjPressure As
Double, MaxAvailableRate As Double,
InjTemp As Double, GasSG As Double,
bstrPvtFile As String, bIsBlackOil As
Boolean)
GetIsUnset(bUnset As Boolean)
GetLastError(errorStr As String)
GetValveCount(lValveCnt As Long)
IGLValveSystem Object - Set Methods
SetGasLiftProps(InjPressure As
Double, MaxAvailableRate As Double,
InjTemp As Double, GasSG As Double,
bstrPvtFile As String, bIsBlackOil As
Boolean)
SetLanguage(nlLanguageID As Long)
As Boolean
IGLValveSystem Object - Operations
AddGLValve(manuf As String, series As
String, portname As String, portsize As
Double, choke As Double, mode As
String, ptro As Double, Ap As Double,
Ab As Double, nomOD As Double, Cd As
Double, tvd As Double, gasrate As
Double)
ClearValveSystem()
DisplayGLValveSystem(p_VarUnitMan
ager, bCloseOK As Boolean)
PIPESIM
70 Open Link
Returns the GL properties:
InjPressure injection pressure
MaxAvailableRate gas rate
InjTemp surface injection temperature
GasSG gas specific gravity
bstrPvtFile PVT file name (for compositional
model)
bIsBlackOil True if black oil model deifned, False
otherwise
Returns True is data is not set and False otherwise
Returns the last error message
Returns the count of installed GL valves
Sets the GL properties:
InjPressure injection pressure
MaxAvailableRate gas rate
InjTemp surface injection temperature
GasSG gas specific gravity
bstrPvtFile PVT file name (for compositional
model)
bIsBlackOil True if black oil model deifned, False
otherwise
Sets the user interface language
Available values for nlLanguageID are:
0x0809 English (UK)
0x0419 Russian
0x080A Spanish (Mexican)
0x0416 Portuguese (Brazilian)
0x0804 Chinese (PRC)
Function returns True if language was changed
successfully and False otherwise
manuf: manufacturer name
series: series name
portname:
portsize:
choke: valve choke
mode: valve type (IPO, PPO, IPS, PPS, Orifice or
Dummy)
ptro: test rack pressure
Ap: port area
Ab: port area/bellows area
nomOD : nominal OD
Cd: Cd value
tvd : valve depth
gasrate
Removes all installed valves
Pops up the GL Valve System GUI
Schlumberger 71 Open Link

IGLValveSystem Object - Properties

BellowsArea(iValveIndx As Long) As Gets bellows area for the valve specified by
Double iValveIndx
(Read only property)
ChokeSize(iValveIndx As Long) As (Read only property)
Double
DPFO(iValveIndx As Long) As Double
Manufacturer(iValveIndx As Long) As (Read only property)
String
MeasuredDepth(iValveIndx As Long) (Read only property)
As Double
nomOD(iValveIndx As Long) As Double (Read only property)
PortArea(iValveIndx As Long) As (Read only property)
Double
portname(iValveIndx As Long) As (Read only property)
String
portsize(iValveIndx As Long) As (Read only property)
Double
ptro(iValveIndx As Long) As Double (Read only property)
series(iValveIndx As Long) As String (Read only property)
UseAnnulusGasGradient As Boolean
UseValveDetails As Boolean
ValveCv(iValveIndx As Long) As Double (Read only property)
ValveMode(iValveIndx As Long) As (Read only property)
String
ValveModeType(iValveIndx As Long) (Read only property)
As Long
Single Branch Output Reader COM
An ATL COM DLL has been developed to read data from a performance curves file.
Name
The name of the COM is WELLCURVE.DLL.
Interfaces supported & Registering
The COM is support on C++ and Visual basic
Register the COM by using REGSVR32.EXE.
For C++ usage:
Include the following paragraph in the stdafx.h header file:
#import wellcurve.dll no_namespace
For Visual basic usage:
Include the COM object in your project, select Projects -> References, then WELLCURVELib 1.0
type library.
1. COM diagram
2. Dependency map
3. COM methods
ReadData Object - Get methods
GetFileCreatorName() As String Returns the name of the simulator that has been used to
create the performance curves.
Parameters - None
Return Value - A string.
GetNumberofVariables() As Long Returns the number of variables (data columns) in the
performance curve.
Parameters - None
Return Value - An integer.

PIPESIM
Schlumberger
GetUnitofVariable(VariableName As
String) As String
GetDataofVariable(VariableName As
String)
GetVariableName(Index As Long) As
String
GetMultipleVariablesData(Indexes)
GetTitle() As String
GetNumberofDataSets() As Long
GetVariableNamesList()
GetAllData()
GetLastError() As String
ReadData Object - Operations
OpenFile(FilePath As String) As Boolean
PIPESIM
72 Open Link
Returns the unit of given the column variable name.
Parameters - VariableNme - Name of the column variable
Return Value -A string.
Returns the array of data at the given column variable name
in the performance curves file.
Parameters - VariableNme -Name of the column variable
Return Value - A variant (as an array of variants). The
number of elements in a sub variant is equal to the number of
data points between two NEWLINE keywords in the
VarName column plus one (for legends).
Returns the name of column variable given the position of
the variable.
Parameters - Index - The position of the variable name in the
column variable list.
Return Value - A string.
Returns the array of data at the given number of variables in
the performance curves file
Parameters - Indexes - Indexes is a variant that contains an
array of integers (indexes of the column variables)
Return Value - A variant (as an array of variants). The
number of variants in the main array is equal to the number
of elements in the Indexes array.
Returns the title of the well performance curves file.
Parameters - None
Return Value - A string.
Returns the number of data sets (= number of NEWLINE
cards) in the performance curves file.
Parameters - None
Return Value - An integer.
Returns the list of names of column variables in the
performance curves file.
Parameters - None
Return Value - A Variant. The number of elements in the
Variant is equal to the number of columns in the
performance curves file.
Returns the entire column variables data in the performance
curves file.
Parameters - None
Return Value - A Variant (as an array of variants). The
number of Variants in the array is equal to the number of
column variables and the number of elements (number of
double type values) in a sub Variant is equal to the number of
data points per column variable in the performance curves
file.
Returns the last error message
Opens the given performance curves file, and returns a
Boolean type. This function must be called before any other
functions (methods) in the DLL are called.
Parameters - FileName -the full path (including the name)
of the performance curves file.
Return Value - True for successful open or False for failure
to open.
Schlumberger 73 Open Link

CloseFile() As Boolean Closes the performance curves file that has been previously
opened, and returns a Boolean type. This function must be
called after finish reading the data and before open another
file.
Parameters - None
Return Value - True for successful closure, or False for
failure to close.
ReadData Object Examples
Visual C++ Sample Code
void CPerformCurve::OnRun()
{
_bstr_t CreatorName; // File creator's name
_bstr_t VarName; // Column name
int NoVars; // Number of data columns in the file
int NoSets; // Number of data sets per column
_variant_t vaData; // Data in a column
_variant_t vaVarList; // Column names list
int ist, ied; // lower and upper bound of a variant
int jst, jed; // lower and upper bound of a variant
int i, j; // Counters
SAFEARRAY *sa1, *sa2; // Supporting variables
_variant_t va1, va2; // Supporting variables
long index; // Supporting variable

// Initialize the COM library

CoInitialize(NULL);

// Define a pointer to ReadData COM object

IReadDataPtr pPerCur;

// Create an instance of ReadData

if (pPerCur.CreateInstance(_uuidof(ReadData)) != S_OK)
{
AfxMessageBox(Performance curve ReadData component not found);
return;
}

// Open the performance curve file

BOOL success = pPerCur->OpenFile(D:\\SOURCE\\CASE1\\WELL_11.PLT);

if (success)
{
// Get the file creator's name
CreatorName = pPerCur->GetFileCreatorName();

// Get number of variables (columns) in the file

NoVars = pPerCur->GetNumberofVariables();

// Get number of data sets in a column

NoSets = pPerCur->GetNumberofDataSets();

// Get name of the first column (= Column number 1 NOT 0)

VarName = pPerCur->GetVariableName(1);

// Get data for the above variable (column)

vaData = pPerCur->GetDataofVariable(VarName);

PIPESIM
Schlumberger 74 Open Link

// How to get data out of vaData

if (vaData.vt != VT_EMPTY)
{
sa1 = vaData.parray;
// Get lower bound of vaData, should be zero
ist = sa1->rgsabound[0].lLbound;
// Get upper bound of vaData, should be equal to NoSets
ied = sa1->rgsabound[0].cElements;
for (i=ist; i<=ied; i++)
{
index = i;
SafeArrayGetElement(sa1, &index, &va1);
if (va1.vt != VT_EMPTY)
{
sa2 = va1.parray;
// Get lower bound of vatmp, should be zero
jst = sa2->rgsabound[0].lLbound;
// Get upper bound of vatmp, should be equal
// to number of data points per data set plus one (legend)
jed = sa2->rgsabound[0].cElements;
for (j=jst; j<=jed; j++)
{
index = j;
SafeArrayGetElement(sa2, &index, &va2);
}
}
}
}

// Get variable list

vaVarList = pPerCur->GetVariableNamesList();

// Close the file

pPerCur->CloseFile();
}

// Destroy the pPerCur

pPerCur.Release();

// Close COM library

CoUninitialize();
}
Visual basic Sample Code
Option Explicit
Private wtst As New WELLCURVELib.ReadData ' create an object of the
performance curve reader
Private Sub Command1_Click()
Dim vtmp As Variant
Dim vData As Variant
Dim NoCol As Integer
Dim NoDataSets As Integer
Dim str As String
Dim ist As Integer
Dim ied As Integer
Dim i As Integer

PIPESIM
Schlumberger 75 Open Link

' Open the file

If (wtst.OpenFile(d:\source\case1\well_11.plt)) Then
' Get the file creator's (simulator's) name
str = wtst.GetFileCreatorName()
' Get number of variables listed in the file
NoCol = wtst.GetNumberofVariables()
' Get the variable list
vtmp = wtst.GetVariableNamesList()
If (Not IsEmpty(vtmp)) Then
ist = LBound(vtmp)
ied = UBound(vtmp)
For i = ist To ied
' Get individual variable names (method 1)
str = vtmp(i)
' Get individual variable names (method 2)
str = wtst.GetVariableName(i + 1)
' Get the data for above variable (str)
vData = wtst.GetDataofVariable(str)
Next i
End If
' Get number of data sets in the file (= number of NEWLINE keywords)
NoDataSets = wtst.GetNumberofDataSets()
' Get the title of performance curve
str = wtst.GetTitle()
' Get all variable data
vData = wtst.GetAllData()
' Get multiple variable data
' Create indexes array
ReDim vtmp(2)
vtmp(0) = 1
vtmp(1) = 4
vtmp(2) = 6
vData = wtst.GetMultipleVariablesData(vtmp)
' Close the file
wtst.CloseFile
End If
Set wtst = Nothing
End Sub

PerformCurve Object
PerformCurve Object - Get methods
GetAllVariables()
GetAttributeDetailsAt(VariableName
As String)
GetAxisBoundaries()
GetBubblePointData()
Returns a Variant type containing multidimensional array of
all values from the curve file. First dimension is a number of
the variables, second dimension is a number of cases and
the third dimension contains all values for the each case
plus the case name. All returned values are wrapped into
Variants
Returns a String (as Variant) containing plotting attributes
for the specified variable
Returns a Variant type containing two-dimensional array of
the low/upper boundaries for the plot variables.
Returns (as Variant type) the array of three doubles values
for saturation pressure, saturation temperature and
saturation GOR. (Black oil models only.)

PIPESIM
Schlumberger
GetColumnVariableDataAt(VarName
As String)
GetConcatenationData()
GetConeGasSG() As Double
GetCreationDate()
GetCurrentModelUnitSettings()
GetDefaultXAxis() As Long
GetDefaultYAxis() As Long
GetDynamicPlotFileName() As String
GetDynamicPlotLongFileName() As
String
GetFileFormatStatus() As String
GetLastError() As String
GetMultipleColumnsDataAt(Index)
GetNoOfDataColumn() As Long
GetNumberOfCases() As Long
GetPhysicalPropertyData()
GetProductionData() ()
GetSimulatorName() As String
GetTitle() As String
GetUnitDetailsAt(VariableName As
String)
GetUnitsOfVariableName(sVarName
As String) As String
GetUnitType() As String
GetUserName() As String
GetVarableNamesList()
GetVariableDataAt(ColName As String)
GetVariableDataAtCase(VarName As
String, CaseNo As Long)
GetVariableNameAt(Index As Long) As
String
GetViscosityData()
PIPESIM
76 Open Link
Returns a Variant type containing two-dimensional array of
all values for specified variable. First dimension is a number
of cases and the second dimension contains all values for
the each case plus the case name. All returned values are
wrapped into Variants
Returns a Double value (wrapped into Variant type) of cone
gas specific gravity
Returns a String value (wrapped into Variant type) of curve
file date/time stamp
Returns (as Variant type) the two-column array of strings
for all plotted variables. First column contains variables
measurement and a second column contains variables units
Returns an index for X axis variable
Returns an index for Y axis variable
Returns a curve file name (short form)
Returns a curve file name (long form)
Return a String New if curve file has new format, otherwise
return value is Old
Returns the last error message produced by the interface.
Returns data similar to GetAllVariables function but for
variables passed in Index array
Returns the total number of variables in curve file
Returns the number of cases in curve file
Returns (as Variant type) the array of 6 doubles values for
API, production gas specific gravity, injection gas specific
gravity, water specific gravity, watercut and GOR. (Black
oil models only.)
Returns (as Variant type) the array of 2 doubles values for
Well PI and static reservoir pressure
Returns String with the simulator name
Returns String with the project description
Returns (as Variant type) the array of 5 Variants containing
units information for the specified variable. First element is
a String with measurement name, second element is a String
with current units, third and forth elements are Doubles
with multiplier and adder for conversion from strict SI units
and last fifth element is a String with strict SI units
Returns String with the current units for the specified
variable
Returns String ENG or S depending on unit system user
selected for the output files
Returns String with the user name form project properties
Returns (as Variant type) the array of Strings containing all
variables names from curve file
Returns (as Variant type) the array of Doubles containing all
values for the specified variable
Similar to GetVariableDataAt but returned values are for
the specified case only (case index is 1-based)
Returns String with the variable name at specified index (1-
based)
Returns (as Variant type) the array of 4 doubles values for
temperatures and viscosities
Schlumberger 77 Open Link

PerformCurve Object - Operations

OpenFile(FilePath As String) As Boolean Opens the given performance curves file, and returns a
Boolean type. This function must be called before any other
functions (methods) in the DLL are called.
Parameters - FileName -the full path (including the name)
of the performance curves file.
Return Value - True for successful open or False for failure
to open.
CloseFile() As Boolean Closes the performance curves file that has been previously
opened, and returns a Boolean type. This function must be
called after finish reading the data and before open another
file.
Parameters - None
Return Value - True for successful closure, or False for
failure to close.
IsWellFileOpened() As Boolean Returns True if the curve file is open and False otherwise
PNSReaderCOM
PNSREADER.DLL includes COM compatible interfaces that can be used to read output from the
output file (PNS) generated by the PIPESIM and PIPESIM-NET engines.
Supported Interfaces
IPNSComPtr: for network models and single branch operations.
Dependency MAP
PNSREADER.DLL has no PIPESIM dependencies. It can be found in the Schlumberger\
COMMON\ACTIVEX folder.
IPNSComPtr Interface Operational methods
ReadPnsFile Read a Net engine (.PNS) output file
Params BSTR FileName - Full path of net engine file
(.PNS)
IPNSComPtr Interface - Get Methods
GetNodeCount Get total number of nodes, junctions + wells +
source + sinks
params (#) int *iNodeCount
GetBranchCount Get total number of branches (that is excluding wells
which engine treats as branch + source/sink)
params (#) int - *BranchCount
GetNodeData Fill a supplied SAFEARRAY (blob) with node data
for i'th node, data format fixed as - name, type, g
rate, l rate, m rate, press, temp , press resid, rate
resid, glr, lgr, wcut
params int iNode - index of node in array (#)
VARIANT *vNodeData SAFEARRAY to hold data
GetBranchOutData, Fill a supplied SAFEARRAY (blob) with node data
GetBranchInData for i'th branch, data
format fixed as - name, type, g retell rate, m rate,
press, temp , press resid,
rate resid, glr, lgr, wcut
params int iNode - index of node in array
(#) VARIANT *vNodeData SAFEARRAY to hold data
GetNodeName name of the i'th node in the array
params int iNode - index in array
(#) BSTR *sName - name of i'th element
GetNodeType Get Network node type
params int iNode - index in array
(#) BSTR* sName - Source, Sink, Well, Junction

PIPESIM
Schlumberger 78 Open Link

GetBranchName name of the i'th branch in the array

params int iNode - index in array
(#) BSTR *sName - name of i'th element
GetNodeVariableValue, Gets value of variable type Gas Rate, glr etc. for i'th
GetBranchOutVariableValue, element of array
GetBranchInVariableValue params int iNode - index of element in the array
(#) double *dValue - value requested. 6 - Baker
Jardine COM documentation
PIPESIM
BSTR sType - GasRate, LiquidRate, MassRate,
Pressure, Temperature, PressureResidual,
RateResidual, GLR, LGR, Water Cut
GetNodeStrVariableValue, Gets value of variable type Gas Rate, glr etc. for
GetBranchInStrVariableValue, named element of array
GetBranchOutVariableValue Params BSTR sName - Object identifier (name) for
example, Well_1
(#) double *dValue - value requested
BSTR sType - GasRate, LiquidRate, MassRate,
pressure, Temperature, PressureResidual,
RateResidual, GLR, LGR, Water Cut, Max Pres, Comp
Power, Choke DP
GetModelStatus Gets convergence error information from the .PNS
file
Params (#) BSTR sName - Convergence status string
of the form 'Model failed to converge Convergence
error = %4.3f Material balance error = %4.3f '
IPNSComPtr Interface Examples
C++ Sample Code
CMyObj::ReadPnsFunc()
{
CString sNodeType;
CoInitialize(NULL);
IPNSComPtr pPNS;
if (pPNS.CreateInstance(_uuidof(PNSCom)) != S_OK)
{
AfxMessageBox(PNS reader component not found);
return;
}
pPNS->ReadPnsFile((LPCTSTR)case1.pns );
iNumNodes = pPNS->GetNodeCount();
iNumBranches = pPNS->GetBranchCount();
iNumWells = pPNS->GetWellCount();
BSTR ss = pPNS->GetModelStatus();
for ( int i = 0 ; i < iNumNodes; i++)
{
BSTR Name = pPNS->GetNodeName(i);
BSTR sNodeType= pPNS->GetNodeType( i );
dVal = pPNS->GetNodeVariableValue( i, Pressure);
if( dVal != Unset() ) // = -7777
{
dVal = pPNS->GetNodeVariableValue( i, Temperature);
dVal = pPNS->GetNodeVariableValue( i, MassRate);
dVal = pPNS->GetNodeVariableValue( i, LiquidRate);
dVal = pPNS->GetNodeVariableValue( i, GasRate);
dVal = pPNS->GetNodeVariableValue( i, GLR);
dVal = pPNS->GetNodeVariableValue( i, Water Cut);

PIPESIM
Schlumberger 79 Open Link

}
int start = iNumNodes + 2;
// Branches
for ( int j = 0; j <= 1; j ++ )
{
for ( i = 0; i < iNumBranches; i++ )
{
BSTR sName = pPNS->GetBranchName( i );
if ( j != 1 )
{
dVal = pPNS->GetBranchInVariableValue( i, Pressure);
dVal2 = pPNS->GetBranchOutVariableValue( i, Pressure);
dVal = pPNS->GetBranchInVariableValue( i, Temperature);
dVal = pPNS->GetBranchInVariableValue( i, MassRate);
dVal = pPNS->GetBranchInVariableValue( i, LiquidRate);
dVal = pPNS->GetBranchInVariableValue( i, GasRate);
dVal = pPNS->GetBranchInVariableValue( i, GLR);
dVal = pPNS->GetBranchInVariableValue( i, Water Cut);
dVal = pPNS->GetBranchInVariableValue( i, Max Pres);
dVal = pPNS->GetBranchInVariableValue( i, Comp Power);
dVal = pPNS->GetBranchInVariableValue( i, Choke DP);
}
else
{
dVal = pPNS->GetBranchOutVariableValue( i, Pressure);
dVal2 = pPNS->GetBranchInVariableValue( i, Pressure);
dVal = pPNS->GetBranchOutVariableValue( i, Temperature);
dVal = pPNS->GetBranchOutVariableValue( i, MassRate);
dVal = pPNS->GetBranchOutVariableValue( i, LiquidRate);
dVal = pPNS->GetBranchOutVariableValue( i, GasRate);
dVal = pPNS->GetBranchOutVariableValue( i, GLR);
dVal = pPNS->GetBranchOutVariableValue( i, Water Cut);.

dVal = pPNS->GetBranchOutVariableValue( i, Max Pres);

dVal = pPNS->GetBranchOutVariableValue( i, Comp Power);
dVal = pPNS->GetBranchOutVariableValue( i, Choke DP);
}
start ++;
}
}
// Wells
for ( j = 0; j <= 1; j ++ )
{
for ( i = 0; i < iNumWells; i++ )
{
BSTR sName = pPNS->GetWellName( i );
if ( j != 1 )
{
dVal = pPNS->GetWellInVariableValue( i, Pressure);
dVal = pPNS->GetWellInVariableValue( i, Temperature);
dVal = pPNS->GetWellInVariableValue( i, MassRate);
dVal = pPNS->GetWellInVariableValue( i, LiquidRate);
dVal = pPNS->GetWellInVariableValue( i, GasRate);
dVal = pPNS->GetWellInVariableValue( i, GLR);
dVal = pPNS->GetWellInVariableValue( i, Water Cut);
dVal = pPNS->GetWellInVariableValue( i, Max Pres);
dVal = pPNS->GetWellInVariableValue( i, Comp Power);

PIPESIM
Schlumberger 80 Open Link

dVal = pPNS->GetWellInVariableValue( i, Choke DP);

}
else
{
dVal = pPNS->GetWellOutVariableValue( i, Pressure);
dVal = pPNS->GetWellOutVariableValue( i, Temperature);
dVal = pPNS->GetWellOutVariableValue( i, MassRate);
dVal = pPNS->GetWellOutVariableValue( i, LiquidRate);
dVal = pPNS->GetWellOutVariableValue( i, GasRate);
dVal = pPNS->GetWellOutVariableValue( i, GLR);
dVal = pPNS->GetWellOutVariableValue( i, Water Cut);
dVal = pPNS->GetWellOutVariableValue( i, Max Pres);
dVal = pPNS->GetWellOutVariableValue( i, Comp Power);
dVal = pPNS->GetWellOutVariableValue( i, Choke DP);
}
start ++;
}
}
pPNS.Release();
CoUninitialize();
}
VBA Sample Code
Taken from EXPORT.XLS Open Link Case study
Private Sub ShowResults()

Dim PnsReader As New PNSREADERLib.PNSCom

Dim filename

'clear output range

Set rv = Range(OUTVAL_RANGE)
rv.ClearContents

filename = Range(MODELFILE)
pos = InStr(1, filename, .bpn, 1)
If (pos > 0) Then
filename = Left(filename, pos)
filename = filename + pns
End If

Dim nodeindex As Long

Dim sourcename As Variant
Dim value As Double
Dim bOK

If (PnsReader.ReadPnsFile(filename)) Then

Set r = Range(SOURCE_RANGE)
Dim col
col = 1

Set r1 = Range(OUTINJGAS_RANGE2)
r1.ClearContents

Set r2 = Range(OUTFLOWRATE_RANGE2)
r2.ClearContents

PIPESIM
Schlumberger 81 Open Link

For Each sourcename In r.Columns

nodeindex = PnsReader.GetNodeIndex(sourcename)

If (nodeindex <> -1) Then

value = PnsReader.GetNodeVariableValue(nodeindex, Pressure)

If (value <> -7777) Then
rv.Cells(1, col) = value
End If

If (value <> -7777) Then

value = PnsReader.GetNodeVariableValue(nodeindex,
Temperature)
rv.Cells(2, col) = value
End If

If (value <> -7777) Then

value = PnsReader.GetNodeVariableValue(nodeindex,
LiquidRate)
rv.Cells(3, col) = value
End If

If (value <> -7777) Then

value = PnsReader.GetNodeVariableValue(nodeindex, GasRate)
rv.Cells(4, col) = value
End If

If (value <> -7777) Then

value = PnsReader.GetNodeVariableValue(nodeindex, MassRate)
rv.Cells(5, col) = value
End If

If (value <> -7777) Then

value = PnsReader.GetNodeVariableValue(nodeindex, GLR)
rv.Cells(6, col) = value
End If

If (value <> -7777) Then

value = PnsReader.GetNodeVariableValue(nodeindex, Water
Cut)
rv.Cells(7, col) = value
End If

End If

'--------------------------------------------------------
'Get the pressure profiles ------------------------------

Dim PltReaderObj As New WELLCURVELib.PerformCurve

Dim plcfile, tempfile
Dim distance
Dim pressure

plcfile = Range(MODELFILE)
tempfile = plcfile

PIPESIM
Schlumberger 82 Open Link

Do
pos = InStr(1, tempfile, \, 1)
tempfile = Right(tempfile, Len(tempfile) - pos)
Loop While pos > 0

If (Len(tempfile) > 0) Then

plcfile = Left(plcfile, Len(plcfile) - Len(tempfile))

plcfile = plcfile + sourcename + .plc

If (PltReaderObj.OpenWellFile(plcfile)) Then

distance = PltReaderObj.GetColumnVariableDataAt(Total
Distance (ft))

Dim Lower, Upper, i

Lower = LBound(distance(0), 1)
Upper = UBound(distance(0), 1)

For i = Lower To Upper - 1

r1.Cells(i + 1) = distance(0)(i)

Next

pressure =
PltReaderObj.GetColumnVariableDataAt(Pressure (psia))

Dim LowerO, UpperO

Dim outter

LowerO = LBound(distance(0), 1)
UpperO = UBound(distance(0), 1)

For outter = LowerO To UpperO - 1

r2.Cells(outter + 1, col) = pressure(0)(outter)

Next

Set rtitle = Range(CASE1TITLE_RANGE)

rtitle.Cells(1, col) = pressure(0)(outter)

PltReaderObj.CloseWellFile

End If
End If

col = col + 1
Next

End If
End Sub

PIPESIM
Schlumberger 83 Open Link

Inflow Performance Calculator COM

Name
The name of the COM module is WellModelCOM.DLL.
Interfaces supported & Registration
Support provided for any COM compliant application
Supported COM Interfaces
Jones: To fit and visualise the IPR curve for a given number of data points according to the Jones'
equation:
Pws - Pwf = BQ + AQ^2 (Liquid)
Pws^2 - Pwf^2 = BQ + AQ^2 (Gas)
Dependency MAP
List of Dependencies: Spr32x30.ocx, TeeChart.ocx, MFC42.DLL
COM Interface: Jones - Get Methods
GetJonesAandBConstants ([out] a: the value of the A parameter in the Jones equation
double * a, [out] BSTR * a_unit, [out] a_unit: the unit string for the A parameter
double * b, [out] BSTR * b_unit) b: the value of the B parameter in the Jones equation
b_unit: the unit string for the B parameter
COM Interface: Jones - Set Methods
AddFlowrateAndPwfPoint ([in] frate: flowrate value (double)
double frate, [in] BSTR frate_unit, frate_unit: unit string for the flowrate value. Any of:
[in] double pwf, [in] BSTR pwf_unit) STB/d, sm3/d for Liquid Rates OR: mmscf/d mscf/d,
scf/d, mmsm3/d, msm3/d, sm3/d for gas rates
pwf: tubing flowing pressure (double)
pwf_unit: unit string for the pwf value: Any of: psia
psig, bara, barg, atma, atmg, kPa a, kPa g, kg/cm2 a,
kg/cm2 g
Call this function once for each survey point.
AddFlowrateAndPwfData ([in] ftype: fluid type, type_liquid = 0, type_gas = 1
short ftype, [in] BSTR frate_unit, [in] frate_unit: unit string for the flowrate value. Any of:
BSTR pwf_unit, [in] BSTR Legend, STB/d, sm3/d for Liquid Rates OR: mmscf/d mscf/d,
[in] VARIANT * vData, [in] const scf/d, mmsm3/d, msm3/d, sm3/d for gas rates
unsigned long pType) pwf_unit: unit string for the pwf value: Any of: psia
psig, bara, barg, atma, atmg, kPa a, kPa g, kg/cm2 a,
kg/cm2 g
Legend: Legend to show on plot
vData: variant whose SAFEARRAY contains a 2D
array (col[0] = FlowRate data, col[1] = Pwf data) Line
= 0; Bar = 1; HorizBar = 2; Area = 3; Point = 4
Use this function to compare an observed set of
points with the fitted curve.
SetFluidType (/*[in]*/ short ftype) ftype: fluid type, type_liquid = 0, type_gas = 1
SetStaticPressure ([in] double pres, Pres: static pressure value
[in] BSTR unitStr) UnitStr: units for the pressure value. Any of: psia psig,
bara, barg, atma, atmg, kPa a, kPa g, kg/cm2 a, kg/cm2
g
SetJonesAConstant ([in] double val: the A parameter in the Jones equation
val, [in] short unitSystem) unitSystem: 0: val is in default Eng : psi/(STB/d)^2
(liq) or (psi/mmscf/d)^2 (gas)
1: val is default SI: bar/(sm3/d)^2 (liq) or
(bar/mmsm3/d)^2 (gas)
Set this value to calculate the B parameter given A
and one survey point

PIPESIM
Schlumberger 84 Open Link

SetJonesBConstant ([in] double val: the B parameter in the Jones equation

val, [in] short unitSystem)
SetJonesMeasuredAConstant ([in]
double val, [in] short unitSystem)
SetJonesMeasuredBConstant ([in]
double val, [in] short unitSystem)
SetUnitSystem ([in] long
unitSystem)
COM Interface: Jones - Operations
DoCalculateConstants ()
ShowInflowPerformanceDlg ()
COM Interface: Jones Example
VBA Sample Code
'Create an instance of the Jones COM interface
Dim JonesObj As WELLMODELCOMLib.Jones
Set JonesObj = New Jones
unitSystem: 0: val is in default Eng: psi/STB/d (liq) or
psi2/mmscf/d (gas) 1: val is default SI: bar/sm3/d (liq)
or bar2/mmsm3/d (gas). Set this value to calculate the
A parameter given B and one survey point
val: the A parameter in the Jones equation
unitSystem: 0: val is in default Eng: psi/(STB/d)^2
(liq) or (psi/mmscf/d)^2 (gas) 1: val is default SI:
bar/(sm3/d)^2 (liq) or (bar/mmsm3/d)^2 (gas) For
display purposes only. Set this value to compare a
measured pair of A and B values with the calculated
ones
val: the B parameter in the Jones equation
unitSystem: 0: val is in default Eng: psi/STB/d (liq) or
psi2/mmscf/d (gas) 1: val is default SI: bar/sm3/d (liq)
or bar2/mmsm3/d (gas)
For display purposes only. Set this value to compare a
measured pair of A and B values with the calculated
ones
unitSystem: 0: values will be displayed in default
Engineering units; 1: SI units
Calculates the A and B parameters based on the given
data: static reservoir pressure and {pwf, flowrate}
points
Displays the IPR COM graphical interface

'Set static pressure as 4000 psia

'legal pressure units: psia psig bara barg atma atmg kPa a kPa g kg/cm2
kg/cm2 g

pws = 4000.0
pws_unit = 'psia'
JonesObj.SetStaticPressure pws, pws_unit

'Set the fluid type: 0 for liquid 1 for Gas

JonesObj.SetFluidType 1 'Gas

'legal liquidRate units : STB/d sm3/d

'legal gasRate units mmscf/d mscf/d, scf/d, mmsm3/d msm3/d, sm3/d,

'Add 4 data points

JonesObj.AddFlowrateAndPwfPoint 10.0, 'mmscf/d', 3600, 'psia'
JonesObj.AddFlowrateAndPwfPoint 28.0, 'mmscf/d', 2400, 'psia'
JonesObj.AddFlowrateAndPwfPoint 30.0, 'mmscf/d', 2100, 'psia'
JonesObj.AddFlowrateAndPwfPoint 25.0, 'mmscf/d', 1600, 'psia'

' Display graphical interface to show the fitted curve and calculated
constants
JonesObj.ShowInflowPerformanceDlg

PIPESIM
Schlumberger 85 Open Link

Units Library
IUnitSystem Interface
Note: See Unit System for the available quantity names and unit strings.
Convert Converts in_value to [out_value, out_unit] given the
[in] BSTR quantity_name, [in] double in_values conversion factor and adder to convert it
in_value, [in] double factor_to_SI, [in] to its strict SI unit. Returns out_value in the given
double adder_to_SI, [in] BSTR out_unit
out_unit, [out, retval] double *
out_value
Convert_SI Converts a given quantity in strict SI units to the
[in] BSTR quantity name, [in] double given out_unit
si_value, [in] BSTR out_unit, [out,
retval] double * out_value
ConvertAny Converts a quantity given as [in_value, in_units] to
[in] BSTR quantity_name, [in] double an out_unit
in_value, [in] BSTR in_unit, [in] BSTR
out_unit, [out, retval] double *
out_value
ConvertStrictSIToCurrentUnits Converts a quantity given as [value] in strict SI to an
[in] BSTR quantity_name, [in] double out_unit defined according to the units file
value, [in] BSTR out_unit, [out, retval] imported using ImportUnitFile. By default it will
double * out_value be Eng units if no unit file has been imported
ConvertToDefEng Converts a quantity given as [in_value, in_units] to
[in] BSTR quantity_name, [in] double the PIPESIMs default engineering unit for that
value, [in] BSTR value_unit, [out] BSTR quantity.
*eng_unit, [out, retval] double
*eng_value
ConvertToDefSI Converts a quantity given as [in_value, in_units] to
[in] BSTR quantity_name, [in] double the PIPESIMs default SI unit for that quantity.
value, [in] BSTR value_unit, [out] BSTR Please note that default SI is not necessarily equal
*si_unit, [out, retval] double * si_value to strict SI.
ConvertToStrictSI Converts a quantity given as [in value, in units] to
[in] BSTR quantity_name, [in] double the strict SI unit for that quantity. Please note that
value, [in] BSTR value_unit, [out] BSTR default SI is not necessarily equal to strict SI
*si_unit, [out, retval] double *si_value
DisplayUnitDialog Displays the graphical user interface for unit system
[in] VARIANT_BOOL selection.
bShowFileOptions, [in]
VARIANT_BOOL bShowDeaultOptions,
[out] VARIANT * pVar
GetDefEngUnitString Returns the default engineering unit string for a
[in] BSTR quantity name, [out, retval] given quantity.
BSTR * unit string
GetDefSIUnitString Returns the default SI unit string for a given
[in] BSTR quantity_name, [out, retval] quantity.
BSTR * unit_string
GetLastError Returns an error description. This method should
[out, retval] BSTR * ErrorStr be called immediately after a function has returned
an error code.
GetStrictSIUnitString Returns the strict SI unit string for a given quantity.
[in] BSTR quantity name, [out, retval]
BSTR * unit_string

PIPESIM
Schlumberger 86 Open Link

GetUnitStrings Returns an array of unit strings defined for the

[in] BSTR quantity name, [out] given quantity.
VARIANT * pVar
GetUnknownValue Returns PIPESIMs definition of unset or
[out, retval] double *pVal unknown value.
ImportUnitFile [in] BSTR filename Imports a saved units file (saved by default with a
.unf extension)
IReal Interface
UnitClass Gets/sets unit class name
string
SetRealValue Sets a Value in the specified unit string
[in] double Value, [in] BSTR Unit
GetRealVal Returns a value in the units corresponding to pUnit
[out] double * pValue, [out] BSTR *
pUnit
SetSelectedUnit Selects the given unit string
[in] BSTR UnitStr, [out, retval]
VARIANT_BOOL
GetSelectedUnit Returns the selected unit string
[out, retval] BSTR * UnitStr
GetDefEngValue Returns the value in default engineering units
[out, retval] double * Val
GetStrictSIValue Returns the value in strict SI units
GetUserValue Returns the value in user selected units
SetStrictSIValue Sets a Value in strict SI units

PIPESIM
Schlumberger 87 Open Link

Defined constants and strings

Object Type Identifiers
Object ID Object Type Description
1 n_FOLD (network folder)
2 (network source)
n_SOURCE
3 n_SINK (network sink)
4 n_JUNC (network junction)
5 n_BRANCH (network branch)
6 n_TEXT (text object)
7 n_PRODWELL (network production well)
8 n_INJWELL (network injection well)
30 n_REINJECTOR (network reinjector)
31 n_WELLCONNECTOR (network well connector)

Object ID Object Type Description

10 n_PINTSOURCE (single branch source)
11 n_PINTVERTCOMP (Vertical Comp.)
12 n_PINTHORCOMP (Horizontal Comp.)
13 n_FLOWLINE (Flowline)
14 n_RISER (Riser)
15 n_CONNECTOR (Zero length connector)
16 n_TUBING (Tubing)
17 n_NODE (generic node)
18 n_CHOKE (choke)
19 n_COMPRESSOR (compressor)
20 n_EXPANDER (expander)
21 n_HEATX (heat exchanger)
22 n_PUMP (centrifugal pump)
23 n_BOOSTER (multiphase booster)
24 n_INJECTOR (injection point)
25 n_SEPARATOR (separator)
26 n_REPORT (report tool)
27 n_ADDMULT (adder/multiplier)
28 n_NAPOINT (nodal analysis point)
29 n_EKT (engine keyword tool)
32 n_SSSV (SSSV, tubing sub-component)
33 n_GLValve (Gas Lift valve, subcomponent)
34 n_BLACKBOX (Generic equipment type)
Object Properties
Vertical Completion objects properties
Common properties
Property name Description
PRESSURE Static reservoir pressure
TEMPERATURE Reservoir temperature
IPRTYPE Completion model type (see IPR Types
(Vertical))

PIPESIM
Schlumberger 88 Open Link

Well PI specific properties

Property name Description
WELLPI FLUIDTYPE Fluid type for the model (see Fluid Types)
WELLPI GASPI Gas PI
WELLPI LIQPI Liquid PI
WELLPI NONLINEARCORRECTION Use Vogel below bubble point (for liquid)
Vogels Equation specific properties
Property name Description
VOGEL AOFP Absolute Open Flow Potential
VOGEL N Vogel coefficient
Fetkovitchs Equation specific properties
Property name Description
FETKOVITCH AOFP Open Flow Potential
FETKOVITCH N n exponent
Joness Equation specific properties
Property name Description
JONES FLUIDTYPE (see Fluid Types) Fluid type for the model (see Fluid Types)
JONES GASA A (turb) coefficient for Gas
JONES GASB B (lam) coefficient for Gas
JONES LIQA A (turb) coefficient for Liquid
JONES LIQB B (lam) coefficient for Liquid
BackPressure Equation specific properties
Property name Description
BACKPRESSURE C Constant C
BACKPRESSURE N Slope n
Pseudo Steady State specific properties
Property name Description
PSEUDOSS IPRBASIS Fluid type for the model (see Fluid Types)
PSEUDOSS USEPSEUDOPRES Use pseudo pressure method (for gas)
PSEUDOSS VOGEL Use Vogel below bubble point (for liquid)
PSEUDOSS THICKNESS Reservoir thickness
PSEUDOSS WELLBOREID Wellbore diameter
PSEUDOSS PERMEABILITY Reservoir permeability
PSEUDOSS DEFRADIUS Use Drainage radius (if set)
PSEUDOSS DRAINRADIUS Drainage radius
PSEUDOSS RESAREA Reservoir area
PSEUDOSS SHAPEFACTOR Shape factor
PSEUDOSS SKIN Mechanical skin
PSEUDOSS RATESKIN GAS Rate dependent skin for gas
PSEUDOSS RATESKIN LIQ Rate dependent skin for liquid
PSEUDOSS CALCSKIN Calculate Mechanical skin (if set)
PSEUDOSS CALCRATESKIN Calculate Rate dependent skin (if set)
PSEUDOSS COMPOPTIONS Completion options type
PSEUDOSS DAMAGEDID Damaged zone diameter
PSEUDOSS DAMAGEDPERM Damaged zone permeability
PSEUDOSS COMPACTEDID Compacted zone diameter
PSEUDOSS COMPACTEDPERM Compacted zone permeability
PSEUDOSS GRAVELPERM Gravel pack permeability
PSEUDOSS GRAVELTUNNEL Gravel pack tunnel length
PSEUDOSS GRAVELCASINGID Gravel pack casing ID
PSEUDOSS GRAVELSCREENSZ Gravel pack screen diameter

PIPESIM
Schlumberger 89 Open Link

PSEUDOSS COMPVERTPERM Completion vertical permeability

PSEUDOSS COMPINTERVAL Completion open interval
PSEUDOSS COMPDEVIATION Completion deviation
PSEUDOSS PERFSKINMETHOD Perforation skin method (0 for McLeod, 1 for
Karakas/Tariq)
PSEUDOSS PERFID Perforation diameter
PSEUDOSS PERFLENGTH Depth of penetration
PSEUDOSS PERFSHOTDENSITY Perforation density
PSEUDOSS PERFPHASEANG Phase angle
PSEUDOSS FPSKINMETHOD FracPack skin method (0 for Fracture
properties, 1 for conductivity)
PSEUDOSS FPFRACHALFLEN Fracture half length
PSEUDOSS FPFRACWIDTH Fracture width
PSEUDOSS FPPROPPERM Fracture proppant permeability
PSEUDOSS FPCOND FracPack conductivity
PSEUDOSS FPFACESKINCALC Include Frac Face skin (if set)
PSEUDOSS FPDAMAGEDEPTH Frac Face Depth of damage
PSEUDOSS FPDAMPERM Frac Face Damage permeability
PSEUDOSS FPCHOKESKINCALC Include Choke Fracture skin (if set)
PSEUDOSS FPCHOKELENGTH Choke length
PSEUDOSS FPCHOKEPERM Frac choke permeability
PSEUDOSS DZSKINCALC Include damaged zone skin (if set)
PSEUDOSS GPSKINCALC Include gravel pack skin (if set)
PSEUDOSS PFSKINCALC Include perforation skin (if set)
PSEUDOSS PPDSKINCALC Include partial penetration/deviation skin (if
set)
PSEUDOSS FPSKINCALC Include FracPack skin (if set)
Forchheimers Equation specific properties
Property name Description
FORCH A A (lam) coefficient
FORCH F F (turb) coefficient
Hydraulic Fracture specific properties
Property name Description
HYDFRACT IPRBASIS Fluid type for the model (see Fluid Types)
HYDFRACT VOGEL Use Vogel below bubble point (for liquid)
HYDFRACT PERMEABILITY Reservoir permeability
HYDFRACT THICKNESS Reservoir thickness
HYDFRACT DRAINRADIUS Drainage radius
HYDFRACT WELLBOREID Wellbore diameter
HYDFRACT FRACTLENGTH Fracture half length
HYDFRACT FRACTPERM Fracture permeability
HYDFRACT FRACTWIDTH Fracture width
HYDFRACT TRANSIENT Use transient parameters (if set)
HYDFRACT TIME Time
HYDFRACT POROSITY Porosity
HYDFRACT COMPRESS Total compressibility
Transient specific properties
Property name Description
TRANSIENTIPR IPRBASIS Fluid type for the model (see Fluid Types)
TRANSIENTIPR USEPSEUDOPRES Use pseudo pressure method (for gas)
TRANSIENTIPR VOGEL Use Vogel below bubble point (for liquid)
TRANSIENTIPR PERMEABILITY Reservoir permeability

PIPESIM
Schlumberger
TRANSIENTIPR THICKNESS
TRANSIENTIPR DRAINRADIUS
TRANSIENTIPR WELLBOREID
TRANSIENTIPR TIME
TRANSIENTIPR POROSITY
TRANSIENTIPR COMPRESS
TRANSIENTIPR SKIN
TRANSIENTIPR RATESKIN GAS
TRANSIENTIPR RATESKIN LIQ
TRANSIENTIPR CALCSKIN
TRANSIENTIPR CALCRATESKIN
TRANSIENTIPR COMPOPTIONS
TRANSIENTIPR DAMAGEDID
TRANSIENTIPR DAMAGEDPERM
TRANSIENTIPR COMPACTEDID
TRANSIENTIPR COMPACTEDPERM
TRANSIENTIPR GRAVELPERM
TRANSIENTIPR GRAVELTUNNEL
TRANSIENTIPR GRAVELCASINGID
TRANSIENTIPR GRAVELSCREENSZ
TRANSIENTIPR COMPDEVIATION
TRANSIENTIPR PERFSKINMETHOD
TRANSIENTIPR COMPINTERVAL
TRANSIENTIPR COMPVERTPERM
TRANSIENTIPR PERFID
TRANSIENTIPR PERFLENGTH
TRANSIENTIPR PERFSHOTDENSITY
TRANSIENTIPR PERFPHASEANG
TRANSIENTIPR DZSKINCALC
TRANSIENTIPR GPSKINCALC
TRANSIENTIPR PFSKINCALC
TRANSIENTIPR PPDSKINCALC
FCV properties
Property name
FCV VALVETYPE
FCV GENERICVALVETYPE
FCV CHOKEEQUATION
FCV EQCHOKEARIA
FCV MAXLIQRATE
FCV MAXGASRATE
FCV LIQCOEFF
FCV GASCOEFF
FCV PRESSDROP
FCV MANUFACTURER
FCV TYPE
FCV PARTNUMBER
FCV VALVEPOSITION
FCV VALVEPERSENTOPEN
PIPESIM
90 Open Link
Reservoir thickness
Drainage radius
Wellbore diameter
Time
Porosity
Total compressibility
Mechanical skin
Rate dependent skin for gas
Rate dependent skin for liquid
Calculate Mechanical skin (if set)
Calculate Rate dependent skin (if set)
Completion options type
Damaged zone diameter
Damaged zone permeability
Compacted zone diameter
Compacted zone permeability
Gravel pack permeability
Gravel pack tunnel length
Gravel pack casing ID
Gravel pack screen diameter
Completion deviation
Perforation skin method (0 for McLeod, 1 for
Karakas/Tariq)
Completion open interval
Completion vertical permeability
Perforation diameter
Depth of penetration
Perforation density
Phase angle
Include damaged zone skin (if set)
Include gravel pack skin (if set)
Include perforation skin (if set)
Include partial penetration/deviation skin (if
set)
Description
FCV type: 0 generic, 1-specific
(manufactured)
Generic FCV type: 0 equivalent choke area,
1 maximum rate through valve
Gas choke equation: 0 mechanistic
Equivalent choke area
Maximum liquid rate through valve
Maximum gas rate through valve
Liquid flow coefficient
Gas flow coefficient
Pressure drop ratio factor
FCV manufacturer
FCV type (munufacturers specific)
FCV partnumber
Valve postion
Valve percent open
Schlumberger 91 Open Link

Tubing objects properties

Common properties
Property name Description
ACTIVATE Make tubing active
TUBING MODEL Tubing model (0: simple, 1 detailed)
LIFT TYPE Artificial Lift type (0: Gas Lift, 1: ESP)
KICKOFF ANGLE Kick Off angle
KICKOFF TVD Kick Off TVD
PERFS MD Perforation MD
PERFS TEMPERATURE Reservoir Temperature
PERFS TVD Perforation TVD
SURFACE TEMPERATURE Surface temperature
SURFACE TVD Surface TVD
COILED TUB MD Coiled tubing bottom MD
COILED TUB RATE OPTION Coiled tubing rate option (0 for gas rate, 1 for
GLR)
COILED TUB RATE Coiled tubing gas rate
COILED TUB GLR Coiled tubing GLR
COILED TUB SPECIFIC GRAVITY Coiled tubing specific gravity
COILED TUB ID Coiled tubing ID
COILED TUB SURFACE PRESSURE Coiled tubing gas rate surface pressure
COILED TUB OD Coiled tubing OD
Tubing sub-object properties
(accessed by GetPropertyValAtObjectIndex& SetPropertyValAtObjectIndex methods)
Property name Description
CHOKE
CHOKE MD Choke MD
BEAN SIZE Bean size

Property name Description

PUMP
ESP MD ESP MD (simple profile)
ESP STAGES Number of stages (simple profile)
ESP SPEED ESP speed (simple profile)
ESP MANUFACTURER Manufacturer name (simple profile)
ESP MODEL Model name (simple profile)
ESP EFFICIENCY ESP efficiency (simple profile)
ESP GASSEPARATOR Gas separator present (if set) (simple profile)
ESP SEPEFFICIENCY Separator efficiency (simple profile)
ESP MD NODE Same as ESP MD but for detailed profile
ESP STAGES NODE Same as ESP STAGES but for detailed profile
ESP SPEED NODE Same as ESP SPEED but for detailed profile
ESP MANUFACTURER NODE Same as ESP MANUFACTURER but for
detailed profile
ESP MODEL NODE Same as ESP MODEL but for detailed profile
ESP EFFICIENCY NODE Same as ESP EFFICIENCY but for detailed
profile
ESP GASSEPARATOR NODE Same as ESP GASSEPARATOR but for
detailed profile
ESP SEPEFFICIENCY NODE Same as ESP SEPEFFICIENCY but for
detailed profile

PIPESIM
Schlumberger 92 Open Link

Property name Description

INJECTOR
GAS LIFT RATE OPTION
GAS LIFT RATE
GAS LIFT GLR
GAS LIFT MD
GAS LIFT PORT DIAMETER
GAS LIFT PVTFILE
GAS LIFT PVTTYPE
GAS LIFT SPECIFIC GRAVITY
GAS LIFT SURFACE PRESSURE
GAS LIFT SURFACE TEMPERATURE
GAS LIFT RATE OPTION NODE
GAS LIFT RATE NODE
GAS LIFT GLR NODE
GAS LIFT MD NODE
GAS LIFT PORT DIAMETER NODE
GAS LIFT PVTFILE NODE
GAS LIFT PVTTYPE NODE
GAS LIFT SPECIFIC GRAVITY NODE
GAS LIFT SURFACE PRESSURE NODE
GAS LIFT SURFACE TEMPERATURE NODE
Gas lift rate option (0 for gas rate, 1 for GLR)
(simple profile)
Gas lift gas rate (simple profile)
Gas lift tubing GLR (simple profile)
Gas lift MD (simple profile)
Gas lift port diameter (simple profile)
Composition file name (simple profile)
Composition type (0 for local composition, 1
for local PVT, 2 for global PVT, 3 for local
MFL) (simple profile)
Gas lift specific gravity (simple profile)
Surface pressure (simple profile)
Surface temperature (simple profile)
Same as GAS LIFT RATE OPTION but for
detailed profile
Same as GAS LIFT RATE but for detailed
profile
Same as GAS LIFT GLR but for detailed
profile
Same as GAS LIFT MD but for detailed profile
Same as GAS LIFT PORT DIAMETER but for
detailed profile
Same as GAS LIFT PVTFILE but for detailed
profile
Same as GAS LIFT PVTTYPE but for detailed
profile
Same as GAS LIFT SPECIFIC GRAVITY but
for detailed profile
Same as GAS LIFT SURFACE PRESSURE but
for detailed profile
Same as GAS LIFT SURFACE
TEMPERATURE but for detailed profile

Property name Description

SEPARATOR
SEPARATOR MD Separator MD
EFFICIENCY Efficiency
TYPE Type (see Separator Types)

Property name Description

SSSV
SSSV MD SSSV MD (simple profile)
SSSV ID SSSV ID (simple profile)
SSSV MD NODE Same as SSSV MD but for detailed profile
SSSV ID NODE Same as SSSV ID but for detailed profile

Property name Description

GLValve
VALVE MD Valve MD
VALVE AB Valve Ab

PIPESIM
Schlumberger 93 Open Link

VALVE AP Valve Ap
VALVE CHOKESIZE Choke size
VALVE CV Valve Cv
VALVE PORTSIZE Port size
VALVE PTRO Valve Ptro
VALVE MANUF Manufacturer name
VALVE SERIES Series name
VALVE PORTNAME Port name
VALVE TYPE Valve type
VALVE DPFO Valve Dpfo

Property name Description

Tubing (pipe section)
PIPE AMB TEMPERATURE Pipe ambient temperature (simple profile)
PIPE FLOWTYPE Flow type (see Pipe Flow Types) (simple
profile)
PIPE ID Pipe ID (simple profile)
PIPE MD Pipe MD (simple profile)
PIPE OD Pipe OD (simple profile)
PIPE ROUGHNESS Pipe roughness (simple profile)
PIPE WT Pipe wall thickness (simple profile)
PIPE AMB TEMPERATURE NODE Same as PIPE AMB TEMPERATURE
but for detailed profile
PIPE FLOWTYPE NODE Same as PIPE FLOWTYPE but for detailed
profile
PIPE ID NODE Same as PIPE ID but for detailed profile
PIPE MD NODE Same as PIPE MD but for detailed profile
PIPE OD NODE Same as PIPE OD but for detailed profile
PIPE ROUGHNESS NODE Same as PIPE ROUGHNESS but for detailed
profile
PIPE WT NODE Same as PIPE WT but for detailed profile
Artificial Lift
Lift Value Description
0 No artificial lift
1 Gas lift injection
2 ESP
Completion Options
Type Value Description
0 None
1 Open hole
2 Perforated
3 Gravel packed and perforated
4 Open hole gravel pack
5 Frac pack
IPR Types (Vertical)
Type Value Description
0 Well PI
1 Vogel
2 Fetkovitch
3 Jones

PIPESIM
Schlumberger 94 Open Link

4 BackPressure
5 PseudoSteadyState
6 Forchheimer
7 Hydraulic Fracture
8 Transient
IPR Types (Horizontal)
Type Value Description
0 Joshi (Oil)

1 Joshi (Gas)
2 Babu & Odeh (Oil)
3 Babu & Odeh (Gas)
4 Distributed PI
IPR Options (Horizontal)
Type Value Description
0 Distributed PI
1 Single Point PI
Fluid Types
Type Value Description
0 Liquid Rate
1 Gas Rate
2 Mass Rate
Pipe Flow Types
Type Value Description
0 Tubing
1 Annular
2 Tubing+Annular
Rate Types
Type Value Description
0 GLR
1 GOR
2 LGR
3 OGR
Separator Types
Type Value Description
0 Liquid
1 Gas
2 Water
Single Branch Operations
Operation Value Operation Name
-1 No Operation
0 System Analysis
1 Pressure and Temp Profile
2 Nodal Analysis
3 Injection Gas Vs Casing Head Pressure
4 Horizontal Well Performance
5 Reservoir Tables

PIPESIM
Schlumberger 95 Open Link

6 Artificial Lift
7 Flow Correlation Profile Match
8 (Reserved)
9 Wax Deposition
10 Well Performance Curves
11 Gas Lift - Diagnostics
12 Gas Lift - Deepest Injection Point
13 Gas Lift - Lift Gas Response
14 Gas Lift - Bracketing

PIPESIM
Schlumberger 96 Open Link

Unit System
Quantity Name Class Name Defined Unit Names
(* def.Engineering, ^ def.SI, ! strict SI)
ADIM UNITLESS
UNITLESS
AGASRATE ACFM *,
ft3/min, acm/s ^, m3/s!, m3/min, bbl/min,
bbl/d,
m3/d ,
AREA AREA in2 *,
mm2 ^,
m2 ! , acres
AREAL AREA EARTH ft2 *. m2 ^!, acres, mi2, ha, km2
SURFACE
COMPRESS COMPRESSIBILITY 1/psia *,
COMPRESSIBILITY 1/bara ^,
1/Pa !
CONDUCTIVITY THERMAL Btu/hr/ft/F *,
THERMALCOUCTIVITY CONDUCTIVITY W/m/K !^

DELTAP PRESSURE Psi *,

PRESSUREDROP (DELTA) Bar ^, atm, kPa, kg/cm2,
Pa!
DELTAT TEMPERATURE F *,
(DELTA) C! ^, K, R,
DENSITY DENSITY LIQUID lb/ft3 *,
kg/m3! ^,
g/cc,
DISTGASPI SPECIFIC Mmscf/d/psi2/ft *,
DISTRIBUTEDGASPI PRODUCTIVITY mmsm3/d/bar2/m ^, msm3/d/kPa2/m,
INDEX (GAS PER sm3/s/Pa2/m!
LENGTH)
DISTLIQPI SPECIFIC STB/d/psi/ft *,
DISTRIBUTEDLIQPI PRODUCTIVITY sm3/d/bar/m ^, sm3/d/kPa/m,
INDEX (LIQ PER sm3/s/Pa/m!
LENGTH)
ENTHALPY ENERGY PER MASS Btu/lb *,
(ENTHALPY) J/g ^,
J/kg!
ENTROPY SPECIFIC Btu/lb/F *,
ENTROPY J/g/K ^,
J/kg/K!
FLOWGLRATIO STD VOLUME PER scf/bbl *, sm3/m3 ^!
VOLUME (GLR)
FRACTION RATIO (%) % *! ^
fract.,
GASPI SPECIFIC Mmscf/d/psi2 *,
PRODUCTIVITY mmscf/d/kPa2, mmsm3/d/bar2 ^,
INDEX (GAS) msm3/d/kPa2, 1.E4sm3/d/MPa2,
m3/s/Pa2!

PIPESIM
Schlumberger 97 Open Link

GASRATE STD VOLUME GAS Mmscf/d *,

RATE Mscf/d, scf/d, mmsm3/d ^, msm3/d,
sm3/d, 1.E3sm3/d, 1.E4sm3/d,
sm3/s!
GASRATE(FLOWING) FLOW RATE Mmcf/d *,
VOLUME BASIS mcf/d, cf/d, mmm3/d ^, mm3/d, m3/d,
(GAS) 1.E3m3/d, 1.E4m3/d, m3/s!
GASRATERECIP STD VOLUME GAS 1/mmscf/d *, 1/mscf/d, 1/scf/d, 1/mmsm3/d,
RATE 1/msm3/d, 1/sm3/d, 1/1.E3sm3/d,
(RECIPROCAL) 1/1.E4sm3/d, 1/sm3/s!
GOR VOLUME PER Scf/STB *,
GLR VOLUME (GLR) sm3/sm3! ^
HEAD ENERGY PER MASS ft-lbf/lbm *,
COMPRESSORHEAD (HEAD) kJ/kg ^, J/kg!
JONESGASA (JONES A GAS) (psi/mmscf/d)^2 *,
(bar/mmsm3/d)^2 ^,
(Pa/sm3/s)^2!
(bar/msm3/d)^2
JONESGASB (JONES B GAS) psi2/mmscf/d *,
bar2/mmsm3/d ^,
Pa2/sm3/s!
bar2/msm3/d
JONESLIQA (JONES A LIQ) psi/(STB/d)^2 *,
bar/(sm3/d)^2 ^,
Pa/(sm3/s)^2!
JONESLIQB (JONES B LIQ) psi/STB/d *,
bar/sm3/d ^,
Pa/sm3/s!
LENGTH LENGTH Inches *,
DIAMETER, ID, OD, WT, SHORTRANGE ft, miles, mm ^, cm, m!, km, 1/64in,
LENGTH(SHORT)
LENGTHL LENGTH Ft *,
LENGTH(LONG) MIDRANGE Miles, m! ^, km,
LIQPI SPECIFIC STB/d/psi *,
PRODUCTIVITY STB/d/kPa, sm3/d/bar ^, sm3/d/kPa,
INDEX (LIQ) sm3/d/MPa, sm3/s/Pa!
LIQRATE STD VOLUME STB/d *,
LIQUID RATE sm3/d ^,
sm3/s!
LIQRATE(FLOWING) FLOWRATE bbl/d *,
VOLUME BASIS m3/d ^, m3/s!
(LIQ)
LIQRATERECIP STD VOLUME 1/STB/d, 1/sm3/d, 1/sm3/s
LIQUID RATE
(RECIPROCAL)
MASS MASS Lb *, Kg! ^
MASSRATE FLOWRATE MASS lb/s *,
BASIS lb/h, kg/s! ^, kg/h,
MOLARVOLUME SPECIFIC VOLUME ft3/mol *,
MOLE m3/mol! ^
OGR VOLUME PER STB/mmscf *,
LGR VOLUME (LGR) sm3/mmsm3 ^, sm3/msm3, sm3/1.E4sm3,
m3/E3m3, sm3/sm3!

PIPESIM
Schlumberger 98 Open Link

PERMEABILITY PERMEABILITY Md *^,

Darcy, nm2,
M2 !
POWER POWER Hp *,
KW ^, Btu/s, kcal/s, Btu/h, kcal/h,
W!
PRESSURE PRESSURE Psia *,
Psig, bara ^, barg, atma, atmg, kPa a, kPa g,
MPa a, MPa g, kg/cm2 a, kg/cm2 g, Pa a!, Pa
g,
PRESSUREGRAD PRESSURE psi/ft *,
PRESSUREGRADIENT GRADIENT bar/m ^, atm/m, kPa/m, kg/cm2,
Pa/m!
ROTVELOCITY FREQUENCY Hz *! ^
FREQUENCY Rpm,
SHOTS PER LENGTH Shots/ft *,
Shots/m! ^
SURFTENSION SURFACE TENSION Dyne/cm *,
SURFACETENSION N/m! ^
TEMPERATURE TEMPERATURE F *,
C! ^, K, R,
TIME TIME Hr *^,
Min, s!, days, years
U HEAT TRANSFER Btu/hr/ft2/F *,
HEATTRANSFERCOEFFI COEFFICIENT W/m2/K! ^
CIENT
VELOCITY VELOCITY ft/s *,
m/s! ^
VISCOSITY VISCOSITY Cp *^
DYNAMIC Ns/m2 ! , lb/s/ft,
VOLFRAC VOLUME PER STD Bbl/mmscf *,
VOLUMEFRACTION VOLUME M3/mmsm3 ^, m3/sm3!
VOLUME VOLUME (LIQUID) ft3 *, m3! ^
VOLUME GAS VOLUME (GAS) ft3 *, m3! ^
NOTE: The keyword _STRICTSI in place of the unit name will set or get a value in the strict SI
unit.

PIPESIM
Schlumberger 99 Open Link

Case Studies
Detailed explanation of routine
The Open Link functionality is distributed with the PIPESIM installation and is contained in a
number of library files. The main file is Net32COM.DLL, which normally resides in the programs
directory and provides the framework and main entry points into both network and single branch
simulation models. Two other files are FluidModelCOM.DLL and FlowCorrelationCOM.DLL, which
provide access to properties defined in the fluid and flow correlation models respectively.
Pre-Loop Steps
Step 1

Dim Bo as New FLUIDMODELCOMLib.IblackOil

Dim Obj as New NET32COMLib.IsingleBranchModel
These statements define the variables Bo and Obj as a black oil object and a Single branch model
object respectively.
A Single Branch Model Object corresponds to the Single Branch Model Interface.
Dim x, n, TempAmb, TempSurf as Integer
This statement let the computer know that the variables x ,n, TempAmb, TempSurf used in the
program are integer. (It is good programming practice to declare all variables used in a program at
the beginning of the listing).

PIPESIM
Schlumberger 100 Open Link

Step 2:
TempAmb = Cells(11,4).value
If TmpAmb = then
Exit Sub
End If
This assigns the value located in the cell cells(11,4) to the Integer variables TempAmb.
Step 3:
PathTemplate = cells(8,1)
If PathTemplate = Then
Exit Sub
End If
Assign the template path specified by the user in the spreadsheet to the variable PathTemplate.
Step 4:
Path = Cells(9,1).Value
If Path = Then
Exit Sub
End If
Assign the Path specified by the user in the spreadsheet to the variable Path.
This is the path where the .bps files that the routine creates are stored.
Step 5:
case1 = ActiveCell.Row
cases = Selection.Rows.Count
lastcase = case1 + cases 1
This statement allows us to loop on the selected rows by assigning the index of the top row to the
variable case1 and the index of the last row 1 to the variable lastcase.

PIPESIM
Schlumberger 101 Open Link

Loop Steps
Step 6:
For n = case1 to lastcase
This statement initiates a loop that will be executed from the value case1 to the value last case.
Step 7:
Obj.OpenModel PathTemplate
This statement is equivalent to doing the following things: From the PIPESIM singlebranch object
interface (Reminder: Object Obj is a single branch object), go to the menu File, select Open Model
and open the model PathTemplate (which is a string defined in the spreadsheet)
Although the PIPESIM windows is not visible after the statement is executed the model is opened
and can be altered.
Step 8:
Bo.GasSg = Cells(n,5)




Obj.BlackOil =Bo

PIPESIM
Schlumberger 102 Open Link

The first statement assign to the gas standard gravity field in the BlackOil interface Bo the value
corresponding to the cells (n,5). It is the cell (3,5) during the first loop and the cell (4,5) in the
second loop.
There are also some conditional statements. The first of those states that if the water cut is above
95% then the value in the blackoil object must be 95.
The second one states that if the GOR is superior to 1000000 then assign an OGR of 0 to the
blackoil object instead of the actual GOR value.
The last statement assigns to the single branch object Obj the black oil properties of the Blackoil
object Bo.

Step 9,10,11,12:
These statements fill the different GUI (Graphical User Interface) objects making up the
SingleBranchObject (that is the completion object, the tubing object, the choke object and the
flow line object).
For example the statement:
Obj.SetPropertyVal Tubing_1, Pipe WT, 0.5, inches
Assigns the value 0.5 to the wall thickness of the tubing object of Template.bps.
The more general statement could be written as:
Obj.SetPropertyVal name of the object(string), name of the field in the object(string), value to be
assigned to that field(double), Units to be used(string)

PIPESIM
Schlumberger 103 Open Link

Step 13: Saving the Template with another name

The statement
Obj.SaveModel Path & Stationname & _ & Wellname & .bps
saves the model Template.bps under a new name in the folder specified in the string variable Path.
Step 14: Restart Loop
The statement Next n indicates to Visual Basic for Application to go back to the statement for n =
case1 to lastcase and to redo the code for a different value of n (that is the next well).
This will happen until n = lastcase (last selected row).

PIPESIM