Pipesim Manual

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


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


PNSReaderCOM ..................................................................................................................................... 77 Inflow Performance Calculator COM .................................................................................................. 83 Units Library ........................................................................................................................................... 85

Defined constants and strings ........................................................................................................................... 87 Object Type Identifiers .......................................................................................................................... 87 Object Properties ................................................................................................................................... 87 Tubing object’s 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


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


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

ISingleBranchModel IObjectProperties TubingObj InjectorObj VertCompObj FlowlineObj ErosionCorrosion HeatTransfer

Network models and operations Single branch models and operations Generic equipment properties Tubing specific properties and operations Injector specific properties Vertical completion specific properties Flowline specific properties and operations Erosion and corrosion settings Heat transfer properties

PSOpSystems.DLL IISystemsAnalysis IIPTProfile IICorrMatching

Systems Analysis operation Pressure/Temp Profiles operation Flow Correlation Matching operation

NodalOp.DLL IINodalAnal Nodal Analysis Operation FluidModelCOM.DLL IBlackOil

ICompositional SinglePointCalib MultiPointCalib ViscosityData Thermal

Black Oil model properties Compositional model properties BO single point calibration properties BO multipoint calibration properties BO viscosity properties 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


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


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


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, let’s 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


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


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


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


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


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


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


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


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


PIPESIM


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


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


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


PIPESIM


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


Plot of Man2_436

PIPESIM


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,

pNameArray, Count As Long) 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.

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 Long, ParentType As Long, ParentObject As String, EquipmentNames, Count As Long)

If ParentObject string is empty, the function is the same as GetNameList (…). See GetNameList

(…) 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

Long, ObjectName As String, Lift As Long) 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

• GetStartBoundaryObject (ObjectType As Long, ObjectName As String)

Returns the ObjectType (See GetNameList (…)) and its name of the upstream-most object in the single branch model.

PIPESIM


• GetCountObjectsInProfile (Count As Long)

Returns the number of objects in the single branch model

• GetObjectAtIndex (Index As Long, ObjectType As Long, ObjectName As String)

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.

• GetLastError (ErrorStr As String) Returns the last error message produced by the interface.

• GetIsModelRunning () As Boolean Returns Boolean value True if the simulation process is active

• GetOperationInterface (pIOperation As Object)

Returns the operation object

• GetOperationType () As Long Returns Long value as the operation defined for the model. See Defined constants and strings

• GetPropertyNames (ObjectName As String, PropNames) as Long

Returns in PropNames the list of properties defined for the object ObjectName. Returns the number of properties as function’s return value

• GetPropertyVal (ObjectName As String, PropName As String, pValue As Double, pUnitStr As String) As Boolean

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.

• GetPropertyValAtObjectIndex (ObjectName As String, PropName As String, pValue As Double, pUnitStr As String, SubObjectType As Long, Index As Long) As Boolean

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

• GetPropertyStringAtObjectIndex (ObjectName As String, PropName As String, pValue As String, Index As Long) As Boolean

The function is similar to GetPropertyValAtObjectIndex but for properties defined as string

• GetPropertyType (ObjectName As String, PropName As String) As Long

Returns the property type: UNDEFINED -1 REAL 0 (value in strict SI units) INT 1 DOUBLE 2 STR 3

• GetSensitivityInfo (ObjectType As Long, ObjectName As String, VariableNames, ItemReference)

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)

• GetSensitivityVariables (ObjectName As String, VariableNames, StdQtyNames) As Long

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

PIPESIM


ISingleBranchModel object - Set Methods • SetOperationInterface (pIOperation As

Unknown) pIOperation: The interface instance to an operation object. This function assigns the given operation to the opened single branch model

• SetOperationType (OperationType As Long)

Sets the operation type for the single branch model. See Defined constants and strings

• SetPropertyVal (ObjectName As String, PropName As String, value As Double, UnitStr As String) As Boolean

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.

• SetPropertyStringAtObjectIndex (ObjectName As String, PropName As String, value As String, Index As Long) As Boolean

As SetPropertyValAtObjectIndex (…) but for properties defined as string

• SetPropertyValAtObjectIndex (ObjectName As String, PropName As String, value As Double, UnitStr As String, SubObjectType As Long, Index As Long) As Boolean

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.

• SetPVTFile (bstrPVTFilename As String) Sets the compositional file (.pvt) to be used as the main fluid in the simulations

• SetUnitManager (p_VarUnitManager) Sets the Unit Manager object ISingleBranchModel object - Properties • BlackOil As Object Gets/sets the Black Oil fluid definition object • Composition As Object Gets/sets the fluid composition object • FlowCorrelation As Object Gets/sets the Flow Correlation object • Fluid As FluidModel Gets/sets the FluidModel object (See

IFlowlineObj Interface) • FluidModelType As Long Gets/sets the fluid type (0: black oil, 1:

compositional, 2: PVT file, 3: MFL file) • GasLiftDesign As Object Gets/sets the Gas Lift Design object • GasLiftSystemProps As Object Gets/sets the Gas Lift System Properties object • ObjectProperties (ObjectName As String)

As ProfileObj 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.

• ProjectInfo As ProjectInfo Returns the ProjectInfo object to access project specific data

• ProjectPath As String Sets full path name to the model file • FieldSurvey As Object Gets/sets the FieldSurvey object • ErosionCorrosion As Object Gets/sets the ErosionCorrosion object • Keywords As String Gets/sets the additional engine keywords

PIPESIM


ISingleBranchModel object - Operations • ExportEngineFiles () 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.

• ExportEngineFiles2 (operationfile As String) As String

In addition to ExportEngineFiles (), this function returns the full pathname to the exported file (.psm) and its associated operation file (.inc)

• ExportEngineFiles3 (nExpertMode As Long)

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

• KillSimulationProcess () Terminates the simulation process • NewModel (bstrModelFileName As String,

ProfileTypesList, ProfileNamesList) As Boolean

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

• OpenModel (bstrModelFileName As String)

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.

• RunSingleBranchModel (bRestart As Boolean)

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.

• RunSingleBranchModel2 (bRestart As Boolean, EngSwitches As String, DynamicPlot As Boolean)

Similar to SetOperationInterface, it also accepts one or more switches to be passed to the simulation engine and turns dynamic plotting on/off.

• RunSingleBranchModel3 (bRestart As Boolean, EngSwitches As String, DynamicPlot As Boolean, ExpertExtensions As Boolean)

Similar to SetOperationInterface2, it also allows using of the Expert extensions

• SaveModel (bstrPathName As String) As Boolean

Saves the currently opened model to a file given by bstrPathName. Function returns True if model is saved, otherwise the return value is False.

• ValidateTubingConfiguration(MaxInjTVD As Double) As Boolean

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.

PIPESIM


• SetOutpoutUnits(nUnits As Integer) As Boolean

This function forces the output to be written in specified units (0 – model’s 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

Long Returns in PropNames the array of properties defined for the object. Function’s return value is the number of properties

PIPESIM


• GetValue (PropName As String, pValue, pUnitStr As String, Index As Long) As Boolean

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’.

ProfileObj object - Set Methods • SetValue (PropName As String, value,

UnitStr As String, Index As Long) As Boolean

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’.

ITubing Interface TubingObj Object - Get Methods • GetCountDownholeEquipment (Type

As Long) As Long 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)

• GetCountTubingSection () As Long Similar to GetCountDownholeEquipment, but specific to tubing sections

• GetDeviationSurvey_SI (Type As Long) As Variant

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

• GetDownholeEquipment (Type As Long, Index As Long, label As String) As Double

Returns the md (as function’s 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.

• GetDownholeEquipmentAtIndex (Index As Long, Type As Long, label As String) As Double

Returns the equipment type, label and md (as function’s return value) in strict SI units at a given Index. See GetDownholeEquipment for definition of Index

PIPESIM


• GetGeothermalSurvey_SI (vbIsTVD As Boolean) As Variant

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

• GetTubingSection (Index As Long, label As String) As Double

Similar to GetDownholeEquipment, but specific to tubing sections

• GetMDatTVD_SI (tvd As Double) As Double

Returns the md given the tvd based on the deviation survey

• GetTVDatMD_SI (md As Double) As Double

Returns the tvd given the md based on the deviation survey

• GetInputOK (info As String) As Boolean

Validates the tubing data and returns True if configuration is correct, otherwise the function returns False and info contains the error message

TubingObj Object -Set Methods • SetDeviationSurvey_SI (Type As

Long, Survey) As Boolean 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).

• SetGeothermalSurvey_SI (vbIsTVD As Boolean, Survey) As Boolean

Sets a geothermal survey to a detailed tubing model. See GetGeothermalSurvey_SI for definition of Survey and vbIsTVD.

TubingObj Object -Properties • InjectionPointFluid (Index As Long)

As FluidModel Gets/sets the FluidModel object for the injection point at a given index. This function is only applicable for compositional models. See ISinglePointCalib object.

• RemedialCoiledTubingEnabled As Boolean

Enables/disables Remedial Coiled Tubing option in configuration

TubingObj Object - Operations • AddDownholeEquipment (Type As

Long, md_SI As Double, label As String) As Long

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 item’s label Function returns the 0 based positional index of the added item. Index = 0 refers to the top-most item closest to the wellhead

• 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

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.

PIPESIM


• AddTubingSection (BottomMD_SI As Double, label As String) As Long

Adds a section of tubing BottomMD_SI: the bottom md of the section in strict SI units label: the item’s label Function returns the 0 based positional index of the added section

