Aspen Touch Solutions ATM-123R Series Especificações

Aspen HYSYSCustomization Guide

1-6 Customizing HYSYS1-61.3 Customizing HYSYSHYSYS can be programmatically run from any tool that supports Automation. You can set up scripts that do

3-16 Creating an Extension3-16Create & Register the DLLWhen you build your project, you must implement it as a 32-bit Dynamic Link Library (DLL).

Extensibility 3-173-17To distribute your extension, you must provide the DLL file, the EDF file, and any other files required by your extension (i.e.,

3-18 Creating an Extension3-18property views. The selection of the ProgID is explained in the following sub-section entitled: Register the Extension.

Extensibility 3-193-19variable with the widget.Each DefaultView form must have a unique name. The object’s default property view must be called Defaul

3-20 Creating an Extension3-20Debug the ExtensionTo debug the extension, you can set breakpoints on just about any line in your class. Initially, you

Extensibility 3-213-21proprietary information or methods.To distribute your extension, you must provide the DLL file, the EDF file, and any other file

3-22 Registering Extensions3-22Extension Definition File for the object.The type of the extension is given by the ExtensionType entry. The type can be

Extensibility 3-233-233. Use the File Path group to find the directory in which the DLL file is saved. Once you find the DLL file, select it and click

3-24 Registering Extensions3-243.6.2 Registering Extensions Written in Visual BasicExtensions written in Visual Basic may be run from within Visual Ba

Extensibility 3-253-253.6.3 Registering Extensions Written in C# or VB.NETTo register an extension written in C# or VB.NET, use the following procedur

Introduction 1-71-71.3.1 HYSYS & the Macro Language EditorThe Macro Language Editor is accessed by selecting the Macro Language Editor command fro

3-26 Extension Interface Details3-26below. You are now ready to use the extension in HYSYS.3.7 Extension Interface DetailsThree types of extensions ca

Extensibility 3-273-27and properties for the extension.Derived from Properties MethodsIDispatch • ExtensionInterface•FPStatus• OnOleEnabledThread•Simu

3-28 Extension Reaction Kinetics3-283.7.2 ExtensionObject InterfaceEvery extension must implement the ExtensionObject interface. This interface defin

Extensibility 3-293-29These previously described interfaces allow a reaction to be implemented and associated with a HYSYS case through a fluid packag

3-30 Extension Reaction Kinetics3-30Extension Definition FilesAn extension definition file is required for the kinetic reaction extension. Since HYSY

Extensibility 3-313-313.8.2 ExtnKineticReactionContainer InterfaceThe ExtnKineticReactionContainer interface is passed to an extension Kinetic Reactio

3-32 Extension Reaction Kinetics3-323. Make sure that the HYSYS 3.* Type Library checkbox is selected in the References property view, which is acces

Extensibility 3-333-338. The first function declared is the Initialize function. It is called when the extension is first added to HYSYS or when a cas

3-34 Extension Reaction Kinetics3-34 Set hyReactant = hyContainer.Reactants.Add("AceticAcid") hyReactant.StoichiometricCoefficientValue

Extensibility 3-353-359. The other function that is required to implement a kinetic reaction extension is the ReactionRate function.Code ExplanationPu

1-8 Customizing HYSYS1-8The Macro Language Editor now has two new features:• Autocompletion feature, which helps you complete the user variable codes

3-36 Extension Reaction Kinetics3-3610. Select Make VinylAc.dll command from the File menu. The Make Project property view appears.11. Select the fol

Extensibility 3-373-37Creating the Extension Definition File (EDF)In order to complete the Kinetic Reaction Extension, you must create an EDF. This is

3-38 Extension Reaction Kinetics3-385. Select Kinetic Reaction as extension type in the Type drop-down list.6. Specify the information in the Variabl

Extensibility 3-393-398. From the Existing Views list, select the DefaultView and click the Edit button. The DefaultView form appears. It consists of

3-40 Extension Reaction Kinetics3-40Adding Widgets to the DefaultView form1. From the Widgets Palette select a Numerical Input widget.2. Right-click,

Extensibility 3-413-415. For the upper Static Text widget specify properties as shown below. When you are finished click the OK button.6. For the lowe

3-42 Extension Reaction Kinetics3-427. For the Numerical Input widget specify properties as shown below. When you are finished click the OK button.Th

Extensibility 3-433-4311. Click the Insert button on the Edit Messages property view. The Select Message property view appears. Select the Close the V

3-44 Extension Reaction Kinetics3-4414. Specify the Name field as shown below. When you are finished click the OK button.The property view now appear

Extensibility 3-453-453. Use the File Path group to find the directory in which the VinylAc.dll file is saved in. Once you find the DLL file, select i

Introduction 1-91-91.3.2 Programming HYSYS from External ProgramsHYSYS can be accessed from external programs using Automation. Programs such as Micro

3-46 Extension Property Packages3-465. You can now go to the Reactions tab of the Simulation Basis Manager property view and add a VinylAcetate Reacti

Extensibility 3-473-47The ExtnPropertyPackage interface is not a dual interface; for efficiency, non-ActiveX Automation compatible data types are pass

3-48 Extension Property Packages3-48has returned a non-zero for NumberOfPreselectedComponents), the container handles the implementation of the IsComp

Extensibility 3-493-49IsActivityModelType This should be set to True if the property package can be considered an activity model property package. A n

3-50 Extension Property Packages3-503.9.1 ExtnPPkgContainer InterfaceThe ExtnPPkgContainer interface is passed to an Extension Property Package in its

Extensibility 3-513-513.9.2 ExtnPropertyPackage InterfaceThe ExtnPropertyPackage interface must be implemented by all Extension Property Packages. Onl

3-52 Extension Unit Operations3-523.10 Extension Unit OperationsYou can implement Unit Operation calculations in HYSYS by creating an Extension Unit

Extensibility 3-533-53Extension Definition FilesAn extension definition file is required for the custom unit operation’s visual interface within the H

3-54 Extension Unit Operations3-543.10.2 ExtnUnitOperation InterfaceThe ExtnUnitOperation interface must be implemented by all Extension Unit Operati

Extensibility 3-553-55condition occurs. When this happens, the Solver stops and switches in to Hold Mode. To allow different objects to calculate diff

1-10 Customizing HYSYS1-10VBAMicrosoft Excel and related products make use of Visual Basic for Applications (VBA). VBA is a high level programming lan

