PROII Com Server Reference Guide

SimSci
PRO/II 9.3
COM Server
Reference Guide
May 2014
All rights reserved. No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by
any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of
Invensys Systems, Inc. No copyright or patent liability is assumed with respect to the use of the information
contained herein. Although every precaution has been taken in the preparation of this documentation, the publisher
and the author assume no responsibility for errors or omissions. Neither is any liability assumed for damages
resulting from the use of the information contained herein.
The information in this documentation is subject to change without notice and does not represent a commitment on
the part of Invensys Systems, Inc. The software described in this documentation is furnished under a license or
nondisclosure agreement. This software may be used or copied only in accordance with the terms of these
agreements.
2014 by Invensys Systems, Inc. All rights reserved.
Invensys Systems, Inc.

26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
(949) 727-3200
http://www.simsci.com/
For comments or suggestions about the product documentation, send an e-mail message to
ProductDocumentationComments@invensys.com.
All terms mentioned in this documentation that are known to be trademarks or service marks have been
appropriately capitalized. Invensys Systems, Inc. cannot attest to the accuracy of this information. Use of a term in
this documentation should not be regarded as affecting the validity of any trademark or service mark.
Invensys, Invensys logo, PRO/II, and SimSci are trademarks of Invensys plc, its subsidiaries and affiliates. All other
brands may be trademarks of their respective owners.
Table of Contents
Introduction --------------------------------------------------------- 1
Overview ---------------------------------------------------------------------------- 1
Notes on Syntax ------------------------------------------------------------------- 1
Notes on Examples --------------------------------------------------------------- 2
Further Reference ---------------------------------------------------------------- 2
Server Object ------------------------------------------------------- 3

Overview ---------------------------------------------------------------------------- 3
General Server and File Manipulation Methods --------------------------- 4
Error Subsystem Methods ------------------------------------------------------ 5
Server Object Properties -------------------------------------------------------- 6
DebugLevel --------------------------------------------------------------------------------- 6
INIFile ---------------------------------------------------------------------------------------- 6
MsgCount ----------------------------------------------------------------------------------- 6
Status ---------------------------------------------------------------------------------------- 7
Server Object Methods ---------------------------------------------------------- 8
ClearMsgs ---------------------------------------------------------------------------------- 8
DbsGetAttrId ------------------------------------------------------------------------------- 9
DbsGetClassId ---------------------------------------------------------------------------- 9
Export --------------------------------------------------------------------------------------- 10
GenerateReport -------------------------------------------------------------------------- 11
GetClassCount --------------------------------------------------------------------------- 12
GetClassNames -------------------------------------------------------------------------- 12
GetGroupClassCount ------------------------------------------------------------------- 13
GetGroupClassNames ----------------------------------------------------------------- 14
PRO/II COM Server Reference Guide I

GetGroupCount -------------------------------------------------------------------------- 15
GetGroupNames ------------------------------------------------------------------------- 16
GetOption ---------------------------------------------------------------------------------- 16
GetSecuritySeat -------------------------------------------------------------------------- 18
Import --------------------------------------------------------------------------------------- 19
Initialize ------------------------------------------------------------------------------------- 19
MsgText ------------------------------------------------------------------------------------ 21
MsgCode ----------------------------------------------------------------------------------- 22
MsgSeverity ------------------------------------------------------------------------------- 22
NewDatabase ----------------------------------------------------------------------------- 23
OpenDatabase --------------------------------------------------------------------------- 23
ReleaseSecuritySeat ------------------------------------------------------------------- 24
RunCalcs ----------------------------------------------------------------------------------- 25
SetCallbackPtr ---------------------------------------------------------------------------- 26
SetOption ---------------------------------------------------------------------------------- 27
Unload -------------------------------------------------------------------------------------- 28
PRZFileConversion --------------------------------------------------------------------- 28
Database Object ------------------------------------------------- 31

Overview -------------------------------------------------------------------------- 31
Database Object Properties -------------------------------------------------- 34
Name ---------------------------------------------------------------------------------------- 34
Status --------------------------------------------------------------------------------------- 34
Database Object Methods ---------------------------------------------------- 34
ActivateObject ---------------------------------------------------------------------------- 34
BuildCompCalc --------------------------------------------------------------------------- 35
BuildExecSequence--------------------------------------------------------------------- 36
BuildRefStreams ------------------------------------------------------------------------- 36
BuildStreamCalc ------------------------------------------------------------------------- 37
BuildThermoCalc------------------------------------------------------------------------- 37
PRO/II COM Server Reference Guide II

CalculateStreamProps ----------------------------------------------------------------- 38
CalculateStreamProps2---------------------------------------------------------------- 39
CalculateUnitProps ---------------------------------------------------------------------- 40
CheckData --------------------------------------------------------------------------------- 42
ConvertIdToNum ------------------------------------------------------------------------- 43
ConvertNumToId ------------------------------------------------------------------------- 44
ConvertValue ----------------------------------------------------------------------------- 45
ConvertValue2 ---------------------------------------------------------------------------- 46
CopyTrayToStream --------------------------------------------------------------------- 47
CreateObject ------------------------------------------------------------------------------ 49
CrossCheckControlUnitOps ---------------------------------------------------------- 50
CrossCheckSpecsVarys --------------------------------------------------------------- 50
CrossCheckUnitOps -------------------------------------------------------------------- 51
DbsSaveDb -------------------------------------------------------------------------------- 51
DeleteObject ------------------------------------------------------------------------------ 52
FlashStream ------------------------------------------------------------------------------- 53
GenerateAssayComponents --------------------------------------------------------- 54
GetObjectCount -------------------------------------------------------------------------- 56
GetObjectNames------------------------------------------------------------------------- 56
GetUOMString ---------------------------------------------------------------------------- 57
GetUOMString2 -------------------------------------------------------------------------- 58
MiscChecks-------------------------------------------------------------------------------- 59
ObjectExists ------------------------------------------------------------------------------- 60
ObjectExistsInGroup -------------------------------------------------------------------- 61
RenameObject---------------------------------------------------------------------------- 62
RestoreInputData ------------------------------------------------------------------------ 63
TowerBurst -------------------------------------------------------------------------------- 64
TowerMerge ------------------------------------------------------------------------------- 64
Database Data Object ----------------------------------------- 65
PRO/II COM Server Reference Guide III

Overview -------------------------------------------------------------------------- 65
Database Data Object Properties ------------------------------------------- 66
Name ---------------------------------------------------------------------------------------- 66
Status --------------------------------------------------------------------------------------- 66
Database Data Object Methods --------------------------------------------- 66
Commit-------------------------------------------------------------------------------------- 66
GetAttribute -------------------------------------------------------------------------------- 67
GetAttributeCount ----------------------------------------------------------------------- 69
GetAttributeDataType ------------------------------------------------------------------ 70
GetAttributeName ----------------------------------------------------------------------- 70
GetAttributeSystemDataType -------------------------------------------------------- 71
GetAttributeUOM------------------------------------------------------------------------- 71
GetThermoDefaults --------------------------------------------------------------------- 72
PopCopy ----------------------------------------------------------------------------------- 73
PullPrevCopy ----------------------------------------------------------------------------- 75
PushNewCopy ---------------------------------------------------------------------------- 75
PutAttribute -------------------------------------------------------------------------------- 75
UnitCount ---------------------------------------------------------------------------------- 77
UnitSize ------------------------------------------------------------------------------------- 77
Appendix A: Unit of Measure Codes --------------------- 79
Appendix B: Pro II Object Reference --------------------- 83

Component Input Data ----------------------------------------------------------------- 83
Component Calculated Data ------------------------------------------------------- 115
Stream Input Data --------------------------------------------------------------------- 142
Stream Calculated Data ------------------------------------------------------------- 154
Flash Input Data------------------------------------------------------------------------ 179
Flash Calculated Properties -------------------------------------------------------- 183
Pump Input Data ----------------------------------------------------------------------- 184
PRO/II COM Server Reference Guide IV

Pump Calculated Properties -------------------------------------------------------- 185
Valve Input Data ----------------------------------------------------------------------- 187
Valve Calculated Properties -------------------------------------------------------- 188
Mixer Input Data------------------------------------------------------------------------ 189
Mixer Calculated Properties -------------------------------------------------------- 190
Splitter Input Data --------------------------------------------------------------------- 191
Splitter Calculated Properties ------------------------------------------------------ 193
Compressor Input Data -------------------------------------------------------------- 194
Compressor Calculated Properties ----------------------------------------------- 199
Expander Input Data ------------------------------------------------------------------ 203
Expander Calculated Properties --------------------------------------------------- 204
Pipe Input Data ------------------------------------------------------------------------- 206
Pipe Calculated Properties ---------------------------------------------------------- 210
Blend UnitInput Data ------------------------------------------------------------------ 214
Blend Unit Calculated Properties -------------------------------------------------- 215
Column Input Data -------------------------------------------------------------------- 216
Column Calculated Properties ----------------------------------------------------- 243
HX Input Data --------------------------------------------------------------------------- 257
HXRIG Input Data --------------------------------------------------------------------- 268
HXRIG Calculated Properties ------------------------------------------------------ 283
LNGHX Input Data -------------------------------------------------------------------- 292
LNGHX Calculated Data ------------------------------------------------------------- 296
PFR Input Data ------------------------------------------------------------------------- 300
PFR Calculated Properties ---------------------------------------------------------- 311
ConReactor Input Data --------------------------------------------------------------- 315
ConReactor Calculated Properties ----------------------------------------------- 320
Gibbs Input Data ----------------------------------------------------------------------- 324
Gibbs Calculated Properties -------------------------------------------------------- 332
EquReactor Input Data --------------------------------------------------------------- 341
EquReactor Calculated Properties------------------------------------------------ 345
BatchDist Input Data ------------------------------------------------------------------ 348
PRO/II COM Server Reference Guide V

BatchDistil Calculated Data --------------------------------------------------------- 372
BatReactor Input Data ---------------------------------------------------------------- 376
Depressure Input Data --------------------------------------------------------------- 390
Depressure Calculated Properties ------------------------------------------------ 398
Controller Input Data ------------------------------------------------------------------ 402
Controller CalculatedProperties --------------------------------------------------- 402
MVC Input Data ------------------------------------------------------------------------ 403
MVC Calculated Properties --------------------------------------------------------- 404
Optimizer Input Data ------------------------------------------------------------------ 406
Optimizer Calculated Properties --------------------------------------------------- 408
Stream Calculator Input Data ------------------------------------------------------ 411
Stream Calculator Calculated Properties --------------------------------------- 416
HcurveInput Data ---------------------------------------------------------------------- 425
Hcurve Calc Data ---------------------------------------------------------------------- 427
PRO/II COM Server Reference Guide VI

Introduction
Overview
This guide describes the Application Programming Interface (API) to the
PRO/II COM Server. The PRO/II COM Server allows full read/write
access to PRO/II simulation databases using Microsoft COM
technology. Any language or application that supports COM can use the
methods and properties described here. This includes Microsoft Visual

Basic , Microsoft Excel, and C++ applications written using the Win32
API, the MFC (Microsoft Foundation Classes) framework, or the ATL
(ActiveX Template Library) framework. The examples in this document
are written in Visual Basic (VB).
There are three types of objects available in the PRO/II COM Server:
Server Object: This singleton object is used to initialize and manage
interaction with the PRO/II COM Server.
Database Object: This object is used to interact with a specific
simulation database.
The PRO/II COM Server can open only one database at a time.
Data Object: Each data object is used to interact with a
specific object in PRO/II: components, thermodynamic systems,
streams, and unit operations. Data are read from and written to
these objects using the GetAttribute and PutAttribute methods.
Notes on Syntax
In this document, the syntax of the properties and methods is expressed
in the Visual Basic 6.0 language. This language is also used as the macro
language for Microsoft Excel.
Visual Basic allows the developer to implicitly define the data type of a
variable by ending it with a special character. This syntax is used in a
number of the examples in this document.
A variable name ending in a percent symbol, such asLevel% indicates
that the variable is of Integer type.
A variable name ending in a dollar symbol ($), such
asobjName$indicates that the variable is of String type.
The term Nothing is also used when referring to object variables.
Nothing is a reserved keyword in Visual Basic that is used to
PRO/II COM Server Reference Guide 1

indicate that an object variable is not assigned. When you assign the
value of Nothing to an existing object variable, Visual Basic will
decrement the reference count of the COM object associated with that
variable by calling the COM function IUnknown::Release. When
the reference count drops to zero, the COM object will be deleted
from memory.
Notes on Examples
Each example is a complete Visual Basic program. You can copy these
code examples into your own Visual Basic or Excel macros and
subroutines. The examples use simulation databases that can be created
with the keyword files supplied with the PRO/II installation in the user
and user\applib directories. Before running one of the Visual Basic
examples, you should start PRO/II with PROVISION, import the keyword
file, solve, save, and exit. At that point, the simulation database (*.prz) will
be ready.
The examples also assume that PRO/II 8.3 has been installed in the
directory c:\simsci\proii83. Modify the directory names in the examples if
your installation is different.
Further Reference
For further reference, see the following documents:
PRO/II COM Server Programmers Guide and Tutorial: Provides an overview
of using Visual Basic to interact with the PRO/II COM Server.

Server Object
Overview
The Server object must be created and initialized before any
simulation database can be created, opened, or solved. To create
the Server Object, use the language-specific method which
creates a COM object. For example, the Visual Basic code to create
the Server Object for PRO/II 8.3 is:
Dim P2SRV as Object
Set P2SRV = CreateObject("SimSciDbs.Database.83")
...
Where:
"SimSciDbs.Database.81" is the progid of the specific version of
PRO/II COM Server to be created. Since multiple versions of PRO/II
can be installed on a single machine, the application must specify
the specific version of PRO/II to be used. For example:
PRO/II PRO/II
progid string progid string
Version Version
7.1.x SimSciDbs.Database.71 8.3.x SimSciDbs.Database.83
Once the Server object has been created, the properties and
methods can be used as described below and in the PRO/II COM
Server Programmers Guide and Tutorial.
The Server object has the following properties:
DebugLevel Amount of debug information to write to the debug file.
INIFile Name and path of the .INI file.
MsgCount Number of errors, warnings, and messages currently

in the internal buffer.

Status Server status. Any method that causes an internal
error will set this property to a non-zero value.
The Server object has the two classes of methods which are as
follows:
General Server and File Manipulation methods
Error Subsystem methods
Each method is described briefly here. Detailed information is
available in the following section, Server Object Methods.
General Server and File Manipulation Methods
DbsGetAttrId Returns the numeric identifier corresponding to the
supplied class identifier and name of a PRO/II
attribute.
DbsGetClassId Returns the numeric class identifier corresponding to

the supplied PRO/II object class name.
Export Exports the specified simulation database to a

keyword file.
GenerateReport Generates a report for the specified simulation.
GetClassCount Returns the number of object classes available from

the PRO/II COM server.
GetClassNames Returns the individual object class name specified by

the index.
GetGroupClassCount Returns the total number of object classes belonging

to the specified group.
GetGroupClassNames Returns the object class name belonging to the

specified group name and corresponding to the
specified index.
GetGroupCount Returns the total number of object class groups in

PRO/II.
GetGroupNames Returns the group name corresponding to the

specified index.

GetOption Returns the value of an option in the PRO/II COM
server.
GetSecuritySeat Acquires a software security seat so that subsequent

calls to security-aware methods will not need to
perform individual security operations.
Import Imports the specified keyword file, creating a new

Initialize Initializes the PRO/II COM Server.
NewDatabase Creates a new PRO/II simulation database.
OpenDatabase Opens an existing PRO/II simulation database.
ReleaseSecuritySeat Releases the software security seat previously

acquired by a call to GetSecuritySeat.
RunCalcs Solves the specified simulation.
SetCallbackPtr Internal method reserved for future use.
SetOption Sets the value of an option in the PRO/II COM

server.
Unload Shuts down the database access features of the

COM server in preparation for RunCalcs or
GenerateReport. (Deprecated since 7.1)
Error Subsystem Methods

ClearMsgs Removes all messages from the internal buffer.
MsgCode Returns an error, warning, or message code from the

internal buffer.
MsgSeverity Returns an error, warning, or message severity code from

the internal buffer.
MsgText Returns an error, warning, or message string from the

internal buffer.

Server Object Properties
DebugLevel
Description
Returns or sets the level determining the amount of debug information to
write to the debug output file. The name of the debug output file is
specified in the Initialize method. The recognized levels are:
0 dumps calls to Server Functions.
1 dumps 0-level information and function details.
2 dumps 1-level information and memory allocation

information.
Syntax
level% = object.DebugLevel
INIFile
Description
Returns the path and name of the PRO/II initialization file. This file
contains information regarding configuration and default selections for
the installed version of PRO/II.
When the PRO/II COM Server is initially started, this value is set to a
default value. Typically, this file is named proii.ini and it is located in
the user directory of the PRO/II installation structure. It can also be
changed by supplying a new value in the Initialize method.
Syntax
IniFile$ = object.INIFile
MsgCount
Description
Returns the number of errors, warnings, and messages in the internal
message buffer.
Methods such as FlashStream or Commit may write detailed
informational messages or errors to the internal buffer. Use MsgCount
and MsgText to retrieve these messages.
Syntax
msgcount% = object.MsgCount

Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
p2Database$ = "c:\SimSci\proii81\user\Applib\R3R.prz"
Set P2DB = P2SRV.OpenDatabase(p2Database$)
P2SRV.ClearMsgs
' Perform flash and display the results
sResults$ = P2DB.FlashStream("1")
MsgBox sResults$, vbOKOnly, "Flash Results"
' If there are errors or messages get them here

nMsg% = P2SRV.MsgCount
If nMsg% > 0 Then
For i% = 0 To (nMsg% - 1)
sMessage$ = P2SRV.MsgText(i%)
Next
End If
Set P2DB = Nothing
Set P2SRV = Nothing
Status
Description
Returns the internal server status. A status of zero means no error has
been encountered.
The methods in the Server Object may change the value of this property
if an error has occurred.
When this property is retrieved, the Status is reset to zero

automatically.

Syntax
stat% = object.Status
Server Object Methods
ClearMsgs
Description
Removes all errors, warnings, and messages from the internal buffer.
This method is typically used before a method such as FlashStream or
Commit to clear the internal message buffer.
Syntax
object.ClearMsgs
Return Value
None.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
P2SRV.ClearMsgs

If nMsg% > 0 Then
For i% = 0 To (nMsg % - 1)
Next
End If

Set P2DB = Nothing
Set P2SRV = Nothing
DbsGetAttrId
Description
Each attribute in a PRO/II object is identified by a name such as the
attribute Composition of the "StreamIn" class. This method returns
the numeric identifier corresponding to the text string.
This method is not typically used in a PRO/II COM application.
Syntax
attrid% = object.DbsGetAttrId(classId, attrName)
Arguments
classId The numeric class identifier. Use the DbsGetClassId

method to get this value from the class name.
attrName The PRO/II object attribute name. Use GetAttributeName

to get a list of recognized attributes for specific PRO/II
object classes.
Return Value
The numeric code corresponding with the PRO/II attribute for the
specified object class.
Example
Dim P2SRV As Object
P2SRV.Initialize
classid% = P2SRV.DbsGetClassId("Stream")
attrid% = P2SRV.DbsGetAttrId(classid%, "Temperature")
Set P2SRV = Nothing
DbsGetClassId
Description
Each object class in PRO/II is identified by a name such as
"StreamIn" or Valve. This method returns the numeric identifier
corresponding to the text string. The numeric identifier can be used in
methods requiring a numeric class identifier, such as DbsGetAttrId.

This method is not typically used in a PRO/II COM application.
Syntax
classid% = object.DbsGetClassId(className)
Arguments
className The PRO/II object class name. Use GetClassNames or

GetGroupClassNames method to get a list of recognized
object class names.
Return Value
The numeric code corresponding with the PRO/II object class.
Example
Dim P2SRV As Object
P2SRV.Initialize
classid% = P2SRV.DbsGetClassId("Stream")
attrid% = P2SRV.DbsGetAttrId(classid%, "Temperature")
Set P2SRV = Nothing
Export
Description
Exports the specified simulation database to a keyword file.
Syntax
retCode% = object.Export(dbName, keywordFile)
Arguments
dbName Path and name of the simulation database to export.
keywordFile Name of keyword file to generate.
Return Value
0 no errors
5 specified simulation database was not found
Example
Dim P2SRV As Object

P2SRV.Initialize
p2KwdFile$ = "c:\SimSci\proii81\user\Applib\R3R_new.inp"
retCode% = P2SRV.Export(p2Database$, p2KwdFile$)
Set P2SRV = Nothing
GenerateReport
Description
This generates a report for the specified simulation. The name of the
report will be the name of the simulation database with the extension
.out.
Syntax
retCode% = object.GenerateReport(dbName)
Arguments
dbName Path and name of simulation database.
Return Value
<0 security missing or improperly installed
1 completed with no errors or warnings
2 completed with warnings
3 errors were generated
5 specified simulation database was not found
Example
Dim P2SRV As Object
P2SRV.Initialize
retCode% = P2SRV.GenerateReport(p2Database)
' the name of the report is R3R.OUT
Set P2SRV = Nothing

GetClassCount
Description
Returns the number of object classes available from the PRO/II COM
Server.
Syntax
clscount% = object.GetClassCount
Arguments
None.
Return Value
The number of object classes.
Example
Dim P2SRV As Object
P2SRV.Initialize
clscount% = P2SRV.GetClassCount
For i% = 0 To clscount% - 1
clsname$ = P2SRV.GetClassNames(i%)
Next
Set P2SRV = Nothing
GetClassNames
Description
Returns the name of an object class with the specified index. This
function is typically used with the GetClassCount method.
Syntax
clsname$ = object.GetClassNames(index)
Arguments
index The index of the class name to retrieve. Specify 0

to return the first class name.
Return Value
The class name returned as a string.

Example
Dim P2SRV As Object
P2SRV.Initialize
clscount% = P2SRV.GetClassCount
clsname$ = P2SRV.GetClassNames(i%)
Next
Set P2SRV = Nothing
GetGroupClassCount
Description
The object classes in PRO/II are organized into groups. For example,
the Valve class and the Pump class both belong to the "Unit" group.
This method returns the total number of classes in the specified group.
To get the names of the classes, use the method
GetGroupClassNames. To get the list of groups, use the methods
GetGroupCount and GetGroupNames.
Syntax
clscount% = object.GetGroupClassCount(groupName)
Arguments
groupName The group name. Use GetGroupCount and

GetGroupNames to get the list of valid groups.
Return Value
The number of PRO/II object classes in the specified group.

Example
Dim P2SRV As Object
P2SRV.Initialize
clscount% = P2SRV.GetGroupClassCount("Unit")
clsname$ = P2SRV.GetGroupClassNames("Unit", i%)
Next
Set P2SRV = Nothing
GetGroupClassNames
Description
the Valve class and the Pump class both belong to the "Unit" group. A
client application can use this function in a loop to get the list of all
classes in the specified group. The total number of classes can be
obtained using the method GetGroupClassCount. Using a specific
group name, the client application can use the function
GetGroupClassNames to get the list of all classes in a group. (The first
element is specified using a value of zero for the index.)
Syntax
clsname$ = object.GetGroupClassNames(groupName, index)
Arguments
groupName The group name. Use GetGroupCount and

GetGroupNames to get the list of valid groups.
Index The index of the class name to retrieve. Specify 0 to return

the first class name.
Return Value
The name of the object class for the specified group at the specified
index.

Example
Dim P2SRV As Object
P2SRV.Initialize
clscount% = P2SRV.GetGroupClassCount("Unit")
clsname$ = P2SRV.GetGroupClassNames("Unit", i%)
Next
Set P2SRV = Nothing
GetGroupCount
Description
the Valve class and the Pump class both belong to the "Unit" group.
This method returns the total number of groups in PRO/II. To get the
names of the groups, use the method GetGroupNames.
Syntax
grpcount% = object.GetGroupCount
Arguments
None.
Return Value
The number of PRO/II object class groups.
Example
Dim P2SRV As Object
P2SRV.Initialize
grpcount% = P2SRV.GetGroupCount
For i% = 0 To grpcount% - 1
grpname$ = P2SRV.GetGroupNames(i%)
Next
Set P2SRV = Nothing

GetGroupNames
Description
The object classes in PRO/II are organized into groups. For
example, the Valve class and the Pump class both belong to the
"Unit" group. The total number of groups can be obtained using the
method GetGroupCount. This method can be used in a loop to get
the individual group names. Then, using a specific group name, the
client application can use the function GetGroupClassNames to get
the list of all classes in a group. (Usually used in conjunction with
GetGroupCount method) (The first element is specified using a value
of zero for the index.)
Syntax
grpname$ = object.GetGroupNames(index)
Arguments
Index The index of the group name to retrieve. Specify 0 to

return the first group name.
Return Value
The group name for specified index.
Example
Dim P2SRV As Object
P2SRV.Initialize
grpcount% = P2SRV.GetGroupCount
For i% = 0 To grpcount% - 1
grpname$ = P2SRV.GetGroupNames(i%)
Next
Set P2SRV = Nothing
GetOption
Description
Returns the value of an option in the PRO/II COM server. The
recognized options are listed in the table:

Option name Description
showInternalObjects Modifies the operation of GetObjectCount and

GetObjectNames. By default these methods
do not include objects internal to the PRO/II
simulation. For diagnostic purposes, it is
sometimes useful to access the attributes of
these internal objects. If the option value is set
to "1" then these methods will include the
"internal" objects as part of the object count
and object list.
"DoublePrecision" Specifies whether the COM Server will return

floating point values in single precision or
double precision. If the option value is set to
"0" then single precision is used. If the value is
set to "1" then double precision is used. The
default is to use single precision, which is the
behavior in version 7.1 and previous.
Syntax
value$ = object.GetOption(optionName)
Arguments
optionName Name of the option to be retrieved. The list of valid

options is shown in the table.
Return Value
Value of the option. The value is returned as a text string.
Example
Dim P2SRV As Object
P2SRV.Initialize
Value1$ = P2SRV.GetOption("showInternalObjects")
Value2$ = P2SRV.GetOption("DoublePrecision")
Set P2SRV = Nothing

GetSecuritySeat
Description
This acquires a software security seat so that subsequent calls to
security-aware methods will not need to perform individual security
operations.
This method can be used to improve performance. A method like
CalculateStreamProps will acquire a security seat, perform the
calculations, and then release the security seat. If the application needs
to make many calls to security-aware methods, then it is more efficient to
make one call to get the security and then make the multiple calls to the
security-aware method.
Syntax
retCode% = object.GetSecuritySeat(level)
Arguments
level Use a value of 2 to request a PRO/II security license.
Return Value
0 no error
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Set P2DB = P2SRV.OpenDatabase(p2Database)
' Get a security license (for better performance)
retCode% = P2SRV.GetSecuritySeat(2)
nStreams% = P2DB.GetObjectCount("Stream")
For i% = 0 To (nStreams% - 1)
objName$ = P2DB.GetObjectNames("Stream", i%)
P2DB.CalculateStreamProps (objName$)
Next

' Release the security license
P2SRV.ReleaseSecuritySeat
Set P2DB = Nothing
Set P2SRV = Nothing
Import
Description
Imports the specified keyword file, creating a new simulation database.
To open the generated database, use the OpenDatabase method.
Syntax
retCode% = object.Import(dbName)
Arguments
dbName The path and name of the keyword file.
Return Value
1 completed with no errors or warnings
2 completed with warnings
3 errors were generated
5 specified keyword file was not found
Example
Dim P2SRV As Object
P2SRV.Initialize
p2KwdFile$ = "c:\SimSci\proii81\user\Applib\R3R.inp"
retCode% = P2SRV.Import(p2KwdFile$)
Set P2SRV = Nothing
Initialize
Description
Initializes the PRO/II COM Server. This method must be called before
any other methods are invoked. To release (close) the server at the end
of the application, set the object variable to Nothing.

Syntax
object.Initialize(config, schema, debug)
Arguments
config Optional. The full path and name of the PRO/II initialization file. If
not specified, then it will use the installation-time default read
from the Windows Registry key
HKEY_LOCAL_MACHINE/Software/Simulation
Sciences/PRO/II/x.y/Ini_File, where x.y refers to the specific
version of PRO/II being used (such as "8.3" or "9.0").
schema Optional. The name of the PRO/II schema file. This file contains
the information on what classes and their attributes are available
in the PRO/II database. If not specified, the value is read from the
config file.
debug Optional.The name of the file in which to dump internal debug

information. The amount of information is controlled by the
DebugLevel property.
Return Value
None.
Example
Using all defaults:
Dim P2SRV As Object
P2SRV.Initialize
...
' Shut down the COM Server
Set P2SRV = Nothing
Specifying the individual files
p2ConfigFile$ = "c:\SimSci\proii81\User\proii.ini"
dbsSchemaFile$ = "c:\SimSci\proii81\System\Schema.sdf"
p2DebugFile$ = "c:\SimSci\proii81\User\debug.txt"
Dim P2SRV As Object
P2SRV.Initialize p2ConfigFile$, _

dbsSchemaFile$, p2DebugFile$
...
' Shut down the COM Server
Set P2SRV = Nothing
MsgText
Description
Returns the text of an error, warning, or message in the internal
message buffer.
Syntax
text$ = object.MsgText(index)
Arguments
index The index of the message to retrieve. Specify a value

of zero to retrieve the first message.
Return Value
The text string of the error, warning, or message.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
P2SRV.ClearMsgs

If nMsg% > 0 Then

iCode% = P2SRV.MsgCode(i%)
iSeverity% = P2SRV.MsgSeverity(i%)
Next
End If
Set P2DB = Nothing
Set P2SRV = Nothing
MsgCode
Description
Returns the internal code for an error, warning, or message in the
internal message buffer.
Syntax
code% = object.MsgCode(index)
Arguments
Index The index of the message code to retrieve. Specify a

value of zero to retrieve the first code.
Return Value
The integer code for the error, warning, or message.
Example
See MsgText.
MsgSeverity
Description
Returns the severity level for an error, warning, or message in the
internal message buffer.
Syntax
severity% = object.MsgSeverity(index)
Arguments
index The index of the message severity to retrieve.

Specify a value of zero to retrieve the first value.

Return Value
The integer severity code for the error, warning, or message.
Example
See MsgText.
NewDatabase
Description
Creates a new PRO/II simulation database. To close the database, set
the object variable to Nothing.
Syntax
Set P2DB = object.NewDatabase(dbname)
Arguments
dbname The path and name of the database to create. Do not

include the file extension.
Return Value
A Database Object.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
p2NewDB$ = "c:\SimSci\proii81\User\MyNewDB"
Set P2DB = P2SRV.NewDatabase(p2NewDB$)
Set P2DB = Nothing
Set P2SRV = Nothing
OpenDatabase
Description
Opens an existing PRO/II simulation database. To close the database,
set the object variable to Nothing.
Syntax
Set P2DB = object.OpenDatabase(dbname)

Arguments
dbname The path and name of the database to open.
Return Value
A Database Object.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Set P2DB = Nothing
Set P2SRV = Nothing
ReleaseSecuritySeat
Description
Releases the software security seat previously acquired by a call to
GetSecuritySeat.
Syntax
object.ReleaseSecuritySeat
Arguments
None.
Return Value
None.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Set P2DB = P2SRV.OpenDatabase(p2Database)

' Get a security license (for better performance)
retCode% = P2SRV.GetSecuritySeat(2)
nStreams% = P2DB.GetObjectCount("Stream")
For i% = 0 To (nStreams% - 1)
objName$ = P2DB.GetObjectNames("Stream", i%)
P2DB.CalculateStreamProps (objName$)
Next
' Release the security license
Set P2DB = Nothing
Set P2SRV = Nothing
RunCalcs
Description
Solves the specified simulation.
An application should call CheckData before running the simulation.
Syntax
retCode% = object.RunCalcs(dbName)
Arguments
dbName Path and name of simulation database.
Return Value
1 simulation solved with no errors or warnings
2 simulation solved with warnings
3 simulation solved with errors
4 simulation not solved
5 specified keyword file was not found

Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
p2Database$ = "c:\SimSci\proii81\user\G3.prz"
retCode% = P2DB.CheckData
Set P2DB = Nothing
If nMsg% > 0 Then
Next
End If
retCode% = P2SRV.RunCalcs(p2Database$)
Set P2SRV = Nothing
SetCallbackPtr
Description
Internal method reserved for future use.
Syntax
Not applicable.
Arguments
Not applicable.
Return Value
Not applicable.
Example
Not applicable.

SetOption
Description
Sets the value of an option in the PRO/II COM server. The recognized
options are listed in the table:
Option name Description
showInternalObjects Modifies the operation of GetObjectCount and

GetObjectNames. By default these methods do not
include objects internal to the PRO/II simulation. For
diagnostic purposes, it is sometimes useful to
access the attributes of these internal objects. If the
option value is set to "1" then these methods will
include the "internal" objects as part of the object
count and object list.
"DoublePrecision" Specifies whether the COM Server will return

floating point values in single precision or double
precision. If the option value is set to "0" then single
precision is used. If the value is set to "1" then
double precision is used. The default is to use single
precision, which is the behavior in version 7.1 and
previous.
Syntax
retCode% = object.SetOption(optionName, optionValue)
Arguments
optionName Name of the option.
optionValue The new value of the option, specified as a text string.
Return Value
0 no error
1 optionName is not recognized
Example
Dim P2SRV As Object
P2SRV.Initialize
retCode% = P2SRV.SetOption("showInternalObjects", "1")

retCode% = P2SRV.SetOption("DoublePrecision", "1")
Set P2SRV = Nothing
Unload
Description
Shuts down the database access features of the PRO/II COM Server in
preparation for RunCalcs or GenerateReport. This method is
automatically performed when setting the Server object to Nothing at the
end of the application.
Note: This method is deprecated starting with version 7.1.
Syntax
object.Unload
Arguments
None.
Return Value
None.
Example
Dim P2SRV As Object
P2SRV.Initialize
' PVSRV.Unload is automatically called as part of
' the next statement
Set P2SRV = Nothing
PRZFileConversion
Description
File conversion from an older version to a higher version.
Syntax
object.PRZFileConversion (dbName)
Arguments
dbName The path and name of the prz file.

Example
Dim P2SRV As Object
p2progid = "SimSciDbs.Database.90"
p2path = "c:\SimSci\proii90"
p2ini = "proii.ini"
dbsSchemaFile = p2path & "\System\Schema.sdf"
p2ConfigFile = p2path & "\User\" & p2ini
p2Database = p2path & "\user\g3.prz"
WScript.echo "Start PRO/II COM server using progid '" &

p2progid & "'"
set P2SRV = CreateObject(p2progid)
P2SRV.Initialize p2ConfigFile, dbsSchemaFile, ""
WScript.echo "Convert database "& p2Database
P2SRV.PRZFileConversion(p2Database)
WScript.echo "Open database "& p2Database
set P2DB = P2SRV.OpenDatabase(p2Database)
WScript.echo " Free object from memory"
set P2OBJ = nothing
WScript.echo "Close database"
set P2DB = nothing
WScript.echo "Shut down PRO/II COM server"
set P2SRV = nothing

Database Object
Overview
This object encapsulates a PRO/II simulation database. Use the
OpenDatabase or NewDatabase methods of the Server object to
access this object. With this object, an application can access specific
units and streams in the database using the ActivateObject method.
The Database object has the following properties:
Name Database name
Status File status
Each of these properties is discussed in more detail in the following sections.

The Database Object has the following methods, which can be divided
into two types:
General File and Object Methods
Cross Check and Data Validation Methods
Utility and Data Conversion Methods
Each method is summarized in the tables below and described in detail
in the following sections.
General File and Object Methods
ActivateObject Loads a data object from the database into

memory, making it available to the application.
BuildCompCalc Creates the calculation-time component data

objects in preparation for the FlashStream
method or RunCalcs.
BuildExecSequence Creates the unit operation execution sequence

in preparation for the RunCalcs method.
BuildRefStreams Creates the reference stream data objects in

preparation for the RunCalcs method.
BuildStreamCalc Creates the calculation-time stream data objects

in preparation for the RunCalcs method.
BuildThermoCalc Creates the calculation-time thermodynamic

data objects in preparation for thermo
calculations and the RunCalcs method.
CheckData Performs all checks on a flowsheet in

ConvertIdToNum Returns the internal number corresponding to

the specified PRO/II object.
ConvertNumToId Returns the name of the PRO/II object specified

by its internal number.
CreateObject Creates a new object in the database.
CrossCheckControlUnitOps Performs cross checks on all controllers

and optimizers in a flowsheet in
CrossCheckSpecsVarys Performs cross checks on all

spec/vary/define objects in a flowsheet
in preparation for the RunCalcs
method.
CrossCheckUnitOps Performs cross checks on all unit operations in

a flowsheet in preparation for the RunCalcs
method.
DbsSaveDb Saves this database to its permanent location.
DeleteObject Deletes an object from the database.
GenerateAssayComponents Generates Assay Components.
GetObjectCount Returns the number of PRO/II objects of a

specified class.
GetObjectNames Returns an object name for a specified class

given its index.
MiscChecks Performs final checks on a flowsheet in

ObjectExists Returns true if the specified object exists in a


ObjectExistsInGrou Returns true if the specified name belongs to an
p object in the database in the same group.
RenameObject Renames an object in the database.
RestoreInputData Resets the flowsheet calculation status by

deleting all previously-calculated results.
TowerBurst Copies column information from merged column

objects into the original column/sidestripper
objects after the flowsheet has been solved by
RunCalcs.
TowerMerge Combines eligible column/sidestripper

combinations into single column object in
Utility and Data Conversion Methods
CalculateStreamProps Calculates a full set of properties for the

specified stream.
CalculateStreamProps2 Calculates a full or partial set of properties for

the specified stream.
CalculateUnitProps Calculates a full set of properties for the

specified unit.
ConvertValue Converts a single-precision floating point value

from one unit-of-measure to another.
ConvertValue2 Converts a single- or double-precision floating

point value from one unit-of-measure to
another.
CopyTrayToStream Copies flowrate, thermal conditions, and

composition data from a column tray to a
stream.
FlashStream Performs a flash calculation on a stream.

GetUOMString Returns the printable version of a unit-of-
measure.
GetUOMString2 Returns the printable version of a unit-of-

measure.
Database Object Properties

Name
The Database File Object.
Description
Returns the object name. This is the name that was originally used in
NewDatabase or OpenDatabase.
Syntax
Dbname$ = object.Name
Status
Description
Returns the internal status. A status of zero means no error has been
encountered.
The methods in the Database Object may change the value of this property
if an error has occurred.
Note: when this property is retrieved, the Status is reset to zero.
Syntax
Status% = object.Status
Database Object Methods
ActivateObject
Description
Loads a data object from the database into memory, making it available to
the application. To free the object, set the object variable to Nothing.
For a list of available data classes, refer to the PRO/II Object Reference.
The methods GetClassNames or GetGroupClassNames can also be used
to query the PRO/II COM server for the list of supported class names.
To get the list of objects for a specified class that actually exists in the
simulation database, use the method GetObjectNames.

Syntax
Set P2OBJ = object.ActivateObject(objclass, objname)
Arguments
objclass The PRO/II data class.
objname The name of the object to activate.
Return Value
A Database Data Object. If the named object does not exist in the
database, the return value will be Nothing.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim P2OBJ As Object
Set P2OBJ = P2DB.ActivateObject("Stream", "1")
dTemp = P2OBJ.GetAttribute("Temperature")
Set P2OBJ = Nothing
Set P2DB = Nothing
Set P2SRV = Nothing
BuildCompCalc
Description
Creates the calculation-time component data objects in preparation for
the FlashStream or RunCalcs method.
Note: this method is automatically called as part of the CheckData
method. If the PRO/II COM application is calling CheckData in
preparation for RunCalcs then it does not need to call BuildCompCalc.
If the application is creating a new database for the purpose of setting up
a flash calculation using FlashStream, then refer to the detailed
example XXX in the tutorial section.

Syntax
object.BuildCompCalc
Arguments
None.
Return Value
None.
Example
For a detailed example of the use of BuildCompCalc as part of a
generic flash utility, refer to example XXX in the Tutorial section.
BuildExecSequence
Description
Creates the unit operation execution sequence in preparation for the
RunCalcs method.
method. PRO/II COM applications should call the CheckData method.
Syntax
object.BuildExecSequence
Arguments
None.
Return Value
None.
Example
See the CheckData method.
BuildRefStreams
Description
Creates the reference stream data objects in preparation for the
RunCalcs method.

Syntax
object.BuildRefStreams
Arguments
None.
Return Value
None.
Example
BuildStreamCalc
Description
Creates the calculation-time stream data objects in preparation for the
RunCalcs method.
Syntax
object.BuildStreamCalc
Arguments
None.
Return Value
None.
Example
BuildThermoCalc
Description
Creates the calculation-time thermodynamic data objects in preparation
for the RunCalcs method.
Syntax
object.BuildThermoCalc

Arguments
None.
Return Value
None.
Example
CalculateStreamProps
Description
Calculates a full set of properties for the specified stream.
The RunCalcs and FlashStream methods do not automatically calculate all
properties for streams. Use this method following a call to FlashStream (or
following a call to RunCalcs and OpenDatabase) to create, if necessary,
and update the SrBulkProp and SrDecProp objects for the named stream.
Important: if the application is calculating properties for stream "1" then it is
important that all active stream objects named "1" (of class StreamIn,
Stream, SrBulkProp, and SrDecProp) be freed from memory by setting their
object variables to Nothing.
Syntax
retCode = object.CalculateStreamProps(objname)
Arguments
objname The name of the stream for which to calculate

properties.
Return Value
Boolean value: true = no error, false = error during calculations. Use the
Status property to retrieve the underlying error code.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object

Dim retCode As Boolean
retCode = P2DB.CalculateStreamProps("1")
Dim P2OBJ1 As Object
Set P2OBJ1 = P2DB.ActivateObject("Stream", "1")
Set P2OBJ2 = P2DB.ActivateObject("SrBulkProp", "1")
dMolRat = P2OBJ1.GetAttribute("TotalMolarRate")
dActualDensity = P2OBJ2.GetAttribute("BulkDensityAct")
Set P2OBJ1 = Nothing
Set P2DB = Nothing
Set P2SRV = Nothing
CalculateStreamProps2
Description
Calculates a full or partial set of properties for the specified stream.
The RunCalcs and FlashStream methods do not automatically calculate all
properties for streams. Use this method following a call to FlashStream (or
following a call to RunCalcs and OpenDatabase) to create, if necessary,
and update the SrBulkProp and SrDecProp objects for the named stream.
Important: if the application is calculating properties for stream "1" then it is
important that all active stream objects named "1" (of class StreamIn,
Stream, SrBulkProp, and SrDecProp) be freed from memory by setting their
object variables to Nothing.
Syntax
retCode = object.CalculateStreamProps2(objname, propertyoption)
Arguments
objname The name of the stream for which to calculate

properties.
Specify: To calculate:
"" (blank string)all properties

"all"
all properties
"std"

standard properties such as densities, enthalpies,
"tbp" and transport properties
"rvp" TBP curves
"bpdp"
RVP
bubble/dew points
You can also specify multiple properties, separated by

commas in a single string, such as "std,bpdp"
Return Value
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
retCode = P2DB.CalculateStreamProps2("1", "")
retCode = P2DB.CalculateStreamProps2("1", "all")
retCode = P2DB.CalculateStreamProps2("1", "std")
retCode = P2DB.CalculateStreamProps2("1", "std,tbp")
retCode = P2DB.CalculateStreamProps2("1", "std,rvp")
retCode = P2DB.CalculateStreamProps2("1", _
"std,tbp,bpdp")
Set P2DB = Nothing
Set P2SRV = Nothing
CalculateUnitProps
Description
Calculates output-time properties for the specified unit.

The RunCalcs method does not automatically calculate output-time
properties for certain unit operations. Use this method after a call to
RunCalcs (and OpenDatabase) to calculate the additional attributes.
The following unit operation classes perform output-time property
calculations:
Simple Heat Exchanger

LNG Heat Exchanger
Rigorous Heat Exchanger
Heating/Cooling curves
Shortcut columns
Rigorous columns
Syntax
retCode = object.CalculateUnitProps(unitId)
Arguments
unitId The name of the unit from which to calculate

properties. If the name is blank then all unit
operations will be processed.
Return Value
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
p2Database$ = "c:\SimSci\proii81\user\Applib\R1.prz"
retCode = P2DB.CalculateUnitProps("HC1")
Dim P2OBJ As Object
Set P2OBJ = P2DB.ActivateObject("HcurveIn", "HC1")

hccalcname$ = P2OBJ.GetAttribute("HCURVE", 0)
Set P2OBJ = Nothing
Set P2OBJ = P2DB.ActivateObject( _
"HcurveCalc", hccalcname$)
totalEnthalpyArray = P2OBJ.GetAttribute( _
"EnthalpyTotal", -1)
For i% = LBound(totalEnthalpyArray) To _
UBound(totalEnthalpyArray)
enthalpy = totalEnthalpyArray(i%)
Next
Set P2OBJ = Nothing
Set P2DB = Nothing

Set P2SRV = Nothing
CheckData
Description
Performs all checks on a flowsheet in preparation for the RunCalcs
method which solves the flowsheet.
The following specific checks are performed as part of this method:
BuildCompCalc
BuildThermoCalc
BuildStreamCalc
TowerMerge
BuildRefStreams
CrossCheckUnitOps
BuildExecSequence
CrossCheckControlUnitOps
CrossCheckSpecsVarys
MiscChecks
Syntax
retCode% = object.CheckData

Arguments
None.
Return Value
0 if no error.1 if error. To get the specific error messages that were
generated, use the methods MsgCount and MsgText properties of the
Server object.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Set P2DB = Nothing
If nMsg% > 0 Then
Next
End If
Set P2SRV = Nothing
ConvertIdToNum
Description
This is an internal utility function that returns the internal number
corresponding to the specified PRO/II object.
This method is not currently active.
Syntax
objNum% = object.ConvertIdToNum(dbObjType, objId)

Arguments
dbObjType The Object type. Valid values are "Unit" and loop.
objId The name of the object.
Return Value
The internal numeric identifier of the PRO/II object.
Example
Not available.
ConvertNumToId
Description
Returns the name of the PRO/II object specified by its internal number.
This method is required for some situations where the attribute of a
PRO/II object is returned as a number but that number needs to be
converted to an actual object name for use in ActivateObject.
Syntax
ObjName$ = object.ConvertNumToId(dbObjType, objNumber)
Arguments
dbObjType The Object type. Valid values are "Unit" and loop.
objNumber The internal object number. Specify 1 for the first object.
Return Value
The name of the PRO/II object.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
ObjName$ = P2DB.ConvertNumToId("Unit", 1)
Set P2DB = Nothing

Set P2SRV = Nothing
ConvertValue
Description
Converts a single-precision floating point value from one unit-of-measure
to another.
Syntax
object.ConvertValue(value, uomclass, fromtype, totype)
Arguments
Value The floating point value to convert.
uomclass The name of the unit-of-measure class. Appendix A lists

the valid codes.
fromtype Character code identifying what to convert the value

from. One of input, "output", English, Metric, or SI.
totype Character code identifying what to convert the value to.

One of input, "output", English, Metric, or SI.
Return Value
The converted value.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim P2OBJ As Object
dPres = P2OBJ.GetAttribute("Pressure")
dRate = P2OBJ.GetAttribute("TotalMolarRate")
dTemp2 = P2DB.ConvertValue( _

dTemp, "TEMP", "internal", "output")
dPres2 = P2DB.ConvertValue( _
dPres, "PRES", "internal", "output")
dRate2 = P2DB.ConvertValue( _
dRate, "MRAT", "internal", "output")
uomT = P2DB.GetUOMString("TEMP", "output")
uomP = P2DB.GetUOMString("PRES", "output")
uomR = P2DB.GetUOMString("MRAT", "output")
MsgBox "Temperature = " & dTemp2 & " " & uomT, _
vbOKOnly, "Temperature"
MsgBox "Pressure = " & dPres2 & " " & uomP, _
vbOKOnly, "Pressure"
MsgBox "Flowrate = " & dRate2 & " " & uomR, _
vbOKOnly, "Flowrate"
Set P2OBJ = Nothing
Set P2DB = Nothing
Set P2SRV = Nothing
ConvertValue2
Description
Converts a single-precision or double-precision floating point value from
one unit-of-measure to another.
Syntax
object.ConvertValue2(value, uomclass, fromtype, totype)
Arguments
Value The floating point value to convert.
uomclass The name of the unit-of-measure class. Appendix A lists the

valid codes.
fromtype Character code identifying what to convert the value from.

totype Character code identifying what to convert the value to. One

of input, "output", English, Metric, or SI.
Return Value
The converted value.
Example
See ConvertValue
CopyTrayToStream
Description
Copies the flowrate, thermal conditions, and composition data from a
column tray to a stream.
Syntax
retCode = object.CopyTrayToStream(columnname, tray, phase, subphase, net,
streamname)
Arguments
columnname The name of the column.
Tray The tray from which the properties are copied.
phase The phase to copy. (0 = Mixed, 1 = Vapor, 2 = Liquid)
subphase The liquid subphase. (Not currently used.)
Net 1 = Net flowrates, 2 = Total flowrates.
streamname The name of the stream to which the tray information is

copied.
Return Value
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object

' Ensure that merged column results have been
' copied back to original column/sidestrippers.
P2DB.TowerBurst
Dim P2OBJ As Object
Set P2OBJ = P2DB.ActivateObject("Column", "COL1")
nTrays = P2OBJ.GetAttribute("NumberOfTrays")
Set P2OBJ = Nothing
' Create temporary stream
tmpStream$ = "TMPSTR"
Set P2OBJ = P2DB.CreateObject("Stream", tmpStream$)
Set P2OBJ = Nothing
P2SRV.GetSecuritySeat(2)
For i% = 1 To nTrays
retCode = P2DB.CopyTrayToStream( _
"COL1", i%, 0, 0, 1, tmpStream$)
retCode = P2DB.CalculateStreamProps(tmpStream$)
Set P2OBJ1 = P2DB.ActivateObject( _
"Stream", tmpStream$)
Set P2OBJ2 = P2DB.ActivateObject( _
"SrBulkProp", tmpStream$)
dTemp = P2OBJ1.GetAttribute("Temperature")
dTotRate = P2OBJ1.GetAttribute("TotalMolarRate")
dLDens = P2OBJ2.GetAttribute("LiqDensityAct")
dVDens = P2OBJ2.GetAttribute("VapDensityAct")
Next

' Delete temporary stream
P2DB.DeleteObject "Stream", tmpStream$
Set P2DB = Nothing
Set P2SRV = Nothing
CreateObject
Description
Creates a new object of the specified class in the database and activates it
into memory. To free the object (remove it from memory), set the object
variable to Nothing. To delete the object from the database, use
DeleteObject.
Syntax
Set P2OBJ = object.CreateObject(objclass, objname)
Arguments
Return Value
A Database Data Object.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim P2OBJ As Object
' Create new stream object
tmpStream$ = "TMPSTR"
' Free (release) object from memory.

' Object is still in the database
Set P2OBJ = Nothing
' Delete temporary stream from database
Set P2DB = Nothing
Set P2SRV = Nothing
CrossCheckControlUnitOps
Description
Performs cross checks on all controllers and optimizers in a flowsheet in
preparation for RunCalcs.
Syntax
object.CrossCheckControlUnitOps
Arguments
None.
Return Value
None.
Example
CrossCheckSpecsVarys
Description
Performs cross checks on all spec/vary/define objects in a flowsheet in
Syntax
object.CrossCheckSpecsVarys
Arguments
None.

Return Value
None.
Example
CrossCheckUnitOps
Description
Performs cross checks on all unit operations in a flowsheet in
Syntax
object.CrossCheckUnitOps
Arguments
None.
Return Value
None.
Example
DbsSaveDb
Description
Saves this database to its permanent location.
Syntax
retCode = object.DbsSaveDb
Arguments
None.
Return Value
Boolean value: true = no error, false = error. Use the Status property to
retrieve the underlying error code.
Example
Dim P2SRV As Object

P2SRV.Initialize
Dim P2DB As Object
p2NewDB$ = "c:\SimSci\proii81\User\MyNewDB"
Set P2DB = P2SRV.NewDatabase(p2NewDB$)
retCode = P2DB.DbsSaveDb
Set P2DB = Nothing
Set P2SRV = Nothing
DeleteObject
Description
Deletes a Database Data Object of the specified class from the
database.
Syntax
object.DeleteObject(objclass, objname)
Arguments
Return Value
None.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim P2OBJ As Object
' Create new stream object
tmpStream$ = "$TMPSTR"

' Free (release) object from memory.
' Object is still in the database
Set P2OBJ = Nothing
' Delete temporary stream from database
Set P2DB = Nothing
Set P2SRV = Nothing
FlashStream
Description
Performs a flash calculation on the specified stream.
Note: the component slate, their compositions and the desired
thermodynamic method must have been selected prior to performing the
flash calculation.
Syntax
Results$ = object.FlashStream(objname)
Arguments
objname The name of the stream to flash.
Return Value
A text string containing the results of the flash.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
P2SRV.ClearMsgs

If nMsg% > 0 Then
Next
End If
Set P2DB = Nothing
Set P2SRV = Nothing
GenerateAssayComponents
Description
Generates assay components.
When the application modifies the assay curves of assay streams, this
method regenerates the set of pseudo-components.
Syntax
object.GenerateAssayComponents
Arguments
None.
Return Value
None.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
' Change assay of existing stream
Set P2OBJ = P2DB.ActivateObject("StreamAsIn", "1")

P2OBJ.PutAttribute 11, "Temperatures"
P2OBJ.PutAttribute 3, "DistPct", 0
P2OBJ.PutAttribute 97, "DistTemp", 0
P2OBJ.Commit True
Set P2OBJ = Nothing
P2DB.GenerateAssayComponents
Set P2DB = Nothing
Set P2SRV = Nothing

GetObjectCount
Description
Returns the number of PRO/II objects of the specified class. Use the
method GetObjectNames to get the individual names of the objects.
Syntax
Count% = object.GetObjectCount(classname)
Arguments
classname The name of the PRO/II object class.
Return Value
The object count.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
objcount% = P2DB.GetObjectCount("Stream")
For i% = 0 To objcount% - 1
objname$ = P2DB.GetObjectNames("Stream", i%)
Next
Set P2DB = Nothing
Set P2SRV = Nothing
GetObjectNames
Description
Returns the name of an object with the specified class and index. This
function is typically used with the GetObjectCount method.
Syntax
object.GetObjectNames(classname, index)

Arguments
classname The name of the PRO/II object class.
index The index of the object name to retrieve. Specify 0 to

return the first class name.
Return Value
The object name returned as a string.
Example
See GetObjectCount.
GetUOMString
Description
Returns the printable version of a unit-of-measure.
Syntax
object.GetUOMString(uomclass, type)
Arguments
uomclass The name of the unit-of-measure class. Appendix A lists

the valid codes.
type Character code identifying which string to return. One of

input, "output", English, Metric, or SI.
Return Value
The unit-of-measure string.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim P2OBJ As Object

dPres = P2OBJ.GetAttribute("Pressure")
dRate = P2OBJ.GetAttribute("TotalMolarRate")
dTemp2 = P2DB.ConvertValue( _
dTemp, "TEMP", "internal", "output")
dPres2 = P2DB.ConvertValue( _
dPres, "PRES", "internal", "output")
dRate2 = P2DB.ConvertValue( _
dRate, "MRAT", "internal", "output")
uomT = P2DB.GetUOMString("TEMP", "output")
uomP = P2DB.GetUOMString("PRES", "output")
uomR = P2DB.GetUOMString("MRAT", "output")
MsgBox "Temperature = " & dTemp2 & " " & uomT, _
vbOKOnly, "Temperature"
MsgBox "Pressure = " & dPres2 & " " & uomP, _
vbOKOnly, "Pressure"
MsgBox "Flowrate = " & dRate2 & " " & uomR, _
vbOKOnly, "Flowrate"
Set P2OBJ = Nothing
Set P2DB = Nothing
Set P2SRV = Nothing
GetUOMString2
Description
Returns the printable version of a unit-of-measure.Contains additional
option to specify mass/mole basis.
Syntax
object.GetUOMString2(uomclass, opt, type)
Arguments
uomclass The name of the unit-of-measure class. Appendix A

lists the valid codes.

opt Specify one of the following values
0 = normal unit, (weight basis, not

standard/actual, default scaling)
100 = include "MOL" in the text
200 = include "STD" in the text
300 = include "ACT" in the text
10 = no English scaling
20 = scale English unit by 1,000
30 = scale English unit by 1,000,000
1 = no SI/Metric scaling
2 = scale SI/Metric by 1,000
3 = scale SI/Metric by 1,000,000
You can combine options by adding the numbers.
type Character code identifying which string to return.

Return Value
The unit-of-measure string.
Example
Not available.
MiscChecks
Description
Performs final checks on a flowsheet in preparation for RunCalcs.
Syntax
object.MiscChecks
Arguments
None.

Return Value
None.
Example
ObjectExists
Description
Returns true if the specified object exists in a simulation database.
Syntax
objExists = object.ObjectExists(objclass, objname)
Arguments
objname The name of the object.
Return Value
Boolean value - True if an object of the specified name and class exists in
the simulation database, otherwise False.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim objExists As Boolean
objExists = P2DB.ObjectExists("Stream", "1")
objExists = P2DB.ObjectExists("Stream", "XXXXX")
Set P2DB = Nothing
Set P2SRV = Nothing

ObjectExistsInGroup
Description
Returns true if the specified name belongs to an object in the database in
the same group.
A group of object classes defines a namespace. For example, Pump and
Valve objects belong to the "Unit" group; therefore, there cannot be a
pump named XX and a valve named XX in the same database. A
stream, however, belongs to a different group, the "Stream" group.
Therefore a simulation database can have a pump named XX and a
stream named XX.
This method can be used before calling CreateObject to create a new
object of a specified class. The return value will indicate if there is a name
conflict with an already-existing unit or stream.
Syntax
object.ObjectExistsInGroup(objclass, objname)
Arguments
Return Value
Boolean value - True if an object of the specified name exists in the same
group as the specified class, otherwise False.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim objExists As Boolean
' Application wants to create a splitter named SS01
' Is the name already used by another unit?
objExists = P2DB.ObjectExistsInGroup("Splitter", "SS01")

' If so, try another name
objExists = P2DB.ObjectExistsInGroup( _
"Stream", "SPLIT01")
Set P2DB = Nothing
Set P2SRV = Nothing
RenameObject
Description
Changes the name of an object in a database.
Syntax
object.RenameObject(objclass, objname, newname)
Arguments
newname The new name of the object.
Return Value
None.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Status% = P2DB.Status
P2DB.RenameObject "Stream", "1", "STREAM1"
Status% = P2DB.Status
Set P2DB = Nothing
Set P2SRV = Nothing

RestoreInputData
Description
Resets the flowsheet calculation status. Previously-calculated results
are deleted for the current flowsheet, allowing a complete re-initialization
of all columns; recycle streams, and calculator results back to their initial
input data.
This feature is particularly useful if a particular what-if scenario involves
substantially different operation from the previous run, or if multiple
calculator units need to have their results array reset.
Syntax
retValue = object.RestoreInputData(resetFlag)
Arguments
resetFlag Reset Flag. Specify a value of 1 to reset the

flowsheet.
Return Value
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim boolCode As Boolean
boolCode = P2DB.RestoreInputData(1)
Set P2DB = Nothing
Set P2SRV = Nothing

TowerBurst
Description
Copies column information from merged column objects into the original
column/sidestripper objects after the flowsheet has been solved by
RunCalcs.
Syntax
object.TowerBurst
Arguments
None.
Return Value
None.
Example
See the CopyTrayToStream method.
TowerMerge
Description
Merges eligible column/sidestripper combinations into single column
object in preparation for RunCalcs.
Syntax
object.TowerMerge
Arguments
None.
Return Value
None.
Example

Database Data Object
Overview
An object of this type represents a specific simulation data object in
PRO/II. All streams, components, thermodynamic methods, reaction
data sets, streams, and unit operations are Database Data Objects.
The PRO/II Object Reference documents the PRO/II data classes and
their attributes.
The Database Data objects have the following properties:
Status Object status.
Name Object name (Read-only).
The Database Data Object has the following methods:
Commit Saves the memory copy of an object to the

database.
GetAttribute Gets a scalar value or one element of an

array.
GetAttributeCount Returns the number of attributes in this object.

(Does not return the number of elements of an
array attribute.)
GetAttributeDataType Returns the internal data type.
GetAttributeName Returns the name of an array attribute

identified by index.
GetAttributeSystemDataType Returns the subsystem data type.
GetAttributeUOM Returns the unit-of-measure associated with the

attribute.
GetThermoDefaults Fills in individual thermodynamic method codes for

this ThermoSet object when the thermodynamic
system has been defined.
PopCopy Performs an abort transaction operation.

PullPrevCopy Performs a commit transaction operation.
PushNewCopy Performs a start transaction operation.
PutAttribute Stores a scalar value or one element of any array.
UnitCount Returns the number of elements for an array

attribute.
UnitSize Returns the size, in bytes, of a scalar

attribute or the size of a single element of an
array attribute.
Database Data Object Properties

Name
Description
Returns the object name.
Syntax
objName$ = object.Name
Status
Description
Returns the internal status. A status of zero means no error has been
encountered.
The methods in the Data Object may change the value of this property if
an error has occurred.
When this property is queried, the Status is reset to zero.
Syntax
Status% = object.Status
Database Data Object Methods
Commit
Description
Saves the in-memory copy of an activated object back to the simulation
database.
This method does not free the object from memory. To do that, set the
object variable to Nothing.

If the full option has been specified, additional initialization and cross
checks will be performed. Errors, warnings and messages generated by
this cross check procedure can be retrieved using MsgCount,
MsgSeverity, and MsgText.
Syntax
object.Commit(full)
Arguments
full If TRUE, a full commit is performed. A full commit

performs additional checks and initialization in
Return Value
None.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim P2OBJ As Object
P2OBJ.PutAttribute 450#, "Temperature"
P2OBJ.Commit True
dTemp2 = P2OBJ.GetAttribute("Temperature")
Set P2OBJ = Nothing
Set P2DB = Nothing
Set P2SRV = Nothing
GetAttribute
Description
Returns the value of a scalar attribute, one element of an array, or an
entire array attribute.

Syntax
Value =object.GetAttribute(attrname, index)
Arguments
attrname The name of the attribute.
index Optional. Index of array attribute to return. Not used for

scalar attributes. For array attributes, specify 0 for the
first element; specify -1 to return the entire array.
Return Value
The value of the attribute returned as a variant. The value can be
integer, floating point, or character, depending on the attribute. Empty
will be returned if the database value is missing.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim P2OBJ As Object
' Scalar attribute
' Single elements of an array attribute
fracCount = P2OBJ.UnitCount("TotalComposition")
For i% = 0 To fracCount - 1
dFracElement = P2OBJ.GetAttribute( _
"TotalComposition", i%)
Next
' Complete array attribute
dFracArray = P2OBJ.GetAttribute("TotalComposition", -1)
For i% = LBound(dFracArray) To UBound(dFracArray)

dFracElement = dFracArray(i%)
Next
Set P2OBJ = Nothing
Set P2DB = Nothing
Set P2SRV = Nothing
GetAttributeCount
Description
Returns the number of attributes in this object. Use the method
GetAttributeName to get the actual name of each attribute.
Note: this method does not return the number of elements in an array
attribute. Use UnitCount for that purpose.
Syntax
attrCount% = object.GetAttributeCount
Arguments
None.
Return Value
The number of attributes in the object returned as an integer.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim P2OBJ As Object
attrcount% = P2OBJ.GetAttributeCount
For i% = 0 To attrcount% - 1
attrName$ = P2OBJ.GetAttributeName(i%)
dataSize% = P2OBJ.UnitSize(attrName)
dataCount% = P2OBJ.UnitCount(attrName)

attrType$ = P2OBJ.GetAttributeDataType(attrName)
attrSystemType$ = _
P2OBJ.GetAttributeSystemDataType(attrName)
attrUOM$ = P2OBJ.GetAttributeUOM(attrName)
Next
Set P2OBJ = Nothing
Set P2DB = Nothing
Set P2SRV = Nothing
GetAttributeDataType
Description
Returns the data type associated with the attribute.
Syntax
attrType$ = object.GetAttributeDataType(attrname)
Arguments
Return Value
The data type as a string. The data types are INTEGER, REAL,
DOUBLE, SINGLE, STRING, and UOM.
Example
See GetAttributeCount.
GetAttributeName
Description
Returns the name of an attribute in this object as identified by the
specified index.
Use the method GetAttributeCount to get the number of attributes in
this object.
Syntax
attrName$ = object.GetAttributeName(index)

Arguments
Index The index of the object name to retrieve. Specify 0 for the
first object name.
Return Value
The attribute name returned as a string. The returned attribute name
can be used in methods such as GetAttribute and PutAttribute.
Example
GetAttributeSystemDataType
Description
Returns the system data type associated with the attribute.
Syntax
systemType$ = object.GetAttributeSystemDataType(attrname)
Arguments
Return Value
The data type as a string. The data types include I (integer), R
(real), D (double), S (single), STRING, UOM, SID (stream ID) ,
COID (component ID) , RSID (reaction set ID) , MID
(thermodynamic method set ID).
Example
GetAttributeUOM
Description
Returns the unit-of-measure class associated with the attribute.
Syntax
Uom$ = object.GetAttributeUOM(attrname)
Arguments

Return Value
The unit-of-measure code as a string (first four letters denoting the
class name of the UOM data type). A list of valid codes is given in
Appendix A.
Example
GetThermoDefaults
Description
Fills in individual thermodynamic method codes for this ThermoSet
object when the thermodynamic system has been defined. This
method only applies if this database object is a ThermoSet object.
For example, if the thermodynamic system is SRK, then this method
will fill in the calculation method codes for the individual
thermodynamic properties.
Syntax
object.GetThermoDefaults
Arguments
None.
Return Value
None.
Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
' Create a new Peng-Robinson Thermodynamic System
' in the database
Dim P2OBJ As Object
Set P2OBJ = P2DB.CreateObject("ThermoSet", "PR01")
P2OBJ.PutAttribute 1, "VLLEFlagInpt"

P2OBJ.PutAttribute 102, "SystemFlagInpt"
P2OBJ.GetThermoDefaults
P2OBJ.Commit 0
P2OBJ.PutAttribute 0, "KvalLLEDataFlg"
P2OBJ.PutAttribute 1, "LiqEnthDataFlg"
P2OBJ.PutAttribute 1, "VapEnthDataFlg"
P2OBJ.PutAttribute 0, "LiqDensDataFlg"
P2OBJ.PutAttribute 1, "VapDensDataFlg"
P2OBJ.PutAttribute 0, "VapPhiDataFlg"
P2OBJ.PutAttribute 1, "LiqEntrDataFlg"
P2OBJ.PutAttribute 1, "VapEntrDataFlg"
P2OBJ.Commit 1
Set P2OBJ = Nothing
Set P2DB = Nothing
Set P2SRV = Nothing
PopCopy
Description
The methods PushNewCopy, PopCopy, and PullPrevCopy
implement simple transaction functionality using the concept of an
object stack. PopCopy is analogous to abort transaction.
Syntax
object.PopCopy
Arguments
None.
Return Value
None.

Example
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim P2OBJ As Object
Set P2OBJ = P2DB.ActivateObject("StreamIn", "1")
P2OBJ.PushNewCopy
' Cancel changes since last PushNewCopy
P2OBJ.PopCopy
' Value has been restored to original
P2OBJ.PushNewCopy
' Confirm changes since last PushNewCopy
P2OBJ.PullPrevCopy
' New value has been retained
P2OBJ.Commit True
Set P2OBJ = Nothing
Set P2DB = Nothing
Set P2SRV = Nothing

PullPrevCopy
Description
object stack. PullPrevCopy is analogous to commit transaction.
Syntax
object.PullPrevCopy
Arguments
None.
Return Value
None.
Example
See PopCopy.
PushNewCopy
Description
object stack. PushNewCopy is analogous to start transaction,
Syntax
object.PushNewCopy
Arguments
None.
Return Value
None.
Example
See PopCopy.
PutAttribute
Description
Puts the value of a scalar attribute, or one element of an array
attribute into the data object.

Note: the data is not permanently saved until the object has been
saved to the database using the Commit method.
Syntax
object.PutAttribute(value, attrname, index)
Arguments
value The value to store in the object. To store the missing

value, use an Empty variant variable.
index Optional. The index of the array element. Used only for
array attributes. Specify 0 to put a value for the first
element.
Return Value
None.
Example
dbsSchemaFile$ = "c:\SimSci\proii81\System\Schema.sdf"
p2ConfigFile$ = "c:\SimSci\proii81\User\proii.ini"
Dim P2SRV As Object
P2SRV.Initialize
Dim P2DB As Object
Dim P2OBJ As Object
Set P2OBJ = P2DB.ActivateObject("StreamIn", "1")
' Scalar attribute
' Single elements of an array attribute
fracCount = P2OBJ.UnitCount("Composition")
newFracElement = 0.25

For i% = 0 To fracCount - 1
dFracElement = P2OBJ.GetAttribute("Composition", i%)
P2OBJ.PutAttribute newFracElement, "Composition", i%
Next
' Save value to the database
P2OBJ.Commit True
Set P2OBJ = Nothing
Set P2DB = Nothing
Set P2SRV = Nothing
UnitCount
Description
Returns the number of elements for an array attribute. A scalar
attribute will return a value of 1.
Syntax
Count% = object.UnitCount(attrName)
Arguments
attrName The name of attribute.
Return Value
The number of elements for an array attributes. A scalar attribute
will return a value of 1.
Example
UnitSize
Description
Returns the size, in bytes, of a scalar attribute; or the size of a single
element of an array attribute.
Syntax
Size% = object.UnitSize(attrName)

Arguments
attrName Required. The name of attribute.
Return Value
The size, in bytes, of a scalar attribute; or the size of a single
element of an array attribute.
Example

Appendix A: Unit of Measure Codes
This table lists the unit-of-measure codes returned by GetAttributeUOM

and used by ConvertValue and GetUOMString.
In many instances, the class code is available as a character string. In
other instances, the class order number is available as a scalar integer.
Unit-of-Measure Class Code Order
Temperature TEMP 1
Temperature Difference TDIF 2
Absolute Temperature TABS 3
Pressure PRES 4
Pressure Difference PDIF 5
Absolute Pressure PABS 6
Mass WT 7
Time TIME 8
Length LENG 9
Fine Length FLEN 10
Inverse Length ILEN 11
Area AREA 12
Fine Area FARE 13
Velocity VELO 14
Cake Resistance CRES 15

Liquid Volume LIQV 16
Vapor Volume VAPV 17
Equivalent Volume (Volume per unit length) EQVO 18
Liquid Density LDEN 19
Vapor Density VDEN 20
Petroleum Density PDEN 21
Specific (Molar) Volume SPVO 22
Specific (Molar) Vapor Volume SPVV 23
Energy ENER 24
Work (Power) WORK 24
Duty DUTY 26
Calculational Duty (no 10**6 multiplier) CDUT 27
Enthalpy ENTH 28
Entropy ENTR 29
Heat Capacity CP 30
Molar Rate MRAT 31
Mass Rate WTRA 32
Liquid Volume Rate LVRA 33

Gas Volume Rate GVRA 34
Thermal Conductivity COND 35
Heat Transfer Coefficient HTCO 36
Fouling Factor FOUL 37
Heat Transfer Coefficient * Area UA 38
Specific Heat SPHE 39
Viscosity VISC 40
Kinematic Viscosity KVIS 41
Surface Tension SURF 42
Basis BASI 43
Phase PHAS 44
Fraction FRAC 45
Percentage PCT 46
Parts per Million PPM 47
Angle ANGL 48
Dipole Moment DIPO 49
Heating Value (energy per volume) HVAL 50

Appendix B: Pro II Object Reference
Table B.1 Component Data

Read an attribute: ComponentObject.GetAttribute(AttributeName, Index)
Write an attribute: ComponentObject.PutAttribute(AttributeName, Index)
Property Attribute Name Index Units Type Description
Component Input Data
Input data for each component is stored in its own object of class "CompIn"
For example, properties for component a named "H20" are stored in the "CompIn" class
object called "H2O".
Temperature independent properties, Class = CompIn
- Component ComponentTypeIn InT 1 - Library,

type Vector
2 - Non-Library,
3 - Petroleum,
4 - Assay
pseudocomponent,
5 - Syncomp,
6 - Synliq
- Component ComponentNameIn Char Component name

name vector
- Component ComponentLibIdIn InT Library components

ID Vector - input Library name
- Molecular MolWeightIn Real Input Molecular

weight weight
- Specific SpecGravityIn Real Input 60 F specific

gravity gravity (liquid)
- NBP NormBoilPtIn TEMP Real Input Normal boiling


point
- Melt point NormMeltPtIn TEMP Real Input Normal melting

point
- Critical CritTempIn TEMP Real Input Critical

temperature temperature
(Tc)
- Critical CritPressIn PRES Real Input Critical pressure

pressure (Pc)
- Critical CritVolIn Real Input Critical volume,

volume (Vc) M3/KG-MOL
- Critical CritCompressIn Real Input Critical

compresssibil compressibility
ity factor (Zc)
- Acentric AcenFactorIn Real Input Acentric factor

factor
- Watson K WatsonKIn Input Watson K (uop

K)
- Racket RackettParamIn Real Input Rackett

parameter parameter
- Dipole DipoleMomentIn DIPO Real Input Dipole moment

moment
- Radius of RadGyrationIn FLEN Real Input Radius of

gyration gyration
- Solubility SolParamIn Real Input Solubility

parameter parameter

- Liquid LiqMolVolIn LIQV Real Input Liquid molar

molar volume volume
- Liquid LiqMolVolBasisIn Real Input liquid mol.

molar volume volume basis (1: M ,
basis 2: W)
- Heat of HeatCombusIn ENTH Real Input Heat of

combustion combustion,
- Heat of HCombBasisIn Real Input heat of

Combusion combustion basis (1:
basis M , 2: W)
- Heat of HeatVapAtNBPIn ENTH Real Input Heat of

vaporization vaporization at NBP
- Heat of HVapBasisIn Real Input heat of

vaporization vaporization basis (1:
basis M , 2: W)
- Heat of HeatFusionAtNMPI ENTH Real Input Heat of fusion

fusion n at NMP
- Heat of HFusionBasisIn Real Input heat of fusion

fusion basis basis (1: M , 2: W)
- Triple point TripPtTempIn TEMP Real Input Triple point

temperature temperature
- Triple point TripPtPressIn PRES Real Input Triple point

pressure pressure
- Gross GrossHeatValueIn ENTH Real Input Gross heating

heating value value

- Gross GHVBasisIn Real Input GHV basis (1:

heating value M , 2: W)
basis
- Lower LowerHeatValueIn ENTH Real Input Lower heating

heating value value
- Lower LHVBasisIn Real Input LHV basis (1: M

heating value , 2: W)
basis
- Carbon CarbonNumIn Real Input Carbon number

number
- Hydrogen HydrogenDefIn Real Input Hydrogen

defiency deficiency
number
- Vapor VapEntropyDepNB ENTR Real Input Vapor entropy

entropy PIn departure at NBP
departure at
NBP
- LibEntrVapNBPIn ENTR Real Input Library entropy

Vaporization of vaporiaztion at
etnropy NBP
change at
NBP
- Liquid LibLiqEntrNbpNmp ENTR Real Input Library liquid

entropy In entropy change from
change from NBP to NMP
NBP to NMP
- Vapor VaporEnthDepNB ENTH Real Input Vapor

enthalpy PIn enthalpy departure at
departure at


NBP NBP
- Vapor LibEnthVapNBPIn ENTH Real Input Library enthalpy

enthalpy of vaporization at NBP
change at
NBP
- Liquid LibLiqEnthNbpNm ENTH Real Input Library liquid

enthalpy pIn enthalpy change
change from from NBP to NMP
NBP to NMP
- WT WTParamIn Real Input WT parameter

parameter scalar (solubility equation)
(Solubility
equation)
- PAVA PAVAParamIn Real Input PAVA

parameter scalar parameter
(Solubility
equation)
- SRK M SrkMFactorIn Real Input SRK M factor

factor for scalar
phase
envelope
- PR M PrMFactorIn Real Input PR M factor

factor for scalar
phase
envelope
Heats of Formation
- Reference FreeEnFoPhaseIn InT 1 - Vapor, 2 - Liquid, 3

phase - Solid

- Heat of StdHeatFormIn ENTH Real Input Standard heat of

formation formation (298 K)
- Gibbs free StdFreeEnFormIn ENTH Real Input Std. free energy

energy of of formation (298 K)
formation
Refinery inspection property, Class = CompSPGen
- Number of PropCount InT Property object count

properties
- Property PropNames Char Contains the names of

type Vector the refinery inspection
property objects. The
data for each property
is stored in their
individual objects.
Refinery inspection property, Class = CompSPGenIn
- Mixing MixingBasis InT 1- Mole, 2 - Weight, 3

basis - Liquid volume
- Fraction FractionType InT 10=Fraction,

qualifier 11=Percent, 12=PPM,
else none
- Gamma Gamma Real Property Gamma

value
- Reference RefIndex Real Property Reference

index Index
- Reference RefValue Real Property Reference

value Value

- Number of NumDataItems InT Number of Input

data items data/Index items
- Component ComponentNumber Comp. ID Component numbers

index s Vector for data or index
- Data / DataIndexFlag InT 1 - Data, 2 - Index.

Index flag Vector This flag indicates the
value type (data or
index) in the
corresponding index
of the InputDataIndex
attribute.
- Data value InputDataIndex Real Input Data/Index

/ Index value Vector values
Kinematic Viscosity
- Number of NumDataItems InT Number of Input

data items at data/Index items
temperature1
- Number of NumKv2Items InT Number of KVis

data items at temp2 items
temperature
2
- KvisTemp1 TEMP Real Note: The

Temperature Vector temperature vectors
1 are sized to number of
data items. All the
indices have the same
value.
- Kvis2Temp2 TEMP Real Temperature 2 values


Temperature Vector
2
- Value at InputDataIndex VISC Real KVIS Input

temp 1 Vector Data/Index values
- Value at Kvis2Data VISC Real KVIS Second temp

temperature Vector data
2
User-defined Special Properties, Class = CompSPUsr
- Number of PropCount InT Property object count

properties
- Property PropNames Char Contains the names of

types Vector the user-defined
special property
objects. The data for
each property is
stored in their
individual objects.
User-defined Special Properties, Class = CompSPUsrIn
- Gamma Gamma Real Property Gamma

value
- Reference RefIndex Real Property REF Index

index value
- Reference RefValue Real Property REF value

value
- Component ComponentNumber Comp ID. Component numbers

index s Vector for data or index

- Data / DataIndexFlag InT 1 - Data, 2 - Index.

Index flag Vector This flag indicates the
value type (data or
index) in the
corresponding index
of the InputDataIndex
attribute.
- Data / InputDataIndex Real Input Data/Index

Index values Vector values
Temperature Dependent Properties, Class = CompIn
- Data Type 0 - No data

1 - Correlation data
from library,
2 - Tabular data,
3 Correlation data
from user input
Each index in this
vector corresponds to
one property.
- Data Type TDPropDataFlag InT The Index/Property

Vector of relation is:
(continued) size 15
1 - Vapor pressure
2 - Solid vapor
pressure
3 - Latent heat
4 - Ideal gas
enthalpy
5 - Sat. Liquid


enthalpy
6 - Solid enthalpy
7 - Solid heat
capacity
8 - Sat. Liquid
density,
9 - Solid density
10 - Saturated vapor
viscosity
11 - Saturated liquid
viscosity
12 - Saturated vapor
thermal conductivity
14 - Solid thermal
conductivity
surface tension
- Number of NumOfCorrPropsIn InT Number of correlated

properties scalar properties input
input
- Property CorrelPropertyIn InT The property numbers

types Vector correspond to the
selected Index/Property
relation described for
TDPropDataFlag
attribute

Correlated Data
- Correlation CorrelTypeIn InT Correlation type

numbers Vector number
- CorrelTempUOMIn TEMP UOM Correlation

Temperature Vector temperature unit
unit
- Property CorrelPropUOMIn UOM Correlated prop unit

unit Vector
- Property CorrelMolBasisIn InT 1 - Mole, 2 - Weight

basis Vector
- Log/Ln CorrelLogBasisIn InT 1 - Ln, 2 - Log

toggle Vector
- Exponential CorrelExponFacIn Real For correlations

factor Vector numbers 3 and 4 only
- Maximum CorrelTMinIn TEMP Real Correlation minimum

temperature Vector temperature input
- Minimum CorrelTMaxIn TEMP Real Correlation maximum

temperature Vector temperature input
- Coefficient CorrelCoeff1In Real Correlation

1 Vector coefficients input










Tabular Data
Vapor Pressure
- Number of VapPressTabNum InT Vapor pressure table

data points PtsIn number of points
- VPTempTableIn TEMP Real Temperatures for

Temperature Vector tabular prop data
s
- Vapor VapPressTableIn PRES Real Tabular data for

pressure Vector Vapor Pressure
values

- VapPressTabTemp TEMP UOM Vapor pressure table

Temperature UOMIn temp unit
UOM
- Vapor VapPressTabProp PRES UOM Vapor pressure table

pressure UOMIn prop unit
UOM
- Vapor VapPressTabBasisI InT 1 - Mole, 2 - Weight

pressure n
basis
Solid Vapor Pressure
- Number of SolVPTabNumPtsI InT Solid Vapor Press

data points n table number of points
- SVPTempTableIn TEMP Real Solids Temperatures

Temperature Vector for tabular prop data
s
- Solid vapor SolVapPressTableI PRES Real Tabular data for Solid

pressure n Vector Vapor Pressure
values
- SolVPTabTempUO TEMP UOM Solid Vapor Press

Temperature MIn table temp unit
UOM
- Solid vapor SolVPTabPropUO PRES UOM Solid Vapor Press

pressure MIn table prop unit
UOM
- Solid vapor SolVPTabBasisIn InT 1 - Mole, 2 - Weight

pressure
basis

Latent Heat
- Number of LatHtTabNumPtsIn InT Latent Heat table

data points number of points
- LHTempTableIn TEMP Real Temperatures for

s
- Latent heat LatHtTableIn ENTH Real Tabular data for

values Vector Latent Heat
- LatHtTabTempUO TEMP UOM Latent Heat table

Temperature MIn temp unit
UOM
- Latent heat LatHtTabPropUOM ENTH UOM Latent Heat table

UOM In prop unit
- Latent heat LatHtTabBasisIn InT 1 - Mole, 2 - Weight

basis
Ideal Gas Enthalpy
- Number of IdGEnthTabNumPt InT Ideal Gas Enthalpy

data points sIn table number of points
- IGHTempTableIn TEMP Real Temperatures for

s
- Ideal gas IdealGasEnthTable ENTH Real Tabular data for Ideal

enthalpy In Vector Gas Enthalpy
values
- IdGEnthTabTempU TEMP UOM Ideal Gas Enthalpy


Temperature OMIn table temp unit
UOM
- Ideal gas IdGEnthTabPropU ENTH UOM Ideal Gas Enthalpy

enthalpy OMIn table prop unit of
UOM measure
- Ideal gas IdGEnthTabBasisIn InT 1 - Mole, 2 - Weight

enthalpy
basis
Saturated Liquid Enthalpy
- Number of SLiqEnthTabNumP InT Sat Liquid Enthalpy

data points tsIn table number of points
- SLHTempTableIn TEMP Real Temperatures for

s
- Liquid SatLiqEnthTableIn ENTH Real Tabular data for Sat

enthalpy Vector Liquid Enthalpy
values
- SLiqEnthTabTemp TEMP UOM Sat Liquid Enthalpy

Temperature UOMIn table temp unit
UOM
- Liquid SLiqEnthTabPropU ENTH UOM Sat Liquid Enthalpy

enthalpy OMIn table prop unit
UOM
- Liquid SLiqEnthTabBasisI InT 1 - Mole, 2 - Weight

enthalpy n
basis

Solid Enthalpy
- Number of SolEnthTabNumPts InT Solid Enthalpy table

data points In number of points
- SHTempTableIn TEMP Real Temperatures for

s
- Solid SolEnthTableIn ENTH Real Tabular data for Solid

enthalpy Vector Enthalpy
values
- SolEnthTabTempU TEMP UOM Solid Enthalpy table

Temperature OMIn temp unit
UOM
- Solid SolEnthTabPropU ENTH UOM Solid Enthalpy table

enthalpy OMIn prop unit of meas
UOM
- Solid SolEnthTabBasisIn InT 1 - Mole, 2 - Weight

enthalpy
basis
Solid Heat Capacity
- Number of SolHtCapTabNumP InT Solid Heat Capacity

data points tsIn table number of points
- SHCTempTableIn TEMP Real Temperatures for

s

- Solid heat SolHtCapTableIn CP Real Tabular data for Solid

capacity Vector Heat Capacity
values
- SolHtCapTabTemp TEMP UOM Solid Heat Capacity

UOM
- Solid heat SolHtCapTabProp UOM Solid Heat Capacity

capacity UOMIn table prop unit
CP
UOM
- Solid heat SolHtCapTabBasisI InT 1 - Mole, 2 - Weight

capacity n
basis
Sat. Liquid Density
- Number of SLiqDensTabNum InT Sat Liquid Density

data points PtsIn table number of points
- SLDTempTableIn TEMP Real Temperatures for

s
- Liquid SatLiqDensTableIn LDEN Real Tabular data for Sat

density Vector Liquid Density
values
- SLiqDensTabTemp TEMP UOM Sat Liquid Density

UOM
- Liquid SLiqDensTabProp LDEN UOM Sat Liquid Density

density UOM UOMIn table prop unit

- Liquid SLiqDensTabBasisI InT 1 - Mole, 2 - Weight

density basis n
Solid Density
- Number of SolDensTabNumPt InT Solid Density table

data points sIn number of points
- SDTempTableIn TEMP Real Temperatures for

s
- Solid SolDensTableIn DENS Real Tabular data for Solid

density Vector Density
values
- SolDensTabTempU TEMP UOM Solid Density table

Temperature OMIn temp unit
UOM
- Solid SolDensTabPropU DENS UOM Solid Density table

density UOM OMIn prop unit
- Solid SolDensTabBasisIn InT 1 - Mole, 2 - Weight

density basis
Saturated Vapor Viscosity
- Number of SVapVisTabNumPt InT Sat Vapor Viscosity

data points sIn table number of points
- SVVTempTableIn TEMP Real Temperatures for

s

- Vapor SatVapViscTableIn VISC Real Tabular data for Sat

viscosity Vector Vapor Viscosity
values
- SVapVisTabTemp TEMP UOM Sat Vapor Viscosity

UOM
- Vapor SVapVisTabPropU VISC UOM Sat Vapor Viscosity

viscosity OMIn table prop unit
UOM
- Vapor SVapVisTabBasisI InT 1 - Mole, 2 - Weight

viscosity n
basis
- Saturated
liquid
viscosity
- Number of SLiqVisTabNumPts InT Sat Liquid Viscosity

data points In table number of points
- SLVTempTableIn TEMP Real Temperatures for

s
- Liquid SatLiqViscTableIn VISC Real Tabular data for Sat

viscosity Vector Liquid Viscosity
values
- SLiqVisTabTempU TEMP UOM Sat Liquid Viscosity

Temperature OMIn table temp unit
UOM

- Liquid SLiqVisTabPropUO VISC UOM Sat Liquid Viscosity

viscosity MIn table prop unit
UOM
- Liquid SLiqVisTabBasisIn InT 1 - Mole, 2 - Weight

viscosity
basis
Saturated Vapor Thermal Conductivity
- Number of SVapThCoTabNum InT Sat Vapor Thermal

data points PtsIn Conduct table number
of points
- SVTCTempTableIn TEMP Real Temperatures for

s
- Vapor SatVapThCondTabl COND Real Tabular data for Sat

thermal cond. e In Vector Vapor Thermal
values Conductivity
- SVapThCoTabTem TEMP UOM Sat Vapor Thermal

Temperature pUOMIn Conduct table temp
UOM unit
- Vapor SVapThCoTabProp COND UOM Sat Vapor Thermal

thermal cond. UOMIn Conduct table prop
UOM unit
- Vapor SVapThCoTabBasi InT 1 - Mole, 2 - Weight

thermal cond. s In
basis

Saturated Liquid Thermal Conductivity
- Number of SLiqThCoTabNum InT Sat Liquid Thermal

data points PtsIn Conduct table number
of points
- SLTCTempTableIn TEMP Real Temperatures for

s
- Liquid SatLiqThCondTabl COND Real Tabular data for Sat

thermal cond. eIn Vector Liquid Thermal
values Conductivity
- SLiqThCoTabTemp TEMP UOM Sat Liquid Thermal

Temperature UOMIn Conduct table temp
UOM unit
- Liquid SLiqThCoTabProp COND UOM Sat Liquid Thermal

thermal cond. UOMIn Conduct table prop
UOM unit
- Liquid SLiqThCoTabBasis InT 1 - Mole, 2 - Weight

thermal cond. In
basis
Solid Thermal Conductivity
- Number of SolThConTabNum InT Solid Thermal

data points Pt In Conductivity table
number of points
- STCTempTableIn TEMP Real Temperatures for

s

- Solid SolThCondTableIn COND Real Tabular data for Solid

thermal cond. Vector Thermal Conductivity
values
- SolThConTabTemp TEMP UOM Solid Thermal

Temperature UOMIn Conductivity table
UOM temp unit
- Solid SolThConTabProp COND UOM Solid Thermal

thermal cond. UOMIn Conductivity table
UOM prop unit
- Solid SolThConTabBasis InT 1 - Mole, 2 - Weight

thermal cond. In
basis
Saturated Liquid Surface Tension
- Number of SLiqSuTeTabNum InT Sat Liquid Surface

data points PtsIn Tension table number
of points
- SLSTTempTableIn TEMP Real Temperatures for

s
- Liquid SatLiqSurTenTable SURF Real Tabular data for Sat

surface In Vector Liquid Surface
tension Tension
values
- SLiqSuTeTabTemp TEMP UOM Sat Liquid Surface

Temperature UOMIn Tension table temp
UOM unit
- Liquid SLiqSuTeTabProp SURF UOM Sat Liquid Surface


surface UOMIn Tension table prop
tension UOM unit
- Liquid SLiqSuTeTabBasi InT 1 - Mole, 2 - Weight

surface sIn
tension basis
Unifac Structural Groups
- Group index GroupIDIn InT UNIFAC Group ID's

Vector input
- Number of GroupIDCountIn InT UNIFAC Group Count

groups in Vector input
component
Unifac Parameters
- van der VDWaalsAreaIn Real Input Van der waals

Waals area area, dimensionless
paramter (Q)
- van der VDWaalsVolIn Real Input Van der waals

Waals volume,
volume dimensionless
parameter
(R)
Particle Size Distribution data, Class = CompPSD
The component PSD information (ranges) are stored in the "CompPSD" class. This class
contains only one object called "CompPSD".
The values supplied in the stream for a component correspond to the ranges supplied for that
component in this object.
- Number of NumPSDCmps InT Number of


components components with PSD
data
- Component PSDComp Comp. ID PSD component

Ids Vector vector
- Beginning PSDStart InT PSDStart[i] and

index of Vector PSDEnd[i] mark the
components beginning and ending
- Ending PSDEnd InT indices in PSDData

index of Vector vector for PSDComp[i]
components
- PSD Data PSDData FLEN Real PSD data vector

(range) Vector
- Number of NumPSDNonZ InT Number of non-zero

non-zero cuts cuts for general
data.
General Attributes data, Class = CompMisc
The names of the general attributes for components are stored in the " CompMisc" class.
This class contains only one object called " CompMisc".
The values supplied in "StrmMiscIn" class objects correspond to the attribute names supplied
for that component in this object.
- Number of NumGenCmps InT Number of

components components with
general data
- Component GenComp Comp. ID General component

Ids Vector vector
- Beginning GenStart InT GenStart[i] and


index of Vector GenEnd[i] mark the
components beginning and ending
- Ending GenEnd InT indices in GenData

index of Vector vector for GenComp[i]
components
- General GenData Char General data vector

attribute Vector(1
names 2)
Number of NumGenNonZ InT Number of non-zero

non-zero cuts cuts for general
data
General Attributes data, Class = CompPoly
The component polymer information (ranges) is stored in the "CompPoly" class. This class
contains only one object called "CompPoly".
Individual CompDistFlag Int 1 - All, 0 - individual

component distribution
distribution
function
specification
flag
Kinetics flag KineticsFlag Int 1=FR, 2=SG
Component MWDComp Char Component IDs

IDs Vector(1
2)

MW attribute MWDData Double MW data vector.

names. Vector
Beginning MWDStart Int Vector MWDStart [i] and

index of MWDEnd [i] mark the
polymer cuts beginning and ending
Ending index MWDEnd Int Vector indices in MWDData

of polymer vector for MWDComp
cuts [i]
Number of NumMBCLCmps Int Number of

MBCL
Number non- NumMBCLNonZ Int Number of non-zero

zero cuts. cuts for MBCL
Number of NumMCTBCmps Int Number of

MCTB
Number non- NumMCTBNonZ Int Number of non-zero

zero cuts. cuts for MCTB
Number of NumMDSDCmps Int Number of

MDSD

Number non- NumMDSDNonZ Int Number of non-zero

zero cuts. cuts for MWD
Number of NumMMWDCmps Int Number of

MMWD
Number non- NumMMWDNonZ Int Number of non-zero

zero cuts. cuts for MMWD
Number of NumMTATBCmps Int Number of

MTATB
Number non- NumMTATBNonZ Int Number of non-zero

zero cuts. cuts for MTATB
Number of NumMTBTBCmps Int Number of

MTBTB
Number non- NumMTBTBNonZ Int Number of non-zero

zero cuts. cuts for MTBTB
Number of NumMTTBCmps Int Number of

MTTB

Number non- NumMTTBNonZ Int Number of non-zero

zero cuts. cuts for MTTB
Number of NumMWDCmps Int Number of

MWD
Number non- NumMWDNonZ Int Number of non-zero

zero cuts. cuts for MDSD
Number of NumPCFRACCmps Int Number of

PCFRAC
Number non- NumPCFRACNonZ Int Number of non-zero

zero cuts. cuts for PCFRAC
Number of NumPolyComp Int Number of polymer

components component
Component PCFRACComp Char Component IDs

IDs Vector(1
2)

MW attribute PCFRACData Int Vector PCFRAC data vector.

names.
Beginning PCFRACStart Int Vector PCFRACStart [i] and

index of PCFRACEnd [i] mark
polymer cuts the beginning and
ending
Ending index PCFRACEnd Int Vector indices in

of polymer PCFRACData vector
cuts for PCFRACComp [i]
Component MMWDData Char Component IDs

IDs Vector(1
2)
MW attribute MMWDComp Int Vector MMWDdata vector.

names.
Beginning MMWDStart Int Vector MMWDStart [i] and

index of MMWDEnd [i] mark
ending
Ending index MMWDEnd Int Vector indices in MMWDData

of polymer vector for
cuts MMWDComp [i]

Component MTATBData Char Component IDs

IDs Vector(1
2)
MW attribute MTATBComp Int Vector MTATB data vector.

names.
Beginning MTATBStart Int Vector MTATBStart [i] and

index of MTATBEnd [i] mark
ending
Ending index MTATBEnd Int Vector indices in MTATBData

cuts MTATBComp [i]
Component MTBTBData Char Component IDs

IDs Vector(1
2)
MW attribute MTBTBComp Int Vector MTBTB data vector.

names.
Beginning MTBTBStart Int Vector MTBTBStart [i] and

index of MTBTBEnd [i] mark


ending
Ending index MTBTBEnd Int Vector indices in MTBTBData

of vector for
MTBTBComp [i]
polymer cuts
Component MCTBData Char Component IDs

IDs Vector(1
2)
MW attribute MCTBComp Int Vector MCTB data vector.

names.
Beginning MCTBStart Int Vector MCTBStart [i] and

index of MCTBEnd [i] mark the
Ending index MCTBEnd Int Vector indices in

of polymer PCFRACData vector
cuts for MCTBComp [i]
Component MBCLData Char Component IDs

IDs Vector(1
2)

MW attribute MBCLComp Int Vector MBCL data vector.

names.
Beginning MBCLStart Int Vector MBCLStart [i] and

index of MBCLEnd [i] mark the
Ending index MBCLEnd Int Vector indices in MBCLData

of polymer vector for MBCLComp
cuts [i]
Component MTTBData Char Component IDs

IDs Vector(1
2)
MW attribute MTTBComp Int Vector MTTB data vector.

names.
Beginning MTTBStart Int Vector MTTBStart [i] and

index of MTTBEnd [i] mark the
Ending index MTTBEnd Int Vector indices in MTTBData

of polymer vector for MTTBComp
cuts [i]

Component MDSDData Double Component IDs

IDs Vector
MW attribute MDSDComp Int Vector MDSD data vector.

names.
Beginning MDSDStart Int Vector MDSDStart [i] and

index of MDSDEnd [i] mark the
Ending index MDSDEnd Int Vector indices in MDSDData

cuts MDSDComp [i]
Component PolyCompData Int Polymer comps

IDs whose distribution are
specified
Component Calculated Data
The calculated fixed property data for components are stored in the "CompCalc" class.
There is only one instance of this class and its name is also "CompCalc".
This object contains vectors for each component property and Property[i] belongs to
component ComponentId[i].
Calculated data, Class = CompCalc
- Component ComponentId 0 to N- Comp ID Component ID

ID 1 Vector (Name)

- Component ComponentType InT 1 - Library, 2 - Non-

type Vector Library, 3 - Petroleum,
4 - Assay
pseudocomponent,
5 - Syncomp, 6 -
Synliq
- Phase Phase InT 1 - Vapor, 2 - Liquid, 3

Vector - Solid
- Print PrintNumber InT Component numbers

number Vector displayed are in
internal order that is
based on component
phase information
- CAS ChemAbsNum InT Chemical abstract

number Vector number
- Library LibraryNumber InT Component library

number Vector number
Temperature independent component properties, Class = CompCalc
- Molecular MolWeight Real Molecular Weight

weight Vector
- Specific SpecGravity Real Specific Gravity

gravity Vector
- Normal NormBoilPt TEMP Real Normal boiling point

boiling point Vector
- Normal NormMeltPt TEMP Real Normal melting point


melting point Vector
- Acentric AcenFactor Real Accentric factor

factor Vector
- Critical CritTemp TEMP Real Critical temperature

temperature Vector
(Tc)
- Critical CritPress PRES Real Critical pressure

pressure (Pc) Vector
- Critical CritVol LIQV Real Critical volume

volume (Vc) Vector
- Critical CritCompress Real Critical

compressibilit Vector compressibility
y factor (Zc)
- Watson K WatsonK Real Watson K

factor Vector
- Liquid molar LiqMolVol LIQV Real Liquid molar volume

volume Vector
- Heat of HeatFusionAtNMP ENTH Real Heat of fusion at the

fusion at Vector normal melting point
normal
melting point
- Heat of HeatVapAtNBP ENTH Real Heat of vaporization

vaporization Vector at the normal boiling
at norm point
boiling point

- Reference FreeEnFoPhase InT 1 - Vapor, 2 - Liquid, 3

phase - Solid
- Standard StdHeatForm ENTH Real Standard heat of

heat of Vector formation
formation
- Standard StdFreeEnForm ENTH Real Standard free energy

free energy Vector of formation
of formation
- Solubility SolParam Real SolParam

parameter Vector
- Racket RackettParam Real Rackett parameter

Vector
- Carbon CarbonNum Real Carbon number

number Vector
- Hydrogen HydrogenDef Real Hydrogen defiency

defiency Vector number
number
- Dipole DipoleMoment DIPO Real Dipole moment

moment Vector
- Radius of RadGyration FLEN Real Radius of gyration

gyration Vector
- Heat of HeatCombus ENTH Real Heat of combustion

combustion Vector
- Triple point TripPtPress PRES Real Triple point pressure

pressure Vector

- Triple point TripPtTemp TEMP Real Triple point

temperature Vector temperature
- Gross GrossHeatValue HVAL Real Gross heating value

heating value Vector
- Lower LowerHeatValue HVAL Real Lower heating value

heating value Vector
- Vapor VapEntropyDepNB ENTR Real Vapor entropy

entropy P Vector departure at NBP
departure at
NBP
- Library LibEntrVapNBP ENTR Real Library entropy of

entropy of Vector vaporization at NBP
vaporization
at NBP
- Liquid LibLiqEntrNbpNmp ENTR Real Liquid entropy

entropy Vector change from NBP to
change from NMP
NBP to NMP
- Vapor VaporEnthDepNBP ENTH Real Vapor enthalpy

enthalpy Vector departure at NBP
departure at
NBP
- Library LibEnthVapNBP ENTH Real Library enthalpy of

enthalpy of Vector vaporization at NBP
vaporization
at NBP

- Liquid LibLiqEnthNbpNmp ENTH Real Liquid enthalpy

enthalpy Vector change from NBP to
change from NMP
NBP to NMP
- van der VDWaalsArea Real van der Waals area

Waals area Vector
- van der VDWaalsVol Real van der Waals

Waals Vector volume
volume
- ETA EtaParam Real Eta parameter

parameter Vector
(Truncated
Virial EOS)
- WT WTParam Real WT parameter

parameter Vector (Solubility equation)
(Solubility
equation)
- PAVA PAVAParam Real PAVA parameter

parameter Vector
(Solubility
equation)
- SRK M SrkMFactor Real SRK M factor

factor for Vector
phase
envelope
- PR M factor PrMFactor Real PR M factor

for phase Vector
envelope

Table B.2 Thermo Data
Read an attribute: ThermoObject.GetAttribute(AttributeName, Index)
Write an attribute: ThermoObject.PutAttribute(AttributeName, Index)
User Accessible Input Variables, Class = ThermoSet
Thermodynamic SystemFlagInpt InT See Table 1

system selected
VLLE set flag VLLEFlagInpt InT 0 - Not a VLLE set,

1 - VLLE set
Default Methods
- K-Value (VLE) KvalVLEDflt InT Default VLE

method
- K-Value (LLE) KvalLLEDflt InT Default LLE

method
- K-Value (SLE) KvalSLEDflt InT Default SLE

method
- Henry's law HenryDflt InT Default Henry's

coefficient law coefficient
method
- Liquid enthalpy LiquidEnthalpyDfl InT Default liquid

t enthalpy method
- Vapor enthalpy VaporEnthalpyDfl InT Default vapor

t enthalpy method
- Liquid density LiquidDensityDflt InT Default liquid

density method

- Vapor density VaporDensityDflt InT Default vapor
density method
- Vapor fugacity VaporPhiDflt InT Default vapor

(PHI) fugacity coefficient
method
- Liquid entropy LiquidEntropyDflt InT Default liquid

entropy method
- Vapor entropy VaporEntropyDflt InT Default vapor

entropy method
- Liquid viscosity LiquidViscosityDfl InT Default liquid

t viscosity method
- Vapor viscosity VaporViscosityDfl InT Default vapor

t viscosity method
- Liquid LiquidConducDflt InT Default liquid

conductivity conductivity
method
- Vapor VaporConducDflt InT Default vapor

conductivity conductivity
method
- Surface tension SurfaceTnsionDfl InT Default surface

t tension method
- Liquid diffusivity LiquidDiffusDflt InT Default liquid

diffusivity method
User-overridden Methods
- K-Value (VLE) KvalVLEOvride InT User override to

default VLE method
- K-Value (LLE) KvalLLEOvride InT User override to

default LLE method
- K-Value (SLE) KvalSLEOvride InT User override to

default SLE method

- Henry's law HenryOvride InT User override to
coefficient default Henry's law
coefficient method
- Liquid enthalpy LiquidEnthalpyOvri InT User override to

de default liquid
enthalpy method
- Vapor enthalpy VaporEnthalpyOvri InT User override to

de default vapor
enthalpy method
- Liquid density LiquidDensityOvrid InT User override to

e default liquid
density method
- Vapor density VaporDensityOvrid InT User override to

e default vapor
density method
- Vapor fugacity VaporPhiOvride InT User override to

(PHI) default vapor
fugacity coefficient
method
- Liquid entropy LiquidEntropyOvrid InT User override to

e default liquid
entropy method
- Vapor entropy VaporEntropyOvrid InT User override to

e default vapor
entropy method
- Liquid viscosity LiquidViscOvride InT User override to

default liquid
viscosity method
- Vapor viscosity VaporViscOvride InT User override to

default vapor
viscosity method

- Liquid LiquidConducOvrid InT User override to
conductivity e default liquid
conductivity
method
- Vapor VaporConducOvrid InT User override to

conductivity e default vapor
conductivity
method
- Surface tension SurfaceTnsionOvri InT User override to

de default surface
tension method
- Liquid diffusivity LiquidDiffusOvride InT User override to

default liquid
diffusivity method
Water Handling Options
- water decant DecantOverrideInpt InT 0 - Allow method

option determine if water
will be decanted
1 - Turn off water
decant
unconditionally
2 - Turn on water
decant
unconditionally
- solubility option HCSolubOptionInpt InT 0/1 - use default

method
2 - use kerosene
data
3 - use eos method
- water properties WaterPropsInpt InT 0 - Compute sat.

option water props
1 - Compute actual
props using steam
tables

Binary InTeraction Parameters : Use the appropriate class names (refer Table 2) to access
the parameter data for the desired property
BWRS
Data applicable for K-Value (VLE), Liquid enthalpy, Vapor enthalpy, Liquid density, Vapor
density, Liquid entropy, Vapor entropy classes
- Number of pairs BWRSCount InT BWRS count
- Component i BWRSKijComp1 Comp ID BWRS i's

Vector
- Component j BWRSKijComp2 Comp ID BWRS j's

Vector
- kij BWRSKij Real Vector Kij
Associating Hexamer Equation of State
Data applicable for K-Value (VLE), K-Value (LLE), Liquid enthalpy, Vapor enthalpy, Liquid
density, Vapor density, Liquid entropy, Vapor entropy classes
- Number of pairs HEXCount InT HEX count. The

following vectors
are sized to this
count
- Component i HEXKijComp1 Comp ID HEX i's

Vector
- Component j HEXKijComp2 Comp ID HEX j's

Vector
- kija HEXKijA Real Vector Kija
- kjia HEXKjiA Real Vector Kjia
- kijb HEXKijB Real Vector Kijb
- kjib HEXKjiB Real Vector Kjib
- kijc HEXKijC Real Vector Kijc

- kjic HEXKjiC Real Vector Kjic
- cij HEXCij Real Vector Cij
- cji HEXCji Real Vector Cji
- Unit of measure HEXKijUnit InT Vector 1 - Kelvin, 2 -

Rankine
Lee-Kesler-Plocker
- Number of pairs LKPCount InT LKP count . This

sizes the following
vectors.
- Component i LKPKijComp1 Comp ID LKP i's

Vector
- Component j LKPKijComp2 Comp ID LKP j's

Vector
- kij LKPKij Real Vector Kij
Redlich-Kister, Gamma Heat of Mixing
Data applicable only for Liquid enthalpy class, Class = ThermoSet
- Heat of mixing ExcessEnthInpt InT Excess enthalpy

method applied flag
to the liquid
419 - Redlich-Kister
enthalpy method
1
420 - Redlich-Kister
2
Data applicable only for Liquid enthalpy class, Class = ThHLiqIn
- Number of Rk1orRk2Count InT The following

component pairs vectors are sized to
this count

- Component I RKisComp1 Comp ID RK1 or RK2 i's
Vector
- Component j RKisComp2 Comp ID RK1 or RK2 j's

Vector
- aij RKisAij Real Vector Aij
- bij RKisBij Real Vector Bij
- cij RKisCij Real Vector Cij
- dij RKisDij Real Vector Dij
- eij RKisEij Real Vector Eij
- fij RKisFij Real Vector Fij
- gij RKisGij Real Vector Gij
- hij RKisHij Real Vector Hij
- Unit of measure RKisUnit InT Vector RK1 or RK2 UOM
SRK, PR, SRKKD
- Number of KijTCount InT Kij(T) count

binary pairs
- Component i KijTComp1 Comp ID. Kij(T) i's

Vector
- Component j KijTComp2 Comp ID. Kij(T) j's

Vector
- kija KijA Real Vector Kija
- kijb KijB Real Vector Kijb
- kijc KijC Real Vector Kijc

- Unit of measure KijTUnit InT Vector 1 - Kelvin, 2 -
Rankine
SRKP, PRP

binary pairs
- Component i KijTComp1 Comp ID. Kij(T) i's

Vector

Vector
- kija KijA Real Vector Kija
- kjia KjiA Real Vector Kjia
- kijb KijB Real Vector Kijb
- kjib KjiB Real Vector Kjib
- kijc KijC Real Vector Kijc
- kjic KjiC Real Vector Kjic

Rankine
SRKM, PRM, SRKS, SRKH and PRH

binary pairs
- Component I KijTComp1 Comp ID. Kij(T) i's

Vector

Vector
- kija (Aij for KijA Real Vector kija

SRKH and PRH)

- kjia (Bij for KjiA Real Vector Kjia
SRKH and PRH)
- kijb (Cij for KijB Real Vector Kijb

SRKH and PRH)
- kjib (Aji for KjiB Real Vector Kjib

SRKH and PRH)
- kijc (Bji for KijC Real Vector Kijc

SRKH and PRH)
- kjic (Cji for KjiC Real Vector Kjic

SRKH and PRH)
- cij ( ij for SRKH Cij Real Vector

and PRH)
- cji ( ij for Cji Real Vector

SRKH and PRH)

Rankine
NRTL Liquid Activity Method
Data applicable for K-Value (VLE) and K-Value (LLE) classes only
NRTL3
- Number of NRTL3Count InT NRTL3 count

component pairs
- Component i NRTL3Comp1 Comp ID. NRTL3 i's

Vector
- Component j NRTL3Comp2 Comp ID. NRTL3 j's

Vector
- bij NRTL3Bij Real Vector Bij
- bji NRTL3Bji Real Vector Bji

- ji NRTL3ALPHAij Real Vector Alphaij
- Unit of measure NRTL3Unit InT Vector 1 - Kelvin,

2
KiloCalories/Kilo
Mole,
3 KiloJoules/
KiloMole
NRTL5

component pairs

Vector

Vector
- aij NRTL5Aij Real Vector Aij
- aji NRTL5Aji Real Vector Aji
- ij NRTL5ALPHAij Real Vector Alphaij
- Unit of measure NRTL5Unit InT Vector 1 - Kelvin, 2 -

KiloCalories, 3
KiloJoules/
KiloMole
NRTL6

component pairs

Vector

Vector
- 'ij NRTL6ALPHAc Real Vector Alphac
- 'ij NRTL6ALPHAt Real Vector Alphat
- Unit of measure NRTL6Unit InT Vector 1 - Kelvin, 2

KiloCalories/Kilo
Mole, 3
KiloJoules/
KiloMole
NRTL8

component pairs

Vector

Vector
- cij NRTL8Cij Real Vector Cij

- cji NRTL8Cji Real Vector Cji
- 'ij NRTL8ALPHAij Real Vector Alphaij
- 'ij NRTL8Betaij Real Vector Betaij
- Unit of measure NRTL8Unit InT Vector 1 - Kelvin,

2
KiloCalories/KiloMo
le,
3 KiloJoules
NRTL10
- Number of NRTL10Count InT NRTL10Count

component pairs
Comp ID.
- Component i NRTL10Comp1 Vector NRTL10 i's
Comp ID.
- Component j NRTL10Comp2 Vector NRTL10 j's
- dij NRTL10Dij Real Vector Dij
- eij NRTL10Eij Real Vector Eij
- dji NRTL10Dji Real Vector Dji
- eji NRTL10Eji Real Vector Eji
-'ij NRTL10ALPHAij Real Vector Alphaij

NRTL14
- Number of
component pairs InT NRTL14Count
Comp ID.
- Component i NRTL14Comp1 Vector NRTL14 i's
Comp ID.
- Component j NRTL14Comp2 Vector NRTL14 j's
- cij NRTL14Cij Real Vector Cij
- dij NRTL14Dij Real Vector Dij
- eij NRTL14Eij Real Vector Eij
- fij NRTL14Fij Real Vector Fij
- cji NRTL14Cji Real Vector Cji
- dji NRTL14Dji Real Vector Dji
- eji NRTL14Eji Real Vector Eji
- fji NRTL14Fji Real Vector Fji
- 'ij NRTL14ALPHAij Real Vector Alphaij
UNIQUAC

UNIQUAC (2 parameter)
- Number of UNIQUAC2Count InT UNIQUAC2 count

component pairs
- Component i UNIQUAC2Comp1 Comp ID. i's

Vector
- Component j UNIQUAC2Comp2 Comp ID. js

Vector
- aij UNIQUAC2Aij Real Vector Aij
- aji UNIQUAC2Aji Real Vector Aji
- Unit of measure UNIQUAC2Unit InT Vector 1 - Kelvin, 2

KiloCalories/KiloMole,
3 KiloJoules/
KiloMole
UNIQUAC (4 parameter)
- Number of UNIQUAC4Count InT UNIQUAC4 count

component pairs
- Component i UNIQUAC4Comp1 Comp ID. is

Vector
- Component j UNIQUAC4Comp2 Comp ID. js

Vector
- aij UNIQUAC4Aij Real Vector Aij
- aji UNIQUAC4Aji Real Vector Aji
- bij UNIQUAC4Bij Real Vector Bij
- bji UNIQUAC4Bji Real Vector Bji

- Unit of measure UNIQUAC4Unit InT Vector 1 - Kelvin,
2
KiloCalories/KiloMole,
3 KiloJoules/
KiloMole
Azeotrope Data
- Number of AzeoCount InT Count

component pairs
- Component i AzeoComp1 Comp ID. is

Vector
- Component j AzeoComp2 Comp ID. js

Vector
- Pressure AzeoPress PRES Real Vector Azeotrope Pressure
- Pressure unit of AzeoPunit PRES UOM Pressure units

measure
- Temperature AzeoTemp TEMP Real Vector Azeotrope

Temperature
- Temperature AzeoTunit TEMP UOM Temperature units

unit of measure
- xi AzeoConc Real Vector Concentration at

azeotrope
- Basis AzeoBasis InT Wt or Molar
Mutual Solubility Data
- Number of MutuCount InT Count

component pairs
- Component i MutuComp1 Comp ID. is

Vector
- Component j MutuComp2 Comp ID. js

Vector

- Temperature MutuTemp TEMP Real Vector Temperature
- Temperature MutuTunit TEMP UOM Temperature units

unit of measure
- x'i MutuConcComp1 Real Vector Solubility of Comp 1

in Comp 2
- x''j MutuConcComp2 Real Vector Solubility of Comp 2

in Comp 1
- Basis MutuBasis InT Wt or molar
Infinite Dilution Activity Data
- Number of InfiniCount InT Count

component pairs
- Component i InfiniComp1 Comp ID. is

Vector
- Component j InfiniComp2 Comp ID. js

Vector
- Temperature InfiniTemp TEMP Real Vector Temperature
- Temperature InfiniTunit TEMP UOM Temperature units

unit of measure
- i InfiniGamma1 Real Vector GAMMA1 at infinite

dilution in Comp 2
- j InfiniGamma2 Real Vector GAMMA2 at infinite

dilution in Comp 1
Wilson
Data applicable for K-Value (VLE) class only
- Number of WilsonCount InT Count

component pairs
- Component i WilsonComp1 Comp ID. is

Vector

- Component j WilsonComp2 Comp ID. js
Vector
- aij WilsonAij Real Vector Aij
- aji WilsonAji Real Vector Aji
- Unit of measure WilsonUnit InT Vector 1 - Kelvin, 2

KCals/KMol,
3 Kjoules/KMol, 4
None
Van Laar
- Number of VanlaarCount InT Count

component pairs
- Component i VanlaarComp1 Comp ID. is

Vector
- Component j VanlaarComp2 Comp ID. js

Vector
- aij VanLaarAij Real Vector Aij
- aji VanLaarAji Real Vector Aji
Margules
- Number of MargulesCount InT Count

component pairs
- Component i MargulesComp1 Comp ID. is

Vector
- Component j MargulesComp2 Comp ID. js

Vector
- aij MargulesAij Real Vector Aij

- aji MargulesAji Real Vector Aji
- dij MargulesDij Real Vector Dij
Table B.2.1: Internal Numbers for Thermodynamic Methods

Keyword
Thermodynamic Method InTernal ID
Abbreviation
Ideal IDEAL 1
Soave-Redlich-Kwong SRK 101
Peng-Robinson PR 102
Grayson-Streed GS 103
Chao-Seader CS 104
Braun K10 BK10 105
Kabadi-Danner modifications to SRK SRKKD 108
Huron-Vidal modifications to SRK SRKH 109
Benedict-Webb-Rubin-Starling BWRS 110
Panagiotopoulos-Reid modifications to SRK SRKP 111
Huron-Vidal modifications to PR PRH 112
UNIWAALS UNIWAAL 113
Panagiotopoulos-Reid modifications to PR PRP 114
Hayden-O'Connell vapor fugacity HOCV 115
Modified Panagiotopoulos-Reid mods to SRK SRKM 116

Keyword
Abbreviation
Modified Panagiotopoulos-Reid mods to PR PRM 117
Grayson-Streed-Erbar GSE 118
Chao-Seader-Erbar CSE 119
Modifications to Grayson-Streed & Chao-Seader IGS 120
SimSci modifications to SRK SRKS 121
Associating Hexamer equation of state HEXAMER 122
Idimer vapor fugacity IDIMER 123
TACITE TACITE 124
SAFT SAFT 125
Predictive Peng-Robinson 78 PPR78 130
Predictive Peng-Robinson PPR78 130
Predictive Soave-Redlich-Kwong PSRK 131
Lee-Kesler-Plocker LKP 204
Truncated Virial Vapor Fugacity TVIRIAL 210
"Non-Random Two Liquid" liquid activity method NRTL 401
UNIQUAC UNIQUAC 403
Wilson WILSON 404

Keyword
Abbreviation
UNIFAC UNIFAC 405
Regular Solution REGULAR 406
Flory-Huggins FLORY 407
Advanced-Lattice Model ALM 409
Van Laar VANLAAR 410
Margules MARGULES 411
UNIFAC Modification UFT1 UNIFT1 412
UNIFAC Modification UNFV UNFV 415
Alcohol package ALCO 501
Glycol package GLYC 502
Sour Water package SOUR 503
GPA Sour Water package GPSWATER 510
Amine package AMINE 511
Van't Hoff Solubility VANTHOFF 802

Table B.2.2 Class Names : Property specific data are stored
in their own objects.
The following is the list of property and their class names.
Property Class Name
- K-Value (VLE) ThKvalVLEIn
- K-Value (LLE) ThKvalLLEIn
- K-Value (SLE) ThKvalSLEIn
- Henry's law coefficient ThHenryIn
- Liquid enthalpy ThHLiqIn
- Vapor enthalpy ThHVapIn
- Liquid density ThDLiqIn
- Vapor density ThDVapIn
- Vapor fugacity (PHI) ThFugCVapIn
- Liquid entropy ThSLiqIn
- Vapor entropy ThSVapIn
- Liquid viscosity ThVLiqIn
- Vapor viscosity ThVVapIn
- Liquid conductivity ThCLiqIn
- Vapor conductivity ThCVapIn
- Surface tension ThSurTenIn
- Liquid diffusivity ThDiffLiqIn

TableB.3A Stream Input Data
Read an attribute:StreamObject.GetAttribute(AttributeName, Index)
Write an attribute: StreamObject.PutAttribute(AttributeName, Index)
Stream Input Data
Stream Documentation, Class = StreamIn
Name StreamName Char 40 char max

(Description)
Stream Conditions, Class = StreamIn
Stream type StreamTypeFlag InT 1 - Composition

defined
2 - Assay
10 - Reference
stream
Solids only SolidsOnlyFlag InT 1 - Composition

stream flag defined stream
containing only
solids
Thermo method StreamThermoMeth Therm 0 - Global default

od ID
>0 - Specified
thermo-dynamic
method
Specification, Class = StreamIn
Temperature Temperature TEM Real

P
Pressure Pressure PRE Real

S
Phase InputPhaseFlag InT 0 Mixed

Stream Input Data

1 Vapor
2 Liquid
Liquid fraction StrmLiqFracFlg InT 0 - Bubble, dew,

present flag liquid fraction
specs)
1 - Temperature
and pressure specs
Liquid fraction LfracBasisFlag InT 1 - Mole

basis flag
2 - Weight
3 - Liquid volume
Liquid fraction LiquidFraction Real
Total stream rate TotalRate Real
Rate basis RateBasisFlag InT 1 Mole

2 Weight
3 - Liquid volume
4 - Gas volume
Stream Temp StrmTempPressFlg InT 0 - Both pressure

Press Flg and temperature
are specified
1 - Only pressure is
specified
2 - Only
temperature is
specified
3 - Neither is
specified (only valid

Stream Input Data

for reference
streams)
Composition, Class = StreamIn
Composition/Rate StrmCompRateFlg Int 0 - Total rate and

flag composition
supplied
1 Total rate and
assay supplied
2 - Individual
component rates
supplied.
Number of CompVectorDimen Int

components sion
Composition units CompositionDimen UO

of measure Unit M
Composition CompositionBasisFl Int 1 Mole

basis ag
2 Weight
3 - Liquid volume
4 - Vapor volume
Component index ComponentID 0 to N- Com Component IDs

1 pID
N=
CompVectorDimen
sion
Component Composition 0 to N- Real

composition or 1

Stream Input Data

rate
Normalize flag NoCheckBasisFlag Int 0 Normalization

off
1 - Normalization
on
Streams with Assay data, Class = StreamAsIn
Distillation type DistType Int 1 - D86

2 - TBP
3 - D1160
4 - D2887
Basis Basis Int 1 - Liquid volume

2 Weight
Distillation DistPres PRES Real

reference
pressure
Cracking Cracking Int 0 No cracking

correction for D86 correction
data
1 - Correction
applied
Temperature TempBasis Int 10 K

basis for
11 C
distillation data
12 R
13 F

Stream Input Data
Distillation curve data, Class = StreamAsIn
Number of assay Temperatures Int

points (Pct/Temp
pairs)
Percent DistPct 0 to N- Real N = Temperatures

1
Value DistTemp 0 to N- TEMP Real

1
Gravity Data, Class = StreamAsIn
Gravity type GravType Int 1 API

2 - Specific gravity
3 - Watson K
Average stream AvgGravity Real

gravity
Number of points Gravities Int

(Pct/Gravity pairs)
Percent GravPct 0 to N- Real N = Gravities

1
Value GravVal 0 to N- Real

1
Molecular Weight Data, Class = StreamAsIn
Average AvgMW Real

Stream Input Data

molecular weight
Number of points MWs InT

(Pct/MW pairs)
Percent MWPct 0 to N- Real N=MWs

1
Value MWVal 0 to N- Real

1
Lightends Data, Class = StreamAsIn
Lightends rate LeRate Real
Rate basis LeRateBasis Int 1 Mole

2 Weight
3 LV
4 - GV
Rate UOM LeRateUOM UOM
Lightends fraction LeFrac Real
Fraction basis LeFrnBasis Int 1 Mole

2 Weight
3 - Liquid volume
4 - Gas Volume
Lightends percent LePct Real

Stream Input Data
Percent basis LePctBasis Int 1 Mole

2 Weight
3 - Liquid volume
4 - Gas Volume
Match TBP curve LeMatch Int 0 No Match

1 - Match
Composition LeCompBasis Int 1 Mole

basis
2 Weight
3 - Liquid Volume
4 - Gas Volume
Number of LeComps Int

components
Component index LeCompIDs 0 to N- Com N = LeComps

1 p ID
Value LeVal 0 to N- Real

1
Refinery inspection properties, Class = StreamAsIn
Number of GenPropCount Int

standard refinery
inspection
properties in
simulation
Property names GenPropNames 0 to N- Char N = GenPropCount

Stream Input Data

1
Refinery inspection properties, Class = StrmSPGenIn

(object given by StreamID.GenPropNames)
Average stream AverageValue Real

value for refinery
inspection
property
Average value AverageQualifier InT 10 - Fraction

qualifier
11 Percent
12 PPM
Number of data NumDataPairs Int

points (PCT/value
pairs)
Mid point AssayPercentage 0 to Real N1 =

percents N1 NumDataPairs
Values (or PropertyValue 0 to Real

Kinematic N1
viscosity 1st
value)
No. of data points LengthKVisT2 Int

for Kin. Visc. 2nd
value
Kinematic KVis2Value 0 to KVIS Real N2 = LengthKVisT2

viscosity 2nd N2
values

Stream Input Data
Value qualifier DataQualifier 0 to Int 10 - Fraction

N2
11 Percent
12 PPM
Kinematic KVisTemp1 TEMP Real

viscosity 1st
temperature
Kinematic KVisTemp2 TEMP Real

viscosity 2nd
temperature
User-defined special properties, Class = StreamAsIn
Number special of UserPropCount Int

properties
Property names UserPropames 0 to N Char Normally 1, 2, 3,

etc. for Special
Properties 1, 2, 3
etc.
N = UserPropCount
User-defined special properties, Class = StrmSPUsrIn

(object given by StreamID.UserPropNames)
Average stream AverageValue Real

value
Number of special NumDataPairs Int

property data
point pairs

Stream Input Data
Midpoint Percents AssayPercentage 0 to N Real N = NumDataPairs
Values PropertyValue 0 to N Real
Solids Flowrate and Composition data, Class = StreamIn
Mole based solids
Stream data type SolidMoleCompRat Int 1 - Total rate,

eFlg composition supplied
2 - Individual
component rates
supplied
Mole flowrate SolidsMoleRate Real

solids
Flowrate UOM SolidMoleRateUnit UO

M
Number of mole SolidMoleCompVec Int

based solid Dim
components
Component index SolidMoleCompID 0 to N- Com

1 p ID
Composition SolidsMoleComp 0 to N- Real N=

value 1 SlidMoleCompVecDi
m
Composition units SolidMoleCompUnit UO

of measure M

Stream Input Data
Composition SolidMoleNoCheck Int 0 - Do not normalize

normalize flag Flg
1 Normalize
Weight based solids
Stream data type SolidWtCompRat Int 1 - Total rate,

eFlg composition supplied
2 - Individual
component rates
supplied
Weight flowrate SolidsWeightRate Real

solids
Flowrate UOM SolidWtRateUnit UOM
Number of weight SolidWtCompVec Int

based solid Dim
components
Component index SolidWtCompID 0 to N- Comp

1 ID
Composition SolidsWtComp 0 to N- Real

value 1
Composition unit SolidWtCompUnit UOM
Composition SolidWtNoCheck Int 0 - Do not normalize

normalize flag Flg
1 Normalize

Stream Input Data
Particle Size Distribution, Class = StrmPSDIn
Number of NumPSDCmps Int

components with
PSD
Component Ids PSDComp 0 to N- Comp N = NumPSDCmps

1 ID
Starting value PSDStart Int

index
Ending value PSDEnd Int

index
Value PSDData Real Values between

PSDStart[i] and
PSDEnd[i] indices
belong to
PSDComp[i]
Number of non- NumPSDNonZ InT Number of non-zero

zero cuts data cuts for general
The particle size distribution ranges for the each component are defined in the CompPSD
object. The data supplied in streams are the values for these ranges.
General Solid Attributes, Class = StrmMscIn
Number of NumGenCmps N Int

components with
general solid data
Component Ids GenComp 0 to N- Comp

Stream Input Data

1 ID
Starting value GenStart Int

index
Ending value GenEnd Int

index
Value GenData Real Values between

GenStart[i] and
GenEnd[i] indices
belong to GenComp[i]
Number of non- NumGenNonZ InT Number of non-zero

zero cuts data cuts for general
The names of the general attributes are defined in CompGen object. The data supplied in
streams are the values for these general attribute names.
Table B.3B Stream Calculated Data

Read an attribute: StreamObject.GetAttribute(AttributeName, Index)
Stream Calculated Data
Calculated Stream Properties, Class = CompCalc

Component ID ComponentId 0 to Com

p. ID
NOC -1
Calculated Stream Properties, Class = Stream
Component mole TotalComposition 0 to Real

fractions
NOC -1
Vapor phase VaporCompositio 0 to Real

compositions n
NOC -1
Liquid phase LiquidCompositio 0 to Real

compositions n
NOC -1
Solid phase SolidComposition 0 to Real

compositions
NOC -1
Temperature Temperature TEMP Real
Pressure Pressure PRES Real
Mole flow rate TotalMolarRate MRAT Real
Mole fraction vapor VaporFraction Real
Mole fraction total liquid LiquidFraction Real
Mole fraction water or WaterFraction Real

L2 liquid
Inert weight rate InertWeightRate WTRA Real
Weight fraction solids SolidFraction Real

Molar enthalpy TotalMolarEnthal ENTH Real

py
Molar entropy TotalMolarEntrop ENTR Real

y
Critical Temperature CritTempFmKVal TABS Real
Bulk Total Stream Properties, Class = SrBulkProp
Molecular weight BulkMwOfPhase Real
Acentric factor BulkAccenFactor Real
Tc BulkCritTemp TABS Real
Pc BulkCritPres PABS Real
Vc BulkCritVolume LIQV Real
Zc BulkCritZFactor Real
Density, Actual BulkDensityAct DENS Real

conditions
Density (Sp. Gravity), BulkDensityStd DENS Real

Std. Conditions
Thermal conductivity BulkThermalCon COND Real

d
Viscosity BulkViscosity VISC Real
Surface Tension BulkSurfTension SURF Real
Normal boiling point, BulkNBPMole TEMP Real

molar composition

Normal boiling point, BulkNBPWt TEMP Real

weight composition
Normal boiling point, BulkNBPVol TEMP Real

Volume composition
UOP K-value BulkUOPKvalue Real
True vapor pressure BulkTrueVapPres PRES Real
Reid vapor pressure BulkReidVapPres Real

(API NAPHTHA) N

(API CRUDE) C

(ASTM D323-73) 3

(ASTM D323-94) 4

(ASTM D4953-91) 5

(ASTM D5191-91) 6

(IDL Method) 7
Reid Vapor Pressure BulkReidVapPres Real

(ASTM D323-82) 78
Gross heating value BulkGrossHeatV HVAL Real

alue

Lower heating value BulkLowerHeatV HVAL Real

alue
Gas Wobbe index BulkWobbeIndex Real
Rate of flow of C2+ BulkC2Plus Real
Rate of flow of C3+ BulkC3Plus Real
Heat capacity, constant BulkCP CP Real

pressure
Cp/Cv Ratio BulkCPCVRatio Real
pH value BulkPH Real
Ionic Strength BulkIonicStrengt Real

h
BulkTemperature BulkTemp TABS Real
Refinery Inspection Properties, Class = SrRefProp
Kinematic viscosity BulkKinematicVis

c KVIS Real
Cloud point BulkCloudPoint TEMP Real
Pour point BulkPourPoint TEMP Real
Flash point (Close cup) BulkFlashPointC

Cup TEMP Real
Sulfur content BulkSulfurConten

t PCT Real
Cetane number Real

BulkCetaneNumb


er
Smoke point BulkSmokePoint Real
Total aromatics content BulkTotalAromati

cs PCT Real
Naphthene content BulkNaphthene PCT Real
Total paraffin content BulkTotalParaffin PCT Real
Hydrogen content BulkHydrogenCo

ntent PCT Real
Carbon content BulkCarbonConte

nt PCT Real
Vanadium content BulkVanadiumCo

ntent PPM Real
Nickel content BulkNickelConten

t PPM Real
Oxygen content BulkOxygenCont

ent PPM Real
Nitrogen content (Total) BulkTotalNitroge

n PCT Real
Nitrogen content BulkBasicNitroge

(Basic) n PCT Real
Nitrogen content (Non- BulkNonBasicNitr

basic) ogen PCT Real
Asphaltene content BulkAsphalteneC

(C5) 5 PPM Real

Asphaltene content BulkAsphalteneC

(C7) 7 PPM Real
Penetration index BulkPenetrationIn

dex Real
Freeze point BulkFreezePoint TEMP Real

temperature
Conradson carbon BulkConradsonC PCT Real

residue Resid
Carbon-Hydrogen ratio BulkCToHRatio Real
Wax content BulkWaxContent PCT Real
Ash content BulkAshContent PCT Real
Octane number BulkROctaneNu Real

(Research) mber
Octane number (Motor) BulkMOctaneNu Real

mber
Refractive index BulkRefrIndexC2 Real

0
Luminosity number BulkLuminosityN Real

umber
Noack volatality BulkNoackVolatili Real

ty
Cetane index BulkCetaneIndex Real
Mercaptan content BulkMercaptan PPM Real

Naphthalene content BulkNaphthalene PCT Real
Aniline point BulkAnalinePoint TEMP Real
Bromine number BulkBromineNum Real

ber
Neutralization number BulkNeutralizatio Real

n
Cold Filter Plug Point BulkCFPP TEMP Real
Softening point BulkSofteningPoi Real

nt
Phenol content BulkPhenolConte PPM Real

nt
Octane number (Motor, BulkMOctaneNu Real

3ML) mberL
Octane number BulkROctaneNu Real

(Research, 3ML) mberL
Sulfur content BulkAliphaticSulf PCT Real

(Aliphatic) ur
Refractive index (70 C) BulkRefrIndexC7 Real

0
Aromatic Ring content BulkAromaticRin PCT Real

g
Iron content BulkIronContent PPM Real
Aromatics (Weight) BulkWtAromatics PCT Real

Paraffins (Weight) BulkWtParaffins PCT Real
Naphthenes (Weight) BulkWtNaphthen PCT Real

es
Boiling point (Mean BulkMeanAvgBP TEMP Real

average)
Boiling point (Cubic BulkCubicAvgBP TEMP Real

average)
Boiling point (Molal BulkMolalAvgBP TEMP Real

average)
Heat of combustion BulkNetHeatingV Real

alue
Mercaptan Sulfur BulkMercaptanS PCT Real

ulfur
Total Reactive Sulfur BulkTotReactive PCT Real

Sulf
Wong Closed Cup BulkFlashPointW TEMP Real

Flash Point CCup
Bulk Vapor properties, Class = SrBulkProp
Temperature VapTemp TEMP Real
Pressure VapPres PRES Real
Vapor mole fraction VapMoleFracOfT Real

ot
Mole flow rate VapMoleRate MRAT Real

Molar enthalpy VapEnthalpy ENTH Real
Molar entropy VapEntropy ENTR Real
Molecular weight VapMwOfPhase Real
Acentric factor VapAccenFactor Real
UOP K-Value VapUOPKvalue Real
Tc VapCritTemp TABS Real
Pc VapCritPres PABS Real
Vc VapCritVolume VAPV Real
z from density VapCritZFactor Real
Density, Actual VapDensityAct VDEN Real
Density, standard VapDensityStd VDEN Real
Normal boiling point, VapNBPMole TEMP Real

molal composition
Normal boiling point, VapNBPWt TEMP Real

weight composition
Normal boiling point, VapNBPVol TEMP Real

Volume composition
Heat capacity, constant VapCP CP Real

pressure
Heat capacity, constant VapCV CP Real

volume

Cp/Cv ratio VapCPCVRatio Real
Viscosity VapViscosity VISC Real
Thermal conductivity VapThermalCond COND Real
Surface tension VapSurfTension SURF Real
True Vapor Pressure VapTrueVapPres PRES Real
Reid Vapor Pressure VapReidVapPres Real

(API NAPHTHA) N

(API CRUDE) C

(ASTM D323-73) 3

(ASTM D323-94) 4

(ASTM D4953-91) 5

(ASTM D5191-91) 6

(IDL Method) 7

(ASTM D323-82) 8
Flash Point VapFlashPoint Real
Gross Heating Value VapGrossHeatVa HVAL Real


lue
Lower Heating Value VapLowerHeatVa HVAL Real

lue
Gas Wobbe Index VapWobbeIndex Real
Rate of flow of C2+ VapC2Plus Real
Rate of flow of C3+ VapC3Plus Real
pH Value VapPH Real
Ionic Strength VapIonicStrength Real
Bulk Liquid properties, Class = SrBulkProp
Temperature LiqTemp TEMP Real
Pressure LiqPres PRES Real
Liquid mole fraction LiqMoleFracOfTo Real

t
Mole flow rate LiqMoleRate MRAT Real
Molar enthalpy LiqEnthalpy ENTH Real
Entropy LiqEntropy ENTR Real
Molecular weight LiqMwOfPhase Real
UOP K-value LiqUOPKvalue Real
Acentric factor LiqAccenFactor Real
Tc LiqCritTemp TABS Real

Pc LiqCritPres PABS Real
Vc LiqCritVolume LIQV Real
Cp LiqCP CP Real
Cp/Cv Ratio LiqCPCVRatio Real
Z from density LiqCritZFactor Real
Liquid density, Actual LiqDensityAct LDEN Real
Liquid density,
Standard LiqDensityStd LDEN Real
Normal boiling point, LiqNBPMole TEMP Real

molal composition
Normal boiling point, LiqNBPWt TEMP Real

weight composition
Normal boiling point, LiqNBPVol TEMP Real

Volume composition
Thermal conductivity LiqThermalCond COND Real
Viscosity LiqViscosity VISC Real
Surface tension LiqSurfTension SURF Real
True Vapor Pressure LiqTrueVapPres PRES Real
Reid Vapor Pressure LiqReidVapPres Real

(API NAPHTHA) N
Reid Vapor Pressure LiqReidVapPres Real

(API CRUDE) C

Reid Vapor Pressure LiqReidVapPres3 Real

(ASTM D323-73)

(ASTM D323-94)

(ASTM D4953-91)

(ASTM D5191-91)

(IDL Method)

(ASTM D323-82)
Flash Point LiqFlashPoint TEMP Real
Gross Heating Value LiqGrossHeatVal HVAL Real

ue
Lower Heating Value LiqLowerHeatVal HVAL Real

ue
Gas Wobbe Index LiqWobbeIndex Real
Rate of flow of C2+ LiqC2Plus Real US Gallons/100

Std. FT3
Rate of flow of C3+ LiqC3Plus Real US Gallons/100

Std. FT3
pH Value LiqPH Real
Ionic Strength LiqIonicStrength Real

Dry Stream Total Properties, Class = SrDecProp
Temperature HCTotTemp TEMP Real
Pressure HCTotPres PRES Real
Mole fraction HCTotMoleFracO Real

fTot
Mole flow rate HCTotMoleRate MRAT Real
Molar enthalpy HCTotEnthalpy ENTH Real
Molar entropy HCTotEntropy ENTR Real
Molecular weight HCTotMwOfPhas Real

e
Acentric factor HCTotAccenFact Real

or
Tc HCTotCritTemp TABS Real
Pc HCTotCritPres PABS Real
Vc HCTotCritVolume LIQV Real
Z from density HCTotCritZFactor Real
Heat capacity, Constant HCTotCP CP Real

pressure
Heat capacity, Constant HCTotCV CP Real

volume
Cp/Cv ratio HCTotCPCVRati Real

o

UOP K value HCTotUOPKvalu Real

e
Density, Standard HCTotDensityStd DENS Real
Density, Actual HCTotDensityAct DENS Real
Thermal conductivity HCTotThermalCo COND Real

nd
Surface tension HCTotSurfTensio SURF Real

n
Viscosity HCTotViscosity VISC Real
Normal boiling point, HCTotNBPMole TEMP Real

molal composition
Normal boiling point, HCTotNBPWt TEMP Real

weight composition
Normal boiling point, HCTotNBPVol TEMP Real

Volume composition
True Vapor Pressure HCTotTrueVapPr PRES Real

es
Reid Vapor Pressure HCTotReidVapPr Real

(API NAPHTHA) esN

(API CRUDE) esC

(ASTM D323-73) es3


(ASTM D323-94) es4

(ASTM D4953-91) es5

(ASTM D5191-91) es6

(IDL Method) es7
Flash Point HCTotFlashPoint TEMP Real
Gross Heating Value HCTotGrossHeat HVAL Real

Value
Lower Heating Value HCTotLowerHeat HVAL Real

Value
Gas Wobbe Index HCTotWobbeInd Real

ex
Rate of flow of C2+ HCTotC2Plus Real US Gallons/100

Std. FT3
Rate of flow of C3+ HCTotC3Plus Real US Gallons/100

Std. FT3
pH Value HCTotPH Real
Ionic Strength HCTotIonicStren Real

gth
Dry Stream Vapor Properties, Class = SrDecProp
Temperature HCVapTemp TEMP Real

Pressure HCVapPres PRES Real
Vapor mole fraction HCVapMoleFracOf Real

Tot
Mole flow rate HCVapMoleRate MRAT Real
Molar enthalpy HCVapEnthalpy ENTH Real
Molar Entropy HCVapEntropy ENTR Real
Molecular weight HCVapMwOfPhase Real
Acentric factor HCVapAccenFacto Real

r
UOP K-Value HCVapUOPKvalue Real
Crictical temperature HCVapCritTemp TABS Real
Critical Pressure HCVapCritPres PRES Real
Critical Volume HCVapCritVolume VAPV Real
Critical Z HCVapCritZFactor Real
Density, Actual HCVapDensityAct VDEN Real
Density, standard HCVapDensityStd VDEN Real
Normal boiling point, HCVapNBPMole TEMP Real

molal composition
Normal boiling point, HCVapNBPWt TEMP Real

weight composition
Normal boiling point, HCVapNBPVol TEMP Real


Volume composition
Heat capacity, constant HCVapCP CP Real

pressure
Heat capacity, constant HCVapCV CP Real

volume
Cp/Cv ratio HCVapCPCVRatio Real
Viscosity HCVapViscosity VISC Real
Thermal conductivity HCVapThermalCo COND Real

nd
Surface Tension HCVapSurfTension SURF Real
True Vapor Pressure HCVapTrueVapPre PRES Real

s
Reid Vapor Pressure HCVapReidVapPre Real

(API NAPHTHA) sN

(API CRUDE) sC

(ASTM D323-73) s3

(ASTM D323-94) s4

(ASTM D4953-91) s5

(ASTM D5191-91) s6


(IDL Method) s7
Flash Point HCVapFlashPoint TEMP Real
Gross Heating Value HCVapGrossHeatV HVAL Real

alue
Lower Heating Value HCVapLowerHeat HVAL Real

Value
Gas Wobbe Index HCVapWobbeInde Real

x
Rate of flow of C2+ HCVapC2Plus Real US Gallons/100

Std. FT3
Rate of flow of C3+ HCVapC3Plus Real US Gallons/100

Std. FT3
pH Value HCVapPH Real
Ionic Strength HCVapIonicStrengt Real

h
Dry Stream Liquid Properties, Class = SrDecProp
Temperature HCLiqTemp TEMP Real
Pressure HCLiqPres PRES Real
Liquid mole fraction HCLiqMoleFracO Real

fTot
Mole flow rate HCLiqMoleRate MRAT Real
Molar enthalpy HCLiqEnthalpy ENTH Real

Molar Entropy HCLiqEntropy ENTR Real
Molecular weight HCLiqMwOfPhas Real

e
Acentric factor HCLiqAccenFact Real

or
UOP K-value HCLiqUOPKvalu Real

e
Tc HCLiqCritTemp TABS Real
Pc HCLiqCritPres PABS Real
Vc HCLiqCritVolume LIQV Real
Cp HCLiqCP CP Real
Cv HCLiqCV CP Real
Cp/Cv Ratio HCLiqCPCVRatio Real
z from density HCLiqCritZFactor Real
Liquid density, Actual HCLiqDensityAct LDEN Real
Liquid density, HCLiqDensityStd LDEN Real

Standard
Normal boiling point, HCLiqNBPMole TEMP Real

molal composition
Normal boiling point, HCLiqNBPWt TEMP Real

weight composition
Normal boiling point, HCLiqNBPVol TEMP Real


Volume composition
Thermal conductivity HCLiqThermalCo COND Real

nd
Viscosity HCLiqViscosity VISC Real
Surface tension HCLiqSurfTensio SURF Real

n
True Vapor Pressure HCLiqTrueVapPr PRES Real

es
Reid Vapor Pressure HCLiqReidVapPr Real

(API NAPHTHA) esN

(API CRUDE) esC

(ASTM D323-73) es3

(ASTM D323-94) es4

(ASTM D4953-91) es5

(ASTM D5191-91) es6

(IDL Method) es7
Flash Point HCLiqFlashPoint TEMP Real
Gross Heating Value HCLiqGrossHeat HVAL Real


Value
Lower Heating Value HCLiqLowerHeat HVAL Real

Value
Gas Wobbe Index HCLiqWobbeInde Real

x
Rate of flow of C2+ HCLiqC2Plus Real US Gallons/100

Std. FT3
Rate of flow of C3+ HCLiqC3Plus Real US Gallons/100

Std. FT3
pH Value HCLiqPH Real
Ionic Strength HCLiqIonicStreng Real

th
Decanted Phase Properties, Class = SrDecProp
Temperature DecWatTemp TEMP Real
Pressure DecWatPres PRES Real
Liquid mole fraction DecWatMoleFrac Real

OfTot
Mole flow rate DecWatMoleRate MRAT Real
Molar enthalpy DecWatEnthalpy ENTH Real
Molar Entropy DecWatEntropy ENTR Real
Molecular weight DecWatMwOfPh Real

ase

Acentric factor DecWatAccenFa Real

ctor
UOP K-Value DecWatUOPKval Real

ue
Tc DecWatCritTemp TABS Real
Pc DecWatCritPres PABS Real
Vc DecWatCritVolu LIQV Real

me
Cp DecWatCP CP Real
Cv DecWatCV CP Real
Cp/Cv Ratio DecWatCPCVRat Real

io
z from density DecWatCritZFact Real

or
Liquid density, Actual DecWatDensityA DENS Real

ct
Liquid density, DecWatDensitySt DENS Real

Standard d
Normal boiling point, DecWatNBPMole TEMP Real

molal composition
Normal boiling point, DecWatNBPWt TEMP Real

weight composition
Normal boiling point, DecWatNBPVol TEMP Real

Volume composition

Thermal conductivity DecWatThermal COND Real

Cond
Viscosity DecWatViscosity VISC Real
Surface tension DecWatSurfTensi SURF Real

on
True Vapor Pressure DecWatTrueVap PRES Real

Pres
Reid Vapor Pressure DecWatReidVap Real

(API NAPHTHA) PresN

(API CRUDE) PresC

(ASTM D323-73) Pres3




(IDL Method) Pres7
Flash Point DecWatFlashPoi TEMP Real

nt
Gross Heating Value DecWatGrossHe HVAL Real

atValue

Lower Heating Value DecWatLowerHe HVAL Real

atValue
Gas Wobbe Index DecWatWobbeIn Real

dex
Rate of flow of C2+ DecWatC2Plus Real US Gallons/100

Std. FT3
Rate of flow of C3+ DecWatC3Plus Real US Gallons/100

Std. FT3
pH Value DecWatPH Real
Ionic Strength DecWatIonicStre Real

ngth
Table B.4A Flash Unit Operation Input Data

Read an attribute: FlashObject.GetAttribute(AttributeName, Index)
Flash Input Data
Flash Documentation, Class = Flash
Descriptive name UnitName Char 40 char max

Flash Input Data
Flash Conditions, Class = Flash
Flash type Type Int 1 Isothermal

2 Adiabatic
3 Isentropic
8 Dew
9 Water Dew
10 HC Dew
11 Bubble
12 Spec
Temperature TempIn TEMP Real
Pressure PressIn PRES Real
Pressure Drop PressDropIn PDIF Real
Duty DutyIn DUTY Real
Initial pressure PressEst PRES Real

estimate
Initial temperature TempEst TEMP Real

estimate
Method MethodData 0 Meth ID Use element 0
Feeds, Class = Flash
Number of feeds CurrentFeeds Int
Feed StreamIDs eedData 0 to N- Strm ID N=CurrentFeeds

1

Flash Input Data
Products, Class = Flash
Number of products CurrentProducts Int
Product ProductData 0 to N- Strm ID N=CurrentProduc

StreamIDs 1 ts
Product stream ProductStoreData 0 to N- Int 1-Vapor

phases 1
2-Liquid
3-Solid
4-Mixed
Entrainment, Class = Flash
Count EntrainmentCount Int
IDs (Names) EntrNames 0 to N- Char N=EntrainmentC

1 ount
From phase EntrFromPhase 0 to N- Int 1-Vapor

1
2-Liquid
3-Solid
4-Decant Water
To phase EntrToPhase 0 to N- Int 1-Vapor

1
2-Liquid
3-Solid
4-Decant Water

Flash Input Data
Fraction or percent EntrType 0 to N- Int 1-Rate

or rate 1
2-Fraction
3-Percent
Basis EntrBasis 0 to N- Int 1-Molar

1
2-Weight
3-Liquid Volume
4-Gas Volume
Value EntrValues MRAT Real Units depends on

WTRA EntrBasis
LVRA
GVRA
Specification, Class = Flash
Specification Present CurrentSpecs Int 0-No

specification
1-Specification
present
Specification Name SpecData 0 Char Use element 0
Specification, Class = Spec
Specification Value SpecValue Real
Absolute tolerance AbsTol Real

value
Relative tolerance RelTol Real

value

Table B.4B Flash Unit Operation Calculated Properties
Write an attribute: FlashObject.PutAttribute(AttributeName, Index)
Flash Calculated Properties
Flash Conditions, Class = Flash
Temperature TempCalc TEMP Real
Pressure PressCalc PRES Real
Duty DutyCalc DUTY Real
Pressure PressGainCalc PDIF Real

drop
Specification, Class = Spec
Calculated spec SpecValueCalc Real

value
Entrainment, Class = Flash
Entrained EntrMolarRates 0 to N- Real N=EntrainmentC

molar rates 1 ount
Entrained weight EnteightRates 0 to N- Real

rates 1
Combined Streams (InTernal), Class = Flash
InTernal MergedFeed 0 Strm ID Use element 0

feed StreamID
InTernal MergedProduct 0 Strm ID Use element 0

product
StreamID

Combined Stream Properties (InTernal), Class = Stream
Enthalpy TotalMolarEnthalpy ENTH Real
Entropy TotalMolarEntropy ENTR Real
Cp VaporMolarCp CP Real
All standard stream properties like Mole Fractions, Weight Fractions of various phases are
accessible via the standard Stream Class. See Table 3-1.
Table B.5 Pump Unit Operation

Read an attribute: PumpObject.GetAttribute(AttributeName, Index)
Write an attribute: PumpObject.PutAttribute(AttributeName, Index)
Pump Input Data
Pump Documentation, Class = Pump
Pump Conditions, Class = Pump
Pressure gain PressGainIn PDIF Real
Pressure ratio PressRatioIn Real P(out)/P(in) in abs

units
Efficiency EffIn FRAC Real Pump efficiency in

%.

Pump Input Data
Feeds, Class = Pump
Feed StreamIDs FeedData 0 to N- Strm ID N=CurrentFeeds

1
Products, Class = Pump
Product StreamIDs ProductData 0 to N- Strm ID N=CurrentProducts

1
Product stream ProductStoreData 0 to N- Int 1-Vapor 2-Liquid

phases 1
3-Solid 4-Mixed
Pump Calculated Properties
Pump Conditions, Class = Pump
Pressure gain PressGainCalc PDIF Real
Pressure ratio PressRatioCalc Real

Pump Input Data
Work WorkCalc WORK Real
Head HeadCalc LENG Real
Efficiency EffCalc FRAC Real Percent

efficiency%.
Total inlet volumetric FlowInletCalc LVRA Real

flowrate
Total outlet volumetric FlowOutletCalc LVRA Real

flowrate
Combined Streams (InTernal), Class = Pump
InTernal feed MergedFeed 0 STreamI Use element 0

StreamID D
InTernal product MergedProduct 0 STreamI Use element 0

StreamID D

Pump Input Data
accessible via the standard Stream Class. See Table: 3-1
Table B.6 Valve Unit Operation

Read an attribute: ValveObject.GetAttribute(AttributeName, Index)
Write an attribute: ValveObject.PutAttribute(AttributeName, Index)
Valve Input Data
Valve Documentation, Class = Valve
Valve Conditions, Class = Valve
Pressure drop PressDropIn PDIF Real
Feeds, Class = Valve
Feed StreamIDs FeedData 0 to N-1 STreamID N=CurrentFeeds

Valve Input Data
Products, Class = Valve
Product StreamIDs ProductData 0 to N-1 STreamID N=CurrentProduct

s
Product stream ProductStoreData 0 to N-1 Int 1-Vapor 2-Liquid

phases
3-Solid 4-Mixed
Valve Calculated Properties
Valve Conditions, Class = Valve
Pressure drop PressDropCalc PDIF Real
Combined Streams (InTernal), Class = Valve
InTernal feed MergedFeed 0 Strm ID Use element 0

StreamID
InTernal product MergedProduct 0 Strm ID Use element 0

StreamID

Valve Input Data
Table B.7 Mixer Unit Operation

Read an attribute: MixerObject.GetAttribute(AttributeName, Index)
Write an attribute: MixerObject.PutAttribute(AttributeName, Index)
Mixer Input Data
Mixer Documentation, Class = Mixer
Mixer Conditions, Class = Mixer

Mixer Input Data
Feeds, Class = Mixer
Feed StreamIDs FeedData 0 to N-1 Strm ID N=CurrentFeeds
Products, Class = Mixer
Product StreamIDs ProductData 0 to N-1 Strm ID N=CurrentProducts

phases
3-Solid 4-Mixed
Mixer Calculated Properties
Mixer Conditions, Class = Mixer
Combined Streams (InTernal), Class = Mixer
InTernal feed MergedFeed 0 Strm ID Use element 0

StreamID
InTernal product MergedProduct 0 Strm ID Use element 0

StreamID

Mixer Input Data
accessible via the standard Stream Class. See Table Table: 3-1
Table B.8 Splitter Unit Operation

Read an attribute: SplitterObject.GetAttribute(AttributeName, Index)
Write an attribute: SplitterObject.PutAttribute(AttributeName, Index)
Property Attribute Name Units Description

Index Type
Splitter Input Data
Splitter Documentation, Class = Splitter
Splitter Conditions, Class = Splitter

Mixer Input Data
Insufficient feed rate Int 1-Noramlize

option 2-Fill
Method MethodData 0 Meth Use element 0

ID
Feeds, Class = Splitter
Feed StreamIDs FeedData 0 to N- Strm N=CurrentFeeds

1 ID
Products, Class = Splitter
Number of products CurrentProducts InT
Product StreamIDs ProductData 0 to N- Strea N=CurrentProduct

1 mID s
Product stream ProductStoreData 0 to N- InT 1-Vapor 2-Liquid

phases 1
3-Solid 4-Mixed
Specifications, Class = Splitter
Number of CurrentSpecs Int

Specifications
Specification object SpecData 0 to N- Spec N=CurrentSpecs

Ids 1 ID
Specifications, Class = Spec

Mixer Input Data
Specification value SpecValue Real Input value

associated with
SpecData
Splitter Calculated Properties
Specifications, Class = Spec
Specification value SpecValueCalc Real Calculated value

associated with
SpecData
Splitter Conditions, Class = Splitter
Stream split fractions SpecValCalc 0 to N- InT N=CurrentProduct

1 s
Combined Streams (InTernal), Class = Splitter
InTernal feed MergedFeed 0 Strm Use element 0

StreamID ID
InTernal product MergedProduct 0 Strm Use element 0

ID
StreamID

Mixer Input Data
Table B.9A Compressor Unit Operation Input Data

Read an attribute: CompressorObject.GetAttribute(AttributeName, Index)
Write an attribute: CompressorObject.PutAttribute(AttributeName, Index)
Compressor Input Data
Compressor Documentation, Class = Compressor
Compressor Conditions, Class = Compressor
Pressure PressOutIn PRES Real
Pressure ratio PressRatioIn Real

Inlet pressure PressInletIn PRES Real
Design pressure PressDesignIn PRES Real
Work WorkIn WORK Real
Work tolerance WorkTolIn Real
Adiabatic efficiency EffAdiaIn FRAC Real
Polytropic efficiency EffPolyIn FRAC
Outlet temperature TempIn TEMP
Estimated outlet TempEstIn TEMP Real

temperature
Calculation method CalcMethodFlag Int 1-GPSA,

2-ASME
(default)
Calculation pressure PressRatioSwitch Real Default = 1.15

switch
RPMs RPMIn Real
Reference RPMs RefRPMIn Real
Fan law H HeadExpoIn Real Exponent used

in the fan laws
when HEAD
preformance
curves are
supplied.
(Default = 2.0)

Fan law E EffExpoIn Real Exponent used

in the fan laws
when tabular
efficiency curve
data is
supplied.
(Default = 1.0)
Performance Curves, Class = Compressor
Curve type PerCurveType Int 1 Head 2 Work

3 Outlet pressure
4 Pressure ratio
Number of points on PerCurveLength Int

curve
Flowrate at each PerCurveFlowRat 0 to N-1 GVRA Real N=PerCurveLength

point es
Value of curve at PerCurveValues 0 to N-1 Real N=PerCurveLength

each point
Curve basis (for PerCurveBasis 1 Adiabatic

Head and Work
2 Polytropic 3
curve types)
Actual
0 for pressure curves
Efficiency Curves, Class = Compressor
Single/Multiple MultEffCurveFlag Single value <= 0

curves switch
Multi value >= 1

Efficiency Curve EffCurveType InT 1 Adiabatic

Type
2 Polytropic
Number of efficiency PressCount Single value = 1

curves at unique
Multi value >=2
pressures
Pressure type PressCurvePType 0 to M- Int M=PressCount

1
1 Outlet pressure
2 Inlet Pressure
All elements have the
same value.
Pressure values EffCurvePressVal 0 to M- PRES Real M=PressCount

ues 1
User pressure curve PressCurveOrder 0 to M- Int M=PressCount

order 1
In the expression
I = PressCurveOrder(j)
j is the curve number
sorted in order of
pressure, and I is the
curve number in order
input by the user.
Number of points on PresskLength 1 to M Int The k in

pressure curve PresskLength takes on
the value of 1 for a
single curve, and the
curve number for
multiple curves in user
input order

Flowrates EffCurvekFlowRat 0 to N-1 GVRA Real N=PresskLength

es
The k in
EffCurveFlowRates
takes on the value of 1
for single curve, and
the curve number (2
M) for multiple curves
in user input order.
Efficiency value EffCurvekValues 0 to N-1 Real N=PresskLength
The k in EffCurvekValues takes on the value of 1 for single curve,

and the curve number (2 M) for multiple curves in user input order.
Feeds, Class = Compressor
Feed StreamIDs FeedData 0 to N-1 Strm ID N=CurrentFeeds
Products, Class = Compressor
Product StreamIDs ProductData 0 to N-1 Strm ID N=CurrentProducts

phases
3-Solid 4-Mixed
Aftercooler, Class = Compressor
Aftercooler presence AfterCoolerFlag Int 0 - Aftercooler not

present
1 Aftercooler present

Aftercooler outlet AcTempIn TEMP Real

tempereature
Aftercooler pressure AcPressDropIn PDIF Real

drop
Table B.9B Compressor Unit Operation Calculated

Properties
Compressor Calculated Properties
Compressor Conditions, Class = Compressor
Pressure gain PressGainCalc PDIF Real
Actual volumetric ActVolVapFlow GVRA Real

flowrate at inlet
CV
- at inlet CVFrmAdiaFlshFd CP Real

Properties
- at outlet CVFrmAdiaFlshPrd CP Real
Compressibility
Factor
- at inlet CompressFactIn Real
- at outlet CompressFactOut Real
Operating speed RPMCalc Real
Reference operating RefRPMCalc Real

speed
Fan Law exponent - EffExpoCalc Real

eff
Fan Law exponent - HeadExpoCalc Real

head
Efficiency
- adiabatic EffAdiaCalc Real
- polytropic EffPolyCalc Real
Head
- adiabatic AdiabaticHead LENG Real
- polytropic PolytropicHead LENG Real
- actual HeadCalc LENG Real

Properties
Work
- theoretical WorkTheoCalc WORK Real
- polytropic WorkPolyCalc WORK Real
- actual WorkActualCalc WORK Real
Isentropic IsenCoeffCalc Real

coefficient, K
Polytropic coefficient, PolyCoeffCalc Real

N
ASME "F" factor FValForAsmeOpt Real
Aftercooler
- duty AcDutyCalc DUTY Real
- outlet temperature AcTempCalc TEMP Real
- pressure drop AcPressDropCalc PDIF Real
Combined Streams (InTernal), Class = Compressor
InTernal feed MergedFeed Strm ID

StreamID
Adiabatic flash result FeedAdiaStrmID Strm ID

at compressor outlet
pressure

Properties
Isentropic flash result FeedIsenStrmID Strm ID

at compressor outlet
pressure
Product from ProdAdiaStrmID Strm ID

compressor, before
aftercooler if present
Aftercooler product AcStrmID Strm ID
InTernal product MergedProduct Strm ID Will yield same

StreamID results as
ProdAdiaStrmI
D if no
aftercooler, or
AcStrmID if
aftercooler is
present

Table B.10A Expander Unit Operation Input Data
Read an attribute: ExpanderObject.GetAttribute(AttributeName, Index)
Write an attribute: ExpanderObject.PutAttribute(AttributeName, Index)
Expander Input Data
Expander Documentation, Class = Expander
Expander Conditions, Class = Expander
Pressure PressOutletIn PRES Real
Pressure ratio PressRatioIn Real
Inlet pressure PressInletIn PRES Real
Design pressure PressDesignIn PRES Real
Work WorkIn WORK Real
Work tolerance WorkTolIn Real
Adiabatic efficiency EffAdiaIn FRAC Real
Estimated outlet TempEstIn TEMP Real

temperature
Feeds, Class = Expander
Feed StreamIDs FeedData 0 to N- Strm ID N=CurrentFeeds

1

Table B.10A Expander Unit Operation Input Data
Products, Class = Expander
Product StreamIDs ProductData 0 to N- Strm ID N=CurrentProducts

1
Product stream ProductStoreData 0 to N- Int 1-Vapor 2-Liquid

phases 1
3-Solid 4-Mixed
Table B.10B Expander Unit Operation Calculated Properties

Expander Calculated Properties
Expander Conditions, Class = Expander
Temperature TempOutletCalc TEMP Real
Pressure PressOutCalc PRES Real
Actual volumetric VolFlowVapInlet GVRA Real

flowrate at inlet

Adiabatic efficiency EffAdiaCalc FRAC Real
Head HeadCalc LENG Real
Work - Theoretical WorkTheoCalc WORK Real
Work - Actual WorkActualCalc WORK Real
Compressibility CompressFactIn Real

Factor
- Inlet
Compressibility CompressFactOut Real

Factor
- Outlet
Isentropic/Polytropic IsenPolyExp Real

exponent
Combined Streams (InTernal), Class = Expander
InTernal MergedFeed 0 Strm Use element 0

feed StreamID ID
InTernal MergedProduct 0 Strm Use element 0

product StreamID ID
Temperatur Temperature TEMP Real

e

Table B.11A Pipe Unit Operation Input Data
Read an attribute: PipeObject.GetAttribute(AttributeName, Index)
Write an attribute: PipeObject.PutAttribute(value,AttributeName, Index)
Pipe Input Data
Pipe Documentation, Class = Pipe
Pipe Configuration, Class = Pipe
Inside Diameter LineInsideDiam FLEN Real
NPS
- Size NominalPipeSize Real
- Schedule PipeSchedule Real
Length LineLength LENG Int
Number of NumSegments Real

Segments
Elevation gain NetChangeInElevn LENG Real
Flow efficiency LineFlowEffic PCT Real
Moody friction factor LineFrictFactor Real
Absolute roughness AbsLineRoughness FLEN Real
Relative roughness RelLineRoughness Real
Allowable Diameters for Sizing, Class = Pipe
Number of Pipe NumSizes Int

sizes supplied

Pipe Input Data
Available diameters SizingPipeInTDiam 0 to N-1 FLEN Real N=NumSizes
Available NPS SizingNomPipeSize 0 to N-1 Real Value in inches
Available schedule SizingPipeSchedules 0 to N-1 Int

values
Process Conditions, Class = Pipe
Duty HeatDuty DUTY Real
U HeatTransfCoeff HTCO Real
Ambient AmbientTemperature TEMP Real

temperature
Isothermal operation IsothermalFlag Int Missing Exit

temperature
includes heat
transfer
1 - Outlet
temperature will
be the same as
the inlet
temperature and
PRO/II
automatically
calculates the
required duty.

Pipe Input Data
Pressure drop PressDropCorrelation Int 1 Beggs-Brill-

correlation Moody
2 Olimens
3 Dukler-Eaton-
Flanigan
4 Gray
5 Hagedorn-
Brown
6 Mukherjee-
Brill
7 Beggs-Brill-
Moody w/Palmer
mod
8 User supplied
correlation 1
9 User supplied
correlation 2
10 Proprietary
user
11 Proprietary
user
Pressure drop DeltaPEstimate PDIF Real

estimate
Pressure drop DPRelConvergToler Real

tolerance

Pipe Input Data
Disable acceleration AccelTermFlag Int Missing Not

pressure gradient disabled
calcs
1 Disabled
Calculate pressure BackwardDPCalcFlag Int Missing Calc in

from outlet to inlet forward direction
1 Calc from
outlet to inlet
Fittings factor FittingResisCoeff Real
Maximum allowable SizingDeltaP PDIF Real

pressure drop
Maximum allowable SizingMaxVelocity VELO Real

velocity
Minimum allowable SizingMinPress PRES Real

pressure

ID
Feeds, Class = Pipe
Feed StreamIDs FeedData 0 to N-1 Strm N=CurrentFeeds

ID
Products, Class = Pipe

Pipe Input Data
Product StreamIDs ProductData 0 to N-1 Strm N=CurrentProduct

ID s
Product stream ProductStoreData 0 to N-1 Int 1-Vapor

phases
2-Liquid
3-Solid
4-Mixed
Table B.11B Pipe Unit Operation Calculated Properties

Pipe Calculated Properties
Duty HeatDutyCalc DUTY Real
Pressure drop
- Line friction PresDropLineFric PDIF Real
- Elevation PresDropElev PDIF Real
- Acceleration PresDropAccel PDIF Real
- Fitting PresDropFitting PDIF Real

- Total PresDropTotalLine PDIF Real
Maximum line fluid LineMaxVelocCalc PDIF Real

velocity
Average fluid velocity UnitAvVelCalc VELO Real
Inside diameter LineInsideDiamCalc VELO Real
Line length LineLengthCalc FLEN Real
Fittings factor LineAverFricFact Real
Average Reynold's LineAverReyNum Real

Number
Absolute roughness AbsLineRoughnessCal Real

c
Relative roughness RelLineRoughnessCalc Real
Flow efficiency LineFlowEfficCalc Real
Temperature
- Inlet TempInlet TEMP Real
- Outlet TempOutlet TEMP Real
Pressure
- Inlet PressInlet PRES Real

- Outlet PressOutlet PRES Real
Mole fraction liquid
- Inlet MolFracLiqInlet Real
- Outlet MolFracLiqOutlet Real
Average Velocity
- Inlet VelocAvgInlet VELO Real
- Outlet UnitAvVelCalc VELO Real
Slip density
- Inlet SlipDensInlet LDEN Real
- Outlet SlipDensOutlet LDEN Real
Slip liquid holdup

fraction (Vol/Vol)
- Outlet SlipLiqHoldupOutlet Real
- Inlet SlipLiqHoldupInlet Real
Taitel-Dunkelr-
Barnea flow regime
- Inlet FlowRegimeInlet Int 1 Stratified


Smooth
- Outlet FlowRegimeOutlet Int
2 Stratified
Wavy
3 InTermittent
4 Disprs Bubble
5 Annular
6 Bubble
7 Churn
8 Single Phase
Combined Streams (Internal), Class = Pipe
InTernal feed MergedFeed 0 Strm Use element 0

StreamID ID
InTernal MergedProduct 0 Strm Use element 0

product StreamID ID
Combined Stream Properties (Internal), Class = Stream

Table B.12 Blend Unit Operation

Blend UnitInput Data
Documentation, Class=UAS
Conditions, Class=UAS
Pressure PressIn 1 Real
Temperature RparmDataIn 0 Real

ID
Feeds, Class=UAS
Feed StreamIDs FeedData 0 to N-1 Strm N=CurrentFeeds

Table B.12 Blend Unit Operation

ID
Products, Class=UAS
Product StreamIDs ProductData 0 Strm

ID
Product stream phase ProductStoreData 0 Int 1-Vapor 2-Liquid

3-Solid 4-Mixed
Blend Unit Calculated Properties
Combined Stream Properties (Internal), Class=Stream
All standard stream properties such as mole fractions and weight fractions of various
phases are accessible via the Standard Stream Class. See Table 3-1.

Table B.13A Column Unit Operation Input Data
Read an attribute: Value=ColumnObject.GetAttribute(AttributeName, Index)
Write an attribute: ColumnObject.PutAttribute(Value,AttributeName, Index)
Column Input Data
Documentation, Class = ColumnIn
Parameter, Class = ColumnIn
Side or main ColumnType Int 0 Main Column

3 Side Column
Number of trays NumberOfTrays
Solution method CalculationMethod Int 1 Sure Method

2 not used in PRO/II
3 - IO, Enhanced IO
4 Chemdist ,
Liquid/liquid extraction,
Reactive distillation
Maximum number ColMaxIter Int

of iterations allowed
Error increase MaxErrorCheckRa Real

factor tio
Damping DampingFactor Real
SURE method stop Int

level
Component CompositionAvera Int

averaging level ging

SURE key KeyComponent Comp

component ID
Freewater flag FreeWaterFlag Int 0 water can be

decanted only on the
top tray or condenser
1 free water can exist
anywhere in the column
Cutoff factor CutoffErrorSum
Feeds, Class = ColumnIn
Number of CurrentFeeds Int Number of feeds,

feeds including returns from
side columns.
FeedData 0 to NF - Strm ID NF=CurrentFeeds

Feed 1
StreamIDs
Feed tray numbers FeedTrays 0 to NF - Int

1
Feed separate flag FeedSeparateFlag Int 0 Feeds are not

separated
1 Feeds are
separated, vapor into
the tray above

Products, Class = ColumnIn
Number of CurrentProducts Int

products
Product StreamIDs ProductData 0 to NP Strm NP

-1 ID =CurrentProducts
Product tray numbers ProdTrays 0 to NP Int

-1
Product type ProdType 0 to NP Int 1 - vapor draw

-1
2 - liq draw
3 - overhead
vapor (partial
condenser type)
4 - overhead
liquid (total
condenser type)
5 - bottoms
6 - water decant
11 - L1 total draw
12 - L2 total draw
13 - L1 partial
draw
14 - L2 partial
draw
15 - L1 overhead
prod
16 - L2 overhead
prod

Product rate ProdRateEstimates 0 to NP Real

estimates -1
Basis for product ProdRateBasis 0 to NP Int 1 Mole

estimates -1
2 Weight
3 Standard liquid
volume
4 Standard gas
volume
Number of pseudo- NumberOfTflowStrea Int Does not include

products ms pseudostreams
related to
thermosiphon
reboilers
Tray number for TFlowTrayNum 0 to Int NPs =

pseudo-products NPs - 1 NumberOfTflowStr
eams
Pseudo-products ids TFlowStreamIDs 0 to Stream

NPs - 1 ID
Net or total flow flag TFlowNetOrTotalFlag 0 to InT 0 Net flow

for pseudo-products NPs - 1
1 Total flow
Phase flag for TFlowPhaseFlag 0 to InT 1 Vapor

pseudo-products NPs - 1
2 - Liquid

Condenser, Class = ColumnIn
Condenser flag CondenserType Int 0 - No condenser

1 - Partial
2 - Mixed phase
3 - Bubble point
4 - Fixed
temperature
5 - Degrees below
bubble point
Condenser pressure CondenserPressure PRES Real
Condenser CondenserTemperatur TEMP Real

temperature e
Condenser CondenserTempDrop TDIF Real

temperature below
bubble point
Estimated condenser CondenserTempEst TEMP Real

temperature
Reboiler, Class = ColumnIn
Reboiler present flag ReboilerType Int 0 - no reboilers

2 - reboiler present
Thermosiphon reboiler ThermosiphonRebFlag Int 0 (or null) No

flag thermosiphon
reboilers present
(could be kettle
reboilers, or could


be no reboilers)
1 Thermosiphon
reboilers without
baffles
2 Thermosiphon
reboilers with
baffles
StreamID of ThermoSRebFeed Stream

thermosiphon reboiler ID
feed
Thermosiphon reboiler ThermoSRebRateSpec Real

rate specification
Thermosiphon reboiler ThermoSRebRateBasi Int 1 Molar

rate specification s
2 Weight
basis
3 Liquid volume
Thermosiphon reboiler ThermoSRebRateEst Real

rate estimate on a
molar basis
StreamID of ThermoSRebVapProd Stream

vapor product
Thermosiphon reboiler ThermoSRebVapFraSp Real

vapor fraction ec
specification
Thermosiphon reboiler ThermoSRebVFracBas Int 1 Molar

vapor fraction is
2 Weight
specification basis
3 Liquid volume

Thermosiphon reboiler ThermoSRebVapFraEs Real

vapor fraction t
estimate on a molar
basis
StreamID of ThermoSRebLiqProd Stream

liquid product
Thermosiphon reboiler ThermoSRebLiqFraS Real

liquid fraction pec
specification
Thermosiphon reboiler ThermoSRebTempSpe Real

temperature c
specification
Thermosiphon reboiler ThermoSRebDTSpec TDIF Real

temperature rise
specification
Heating and Cooling Duties, Class = ColumnIn
Number of heating or NumberOfHeaters Int

cooling duties not
including heat leak
Input duty value HeaterDuties 0 to NH - DUTY Real NH =

(estimate or spec) 1 NumberOfHeaters
Heater name HeaterNames 0 to NH - Char

1
Heater number HeaterNumber 0 to NH - Int HeaterNumber = Index

1 +1

Pumparound number HeaterPANumber 0 to NH - Int 0 Not attached to a

corresponding to 1 pumparound
heater
Heater attached to a HeaterRegOrPAFla 0 to NH - Int 1 Not attached to a

pumparound flag g 1 pumparound
2 Attached to a
pumparound
Heater tray number HeaterTrayNumber 0 to NH - Int

1
Heater fixed or vary HeaterVarFixDtyFl 0 to NH - Int 0 Not varied

flag ag 1
1 Varied
Heat Leak, Class = ColumnIn
Use heat gain/loss HeatLeakGainFlag Int 0 No heat leak or

flag. gain
1 Heat leak or
gain specified
User specified heat HeatLeak 0 to NT- Real NT =

gain/loss per tray 1 NumberOfTrays
Contrary to the
variable name, a
positive value is
heat gain to
column. Only the
trays with user
specified values
are populated with
real values. The
remaining
interpolated trays


are populated with
missing.
Heat gain/loss in HeatLeakGainCondens Real

condenser er
Heat gain/loss in HeatLeakGainColumn Real

column excluding
condenser and
reboiler
Heat gain/loss per tray HeatLeakGainTray Real
Heat gain/loss in HeatLeakGainReboiler Real

reboiler
Pumparounds, Class = ColumnIn
NumberOfPumparounds Int
PumpAroundHeaterNum 0 to PA Int PA =
-1 NumberOfPump
arounds
Pumparound from PumpAroundTrayFrom 0 to PA Int

tray number -1
Pumparound too tray PumpAroundTrayTo 0 to PA Int

number -1
Pumparound draw PumpAroundPhase1 or 0 to PA Int Both variables have

phase PumpAroundPhase2 -1 the same meaning
1 Vapor
2 - Liquid
PumpAroundNames 0 to PA Char


-1
Return temperature PumpAroundTdTFlag 0 to PA Int 1 Return

type flag -1 temperature
specified
2 Temperature
drop
3 Return
temperature not
specified
The value of the PumpAroundTempOrDT 0 to PA Real

specified return -1
temperature or
temperature drop
Pumparound liquid PumpAroundLiqFrac 0 to PA Real

fraction -1
Return stream liquid PumpAroundLFracBasis 0 to PA Int 0 Basis not given

fraction specification -1
1 Mole
basis
2 Weight
3 Liquid volume
Pumparound rate PumpAroundRate 0 to PA Real

-1
Pumparound rate PumpAroundRateBasis 0 to PA Int 0 Basis not given

basis -1
1 Mole
2 Weight
3 Liquid volume
4 Gas volume

Pumparound type PumpAroundType 0 to PA Int 1 Rate, temp/lfrac

flag -1 given
2 Duty, temp/lfrac
given
3 Rate, duty
given
13 Rate given, no
duty
Pumparound return PumpAroundPressure Real

pressure
Total pumparound PumpAroundTotNormFlg 0 to 0 Normal

type flag PA -1 pumparound
1 Total
pumparound
Pressure Profile, Class = ColumnIn
Tray pressure TrayPressures 0 to PRES Real NT = NumberOfTrays

NT -1
Top tray pressure TopTrayPressure PRES Real
Column pressure PressureDropPerColu PDIF Real

drop
Tray pressure crop PressureDropPerTray PDIF Real
Condenser pressure CondenserPressure PRES Real
Initial Estimates, Class = ColumnIn
Estimate Model type InitialEstimModel Int 0 - None/Simple


1 - Conventional
2 - Refining
3 - Chemical
4 - Electrolyte
Condenser CondenserTempEst TEMP Real

temperature
Top tray temperature TopTrayTempEst TEMP Real
Bottom tray BottomTrayTempEst TEMP Real

temperature
Reboiler temperature ReboilerTrayTempEst TEMP Real
Reflux ratio RefluxRatioEst Real
Reflux rate RefluxRateEst Real
Tray temperature TrayTempEstimates 0 to NT TEMP Real NT =

-1 NumberOfTrays
Tray net vapor rate TrayNetVapRateEstim 0 to NT Real

-1
Basis for tray vapor VapEstRateBasis Int 1 Mole

rate
2 - Weight
3 - Liquid volume
4 - Gas vol.
Tray net liquid rate TrayNetLiqRateEstim 0 to NT Real

-1
Basis for tray liquid LiqEstRateBasis Int 1 Mole


rate 2 - Weight
3 - Liquid volume
4 - Gas vol.
Number of trays for NumCestVTrays Int

which vapor
composition estimates
are supplied
Tray numbers for TrayNumsCestV 0 to V - Int V=NumCestVTrays

vapor composition 1
estimates.
Component Names ComponentIds 0 to Comp NOC = Number of

NOC - 1 Ids components in
simulation
Mole fraction of CompDataCestV 0 to FRAC Real See example below

component on tray V*NOC-
vapor 1
Index for component NOC * j + k where

cid on tray i TrayNumsCestV(j) = i
and
ComponentIds(k)=cid
If:
Number of components = 10
th
NC4 is the 7 component on the component list
Mole fraction of nC4 on tray 17 = 0.3
th
Tray 17 is the 4 tray for which vapor compositions are given
Then:
NOC =10


TrayNumsCestV(3) = 17
ComponentIDs(6) = nC4
Index = 10 * 3 + 6 = 36
CompDataCestV(36) = 0.3
Number of trays for NumCestLTrays Int

which liquid
composition
estimates are
supplied
Tray numbers for TrayNumsCestL 0 to L-1 Int L=NumCestLTrays

liquid composition
estimates.
Mole fraction of CompDataCestL 0 to FRAC Real See example below

component on tray L*NOC-1
liquid
Index for component NOC * j + k where Int See example for vapor
cid on tray i TrayNumsCestL(j) compositions above
= i and
ComponentIds(k)=
cid
Number of trays for NumCestL1Trays Int

which liquid(1)
composition
estimates are
supplied
Tray numbers for TrayNumsCestL1 0 to L-1 Int L=NumCestL1Trays

liquid(1) composition
estimates.

Mole fraction of CompDataCestL1 0 to FRAC Real See example below

component on tray L*NOC-
liquid(1) phase 1
cid on tray i TrayNumsCest1L(j) compositions above
= i and
ComponentIds(k)=
cid
Number of trays for NumCestL2Trays Int

which liquid(2)
composition
estimates are
supplied
Tray numbers for TrayNumsCestL2 0 to L-1 Int L=NumCestL2Trays

liquid(2) composition
estimates.
Mole fraction of CompDataCestL2 0 to FRAC Real See example below

component on tray L*NOC-
liquid(2) phase 1
cid on tray i TrayNumsCestL2(j) compositions above
= i and
ComponentIds(k)=
cid
Estimate of ratio of RatioFreeWater 0 to N-1 Real N=NumberOfTrays

free water to
hydrocarbon on a
tray

Specifications, Class = ColumnIn
Number of CurrentSpecs Int

specifications
Specification names SpecData 0 to NS - Spec ID NS = CurrentSpecs

1
Specification Values, Class = Spec

Note: See Spec class documentation for complete list of available attributes.
Value SpecValue
Absolute tolerance AbsTol
Relative tolerance RelTol
Tray Efficiencies, Class = ColumnIn
Efficiency type TrayEfficFlag Int 1 No tray

efficiency
calculations
2 Murphree
3 Equilibrium
4 - Vaporization
Efficiency Factor TrayEfficiencyFactor Real

Tray efficiency data EfficiencyFlag Int 1 - Tray efficiency

provided flag provided
2 - Component
efficiency provided
3 - Both tray and
component
efficiency provided
N=
Tray efficiency TrayEfficiency 0 to N-1 Real
NumberOfTrays
Number of NumOfCompEfComps Int

components for which Set1
component tray
efficiencies are given
Number of trays for NumOfCompEffTrays1 Int

which component tray
efficiencies are given
Tray numbers for TrayNumsCEffic1 0 to Int NT=

which component tray NT - 1 NumOfCompEffTra
efficiencies are given ys1
Component IDs for CompIdsCEffic1 0 to Comp NC =

which component tray NC - 1 ID NumOfCompEfCo
efficiencies are given mpsSet1
Individual component CompEff1 0 to Real For component Ci

tray efficiencies NT*NC and tray Tj, the
-1 order of component
tray efficiencies is
C0T0, C1T0, C2T0
CNC-1TNT-1

Homotopy, Class = ColumnIn
Number of HCNumSpecs Int

specifications with
homotopy applied
Number of iterations HSpecNumOfSteps 0 to Int NH=HCNumSpecs

or steps the NH - 1
homotopy algorithm
will take until it
reaches solution
Spec ID HSpecID 0 to Char

NH -1
Specification number HSpecNum 1 to NS Int NS = CurrentSpecs
Initial specification HSpecInitValue 0 to Real

value NH -1
Tray Hydraulics, Class = TraySizRat
Number of tray rating NumOfTrayRatingSec Int

sections ts
Tray rating: tray RatingTraySpacing 0 to NR - Real NR = NumOfTray

spacing 1 RatingSects
Tray rating: cap RatingCapSpacing 0 to NR - Real

spacing 1
Tray rating: system RatingSysFactor 0 to NR - Real

factor 1
Tray rating: tray RatingTrayDiamete 0 to NR - Real

diameter r 1

Tray rating: valve, RatingVSorCdiam 0 to NR - Real

sieve, or cap 1
diameter
Tray rating: tray deck RatingTrayDeckTh 0 to NR - Real

thickness k 1
Tray rating: valve RatingValveThk 0 to NR - Real

thickness 1
Tray rating: sieve RatingPctSvHoleAr 0 to NR - Real

hole area, percent ea 1
Tray rating: weir RatingWeirHeight 0 to NR - Real

height 1
Tray rating: RatingDwncClear 0 to NR - Real

downcomer 1
clearance
Tray rating: RatingDwncWidth1 0 to NR - Real

downcomer width 1 1

downcomer width 2 1

downcomer width 3 1

downcomer width 4 1

downcomer width 5 1


downcomer width 6 1

downcomer width 7 1

downcomer width 8 1
Tray rating: pressure RatingPressDropS 0 to NR - Real

drop scaling value cal 1
for calculation time
Tray rating: user RatingSectionNum 0 to NR - Real

supplied section ber 1
number
Tray rating: first tray RatingFirstTray 0 to NR - Int

in section 1
Tray rating: last tray RatingLastTray 0 to NR - Int

in section 1
Tray rating: tray RatingTrayType 0 to NR - Int 1 = V1

type, 1
2 = V4
3 = sieve
4 = cap
Tray rating: number RatingNumberOfPa 0 to NR - Int

of passes sses 1
Tray rating: number RatingNumberOfVa 0 to NR - Int

of valves or caps lves 1
Tray rating: valve RatingValveMateria 0 to NR - Int 1 = Stainless Steel

material : l 1
2 = Carbon Steel


3 = Nickel
4 = Monel
5 =Titanium
6 = Hastalloy
7 =Aluminum
8 =Copper
9 =Lead
Number of tray NumOfTraySizingS Int

sizing sections ects
Tray sizing: user SizingSectionNumb 0 to NS - Int NS = NumOfTraySizing

supplied section er 1 Sects
number
Tray sizing: first tray SizingFirstTray 0 to NS - Int

in section 1
Tray sizing: last tray SizingLastTray 0 to NS - Int

in section 1
Tray sizing: tray SizingTrayType 0 to NS - Int 1 = valve

type, 1
2 = sieve
3 = cap
Tray sizing: number SizingNumberOfPa 0 to NS - Int

of passes sses 1
Tray sizing: tray SizingTraySpacing 0 to NS - Real

spacing 1

Tray sizing: system SizingSystemFacto 0 to NS - Real

factor r 1
Tray sizing: flood SizingFloodFactor 0 to NS - Real

factor 1
Tray sizing: SizingMinTrayDiam 0 to NS - Real

minimum tray 1
diameter
Tray sizing: pressure SizingPressDropSc 0 to NS - Real

drop scaling value al 1
for calculation time
Packing Hydraulics, Class = ColumnIn
Total number of PckngTotNumSect Int

packed sections.
Column section PckngSectionNum 0 to NP - Int NP =

number 1 PckngTotNumSect
Correlates the packed
section number to the
column section
number. Setting
PckngSectionNum(2)=4
implies that the 3rd
packed section is the
th
5 column section
overall.
Beginning tray PckngBeginTray 0 to NP - Int

number of packed 1
section
End tray number of PckngEndTray 0 to NP - Int


packed section 1
Max pressure drop PckngDPSpecOptn 0 to NP - Int 0 None selected

flag 1
1 Max pressure drop
per section given
2 Max given linear
pressure drop
Pressure drop PckngDPMeth 0 to NP - Int 1 Tsai

correlation flag. 1
2 Norton
3 Sulzer

Packing type flag PckngPackngType 0 to NP Int 1 - IMTP

(Norton packing Optn 1
2 - Hy-Pak (Metal)
selected)
3 - Super InTalox #1
Saddles (Ceramic)
4 - Super InTalox #2
Saddles (Ceramic)
5 - Pall Rings (Plastic)
6 - Pall Rings (Metal)
7 - InTalox Saddles
(Ceramic)
8 - Raschig Rings
(Ceramic)
9 - Raschig Rings
(1/32" Metal)
10 - Raschig Rings
(1/16" Metal)
11 - Berl Saddles
(Ceramic)
Packing type flag PckngPackngType 0 to NP Int 1 - MELLAPAK 125.X

(Sultzer packing Optn 1
2 - MELLAPAK 125.Y
selected)
3 - MELLAPAK 250.X
4 - MELLAPAK 250.Y
5 - MELLAPAK 350.X
6 - MELLAPAK 350.Y
7 - MELLAPAK 500.X
8 - MELLAPAK 500.Y
9 - BX


10 - entry missing
11 - CY
12 - KERAPAK
13 - MELLAPAK170.Y
14 - MELLAPAK170.X
15 - M2Y
16 - M2X
17 - M750Y
18 - MG90
19 - MD250Y
20 - MD350Y
21 - MD450Y
22 - MC350Y
23 - BXPFP
24 - M64Y
25 - M64X
26 - MG64
27 - OFC36
HETP Method PckngHETPMeth 0 to NP Int 1 Frank

1
2 Norton
CS Calc Design flag PckngCalcFlgCSDs 0 to NP Int 0 - None

gn 1
1 CS Design or
Design
CS Flood flag PckngCalcFlgCSFld 0 to NP Int 0 None

1


1 - CSMax or Flood
CS Flood Approach PckngCalcFlgCSFl 0 to NP Int 0 None

flag (Norton) Ap 1
1 - CS Approach or
Flood Approach.
CS Flood Approach PckngCalcFlgCSFl 0 to NP Int 0 None

flag (Sulzer) Ap 1
1 - Capacity
Packing Factor flag PckngCalcFlgFacto 0 to NP Int 0 No packing factor

r 1 provided
1 Packing factor
provided
Max delta pressure PckngCalcStatDP 0 to NP Int 0 None

type 1
1 Max DP per section
specified
2 Max linear DP
specified
3 Column diameter
specified.
HETP calculation PckngCalcStatHET 0 to NP Int 0 None selected

flag P 1
1 HETP given
2 Overall height of
packed section given
3 Calculates HETP
Efficent packing or PckngCalcStatMeth 0 to NP Int 0 None

flood method flag 1
1 CS Method
2 Flood Method

Packing size PckngPackingCode 0 to NP FLEN Real

1
Packing factor PckngPackingFact LENG Real Returned in meters
Height of packed PckngColumnHeigh FLEN Real

section t
HETP of packed PckngSectHETP FLEN Real HETP

section
Diameter of packed PckngSectDia Real PACKED SECTION

section DIA
Fraction of efficient PckngCapFactRatio Real

capacity or fraction
of flood capacity.
Flood value or PckngMaxCapFact Real

maximum efficient or
capacity value.
Design capacity PckngCapFact Real

value or efficient
design capacity
value
Maximum allowable PckngMaxSectDPT PDIF Real

pressure drop otl
across the section
Maximum allowable PckngMaxSectDPft PDIF Real

linear pressure drop
in the section

Tolerance, Class = ColumnIn
K-value tolerance KvalueTolerance Real For IO
Component MassbalTolerance Real For Sure and

tolerance Chemdist
Equilibrium BubblePntTolerance Real

tolerance
Enthalpy tolerance EnthalpyBalTolerance Real
Table B.13B Column Unit Operation Calculated Properties

Column Calculated Properties
Documentation, Class = Column
Parameter, Class = Column
Side or main ColumnType Int 0 Main Column

3 Side Column
Number of trays NumberOfTrays Int

Feeds, Class = Column
Number of feeds CurrentFeeds Int Number of feeds,

including returns
from side columns.
Feed StreamIDs FeedData 0 to NF - STre NF = CurrentFeeds

1 amID
Feed tray numbers FeedTrays 0 to NF - InT

1
Products, Class = Column
Product StreamIDs ProductData 0 to NP - Strm NP =

1 ID CurrentProducts
Number of pseudo- NumberOfTflowStrea Does not include

products ms pseudostreams
related to
thermosiphon
reboilers
Pseudo-products ids TFlowStreamIDs 0 to NPs- Strm NPs =

1 ID NumberOfTflowStre
ams
Reboiler, Class = Column
Reboiler present flag ReboilerType Int 0 - no reboilers

2 - reboiler
present

Thermosiphon ThermosiphonRebFla Int 0 (or null) No

reboiler flag g thermosiphon
reboilers present
(could be kettle
reboilers, or could
be no reboilers)
1 Thermosiphon
reboilers without
baffles
2 Thermosiphon
reboilers with
baffles
StreamID of ThermoSRebFeed Strm

thermosiphon ID
reboiler feed
Thermosiphon ThermoSRebRateSpe Real

reboiler rate c
specification
Thermosiphon ThermoSRebRateBasi Int 1 Molar

reboiler rate s
2 Weight
specification basis
3 Liquid volume
Thermosiphon ThermoSRebRateEst Real

reboiler rate estimate
on a molar basis

StreamID of ThermoSRebVapProd Strm

thermosiphon ID
reboiler vapor
product
Thermosiphon ThermoSRebVapFraS Real

reboiler vapor pec
fraction specification
Thermosiphon ThermoSRebVFracBa Int 1 Molar

reboiler vapor sis
2 Weight
fraction specification
basis 3 Liquid volume
Thermosiphon ThermoSRebVapFraE Real

reboiler vapor st
fraction estimate on
a molar basis
StreamID of ThermoSRebLiqProd Strm

thermosiphon ID
reboiler liquid
product
Thermosiphon ThermoSRebLiqFra Real

reboiler liquid fraction Spec
specification
Thermosiphon ThermoSRebTempSp Real

reboiler temperature ec
specification

Thermosiphon ThermoSRebDTSpec TDIF Real

reboiler temperature
rise specification
Column Profiles, Class = Column
Number of trays NumberOfTrays
Tray temperautures TrayTemperatures 0 to NT - TEMP Real NT =

1 NumberOfTrays
Tray pressures TrayPressures 0 to NT - PRES Real

1
Liquid molar rates TrayNetLiqRates 0 to NT - MRAT Real

from tray to tray 1
below
Total liquid molar TrayTotalLiqRates 0 to NT - MRAT Real

flow from tray 1
Vapor molar rates TrayNetVapRates 0 to NT - MRAT Real

from tray 1
Total vapor molar TrayTotalVaporRate 0 to NT - MRAT Real

flow from tray s 1
Compressibility TrayVaporEOSZ 0 to NT -
calculated from K- 1
value EOS
Number of NumComps
components

Component mole TrayLiquidMoleFrac 0 to FRAC Real NC = NumComps

fraction of tray liquid s NT*NC-1
NT = Number of
trays
For component i
on tray j, index =
i + NC * ( j -1) - 1
Component mole TrayVaporMoleFrac 0 to FRAC Real

fraction of tray vapor s NT*NC-1
VLE K-value TrayVleKValue 0 to Real

NT*NC-1
Flood approach FloodApproach 0 to NT -1
Specifications, Class = Column
Number of CurrentSpecs InT

specifications
Specification names SpecData 0 to NS - Spec ID NS =

1 CurrentSpecs
SpecificationValues, Class = Spec

Note: See Spec class documentation for complete list of available attributes.
Specified value SpecValue
Calculated value SpecValueCalc
Absolute tolerance AbsTol
Relative tolerance RelTol

Heaters, Coolers, Heat Leak, Class = Column
Number of NumberOfHeaters InT

heater/coolers
Heater/cooler duty HeaterDuties 0 to NH - DUTY Real NH =

1 NumberOfheaters
Heater/cooler names HeaterNames 0 to NH - HID

1
Regular or HeaterRegOrPAFlag 0 to NH - InT 1 Regular

Pumparound heater 1 Heater
flag
2 Pumparound
heater
Heat leak per tray HeatLeak 0 to NT - Real

1
Total heat leakage in HeatLeakGainColTot Real

column
Pumparounds, Class = Column
Number of NumberOf
pumparounds Pumparounds
Pumparound name PumparoundNames 0 to Where NP =

NP - 1 NumberOfPumpar
ounds
Pumparound draw PumpAroundPhase1 0 to

phase NP - 1

Pumparound tray PumpAroundTrayFro 0 to

draw location m NP - 1
Pumparound return PumpAroundTrayTo 0 to

tray NP - 1
Heater number PumpAroundHeaterN 0 to

corresponding to um NP - 1
pumparound.
Mole rate of PumpAroundMolRate 0 to

pumparound NP - 1
circulation
Return stream liquid PumpAroundLFracBa 0 to InT 0 Not given

fraction basis sis NP - 1
1 Mole
2 Weight
3 Liquid volume
Return stream liquid PumpAroundLiqFrac 0 to Real Using

fraction NP - 1 PumpAroundLFra
c Basis
Pumparound return PumpAroundPressure 0 to PDIF Real

pressure NP - 1
PumpAroundEnthalpy 0 to
NP - 1

Flag for exit Temp or PumpAroundTdTFlag 0 to InT 0 Neither spec

DT NP - 1 given
1 Return spec
given
2 Temperature
drop spec given
Exit temperature or PumpAroundTempOr 0 to Real Outlet temperature

delta T. DT NP - 1 if
PumpAroundTdT
Flag = 0 or 1.
Temperature drop
if PumparoundTdT
Flag = 2.
Tray Hydraulics, Class = Column
Total number of PckngTotNumSect Int

packed sections
Packing calculation PckngCalcStatMeth Int 0 None

method
1 CS Method
2 Flooding
method
2 3
Packing factor units PckngCalcFactorUOM Int 1 Ft /Ft
of measure 2 3
2 M /M
Column diameter at TrayDiameters 0 to FLEN Real

theoretical tray NT -1

Theoretical tray PckngTrayDp 0 to PDIF Real

pressure drop NT -1
Packing HETP PckngTrayHETP 0 to FLEN Real

NT -1
Flood factor PckngTrayFloodFact 0 to Real

NT -1
Flooding approach FloodApproach 0 to Real

NT -1
CS Approach CSApproach 0 to Real

NT -1
Capacity factor PckngTrayCapFact 0 to Real

NT -1
CS Max PckngTrayMaxCapFa 0 to Real

c NT -1
Sultzer packing F PckngSulzerFFactor 0 to Real

factor NT -1
Sultzer packing liquid PckngSulzerLiqLoad 0 to Real

load NT -1
Downcomer backup TrayDCBackup 0 to FLEN Real

NT -1
Flooding factor on TrayFloodFactors 0 to Real As a percent

tray NT -1

Tray Properties, Class = TrayProp
Total Tray TotCompres 0 to Real

Compressibility NT-1
Dry Vapor Standard DryVapStdSG 0 to Real

Specific Gravity NT-1
Dry Vapor Standard DryVapStdAPI 0 to Real

API Gravity NT-1
Dry Vapor Molecular DryVapMW 0 to Real

Weight NT-1
Dry Vapor UOPK DryVapUOPK 0 to Real

NT-1
Dry Vapor Critical DryVapCritTemp 0 to TEMP Real

Temperature NT-1
Dry Vapor Critical DryVapCritPres 0 to PRES Real

Pressure NT-1
Dry Vapor Critical DryVapCritCompres 0 to Real

Dry Vapor Molar DryVapAvgBoilPoint 0 to TEMP Real

Average Boiling NT-1
Point
Dry Vapor Acentric DryVapAcenFact 0 to Real

Factor NT-1

Dry Vapor C2+ Flow DryVapC2Plus 0 to FRAC Real

NT-1
Dry Vapor C3+ Flow DryVapC3Plus 0 to FRAC Real

NT-1
Dry Vapor Molar DryVapMolarGrossHe 0 to ENTH Real

Gross Heating Value at NT-1
Dry Vapor Standard DryVapStdGrossHeat 0 to ENTH Real

Gas Gross Heating NT-1
Value
Dry Vapor Molar DryVapMolarLowerHe 0 to ENTH Real

Lower Heating Value at NT-1
Dry Vapor Standard DryVapStdLowerHeat 0 to ENTH Real

Gas Lower Heating NT-1
Value
Dry Vapor Wobbe DryVapWobbeIndex 0 to Real

Index NT-1
Dry Liquid Standard DryLiqStdSG 0 to Real

Dry Liquid Standard DryLiqStdAPI 0 to Real

API Gravity NT-1
Dry Liquid Molecular DryLiqMW 0 to Real

Weight NT-1
Dry Liquid UOPK DryLiqUOPK 0 to Real

NT-1

Dry Liquid Critical DryLiqCritTemp 0 to TEMP Real

Temperature NT-1
Dry Liquid Critical DryLiqCritPres 0 to PRES Real

Pressure NT-1
Dry Liquid Critical DryLiqCritCompres 0 to Real

Dry Liquid Molar DryLiqAvgBoilPoint 0 to TEMP Real

Average Boiling NT-1
Point
Dry Liquid Acentric DryLiqAcenFact 0 to Real

Factor NT-1
Wet Vapor Standard WetVapStdSG 0 to Real

Wet Vapor Standard WetVapStdAPI 0 to Real

API Gravity NT-1
Wet Vapor Molecular WetVapMW 0 to Real

Weight NT-1
Wet Vapor Standard WetVapStdVolumeFlo 0 to GVRA Real

Volumetric Flowrate w NT-1
Wet Vapor Actual WetVapActVolumeFlo 0 to GVRA Real


Wet Vapor Standard WetVapStdDensity 0 to VDEN Real

Density NT-1
Wet Vapor Actual WetVapActDensity 0 to VDEN Real

Density NT-1
Wet Vapor Viscosity WetVapViscosity 0 to VISC Real

NT-1
Wet Vapor Thermal WetVapThermCond 0 to COND Real

Conductivity NT-1
Wet Vapor Entropy WetVapEntropy 0 to ENTR Real

NT-1
Wet Liquid Standard WetLiqStdSG 0 to Real

Wet Liquid Standard WetLiqStdAPI 0 to Real

API Gravity NT-1
Wet Liquid Molecular WetLiqMW 0 to Real

Weight NT-1
Wet Liquid Standard WetLiqStdVolumeFlo 0 to LVRA Real

Wet Liquid Actual WetLiqActVolumeFlow 0 to LVRA Real

Volumetric Flowrate NT-1
Wet Liquid Standard WetLiqStdDensity 0 to LDEN Real

Density NT-1

Wet Liquid Actual WetLiqActDensity 0 to LDEN Real

Density NT-1
Wet Liquid Viscosity WetLiqViscosity 0 to VISC Real

NT-1
Wet Liquid Thermal WetLiqThermCond 0 to COND Real

Conductivity NT-1
Wet Liquid Entropy WetLiqEntropy 0 to ENTR Real

NT-1
Wet Liquid Surface WetLiqSurfTens 0 to SURF Real

Tension NT-1
Table B.14A Simple Heat Exchanger Unit Operation Input

Data
Read an attribute: Value=HXObject.GetAttribute(AttributeName, Index)
Write an attribute: HXObject.PutAttribute(Value,AttributeName, Index)
HX Input Data
Documentation, Class = Hx
Descriptive UnitName Char 40 char max

name

Data
Configuration, Class = Hx
Flow configuration CoCounterFlag InT
Number of tube TubePasses InT

passes
Number of shell ShellPasses InT

passes
LMTD correction LmtdFactorIn Real

factor (FT)
Specifications, Class = Hx
Specification type SpecTypeFlag InT
Hot side product HotProdTempIn TEMP Real SpecTypeFlag = 0

temperature
Hot side product HotLiqFracIn Real SpecTypeFlag = 1

molar liquid fraction
Hot side temperature HotBubbleIn TDIF Real SpecTypeFlag = 2

below bubble point
Hot side temp. rise HotDewIn TDIF Real SpecTypeFlag = 3

above dew point
Cold side product ColdProdTempIn TEMP Real SpecTypeFlag = 4

temperature
Cold side product ColdLiqFracIn Real SpecTypeFlag = 5

molar liquid fraction

Data
Cold side ColdBubbleIn TDIF Real SpecTypeFlag = 6

temperature. drop
below bubble point
Cold side temp. rise ColdDewIn TDIF Real SpecTypeFlag = 7

above dew point
Duty DutyIn DUTY Real SpecTypeFlag = 8
Hot out - cold in HociIn TDIF Real SpecTypeFlag = 9

temperature
approach
Hot in - cold out HicoIn TDIF Real SpecTypeFlag =

temperature 10
approach
Hot out - cold out HocoIn TDIF Real SpecTypeFlag =

temperature 11
approach
Minimum of HOCI or MiniIn TDIF Real SpecTypeFlag =

HICO 12
Minimum Internal MitaIn TDIF Real SpecTypeFlag =

temperature 13
approach
Overall UA UaIn UA Real SpecTypeFlag =

specification 14
U value UvalueIn HTCO Real
Area AreaIn AREA Real

Data
UA maximum value UaMaxIn UA Real
Relative convergence ConvTolIn Real

tolerance for spec.
value
Hot side pressure HotPressDropIn PDIF Real dP = Pin - Pout

drop
Cold side pressure ColdPressDropIn PDIF Real dP = Pin - Pout

drop
Feeds, Class = Hx
Number of CurrentFeeds Int

feeds
Feed FeedData 0 to N- Strm N=CurrentFeeds

StreamIDs 1 ID
Starting FirstFeed 0 Int Always has value

index hot side feeds of 1
Ending index LastFeed 0 Int

hot side feeds
Starting FirstFeed 1 Int

index of cold side
feed
Ending index LastFeed 1 Int Always has value

cold side feeds of N
Hot side thermo MethodData 0 Meth

method set ID

Data
Cold side thermo MethodData 1 Meth

method set ID
Products, Class = Hx
Number of CurrentProduct Int

products s
Product ProductData 0 to N- Strm N=CurrentProduct

StreamIDs 1 ID s
Product ProductStoreD 0 to N- InT 1-Vapor

stream phases ata 1
2-Liquid
3-Solid
4-Mixed
Starting FirstProduct 0 Int Always has value

index hot side of 1
products
Ending index LastProduct 0 Int

hot side products
Starting FirstProduct 1 Int

index of cold side
product
LastProduct 1 Int Always has value

Ending index of N
cold side products

Data
Utilities, Class = Hx
Use of utility stream UtilitySideFlag Int 0 - No utility

flag
1 - Hot side utility
2 - cold side utility
Utility fluid type UtilityFluidFlag Int 0 None

1 Water
2 Air
3 Steam
4 Refrigerant
5 - Heating
medium
Heating Hx_UtilCompID Comp

medium/Refrigerant ID
component
Inlet/Outlet
temperatures for
water, air
- Inlet UtilityTempIn TEMP Real

temperature
- Outlet UtilityTempOut TEMP Real

temperature
Saturation options for

steam, heating
medium, refrigerant

Data
- Option UtilSatrnOption Int 1 Pressure

2 Temperature
- Saturation UtilityTempIn TEMP Real

temp.
- Saturation UtilityPresIn PRES Real

pressure
Zones Analysis, Class = Hx
Calculation option ZoneAnalysisFlag Int 0 No zones

analysis
1 - During
calculation
2 - During output
Number of zones ZonesIn Int
Attached Column Configuration, Class = Hx
Attachment present AttachedSideFlag Int 0 - Not attached

1 - Hot side
attached
2 - Cold side
attached
Attached column ID AttachedUnit Unit

ID

Data
Attachment heater AttachedTypeFlag Int 0 Not attached

type
1 Condenser
2 Reboiler
3 Pumparound
heater/cooler
4 - Side
heater/cooler
Column side heater ColuHeaterName Char

name
Column pumparound ColuPAName Char

heater/cooler name
Attached column tray AttTrayNumber Int

number
Phase of feed to AttFeedPhase Int

attached HX
Feed rate to attached AttachedFeedRate MRAT Real

heater/cooler

Table B.14B Simple Heat Exchanger Unit Properties
HX Calculated Properties
Parameters, Class = Hx
Hot side product TEMP Real

temperature HotProdTempCalc
Hot side product Real

molar liquid fraction HotLiqFracCalc
Hot side temp. below TDIF Real

bubble poInt HotBubbleCalc
Hot side temp. rise TDIF Real

above dew poInt HotDewCalc
Cold side product TEMP Real

temperature ColdProdTempCalc
Cold side product Real

molar liquid fraction ColdLiqFracCalc
Cold side temp.drop TDIF Real

below bubble poInt ColdBubbleCalc
Cold side temp. rise TDIF Real

above dew poInt ColdDewCalc
Hot out - cold in TDIF Real

temperature
approach HociCalc

Hot in - cold out TDIF Real

temperature
approach HicoCalc
Hot out - cold out TDIF Real

temperature
approach HocoCalc
Minimum of HOCI or TDIF Real

HICO MiniCalc
Minimum Internal TDIF Real

temperature
approach MitaCalc
Overall UA UA Real
specification UaCalc
U value UvalueCalc HTCO Real
Area AreaCalc AREA Real
UA maximum value UaMaxCalc UA Real
Relative ConvTolCalc Real

convergence
tolerance for spec.
value
LMTD correction
factor (FT) LmtdFactorCalc
Overall exchanger TDIF

Mean Temp.
Difference (MTD) LmtdCalc

Temperature
crossover ZoneLmtdCalc
Hot side pressure HotPressDropCalc PDIF Real dP = Pin - Pout

drop
Cold side pressure ColdPressDropCalc PDIF Real dP = Pin - Pout

drop
Utilities, Class = Hx
Inlet utility TEMP Real

temperature UtilityTempCalc
Outlet utility TEMP Real

temperature UtilityTempOutCalc
Utility saturation PRES Real

pressure UtilityPresCalc
Utility flowrate UtilityFlowRate MRAT Real
Utility Cp or heat SPHE Real

value UtilityHeatValue
Combined Streams (Internal), Class = Hx
Hot side Internal feed MergedFeed 0 Strm

StreamID ID
Hot side Internal MergedProduct 0 Strm

product StreamID ID
Cold side Internal MergedFeed 1 Strm

feed StreamID ID

Cold side Internal MergedProduct 1 Strm

product StreamID ID
accessible via the standard Stream Class. See Table 3-1
Table B.15A Rigorous Heat Exchanger Input Data

Property Attribute Name Index Units Description

Type
HXRIG Input Data
Documentation, Class = HxRigIn


Type
HXRIG Input Data
Feeds, Class = HxRigIn
Feed StreamIDs FeedData 0 to Strm N=CurrentFeeds

N-1 ID
Starting index shell FirstFeed 0 Int Always has value

side feeds of 1
Ending index shell LastFeed 0 Int

side feeds
Starting index of FirstFeed 1 Int

tube cold side feed
Ending index tube LastFeed 1 Int Always has value

side feeds of N
Shell-side thermo MethodData 0 Meth

method set ID
Tube-side thermo MethodData 1 Meth

method set ID
Products, Class = HxRigIn
Number of CurrentProducts Int

products
Product ProductData 0 to Strm N=CurrentProdu

StreamIDs N-1 ID cts


Type
HXRIG Input Data
Product stream ProductStoreData 0 to Int 1-Vapor

phases N-1
2-Liquid
3-Solid
4-Mixed
Starting index shell FirstProduct 0 Int Always has value

side products of 1
Ending index shell LastProduct 0 Int

side products
Starting index of FirstProduct 1 Int

tube side product
Ending index tube LastProduct 1 Int Always has value

side products of N
Configuration, Class = HxRigIn
Calculation Type SpecType Int 0 Rating mode

1 Shell
temperature
specified
2 Tube
temperature
specified
3 Duty
specified
Number of tubes NumOfTubes Int


Type
HXRIG Input Data

per shell
Area per shell UnitAreaPerShellIn AREA Real
Shell Inside ShellID DFLT Real

diameter
Number of shells in NumOfSerShells Int

series
Number of shells in NumOfParShells Int

parallel
Number of tube NumOfTubePasses Int

passes per shell
Orientation PositionType Int 1 Horizontal

2 - Vertical
Flow configuration FlowTypeFlag Int 0

Countercurrent
1 Cocurrent
TEMA Types IJK
Front type I TEMATypeFrontEndF Int 0 UNDEF

lag
1 A
2 B
3 C
4 N


Type
HXRIG Input Data

5 D
7 F
Shell type J TEMATypeShellFlag Int 0 UNDEF

1 E
2 F
3 G
4 H
5 J
6 K
7 X
Rear type K TEMATypeRearEndFl Int 0 UNDEF

ag
1 S
2 T
3 U
4 L
5 M
6 N
7 P
8 W
Character TEMATypeChar Char i.e., AES

Representation of
TEMA Type


Type
HXRIG Input Data
Tube Data, Class = HxRigIn
Tube thickness type TubeThckFlag Int 1 - Inside

flag Diameter
2 - Wall
thickness
3 - BWG
Inside diameter TubeID FLEN Real
Tube wall thickness TubeThck FLEN Real
Tube BWG TubeBWG Int
Tube length TubeLen LENG Real
Tube outside TubeOD FLEN Real

diameter
Tube pitch TubePitch FLEN Real
Tube pitch pattern PitchPattern Int 1 = 30

2 = 90
3 = 60
4 = 45
Tubesheet TubeSheetThck FLEN Real

thickness
Fin area calc flag FinExistFlag Int 1 No finned

tubes


Type
HXRIG Input Data

2 Area from fin
data
3 Area per ft
tube supplied
Surface area FinArea AREA Real
Fins per inch FinsPerInch Real
Fin thickness FInthck FLEN Real
Fin height about FinHgt FLEN Real

root
Fin root diameter FinRootDia FLEN Real
Baffle Data, Class = HxRigIn
Baffle type BaffleType Int 1 - Single

2 Double
5 - No baffles
(3 and 4 not in
use in PRO/II)
Tubes in baffle TubesExistFlag Int 0 Normal

windows
1 No tubes in
windows
Baffle geometry BaffleGeometryFlag Int 1 Based on

type baffle cut
2 Based on Net


Type
HXRIG Input Data

free area ratio
Baffle cut fraction BaffleCutFrac Real
Baffle net free area NetFreeAreaRatio Real

ratio
Center spacing BaffleSpc DFLT Real
Inlet spacing InletBaffleSpc DFLT Real
Outlet spacing OutletBaffleSpc DFLT Real
Baffle thickness BaffleThck DFLT Real
Number of pairs of NumOfSealStripPairs Int

sealing strips
Film Coefficient Data, Class = HxRigIn
Overall U-value UValEstIn Real

estimate
Overall U-value USclFct Real

scale factor
Tube-side film TubeFilmOption Int 1 Use scale

coefficient method factor
2 Use film
coefficient
Tube-side film TubeFilmCoeff Real

coefficient


Type
HXRIG Input Data
Tube-side scale TubeFilmCoeffSclFct Real

factor
Tube-side fouling TubeFoulFct Real

resistance
Tube-side fouling TubeFoulLayerThck Real

thickness
Shell-side film ShellFilmOption Int 1 Use scale

coefficient method factor
2 Use film
coefficient
Shell-side film ShellFilmCoeff Real

coefficient
Shell-side scale ShellFilmCoeffSclFct Real

factor
Shell-side fouling ShellFoulFct Real

resistance
Shell-side fouling ShellFoulLayerThck Real

thickness
Pressure Drop Data, Class = HxRigIn
Tube-side pressure TubePressDropFlag Int 1 Use DP scale

drop type flag factor
2 - Use DP/shell
3 - Use DP/Unit


Type
HXRIG Input Data
Tube-side pressure TubePressDropSclFct PDIF Real

drop scale factor
Tube-side pressure TubePressDropShell PDIF Real

drop per shell
Tube-side pressure TubePressDropUnit PDIF Real

drop per unit
Shell-side pressure ShellPressDropFlag Real 1 Use DP scale

drop type flag factor
2 - Use DP/shell
3 - Use DP/Unit
Shell-side pressure ShellPressDropSclFct PDIF Real

drop scale factor
Shell-side pressure ShellPressDropShell PDIF Real

drop per shell
Shell-side pressure ShellPressDropUnit Real

drop per unit
Shell-side pressure ShellDPCorrMeth Int 0 Use Bell

drop calculation method
method
1 Use stream
method (Wills
and Johnston)
Material Data, Class = HxRigIn
Tube material TubeMatCode 1 - "Carbon - Steel"2 - "Carbon-


Type
HXRIG Input Data

moly - Steel"
Shell material ShellMatCode
3 - "Chrome-moly - Steel"
4 - "Low - Chrome - Steel"
5 - "Medium - Chrome - Steel"
6 - "Straight - Chrome - Steel"
7 - "304 - Stainless - Steel"
20 - "Aluminum - 1060-H14"
21 - "Aluminum - 1100 - Annealed"
22 - "Aluminum - 3003 - H14 -
Annealed"
23 - "Aluminum - 3003 - H25 -
Annealed"
24 - "Aluminum - 6061 - T4 -
Annealed"
25 - "Aluminum - 6061 - T6 -
Annealed"
30 - "Copper"
31 - "Arsenical - Copper"
32 - "Copper - Nickel - 90/10"


Type
HXRIG Input Data

40 - "Red - Brass - 85 Cr, 15 Zn"
41 - "Admirality 71 Cu, 28 Zn,
1Sn"
42 - "Commercia - Brass 55 Cu,
34 Zn"
43 - "Muntz - Metal 60 Cu, 40
Zn"
44 - "Aluminum Bronze 93 Cu,
5 Al"
45 - "Aluminum - Brass 78 Cu, 2
Al"
50 - "Nickel - Annealed"
51 - "Low - Carbon - Nickel -
Annealed"
52 - "Monel - Nickel - 70 Ni, 30 Cu"
53 - "Inconel - 600 - 76 Ni, 16 Cr, 8
Fe"
60 - "Titanium - Grade 2"
Tube material user- TubeMatName CHAR Char

supplied name
Tube material TubeDens DENS Real

density
Tube material TubeThermCond TCON Real



Type
HXRIG Input Data
Shell material user- ShellMatName CHAR Char

supplied name
Shell material ShellDens DENS Real

density
PrInt Options, Class = HxRigIn
Extended TEMA ExtendedPrIntFlag Int 1 Do not prInt

sheet prIntout flag extended report
2 PrInt
extended report
Zones analysis flag ZonesPrIntFlag Int 1 Do not run

zones analysis
2 Run zones
report
Plot zones analysis PlotFlag Int 0 No zones plot

flag
1 Generate
zones plot
Nozzle Options, Class = HxRigIn
Use tube-side TubeNozzleType Int 0 No nozzle

nozzles flag
1 Program
sized
2 User supplied
tube-side nozzle
sizes


Type
HXRIG Input Data
Tube-side inlet TubeNozzleInletID FLEN

nozzle inside
diameter
Tube-side outlet TubeNozzleOutletID FLEN

nozzle inside
diameter
Use Shell-side ShellNozzleType Int 0 No nozzle

nozzles flag
1 Program
sized
2 User supplied
shell-side nozzle
sizes
3 Annular, user
sized.
Shell-side inlet ShellNozzleInletID FLEN Real

nozzle inside
diameter
Shell-side outlet ShellNozzleOutletID FLEN Real

nozzle inside
diameter
Annular inlet nozzle AnnInletClr FLEN Real

wall clearance
Annular inlet nozzle AnnInletLen FLEN Real

groove area


Type
HXRIG Input Data
Annular inlet nozzle AnnInletArea FARE Real

length
Annular outlet AnnOutletClr FLEN Real

nozzle wall
clearance
Annular outlet AnnOutletArea FLEN Real

nozzle groove area
Annular outlet AnnOutletLen FARE Real

nozzle length
Attached Column Configuration, Class = HxRigIn
Attachment present AttachedSideFlag Int 0 - Not attached

1 - Hot side
attached
2 - Cold side
attached
Attached column ID AttachedUnit Unit

ID
Attachment heater AttachedTypeFlag Int 0 Not attached

type
1 Condenser
2 Reboiler
3 Pumparound
heater/cooler
4 - Side


Type
HXRIG Input Data

heater/cooler
Column side heater ColuHeaterName Char

name
Column ColuPAName Char

pumparound
heater/cooler name
Attached column AttTrayNumber Int

tray number
Phase of feed to AttFeedPhase Int

attached HX
Feed rate to AttachedFeedRate MRAT Real

attached
heater/cooler
Table B.15B Rigorous Heat Exchanger Calculated Properties

HXRIG Calculated Properties
Operating Conditions, Class = HxRig
Duty ExchngHtDuty DUTY Real

LMTD LogMeanTempDiff TDIF Real
LMTD Correction Real

factor (Ft) FTFct
MTD (Ft * LMTD) MeanTempDiff TDIF Real
Overall heat transfer HTCO Real

coefficient (U) UValFoul
Exchanger area (A) AreaUsingUDirty AREA Real
U*A UAVal
Overall heat transfer HTCO Real

coefficient UValFoul
Clean heat transfer HTCO Real

coefficient UValNoFoul
Number of tubes per NumOfTubes InT

shell
Tube side product TubeTempOut TEMP Real

temperature
Tube side pressure TubePressDropCalc PDIF Real

drop per shell
Tube side velocity TubeVel VELO Real
Tube side fouling TubeFoulFct FOUL Real

factor

Tube side design TubeDsgnPress

pressure
Tube thickness type TubeThckFlag 1 - Inside

flag Diameter
2 - Wall thickness
3 - BWG
Inside diameter TubeID FLEN Real
Tube wall thickness TubeThck FLEN Real
Tube BWG TubeBWG Int
Tube length TubeLen Real
Tube outside TubeOD FLEN Real

diameter
Tube pitch TubePitch Real
Tube pitch pattern PitchPattern Int 1 = 30 2 = 90

3 = 60 4 = 45
Number of tube NumOfTubePasses Int

passes per shell
Tubesheet thickness TubeSheetThck Real

Fin area calc flag FinExistFlag Int 1 No finned

tubes
2 Area from fin
data
3 Area per ft
tube supplied
Surface area FinArea Real
Fins per inch FinsPerInch Real
Fin thickness FInthck Real
Fin height about root FinHgt Real
Fin root diameter FinRootDia Real
Tube side Reynolds Real

number TubeReyNum
Tube side Prandtl Real

number TubePrnNum
Shell side Prandtl Real

number ShellPrnNum
Tube side film heat TubeFilmCoeff HTCO Real

transfer coefficient
Tube side film heat TubeFilmCoeffSclFct Real

scaling factor
Tube side fouling TubeFoulLayerThck DFLT Real

layer thickness

Shell data, Class = HxRig
Shell side product TEMP Real

temperature ShellTempOut
Shell side pressure PDIF Real

drop per shell ShellPressDropCalc
Shell side velocity ShellVel VELO Real
Shell side fouling FOUL Real

factor ShellFoulFct
Shell side design

pressure ShellDsgnPress
Area per shell UnitAreaPerSh AREA Real

ell
Shell Inside diameter ShellID DFLT Real
Number of shells in NumOfSerShells Int

series
Number of shells in NumOfParShells Int

parallel
Shell inlet nozzle v

2
ShellInletNozRhoV2 Real
Shell side Reynolds Real

number ShellReyNum
Shell side film heat ShellFilmCoeff HTCO Real


Shell side film heat ShellFilmCoeffSclFct Real

scaling factor
Shell side fouling ShellFoulLayerThck DFLT Real

layer thickness
Weight data, Class = HxRig
Tube bundle weight TubeBundleWt WT Real
Empty shell weight ShellEmptyWt WT Real
Shell weight full with WT Real

water ShellWetWt
Baffle data, Class = HxRig
Baffle type BaffleType Int 1 Single

2 Double
5 - No baffles
(3 and 4 not in use
in PRO/II)
Number of baffles NumOfBaffles Int
Tubes in baffle TubesExistFlag Int 0 Normal

windows
1 No tubes in
windows
Baffle geometry type BaffleGeometryFlag Int 1 Based on

baffle cut
2 Based on Net
free area ratio

Baffle cut fraction BaffleCutFrac Real
Baffle net free area NetFreeAreaRatio Real

ratio
Center spacing BaffleSpc DFLT Real
Inlet spacing InletBaffleSpc DFLT Real
Outlet spacing OutletBaffleSpc DFLT Real
Baffle thickness BaffleThck DFLT Real
Number of pairs of NumOfSealStripPairs Int

sealing strips
Combined Streams (Internal), Class = HxRig
Tube side Internal MergedFeed 0 Strm

feed StreamID ID
Tube side Internal MergedProduct 0 Strm

product StreamID ID
Shell side Internal MergedFeed 1 Strm

feed StreamID ID
Shell side Internal MergedProduct 1 Strm

product StreamID ID

Zones Analysis, Class = HxRig
Number of zones for Int

zones analysis NumOfHtTrZones
Zones report prInt ZonesPrIntFlag Int 1 Do not prInt

flag zones report
2- PrInt zones
report
Zones report plot flag PlotFlag Int 0 PrInt zones

plot
1 Do not prInt
zones plot
Heat transfer per ZoneHeatDuty 1 to N Real N =

zone NumOfHtTrZones
Hot side ZoneHotTemp 1 to TEMP Real

temperatures N+1
Cold side ZoneColdTemp 1 to TEMP Real

temperatures N+1
Zone LMTD ZoneMeanTempDiff 1 to N Real

Hot side pressures ZoneHotPress 1 to PRESS Real

N+1
Cold side pressures ZoneColdPress 0 to N PRESS Real
Area per zone ZoneArea 1 to N Real
Zone LMTD ZoneFT 1 to N Real

correction factor
Zone U value ZoneUVal 0 to N- Real

1
Zone tube side film ZoneTubeFilmCoeff 1 to N Real

coefficient
Zone shell side film ZoneShellFilmCoeff 1 to N Real

coefficient

Table B.16A LNG Heat Exchanger Input Data
Property Attribute Name Units Type Description

Index
LNGHX Input Data
Documentation, Class = LngHx
Configuration, Class = LngHx
Total cells in LNG TotalCellCount InT

heat exchanger
Total number of cold ColdCellCount Int

cells
Total number of hot HotCellCount Int

cells
Total number of cells TotalSpecCellCount Int

with specifications
Total number of cold ColdSpecCellCount Int

cells with
specifications
Total number of hot HotSpecCellCount Int

cells with
specifications
Cell name CellName 0 to Cell ID N =

N -1 TotalCellCount
Cell hot/cold type CellType 0 to Int 0 Undefined

N -1
1 Hot side
2 Cold side


Index
LNGHX Input Data
Cell specification CellSpecFlag 0 to Int 0 No spec

type N -1
1 Outlet
temperature
2 Duty
Specified cell duty CellDuty 0 to DUTY Real

N -1
Specified cell outlet CellOutletTemp 0 to TEMP Real

temperature N -1
Specified cell CellPressDrop 0 to PDIF Real

pressure drop N -1
LNG thermo method MethodData 0 to Meth Method used

set N -1 ID
Specified heat leak HLeakIn Real

fraction
Feeds, Class = LngHx
Feed StreamIDs FeedData 0 to Strm F = CurrentFeeds

F -1 ID
Starting index cell FirstFeed 0 to Int N=

feeds N -1 TotalCellCount
Ending index LastFeed 0 to Int

cell feeds N -1


Index
LNGHX Input Data
Merged cell feed MergedFeed 0 to Strm

label N -1 ID
Products, Class = LngHx
Number of CurrentProduct Int

products s
Product ProductData 0 to Strm P=CurrentProduct

StreamIDs P -1 ID s
Product ProductStoreD 0 to Int 1-Vapor

stream phases ata P -1
2-Liquid
3-Solid
4-Mixed
Starting FirstProduct 0 to Int

index cell feeds N -1
Ending index LastProduct 0 to Int

cell feeds N -1
Merged cell product MergedProduct 0 to Strm

label N -1 ID
PrInt Options, Class = LngHx
Include plots flag PlotOption Int 1 No plots in

output report
2 Include plots
in output report


Index
LNGHX Input Data
Include temperature TempDutyPlot Int 0 Do not include

vs. duty plot plot
1 Include plot
Include UA vs. duty DutyUAPlot Int 0 Do not include

plot plot
1 Include plot
Include UA vs. delta TempDiffUAPlot Int 0 Do not include

temp plot
1 Include plot
Include delta temp. TempTempDiffPlot Int 0 Do not include

vs temp. plot
1 Include plot
Include delta temp. DutyTempDiffPlot Int 0 Do not include

vs duty plot
1 Include plot
Include duty vs. DutyTempPlot Int 0 Do not include

temperature plot plot
1 Include plot


Index
LNGHX Input Data
Zones Options, Class = LngHx
Use zones analysis ZoneFlag Int 0 Zones not

flag used
1 Zones
calculated during
flowsheet
simulation
2 Zones
calculated during
output report
Specified number of NumZones Int

zones
Table B.16B LNG Heat Exchanger Output Data

LNGHX Calculated Data
Performance data, Class = LngHx
Overall exchanger OverallCellDuty DUTY Real

duty

Calculated heat duty CellDutyCalc 0 to DUTY Real N =

of cell N -1 TotalCellCount
Calculated outlet CellOutletTempCalc 0 to TEMP Real

temperature N -1
Pressure drop used CellPressDropCalc 0 to PDIF Real

N -1
Heat leak fraction HLeakCalc

used by calculations
Products, Class = LngHx
Product StreamIDs ProductData 0 to Strm P=CurrentProduct

P -1 ID s
Product stream ProductStoreData 0 to Int 1-Vapor

phases P -1
2-Liquid
3-Solid
4-Mixed
Starting index cell FirstProduct 0 to N Int

feeds -1
Ending index cell LastProduct 0 to Int

feeds N -1
Merged cell product MergedProduct 0 to Strm

label N -1 ID

accessible via the standard Stream Class. See Table 3-1
Zones analysis, Class = LngHx
Overall weighted duty OverallWtZoneDuty DUTY

from zones
Overall weighted U*A OverallWtZoneUA UA

from zones
Overall weighted OverallWtZoneLMTD TDIF

LMTD from zones
Minimum Internal ZoneMITA TDIF

temperature
approach from zones
Actual number of ZonePntCalc

zone poInts
calculated.

Actual cold side zone ColdZonePntNum

poInts
Actual hot side zone HotZonePntNum

poInts
Duties for each zone ZoneDuty 1 to DUTY N = ZonePntCalc

N-1
Number of pinch PinchPtCountCalc

poInts calculated
Hot side ZoneHotSideTemp 0 to TEMP 0 Hot side outlet

temperatures for N-1
each zone
Cold side ZoneColdSideTemp 0 to TEMP 0 Cold side inlet

temperatures for N-1
each zone

Table B.17A Plug Flow Reactor(PFR) Unit Operation Input
Data
Read an attribute: ReactorObject.GetAttribute(AttributeName, Index)
Write an attribute: ReactorObject.PutAttribute(AttributeName, Index)
PFR Input Data
PFR Documentation, Class = Plug
Feeds, Class = Plug
Number of feeds CurrentFeeds InT
Feed StreamIDs FeedData 0 to STrea NF=CurrentFeeds

NF-1 mID
Products, Class = Plug
Number of products CurrentProdu Int

cts
Product StreamIDs ProductData 0 to Strm NP=CurrentProduct

NP-1 ID s
Product stream ProductStore 0 to Int 0-Unspecified

phases Data NP-1
1-Vapor 2-Liquid
3-Solid 4-Mixed
PFR Configuration, Class = Plug
Reactor length LengthIn FLEN Real
Reactor diameter DiamIn FLEN Real
Number of tubes TubesIn Int

Data
PFR Input Data
Number of poInts in NumProfPrIntPts Int Default=10

reactor profile
prIntout
PFR Reactor Tube Pressure Profile, Class = Plug
Reactor pressure PressureFlag Int 0 - Pressure given

flag
1 - Pressure Drop
(DP) given
2 - Neither given
Reactor inlet RxPresInFlag Int 1 - Lowest feed

pressure flag pressure
2 - User input inlet
pressure
3 - Pressure drop
below feed
User supplied InPresIn PRES Real

reactor inlet
pressure
Reactor outlet RxPresOutFlag Int 1 - Lowest feed

pressure flag pressure
2 - User input outlet
pressure
3 Reactor
pressure drop

Data
PFR Input Data
User supplied PresIn PRES Real

reactor outlet
pressure
User supplied InPresDropIn PDIF Real

reactor inlet
pressure drop below
feed pressure
User supplied PresDropIn PDIF Real

reactor pressure
drop
Pressure profile flag PProfileFlag Int 0 - No pressure

profile
1 - Pressure profile
input
Number of pressure PresProfPoInts Int

profile poInts
Pressure profile PresProfile 0 to TEMP Real NP =

NP - 1 PresProfPoInts
Pressure profile PresProfLocs 0 to FLEN Real NP =

locations NP - 1 PresProfPoInts

Data
PFR Input Data
Pressure profile PProfileLocFlag Int 0 - Actual reactor

location basis length
1 - Fraction of
length
2 - Percent of
length
PFR Thermal Conditions, Class = Plug
Operating phase RxOperPhaseIn Int 1 Vapor (Default)

flag 2 Liquid
Reactor Operation RxOperTypeIn Int 1 Thermal

Type (isothermal or
temperature profile)
2 Fixed duty
3 External heat
(co-current)
4 - External heat
(countercurrent)
Isothermal operation IsoTempInFlag Int 0 = Not input

flag combined feed
temperature or
from profile if
supplied
1 = Fixed
temperature
supplied

Data
PFR Input Data
Outlet temperature TempIn TEMP Real Fixed temperature

operation only
Temperature profile TProfileFlag Int 0 - Temperature

flag Profile Not Input
1 - Temperature
Profile Input
Number of TempProfPoInts Int 0 - No temperature

temperature profile profile (feed
poInts temperature)
N - No. of
temperature profile
locations input
Basis of location for TProfileLocFlag Int 0 - Actual Reactor

temperature profile Length
1 - Fraction of
Length
2 - Percent of
Length
Temperature profile TempProfLocs 0 to FLEN Real NP =

locations NP - 1 TempProfPoInts
Input temperature TempProfile 0 to TEMP Real NP =

profile NP - 1 TempProfPoInts
Duty (DUTY) DutyIn DUTY Real RxOperTypeIn = 2

only

Data
PFR Input Data
Cooling/heating ColdOutTempIn TEMP Real External heat

stream outlet option only
temperature
External stream SideFlag Int 0 - None

heat type
1 - Cooling
2 - Heating
Input heat transfer HTCIn HTCO Real Default = 1 Btu/hr

2
coefficient ft F
Heating/cooling HotPresInFlag Int 1 - Combined feed

medium inlet pressure (Default)
pressure flag
pressure
3 - Pressure drop
below feed
Heating/cooling HotPresOutFlag Int 1 - Combined feed

medium outlet pressure (Default)
pressure flag
pressure
3 - Pressure drop
below feed
Heating/cooling ColdInPress PRES Real

medium inlet
pressure

Data
PFR Input Data
Heating/cooling ColdOutPress PRES Real

medium outlet
pressure
Heating/cooling ColdPressDropIn PDIF Real

medium inlet
pressure drop
Heating/cooling ColdPressDrop PDIF Real

medium pressure
drop
Flag for prInting the PrIntPathFlagIn Int 0 Heat path

heat of reaction path calculation not
prInted
1 Heat path
calculation prInted
in output report
PFR Integration Method, Class = Define
Integration method IntMethodFlagIn Int 1 = Runge Kutta

flag
2 = Gear
3 = LSODA
Runge Kutta option RungeKuttaOption Int 1=RungeKutta

flag steps
2=RungeKutta step
size

Data
PFR Input Data
Number of Steps for RungeKuttaStepsIn Int Default =20

Runge Kutta
Integration
Runge-Kutta step IntStepSize Real

size
Gear/LSODA IntCalcTolIn Real Default = 0.1

tolerance
PFR Unit Reaction Definitions, Class = Define
Reaction set RxnSetID Rxn

selected Set
ID
Reaction ids RxnID 0 to

NR - 1
Number of NumberOfRxnComps InT Number of

components in components in the
simulation simulation
Component ids CompID 0 to CID Comp NOC =

NOC-1 ID NumberOfRxnCom
ps

Data
PFR Input Data
Calculation method KIntypeFlagIn InT 1 - Power Law

for kinetic data Equation
2 - User Kinetic
Subroutine
3 - In-Line
Procedure
Reaction activity CompBasisFlagIn InT 1 = Concentration

basis
2 = Partial pressure
3 = Vapor fugacity
4 = Liquid activity
Number of reactions NumberOfReactions InT

in the selected set
Reaction component BaseCompIDIn 0 to Comp ID Char NR =

base NR - 1 NumberOfReaction
s
User supplied pre- PexpFactors 0 to Real

exponential factor NR - 1
(A)
User supplied ActivationEnergy 0 to Real

activation energy (E) NR - 1
User supplied Texponents 0 to Real

temperature NR - 1
exponent (n)

Data
PFR Input Data
User supplied - rate PexpLiqvUOMIn 0 to LIQV Real

equation volume NR - 1
UoM
User supplied - rate PexpPresUOMIn 0 to PRES Real

equation pressure NR - 1
UoM
User supplied - PexpWtUOMIn 0 to WT Real

weight equation NR - 1
volume UoM
User supplied - time PexpTimeUOMIn 0 to TIME Real

equation volume NR - 1
UoM
User supplied order ExpoRxnComps 0 to Real NOC =

of reaction NOC - NumberOfRxnCom
1 ps
User kinetic USKINIDIn Int 1 - User Kinetic

subroutine flag Subroutine = U1
2 - User Kinetic
Subroutine = U2
etc
Kinetic subroutine UserAddedIparm 0 to Int NP = number of

InT parameter data NP - 1 parameters
(IPARM) (Default = 9)
Kinetic subroutine UserAddedRparmIn 0 to Real NP = number of

real parameter data NP - 1 parameters
(RPARM) (Default = 69)

Data
PFR Input Data
Kinetic subroutine UserAddedSupple 0 to Real NP = number of

supplemental NP - 1 parameters
parameter data
(Default = 199)
(SUPPLE)
Kinetic procedure ID ProcedureIDIn Char
Kinetic procedure ProcIntVars 0 to Int NP = number of

(Default = 9)
Kinetic procedure ProcRealVars 0 to Real NP = number of

real parameter data NP - 1 parameters
(Default = 270)
Kinetic procedure ProcIntVars 0 to Int NP = number of

(Default = 9)

Table B.17B Plug Flow Reactor(PFR) Unit Operation
Calculated Properties
PFR Calculated Properties
Thermal Conditions, Class = Plug
Inlet temperature FeedTemp TEMP Real
Outlet temperature TempCalc TEMP Real
Inlet pressure FeedPress PRES Real
Temperature profile 0 to NP TEMP Real NP =

data TempProfile -1 TempProfPoInts
Temperature profile 0 to NP FLEN Real NP =

locations TempProfLocs -1 TempProfPoInts
Outlet pressure PresCalc PDIF Real
Outlet pressure ProdPres PRES Real
Calculated pressure PDIF Real

drop PresDropCalc
Pressure profile PresProfile 0 to NP PRES Real NP =

data -1 PresProfPoInts
Pressure profile 0 to NP FLEN Real NP =

locations PresProfLocs -1 PresProfPoInts
Calculated reactor LIQV Real

volume ReacVolume

Total heat of ENER Real

reaction TotalHOR
Individual reactions HeatsOfRxn 0 to NR ENTH Real NR = number of

heat of reaction 1 reactions
Base component BaseCompNumbers 0 to NR Comp NR = number of

name -1 ID reactions
Individual ReactionRates 0 to NC MRAT Real NC = number of

component reaction -1 components
rates
Calculated ActualActEnergy 0 to NR ENER Real NR = number of

activation energy -1 reactions
Calculated (-E/RT) ERTs 0 to NR Real NR = number of

terms -1 reactions
Feed component FeedCompRates 0 to NC MRAT Real NC = number of

rates 1 components
Product component ProdCompRates 0 to NC MRAT Real NC = number of

rates 1 components
Fractional FracConversions 0 to NR Real NR = number of

conversion -1 reactions
Maximum velocity VmaxCalc VELO Real
Residence time ResidenceTime TIME Real

Heat transfer HTCCalc HTCO Real

coefficient
Array for storing PrIntResults 0 to 69 Real

prInt results
Reference Conditions, Class = Plug
Reference RefTempHOR TEMP Real

conditions
temperature for heat
of reaction
calculations
Reference RefPhaseFlag Int 1 vapor

conditions phase
2 liquid
Feed reference RxFeedRefISN Strm ID Char

conditions stream
Product reference RxProdRefISN Strm ID Char

conditions stream
Reference RefTemp TEMP Real

temperature for
enthalpy
calculations
Individual reaction HeatOfRxnRefTemp 0 to NR TEMP Real NR = number of

reference -1 reactions
temperatures for
enthalpy
calculations

Base component for HeatOfRxnBaseComp 0 to Comp NR = number of

heat of reaction NR - 1 ID reactions
Merged Streams, Class = Plug
Internal stream MergedFeed SID Char

containing feed
conditions
Feed stream FeedEnthalpy DUTY Real

enthalpy
Internal stream MergedProduct SID Char

containing product
conditions
Product stream ProdEnthalpy DUTY Real

enthalpy
Temperatur Temperature TEMP Real

e

Table B.18A Conversion Reactor Unit Operation

Property Attribute Name Index Type Description

Units
ConReactor Input Data
Conversion Reactor Documentation, Class = ConReactor
Feeds, Class = ConReactor
Number of feeds CurrentFeeds InT
Feed StreamIDs FeedData 0 to STrea NF=CurrentFeeds

NF-1 mID
Products, Class = ConReactor
Number of products CurrentProducts InT


Units

NP-1 ID s
Product stream ProductStoreData 0 to InT 0-Unspecified

phases NP-1
1-Vapor
2-Liquid
3-Solid
4-Mixed
Conversion Reactor Conditions, Class = ConReactor
Reactor Operation RxOperTypeIn InT 1 - Fixed outlet

Type temperature
2 - Fixed duty
3 - Temperature
rise
Shift/Methanator RxType 0 User specified

flag stoichiometry
1 Shift reactor
2 Methanator
reactor
Outlet temperature IsoDTFeedIn TDIF Real

delta above feed
Outlet temperature OutTempIn TEM Real

P
Duty ReactorDutyIn DUTY Real


Units
Maximum TEM Real

temperature AdiaTmaxIn P
Minimum AdiaTminIn TEM Real

temperature P
Heat balance flag HeatBalanceFlagIn InT 1 - No heat balance

otherwise - perform
heat balance
Flag for prInting the PrIntPathFlagIn 0 Heat path

heat of reaction path calculation not
prInted
1 Heat path
calculation prInted
in output report
Stop option XoptionFlagIn InT 1(MISS) - Stop

calculation
2 - Continue
calculations with no
reaction
3 - Add makeup for
limiting reactant
4 - Reduce
conversion
Pressure flag PressureFlagIn 1 - Reactor

pressure drop
given
2 - Reactor outlet


Units

pressure given
Pressure drop ReactorPresDropIn PDIF Real
Outlet pressure OutPresIn PRES Real
Input conversion ConvBasisFlagIn InT 1 - Feed based

basis conversion
2 - Reaction based
conversion
Reaction type RxTypeIn InT 0 User specified

reaction set
1 - Shift reaction
2 Methanation
reaction
Reaction set RxnSetID RxnS

selected et ID
Number of reactions NumberOfReactions InT

in the selected set
Reaction ids RxnID 0 to NR

-1
Reaction component BaseCompID 0 to NR CID Char NR =

base -1 NumberOfReaction
s
User supplied ConvCoeffIn 0 to Real

conversion 3*NR -1


Units

coefficients
Temperature basis 0 to NR - 1 0 to NR Char

for conversion -1
coefficients
Conversion Reactor Define Stoichiometry, Class = Define
Number of NumberOfComponen InT (Not available in v5.61)

components in ts
simulation
CompID 0 to CID Char (Not available in v5.61)

NC-1
Stoichiometry StoiCoefIn 0 to NC =
Coefficients actually
NC *
used
NR -1 NumberOfComponents*
NR =
NumberOfReactions
Index =
NOC *( j - 1) + i -1
i = component number
j = reaction number
* To obtain NOC, execute the GetObjectCount method on object CompIn.

For example: NOC = P2File.GetObjectCount(CompIn)
Primary Unit for PriUnitID Unit ID Contains Calculator


Units

Define UID
Starting element PriVectorVatEntry Int Contains starting

element for
stoichiometry
Table B.18B Conversion Reactor Unit Operation Calculated

Properties
ConReactor Calculated Properties
Thermal Conditions, Class = ConReactor
TEM Real
Inlet temperature RxIntemp P
TEM Real
Outlet temperature OutTempCalc P
Inlet pressure RxInPres PRES Real
Outlet pressure OutPresCalc PRES Real
ReactorPresDropCalc PDIF Real

Calculated pressure

Properties

drop
Duty AdiaDutyCalc DUTY Real
Total heat of ENTH Real

reaction HeatOfReaction
Negative component NegCompFlag Int 0 No negative

rate flag components
1 Negative
component rate
detected
Number of reactions NumberOfReactions Int
Calculated CalcConversions 0 to Real NR =

conversions NR - 1 NumberOfReaction
s
Base component BaseCompNumbers 0 to Int

number NR - 1
Base component BaseCompID 0 to Strm Char

name NR - 1 ID
Amount of base BaseCompRxnRates 0 to Real

component reacted NR - 1
Conversion basis ConvBasisFlag 1 - Feed based

flag conversion
2 - Reaction based
conversion

Properties
Reference Conditions, Class = ConReactor
Reference RefTemp TEM Real

conditions P
temperature for heat
of reaction
calcultations
Reference RefPhaseFlag Int 1 vapor

conditions phase
2 liquid
Feed reference RefFeedISN Strm Char

conditions stream ID
Feed reference RefFeedPres PRES Real

condition pressure
Feed reference RefFeedEnthalpy ENTH Real

condition enthalpy
Product reference RefProdISN Strm Char

conditions stream ID
Product reference RefProdPres PRES Real

condition pressure
Product reference RefProdEnthalpy ENTH Real

condition enthalpy
Base component for HeatOfRxnBaseComp 0 to Int NR =

heat of reaction NR - 1 NumberOfReaction
s

Properties
Reference HeatOfRxnRefTemp 0 to Real

temperature for heat NR - 1
of reaction
Merged Streams, Class = ConReactor

containing feed
conditions
Feed stream FeedEnthalpy Enth Real

enthalpy

containing product
conditions
Product stream ProdEnthalpy Enth Real

enthalpy
Temperatur Temperature TEM Real

e P

Properties
Table B.19A Gibbs Reactor Unit Operation Input Data

Class = Gibbs
Gibbs Input Data
Feeds, Class = Gibbs
Feed StreamIDs FeedData 0 to Strm NF=CurrentFeeds

NF-1 ID
Products, Class = Gibbs


NP-1 ID s
Product stream ProductStoreData 0 to Int 0-Unspecified

phases NP-1
1-Vapor 2-Liquid
3-Solid 4-Mixed
Operating Conditions, Class = Gibbs
Flag for form of input PressureFlagIn Int 1 - Pressure Drop

pressure (DP) given
2 - Pressure given
Flag for form of input PressDropFlag Int 0 User specified

pressure pressure
1 Pressure Drop
(DP) given.
User supplied reactor OutPressIn PRES Real

outlet pressure
User supplied reactor PressDropIn PDIF Real

pressure drop
Elimination criterion DropPhaseIn Real

Of a fluid phase
Reactor operation OperFlagIn Int 1 User specified

flag temperature
2 Adiabatic
3 Feed
temperature

Reactor temperature OutTempIn TEMP Real
Allowed maximum MaxTempIn TEMP Real

temperature
Allowed minimum MIntempIn TEMP Real

temperature
Global Temperature GlobalTempApprIn TDIF Real

Approach
Duty DutyIn DUTY Real
PrInt flag PrIntPathFlagIn Int 1 = PrInt heat

balance
Reactor Data, Class = Gibbs
Maximum iteration MaxIterIn Int

allowed
Iteration number StartTrialIn Int

before
Start of phase split
trial
Frequency of phase TrialFreqIn Int

split trial
Convergence ConvergeTolerIn Real

tolerance

Convergence FibboTolerIn Real

tolerance for
Fibonacci search
Product estimate flag ProdEstimFlagIn Int 0 PRO/II default

initial estimate
1 Average of all
feeds
2 User estimate
(use values given by
the REACTANTS
entry on the
ELEMENT
statement
Physical property ThermoUpdateFgIn Int 0 Use values from

Evaluation option previous iteration
1 Reevaluate
values at each step
of the search
Reaction Definitions, Class = Gibbs
Element Names ElementNames 0 to NE - Char NE Number of

1 element groups

Operating phase flag RXNPhaseFlagIn Int 1 Vapor
2 Liquid
3 - Vapor Liquid
4 Liquid Liquid
5 Vapor Liquid
Liquid
6 Calculated
(Default)
Guessed phase GuessPhaseIn Int 1 Vapor

when phase is 2 Liquid
unknown
3 - Vapor Liquid
(Default)
4 Liquid Liquid
5 Vapor Liquid
Liquid
6 Calculated
Phase keyword flag PhaseSpecifiedFg Int 0 Phase is

specified
1 phase is not
specified.
In GUI, always
equal to "1".
Individual reaction RxnTempApprIn 0 to NR - TE Real NR = number of

1 MP reactions
Temperature
approach

Component reaction CompReactantFlag 0 to NOC = Number of

flag NOC-1
Components
0 Not Participate
in reaction
1 Participate in
reaction
Component Index ID CompID 0 to Int NOC = Number of

NOC-1
Components
Element coefficient ElementMatrixIn 0 to Real MASIZE = Element

matrix. stored as MASIZE Matrix size.
(element group,
component ID)
Each column stores
the value of each
element group based
on which a
participating
component is
constituted.
Individual reaction RxnTempApprIn 0 to Real NRXN Number of

temperature NRXN - reactions
approach 1
Input individual RxnExtentIn 0 to Real NRXN Number of

reaction extent NRXN - MR reactions
1 AT
Amount of fixed FixCompMoleIn 0 to Real NOC = Number of

component NOC-1 MR Components
AT

Product estimate ProdRateEstimIn 0 to MR Real NOC = Number of

NOC-1 AT Components
Fixed-amount FixMassCompIn 0 to Int NOC = Number of

component ID NOC-1
Components
Unit flag for fixed- FixedMassUnitIn 0 to Int NOC = Number of

amount components NOC-1 Components
-1 Percentage
0 Weight 1-
Mole
Component ID for RxnExtentCompIn 0 to Int NRXN Number of

reaction extent reactions
NRXN -
specification
1
Unit type for reaction RxnExtentBasisIn 0 to Int NRXN Number of

extent specification reactions
NRXN -
1 0 Weight 1-
Mole
Unit type for product ProdEstimBasisIn 0 to Int NOC = Number of

flow rate estimate Components
NOC-1
0 weight 1-
Mole
Reaction set number RxnSetNumber Int
Reaction RxnStoichFlag Int 0 No stoichiometry

stoichiometry data data
source flag
1 From reaction
data section

Number of NumOfRxnComp Int

components
Reaction Internal RxnID 0 to Int NRXN Number of

number for specified reactions
NRXN -1
reactions
Number of stoich NumRxn Int

reactions
Number of element NumElement Int

groups either from
user input or from
call of DTNELM.FOR
Maximum number of MaxFluidPhaseNo Int The value is determined

fluid phases by "RXNPhaseFgIn".
If "1" or "2"--> value =1
"3" or "4" --> value = 2
"5" or "6" --> value = 3
IMISS --> value = 3
Flag for Element ElemtGroupFlag Int 0 = Element composition

composition not provided
1 = Element composition
provided by the user.

Table B.19B Gibbs Reactor Unit Operation Calculated
Properties
Property Attribute Index Units Type Description
Class = Gibbs
Gibbs Calculated Properties
Calculated reactor OutPressCalc PRES Real

outlet pressure
Calculated reactor PressDropCalc PDIF Real

pressure drop
RXNPhaseFlag Real
Calculated Phase Calc
Phase type PhaseTypeVect 0 to Real NPH = Maximum no

or of fluid phases
NPH -
1 1 - Vapor 2 - Liquid
Operating phase RXNPhaseFlag Int

flag calculated Calc
Guessed phase GuessPhaseCal Int

when phase is c
unknown
(calculated)
Elimination criterion DropPhaseCalc Real

Of a fluid phase
Initial split ratio for PhaseSplitRatio Real

phase split trial Est
Reactor operation OperFlagCalc Int

flag calculated

Properties
Reactor temperature OutTempCalc TEMP Real

calculated
Allowed maximum MaxTempCalc TEMP Real

temperature
calculated
Allowed minimum MIntempCalc TEMP Real

temperature
calculated
Global Temperature GlobalTempApp TDIF Real

Approach calculated rCalc
Individual reaction RxnTempApprC 0 to TEMP Real NR = number of

Temperature alc NR - 1 reactions
approach calculated
Calculated duty CalcDuty DUTY Real
Merged stream feed FeedTemp TEMP Real

temperature
Merged stream feed InletPress PRES Real

pressure
Total heat of TotalHOR DUTY Real

reaction generated.
Reference state HORRefTemp TEMP Real

temperature for
Heat of reaction

Properties
Flash tolerance FlashTolerance Real
Dimensionless free GRT Real

energy (G/RT)
Elimination criterion DropPhaseCalc Real

of a fluid phase
Initial split ratio for PhaseSplitRatio Real

phase split trial Est
Reactor Data, Class = Gibbs
Unit ID UnitID Char
Maximum iteration MaxIterCalc Int

allowed
Iteration number StartTrialCalc Int

before Start of
phase split trial
Frequency of phase TrialFreqCalc Int

split trial
Convergence ConvergeTolerC Real

tolerance alc
Convergence FibboTolerCalc Real

tolerance for
Fibonacci search
Gibbs energy FibonacciFlag Int 0 = "Interval Search"

minimization search
1 = "Fibonacci

Properties

method. Search"
Fugacity override FugacityOverrid Int

flag eFg
Product estimate ProdEstimFlagC Int 0 PRO/II default initial

flag alc estimate
1 Average of all feeds
2 User estimate (use
values given by the
REACTANTS entry
on the ELEMENT
statement
Physical property ThermoUpdateF Int 0 Use values from

Evaluation option gCalc previous iteration
1 Reevaluate values at
each step of the
search
Step change factor StepChangeLimi Real

for X lambda update t
Convergence record YvalueRecord Real

(Y) at adiabatic
conditions.
Convergence record XvalueRecord Real

(X) at adiabatic
conditions
Feed stream FeedAtRefer Int

number at
Reference

Properties

conditions
Product stream ProdAtRefer Int

number at
Reference
conditions
Calculated phase CalcFluidPhase Int

number No
Reaction Definitions, Class = Gibbs
Element coefficient ElementMatrixC 0 to Real MSIZE = Global

matrix. stored as alc component number
MSIZE
times element
(element group,
number
component ID)
Each column stores
the value of each
element group
based on which a
participating
component is
constituted.
Individual reaction RxnTempApprC 0 to TEMP Real NRXN Number of

temperature alc NRXN reactions
approach -1
Input individual RxnExtentCalc 0 to Real NRXN Number of

reaction extent NRXN MRAT reactions
-1
Amount of fixed FixCompMoleC 0 to Real NRXNC = No of

component alc MRAT reacting
NRXN
components in each
C -1

Properties

reaction
Maximum number of MaxReactant Int

reactants in each
reaction (not used).
Stored as "1" if no
reaction has been
specified.
Product estimate ProdRateEstim 0 to MRAT Real NRXNC = No of

Calc reacting
NRXN
components in each
C -1
reaction
Fixed-amount FixMassCompC 0 to Int NRXNC = No of

component ID alc reacting
NRXN
components in each
C-1
reaction
Unit flag for fixed- FixedMassUnitC 0 to Int NRXNC = No of

amount components alc reacting
NRXN
components in each
C-1
reaction
Component ID for RxnExtentComp 0 to Int NRXN Number of

reaction extent Calc reactions
NRXN
specification
-1
Unit type for RxnExtentBasis 0 to Int NRXN Number of

reaction extent Calc reactions
NRXN
specification
-1 0 Weight 1 -
Mole
Unit type for product ProdEstimBasis 0 to Int NRXNC = No of

flow rate estimate Calc reacting
NRXN
components in each

Properties

C -1 reaction
0 weight
1 - Mole
Stoichiometric StoichRxnMatrix 0 to Real NRXGLO = Stoich.

matrix for matrix size
NRXGLO -1
Coefficients.
Stored as data pairs: (Component stoich coefficient,reaction number).

Each column stores the stoichiometric coefficients of each participating
component in a particular reaction.
Holds feed VECB 0 to Real NRXNC = No of

composition reacting
NRXNC -1
components in each
reaction
Component order GibbCompOrder 0 to Int NRXNC = No of

for Gibbs variables reacting
NRXNC -1
components in each
reaction
Phase type PhaseTypeVect 0 to Int NUMPHS = Max no.

or of fluid phase
NUMPHS-1
1 = Vapor
2 = Liquid
Kvalue method flag FugacityMethod 0 to Int NRXNC = No of

reacting
NRXNC -1
components in each
reaction
Number of reactions NumOfRxnExte Int

with Extent nt

Properties

specification.
No. of comps with NumFixedMass Int

fixed rates
Number of fixed NumFixCompDe Int

components riv
including inerts
Derived component DerivCompReac 0 to Int NRXNC = No of

reaction flag. tFg reacting
NRXNC-1
components in each
reaction
1. If Stoich data is specified then flag = 1 for specified

components Else flag = 0
2. Else If element reactant is specified then flag = 1 for
specified components Else flag = 0
3. Else If element composition is specified then flag = 1 for
specified components
Else flag = 0
Compact StoichRxnID 0 to NRXGLO Char NRXGLO - Stoich.

stoichiometry matrix -1 matrix size
for reactant ID (compact)
Copied from Reaction Data section. Stored as (component ID,

reaction). Each column stores the component ID of each
participating component in a particular reaction.
Adiabatic error flag AdiabaticErrorFla Int

g
Phase error flag PhaseErrorFlag Int

Properties
Heat Balance FLAG NoHeatBalanceF Int

lag
Merged Streams, Class = Gibbs
Internal stream MergedFeed Strm ID Char

containing feed
conditions
Internal stream MergedProduct Strm ID Char

containing product
conditions
Enthalpy TotalMolarEnthal ENTH Real

py
Entropy TotalMolarEntrop ENTR Real

y
All standard stream properties like Mole Fractions, Weight Fractions of various
phases are accessible via the standard Stream Class. See Table 3-1.

Table B.20A Equilibrium Reactor Unit Operation Input
Data
Class = EquReactor
EquReactor Input Data

Feeds, Class = EquReactor
Number of feeds CurrentFeeds Integer
Feed StreamIDs FeedData 0 to Strm ID NF=CurrentFeeds

NF-1
Products, Class = EquReactor
Number of products CurrentProducts Integer
Product StreamIDs ProductData 0 to Strm ID NP=CurrentProducts

NP-1
Product stream ProductStoreData 0 to Integer 0-Unspecified

phases NP-1
1-Vapor 2-Liquid
3-Solid 4-Mixed
Equilibrium Reactor Conditions, Class = EquReactor
Reactor Operation RxOperTypeIn Int 1 - Fixed outlet

Type temperature
2 - Fixed duty
3 - Temperature rise

Data
Class = EquReactor
Shift/Methanator flag RxType 0 User specified

stoichiometry
1 Shift reactor
2 Methanator reactor
Outlet temperature IsoDTFeedIn TDIF Real

delta above feed
Outlet temperature OutTempIn TEMP Real
Duty ReactorDutyIn DUTY Real
Maximum TEMP Real

temperature AdiaTmaxIn
Minimum AdiaTminIn TEMP Real

temperature
Reaction phase RxOperPhaseFlag Int 1 Vapor phase reaction

In
2 Liquid phase reaction
Heat balance flag HeatBalanceFlagI Int 1 - No heat balance

n otheise - perform heat
balance
Flag for prInting the PrIntPathFlagIn Int 0 Heat path calculation

heat of reaction path not prInted
1 Heat path calculation
prInted in output report
Pressure flag PressureFlagIn Int 1 - Reactor pressure drop

Data
Class = EquReactor
given
2 - Reactor outlet
pressure given
Pressure drop ReactorPresDropI PDIF Real

n
Outlet pressure OutPresIn PRES Real
Reaction type RxTypeIn Int 0 User specified reaction

set
1 - Shift reaction
2 Methanation reaction
Reaction set selected RxnSetID RxnSet ID
Number of reactions NumberOfReactio Int

in the selected set ns
Reaction ids RxnID 0 to

NR -
1
Reaction component BaseCompID 0 to CID NR = NumberOfReactions

base NR 1
Char
Equilibrium EquilCoeff 0 to 7 Int

coefficients A
through H
Approach

Data
Class = EquReactor
Conversion Reactor Define Stoichiometry, Class = Define
Number of NumberOfCompo Int (Not available in v5.61)

components in nents
simulation
CompID 0 to NC- CID (Not available in v5.61)

1
Char
Stoichiometry StoiCoefIn 0 to Int NC = NumberOf

Coefficients actually Components*
NC*NR
used
-1 NR = NumberOf
Reactions
Index = NOC *( j - 1) + i -1
i = component number
j = reaction number
* You can obtain the NOC by executing the GetObjectCount method on object
CompIn. For example: NOC = P2File.GetObjectCount(CompIn)
Primary Unit for PriUnitID Unit ID Contains Calculator

Define UID
Starting element PriVectorVatEntry Int Contains starting element

for stoichiometry

Table B.20B Equilibrium Reactor Calculated Properties
Class = EquReactor
EquReactor Calculated Properties
Thermal Conditions
Inlet temperature RxIntemp TEMP Real
Outlet temperature OutTempCalc TEMP Real
Inlet pressure RxInPres PRES Real
Outlet pressure OutPresCalc PRES Real
Calculated pressure ReactorPresDropC PDIF Real

drop alc
Duty AdiaDutyCalc Duty Real
Total heat of reaction HeatOfReaction ENTH Real
Negative component NegCompFlag Int 0 No negative

rate flag components
1 Negative
component rate
detected
Reference Conditions, Class = EquReactor
Reference conditions RefTemp TEMP Real

temperature for heat of
reaction calcultations
Reference conditions RefPhaseFlag Int 1 vapor

phase
2 liquid

Class = EquReactor
Feed reference RefFeedISN SID Char

conditions stream
Feed reference RefFeedPres PRES Real

condition pressure
Feed reference RefFeedEnthalpy ENTH Real

condition enthalpy
Product reference RefProdISN SID Char

conditions stream
Product reference RefProdPres PRES Real

condition pressure
Product reference RefProdEnthalpy ENTH Real

condition enthalpy
Base component for HeatOfRxnBaseCo 0 to Int NR =

heat of reaction mp NR - 1 NumberOfReactions
Reference temperature HeatOfRxnRefTem 0 to Real

for heat of reaction p NR - 1
Merged Streams, Class = EquReactor

containing feed
conditions
Feed stream enthalpy FeedEnthalpy Enth Real

Class = EquReactor

containing product
conditions
Product stream ProdEnthalpy Enth Real

enthalpy
All standard stream properties like Mole Fractions, Weight Fractions of various phases
are accessible via the standard Stream Class. See Table: 3-1
Number of reactions NumberOfReaction Int

s
Calculated conversions CalcConversions 0 to Real NR =

NR - 1 NumberOfReactions
Base component BaseCompNumber 0 to Int

number s NR - 1
Base component name BaseCompID 0 to SID Char

NR - 1

Class = EquReactor
Amount of base BaseCompRxnRat 0 to Real

component reacted es NR - 1
Conversion basis flag ConvBasisFlag Int 1 - Feed based

conversion
2 - Reaction based
conversion
Table B.21A Batch Distillation Unit Operation Input Data

Read an attribute: BatchDistil Object.GetAttribute(AttributeName, Index)
Write an attribute: BatchDistil Object.PutAttribute(AttributeName, Index)
Class = BatchDistil
BatchDist Input Data

Column and Calculation parameters, Class = BatchDistil
Number of trays NumColumnTrays Int Number of column

trays input
Indicator for upper UpperVesselIndicator Int 0 = not present, 1 =

vessel Present
Number of trays in NumUpperColumnTra Int Number of trays in

upper column ys upper column

Class = BatchDistil
Total number of NumStagesInput Int Total number of

stages stages - input
Update Interval for EnergyBalUpdIntvlInp TIME Real Update Interval for

Energy balance scalar EB - input
Tray efficiency TrayEfficFlag Int 1 No tray

method scalar efficiency
2 Murphree
efficiency
3 Equilibrium
efficiency
4 Vaporization
efficiency
Tray thermo method VlleTrayMethod Int Tray thermo

method
Thermo method flag ColThermoMethod Int Column thermo

method
Efficiency input code EffFlg Int 0 none,

1 TEFF,
2 - CEFF,
3 Both TEFF &
CEFF
Component CompEff1 Real Vectors of

efficiency vector component
efficiencies - set 1

Class = BatchDistil
Tray efficiency TrayEfficiency Real Tray efficiency

vector vector
Maximum number of VlleCheckMaxNewTra Int Default = No. of

VLLE stages ys trays
Component ID set 1 CompIdsCEffic1 Int Vector of comp IDs

Vector for component
efficiency set 1
Tray numbers for TrayNumsCEffic1 Int Vector of tray

efficiency Vector numbers for
component
efficiency set 1
Efficiency factor TrayEfficiencyFactor Real efficiency factor for

scalar tray efficiencies
Number of tray comp NumOfCompEfComps Int

efficiency Set1 scalar
components - set
Number of tray comp NumOfCompEffTrays Int

efficiency trays - set 1 scalar
1
Feed data,Class = BatchDistil
Number of CurrentFeeds Int Number of feeds

feeds
Feed FeedData 0 to Stream N=CurrentFeeds

StreamIDs N -1 ID

Class = BatchDistil
Products data, Class = BatchDistil
Number of CurrentProdu Int Number of

products cts products
Product StreamIDs ProductData 0 to Strm N=

N-1 ID CurrentProducts
VLLE check for VllecondenserCheck Int

condenser product
VLLE check flag ThermoClassVLLEFlg Int 0 No VLLE,

1 - VLLE
Flag to check phase VlleTrayChkFlag Int Flag to check

split on a tray with Vector phase split on a
condenser thermo tray with condenser
thermo
Product definition ProdDefinition Int 1 - Heel,

vector Vector
2 Accumulator,
3 - Overhead
Equimolal-overflow EquiMolOverflowFlag Int 1 = Specified,

flag
2 = not specified

Class = BatchDistil
Condenser Specifications,Class = BatchDistil
Condenser Option CondenserTypeInput Int 1 = Partial,

2 = Mixed,
3 = Bubble,
4 = fixed temp,
5 = DTBB
Condenser HX check CondHXCheck Int
Tube passes CondHXTubePassIn Int Tube Passes of Hx

used as Condenser
Shell passes CondHxShellPassIn Int Shell Passes of Hx

used as Condenser
Condenser thermo ConThermoMethod Int

method
Condenser CondenserTemperatu TEMP Real Input condenser

temperature re scalar temperature
Condenser limiting CondVapFracLimInput FRAC Real Input condenser

vapor fraction scalar limiting vapor
fraction
Condenser CondenserTempDrop TDIF Real condenser

temperature drop scalar temperature drop -
Input
Condenser pressure CondenserPressure PRES Real Condenser

scalar pressure - Input

Class = BatchDistil
Condenser holdup CondenserHoldup Real condenser holdup -

scalar Input
Condenser area CondHxAreaIn AREA Real Area of Hx used as

scalar Condenser - Input
U Value for CondHxUvalueIn HTCO Real U Value of Hx used

Condenser scalar as Condenser
Ft Factor of CondHxFtFactorIn Real Ft Factor of Hx

Condenser scalar used as Condenser
condenser HX HxConvergeTol Real condenser HX

tolerance scalar tolerance
condenser holdup CondensL1Holdup Real condenser holdup

Liquid L1 scala Liquid L1
condenser holdup CondensL2Holdup Real condenser holdup

Liquid L2 scalar Liquid L2
Reboiler Specifications,Class = BatchDistil
Reboiler HX check ReboilHXCheck Int
Check for Heat ReboilerSpecFlag Int Index: check for

media spec Vector Heat media spec
Stream reference for ReboilerStreamRef Int Stream reference

reboiler charge Vector (StreamID) for
reboiler charge
Area of Reboiler ReboilHxAreaIn AREA Real Area of Hx used as

scalar Reboiler

Class = BatchDistil
U Value of Reboiler ReboilHxUvalueIn HTCO Real U Value of Hx used

scalar as Reboiler
Reboiler HX ReboilConvergeTol Real Reboiler HX

tolerance scalar tolerance
Rate of reboiler utility ReboilerRateIn Real Rate of reboiler

vector utility - Input
Reboiler fluid ReboilerPressDpIn PDIF Real Reboiler fluid

pressure drop vector pressure drop -
Input
Thermo method ID StageThermoMethodI Int Thermo method ID

for ending stage n Vector for ending stage
Pressure profile data, Class = BatchDistil
Top tray pressure TopTrayPressure PRES Real Top tray pressure -

scalar Input
Stillpot pressure StillpotPressure PRES Real Stillpot pressure -

scalar Input
Pressure drop per PressureDropPerStg PDIF Real pressure drop per

stage scalar stage - Input
Pressure drop per PressureDropPerColu PDIF Real pressure drop per

column scalar column - Input
Stage pressures StagePressures PRES Real Stage Pressures

vector (top down) -
pressure values

Class = BatchDistil
Stage liquid holdup specifications,Class = BatchDistil
Tray holdup TrayHoldup Real tray holdup - Input

scalar
UOM basis for HoldupBasisInp Int 1 = Molar, 2 =

holdups Weight, 3 = Liquid
volume
Stage Holdups StageHoldups Real Stage Holdups (top

vector down) - holdup
values
Stop criteria data,Class = BatchDistil
Number of triggers in NumOfStopTriggers InT Number of triggers

STOP statements scalar in STOP
statements
Maximum time stop MaxTime TIME Real maximum time stop

criterion scalar criterion
Minimum charge MinChargeFractionInp FRAC Real Minimum charge

fraction stop criterion scalar fraction stop
criterion-input
Stop trigger values StopTrigValue Real

vector
Policy ID StopChgFracGoPSInp Int Policy segment ID

Vector for GOTO
associated with
STOP CHGFRAC

Class = BatchDistil
Stop trigger basis StopTrigBasisInp Int 1 = Molar, 2 =

Vector Weight, 3 = Liquid
volume
UOM basis for ChgFracBasisInp Int 1 = Molar, 2 =

change fraction Weight, 3 = Liquid
volume
Policy ID StopTrigGoPolSegInp Int Policy segment ID

Vector for GOTO
associated with
stop trigger
Stop trigger type StopTrigType Int 4 Amount,

Vector
5 Fraction,
6 Percent,
7 PPM,
8 - Temperature
Stop trigger location StopTrigLocation Int 1 Pot,

index Vector
2 top vapor,
3 inst. Distillate,
4 - accumulator
Stop trigger StopTrigCompIndex Int

component index Vector
Stop trigger 2nd StopTrigCompIndex2 Int

component index Vector
Stop trigger StopTrigApproach Int 1 from either

Class = BatchDistil
approach direction Vector direction,
2 from above
3 from below
Snapshot specifications,Class = BatchDistil
Snapshot data flag SnapInterdataFlag Int Flag for creating

file for snapshot
Intermittant data
Policy ID flag SnapdataPolicyID Int Policy ID for which

Snapshot data is
selected - input
Storage type flag SnapTypeFlag Int Flag for tpye of

storeage for
snapshot(average/
end of policy)
Data file name DataFileName Int File name for data

access of trend
and snap shots
Time to begin saving DataTimeStart TIME Real Time to begin

scalar saving
Time to end saving DataTimeEnd TIME Real Time to end saving

scalar
Frequency to end DataTimeFreq TIME Real Frequency to end

saving scalar saving
Names of the input SaveObjNameIn Int Names of the input

save objects Vector save objects

Class = BatchDistil
Trend graph flag TrendInterdataFlag Int Flag for creating

file for trend graph
Intermittant data
Operational Policy data,Class = BatchDistil
Number of policy NumOfPolicySegment Int Number of policy

segments s scalar segments
Policy segment ID PolSegID Int Policy segment ID

Vector
Policy segment PolSegSequenFlag Int 0 - not sequential,

sequential flag Vector
1 - sequential
Policy segment use PolSegUseInp Int 1 = Single, 2 =

indicator Vector Multiple
Policy ID PolStartWithSegID Int Policy segment ID

Vector for WITH
associated with
policy START
Policy ID PolStartPendedSegID Int Policy segment ID

Vector for PENDED
associated with
policy START
Policy start incidence PolStartIncidence Int

matrix Vector
Position of first PolStartTriggerOff Int Position in policy

trigger Vector start trigger vector
of first trigger for
given policy

Class = BatchDistil
segment
Number triggers in NumOfStartTriggers Int Number triggers in

POLICY STARTs scalar POLICY STARTs
Start trigger basis StartTrigBasisInp Int 1 = Molar,

Vector
2 = Weight,
3 = Liquid volume
Start trigger values StartTrigValue Real

vector
Start trigger type StartTrigType Real 2 time,

vector
4 Amount,
5 Fraction,
6 Percent,
7 PPM,
8 - temperature
Start trigger location StartTrigLocation Real 1 Pot,

index vector
2 top vapor,
3 inst. Distillate,
4 - accumulator
Start trigger StartTrigCompIndex Real

component index vector
Start trigger 2nd StartTrigCompIndex2 Real


Class = BatchDistil
Start trigger StartTrigApproach Real 1 from either

approach direction vector direction,
2 from above
3 from below
Start trigger policy StartTrigPolSeg Real Policy segment

segment vector (psn) in which start
trigger occurs
Ordinal number of StartTrigSeqInPol Real

start trigger in policy vector
segment
Total number of NumOfCharges Int Total number of

charges scalar charges
Charge Type ChargeType Int 1 Only amount

Vector given,
2- Only rate given,
3 Amount and
rate given,
4 Amount and
duration given
5 rate and
duration given
Charge incidence ChargeIncidence Int

matrix Vector
Charge ID ChargeIDInp Int Charge ID - input

Vector

Class = BatchDistil
Stream reference for ChargeStreamRef Int Stream reference

charge Vector (StreamID) for
charge
Destination stage ChargeStage Int Destination stage

number for charge Vector number for charge
Charge amount UOM ChargeAmountBasisIn Int 1 = Molar,

basis p Vector
2 = Weight,
3 = Liquid volume
Charge rate UOM ChargeRateBasisInp Int 1 = Molar,

basis Vector
2 = Weight,
3 = Liquid volume
Amount of charge ChargeAmount Real

vector
Rate of charge ChargeRateInput Real Rate of charge -

vector input
Charge duration ChargeDurationInput TIME Real Charge duration -

vector input
Total number of NumOfDraws InT Total number of

draws scalar draws

Class = BatchDistil
Draw Type DrawType Int 1 Only amount

Vector given,
2- Only rate given,
3 Amount and
rate given,
4 Amount and
duration given
5 rate and
duration given
Product stream DrawProdStreamRef Int Product stream

reference for draw Vector reference
(StreamID) for
draw
Source stage number DrawStageInp Int Source stage

for draw Vector number for draw -
input
Draw amount UOM DrawAmountBasisInp Int 1 = Molar,

basis Vector
2 = Weight,
3 = Liquid volume
Draw rate UOM basis DrawRateBasisInp Int 1 = Molar,

Vector
2 = Weight,
3 = Liquid volume
Draw incidence DrawIncidence Int

matrix Vector

Class = BatchDistil
Flag for draw from DrawAccumFlag Int 0 not specified,

accumulator Vector
1 - specified
Amount of draw DrawAmount Real Amount of draw

vector
Rate of draw DrawRateInput Real Rate of draw -

vector input
Draw duration DrawDurationInput TIME Real Draw duration -

vector input
Number triggers in NumOfRunUntlTrigger Int Number triggers in

POLICY RUNUNTILs s scalar POLICY
RUNUNTILs
Rununtil trigger basis RunuTrigBasisInp Int 1 = Molar,

Vector
2 = Weight,
3 = Liquid volume
Policy ID RunuTrigGoPolSegIn Int Policy segment ID

p Vector for GOTO
associated with
rununtill trigger

Class = BatchDistil
Rununtil trigger RunuTrigValue Real

values vector
Rununtil trigger type RunuTrigType Int 2 time,

vector
3 - DTIME
4 Amount,
5 Fraction,
6 Percent,
7 PPM,
8 - temperature
Rununtil trigger RunuTrigLocation Int 1 Pot,

location index vector
2 top vapor,
3 inst. Distillate,
4 - accumulator
Rununtil trigger RunuTrigCompIndex Int

Rununtil trigger 2nd RunuTrigCompIndex2 Int

Rununtil trigger RunuTrigApproach Int 1 from either

approach direction vector direction,
2 from above
3 from below

Class = BatchDistil
Policy segment (psn) RunuTrigPolSeg Int

in which rununtil vector
trigger occurs
Ordinal number of RunuTrigSeqInPol Int

rununtil trigger in vector
policy segment
RunUntil incidence RunUntilIncidence Int

matrix vector
UOM for top vapor TopVapRateUOMBasi Int 1 = Mole, 2=

rate s Vector WT,
3 = LV, 4 = GV
UOM for ditillate DistilRateUOMBasis Int 1 = Mole, 2=

Vector WT,
3 = LV, 4 = GV
Number of specs in NumOfPolDistillSpecs Int Number of specs in

POLICY DISTILLs scalar POLICY DISTILLs
Distill occurrence DistilOccurrence Int 0 not present,

vector Vector
1 - present
Distill incidence DistilIncidence Int

matrix Vector

Class = BatchDistil
Distill spec type DistilSpecType Int 1 top vapor rate

Vector
2 distillate rate
3 reflux ratio
4 prInt Interval
5 step size
6 max. step size
7 error tolerance
8 liquid1 dist.
Rate
9 liquid2 dist.
Rate
10 liquid1 reflux
ratio
11 liquid2 reflux
ratio
Distill spec values DistilSpecValue Real Distill spec values

vector
Controller incidence ControllerIncidence InT 0 not specified

flag Vector
1 - specified
Controller spec UOM ControlSpecBasisInp Int 1 = Molar,

basis Vector
\2 = Weight,
3 = Liquid volume

Class = BatchDistil
Controller - stage for ControlStage Int Controller - stage

specified variable Vector for specified
variable
Controller component ControlCompNums Int Controller

number codes Vector component number
codes
Controller component ControlCompNumInci Int

number incidence d Vector
Controller vary type ControlVaryType Int 1 = reflux ratio, 2 =

Vector distillate rate
Controller spec type ControlSpecType Int 1 Temperature

Vector
2 DTEMP
3 Fraction
4 Percent
5 - PPM
Specified value for ControlSpecValue Real Specified value for

controller vector controller
Controller - min. ControlMinVary Real Controller - min.

value for varied vector value for varied
variable variable

Class = BatchDistil
Controller - max. ControlMaxVary Real Controller - max.

value for varied vector value for varied
variable variable
Controller gain ControllerGainInp Real Controller gain -

vector input
Number of NumOfControllerCnos Int Number of

comp.numbers in scalar comp.numbers in
controller specs controller specs
Check for coolant CoolantSpecFlag Int Index: check for

spec Vector coolant spec
Stream reference for CoolantStreamRef InT Stream reference

Coolent charge Vector (StreamID) for
Coolent charge
Rate of coolant CoolantRateIn Real Rate of coolant -

vector input
coolant Pressure CoolantPressDpIn PDIF Real coolant Pressure

drop vector drop - input
UOM for cooling CoolantstrmBasis Int 1 = Mole, 2=

stream Vector WT,
3 = LV, 4 = GV
UOM for heating HeatingstrmBasis Int 1 = Mole, 2=

stream Vector WT,
3 = LV, 4 = GV

Class = BatchDistil
Product ID EndcutProduct Int Product stream

Vector reference (Stream
ID) for endcut
selection of Liquid EndcutLiqphase Int 0 = both L1 & L2,

phase for End cut Vector
1 = L1, 2 = L2
Endcut incidence flag EndcutIncidence Int 0 not specified

Vector
1 - specified
Policy segment ID for GoPolSegInput Int Policy segment ID

GOTO Vector for GOTO
Policy GoTo GoToIncidence Int 0 not specified

incidence flag Vector
1 - specified
Check for policy PressTimeCheck Int Index: check for

pressure time Vector policy pressure
time
Check for policy IndexSegPress Int Index: check for

pressure Vector policy pressure
condenser pressure CondenserPolyPress PRES Real condenser

for policy vector pressure for policy
top tray pressure for TopTrayPolyPress PRES Real top tray pressure
policy vector for policy
stillpot pressure for StillpotPolyPress PRES Real stillpot pressure for

policy vector policy
pressure drop per PolyPressDropPerStg PDIF Real pressure drop per

Class = BatchDistil
stage for policy vector stage for policy
pressure drop per PolyPressDropPerCol PDIF Real pressure drop per

column for policy vector column for policy
Stage Pressures - StagePOLYPressures PRES Real Stage Pressures

pressure values vector (top down) -
pressure values
Time for pressure PressTimePeriod TIME Real

change from the vector
previous policy value
Calculation method data,Class = BatchDistil
Integration method IntegMethodInp Int 1 = SIT, 2 =

indicator LSODA
Starting Integration IntegStepSizeInp Real starting Integration

step size scalar step size - input
Integration max. step IntegMaxStepSizeInp Real Integration max.

size scalar step size - input
Integration error IntrorTolInp Real Integration error

tolerance scalar tolerance - input
Liquid density calculation data,Class = BatchDistil
Liquid Density LiqDensityCalcInp Int 1 = rigorous,

Calculation Indicator
2 = shortcut

Class = BatchDistil
Reference RefTempForVolumeInp TEMP Real reference

temperature for scalar temperature for
volume calculations volume
calculations - input
Output options data,Class = BatchDistil
PrInt level PrIntLevelInput Int 1 = none,

2 = events,
3 = all
Time step (DTIME) PrIntTimeStep TIME Real time step for

for PRINT scalar PRINT
Start time for PRINT PrIntStartTime TIME Real start time for
scalar PRINT
End time for PRINT PrIntEndTime TIME Real end time for PRINT
scalar
Batch cycle time,Class = BatchDistil
Batch cycle time BatchCycleTime TIME Real batch cycle time -

scalar Input

Table B.21B Batch Distillation Unit Operation Calculated
Properties
Read an attribute: BatchDistil Object.GetAttribute(AttributeName,Index)
Write an attribute: BatchDistil Object.PutAttribute(AttributeName,Index)
Class = BatchDistil
BatchDistil Calculated Data
VLE/VLLE FLAG StageVLLEThermoM Int 1 VLE

eth vector
2 - VLLE
Number of liquid StageNumLiqPhases Int 1 one liquid

phases on tray vector Phase on tray
2 two liquid
phases on tray
Thermo method code StgThermoMethod Int

for each tray vector
Calculation method CalculationMethod Int 1 SURE, 2

scalar FAST, 3 IO, 4 -
EXDIST
Index of object SummaryObjInd Int

containing data for a vector
given summary
Index in given object SummaryIndInObj Int Index in a given

for time vector object for the time-
slice corresponding
to a given
summary
Total number of NumOfSummaries Int

summary (snapshot) scalar
reports

Properties
Class = BatchDistil
Index: calculation IndexCalcToInside Int

order to inside order vector
Index: inside order to IndexInsideToCalc Int

calculation order vector
Top vapor rate TopVaporRate Real current top vapor

scalar rate
Reflux ratio RefluxRatio Real current reflux ratio

scalar
Distillate rate DistillateRate Real current distillate

scalar rate
PrInt Interval PrIntInterval TIME Real current prInt

scalar Interval
Actual maximum ActualMaxTime TIME Real Actual max. time

simulation time scalar reached in
simulation
Condenser Tube CondHXTubePass Int Tube Passes of Hx

passes scalar used as Condenser
Condenser Shell CondHxShellPass Int Shell Passes of Hx

passes scalar used as Condenser
Condenser area CondHxAreaCalc AREA Real Area of Hx used as

scalar Condenser
U Value of Hx used CondHxUvalueCalc HTCO Real U Value of Hx used

as Condenser scalar as Condenser

Properties
Class = BatchDistil
Ft Factor of Hx used CondHxFtFactorCalc Real Ft Factor of Hx

as Condenser scalar used as Condenser
LMTD OF HX LmtdFactor TDIF Real LMTD OF HX

scalar
HX duty HxDuty DUTY Real HX duty

scalar
Area of Hx used as ReboilAreaCalc AREA Real Area of Hx used as

Reboiler scalar Reboiler
U Value of Hx used ReboilHxUvalueCalc HTCO Real U Value of Hx used

as Reboiler scalar as Reboiler
Reboiler LMTD factor ReboilLmtdFactor Real Reboiler LMTD

scalar factor
efficiency factor for TrayEffFactCalc Real efficiency factor for

tray efficiencies scalar tray efficiencies
Reboiler HX DUTY ReboilHxDuty DUTY Real Reboiler HX DUTY

scalar
Component TrayCompEffThird Real Component

efficiencies for vector efficiencies for
second methods second methods
Secondary tray TrayEffSecondary Real Secondary tray

efficiency vector efficiency
Rate of charge ChargeRate Real Rate of charge

vector

Properties
Class = BatchDistil
Charge duration ChargeDuration TIME Real Charge duration

vector
Rate of draw DrawRate Real Rate of draw

vector
Draw duration DrawDuration TIME Real Draw duration

vector
Time for summary SummaryTime TIME Real Time for a given

report vector summary
(snapshot) report
Final cumulative ChargeAmountFinal Real Final cumulative

amount used for vector amount used for
charge charge
Final cumulative ProductAmountFinal Real Final cumulative

amount sent to vector amount sent to
product product
Rate of coolant CoolantRate Real Rate of coolant

vector
coolant Pressure CoolantPressDp PDIF Real coolant Pressure

drop vector drop
Rate of reboiler utility ReboilerRate Real Rate of reboiler

vector utility
Reboiler fluid ReboilerPressDp PDIF Real Reboiler fluid

pressure drop vector pressure drop -
Input

Table B.22A Batch Reactor Unit Operation Input Data
Read an attribute: BatReactorObject.GetAttribute(AttributeName, Index)
Write an attribute: BatReactorObject.PutAttribute(AttributeName, Index)
Class = BatReactor
BatReactor Input Data

Feeds, Class = BatReactor
Number of CurrentFeeds Integer

feeds
Feed StreamIDs FeedData 0 to StrmID NF=CurrentFeeds

NF-1
Products, Class = BatReactor
Number of products CurrentProducts Integer
Product StreamIDs ProductData 0 to StrmID NP=CurrentProduct

NP-1 s
Product stream ProductStoreData 0 to Integer 0-Unspecified

phases NP-1
1-Vapor
2-Liquid
3-Solid
4-Mixed
Batch Reactor Conditions, Class = BatReactor
Reaction set number RxnSetNumIn Integer
Number of reactions NumOfRxn Integer

Kinetics Type KineticsTypeIn Integer 1 - Power Law

Model,
2 - User Added
Subroutine,
3 - In-Line
Procedure
Composition basis BasisForKineticsIn Integer 1 Concentration,

for kinetic rate
4 Liquid activity
Number of utilities NumOfUtilities Integer

specified
Flag for Integration IntMethodFlag Integer 1 - LSODA

method
Flag for All AllFlagIn Integer 0 No components,

components profile
1 All components,
2 Selected
components
Basis for BasisForConcProfIn Integer 1 Mole,

concentration profile
2 - Weight
Flag for policy prInt PolicyPrIntFlagIn Integer 1 Partial,

out
2 - Complete
Number of NumOfCompPrIntIn Integer

components for
concentration profile
Number of poInts for NumOfPntForProf Integer

profile prIntout

Number of policies NumOfPolicy Integer

specified
Local count of NumOfComp Integer

number of
components
User added kinetics IDATACount Integer

vec. len. IDATA
User added kinetics RDATACount Integer

vec. len. RDATA
User added kinetics SuppleCount Integer

vec. len. SUPPLE
user-added in-line ProcedureIDIn Integer

procedure number
user-added kinetics USKINIDIn Integer

subroutine number
Reaction number RxnNum Integer

Vector
Base component BaseCompIn Integer

number Vector
Index number of IndexNumOfComp Integer

component Vector
ID for user added KineticsIDIn Integer

kinectics Vector
Utility ID UtilityID Integer

Vector

Flag for utility type UtilityTypeFlag Integer 1 Water,

Vector
2 Air,
3 Refrigerant,
4 Steam,
5 heating medium
Component number UtilityCompNumIn Integer

for heating medium Vector
or refrugerant
IDATA entries for UserAddedIDATAIn Integer

user added kinetics Vector
Component number PrIntCompNumIn Integer

for concentration Vector
Policy ID PolicyID Integer

Vector
Policy analysis PolicyExecFlag Integer 1 Single,

execution flag Vector
2 - Multiple
Reactor flag on StartReactorFlag Integer

START statement Vector
Basis for variables on StartBasisFlagIn Integer 1 Mole,

START Vector
2 Weight,
3 - LV
Approach flag on StartApprFlagIn Integer 1 Either,

2 Above,
3 - Below

All/Any flag on StartAllAnyFlag Integer 1 Any,

2 - All
Starting component StartingCompNumIn Integer

numbe Vector
Ending component EndingCompNumIn Integer

number Vector
Trigger type on StartTriggerType Integer 1 Time,

2 Temperature,
3 Fraction,
4 Percent,
5 - Amount
Flag for RXUNTIL PolicyRxuntilFlag Integer 0 Not specified,

statement Vector
1 - Specified
Approach flag on RxuntilApprFlagIn Integer 1 From either

RXUNTIL statement Vector above or below.
2 From above,
3 From below
Component number RxuntilCompNumIn Integer

Vector
Basis for variables on RxuntilBasisFlagIn Integer 1 Mole, 2 - Weight

RXUNTIL Vector
Flag for CHARGE PolicyChargeFlag Integer 0 Not specified,

statement Vector
1 - Specified

StreamID for StrmIDForCharge Integer

CHARGE statement Vector
Basis for AMOUNT ChargeBasisFlagIn Integer 1 Mole, 2

on CHARGE Vector Weight, 3 - LV
Basis for RATE on RateBasisFlagIn Integer 1 Mole, 2

CHARGE Vector Weight, 3 - LV
Flag for DISCHARGE PolicyDischgFlag Integer 0 Not specified,

statement Vector
1 Specified,
2 Specified with
DTIME,
3 Specified with
Rate
Basis for RATE on DischgBasisFlagIn Integer 1 Mole, 2

DISCHARGE Vector Weight, 3 - LV
Flag for HEAT/COOL PolicyHeatCoolFla Integer 0 Not specified,

statement g Vector
1 Heat specified,
2 Cool specified
Utility ID on HeatCoolUtilityID Integer

HEAT/COOL statement Vector
Number of values NumOfValIn Integer

specified for Vector
FRACTION,PERCENT
or AMOUNT on START
Preexponential Factor PEXPWTUOMIn Integer

WT UOM Vector

Preexponential PEXPLIQVUOMIn Integer

Factor LIQV UOM Vector
Preexponential PEXPPRESUOMIn Integer

Factor PRES UOM Vector
Preexponential PEXPTEMPUOMIn Integer

Factor TEMP UOM Vector
Preexponential PEXPTIMEUOMIn Integer

Factor TIME UOM Vector
Total cycle time TotalCycleTimeIn TIME Real

scalar
Average charge time AvgChargeTimeIn TIME Real

scalar
Average heating time AvgHeatTimeIn TIME Real

scalar
Average cooling time AvgCoolTimeIn TIME Real

scalar
Average discharge AvgDischgTimeIn TIME Real

time scalar
Average cleaning AvgCleanTimeIn TIME Real

time scalar
Standard deviation - StdDevChargeTimeI TIME Real

charge time n scalar
Standard deviation - StdDevHeatTimeIn TIME Real

heating time scalar

Standard deviation - StdDevCoolTimeIn TIME Real

cooling time scalar
Standard deviation - StdDevDischgTimeIn TIME Real

discharge time scalar
Standard deviation - StdDevCleanTimeIn TIME Real

clean time scalar
Time increment TimeIncrementIn TIME Real

scalar
Step size Runge RungeStepSizeIn TIME Real

Kutta method scalar
Tolerance for Gear & ToleranceIn Real

LSODA methods scalar
Maximum overall MaximumTimeIn TIME Real

time scalar
Maximum process MaximumTempIn TEMP Real

temperature scalar
Minimum process MinimumTempIn TEMP Real

temperature scalar
Start time for profiles StartTimeProfIn TIME Real

scalar
Time increment for TimeIncreProfIn TIME Real

profiles scalar
Reactor volume Input ReactorVolIn LIQV Real

scalar

Tolerance for ConcToleranceIn FRAC Real

concentration scalar
Tolerance for TempToleranceIn TEMP Real

temperature scalar
Tolerance for PresToleranceIn PRES Real

pressure scalar
Preexponential PexpFactorsIn Real

factors vector
Activation energy ActivationEnergyIn ENTH Real

vector
Temperature TempExponentIn Real

exponent vector
Reaction order RxnOrderIn Real Reaction order of

vector component in each
reaction
Inlet temperature of InletTempUtilityIn TEMP Real

utility vector
Outlet temperature of OutletTempUtilityIn TEMP Real

utility vector
Saturation SaturationTempIn TEMP Real

temperature of utility vector
Saturation pressure SaturationPressIn PRES Real

of utility vector
RDATA entries for UserAddedRDATAIn Real

use-added kinetics vector

Supplemental entries UserAddedSuppleIn Real

for user added vector
kinetics
Time trigger on StartTimeIn TIME Real

START statement vector
Temp trigger on StartTempIn TEMP Real

Fraction trigger on StartFracIn FRAC Real

Percent trigger on StartPctIn PCT Real

Amount trigger on StartAmountIn Real

Time trigger on RxuntilTimeIn TIME Real

RXUNTIL statement vector
Incremental time on RxuntilIncrTimeIn TIME Real

Temp trigger on RxuntilTempIn TEMP Real

Fraction trigger on RxuntilFracIn FRAC Real

Percent trigger on RxuntilPctIn PCT Real

Conversion trigger on RxuntilConversionIn Real

RXUNTIL vector

Amount on CHARGE ChargeAmountIn Real

statement vector
Rate on CHARGE ChargeRateIn Real

statement vector
Incremental time on ChargeIncrTimeIn TIME Real

CHARGE statement vector
Rate on DischgRateIn Real

DISCHARGE vector
statement
Incremental time on DischgIncrTimeIn TIME Real

DISCHARGE vector
statement
Temperature on HeatTempIn TEMP Real

HEAT statement vector
Tempearture HeatTempDiffIn TDIF Real

difference on HEAT vector
statement
Duty on HEAT HeatDutyIn DUTY Real

statement vector
Incremental time on HeatIncrTimeIn TIME Real

HEAT statement vector

Table B.22B Batch Reactor Unit Operation Calculated
Properties
Read an attribute: BatReactorObject.GetAttribute(AttributeName,Index)
Write an attribute: BatReactorObject.PutAttribute(AttributeName,Index)
Class = BatReactor
BatReactor Calculated Properties
Number of profile NumOfActualPnt Integer Number of actual

poInts poInts for profile
poInts
Number of policy PolicyExecCounter Integer Number of policy

executions Vector executions
Total heat of reaction TotalHeatOfRxn ENTH Real Total heat of

reaction
Reactor volume ReactorVol LIQV Real Reactor volume
Overall rates for each OverallCompRates Real Overall rates for

component Vector each component
The (-E/RT) term for ERTs Real The (-E/RT) term

each reaction Vector for each reaction
Flowrate of utility FlowRateOfUtility MRAT Real Flowrate of utility

Vector
Concentration profile ConcProfile Real Concentration

Vector profile for all
components
Temperature profile TempProfile TEMP Real Temperature

Vector profile
Heat profile HeatProfile DUTY Real Heat profile

Vector

Properties
Class = BatReactor
Volume profile VolProfile LIQV Real Volume profile

Vector (liquid phase)
Moles of components FeedCompMoles Real Moles of

in feed Vector components in
feed
Moles of component CompMolesReacted Real Moles of

reacted Vector component reacted
Moles of component ProdCompMoles Real Moles of

in product Vector component in
product
Start time for an ActionStartTime TIME Real Start time for an

action Vector action
End time for an ActionEndTime TIME Real End time for an

action Vector action
Time for profile TimeProfile TIME Real Time for profile

poInts Vector poInts
Total volume profile TotalVolProfile Real Total volume

Vector profile
Amount of feed AmtOfFeedUsed Real Amount of feed

stream Vector stream fed to
reactor
Vapor volume profile VaporVolProfile Real Vapor volume

Vector profile

Properties
Class = BatReactor
Pressure profile PressureProfile PRES Real Pressure profile

Vector
Merged Streams, Class = BatReactor

containing feed
conditions
Feed stream FeedEnthalpy DUTY Real

enthalpy

containing product
conditions
Product stream ProdEnthalpy DUTY Real

enthalpy
All standard stream properties like Mole Fractions, Weight Fractions of various phases
are accessible via the standard Stream Class. See Table: 3-1

Table B.23A Depressure Unit Operation Input Data
Read an attribute: Depressure Object.GetAttribute(AttributeName, Index)
Write an attribute: Depressure Object.PutAttribute(AttributeName, Index)
Class = Depressure
Depressure Input Data
Depressure Configaration
Vessel volume type VessVolTypeFlg InT 1 = Spherical

flag
2 = Horizontal
3 = Vertical
Liquid holdup height LiqHeightPresentFlg InT 1 = Specified else

flag none
liquid holdup present LiqHoldupPresentFlg InT 1 = Specified else

flag none
Vessel volume VessVolume LIQV Real Input vessel

volume
Vessel vertical height VessVertHt LENG Real Input vessel

vertical height
Vessel diameter VessDiam LENG Real Input vessel

diameter
Vessel weight VessWt WT Real Input vessel weight
Vessel Density VessDensity DENS Real Vessel wall density
Vessel Thicness VessThickness LENG Real Vessel wall

thickness

Class = Depressure
Vessel volume factor VessVolFac Real Input vessel

volume factor
Vessel holdup VessHoldup LIQV Real Input vessel holdup
Vessel horizontal VessHoraLn LENG Real Input vessel

length horizontal length
Vessel liquid height VessLiqHt LENG Real Input vessel liquid

height
Vessel specific heat VessCp CP Real Input vessel

specific heat
Depressure Conditions, Class = Depressure
- Liquid holdup LiqHoldupBasisFlg InT 0 = No holdup

basis flag
1 = Mole holdup
2 = Wt holdup
3 = LV holdup
- Calculation stop StopFlagOpt InT 1 = Continue

flag
2 = Stop
Maximum poInts MaxPoInts InT Maximum number

of poInts calculated

Class = Depressure
Valve calculation ValveOptFlg InT 0 = supersonic

method
1 = subsonic
2 = constant
3 = user
Heat calculation HeatOptFlg InT 0 = User

method
1 = API2
2 = ApiS
3 = Isot
4 = Rp52
5 = Rpsc
6 = Blow
7 = Fire
Weight output WtOutReqFlg InT 1 = Present, else

request flag none
Composition output CompOutReqFlg InT 1 = All

request flag
2 = Part
3 = None
Maximum number of MaxIter InT Iterations

iterations
Calculation option CurrNewOptFlg InT 0 = Current

1 = New

Class = Depressure
Time step calculation TimeStepOptFlg InT 0 = Total

option flag
1 = Vapor
2 = Choice
Pressure plot request PressPlotFlg InT 1 = Specified else

none
Temperature plot TempPlotFlg InT 1 = Specified else

request none
Combined plot CombinedPlotFlg InT 1 = Specified else

request none
Property calculation PropsPrntOptFlg InT 0 = Semi rigorous

option
1 = Rigorous
Relief conditions ReliefCondFlg InT 1 = Relief specified

input flag
2 = Prelief
specified
Calculate initial WettedAreaFlg lnT 0=Use Initial

wetted area wetted area
1=Use Dynamic
wetted area
Adjacent TvadjacentLiqVap lnT 0=No calculation

Temperatures
1=Calculate
temperatures
Depressuring time FinalDeprTime TIME Real Input depressuring

time

Class = Depressure
Time step TimeStep TIME Real Input time step
Relief time ReliefTime TIME Real Input relief time
Valve constant ValveConst or Real Input Valve

PolicyVConstData Constant or Array
of Valve Constants
Valve Cv ValveCV Real Input Valve Cv
Downstream Pipe DownSPipeDia LENG Real Downstream pipe

Diameter diameter
Fire wetted area FireWetArea AREA Real Input fire wetted

area
Lagging factor LagFact Real Input lagging factor
Gas blowdown heat HtTrnArFactCoef HTCO Real Input gas

transfer coefficient blowdown heat
Gas blowdown vapor VaporHTC HTCO Real Input gas

heat transfer blowdown vapor
coefficient heat transfer
coefficient
User heat model A HeatModelCoefA Real input user heat

coefficient model A coefficient
User heat model C HeatModelCoefC Real input user heat

coefficient model C coefficient

Class = Depressure
Pressure step IntPresOutStep PDIF Real Input intermediate

pressure step for
output
Time step IntTimeOutStep TIME Real Input intermediate

time step for output
Temparature Temperature TEMP Real Input temperature

in VAT
Volume tolerance VolumeTol Real Input volume

tolerance
Temperature TemperatureTol Real Input temperature

tolerance tolerance
Enthalpy tolerance EnthalpyTol Real Input enthalpy

tolerance
Time step size TimeStepSize Real Input time step size
Final pressure FinalPres PRES Real Input final pressure
Final time FinalTime TIME Real Input final time
Isentropic efficiency IsenEff PCT Real Input isentropic

eficiency
Relief pressure ReliefPres PRES Real Input relief

pressure
Valve back pressure ValveBackPres PRES Real Input valve back

pressure

Class = Depressure
Valve CF ValveCF Real Input valve CF
Fire wetted area FireWetAreaFac Real Input fire wetted

factor area factor
Heat transfer area HeatTranArea AREA Real Input gas

blowdown heat
transfer area
Heat transfer area HeatTranAreaFact Real Input gas

factor blowdown heat
transfer area factor
Gas blowdown liquid LiquidHTC HTCO Real Input gas

HTC blowdown liquid htc
Heat model B HeatModelCoefB Real input user heat

coefficient model B coefficient
Heat model D HeatModelCoefD Real input user heat

coefficient model D coefficient
Heat model E HeatModelCoefE Real input user heat

coefficient model E coefficient
Duty Duty DUTY Real Input duty
Valve rate Rate MRAT Real Input valve rate
Valve constant for ConValveConIn Real Input valve

constant constant for
constant

Class = Depressure
Feeds, Class = Depressure
Number of feeds CurrentFeeds InT Number of feeds
Feed StreamIDs FeedData 0 to Strm ID N=CurrentFeeds

N-1
Makeup StreamID MakeupStrmID InT Makeup stream

number
Products, Class = Depressure
Number of products CurrentProducts InT Number of products
Product StreamIDs ProductData 0 to Strm ID N=CurrentProducts

N-1
ProductStoreData 0 to InT 1-Vapor 2-Liquid

N-1
3-Solid 4-Mixed

Table B.23B Depressure Unit Op Calculated Properties
Class = Depressure
Depressure Calculated Properties
Vessel volume VessVolumeCalc LIQV Real Calculated vessel
volume
Vessel vertical height VessVertHtCalc LENG Real Calculated vessel

vertical height
Vessel diameter VessDiamCalc LENG Real Calculated vessel

diameter
Vessel weight VessWtCalc WT Real Calculated vessel

weight
Vessel Density VessDensityCalc DENS Real Vessel wall density
Vessel Thicness VessThicknessCalc LENG Real Vessel wall thicness
Vessel volume factor VessVolFacCalc Real Calculated vessel

volume factor
Depressuring time FinalDeprTimeCalc TIME Real Calculated

depressuring time
Time step TimeStepCalc TIME Real Calculated time step
Relief time ReliefTimeCalc TIME Real Calculated relief

time
Valve constant ValveConstCalc Real Calculated valve

constant
Valve Cv ValveCVCalc Real Calculated Valve Cv

Class = Depressure
Downstream Pipe DownSPipeDiaCalc LENG Real Downstream pipe

Diameter diameter
Fire wetted area FireWetAreaCalc AREA Real Calculated fire

wetted area
Lagging factor LagFactCalc Real Calculated lagging

factor
Gas blowdown heat HtTrnArFactCoefCalc HTCO Real Calculated gas

transfer coefficient blowdown heat
Gas blowdown vapor VaporHTCCalc HTCO Real Calculated gas

heat transfer blowdown vapor
coefficient heat transfer
coefficient
User heat model A HeatModelCoefACal Real Calculated user

coefficient c heat model A
coefficient
User heat model C HeatModelCoefCCal Real Calculated user

coefficient c heat model C
coefficient
Temperature TemperatureCalc TEMP Real Calculated

temperature in VAT
Vessel holdup VessHoldupCalc LIQV Real Calculated vessel

holdup
Vessel horizontal VessHoraLnCalc LENG Real Calculated vessel

length horizontal length

Class = Depressure
Vessel liquid height VessLiqHtCalc LENG Real Calculated vessel

liquid height
Vessel specific heat VessCpCalc CP Real Calculated vessel

specific heat
Final pressure FinalPresCalc PRES Real Calculated final

pressure
Final time FinalTimeCalc TIME Real Calculated final time
Isentropic efficiency IsenEffCalc PCT Real Calculated

isentropic eficiency
Relief pressure ReliefPresCalc PRES Real Calculated relief

pressure
Valve back pressure ValveBackPresCalc PRES Real Calculated valve

back pressure
Valve CF ValveCFCalc Real Calculated valve CF
Fire wetted area FireWetAreaFacC Real Calculated fire

factor wetted area factor
Heat transfer area HeatTranAreaCalc AREA Real Calculated gas

blowdown heat
transfer area
Heat transfer area HeatTranAreaFactCa Real Calculated gas

factor lc blowdown heat
transfer area factor
Gas blowdown liquid LiquidHTCCalc HTCO Real Calculated gas

HTC blowdown liquid htc

Class = Depressure
Heat model B HeatModelCoefBCal Real Calculated user

coefficient c heat model B
coefficient
Heat model D HeatModelCoefDCal Real Calculated user

coefficient c heat model D
coefficient
Heat model E HeatModelCoefECal Real Calculated user

coefficient c heat model E
coefficient
Duty DutyCalc DUTY Real Calculated duty
Valve rate RateCalc MRAT Real Calculated valve

rate
Valve constant for ConValveConCalc Real Calculated valve

constant constant for
constant

Table B.24Controller Unit Operation
Read an attribute: ControllerObject.GetAttribute(AttributeName, Index)
Write an attribute: ControllerObject.PutAttribute(AttributeName, Index)
Attribute
Property Index Units Type Description
Name
Class = Controller
Controller Input Data
Maximum iterations MaxIterations Integer Maximum allowed trials

to converge
Trial printout flag PrintTrialFlag Integer 0 = do not print

1 = print
Return Unit ID ReturnUnit Char 12 characters max

Control transfer to this
unit op after controller
finishes
Controller CalculatedProperties
Execution counter RunFlag Integer 0 = never ran
>0 = count of executed
trials (Nt)
Final value of VARY LastVaryValue ~ Real Last value applied to

the VARY statement
Spec Values SpecHist 0 to ~ Real Values of SPEC after

Ns-1 each execution
Vary values VaryHist 0 to ~ Real Values of VARY after

Nv-1 each execution

Table B.25Multi-variable Controller Unit Operation
Read an attribute: MVCObject.GetAttribute(AttributeName, Index)
Write an attribute: MVCObject.PutAttribute(AttributeName, Index)
Class = MVC
MVC Input Data
Descriptive name UnitName Char 40 characters maximum

unit op after MVC
finishes
Ns, No. of SPECs CurrentSpecs Integer Ns (1 or more)
Nv, No. of VARYs NumOfVars Integer Nv (1 or more, must =

Ns)
Maximum cycles MaxCycles Integer Maximum allowed

number of calculation
cycles
Print option PrintFlag Integer 0 = None

1 = Summary or Partial
2 = Full
Plot Option PlotFlag Integer 0 = No plots

1 = generate plots
SPEC values input SpecValsIn 0 to ~ Real

Ns-1

MVC Calculated Properties
Execution flag RunFlag Integer 0 = never executed

1 = ran at least once
Nc, Current cycle CurrCycle Integer Current cycle number
Do Not Stop Option NostopFlagCalc Integer 0 = No Stop not active

1 = No Stop is active
Solved flag SoluFlag Integer 0 = never executed

1 = solved
2 or more = failed, error
TotNumOfCyclesRun Integer Count of completed

Total cycles solved cycles
Number of best CycleWithSmSqdE Integer Cycle having smallest err

cycle rr
Print option PrintFlagCalc Integer 0 = None

1 = Summary or Partial
2 = Full
Plot Option PlotFlagCalc Integer 0 = No plots

1 = generate plots

UOM classes for SpecUnitClasses 0 to Integer Class of UOM used by

SPECs Ns-1 each SPEC (App. A)
SPEC Max Error, ScaledMaxErrCalc ~ Real The single maximum

scaled SPEC error, scaled
SPEC Relative SpecRelErrs 0 to ~ Real Error found. See above

errors, calculated Ns-1 for UOM classes
SPEC values, SpecVals 0 to ~ Real Computed values for

calculated Ns-1 each SPEC. See above
for UOM classes
UOM classes for VarUnitClasses 0 to Integer Class of UOM used by

VARYs Ns-1 each SPEC (App. A)
VARY values, most VarValsLastUsed 0 to ~ VARY values See class

recently used Nv-1 of UOM above.
Step sizes for VarStepVals 0 to ~ Increment applied to

VARYs Nv-1 each VARY. See class of
UOM above.

Table B.26Optimizer Unit Operation
Read an attribute: OptimizerObject.GetAttribute( AttributeName, Index )
Write an attribute: OptimizerObject.PutAttribute( AttributeName, Index )
Class = Optimizer
Optimizer Input Data
Nc, Maximum MaxCyclesAllowed Integer Maximum allowed trials

cycles to converge (Nc)

unit op after MVC
finishes
No Scaling option NoScaleFlag Integer 0 = Apply scaling

1 = Do no scaling
Intermediate IPrintFlag Integer 0 = None

Variable Print option
1 = Summary or Final
2 = All
Intermediate Deriv. DPrintFlag Integer 0 = None

Print option
2 = All
Shadow Printout ShadowPrint Integer 0 = None (omit printing)

1 = Brief
2 = All
Print Derivative DerivativeAnalysis Integer 0 = omit deriv. analysis

analysis
1 = print the analysis

Class = Optimizer
Final Deriv. Print OPrintFlag Integer 0 = History

option
1 = Brief
2 = All
Plot Option PlotFlag Integer 0 = No plots

1 = generate plots
Copy Option CopyFlag Integer 0 = No copy

1 = Copy entire
database at each
optimizer base cycle.
Do Not Stop Option NostopFlag Integer 0 = No Stop not active

Broyden start cycle BroydenStartIter 0 - Nc Integer First cycle that performs

Broyden updating.
Full Step Option FullStep Integer 0 = use any provided

variable step sizes
1 = Ignore step sizes,
always take full step
ELIM option Eliminate 1 - Nv Integer 0 = do not eliminate

VARs
1-Nv number of
variables to
eliminate

Class = Optimizer
KEEP option Keep 1 to Integer 1-Nv = number of

Nv variables to keep
Local Thermo LocalThermo 0 = NONE

Option
1 = TP
2 = TPX
3 = TPXY
Line Search Mode LineSearchMode >=1 Integer 0 = no line search

(LMODE)
>=1 = maximum line
searches per cycle
SPEC Values SpecVals 0 to ~ Real

Ns- Values of SPEC after
1 each execution
Optimizer Calculated Properties
Maximum Cycles MaxCyclesAllowedCalc Integer Maximum allowed trials

to converge
Ncy, Current cycle CurrCycle Integer Current cycle number
Cycles completed NumOfCyclesComplete Integer Number of completed

d cycles
Ns, No. of SPECs CurrentSpecs Integer Number of SPECs
Nv, No. of VARYs NumOfVars Integer Nv (1 or more, must =

Ns)

Class = Optimizer
Ncs, No. of Constraints NumOfConstr Integer Number of Constraints
Solved solution flag SoluFlag Integer 0 = never ran

1 = solved
2, 3 = not solved
No Scaling option NoScaleFlagCalc Integer 0 = Apply scaling

1 = Do no scaling
Do Not Stop Option NostopFlagCalc Integer 0 = No Stop not active

Optimization Option OptType Integer -1 = minimize objective

0 = calculate error
+1 = maximize objective
Best Cycle CycleWithBestObjFn Integer Cycle number with most

optimal objective
function
Intermediate IPrintFlagCalc Integer 0 = None

Variable Print option
2 = All
Intermediate Deriv. DPrintFlagCalc Integer 0 = None

Print option
2 = All

Class = Optimizer
Final Deriv. Print OPrintFlagCalc Integer 0 = History

option
1 = Brief
2 = All
Plot Option PlotFlagCalc Integer 0 = No plots

1 = generate plots
Copy Option CopyFlagCalc Integer 0 = No copy

1 = Copy entire
database at each
optimizer base cycle.
ELIM option EliminateCalc 1to Integer 0 = do not eliminate

Nv VARs
1-Nv number of VARYs
to eliminate
UOM classes for SpecUnitClasses 0to Integer

SPECs Ns- See Appendix A for
1 UOM classes
Spec Values SpecValsCalc 0toNs ~ Real Values of SPEC after

-1 each execution
UOM classes for VarUnitClasses 0to Integer See Appendix A for

VARYs Nv- UOM classes
1

Class = Optimizer
Vary values CurrVarVal 0 to ~ Real

Nv- Values of VARY after
1 each execution
Table B.27Stream Calculator Unit Operation

Read an attribute: StreamCalcObject.GetAttribute(AttributeName, Index)
Write an attribute: StreamCalcObject.PutAttribute(AttributeName, Index)
Class = StreamCalc
Stream Calculator Input Data
Duty value DutyIn Duty Real Internal PRO/II UOM
OVHD temperature OvhdTempIn Temp Real Internal PRO/II UOM
OVHD DT OvhdDTIn Tdif Real Internal PRO/II UOM
OVHD DTBUBB OvhdDTBubblePtIn Tdif Real Internal PRO/II UOM
OVHD DTDEW Pt OvhdDTDewPointIn Tdif Real Internal PRO/II UOM

Class = StreamCalc
OVHD Testimate OvhdTempEstIn Temp Real Internal PRO/II UOM
OVHD Pressure OvhdPressIn Press Real Internal PRO/II UOM
OVHD Pressure OvhdDpIn Pdif Real Internal PRO/II UOM

Drop
BTMS temperature BtmsTempIn Temp Real Internal PRO/II UOM
BTMS DT BtmsDTIn Tdif Real Internal PRO/II UOM
BTMS DTBUBB BtmsDTBubblePtIn Tdif Real Internal PRO/II UOM
BTMS DTDEW Pt BtmsDTDewPointIn Tdif Real Internal PRO/II UOM
BTMS Testimate BtmsTempEstIn Temp Real Internal PRO/II UOM
BTMS Pressure BtmsPressIn Press Real Internal PRO/II UOM
BTMS Pressure BtmsDpIn Pdif Real Internal PRO/II UOM

Drop
PROD temperature ProdTempIn Temp Real Internal PRO/II UOM
PROD DT ProdDTIn Tdif Real Internal PRO/II UOM
PROD DTBUBB ProdDTBubblePtIn Tdif Real Internal PRO/II UOM

Class = StreamCalc
PROD DTDEW Pt ProdDTDewPointIn Tdif Real Internal PRO/II UOM
PROD Testimate ProdTempEstIn Temp Real Internal PRO/II UOM
PROD Pressure ProdPressIn Press Real Internal PRO/II UOM
PROD Pressure ProdDpIn Pdif Real Internal PRO/II UOM

Drop
Number of Feed FeedScaleFactCount Integ Represented as Nfsf

scaling factors er
Feed scaling factors FeedScaleFactIn 0 to ~ Real Dimensionless

Nfsf-1
Number of FOVHD OvhdRecovCount Integ Nof, count of

Factors er ovhdfeed fraction
factors
FOVHD Values OvhdRecovIn 0 to ~ Real Dimensionless

Nof-1 fraction
Number of FBTMS BtmsRecovCount Integ Nbf, count of btms

Factors er feed fraction
factors
FBTMS Values BtmsRecovIn 0 to ~ Real Dimensionless

Nbf-1 fraction

Class = StreamCalc
Number of ROVHD OvhdRateCount Integ Nor, count of ovhd

Factors er rate factors
ROVHD Values OvhdRateIn 0 to Rate Real Overhead rates

Nor-1
Number of RBTMS BtmsRateCount Integ Nbr, count of btms

RBTMS Values BtmsRateIn 0 to Rate Real Bottoms rates

Nbr-1
Number of XOVHD OvhdCompCount Integ Nox, count of ovhd

XOVHD Values OvhdCompIn 0 to ~ Real Component

Nox-1 fractions
Number of XBTMS BtmsCompCount Integ Nbx, count of btms

XBTMS Values OvhdCompIn 0 to ~ Real Component

Nbx-1 fractions
Number of FPROD ProdRecovCount Integ Npf, count of ovhd

Factors er feed fraction
factors

Class = StreamCalc
FPROD Values ProdRecovIn 0 to ~ Real Dimensionless

Npf-1 fraction
Number of RPROD ProdRateCount Integ Npr, count of ovhd

RPROD Values ProdRateIn 0 to Rate Real Synthesis product

Npr-1 rates
Number of XPROD ProdCompCount Integ Npx, count of ovhd

XPROD Values ProdCompIn 0 to ~ Real Component

Npx-1 fractions
STOP option ErrHandlingFlagIn Integer Negative flow handling

1 = set to zero, continue
2 = set to absolute value
and continue
3 = fail on negative val
Feeds
Number of feeds CurrentFeeds Intege Nf = Feed count

r
Feed streamIDs FeedData 0 to Strm Nf=Feed count

Nf-1 ID

Class = StreamCalc
Products
Number of products CurrentProducts Integ Np = Product count

er
Product stream IDs ProductData 0 toNp- Strm Np = Product count

1 ID
Product phases ProductStoreData 0 to Integ Np = Product count

Np-1 er
1=Vapor
2=Liquid
3=Solid
4=Mixed
5=H2O (decant)
Stream Calculator Calculated Properties
Feed scaling factors FeedScaleFact 0 to ~ Real Dimensionless

Nfsf-1
Error Count ErrCountFlag Integ

er 0 = no errors

Class = StreamCalc
STOP option ErrHandlingFlag Integ Negative flow

er handling
1 = set to zero,
continue
2 = set to absolute
value and continue
3 = fail on negative
val
Duty value Duty Duty Real Internal PRO/II UOM
OVHD Temperature OvhdTempFlag Integer TempOp

option = TempOp
0 = undefined by input
1 = DT 2 = TEMP
3 = DTBB 4 = DTAD
5 = BUBT 6 = DEWT
OVHD Temperature OvhdTemp Real Internal PRO/II UOM
OVHD DT OvhdDT Tdif Real Internal PRO/II UOM
OVHD DTBUBB OvhdDTBubblePt Tdif Real Internal PRO/II UOM
OVHD DTDEW OvhdDTDewPoint Tdif Real Internal PRO/II UOM

Class = StreamCalc
OVHD Testimate OvhdTempEst Temp Real Internal PRO/II UOM
OVHD pressure OvhdPressFlag Integer PresOp

option = PresOp
0 = undefined by input
1 = DP below Feed P
(DP=0.0 is default)
2 = Pressure was input
OVHD Pressure OvhdPress Press Real Internal PRO/II UOM
OVHD Pressure OvhdDp Pdif Real Internal PRO/II UOM

Drop
BTMS temperature BtmsTempFlag Integ See TempOp for

option er values
BTMS temperature BtmsTemp Temp Real Internal PRO/II UOM
BTMS DT BtmsDT Tdif Real Internal PRO/II UOM
BTMS DTBUBB BtmsDTBubblePt Tdif Real Internal PRO/II UOM
BTMS DTDEW Pt BtmsDTDewPoint Tdif Real Internal PRO/II UOM
BTMS Testimate BtmsTempEst Temp Real Internal PRO/II UOM

Class = StreamCalc
BTMS pressure BtmsPressFlag Integ See PresOp for

option er values
BTMS Pressure BtmsPress Press Real Internal PRO/II UOM
BTMS Pressure BtmsDp Pdif Real Internal PRO/II UOM

Drop
PROD temperature ProdTempFlag Integ See TempOp for

option er values
PROD temperature ProdTemp Temp Real Internal PRO/II UOM
PROD DT ProdDT Tdif Real Internal PRO/II UOM
PROD DTBUBB ProdDTBubblePt Tdif Real Internal PRO/II UOM
PROD DTDEW Pt BtmsDTDewPoin Tdif Real Internal PRO/II UOM

t
PROD Testimate ProdTempEst Temp Real Internal PRO/II UOM
PROD pressure ProdPressFlag Integer See PresOp for

option values
PROD Pressure ProdPress Press Real Internal PRO/II UOM
PROD Pressure ProdDp Pdif Real Internal PRO/II UOM

Drop

Class = StreamCalc
Operation Mode OperationMode 1 = Separator only

2 = Builder + feeds
3 = Builder, no feeds
4 = Separator + Builder
FOVH first compon. OvhdRecovBegComp0 0 to Integer

Nof-1
FOVH last compon. OvhdRecovEndComp0 0 to Integer

Nof-1
FOVH Basis OvhdRecovBasis 0 0 to Integer RecBasis:

Nof-1
1 = mole, 2 = weight
3 = liqVol, 4 = vapVol
FOVHD Values OvhdRecov 0 0 to Real Dimensionless fraction

Nof-1
FOVHd Names OvhdRecovSpecNam 0 0 to Char 12 char max

e Nof-1
ROVHD first comp. OvhdRateBegComp 0 0 to Integer Internal component

Nor-1 order number
ROVHD last comp. OvhdRateEndComp 0 0 Integer Internal component

toNor order number
-1

Class = StreamCalc
ROVHD Basis OvhdRateBasis 00 Integer See RecBasis

toNor
-1
ROVHD UOM OvhdRateSpecUOM 0 0 Integer Rate unit of measure

toNor
-1
ROVHD Values OvhdRate 0 0 to Nof-1 Rate Real Overhead rates
ROVH Names OvhdRateSpecName 0 0 to Char 12 char max

Nor-1
XOVHD first comp. OvhdCompBegComp 0 0 to Integer Internal component

Nox-1 order number
XOVHD last comp. OvhdCompEndComp 0 0 to Integer Internal component

Nox-1 order number
XOVHD Basis OvhdCompBasis 0 0 to Integer See RecBasis

Nox-1
XOVHD Values OvhdComp 0 to Rate Real Component fraction

Nof-1
XOVHD Names OvhdCompSpecNam 0 0 Char 12 char max

e toNox
-1

Class = StreamCalc
FBTM first compon. BtmsRecovBegComp 0 0 to Integer Internal component

Nbf-1 order number
FBTM last compon. BtmsRecovEndComp 0 0 to Integer Internal component

Nbf-1 order number
FBTM Basis BtmsRecovBasis 0 0 to Integer See RecBasis

Nbf-1
FBTM Values BtmsRecov 0 to Nbf- ~ Real Dimensionless fraction

1
FBTM Names BtmsRecovSpecNam 0 0 to Char 12 char max

e Nbf-1
RBTM first compon. BtmsRateBegComp 0 0 to Integer Internal component

Nbr-1 order number
RBTM last compon. BtmsRateEndComp 0 0 to Integer Internal component

Nbr-1 order number
RBTM Basis BtmsRateBasis 0 0 to Integer See RecBasis

Nbr-1
RBTM UOM BtmsRateSpecUOM 0 0 to Integer Rate unit of measure

Nbr-1
RBTM Values BTMSRate 0 to Rate Real Rate values

Nbr-1

Class = StreamCalc
RBTM Names BtmsRateSpecName 0 0 to Char 12 char max

Nbr-1
XBTM first compon. BtmsCompBegComp 0 0 to Integer Internal component

Nbx-1 order number
XBTM last compon. BtmsCompEndComp 0 0 to Integer Internal component

Nbx-1 order number
XBTM Basis BtmsCompBasis 0 0 to Integer See RecBasis

Nbx-1
XBTM Values BtmsComp 0 to Rate Real Component fractions

Nbx-1
XBTM Names BtmsCompSpecName0 0 to Char 12 char max

Nbx-1
FPROD first comp. ProdRecovBegComp 0 0 to Integer Internal component

Nof-1 order number
FPROD last comp. ProdRecovEndComp 0 0 to Integer Internal component

Npf-1 order number
FPROD Basis ProdRecovBasis 0 0 to Integer See RecBasis

Npf-1
FPROD Values ProdRecov 0 to Real Dimensionless fraction

Npf-1

Class = StreamCalc
FPROD Names ProdRecovSpecName0 0 to Char 12 char max

Npf-1
RPROD first comp. ProdRateBegComp 0 0 to Integer Internal component

Npr-1 order number
RPROD last comp. ProdRateEndComp 0 0 to Integer Internal component

Npr-1 order number
RPROD Basis ProdRateBasis 0 0 to Integer See RecBasis

Npr-1
RPROD UOM ProdRateSpecUOM 0 0 to Integer Rate unit of measure

Npr-1
RPROD Values ProdRate 0 to Rate Real Product rates

Npr-1
RPROD Names ProdRateSpecName 0 0 to Char 12 char max

Npr-1
XPROD first comp. ProdCompBegComp 0 0 to Integer Internal component

Npx-1 order number
XPROD last comp. ProdCompEndComp 0 0 to Integer Internal component

Npx-1 order number
XPROD Basis ProdCompBasis 0 0 to Integer See RecBasis

Npx-1

Class = StreamCalc
XPROD Values ProdComp 0 0 to Real component fraction

Npx-1
XPROD Names ProdCompSpecName0 0 to Char 12 char max

Npx-1
Table B.28Hcurve Unit Operation

Read an attribute: HcurveIn.GetAttribute(AttributeName, Index)
Write an attribute: HcurveIn.PutAttribute(AttributeName, Index)
Attribute Type Units Description
Class = HcurveIn Object
HcurveInput Data
UnitName Character None Unit name
StreamID Stream Name None Stream Number of Hcurve stream

(Character) Array
NumberOfPoints Integer Array None Number of Hcurve Points input

HcurveInput Data
CalcUnitID Unit Name None Calc unit id (diff than UnitID for
(Character) Array merged cols) - If 0 then source of
Hcurve is a stream
HeaterNumber Integer Array None Heater(Cooler) number for column

or cell no. for LNGHX
SideNumber Integer Array None Hot(=1)/Cold(=2) side for HX,

LNGHX, or shell(=1)/tube(=2) side
for HXRIG
SourceType Integer Array None Source type (From PUTYPE.CMN)
UnitID Unit Name None Unit number if Hcurve is for unit op

(Character) Array stream
Duty Floating Point None Heating/Cooling Duty

Array

Read an attribute: HcurveCalc.GetAttribute(AttributeName, Index)
Write an attribute: HcurveCalc.PutAttribute(AttributeName, Index)
Class = HcurveCalc
Hcurve Calc Data
Temperatures Floating Point None Temperatures

Array
Pressures Floating Point None Pressures

Array
EnthalpyTotal Floating Point None Total enthalpy

Array
EnthalpyWater Floating Point None Decant enthalpy

Array
FractionWater Floating Point None Decant fraction

Array
Compressibility Floating Point None Compressibility (z) factor

Array
FractionDry Floating Point None Dry LV fraction

Array
FactionLV Floating Point None Vapor/liquid fraction

Array
EnthalpyLV Floating Point None Vapor/liquid enthalpy

Array

HcurveInput Data
EntropyLV Floating Point None Vapor/liquid entropy

Array
MWDryLV Floating Point None Dry vapor/liquid molecular weight

Array
MWWetLV Floating Point None Wet vapor/liquid molecular weight

Array
SpGrDryLV Floating Point None Dry vapor/liquid specific gravity

Array
SpGrWetLV Floating Point None Wet vapor/liquid specific gravity

Array
DensityDryLV Floating Point None Dry vapor/liquid density

Array
DensityWetLV Floating Point None Dry vapor/liquid density

Array
SpecificHeatLV Floating Point None Vapor/liquid Cp

Array
ViscosityDryLV Floating Point None Dry vapor/liquid viscosity

Array

HcurveInput Data
ThermCondDryLV Floating Point None Dry vapor/liquid thermal

Array conductivity
ViscosityWetLV Floating Point None Wet vapor/liquid viscosity

Array
ThermCondWetLV Floating Point None Wet vapor/liquid thermal

Array conductivity
CriticalTempLV Floating Point None Vapor/liquid critical temperature

Array
CriticalPresLV Floating Point None Vapor/liquid critical pressure

Array
CriticalCompressLV Floating Point None Vapor/liquid critical compressibility

Array
AcenFactorDryLV Floating Point None Dry vapor/liquid acentric factor

Array
AcenFactorWetLV Floating Point None Wet vapor/liquid acentric factor

Array
APIGravityLV Floating Point None Vapor/liquid API gravity

Array

HcurveInput Data
UOPKLV Floating Point None Vapor/liquid UOP K

Array
AvgBoilingPtLV Floating Point None Vapor/liquid average boiling point

Array
IdealGasCP Floating Point None Ideal gas Cp

Array
SurfaceTensionDry Floating Point None Dry surface tension (of liquid)

Array
SurfaceTensionWet Floating Point None Wet surface tension (of liquid)

Array
CompositionLiquid Floating Point None Liquid composition (mole fraction,

Array x)
CompositionVapor Floating Point None Vapor composition (mole fraction,

Array y)
ActivityCoeff Floating Point None Activity coefficient

Array
VaporPressure Floating Point None Vapor pressure

Array

HcurveInput Data
FugacityVaporComp Floating Point None Pure component vapor fugacity

Array
PoyntingCorrection Floating Point None Poynting correction factor

Array
FugacityCoeffVapor Floating Point None Vapor fugacity coefficient

Array
MWDissolvedLiquid Floating Point None Dissolved liquid molecular weight

Array
DensitySolid Floating Point None Solid density

Array
EnthalpySolid Floating Point None Solid enthalpy

Array
SpecificHeatSolid Floating Point None Solid Cp

Array
FractionSolid Floating Point None Solid fraction

Array
VolFractionSolid Floating Point None Volumetric fraction of solid

Array

HcurveInput Data
MWSolid Floating Point None Solid molecular weight

Array
LatentHeat Floating Point None Latent heat of vapor-liquid mixture

Array

Invensys Systems, Inc.
26561 Rancho Parkway South
Lake Forest, CA 92630
United States of America
http://iom.invensys.com
Global Customer Support

Inside U.S.: 1-866-746-6477
Outside U.S.: 1-508-549-2424 or contact your
local Invensys Representative.
Email: Invensys.iom.support@Schneider-electric.com
Website: http://support.ips.invensys.com

PROII Com Server Reference Guide

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

PROII Com Server Reference Guide

Hochgeladen von

Copyright:

Verfügbare Formate

SimSci

2014 by Invensys Systems, Inc. All rights reserved.

Invensys Systems, Inc.

Server Object ------------------------------------------------------- 3

PRO/II COM Server Reference Guide I

Database Object ------------------------------------------------- 31

PRO/II COM Server Reference Guide II

Database Data Object ----------------------------------------- 65

PRO/II COM Server Reference Guide III

Appendix A: Unit of Measure Codes --------------------- 79

Appendix B: Pro II Object Reference --------------------- 83

PRO/II COM Server Reference Guide IV

PRO/II COM Server Reference Guide V

PRO/II COM Server Reference Guide VI

PRO/II COM Server Reference Guide 1

PRO/II COM Server Reference Guide 2

7.1.x SimSciDbs.Database.71 8.3.x SimSciDbs.Database.83

8.0.x SimSciDbs.Database.80 9.0.x SimSciDbs.Database.90

8.1.x SimSciDbs.Database.81 9.1.x SimSciDbs.Database.91

8.2.x SimSciDbs.Database.82 9.3.x SimSciDbs.Database.93

DebugLevel Amount of debug information to write to the debug file.

INIFile Name and path of the .INI file.

MsgCount Number of errors, warnings, and messages currently

PRO/II COM Server Reference Guide 3

DbsGetClassId Returns the numeric class identifier corresponding to

Export Exports the specified simulation database to a

GenerateReport Generates a report for the specified simulation.

GetClassCount Returns the number of object classes available from

GetClassNames Returns the individual object class name specified by

GetGroupClassCount Returns the total number of object classes belonging

GetGroupClassNames Returns the object class name belonging to the

GetGroupCount Returns the total number of object class groups in

GetGroupNames Returns the group name corresponding to the

PRO/II COM Server Reference Guide 4

GetSecuritySeat Acquires a software security seat so that subsequent

Import Imports the specified keyword file, creating a new

Initialize Initializes the PRO/II COM Server.

NewDatabase Creates a new PRO/II simulation database.

OpenDatabase Opens an existing PRO/II simulation database.

ReleaseSecuritySeat Releases the software security seat previously

RunCalcs Solves the specified simulation.

SetCallbackPtr Internal method reserved for future use.

SetOption Sets the value of an option in the PRO/II COM

Unload Shuts down the database access features of the

Error Subsystem Methods

MsgCode Returns an error, warning, or message code from the

MsgSeverity Returns an error, warning, or message severity code from

MsgText Returns an error, warning, or message string from the

PRO/II COM Server Reference Guide 5

0 dumps calls to Server Functions.

1 dumps 0-level information and function details.

2 dumps 1-level information and memory allocation

PRO/II COM Server Reference Guide 6

' If there are errors or messages get them here

When this property is retrieved, the Status is reset to zero

PRO/II COM Server Reference Guide 7

' If there are errors or messages get them here

PRO/II COM Server Reference Guide 8

classId The numeric class identifier. Use the DbsGetClassId

attrName The PRO/II object attribute name. Use GetAttributeName

PRO/II COM Server Reference Guide 9

className The PRO/II object class name. Use GetClassNames or

dbName Path and name of the simulation database to export.

keywordFile Name of keyword file to generate.