• ClearGasLiftValves () Removes all gas lift valves from the tubing • RemoveDownholeEquipment (Type

As Long, Index As Long) 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

• RemoveTubingSection (Index As Long)

Similar to RemoveDownholeEquipment but applicable to tubing sections

• DisplayDialog (p_VarUnitManager, fluidtype As Integer) As Boolean

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

IVertCompObj Interface VertCompObj Object - Get Methods • GetInputOK (info As String) As

Boolean Validates the flowline data and returns True if configuration is correct, otherwise the function returns False and info contains the error message

VertCompObj Object - Set Methods • SetMultipoint(value As Long) As

Boolean Set either multipoint=1 or isochronal=0 type of IPR data table

• SetIPRFluidType(Type As Long) As Boolean

Set fluid type for IPR: type_liquid=0, type_gas=1

• SetIPRTable_SI(QPPoints) As Boolean 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

• GetConingTableData(IsUsed As Boolean, ConedGasSG As Double, Flowrate, GOR, WCut) As Boolean

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

VertCompObj Object - Operations • CalculateIPR() As Boolean

PIPESIM


• DisplayDialog (p_VarUnitManager) As Boolean

Function invokes Vertical Completion configuration dialog and returns True if OK button was clicked, False otherwise. Pass a Null variant as the argument’s value.

IFlowlineObj Interface FlowlineObj Object - Properties • HeatTransfer As Object Gets/sets HeatTransfer object FlowlineObj Object - Get Methods • GetInputOK (info As String) As

Boolean Validates the flowline data and returns True if configuration is correct, otherwise the function returns False and info contains the error message

FlowlineObj Object - Operations • AddProfileNode_SI (distance As

Double, elevation As Double, ambientT As Double, uValue As Double, label As String)

Adds a node to the flowline detailed node description. All values must be given in strict SI units.

• ClearDetailedProfile () Deletes all nodes in the flowline detailed profile • UseDetailedProfile (UseDetailed As

Boolean) UseDetailed = True: instructs the flowline to use the detailed profile description. UseDetailed = False: use the flowline’s simple description, detailed nodes will be generated automatically.

• DisplayDialog (p_VarUnitManager) As Boolean

Function invokes flowline configuration dialog and returns True if OK button was clicked, False otherwise. Pass a Null variant as the argument’s value.

• GetNodesCount () As Long Function returns a number of nodes defined in a detailed profile

• GetPipeOD (od as Double, units as String)

Function calculates pipe’s OD based on coating properties

IHeatTransfer Interface HeatTransfer Object - Properties • UValueType As Long 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

• IsIFCIncluded As Boolean Gets/sets a Boolean value for inside filem coefficient. True if IFC is included in U Value and False if it is calculated separately.

• AmbientFluidType As Long Gets/sets an ambient fluid type. 0 for air and 1 for water.

HeatTransfer Object - Get Methods • GetUValue (uVal as Double, units as

String) Returns U Value and units string. Fails if UValueType is set to calculated

• GetPipeConductivity (dblVal as Double, units as String)

Returns pipe conductivity value and units string. Fails if UValueType is not calculated

• GetAmbientFluidVelosity (dblVal as Double, units as String)

Returns ambient fluid velocity value and units string. Fails if UValueType is not calculated

• GetBurialDepth (dblVal as Double, units as String)

Returns pipe burial depth value and units string. Fails if UValueType is not calculated

• GetGroundConductivity (dblVal as Double, units as String)

Returns ground conductivity value and units string. Fails if UValueType is not calculated

PIPESIM


• GetCoatingData_SI (varData) 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

HeatTransfer Object - Set Methods • SetUValue (uVal as Double, units as

String) Sets U Value in specified units. Fails if UValueType is set to calculated

• SetPipeConductivity (dblVal as Double, units as String)

Sets pipe conductivity value in specified units. Fails if UValueType is not calculated

• SetAmbientFluidVelosity (dblVal as Double, units as String)

Sets ambient fluid velocity value in specified units. Fails if UValueType is not calculated

• SetBurialDepth (dblVal as Double, units as String)

Sets pipe burial depth value in specified units. Fails if UValueType is not calculated

• SetGroundConductivity (dblVal as Double, units as String)

Sets ground conductivity value in specified units. Fails if UValueType is not calculated

• SetCoatingData_SI (varData) 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

IFluid Interface FluidModel Object - Properties • Composition As Object Accesses the ICompositional object (See

ISinglePointCalib object) • BlackOil As Object Accesses the IBlackOil object (Ref IBlackOil ) • FluidModelType As Long Retrieves the fluid model type: 0: BlackOil, 1:

Compositional, 2 PVT File, 3 MFL File • OverrideValues As Boolean Sets/gets whether Wcut/GOR values are overridden

from the values defined in the fluid model. • WCutoverride_SI As Double Accesses the watercut override value • GORoverride_SI As Double Accesses the GOR override value • OGRoverride_SI As Double Accesses the OGR override value • LGRoverride_SI As Double Accesses the LGR override value • GLRoverride_SI As Double Accesses the GLR override value • GORoverride_Type As Integer Accesses which GOR type is being overridden

(0=GLR, 1=GOR, 2=LGR, 3=OGR) • IsLocalFluid As Boolean Sets/gets whether the object is using a local fluid

model • CompositionType As Long Sets/gets whether the local composition is a PVT

file or a defined PIPESIM composition or local MFL file

• FluidName As String Sets/gets a fluid name FluidModel Object - Get Methods • GetInputOK (info As String) As

Boolean Validates the fluid model data and returns True if configuration is correct, otherwise the function returns False and info contains the error message

FluidModel Object - Operations • DisplayDialog (p_VarUnitManager) As

Boolean Function invokes fluid configuration dialog and returns True if OK button was clicked, False otherwise. Pass a Null variant as the argument’s value.

PIPESIM


IProjectInfo Interface ProjectInfo Object - Properties • Description As String Gets/sets string property • User As String Gets/sets string property • Job As String Gets/sets string property • Company As String Gets/sets string property • Manager As String Gets/sets string property • Remarks As String Gets/sets string property • Date As String Gets/sets string property • Field As String Gets/sets string property • WellNumber As String Gets/sets string property • Lease As String Gets/sets string property • Country As String Gets/sets string property • Address As String Gets/sets string property • Email As String Gets/sets string property • Phone As String Gets/sets string property • Fax As String Gets/sets string property

IErosionCorrosion Interface ErosionCorrosion Object - Properties • CalculatePH As Long Gets/sets value for Actual pH property (1 –

calculate value, 0 – use user-defined pH value) • CorrosionEfficiency As Double Gets/sets corrosion efficiency value • CorrosionModel As Long Gets/sets value for Corrosion Model property (0 –

none, 1 – use de Waard (1995) model ) • ErosionEfficiency As Double Gets/sets erosion efficiency value • ErosionModel As Long Gets/sets value for Erosion Model property (0 –

API 14e model, 1- SALAMA (2000)) • ErosionRate_Eng As Double Gets/sets acceptable erosion rate value • ErosionVelocityConst As Double Gets/sets erosion velocity constant value • GeometryConstant As Double Gets/sets geometry constant value • SandGrainSize_Eng As Double Gets/sets sand grain size value • SandProdRatio As Double Gets/sets sand production ratio value • UserDefinedPH As Double Gets/sets user-defined pH value 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 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

PIPESIM


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

as String) as Boolean Returns true if custom data has been stored against the KeyName string

• GetNameList (ObjectType As Long, pNameArray, Count As Long)

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.

ObjectType can be any of: 1 - Folder 2 - Source 3 - Sink 4 - Junction 5 - Branch 6 - Text Object 7 - Production Well 8 – Injection Well

• GetHasArtificialLift (ObjectType As Long, ObjectName As String, Lift As Long)

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

• GetEquipmentInfo (EquipmentType As Long, ParentType As Long, ParentObject As String, EquipmentNames, Count As Long)

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


• GetLastError (ErrorStr As String) Returns the last error message produced by the interface

• GetBoundaryProperties (ObjectName As String, Pressure As Double, Temperature As Double, Fluidrate As Double, Fluidtype As Long)

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

• GetBoundaryProperties_SI (ObjectName As String, Pressure As Double, Temperature As Double, Fluidrate As Double, fluidtype As Long)

Similar to GetBoundaryProperties except that this function returns the properties in strict SI units.

• GetBoundaryBlackOil (ObjectName As String, BlackOil As Object) As Boolean

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

• GetBoundaryComposition (ObjectName As String, Composition As Object) As Boolean

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

• GetBoundaryCompositionType (ObjectName As String, Type As Long)

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

• GetBoundaryPVTFile (ObjectName As String, PVTFilename As String) As Boolean

Gets the PVT file used by the source with identifier ObjectName. Only applicable for Compositional/PVT models

• GetBoundaryType (ObjectName As String, Type As Long, CurveOption As Long)

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

• GetCountObjectsInProfile (NetObjectName As String) As Long

Returns the number of objects in the single branch model defined for NetObjectName.

• GetIsModelRunning () As Boolean Returns True if simulation is running • GetPropertyNames (ObjectName As

String, ParentName As String, PropNames) As Long

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

• GetPropertyVal (ObjectName As String, ParentName As String, PropName As String, pValue As Double, pUnitStr As String) As Boolean

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


constants and strings• GetPropertyValAtObjectIndex

(ObjectName As String, ParentName As String, PropName As String, pValue As Double, pUnitStr As String, SubObjectType As Long, Index As Long) As Boolean

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

• GetPropertyStringAtObjectIndex

(ObjectName As String, ParentName As String, PropName As String, pValue As String, Index As Long) As Boolean