3-56 Extension Unit Operations3-56The Execute method of an object can be called more than once in either of the Solve Passes, as variables in the obj

Extensibility 3-573-574. Rename the project name to UnitOpExtn as shown.5. Save the class and project by selecting Save Project command from the File

3-58 Extension Unit Operations3-587. The first function declared is the Initialize function. It is called when the extension is first added to HYSYS

Extensibility 3-593-598. The other function that is required to implement a Unit Operation Extension is the Execute function.Set hyFeedStrm = hyContai

3-60 Extension Unit Operations3-60 Set Components = hyContainer.Flowsheet.FluidPackage.Components WaterPresent = False For Each Component In Co

Extensibility 3-613-61 WorkFluid.TPFlash hyFeedStrm.TemperatureValue, hyFeedStrm.PressureValue If WorkFluid.FluidPhases.Count = 1 Then CalcEr

3-62 Extension Unit Operations3-62 Do While WorkFluid.FluidPhases.Count = 1 Count = Count + 1 Set WorkFluid = hyFeedStrm.DuplicateFluid

Extensibility 3-633-639. While the Initialize and Execute methods are required for the implementation of the unit operation extension, it is strongly

3-64 Extension Unit Operations3-64If hyWatStrm Is Nothing Then Call hyStatus.AddStatusCondition(slMissingRequiredInformation, 4, "Water Stream

Extensibility 3-653-6510. Select Make Saturate.dll command from the File menu.Creating the Extension Definition File (EDF)In order to complete the Uni

Automation 2-12-12 Automation2.1 Introduction... 32.2 Objects ...

3-66 Extension Unit Operations3-66The default View Editor should appear as shown below: 2. Click the Objects Manager icon to view the Objects Manager

Extensibility 3-673-67The Object Manager property view now appears similar to the figure below.7. Click the Close button. This returns you to the View

3-68 Extension Unit Operations3-688. From the Existing Views list, select DefaultView and click the Edit button. The DefaultView form appears. Defini

Extensibility 3-693-693. The Select Number Variable property view appears. From the list select Current Page and click the OK button. 4. In the Label

3-70 Extension Unit Operations3-707. A default controller has already been set up for the page tabs called PageController. Click the Edit button to v

Extensibility 3-713-713. Place a Static Text widget above each Attachment Name widget. 4. First the Feed widgets (i.e., the Attachment Name and Static

3-72 Extension Unit Operations3-725. For the Feed Attachment Name widget specify properties as shown below. When you are finished click the OK button

Extensibility 3-733-737. For the Water Attachment Name widget specify properties as shown below. When you are finished click the OK button.The Target

3-74 Extension Unit Operations3-749. For the Product Attachment Name widget specify properties as shown below. When you are finished click the OK but

Extensibility 3-753-75Adding Widgets to Worksheet TabThe next step is to add widgets to the Worksheet tab on the DefaultView form.1. In the Visibility

2-2 Introduction2-22.1 IntroductionAutomation, defined in its simplest terms, is the ability to drive one application from another. For example, the d

3-76 Extension Unit Operations3-766. Select the Vertical Direction checkbox. The Matrix Properties property view should appear similar to the figure

Extensibility 3-773-7712. From the list select Object Name as shown in the figure below and click the OK button.13. The Select Text Variable property

3-78 Extension Unit Operations3-7819. From the list select Molar Flow and click the OK button. The Select Number Variable property view closes, and y

Extensibility 3-793-79the only two cells defined.22. Select Save command from the File menu and save the EDF as Saturate.edf in the same directory as

3-80 Extension Transition Objects3-804. You can now go in to the main Simulation environment and from the UnitOps property view find the Saturate Ext

Extensibility 3-813-81• Global Variables•Initialize•Execute•EdfOverviewIn this section a Visual Basic extension transition object will be created.To b

3-82 Extension Transition Objects3-82when installing an extension for the first time. When a transition object is installed for the first time, the

Extensibility 3-833-83the feed and product streams, as fluid types. The idea is to map one set components to another based on the normal boiling point

3-84 Extension Transition Objects3-84a suitable product stream component is located for mapping the next iteration of the feed stream component loop

Extensibility 3-853-85When a product stream component is located, results for each property, MW and Flash Point, are stored in corresponding property

Automation 2-32-32.2 ObjectsThe key to understanding Automation lies in the concept of objects. An object is a container that holds a set of related f

3-86 Extension Transition Objects3-86When the property vectors are populated and all component mapping is complete, remaining properties are estimate

Extensibility 3-873-873.11.2 ExampleThis section provides examples of the source code. It includes the following topics:•Overview• Installing the Exte

3-88 Extension Transition Objects3-88The following example will illustrate how to update a legacy Aspen HYSYS Oil to a RefSYS Oil.Installing the Exte

Extensibility 3-893-897. Close the view and use Install Oil with the name myOil. myOil will correspond to a flowsheet stream with Aspen HYSYS Oil Comp

3-90 References3-90Building the Flowsheet1. Click the stream myOil and enter the following conditions:2. Click the Flowsheet icon from the operations

Extension View Editor 4-14-14 Extension View Editor4.1 Introduction...

4-2 Extension View Editor 4-24.3.18 Unit Enumeration Widget...704.3.19 Text List Widget ...

Extension View Editor 4-34-34.1 IntroductionThe View Editor can be used to create or modify Extension Definition Files (*.edf). Users that are access

4-4 Introduction4-44.1.1 Accessing the View EditorAccess to the View Editor is provided with each commercial release of HYSYS. However, it is not ava

Extension View Editor 4-54-5The View Editor appears as shown below: You can now either open an existing EDF or create a new EDF.4.1.2 Creating a New

2-4 Objects2-4tread type or model number. 2.2.1 Object HierarchyThe path that is followed to get to a specific property may involve several objects. T

4-6 Introduction4-6The Views Manager property view and the Widgets Palette appears as shown in the figure below. Figure 4.4

Extension View Editor 4-74-72. Assuming, at this time, that only one property view exists for this EDF file, click the Edit button to open the Defaul

4-8 Using the View Editor4-84.1.3 Editing an Existing EDF File1. To open an existing EDF file, do one of the following:• Select Open under File in th

Extension View Editor 4-94-9Alternate ApproachAn alternate approach to the above steps #2 through #3 is to select the Lock checkbox found at the bott

4-10 Using the View Editor4-10Deleting a WidgetTo delete a widget simply select the widget and do one of the following:•Press the DELETE key.• Right-

Extension View Editor 4-114-11all selected widgets by resizing the anchor widget, which is the widget displayed with the resizing handles.To re-size

4-12 Using the View Editor4-12Active Location SettingsTab Order IconWhen this icon is clicked, an integer value appears over each widget on the Defau

Extension View Editor 4-134-13one below the value on the widget with which the static text is associated. This enables the associated widget to get t

4-14 Using the View Editor4-14All other widgets would have their integer values increase by 1 with the old #1, the Static Text Inlet widget, becoming

Extension View Editor 4-154-15•Stretch HeightClicking the Stretch Height icon toggles the Y-direction Stretch checkbox (found in the widget’s Propert

Automation 2-52-5the application by examining the type library.The HYSYS type library reveals over 340 objects that contain over 5000 combined propert

4-16 Using the View Editor4-16The Alignment icons that are available:4.2.3 Visibility ManagerThe Visibility Manager is used when you want to show or

Extension View Editor 4-174-17For instance, many HYSYS property views have tabs along the lower part of the property view which enable different info

4-18 Using the View Editor4-18An example, if you were to select the Page2 radio button, you would see the Page 2 tab. Only the widgets placed on this

Extension View Editor 4-194-19Using TabsA property view created through the View Editor can contain multiple tabbed sections within the same property

4-20 Using the View Editor4-203. Right-click the DefaultView form background and select Open Visibility Manager command from the Object Inspect menu.

Extension View Editor 4-214-218. Select Current Page from the list in the Select Number Variable property view, and click the OK button.9. Enter a na

4-22 Using the View Editor4-2211. Repeat #9 and #10 for each tab.12. Click the Select Widgets button. Select the checkbox under the appropriate tab n

Extension View Editor 4-234-234.2.4 Objects Manager Property ViewThe Objects Manager provides a property view in which you can enter crucial informat

4-24 Using the View Editor4-24Object Definition MatrixThe Object Definition matrix consists of four columns: Attributes of Selected Object GroupThe A

Extension View Editor 4-254-25Variables of Selected Object GroupIn the Variables of Selected Object group, you can specify all variable-related infor

Version Number: V7.3March 2011Copyright (c) 1981-2011 by Aspen Technology, Inc. All rights reserved. Aspen HYSYS and the aspen leaf logo are trademark

2-6 Objects2-67. Open the View menu and select the Object Browser command (or press F2). 8. Open the Libraries/Workbooks drop-down list and select HYS

4-26 Using the View Editor4-26Attachment TypeFor Attachment variables, you can specify the attachment type as one of the following:• Stream. Generic

Extension View Editor 4-274-274.2.5 Views ManagerThe Views Manager property view consists of two groups: View File and Selected Object.Selected Objec

4-28 Widget Properties4-28From the Views Manager property view, you can click any of the buttons that pertain to the Existing Views list:4.3 Widget Pr

Extension View Editor 4-294-29For most widgets the Target Moniker option is used to assign a specific variable to the widget.Common widget properties

4-30 Widget Properties4-30The Select Number Variable and Select Text Variable property view are very similar in their appearance and operation. Both c

Extension View Editor 4-314-31An example, suppose a stream variable was selected in the Base Object drop-down list. As shown in the figure below, Fee

4-32 Widget Properties4-324.3.1 Common Widget PropertiesEach of the widgets listed in the Widgets Palette has a set of common properties listed on its

Extension View Editor 4-334-33Stretch When the X-direction Stretch checkbox is selected, the width of the widget increases as the DefaultView form is

4-34 Widget Properties4-344.3.2 DefaultView Form ObjectThe DefaultView form object has its own set of properties that control the appearance and funct

Extension View Editor 4-354-35Form Properties Property ViewThe DefaultView form is the only object that has a unique properties layout. It does not h

Automation 2-72-7type shown is not a string, Boolean, variant, double, integer, or long then it is most likely an object. The object type shown is fou

4-36 Widget Properties4-36Form Style In this group, you can choose one of the radio buttons that assigns characteristics to the DefaultView form:• Nor

Extension View Editor 4-374-37Borders Allows you to specify the distance that the top, bottom, left, and right edges of the DefaultView form are from

4-38 Widget Properties4-384.3.3 Button WidgetThe button widget is used to send specific instructions to its base object when it is clicked by the user

Extension View Editor 4-394-39Button PropertiesThe properties available for a Button widget are described in the table below:Object DescriptionLabel

4-40 Widget Properties4-404.3.4 Static Text WidgetUse this widget to show read-only text on the application’s property view.Static Text PropertiesThe

Extension View Editor 4-414-41Source MonikerThis is available only when the Source radio button is selected. Allows you to select a text variable tha

4-42 Widget Properties4-424.3.5 Text Entry WidgetUse this widget to allow the user to input text on the property view.Text Entry PropertiesThe propert

Extension View Editor 4-434-43Word Wrap Available only when the Multi-Line checkbox is selected. Select this checkbox if you would like the widget to

4-44 Widget Properties4-444.3.6 Rich Text Entry WidgetUse this widget to allow the user to enter text and change the text’s attributes (i.e., font, co

Extension View Editor 4-454-454.3.7 Format Entry WidgetUse this widget to allow the user to choose the format for certain values on the application’s

2-8 Objects2-8objects.The individual members of a collection object can be accessed by index number (like an array) or directly by name. Either approa

4-46 Widget Properties4-464.3.8 Numerical Input WidgetUse this widget to allow the user to input numerical values on the application’s property view.N

Extension View Editor 4-474-474.3.9 Matrix WidgetUse this widget to display related information in an organized fashion.Units There are three particu

4-48 Widget Properties4-48Matrix PropertiesThe properties available for a Matrix widget are described in the table below: Object PropertiesData Sets I

Extension View Editor 4-494-49Labels The Labels group has two drop-down lists, a numerical entry cell and a cell for a label moniker:• Unnamed. The f

4-50 Widget Properties4-50DataSet PropertiesAll data set types have the following common properties:Specific data set type properties include: Figure

Extension View Editor 4-514-51Attachment Figure 4.37Object DescriptionDrop List Sorting Assign a type of sorting for the list of attachments that a

4-52 Widget Properties4-52Boolean Enumeration Figure 4.38Object DescriptionTrue Icon Double-click on this cell to select an icon that represents the

Extension View Editor 4-534-53Numeric Figure 4.40Object DescriptionFormat Specify the format for the value in the data set. Clicking the Ellipsis i

4-54 Widget Properties4-54Spreadsheet Unit Figure 4.41Object DescriptionUnit System MonikerOptional setting. When set it allows the unit set used fo

Extension View Editor 4-554-55Worksheet Attach Numerical Format Figure 4.43Object DescriptionExpand StyleThere are three options for this drop-down

Automation 2-92-92.3 Automation SyntaxDeclaring ObjectsAn object in Visual Basic is another type of variable and should be declared. Objects can be de

4-56 Widget Properties4-564.3.10 Checkbox WidgetUse this widget for boolean (true/false or yes/no) situations.Checkbox PropertiesThe properties availa

Extension View Editor 4-574-574.3.11 Radio Buttons WidgetUse this widget when you want the user to make a single specific choice from a list of mutua

4-58 Widget Properties4-58Insert Adds another entry in to the radio button details matrix wherever the focus happens to be, but the entry will not be

Extension View Editor 4-594-594.3.12 Graphic Button WidgetUse this widget to send specific instructions to its base object when it is clicked by the

4-60 Widget Properties4-60Message This is the command(s) that will be executed/fired when the button is pressed. For the button shown above, the prope

Extension View Editor 4-614-61Sticky OptionsThese options allow you to set whether or not the button will remain in its pressed state (Stuck) when it

4-62 Widget Properties4-624.3.13 Group WidgetUse this widget to organize related information within a titled border on the application’s property view

Extension View Editor 4-634-634.3.14 Page Tabs Widget Use this widget to increase the amount of information that can appear on the application’s prop

4-64 Widget Properties4-64Draw Border Select this checkbox if would like a rectangular area around the tabs to have a three-dimensional sunken effect.

Extension View Editor 4-654-654.3.15 Ply Picker WidgetThis widget, used in conjunction with the tabs widget, provides a way to further organize infor

2-10 Automation Syntax2-10The example below assumes hycase is set to the SimulationCase object.GetObject, CreateObjectIn order to begin communication

4-66 Widget Properties4-66Ply Picker PropertiesThe properties available for a Page Picker widget are described in the table below: Object Description

Extension View Editor 4-674-674.3.16 Attachment Name WidgetUse this widget to display variables of type Attachment in a drop-down list format.Attachm

4-68 Widget Properties4-68Attach Message Allows you to specify a command(s) that will be executed/fired when a choice is made in the attachment name w

Extension View Editor 4-694-694.3.17 Enumeration WidgetUse this widget to display a list of names in a drop-down list format.Enumeration PropertiesTh

4-70 Widget Properties4-704.3.18 Unit Enumeration WidgetUse this widget to display a list of units in a drop-down list format.Match using abbreviation

Extension View Editor 4-714-71Unit Enumeration Properties The properties available for a Unit Enumeration widget are described in the table below: Ob

4-72 Widget Properties4-724.3.19 Text List WidgetUse this widget to display a list of object related information in text format, from which the object

Extension View Editor 4-734-73Track MonikerSupply a variable in this cell which will allow you to keep a record of the selected object in the list or

4-74 Widget Properties4-744.3.20 Enumeration List WidgetUse this widget to display a list of the labels in an enumeration.Draw Border Select this chec

Extension View Editor 4-754-75Enumeration List PropertiesThe properties available for a Enumeration List widget are described in the table below: Obj

Automation 2-112-11For application objects or document objects the codes are shown below:In the example below, hyCase is declared as type object so it

4-76 Widget Properties4-76Append Extra BlankSelect this checkbox if you want a blank row to always be present at the end of the list. This is useful w

Extension View Editor 4-774-774.3.21 Attachment List WidgetUse this widget to display a list of related objects.Attachment List PropertiesThe propert

4-78 Widget Properties4-78Track MonikerSupply a variable in this cell which will allow you to keep a record of the selected object in the list or set

Extension View Editor 4-794-79Hide Tags Select this checkbox if you do not want to show name of the flowsheet with the name of the object in the list

4-80 Widget Properties4-804.3.22 Level WidgetUse this widget to display a numerical value along with a graphical representation of the value as a perc

Extension View Editor 4-814-81Target MonikerThis is the variable to which you put your widget data and/or from which you get your widget data. It is

4-82 Widget Properties4-82Display Mode The display mode represents the graphical portion of the widget. Select either radio button:• Percent. The grap

Extension View Editor 4-834-834.3.23 Plot WidgetUse this widget to show a two-dimensional or three-dimensional graph. The appropriate plot is shown a

4-84 Widget Properties4-844.3.24 Worksheet Matrix WidgetUse this widget to display related information in an organized fashion. The Worksheet Matrix p

Extension View Editor 4-854-85Worksheet Matrix PropertiesThe properties available for a Worksheet Matrix widget are described in the table below: Obj

2-12 Automation Syntax2-12ActiveDocument property of hyApp.Object Properties, Methods, & HierarchyThe sequence of objects is set through a special

4-86 Widget Properties4-86Labels The Labels group has two drop-down lists, a numerical entry cell and a cell for a label moniker:• Unnamed. The first

Extension View Editor 4-874-874.3.25 ACTIVEX Container WidgetThis widget allows you to incorporate ActiveX objects in to your DefaultView form.Grids

4-88 Widget Properties4-88ActiveX Container PropertiesThe properties available for a ActiveX Container widget are described in the table below:Object

User Variables 5-15-15 User Variables 5.1 Introduction... 25.2 Addi

5-2 Introduction5-25.1 IntroductionUser Variables help you to increase the internal functionality of HYSYS objects, such as streams and unit operation

User Variables 5-35-3Regardless of where the User Variables matrix is located, the matrix is the same as the one shown in the figure below.• Flowshee

5-4 Adding a User Variable5-4• Simulation. If you want to add a User Variable to your simulation, open the Simulation menu in the menu bar and select

User Variables 5-55-5The following table lists and describes the icons in the User Variables property view:Before you add the first User Variable to

5-6 Adding a User Variable5-6To add a User Variable:1. Access the User Variables matrix in the object where you want to associate the User Variables.

User Variables 5-75-75.3 Importing/Exporting User VariablesYou may import and export User Variables between cases via the Import Export User Variable

Automation 2-132-13passed when the method is called. The type library provides information about which arguments are necessary to call a particular me

5-8 Importing/Exporting User 5-8A list of User Variables currently attached to the case appears in the User Variables In Case group. The list on the r

User Variables 5-95-9The file name you selected should now appear in the User Variables In Export File group under the Current Export File: text. A l

5-10 Data Types5-10not specified. You are prompted to provide an alternate Name or Tag if they are not unique among all User Variables attached to the

User Variables 5-115-11Dimensions Drop-down ListWhen a Real, Enumeration or Text data type is specified, the Dimensions drop-down list is available o

5-12 Data Types5-12This drop-down list defaults to variable type Index, which is a unitless, generic type. The Variable Changing macro can be used to

User Variables 5-135-135.5.3 Message Data TypeType Message variables have a single purpose: to execute their Fire macro when the user variable is inv

5-14 User Variables Tabs5-145.6.1 Macros TabThe Macros tab lists the macros that can be enabled for the variable currently being edited. The macros li

User Variables 5-155-15The checkboxes in the Variable group on the right of the Macros tab enables macros that are invoked when the value of the User

5-16 User Variables Tabs5-165.6.2 Attributes TabThe Attributes tab has two associated groups:• Activation•SolverActivation GroupThe Activation group r

User Variables 5-175-17With the User Enabled radio button selected, specific variables appear only in certain instances of an object type. The variab

2-14 Automation Syntax2-14collection object contains a set of properties and methods for navigating and manipulating the objects in the collection.The

5-18 User Variables Tabs5-18Solver GroupThe Solver group of the Attributes tab contains a single checkbox labelled Trigger Solve. This checkbox is onl

User Variables 5-195-19The native data type (Real, Text, etc.) is always included in the list of active filters. It cannot be deleted. To include a n

5-20 Code Editor5-20VariableThe second level of security is the Calculate Only setting. Select this option to ensure that only the User Variable’s mac

User Variables 5-215-21The Code Editor is shown below: Tool Tip TextA single quote (') preceding text in the Code Editor indicates a Visual Basi

5-22 User Variable Examples5-225.8 User Variable Examples5.8.1 Dew Point Temperature VariableThe following User Variable example can be applied to an

User Variables 5-235-233. In the Create New User Variable property view, enter the following information in the indicated fields: 4. On the Attribute

5-24 User Variable Examples5-245. On the Security tab, select the Calculate Only checkbox. This ensures that no one attempts to specify a value for t

User Variables 5-255-25Re-calculate the stream and the dew point temperature value appears in the User Variables page for all the streams in your sim

5-26 User Variable Examples5-265.8.2 Automatic Pump Energy StreamThe User Variable created in this example automatically adds an energy stream to a p

User Variables 5-275-275. Edit the enumeration values by clicking the Enumeration Values button. Create two labels in the left column of this propert

Automation 2-152-15necessary to subtract one in order to access all the objects in the collection.The example below, is identical to the first example

5-28 User Variable Examples5-288. Select the PostExecute() checkbox found on the Macro tab. Enter the following PostExecute macro in the Code Editor.

User Variables 5-295-29Now, whenever both inlet and outlet streams are connected to any pump in the case, and no energy stream is currently connected

5-30 User Variable Examples5-30The first three lines of comment in your code appear as tool tip fly by when the cursor hovers over the variable in on

User Variables 5-315-31Toggling the setting back to Not Run Yet would allow the macro to once again add and connect a new Energy stream during a stea

5-32 User Variable Examples5-32

User Unit Operation 6-16-16 User Unit Operation6.1 Introduction...

6-2 Introduction6-26.1 IntroductionThe User Unit Operation is a HYSYS unit operation much like any other, except that its behaviour is defined entirel

User Unit Operation 6-36-32. When the User Unit Operation has been added, the following property view appears: The property view shown above lists th

6-4 Adding a User Unit Operation6-45. To add an operation of that type, highlight the type you created and click the Add button. The User Unit Op pro

User Unit Operation 6-56-54. Click the Save button.5. The file is saved with *.huo file extension.Importing a User Unit Op1. Click the Import button

viiiTable of ContentsTechnical Support... vOnline Technical Support Center ...

2-16 Automation Syntax2-16implicitly a variant. Variants have considerably more storage associated with their use, so for a large application it is go

6-6 User Unit Op Property View6-66.3.1 Design TabThere are five pages associated with the Design tab: • Connections•Code•Variables•Notes•ExportConnec

User Unit Operation 6-76-7The first feed and first product nozzles are always active, but the other four nozzles can be activated or deactivated depe

6-8 User Unit Op Property View6-8The code environment in the User Unit Operation is very similar to that described for the User Variables.Code can be

User Unit Operation 6-96-9The three User Unit Operation sub-routines are described in the following table:Empty versions of these three sub-routines

6-10 User Unit Op Property View6-10The standard debugging property view is shown as follows: Variables PageYou can attach User Variables to the User

User Unit Operation 6-116-11Notes PageThe Notes page provides a text editor where you can record any comments or information regarding the User Unit

6-12 Dehumidifier Example6-126.4 Dehumidifier ExampleThe following example shows how to create a new User Unit Operation. This operation will function

User Unit Operation 6-136-136. Click the Create Type button on the Add a User Unit Operation property view. Enter Dehumidifier as the New User Operat

6-14 Dehumidifier Example6-148. To add code, switch to the Code page and click the Edit button. This opens the Edit Existing Code property view where

User Unit Operation 6-156-15stream wtr.Pressure.Calculate(feed.PressureValue) wtr.Temperature.Calculate(feed.TemperatureValue) wtr.MolarF

Automation 2-172-17property of a column. The array is set to hyStageCompFrac. This array is two-dimensional. The first dimension represents the compon

6-16 Dehumidifier Example6-16 If ActiveObject.Products2.Count = 0 Then GotOne = True ActiveObject.AddStatusCondition(slMissingReq

User Unit Operation 6-176-17 If Not CMFsKnown(0) Then ActiveObject.AddStatusCondition(slMissingOptionalInformation, 15, "Feed Compo

6-18 Dehumidifier Example6-18When this code has been inserted, the Dehumidifier operation is complete. Any additional Dehumidifier objects added to th

User Unit Operation 6-196-1911. Complete the Connections page by attaching streams as shown in the figure below: Deactivate the extra nozzles by clea

6-20 Dehumidifier Example6-20The PFD for the solved case, along with an attached stream table, is shown in the figure below: Figure 6.13

Aspen Custom Modeler Operation 7-17-17 Aspen Custom Modeler Operation7.1 Introduction...

7-2 Introduction7-27.1 IntroductionAspen Custom Modeler (ACM) is a component of the Aspen Engineering Suite designed to suit the need of the fast-pace

Aspen Custom Modeler Operation 7-37-37.2 Creating an ACM ModelThe functionality of the ACM Op is defined by the Aspen Property file and ACM exported

7-4 Creating an ACM Model7-42. Open MyPipe.acmf from the ModelExport folder in the Examples folder.The supplied “MyPipe” ACM example can be exported

Aspen Custom Modeler Operation 7-57-59. In the Contents of Models pane, right-click on the StreamMultiplier model icon, and select Compile from the o

2-18 Key HYSYS Objects2-182.4 Key HYSYS Objects2.4.1 HYSYS Object OverviewThere are over 340 automation objects exposed in HYSYS. These objects colle

7-6 Creating an ACM Model7-615. Click on the Variables tab.16. Select the Show All Variables checkbox to show all the variables.17. In this form, we

Aspen Custom Modeler Operation 7-77-719. In the All Items pane, right-click on the StreamMultiplier sub-branch under the Models branch.20. Select Mod

7-8 Creating an ACM Model7-822. The Export Model - Ports property view displays the ports associated with the ACM model. Keep the default settings. C

Aspen Custom Modeler Operation 7-97-926. Select Export from the object inspect menu. The Export property view appears.27. Select a directory that you

7-10 Creating an ACM Model7-107.2.2 Adding an ACM Operation in HYSYSAs a prerequisite to using the ACM Op, the simulation basis must have an Aspen Pr

Aspen Custom Modeler Operation 7-117-11The ACM Op property view appears.• To delete the ACM Op operation, click the Delete button. HYSYS will ask you

7-12 Creating an ACM Model7-12ACM Configuration PageThe ACM Configuration page lets you select an ACM exported model and an Aspen Properties based fl

Aspen Custom Modeler Operation 7-137-13Stream Ports PageThe Stream Ports page displays all the ports in the ACM model, and allows you to define and co

7-14 Creating an ACM Model7-14Solver Options PageThe Solver Options page sets the solver type and the failure recovery option.The options in the drop

Aspen Custom Modeler Operation 7-157-15your own User Variables and code to the ACM Op. You can attach code written in a Visual Basic compatible macro

Automation 2-192-19accessing or opening specific simulation cases.Syntax: Connecting to the ApplicationSet hyApp = CreateObject(“HYSYS.Application”)Sy

7-16 Creating an ACM Model7-16Click on a column label to sort the table by that column.Click again to reverse the sorting order.“Constant” specificat

Aspen Custom Modeler Operation 7-177-17shown here changes as you configure the model.7.2.8 Worksheet TabThe Worksheet tab consists of four pages:• Con

7-18 Creating an ACM Model7-18Composition PageThe Composition page allows you to specify the mole fraction for each component in the ACM Op streams.

Aspen Custom Modeler Operation 7-197-19ACM Op. If your model does not have dynamics behaviour or you require maximum calculation speed and optimal per

7-20 Creating an ACM Model7-20PF Specs PageThe PF Specs page allows you to select HYSYS stream pressure and flow variables that are used to write the

Aspen Custom Modeler Operation 7-217-217.2.10 Simulation Engine TabThe Simulation Engine tab allows you to enter OOMF script language commands for spe

7-22 Creating an ACM Model7-22The Simulation Engine page also allows you to record commands that you enter and play them back again later using the S

Customization FAQ A-1A-1A Customization FAQA.1 Automation FAQ... 2A.2 Ex

A-2 Automation FAQA-2A.1 Automation FAQ1. Whenever I change the Basis using Automation, HYSYS displays a property view “Do you want to be left in HOLD

Customization FAQ A-3A-3The text below is a HYSYS macro which demonstrates the above. 3. How do I use Automation to attach multiple feed and product

2-20 Key HYSYS Objects2-20Using GetObject and CreateObjectThe SimulationCase object and the Application object can be created directly through the Ge

A-4 Automation FAQA-4For example, if hyMix refers to a Mixer unit operation object and hyFeed1 and hyFeed2 refer to material stream objects, the follo

Customization FAQ A-5A-54. How do I use Automation to refer to a stream name which is a number?Ans: HYSYS assumes any variable which contains a numbe

A-6 Automation FAQA-66. How do I obtain component mass/molar/volume fractions from a Fluid object?Ans: Unfortunately, the Fluid object differs from th

Customization FAQ A-7A-79. How do I determine if an object reference actually points to an object?Ans: When an object reference is made, the referenc

A-8 Automation FAQA-8Now directly access the column specifications by name:13. How do I access a SpreadSheet unit operation via Automation?Ans: Use t

Customization FAQ A-9A-9If HYSYS is not running, then the above line generates error number 429 in Office 97 and 483 in Office 95. Error trapping can

A-10 Extensibility FAQA-10A.2 Extensibility FAQA.2.1 General Extensibility1. What is the difference between registering the EDF instead of the DLL?Ans

Customization FAQ A-11A-11d. Click the Start icon on the Visual Basic toolbar. The Debug property view appears. e. Load a HYSYS simulation case and i

A-12 Extensibility FAQA-124. When using FindVariable to set an object reference to an object in the EDF, when do I use .Variable and when do I use .Va

Customization FAQ A-13A-13A.2.2 Unit Operation Extensions1. What is the Container for a unit operation extension?Ans: The ExtnUnitOperationContainer

Automation 2-212-21Starting a Particular Version of HYSYSTo start a particular version of HYSYS via OLE, use one of the following HYSYS.Application Pr

A-14 Extensibility FAQA-14problems. 4. How do I set default values for numeric input or text boxes?Ans: Use the following procedure:Make object refere

Customization FAQ A-15A-15d. Click the Insert button.e. Select Delete Object from the list and click the OK buttons on the Select Message property vi

A-16 Extensibility FAQA-16h. In the extension code, use the value of the enumeration as appropriate: IsRecalling is only false when the extension is f

Customization FAQ A-17A-17Fixed Text (such as OK and Error). Select the Framed checkbox for each. Make sure the Enable Moniker field is empty. e. Cre

A-18 Extensibility FAQA-18radio buttons displays the appropriate text.xii. In the extension code to set the value of Status as appropriate:f. Dimensio

Customization FAQ A-19A-19f. Add an Enumeration widget. Double-click on the Target Moniker field or click the Ellipsis icon beside it and select th

A-20 Extensibility FAQA-20hyContainer is an object referenced to the Container object which is made in the Function Initialize section of the class mo

Customization FAQ A-21A-21d. Close the Object Manager property view and open the extension property view by double-clicking on it in the Existing Vie

A-22 Extensibility FAQA-22j. Add the following to the global declarations section:k. Add the following to the Execute function:12. How do I add a Comp

Customization FAQ A-23A-23d. Close the Object Manager property view and open the extension property view by double-clicking on it in the Existing Vie

2-22 Key HYSYS Objects2-22likewise its own property package and set of components. Sub-flowsheets can be accessed from the main flowsheet object thro

A-24 Extensibility FAQA-24Empty Text field. <empty> is the HYSYS standard.v. Enter the text used when a cell is uneditable in the Matrix in the

Customization FAQ A-25A-25j. Add the following to the Initialization function:k. Add the following to the Execute function:13. How do I change the na

A-26 Extensibility FAQA-26Use the following procedure:a. Add a Static Text widget and double-click it or right-click and select Static Text Properties

Customization FAQ A-27A-2715. How do I display results in the EDF?Ans: Use the following procedure:a. Open the HYSYS Extension View Editor with the e

A-28 Extensibility FAQA-28c. In the Variables of Selected Object matrix, enter the following: The Triggers Solve checkbox should be selected or cleare

Customization FAQ A-29A-2916. How do I automatically set the Calc Level (calculation level) of an extension?Ans: Add the following to the Initialize

A-30 Extensibility FAQA-30To illustrate this, assume that the temperature of the inlet stream to a unit operation is changed from 10°C to 41°C. The fo

Customization FAQ A-31A-31•Pressure Drop•Outlet TemperatureThe Cooler calculates its Duty and Outlet Pressure based on these values. If the inlet tem

A-32 Extensibility FAQA-32A problem arises when the unit operation uses a “Balance” call to calculate the compositions and flow of its streams. The “B

Customization FAQ A-33A-33A.2.3 Kinetic Reaction Extensions1. What is the Container for a Kinetic Reaction Extension?Ans: The ExtnKineticReactionCont

Automation 2-232-232.4.3 Basis ObjectsThe Basis objects refer predominantly to objects handled by the HYSYS BasisManager. The BasisManager object in H

A-34 Extensibility FAQA-34

I-1AAssays 2-27Assays Collection Object 2-27Automationdefinition 1-3starting a case 2-11–2-12BBlend(s) 2-28CCLSID 3-21Code Editor 5-20Collection Objec

I-2 I-2OObjecthierarchy 2-3, 2-12Object Browser 2-4accessing 2-5Object Definition Matrix 4-24Objectscollection 2-14declaring 2-9definition 2-2HYSYS 2-

I-3I-3radio button 4-57rich text 4-44static text 4-40text entry 4-42text list 4-72unit enumeration 4-70worksheet matrix 4-84

I-4 I-4

2-24 Key HYSYS Objects2-24PropertyPackage object and Components object. When you access the fluid package in this way, changes can be made to the pro

Automation 2-252-25contains the PengRobinson property package.Component(s)The Components object is accessed through the FluidPackage object. Each Flui

ix4.1 Introduction ... 4-34.2 Using the View Editor... 4-84.3 Wi

2-26 Key HYSYS Objects2-26counted.HypotheticalsThe HypoGroups collection object is accessed from the BasisManager. This object contains a collection

Automation 2-272-27invoked prior to adding this hypothetical to the case. Hypotheticals have a * appended to the name once they are created.2.4.4 Oils

2-28 Key HYSYS Objects2-28 Assays and Blends are not estimated until the EndOilChange method is invoked.AssaysCollection & AssaysThe AssaysCollec

Automation 2-292-29Below is an example on creating an assay.Blend(s)Blends are created through the BasisManager and can be completed by specifying at

2-30 Key HYSYS Objects2-30blend is also assigned to a stream in the HYSYS case.2.4.5 Stream ObjectsThe main objects of the stream category are the Pr

Automation 2-312-31methods.In most instances the collection object and member object of the collection have nearly similar names. The name of the coll

2-32 Key HYSYS Objects2-32appropriate components.Additional Functions for Stream CharacterizationAspen HYSYS Petroleum Refining has the following fun

Automation 2-332-33If you have specified TargetValue then specify TargetPFDif as-32767.A Petroleum Assay name (specified as szAssayName) must exist in

2-34 Key HYSYS Objects2-34vtTemp1(5) = 1173.15vtProp1(0) = 0.01vtProp1(1) = 0.03vtProp1(2) = 0.2vtProp1(3) = 2vtProp1(4) = 3vtProp1(5) = 5sulKey = 11

Automation 2-352-35Example:Dim x As VariantDim intI As Integer Dim bsCompBasisVarType As StringDim bsTargetDistType As StringDim vtTargetTemps(6)

Introduction 1-11-11 Introduction1.1 Customization ... 21.2 Automation

2-36 Key HYSYS Objects2-36vtTargetLEcompId(6) = 2 ‘ EthanevtTargetLEcompId(7) = 14 ‘ CO2vtTargetLEcompId(8) = 15 ‘ H2SvtTargetLEcompId(9) = 55 ‘ Pro

Automation 2-372-37in the component view as shown below:Also note that this function can only be used with HYSYS components, since Aspen Properties pu

2-38 Key HYSYS Objects2-38Property Keys IndexThe following is the list of property keys for commonly used properties: Figure 2.7Property Name Figure

Automation 2-392-39Viscosity @ 38C 11038Viscosity @ 50C 11039Viscosity @ 60C 11040Wax Content 11041Pi C6 22DMB Wt Pct 11042Pi C6 22DMB Vol Pct 1

2-40 Key HYSYS Objects2-40Pn C7 Heptane Vol Pct 11081Pn C8 Octane Wt Pct 11082Pn C8 Octane Vol Pct 11083Pn C9 Nonane Wt Pct 11084Pn C9 Nonane Vol

Automation 2-412-41N C8 cyc-C6 Wt Pct 11124N C8 cyc-C6 Vol Pct 11125N C9 cyc-C5 Wt Pct 11126N C9 cyc-C5 Vol Pct 11127N C9 cyc-C6 Wt Pct 11128N C9

2-42 Key HYSYS Objects2-42Fluid ObjectA Fluid object is derived from a single ProcessStream through the DuplicateFluid method. A Fluid object is esse

Automation 2-432-43flashed without interfering with the simulation case.The example below, shows how to create a Fluid off of a stream and use the Flu

2-44 Key HYSYS Objects2-44accessed to determine the type of phase.The example below, enumerates through the FluidPhases of a Fluid and displays the p

Automation 2-452-45OperationsAll operations have a few properties and methods in common. Operation objects contain properties for determining the feed

1-2 Customization1-21.1 CustomizationUnlike its accompanying volumes, the Customization Guide does not discuss exact procedures for accomplishing task

2-46 Key HYSYS Objects2-46ColumnOp & ColumnFlowsheetThe column operation is a special kind of operation in HYSYS and actually contains its own fl

Automation 2-472-47value, current value, and status.The example below, enumerates through all the column specifications and displays in a property vie

2-48 Key HYSYS Objects2-48related to the fluids residing on a particular column stage.The example below, loops through each feed stage and displays i

Automation 2-492-49RealVariable/RealFlexVariableThe RealVariable object provides additional information about a particular variable such as its units

2-50 Key HYSYS Objects2-50returned to variants.The presence of Flex in the object name indicates the possibility of a dynamic array (in other words,

Automation 2-512-51vsDefaultedValue are integer variables specified in the type library. Fixed AttachmentsThe FixedAttachments object is a collection

2-52 Key HYSYS Objects2-52Solver & IntegratorThe Solver is accessed from the SimulationCase object. The Solver object can be used to turn the cal

Automation 2-532-53SpreadsheetOp & SpreadsheetCell(s)The SpreadsheetCells object is a collection of SpreadsheetCell objects. The cell properties a

2-54 Key HYSYS Objects2-542.4.8 PFD ObjectsPFD objects are used for the manipulation and automation of PFDItems. A PFDItem is any item that is found

Automation 2-552-552.5 Example 1: The Macro Language EditorIn this example, you use the HYSYS Macro Language Editor to build a macro tool that display

Introduction 1-31-3be easily distributed to other machines, and they appear as any other HYSYS object in the program. You could easily develop an exte

2-56 Example 1: The Macro Language 2-562. Add a function that returns the Stream object that you choose from a list. Creating separate functions allo

Automation 2-572-573. At this time it is probably a good idea to globally declare some constants that are used in the Main sub-routine as shown below.

2-58 Example 1: The Macro Language 2-58Set flow = strm.MassFlowIf flow.IsKnown Then flowValue = flow.GetValue(“lb/hr”) flowValue = flowValue / 3

Automation 2-592-59For num = 1 To nPipes rSquared = pipeSizes(num) * pipeSizes(num)/144.0/4.0 Mach = flowValue / pi / rSquared / soundVel sizetxt =

2-60 Example 1: The Macro Language 2-605. Once you have finished adding this code, you should be ready to run the program. First ensure that HYSYS ha

Automation 2-612-617. Be sure to save the program by doing one of the following:• Right-click on any area of the Macro Language Editor property view,

2-62 Example 2: Automation in Visual 2-622.6 Example 2: Automation in Visual BasicIn this example HYSYS is used as the Automation server for a unit c

Automation 2-632-63Your screen should appear similar to the figure below. 2. By default you should have a form associated with the project. Begin, by

2-64 Example 2: Automation in Visual 2-645. From the toolbox select the Combo Box icon and create a combo box on the form as shown below. 6. Ensure t

Automation 2-652-6510. Now add an Text Box next to the Combo Box you created. Use the method described in Steps #6 - #7 to name this Text Box ebFromV

1-4 Automation & Extensibility1-4another object such as a text document. Changes to values in the spreadsheet would automatically be updated in t

2-66 Example 2: Automation in Visual 2-6612. Only two more objects are required on the form. Select the Command icon control from the toolbox and add

Automation 2-672-67The following property view should appear: 14. Begin by declaring the following variables under the Option Explicit declaration. F

2-68 Example 2: Automation in Visual 2-6815. The first sub-routine should already be declared. The Form_Load sub-routine is the first sub-routine cal

Automation 2-692-6917. The next 2 sub-routines reset the lbToValue label whenever an option is selected in either the ddFromUnit or ddToUnit combo box

2-70 Example 2: Automation in Visual 2-7019. You are now ready to compile and run the program. Before you begin, please ensure that you have a copy o

Extensibility 3-13-13 Extensibility3.1 Introduction... 33.2 Impleme

3-2 Extensibility 3-23.9.2 ExtnPropertyPackage Interface ...513.10 Extension Unit Operations ...

Extensibility 3-33-33.1 IntroductionHYSYS provides the unique capability of enhancing its functionality through the addition of custom objects to a si

3-4 Introduction3-4HYSYS finds extensions by looking for specific keys in the System Registry. When an extension is registered on a computer, informat

Extensibility 3-53-53.2 Implementing InterfacesAn extension implements an interface if it supports the methods in that interface. There are two differ

Introduction 1-51-5A HYSYS extension is typically composed of two distinct and interdependent components; an ActiveX Server DLL and an Extension Defin

3-6 Data Types3-63.2.2 Implementing an Interface Through a Custom InterfaceAn extension can also be implemented by overloading the Custom interfaces d

Extensibility 3-73-73.4 Extension Development KitA number of tools are provided in the HYSYS Extension Development Kit. These tools are not required t

3-8 Extension Development Kit3-8The HYSYS View EditorAllows you to:• Define extension information for the registration program.• Define Variables for

Extensibility 3-93-93.5 Creating an Extension3.5.1 In Visual BasicCreating an extension in Visual Basic is a very straightforward procedure. The follo

3-10 Creating an Extension3-10Once the preliminary definition information is provided, you specify the variables that the object owns and that are vi

Extensibility 3-113-11Each DefaultView form must have a unique name. The object’s default property view must be called DefaultView as it is the proper

3-12 Creating an Extension3-12Debug the ExtensionTo debug the extension, you can set breakpoints on just about any line in your Visual Basic class. I

Extensibility 3-133-133.5.2 In C++The following six steps provide a framework for creating an extension in C++:1. Create the Extension Definition.2. I

3-14 Creating an Extension3-14Once the preliminary definition information is provided, you specify the variables that the object owns and that is vis

Extensibility 3-153-15Definitions of the interfaces that you must implement (as well as any interfaces provided by HYSYS objects) are provided in the