The function is similar to GetPropertyValAtObjectIndex (…) but for properties defined as string

• GetSingleBranchModel (NetObjectName As String) As ISingleBranchModel

Returns the ISingleBranchModel object for the NetObjectName specified

• GetNamesInFolder(FolderName As String, ObjectType As Long, pNameArray, Count As Long)

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

• GetNodeCooordinates(ObjectName As String, pCoordArray) As Boolean

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

• GetConnectionInfo(pBranchArray, pSNodeArray, pENodeArray) As Boolean

Returns the array of all branch names, the array of starting nodes and the array of ending nodes for those branches

• GetBoundaryCurveFile(ObjectName As String) As String

Returns the offline curve file name for the specified well name

• GetCustomData(KeyName As String, pValue) As Boolean

Returns a variant byte array of the custom data that has been stored against the supplied KeyName string

• GetCustomKeys(pKeyNameArray) As Boolean

Returns an array of the KeyNames strings for which custom data has been stored

• GetFlowrateLimits_SI(ObjectName as String) As Variant

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.

INetModel Interface - Set Methods • SetBoundaryBlackOil (ObjectName

As String, BlackOil As Object) As Boolean

Sets a BlackOil object to a given source. The function returns True in case of success and False otherwise

• SetBoundaryComposition (ObjectName As String, Composition As Object) As Boolean

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

• SetBoundaryCurveFile (ObjectName As String, CurveFileName As String) As Boolean

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


object identified by ObjectName must be a Production Well.

• SetBoundaryFluidrate (ObjectName As String, Fluidtype As Long, value As Double, UnitStr As String)

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

• SetBoundaryPressure (ObjectName As String, value As Double, UnitStr As String)

Sets the given value in the given units as pressure boundary condition for source object ObjectName.

• SetBoundaryPVTFile (ObjectName As String, PVTFilename As String) As Boolean

Sets a PVT file to a given source. PVTFilename must contain the full path to a PVT file

• SetBoundarySourcePQPoints (ObjectName As String, PQPoints, fluidtype As Long, PressureUnits As String, FlowrateUnits As String) As Boolean

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.

• SetBoundaryTemperature (ObjectName As String, value As Double, UnitStr As String)

Sets the given value in the given units as temperature boundary condition for source object ObjectName.

• SetBoundaryType (ObjectName As String, Type As Long, CurveOption As Long)

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 (…))

• SetPropertyVal (ObjectName As String, ParentName As String, PropName As String, value As Double, UnitStr As String) As Boolean

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.

• SetPropertyValAtObjectIndex (ObjectName As String, ParentName As String, PropName As String, value As Double, UnitStr As String, SubObjectType As Long, Index As Long) As Boolean

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.

• SetPropertyStringAtObjectIndex (ObjectName As String, ParentName As String, PropName As String, value As String, Index As Long) As Boolean

Similar to SetPropertyValAtObjectIndex (…) except that PropName is a string type property.

• SetPVTFile (bstrPVTFilename As Sets the compositional file (.pvt) to be used as the

PIPESIM


String) main fluid in the simulations • SetSingleBranchModel

(NetObjectName As String, filename As String) As Boolean

Sets the underlying single branch model by way of its associated .bps file to a network object.

• SetCustomData(KeyName As String, pValue) As Boolean

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

• SetFlowrateLimits_SI(ObjectName as String, Limits)

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.

INetModel Interface - Properties • BlackOilDefault As Object Gets/sets the default BlackOil model to/from a

BlackOil object • CompositionDefault As Object Gets/sets the default composition to/from a

Composition object • FlowCorrelation As Object Gets/sets the flow correlation properties to/from a

FlowCorrelation object • FluidModelType As Long 0: BlackOil, 1: Compositional, 2: PVT File, 3: MFL File • LocalFluid (ObjectName As String) As

FluidModel Gets/sets the Fluid object for the specified object (ObjectName)

• ModelFileName As String Returns the file path of the current model • ModelBuilder As ModelBuilder Returns a ModelBuilder object - see ModelBuilder • ProjectInfo As ProjectInfo Get the ProjectInfo object to access project specific

data • ErosionCorrosion As Object Gets/sets the ErosionCorrosion object • UseNetErCorrSettings As Long Gets/sets the flag value to use network erosion &

corrosion settings over local branches settings (if = 1) or to use local settings overwise

• BottomKeywords As String Gets/sets the network engine keywords to be added at bottom of tnt file

• TopKeywords As String Gets/sets the network engine keywords to be added on top of tnt file

• AppVersion As String Gets the version of PIPESIM INetModel Interface - Operations • ExportEngineFiles () 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.

• KillSimulationProcess () Terminates the simulation process • OpenModel (bstrModelFileName As

String) 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


• RunNetwork (bRestart As Boolean) 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.

• RunNetwork2 (bRestart As Boolean, EngSwitches As String)

Similar to RunNetwork and also accepts one or more switches to be passed to the simulation engine.

• SaveModel (bstrPathName As String) As Boolean

Saves the currently opened model to a file given by bstrPathName

• ResetLocalErCorrSettings() As Boolean

Overrides all local erosion and corrosion settings with the global ones

ModelBuilder object • SetNodeCoordinates (NodeName As

String, X As Long, Y As Long) Sets the node coordinates for node object NodeName to X, Y coordinates

• TopLeftCoordinate_X As Long Sets/returns the top left X coordinate of the graphical panel. SetNodeCoordinates values are passed in relation to TopLeftCoordinate_X and

TopLeftCoordinate_Y

• TopLeftCoordinate_Y As Long As above for the Y coordinate

• BottomRightCoordinate_X As Long Returns the bottom right X coordinate of the graphical panel (this is a read-only property)

• BottomRightCoordinate_Y As Long As above for the Y coordinate

• GetNodeCoordinates (NodeName As String, X As Long, Y As Long)

Gets the node X, Y coordinates for node object NodeName

• GetLastError () As String Returns the last error message produced by the object

IBlackOil object IBlackOil object - Properties • API As Double API value • ConingEnabled As Boolean True/False • ConingGasSG As Double Coning gas specific gravity • ConingRateType As Long 0: liquid, 1: gas, 2: mass • ConingTable_SI As Variant A 3-column array with rate, gor/glr, wcut values, use

strict SI units • GasSG As Double Black oil specific gravity • GLR_SI As Double Gas/Liquid Ratio use strict SI units • GOR_SI As Double Gas/Oil Ratio use strict SI units • GOR_Type As Integer (0=GLR, 1=GOR, 2=LGR, 3=OGR) • LGR_SI As Double Liquid/Gas Ratio use strict SI units • OGR_SI As Double Oil/Gas Ratio use strict SI units • SolutionGasCorrelation As Long 0 = Lasater, 1 = Standing, 2 = Vazquez and Beggs, 3 =

Glaso, 4 = Kartoatmodjo • Watercut As Double Water Cut • WaterSG As Double Water specific gravity • Name As String Name of the fluid • Comment As String String containing the text in the comments field • Calibration As Long Calibration type: 0 – no calibration, 1 – single point

and 2 - multipoint • SinglePointCalib As Object Single point calibration data object • MultiPointCalib As Object Multipoint calibration data object

PIPESIM


• Viscosity As Object String containing the text in the comments field • ThermalData As Object String containing the text in the comments field • Contaminants As Variant Array of Doubles for contaminant values in a

following order: CO2, H2S, N2, H2 and CO IBlackOil object - Methods • SetBubblePointCalibration

(SatGas_SI As Double, Pressure_SI As Double, Temperature_SI As Double)

Sets the bubble point data

• GetBubblePointCalibration (Pressure_SI As Double, Temperature_SI As Double) As Double

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

IBlackOil object - Operations • SetBlob (sBlob As String) Sets data for the required fluid

sBlob = String containing black oil information

ISinglePointCalib object ISinglePointCalib object – Get Methods • GetCalibrationAtBubblePoint

(Pressure_SI As Double, Temperature_SI As Double, SatGas_SI As Double) as Long

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

• GetCalibrationAboveBubblePoint

(OFVF As Double, Density_SI as Double, Compressibility_SI as Double, Pressure_SI As Double, Temperature_SI As Double) as Long

Function gets calibration data above bubble point. The return value is density type: 0 for Density, 1 for OFVF or 3 for Compressibility

• GetCalibrationBelowBubblePoint

(OFVF As Double, Density_SI as Double, Pressure_SI As Double, Temperature_SI As Double) as Long

Function gets calibration data below bubble point. The return value is density type: 0 for Density or 1 for OFVF

• GetLiveOilViscBelowBubblePoint

(Pressure_SI As Double, Temperature_SI As Double, LiveOilVisc_SI) as Long

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

• GetGasViscBelowBubblePoint

(Pressure_SI As Double, Temperature_SI As Double) as Double

Function gets gas viscosity data below bubble point. The return value is gas viscosity.

• GetGasZBelowBubblePoint (GasZ as Double, Pressure_SI As Double, Temperature_SI As Double) as Long

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.

ISinglePointCalib object – Set Methods • SetCalibrationAtBubblePoint

(SolGasCorr as Long, Pressure_SI As Double, Temperature_SI As Double, SatGas_SI As Double)

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

• SetCalibrationAboveBubblePoint

(DensType as Long, OFVF As Double, Density_SI as Double, Compressibility_SI as Double,

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


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)

Function sets calibration data above bubble point. The acceptable values for density type are: 0 for Density or 1 for OFVF

• SetLiveOilViscBelowBubblePoint

(LiveOilCorr as Long, Pressure_SI As Double, Temperature_SI As Double, LiveOilVisc_SI)

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

• SetGasViscBelowBubblePoint

(Pressure_SI As Double, Temperature_SI As Double, GasVisc_SI as Double)

Function sets gas viscosity data below bubble point.

• SetGasZBelowBubblePoint

(GasZCorr as Long, GasZ as Double, Pressure_SI As Double, Temperature_SI As Double)

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.

IMultiPointCalib object IMultiPointCalib object – Properties • OFVF as Boolean True for Oil FVF or False for Oil Density IMultiPointCalib object – Get Methods • GetCalibUnits (UnitsArray) Function returns an array of Strings containing units

for Pressure, Solution Gas GOR, Oil Density, Oil Viscosity and Gas Viscosity

• GetCorrelations (CorrArray) 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

• GetTemperature (Value As Double, Units as String)

Function returns a calibration temperature and units.

• GetCalibrationAtBubblePoint

(CalibData) 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

• GetCalibrationAboveBubblePoint

(CalibData) 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

• GetCalibrationBelowBubblePoint

(CalibData) 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

IMultiPointCalib object – Set Methods • SetCalibUnits (UnitsArray) Function sets units for Pressure, Solution Gas GOR,

Oil Density, Oil Viscosity and Gas Viscosity supplied as an array of Strings

PIPESIM


• SetCorrelations (CorrArray) 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

• SetTemperature (Value As Double Units as String)

Function sets a calibration temperature in specified units.

• SetCalibrationAtBubblePoint

(CalibData) 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

• SetCalibrationAboveBubblePoint

(CalibData) 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

• SetCalibrationBelowBubblePoint

(CalibData) 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

IViscosityData object IViscosityData object – Properties • DeadOilCorr as Long 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

• LiveOilCorr as Long 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

• EmulViscosity as Long 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

• UsatOilViscosity as Long 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

IViscosityData object – Get Methods • GetDOPoints (Temp1 as Double,

Temp2 as Double, TUnits as String, Visc1 as Double, Visc2 as Double, VUnits as String)

Function returns temperature and viscosity values for Dead Oil for user-specified 2-point Dead Oil Viscosity Correlation

• GetUserViscTable_SI (Table) Function returns a two-column array of Doubles

PIPESIM


containing values for Temperature and Viscosity for user-supplied table Dead Oil Viscosity Correlation

• GetUserEmulTable_SI (Type as Long, Table)

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.

• GetWCutCutoff (Method as Long, WCut As Double, Units as String)

Function returns a watercut cutoff method (0 for user-defined or 1for Brauner & Ullman) and a cutoff value and units .

• GetEmulCoeffs (Method as Long, Coeff1 as Double, Coeff2 as Double)

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.

• GetKouzelCoeffs (ParA as Double, ParB as Double)

Function returns Kouzel coefficients for Undersaturated Oil Viscosity

IViscosityData object – Set Methods • SetDOPoints (Temp1 as Double,

Temp2 as Double, TUnits as String, Visc1 as Double, Visc2 as Double, VUnits as String)

Function sets temperature and viscosity values for Dead Oil for user-specified 2-point Dead Oil Viscosity Correlation

• SetUserViscTable_SI (Table) Function sets a user-supplied table for Dead Oil Viscosity Correlation passing a two-column array of Doubles containing values for Temperature and Viscosity.

• SetUserEmulTable_SI (Type as Long, Table)

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.

• SetWCutCutoff (Method as Long, WCut As Double, Units as String)

Function sets a watercut cutoff method (0 for user-defined or 1for Brauner & Ullman) and a cutoff value in specified units.

• SetEmulCoeffs (Method as Long, Coeff1 as Double, Coeff2 as Double)

Function sets user-supplied coefficients for corresponding emulsion viscosity method. Method must be 9 for Vand with user-supplied coefficients or 10 for Richardson.

• SetKouzelCoeffs (ParA as Double, ParB as Double)

Function sets Kouzel coefficients for Undersaturated Oil Viscosity

IThermal object IThermal object – Get Methods • GetConductivity (Values, Units as

String) Function returns an array of 3 Doubles containing Gas, Oil and Water thermal conductivity values and a units string

• GetEnthropy (Values, Units as String) Function returns an array of 3 Doubles containing Gas, Oil and Water heat capacity values and a units string

ISinglePointCalib object – Set Methods • SetConductivity (Values, Units as

String) Function sets values for Gas, Oil and Water thermal conductivities passed as an array of 3 Doubles in specified units

• SetEnthropy (Values, Units as String) Function sets values for Gas, Oil and Water heat capacities passed as an array of 3 Doubles in specified units

PIPESIM


ICompositional object ICompositional object - Properties • Name As String Name of the fluid ICompositional object - Get Methods • GetComment () As String Returns a string containing the text in the comments

field • GetPackage () As Boolean Returns the compositional package description, 0 =

Multiflash and 1 = SIEP’s SPPTS • GetPackageType () As Long Returns the Compositional Package Type to use as

long integer according to the following formula: 0 = SIS Flash, 1 = Multiflash, 2 = SPPTS.

• GetComponentList GetComponentList (pVart, pVar, pVar2, HydComp1 As Long, AquComp1 As Long) As Long

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

• GetLibraryComptBP (pVar) Returns the boiling points of the library components set by SetLibraryComptCalculator. pVar = list of boiling points as an array of doubles.

• GetLibraryComptMW (pVar) Returns the molecular weight of the library components set by SetLibraryComptCalculator. pVar = list of molecular weights as an array of doubles.

• GetLibraryComptOM (pVar) Returns the acentric factors of the library components set by SetLibraryComptCalculator. pVar = list of acentric factors as an array of doubles.

• GetLibraryComptPC (pVar) Returns the critical pressures of the library components set by SetLibraryComptCalculator. pVar = list of critical pressures as an array of doubles.

• GetLibraryComptSG (pVar) Returns the specific gravities of the library components set by SetLibraryComptCalculator. pVar = list of specific gravities as an array of doubles.

• GetLibraryComptTC (pVar) Returns the critical temperatures of the library components set by SetLibraryComptCalculator. pVar = list of critical temperatures as an array of doubles.

• GetLibraryList (pVar) As Long 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.

• GetMolarList (pVar) As Long 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.

• GetMolWeightList (pVar) As Long 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


• GetBoilingPointList (pVar) As Long 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.

• GetSpecificGravityList (pVar) As Long

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.

• GetCriticalPressureList (pVar) As Long

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

• GetCriticalTemperatureList (pVar) As Long

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.

• GetAcentricFactorList (pVar) As Long

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.

ICompositional object - Set Methods • SetComment (sComment As String) Sets a string in the comments field of the

compositional description 1 . • SetPackage (sPackage As Boolean) Sets the compositional package description, False =

Multiflash and true = SIEP’s SPPTS. • SetPackageType (lPackageType As

Long) 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

• SetComponentList (pVar, CompNum As Long, pVar2, CompNum2 As Long)

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 .

• SetMolarList (pVar, CompNum As Long)

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

• SetLibraryList (pVar, CompNum As Long)

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

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


• SetLibraryComptCalculator (pVar, CompNum As Long)

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.

• SetMolwtList (pVar, CompNum As Long)

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.

• SetPvtFile SetPvtFile (sFile As String)

Calls the compositional pvt file reader to read the inputted pvt file.

• SetBoilingPointList (pVar, CompNum As Long)

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

• SetSpecificGravityList (pVar, CompNum As Long)

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

• SetCriticalPressureList (pVar, CompNum As Long)

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

• SetCriticalTemperatureList (pVar, CompNum As Long)

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.

• SetAcentricFactorList (pVar, CompNum As Long)

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

ICompositional object - Operations • CreateNewComposition () Blanks all compositional arrays and parameters in

memory

PIPESIM


• UpdateComposition () Updates all compositional arrays and parameters in memory

• SetBlob (sBlob As String) Sets data for the required composition sBlob = String containing compositional information 3 .

FlowCorrelations Interface CIFlowCorrelation object - Get Methods • GetHorizontalCorrelationName ()

As String Returns the horizontal correlation name. The returned string is a unique keyword name.

• GetHorizontalSourceName () As String

Returns the correlation’s source name (such as bja, tulsa)

• GetVerticalCorrelationName () As String

Returns the vertical correlation name. The returned string is a unique keyword name (for example ANSAR, BJA, BBR, BBOTD)

• GetVerticalSourceName () As String Returns the correlation’s source name (such as bja, tulsa)

• GetSensitivityItems (VerticalCorrs As Boolean, Items) As Long

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 function’s return value

CIFlowCorrelation object - Set Methods • SetHorizontalCorrelation (sSource

As String, sCorrelation As String) 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

• SetHorizUserCorrelation (sSource As String, sCorrelation As String)

Set a horizontal user correlation

• SetVerticalCorrelation (sSource As String, sCorrelation As String)

Set a vertical source and correlation. For example for the Tulsa correlation source it can be any of: TBB, TDR, TGA, THB, TMB, TORK

• SetVertUserCorrelation (sSource As String, sCorrelation As String)

Set a vertical user correlation

CIFlowCorrelation object - Properties • SwapAngle As Double Vertical-Horizontal Correlation Swap Angle • HorizontalFrictionFactor As Double Horizontal Friction Factor • VerticalFrictionFactor As Double Vertical Friction Factor • VerticalHoldup As Double Vertical Holdup • HorizontalHoldup As Double Horizontal Holdup • SinglePhaseCorrelation As String Any of: Moody, AGA, Pan-A, Pan-B, HazWill,

Weymouth, CULSMITH Note: See the PIPESIM help for the complete list of available vertical and horizontal flow correlations and sources. CIFlowCorrelation object - Operations • DisplayDialog () Displays PIPESIM dialog for flow correlation (this

method is obsolete, use DisplayDialog2 instead). • DisplayDialog2 () As Boolean Displays PIPESIM dialog for flow correlation ().

Return value is True if data is changed and False otherwise

3 The compositional data is provided by the call to the Ipnscom Interface

PIPESIM


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 operation’s 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 String

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.

• SensitivityVariable (indx As Long) As String

indx: the sensitivity box indx. Pass –1 for the X-axis 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 operation’s 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


• GetSensitivityData_SI (indx As Long, ObjectStr As String, VarStr As String, Values_SI, QuantClass As String)

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

ISystemsAnalysis Object - Set Methods • SetSensitivityData (indx As Long,

ObjectStr As String, VarStr As String, Values_DefEng, vbActive As Boolean)

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)

• SetSensitivityData_SI (indx As Long, ObjectStr As String, VarStr As String, Values_SI, vbActive As Boolean, QuantClass As String)

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.)

• SetLanguage (nlLanguageID As Long) As Boolean

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

ISystemsAnalysis Object - Operations • WriteOperationFile () As Boolean Writes an ASCII file (modelname.inc) containing the

instructions to the simulation engine to run the operation.

• DisplayDialog (p_VarUnitManager, CloseOK As Boolean)

Displays the operations graphical interface. Pass a Null variant as the first argument. Returns True if dialog box was closed OK, otherwise False.

PIPESIM


Pressure and Temperature Profiles IPTProfile Object - Properties • BoundaryConds As IBoundaryProps Get/set property to access boundary conditions. See

the definition of ‘IBoundaryProps’ for its methods and properties

• Engine As IEngineOptions Gets the IEngineOptions object to set simulation parameters and run the operation. See ‘IEngineOptions’ 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

• EnableSurveyOpts As Boolean Gets/sets whether survey data is used for profile plotting

• ProfileType As Long 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

• SensitivityObject (indx As Long) As String

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.

• SensitivityVariable (indx As Long) As String

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.

IPTProfile Object - Get Methods • GetIsUnset () As Boolean Returns true if the operation’s data is all blank (unset) • GetLastError () As String Returns an error description after function call


• GetSensitivityData_SI (ObjectStr As String, VarStr As String, Values_SI, QuantClass As String)

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.

IPTProfile Object - Set Methods • SetSensitivityData (ObjectStr As

String, VarStr As String, Values_DefEng)

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


• SetSensitivityData_SI (ObjectStr As String, VarStr As String, Values_SI, QuantClass As String)

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.

• SetSurveyData_SI (SurveyName As String, SurveyDate As Date, Var_MD_Pres_Temp)

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

IPTProfile Object - Operations • WriteOperationFile () As Boolean Writes an ASCII file (modelname.inc) containing the




Flow Correlation Matching ICorrMatching object - Properties • BoundaryConds As IBoundaryProps Get/set property to access boundary conditions. See

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

• EnableSurveyOpts As Boolean Gets/sets whether survey data is used for profile plotting

• ProfileType As Long 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

ICorrMatching object - Get Methods • GetIsUnset () As Boolean Returns true if the operation’s data is all blank (unset) • GetLastError () As String Returns an error description after function call


PIPESIM


• GetSelectedCorrelation

(IsVertical As Boolean, EngineCodes) 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

ICorrMatching object - Set Methods • SetSurveyData_SI (SurveyName As

String, SurveyDate As Date, Var_MD_Pres_Temp)

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

• SetSelectedCorrelation (helpStr As String, engineCode As String, mainCode As String, IsVertical As Boolean, IsSelected As Boolean)

Set or removes selection for the correlation specified by engineCode depending on IsSelected value IsVertical = True for vertical correlations, False for horizontal.



ICorrMatching object - Operations • WriteOperationFile () As Boolean Writes an ASCII file (modelname.inc) containing the




Nodal Analysis INodalAnal Object - Properties • CFactor As Double Sets a Constant C value • EngineSwitch As String Sets/gets extra command line arguments for the

PIPESIM engine • FetkovichExp As Double Sets a Fetkovich n exponent value • FixedInjectionDepths As Boolean Applicable to gas lifted systems, this property

sets/gets whether gas lift valves are installed in the tubing

• FutureAOFP As Double Sets a future AOFP value • FutureIPR As Boolean Sets a flag whether to use Future IPR option (True

by default) • IncludeFilePath As String The full path name to the engine’s operation file • InflowCurveRangeLimit As Boolean Allow the inflow curves to extend to the AOFP (true) • InflowObject As String Returns/sets the inflow object name • InflowVariable As String Returns/sets the inflow variable name • MaxPressureForOutflow_SI As

Double Maximum pressure for the outflow curves

• MaxRate_SI As Double The maximum fluidrate in strict SI units • MaxRateFluidType As Long The maximum fluid rate type: 0: liquid, 1: gas, 2 mass

PIPESIM


• NumberInflowPoints As Long The number of points on each inflow curve • NumberOutflowPoints As Long The number of points on each outflow curve • OutflowCurveRangeLimit As Boolean Allow the outflow curves to extend to the supplied

maximum flowrate • OutflowObject As String Returns/sets the outflow object name • OutflowVariable As String Returns/sets the outflow variable name • OutletPressure_SI As Double Gets/sets the outlet pressure in strict SI units • 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) • ReservoirPressure As Double Set a reservoir pressure. Used for future AOFP

calculations • RunEngineMinimised As Long Runs the engine in a minimised window • RunPlotToolWithEngine As Long If True (1) shows the plotting tool (PSPlot) as the

simulation runs INodalAnal Object - Get Methods • GetIsEngineActive (p_bActive As

Long) Returns True (1) if the PIPESIM engine is running, otherwise False (0)

• GetIsUnset GetIsUnset (pVar As Long) Returns True (1) if the operation’s data is all blank (unset)

• GetLastError (errorStr As String) Returns an error description after function call failure. Must be called immediately after the call to the failed function.

• GetSensitivityData_SI (InflowOutflow As Long, ObjectStr As String, VarStr As String, Values_SI, QuantClass As String)

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.

INodalAnal Object - Set Methods • SetSensitivityData_SI

(InflowOutflow As Long, ObjectStr As String, VarStr As String, Values_SI, QuantClass As String)

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.



INodalAnal Object - Operations • KillOperation () Terminates the engine run • RunOperation () Runs the simulation

PIPESIM


• WriteOperationFile (bOK As Boolean) Writes an ASCII file containing the instructions to the simulation engine to run the operation.

• DisplayDialog (p_VarUnitManager) Displays the operations graphical interface. Pass a NULL variant as the first argument. This method is obsolete. Use DisplayDialog2

method instead • DisplayDialog2 (p_VarUnitManager,

bCloseOK As Boolean) Displays the operations graphical interface. Pass a Null variant as the first argument. Returns true if dialog box was closed OK, otherwise false.

Wax Deposition IWaxOp Object - Properties • RunEngineMinimised As Boolean Runs the engine in a minimised window • RunPlotToolWithEngine As Boolean If True (1) shows the plotting tool (PSPlot) as the

simulation runs • PsmFilePath As String The full path to the model file (.psm file) • PlotToolPath As String The full path to the plotting tool (PSPlot) • IncludeFilePath As String The full path name to the engine’s operation file • PipesimEnginePath As String The full path to the PIPESIM engine • EngineSwitch As String Sets/gets extra command line arguments for the

PIPESIM engine • WaxProperties As Variant IWaxOp Object - Get Methods • GetLastError() As String Returns an error description after function call


• GetIsUnset() As Boolean Returns True (1) if the operation’s data is all blank (unset)

• GetIsEngineActive() As Boolean Returns True (1) if the PIPESIM engine is running, otherwise False (0)

IWaxOp Object - Set Methods • SetLanguage(nlLanguageID As Long)

As Boolean 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

IWaxOp Object - Operations • DisplayDialog(p_VarUnitManager As

Variant) Displays the operations graphical interface. Pass a NULL variant as the first argument. This method is obsolete. Use DisplayDialog2

method instead • DisplayDialog2(p_VarUnitManager As

Variant) As Boolean Displays the operations graphical interface. Pass a Null variant as the first argument. Returns true if dialog box was closed OK, otherwise false.

• RunOperation(); Runs the simulation • KillOperation(); Terminates the engine run • WriteOperationFile() As Boolean Writes an ASCII file containing the instructions to the

simulation engine to run the operation. IWaxOp2 Object - Properties • WaxMethod As Integer WaxMethod can be one of the following values:

0: Shell;

PIPESIM


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 engine’s 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


actual throughputs for each valve. Uses Thornhill & Craver equation

• GetArrayInjectionPressure(pVar) Returns in pVar an array of Doubles with the injection pressure at each valve depth

• GetArrayInjectionTemperature(pVar) Returns in pVar an array of Doubles with the injection temperature at each valve depth

• GetArrayMaxGasRate(pVar) Returns in pVar an array of Doubles with the maximum throughputs for each valve. Uses Thornhill & Craver equation

• GetArrayProductionPressure(pVar) Returns in pVar an array of Doubles with the production pressure at each valve depth

• GetArrayProductionTemperature(pVar) Returns in pVar an array of Doubles with the production temperature at each valve depth

• GetArrayValveClosePressure(pVar) Returns in pVar an array of Doubles with closing pressures for each valve

• GetArrayValveOpenPressure(pVar) Returns in pVar an array of Doubles with opening pressures for each valve

• GetArrayValveStatus(pVar) Returns in pVar an array of Strings with the valve status: such as “Throttling”, “Fully Open”.

• GetEquilibriumCurve(pVar) 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.

• GetLastError(sLastError As String) Returns the last error message produced by GLD.

• GetProductionPressureCurve(pVar, type As Long)

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

• GetProductionTemperatureCurve (pVar, type As Long)

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

GLWell Object - Set Methods • AddCalculatedPressureProfile (type As

Long, pVar, pressUnits As String, lenUnits As String)

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.

• AddCalculateTempProfile (type As Long, pVar, tempUnits As String, lenUnits As String)

Type: 0 = MD; 1 = TVDpVar: 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.

PIPESIM


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.

• AddDeviationSurvey (pVar, TVDUnits As String, MDUnits As String)

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

• AddEquilibriumCurve (pVar, pressUnits As String, lenUnits As String)

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.

• 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)

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

• AddPressureSurvey (type As Long, pVar, pressUnits As String, lenUnits As String)

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

• AddTemperatureSurvey (type As Long, pVar, tempUnits As String, lenUnits As String)

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

• SetApi (api As Double)

Optional, this parameters are written to the u2p file

PIPESIM


• 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)

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]

• SetHorizontalCorrelation (bsName As String, HoldupFactor As Double, FrictionFactor As Double)


• SetIprTypeAndValue (IprType As Long, IprValue As Double)

Optional, these parameters are written to the u2p file. IprType = 0 for WELLPI, IprType = 1 for VOGEL

• SetPressureUnits (unitStr As String) 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

• 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)

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

PIPESIM


• 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)

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

• 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)

Required if ProfileMode property is set to Constant Gradient or Variable Gradients

• SetVerticalCorrelation (bsName As String, HoldupFactor As Double, FrictionFactor As Double, SwapAngle As Double)


GLWell Object - Operations • DisplayGasLiftDialog Pops up the GLD GUI • DisplayGasLiftDialog2 (JpgFilename As

String, p_VarUnitManager, bCloseOK As

Boolean)

Same as DisplayGasLiftDialog but it allows to pass Jpeg file name where plot will be stored

GLWell Object - Properties • PressureProfileMode As Long 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.

PIPESIM


• CalculateEqCurveOnDisplay As Boolean 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.

• CalculatePressureProfileOnDisplay As Boolean

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.

• DesignMode As Boolean Sets the module in design mode (True) otherwise diagnostics mode (False). Default is False

• Gor As Double The gor in scf/bbl. Required if PressureProfileMode = 3

• IterationMode As Long Mode = 0 calculate flowrate {DEFAULT} Mode = 1 calculate inlet pressure This is applicable when PressureProfileMode = 2

• LiquidRate As Double The production liquid rate in bbl/d. Required if PressureProfileMode = 3

• PipesimEnginePath As String bstrPath is the full path to a valid PIPESIM engine This data is required if PressureProfileMode = 2

• PipesimIterationTolerance As Double Sets/gets the tolerance in % for the convergence of PIPESIM iterations (default = 1 %)

• ProductionPressureGradient As Double The pressure gradient in psi/ft. Required if PressureProfileMode = 0

• PsmFilePath As String The full path to a valid psm file This data is required if PressureProfileMode = 2

• ReservoirPressure As Double Gets/sets the static reservoir pressure • SetDisplayUnitSystem As Long System = 0 Engineering (DEFAULT), System = 1

SI

• ShowAmbientTemperature As Long (default = 1) • ShowEquilibriumCurvePlot As Long (default = 1) • ShowEquilibriumCurvePlot As Long (default = 1) • ShowInjectionPressure As Long (default = 1) • ShowProductionPressurePlot As Long (default = 1) • ShowProductionTemperature As Long (default = 1) • ShowTransferLinesPlot As Long (default = 1) • ShowValveClosePressure As Long (default = 1) • ShowValveOpenPressure As Long (default = 1) • ValveTemperature (ValveIndx As Long) As

Double Sets to valve at 0-based index ValveIndx (top valve is indx = 0) the temperature given in val [F]. See also the function SetValveTemperatureFrom (…)

• Watercut As Double The watercut in %. Required if PressureProfileMode = 3

PIPESIM


• 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


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,

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)

Returns the recently calculated valve parameters at the specified index manuf: manufacturer name series: series name portname:

portsize:

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 Object)

Returns the recently calculated IGLValveSystem object

• GetCurrentValveSystemCount(ValveCount As Long

Returns the count of recently calculated GL valves

• GetDesignBias() As IDesignBias Returns the IDesignBias object• GetDesignParams () As IDesignParams Returns the IDesignParams object• GetGLValve (indx As Long, 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, md As Double, gasrate As Double)

Returns the installed valve parameters at the specified index manuf: manufacturer name series: series name portname:

portsize:

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


• GetIsUnset(bUnset As Boolean) Returns True is data is not set and False otherwise • GetProductionPressure(depth As

Double) As Double Returns the production pressure

• GetProductionTemperature(depth As Double) As Double

Returns the production temperature

• GetProjectData(ProjData) Returns the array of strings containing project data • GetValveSystemCount(ValveCount As

Long) Returns the count of installed GL valves

• GetLastError(errorStr As String) Returns the last error message IGLDesign Object - Set Methods • SetCompletionParams(Params) Sets the completion type as String for report

purposes. String must be passed as Variant type • SetCurrentSystem(pIValveSystem As

Object) Sets the IGLValveSystem object

• SetFlowCorrsParams(Params) Sets the flow correlation as String for report purposes. String must be passed as Variant type

• SetFluidParameters(Params) 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.

• SetLanguage(nlLanguageID As Long) As Boolean



• SetProjectData(ProjData) 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

IGLDesign Object - Operations • AddDeviationSurvey(pVar_MDvsTVD_

Points) Sets user-defined deviation survey pVar: a two dimensional array containing Doubles { MD , TVD} in Strict_SI units

• CheckInput(Description As String) As Boolean

Validates the design data and returns True if data is ok. Otherwise the return value is False and Description contains the error message

• DisplayGasLiftDesign(p_VarUnitManager, bCloseOK As Boolean)

Pops up the GLDesign GUI.

• DisplayResults(p_VarUnitManager) As Boolean

Pops up the results of the GL design calculations

• PerformDesign() As Boolean Runs the engine to perform design IGLDesign Object - Properties • AmbientTemperature As Double • BottomHoleOffset As Double

PIPESIM


• 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


• 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


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)

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

• GetIsUnset(bUnset As Boolean) Returns True is data is not set and False otherwise • GetLastError(errorStr As String) Returns the last error message • GetValveCount(lValveCnt As Long) Returns the count of installed GL valves IGLValveSystem Object - Set Methods • SetGasLiftProps(InjPressure As

Double, MaxAvailableRate As Double, InjTemp As Double, GasSG As Double, bstrPvtFile As String, bIsBlackOil As Boolean)

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

• 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)

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

• ClearValveSystem() Removes all installed valves

• DisplayGLValveSystem(p_VarUnitManager, bCloseOK As Boolean)

Pops up the GL Valve System GUI

PIPESIM


IGLValveSystem Object - Properties • BellowsArea(iValveIndx As Long) As

Double Gets bellows area for the valve specified by iValveIndx

(Read only property) • ChokeSize(iValveIndx As Long) As

Double (Read only property)

• DPFO(iValveIndx As Long) As Double • Manufacturer(iValveIndx As Long) As

String (Read only property)

• MeasuredDepth(iValveIndx As Long) As Double

(Read only property)

• nomOD(iValveIndx As Long) As Double (Read only property) • PortArea(iValveIndx As Long) As

Double (Read only property)

• portname(iValveIndx As Long) As String


• portsize(iValveIndx As Long) As 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

String (Read only property)

• ValveModeType(iValveIndx As Long) 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


• GetUnitofVariable(VariableName As String) As String

Returns the unit of given the column variable name. Parameters - VariableNme - Name of the column variable Return Value -A string.

• GetDataofVariable(VariableName As 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).

• GetVariableName(Index As Long) As String

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.

• GetMultipleVariablesData(Indexes) 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.

• GetTitle() As String Returns the title of the well performance curves file. Parameters - None Return Value - A string.

• GetNumberofDataSets() As Long Returns the number of data sets (= number of NEWLINE cards) in the performance curves file. Parameters - None Return Value - An integer.

• GetVariableNamesList() 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.

• GetAllData() 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.

• GetLastError() As String Returns the last error message ReadData 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.

PIPESIM


• 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


// 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


' 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() 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

• GetAttributeDetailsAt(VariableName As String)

Returns a String (as Variant) containing plotting attributes for the specified variable

• GetAxisBoundaries() Returns a Variant type containing two-dimensional array of the low/upper boundaries for the plot variables.

• GetBubblePointData() Returns (as Variant type) the array of three doubles values for saturation pressure, saturation temperature and saturation GOR. (Black oil models only.)

PIPESIM


• GetColumnVariableDataAt(VarName As String)

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

• GetConcatenationData() • GetConeGasSG() As Double Returns a Double value (wrapped into Variant type) of cone

gas specific gravity • GetCreationDate() Returns a String value (wrapped into Variant type) of curve

file date/time stamp • GetCurrentModelUnitSettings() Returns (as Variant type) the two-column array of strings

for all plotted variables. First column contains variable’s measurement and a second column contains variable’s units

• GetDefaultXAxis() As Long Returns an index for X axis variable • GetDefaultYAxis() As Long Returns an index for Y axis variable • GetDynamicPlotFileName() As String Returns a curve file name (short form) • GetDynamicPlotLongFileName() As

String

Returns a curve file name (long form)

• GetFileFormatStatus() As String Return a String New if curve file has new format, otherwise return value is Old

• GetLastError() As String Returns the last error message produced by the interface. • GetMultipleColumnsDataAt(Index) Returns data similar to GetAllVariables function but for

variables passed in Index array • GetNoOfDataColumn() As Long Returns the total number of variables in curve file • GetNumberOfCases() As Long Returns the number of cases in curve file • GetPhysicalPropertyData() 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.)

• GetProductionData() () Returns (as Variant type) the array of 2 doubles values for Well PI and static reservoir pressure

• GetSimulatorName() As String Returns String with the simulator name • GetTitle() As String Returns String with the project description • GetUnitDetailsAt(VariableName As

String) 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

• GetUnitsOfVariableName(sVarName As String) As String

Returns String with the current units for the specified variable

• GetUnitType() As String Returns String ENG or S depending on unit system user selected for the output files

• GetUserName() As String Returns String with the user name form project properties • GetVarableNamesList() Returns (as Variant type) the array of Strings containing all

variables names from curve file • GetVariableDataAt(ColName As String) Returns (as Variant type) the array of Doubles containing all

values for the specified variable • GetVariableDataAtCase(VarName As

String, CaseNo As Long) Similar to GetVariableDataAt but returned values are for the specified case only (case index is 1-based)

• GetVariableNameAt(Index As Long) As String

Returns String with the variable name at specified index (1-based)

• GetViscosityData() Returns (as Variant type) the array of 4 doubles values for temperatures and viscosities

PIPESIM


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, • GetBranchInData

Fill a supplied SAFEARRAY (blob) with node data 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


• GetBranchName name of the i'th branch in the array params int iNode - index in array (#) BSTR *sName - name of i'th element

• GetNodeVariableValue, • GetBranchOutVariableValue, • GetBranchInVariableValue

Gets value of variable type Gas Rate, glr etc. for i'th element of array 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, • GetBranchInStrVariableValue, • GetBranchOutVariableValue

Gets value of variable type Gas Rate, glr etc. for named element of array 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


} 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


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


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


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


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]

double * a, [out] BSTR * a_unit, [out] double * b, [out] BSTR * b_unit)

a: the value of the A parameter in the Jones equation a_unit: the unit string for the A parameter 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]

double frate, [in] BSTR frate_unit, [in] double pwf, [in] BSTR pwf_unit)

frate: flowrate value (double) frate_unit: unit string for the flowrate value. Any of: 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] short ftype, [in] BSTR frate_unit, [in] BSTR pwf_unit, [in] BSTR Legend, [in] VARIANT * vData, [in] const unsigned long pType)

ftype: fluid type, type_liquid = 0, type_gas = 1

frate_unit: unit string for the flowrate value. Any of: STB/d, sm3/d for Liquid Rates OR: mmscf/d mscf/d, scf/d, mmsm3/d, msm3/d, sm3/d for gas rates 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,

[in] BSTR unitStr) Pres: static pressure value 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, [in] short unitSystem)

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) Set this value to calculate the B parameter given A and one survey point

PIPESIM


• SetJonesBConstant ([in] double val, [in] short unitSystem)

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). Set this value to calculate the A parameter given B and one survey point

• SetJonesMeasuredAConstant ([in] double val, [in] short unitSystem)

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

• SetJonesMeasuredBConstant ([in] double val, [in] short unitSystem)

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

• SetUnitSystem ([in] long unitSystem)

unitSystem: 0: values will be displayed in default Engineering units; 1: SI units

COM Interface: Jones - Operations • DoCalculateConstants () Calculates the A and B parameters based on the given

data: static reservoir pressure and {pwf, flowrate} points

• ShowInflowPerformanceDlg () Displays the IPR COM graphical interface COM Interface: Jones Example VBA Sample Code 'Create an instance of the Jones COM interface Dim JonesObj As WELLMODELCOMLib.Jones Set JonesObj = New Jones '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


Units Library IUnitSystem Interface Note: See Unit System for the available quantity names and unit strings. • Convert

[in] BSTR quantity_name, [in] double in_value, [in] double factor_to_SI, [in] double adder_to_SI, [in] BSTR out_unit, [out, retval] double * out_value

Converts in_value to [out_value, out_unit] given the in_value’s conversion factor and adder to convert it to its strict SI unit. Returns out_value in the given out_unit

• Convert_SI [in] BSTR quantity name, [in] double si_value, [in] BSTR out_unit, [out, retval] double * out_value

Converts a given quantity in strict SI units to the given out_unit

• ConvertAny [in] BSTR quantity_name, [in] double in_value, [in] BSTR in_unit, [in] BSTR out_unit, [out, retval] double * out_value

Converts a quantity given as [in_value, in_units] to an out_unit

• ConvertStrictSIToCurrentUnits [in] BSTR quantity_name, [in] double value, [in] BSTR out_unit, [out, retval] double * out_value

Converts a quantity given as [value] in strict SI to an out_unit defined according to the units file imported using ImportUnitFile. By default it will be Eng units if no unit file has been imported

• ConvertToDefEng [in] BSTR quantity_name, [in] double value, [in] BSTR value_unit, [out] BSTR *eng_unit, [out, retval] double *eng_value

Converts a quantity given as [in_value, in_units] to the PIPESIM’s default engineering unit for that quantity.

• ConvertToDefSI [in] BSTR quantity_name, [in] double value, [in] BSTR value_unit, [out] BSTR *si_unit, [out, retval] double * si_value

Converts a quantity given as [in_value, in_units] to the PIPESIM’s default SI unit for that quantity. Please note that default SI is not necessarily equal to strict SI.

• ConvertToStrictSI [in] BSTR quantity_name, [in] double value, [in] BSTR value_unit, [out] BSTR *si_unit, [out, retval] double *si_value

Converts a quantity given as [in value, in units] to the strict SI unit for that quantity. Please note that default SI is not necessarily equal to strict SI

• DisplayUnitDialog [in] VARIANT_BOOL bShowFileOptions, [in] VARIANT_BOOL bShowDeaultOptions, [out] VARIANT * pVar

Displays the graphical user interface for unit system selection.

• GetDefEngUnitString [in] BSTR quantity name, [out, retval] BSTR * unit string

Returns the default engineering unit string for a given quantity.

• GetDefSIUnitString [in] BSTR quantity_name, [out, retval] BSTR * unit_string

Returns the default SI unit string for a given quantity.

• GetLastError [out, retval] BSTR * ErrorStr

Returns an error description. This method should be called immediately after a function has returned an error code.

• GetStrictSIUnitString [in] BSTR quantity name, [out, retval] BSTR * unit_string

Returns the strict SI unit string for a given quantity.

PIPESIM


• GetUnitStrings [in] BSTR quantity name, [out] VARIANT * pVar

Returns an array of unit strings defined for the given quantity.

• GetUnknownValue [out, retval] double *pVal

Returns PIPESIM’s definition of ‘unset’ or ‘unknown’ value.

• ImportUnitFile [in] BSTR filename Imports a saved units file (saved by default with a .unf extension)

IReal Interface • UnitClass

string Gets/sets unit class name

• SetRealValue [in] double Value, [in] BSTR Unit

Sets a Value in the specified unit string

• GetRealVal [out] double * pValue, [out] BSTR * pUnit

Returns a value in the units corresponding to pUnit

• SetSelectedUnit [in] BSTR UnitStr, [out, retval] VARIANT_BOOL

Selects the given unit string

• GetSelectedUnit [out, retval] BSTR * UnitStr

Returns the selected unit string

• GetDefEngValue [out, retval] double * Val

Returns the value in default engineering units

• 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


Defined constants and strings Object Type Identifiers

Object ID Object Type Description

1 n_FOLD (network folder) 2

n_SOURCE (network 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 object’s properties Common properties

Property name Description

PRESSURE Static reservoir pressure TEMPERATURE Reservoir temperature IPRTYPE Completion model type (see IPR Types

(Vertical))

PIPESIM


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)

Vogel’s Equation specific properties Property name Description

VOGEL AOFP Absolute Open Flow Potential VOGEL N Vogel coefficient

Fetkovitch’s Equation specific properties Property name Description

FETKOVITCH AOFP Open Flow Potential FETKOVITCH N n exponent

Jones’s 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


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)

Forchheimer’s 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


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


TRANSIENTIPR THICKNESS Reservoir thickness TRANSIENTIPR DRAINRADIUS Drainage radius TRANSIENTIPR WELLBOREID Wellbore diameter TRANSIENTIPR TIME Time TRANSIENTIPR POROSITY Porosity TRANSIENTIPR COMPRESS Total compressibility TRANSIENTIPR SKIN Mechanical skin TRANSIENTIPR RATESKIN GAS Rate dependent skin for gas TRANSIENTIPR RATESKIN LIQ Rate dependent skin for liquid TRANSIENTIPR CALCSKIN Calculate Mechanical skin (if set) TRANSIENTIPR CALCRATESKIN Calculate Rate dependent skin (if set) TRANSIENTIPR COMPOPTIONS Completion options type TRANSIENTIPR DAMAGEDID Damaged zone diameter TRANSIENTIPR DAMAGEDPERM Damaged zone permeability TRANSIENTIPR COMPACTEDID Compacted zone diameter TRANSIENTIPR COMPACTEDPERM Compacted zone permeability TRANSIENTIPR GRAVELPERM Gravel pack permeability TRANSIENTIPR GRAVELTUNNEL Gravel pack tunnel length TRANSIENTIPR GRAVELCASINGID Gravel pack casing ID TRANSIENTIPR GRAVELSCREENSZ Gravel pack screen diameter TRANSIENTIPR COMPDEVIATION Completion deviation TRANSIENTIPR PERFSKINMETHOD Perforation skin method (0 for McLeod, 1 for

Karakas/Tariq) TRANSIENTIPR COMPINTERVAL Completion open interval TRANSIENTIPR COMPVERTPERM Completion vertical permeability TRANSIENTIPR PERFID Perforation diameter TRANSIENTIPR PERFLENGTH Depth of penetration TRANSIENTIPR PERFSHOTDENSITY Perforation density TRANSIENTIPR PERFPHASEANG Phase angle TRANSIENTIPR DZSKINCALC Include damaged zone skin (if set) TRANSIENTIPR GPSKINCALC Include gravel pack skin (if set) TRANSIENTIPR PFSKINCALC Include perforation skin (if set) TRANSIENTIPR PPDSKINCALC Include partial penetration/deviation skin (if

set) FCV properties


FCV VALVETYPE FCV type: 0 –generic, 1-specific (manufactured)

FCV GENERICVALVETYPE Generic FCV type: 0 – equivalent choke area, 1 – maximum rate through valve

FCV CHOKEEQUATION Gas choke equation: 0 – mechanistic FCV EQCHOKEARIA Equivalent choke area FCV MAXLIQRATE Maximum liquid rate through valve FCV MAXGASRATE Maximum gas rate through valve FCV LIQCOEFF Liquid flow coefficient FCV GASCOEFF Gas flow coefficient FCV PRESSDROP Pressure drop ratio factor FCV MANUFACTURER FCV manufacturer FCV TYPE FCV type (munufacturer’s specific) FCV PARTNUMBER FCV partnumber FCV VALVEPOSITION Valve postion FCV VALVEPERSENTOPEN Valve percent open

PIPESIM


Tubing object’s properties Common properties


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)


CHOKE CHOKE MD Choke MD BEAN SIZE Bean size


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



INJECTOR GAS LIFT RATE OPTION Gas lift rate option (0 for gas rate, 1 for GLR)

(simple profile) GAS LIFT RATE Gas lift gas rate (simple profile) GAS LIFT GLR Gas lift tubing GLR (simple profile) GAS LIFT MD Gas lift MD (simple profile) GAS LIFT PORT DIAMETER Gas lift port diameter (simple profile) GAS LIFT PVTFILE Composition file name (simple profile) GAS LIFT PVTTYPE Composition type (0 for local composition, 1

for local PVT, 2 for global PVT, 3 for local MFL) (simple profile)

GAS LIFT SPECIFIC GRAVITY Gas lift specific gravity (simple profile) GAS LIFT SURFACE PRESSURE Surface pressure (simple profile) GAS LIFT SURFACE TEMPERATURE Surface temperature (simple profile) GAS LIFT RATE OPTION NODE Same as GAS LIFT RATE OPTION but for

detailed profile GAS LIFT RATE NODE Same as GAS LIFT RATE but for detailed

profile GAS LIFT GLR NODE Same as GAS LIFT GLR but for detailed

profile GAS LIFT MD NODE Same as GAS LIFT MD but for detailed profile GAS LIFT PORT DIAMETER NODE Same as GAS LIFT PORT DIAMETER but for

detailed profile GAS LIFT PVTFILE NODE Same as GAS LIFT PVTFILE but for detailed

profile GAS LIFT PVTTYPE NODE Same as GAS LIFT PVTTYPE but for detailed

profile GAS LIFT SPECIFIC GRAVITY NODE Same as GAS LIFT SPECIFIC GRAVITY but

for detailed profile GAS LIFT SURFACE PRESSURE NODE Same as GAS LIFT SURFACE PRESSURE but

for detailed profile GAS LIFT SURFACE TEMPERATURE NODE Same as GAS LIFT SURFACE

TEMPERATURE but for detailed profile


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


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


GLValve VALVE MD Valve MD VALVE AB Valve Ab

PIPESIM


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


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


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


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


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 SURFACE

ft2 *. m2 ^!, acres, mi2, ha, km2

COMPRESS COMPRESSIBILITY

COMPRESSIBILITY 1/psia *, 1/bara ^, 1/Pa !

CONDUCTIVITY THERMALCOUCTIVITY

THERMAL CONDUCTIVITY

Btu/hr/ft/F *, W/m/K !^

DELTAP PRESSUREDROP

PRESSURE (DELTA)

Psi *, Bar ^, atm, kPa, kg/cm2, Pa!

DELTAT

TEMPERATURE (DELTA)

F *, C! ^, K, R,

DENSITY DENSITY LIQUID lb/ft3 *, kg/m3! ^, g/cc,

DISTGASPI DISTRIBUTEDGASPI

SPECIFIC PRODUCTIVITY INDEX (GAS PER LENGTH)

Mmscf/d/psi2/ft *, mmsm3/d/bar2/m ^, msm3/d/kPa2/m, sm3/s/Pa2/m!

DISTLIQPI DISTRIBUTEDLIQPI

SPECIFIC PRODUCTIVITY INDEX (LIQ PER LENGTH)

STB/d/psi/ft *, sm3/d/bar/m ^, sm3/d/kPa/m, sm3/s/Pa/m!

ENTHALPY ENERGY PER MASS (ENTHALPY)

Btu/lb *, J/g ^, J/kg!

ENTROPY SPECIFIC ENTROPY

Btu/lb/F *, J/g/K ^, J/kg/K!

FLOWGLRATIO STD VOLUME PER VOLUME (GLR)

scf/bbl *, sm3/m3 ^!

FRACTION RATIO (%) % *! ^ fract.,

GASPI SPECIFIC PRODUCTIVITY INDEX (GAS)

Mmscf/d/psi2 *, mmscf/d/kPa2, mmsm3/d/bar2 ^,

msm3/d/kPa2, 1.E4sm3/d/MPa2,

m3/s/Pa2!

PIPESIM


GASRATE STD VOLUME GAS RATE

Mmscf/d *, Mscf/d, scf/d, mmsm3/d ^, msm3/d,

sm3/d, 1.E3sm3/d, 1.E4sm3/d,

sm3/s!

GASRATE(FLOWING) FLOW RATE VOLUME BASIS (GAS)

Mmcf/d *, mcf/d, cf/d, mmm3/d ^, mm3/d, m3/d, 1.E3m3/d, 1.E4m3/d, m3/s!

GASRATERECIP STD VOLUME GAS RATE (RECIPROCAL)

1/mmscf/d *, 1/mscf/d, 1/scf/d, 1/mmsm3/d, 1/msm3/d, 1/sm3/d, 1/1.E3sm3/d, 1/1.E4sm3/d, 1/sm3/s!

GOR GLR

VOLUME PER VOLUME (GLR)

Scf/STB *, sm3/sm3! ^

HEAD COMPRESSORHEAD

ENERGY PER MASS (HEAD)

ft-lbf/lbm *, 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 DIAMETER, ID, OD, WT, LENGTH(SHORT)

LENGTH SHORTRANGE

Inches *, ft, miles, mm ^, cm, m!, km, 1/64in,

LENGTHL LENGTH(LONG)

LENGTH MIDRANGE

Ft *, Miles, m! ^, km,

LIQPI SPECIFIC PRODUCTIVITY INDEX (LIQ)

STB/d/psi *, STB/d/kPa, sm3/d/bar ^, sm3/d/kPa, sm3/d/MPa, sm3/s/Pa!

LIQRATE STD VOLUME LIQUID RATE

STB/d *, sm3/d ^, sm3/s!

LIQRATE(FLOWING) FLOWRATE VOLUME BASIS (LIQ)

bbl/d *, m3/d ^, m3/s!

LIQRATERECIP STD VOLUME LIQUID RATE (RECIPROCAL)

1/STB/d, 1/sm3/d, 1/sm3/s

MASS MASS Lb *, Kg! ^ MASSRATE FLOWRATE MASS

BASIS lb/s *, lb/h, kg/s! ^, kg/h,

MOLARVOLUME SPECIFIC VOLUME MOLE

ft3/mol *, m3/mol! ^

OGR LGR

VOLUME PER VOLUME (LGR)

STB/mmscf *, sm3/mmsm3 ^, sm3/msm3, sm3/1.E4sm3, m3/E3m3, sm3/sm3!

PIPESIM


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 PRESSUREGRADIENT

PRESSURE GRADIENT

psi/ft *, bar/m ^, atm/m, kPa/m, kg/cm2, Pa/m!

ROTVELOCITY FREQUENCY

FREQUENCY Hz *! ^ Rpm,

SHOTS PER LENGTH Shots/ft *, Shots/m! ^

SURFTENSION SURFACETENSION

SURFACE TENSION Dyne/cm *, N/m! ^

TEMPERATURE TEMPERATURE F *, C! ^, K, R,

TIME TIME Hr *^, Min, s!, days, years

U HEATTRANSFERCOEFFICIENT

HEAT TRANSFER COEFFICIENT

Btu/hr/ft2/F *, W/m2/K! ^

VELOCITY VELOCITY ft/s *, m/s! ^

VISCOSITY VISCOSITY DYNAMIC

Cp *^ Ns/m2 ! , lb/s/ft,

VOLFRAC VOLUMEFRACTION

VOLUME PER STD VOLUME

Bbl/mmscf *, 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


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


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


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


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


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

Pipesim Manual

Documents

Transcript of Pipesim Manual