General Toolkit Function Concepts Guide

Honeywell Process Solutions
Advanced Process Control

Profit Toolkit
General Toolkit Function Concepts
AP11-409
R410
01/12
Release 410
Notices and Trademarks
Copyright 2012 by Honeywell International Inc.

Release 410 January, 2012
While this information is presented in good faith and believed to be accurate, Honeywell disclaims
the implied warranties of merchantability and fitness for a particular purpose and makes no
express warranties except as may be stated in its written agreement with and for its customers.
In no event is Honeywell liable to anyone for any indirect, special or consequential damages. The
information and specifications in this document are subject to change without notice.
Honeywell, PlantScape, Experion PKS, and TotalPlant are registered trademarks of Honeywell
International Inc.
Other brand or product names are trademarks of their respective owners.
Honeywell Process Solutions

1860 W Rose Garden Lane
Phoenix, AZ 85027
1-800 343-0228
ii Advanced Process Control Profit Toolkit General Toolkit Function Concepts R410
01/12
About This Document
Contacts
World Wide Web
The following Honeywell web sites may be of interest to Process Solutions customers.
Honeywell Organization WWW Address (URL)
Corporate http://www.honeywell.com
Process Solutions http://www.acs.honeywell.com/ps
R410 Advanced Process Control Profit Toolkit General Toolkit Function Concepts iii
01/12
About This Document
Symbol Definitions
Telephone
Contact us by telephone at the numbers listed below.
Organization Phone Number
United States Honeywell International Inc. 1-800-343-0228 Sales

and Canada Process Solutions 1-800-525-7439 Service
1-800-328-5111 Technical
Support
Asia Pacific Honeywell Asia Pacific Inc. (852) 23 31 9133
Hong Kong
Europe Honeywell PACE [32-2] 728-2711

Brussels, Belgium
Latin America Honeywell International Inc. (954) 845-2600

Sunrise, Florida U.S.A.
Symbol Definitions
The following table lists those symbols used in this document to denote certain conditions.
Symbol Definition
ATTENTION: Identifies information that requires special

consideration.
TIP: Identifies advice or hints for the user, often in terms of

performing a task.
REFERENCE -EXTERNAL: Identifies an additional source of

information outside of the bookset.
REFERENCE - INTERNAL: Identifies an additional source of

information within the bookset.
iv Advanced Process Control Profit Toolkit General Toolkit Function Concepts R410
01/12
About This Document
Symbol Definitions
Symbol Definition
CAUTION Indicates a situation which, if not avoided, may result in equipment

or work (data) on the system being damaged or lost, or may result in
the inability to properly operate the process.
CAUTION: Indicates a potentially hazardous situation which, if not

avoided, may result in minor or moderate injury. It may also be used
to alert against unsafe practices.
CAUTION symbol on the equipment refers the user to the product

manual for additional information. The symbol appears next to
required information in the manual.
WARNING: Indicates a potentially hazardous situation which, if not

avoided, could result in serious injury or death.
WARNING symbol on the equipment refers the user to the product

manual for additional information. The symbol appears next to
required information in the manual.
WARNING, Risk of electrical shock: Potential shock hazard where

HAZARDOUS LIVE voltages greater than 30 Vrms, 42.4 Vpeak, or
60 VDC may be accessible.
ESD HAZARD: Danger of an electro-static discharge to which

equipment may be sensitive. Observe precautions for handling
electrostatic sensitive devices.
Protective Earth (PE) terminal: Provided for connection of the

protective earth (green or green/yellow) supply system conductor.
Functional earth terminal: Used for non-safety purposes such as

noise immunity improvement. NOTE: This connection shall be
bonded to Protective Earth at the source of supply in accordance
with national local electrical code requirements.
R410 Advanced Process Control Profit Toolkit General Toolkit Function Concepts v
01/12
About This Document
Symbol Definitions
Symbol Definition
Earth Ground. Functional earth connection. NOTE: This

connection shall be bonded to Protective Earth at the source of
supply in accordance with national and local electrical code
requirements.
Chassis Ground: Identifies a connection to the chassis or frame of

the equipment shall be bonded to Protective Earth at the source of
supply in accordance with national and local electrical code
requirements.
vi Advanced Process Control Profit Toolkit General Toolkit Function Concepts R410
01/12
Contents
1. GENERAL PROFIT TOOLKIT CONCEPTS.................................11

1.1 Configuring and Deploying Profit Toolkit Application ............................. 11
Profit Suite Runtime Studio.............................................................................................. 11
1.2 Deploying Profit Toolkit on Runtime Computer ....................................... 12
Deploying a Profit Toolkit application (.URT platform file) on a target computer ................. 12
1.3 Loading an Application via PSOS ............................................................. 13
What really happens when Application is Loaded in PSOS ............................................... 13
1.4 Activating/Inactivating an Application via PSOS...................................... 14
What really happens when Application is set Active via PSOS .......................................... 14
What really happens when Application is set Inactive via PSOS ....................................... 14
1.5 Reloading or Terminating an Application via PSOS................................. 15
Reloading an Application - Changing the Contents of the Platform (URT) File ................... 15
Terminating an Application - Changing the Contents of the Platform (URT) File ................ 15
1.6 Removing a Profit Toolkit Application from a Runtime Computer .......... 16
Removing a Profit Toolkit application (.URT platform file) on a runtime computer .............. 16
1.7 Overview of Functions............................................................................... 17
Functions can be Run in Design and RunTime Environments ........................................... 17
General Description of Functions ..................................................................................... 17
Toolkit Function Execution Order in ProfitController/Optimizer .......................................... 17
Function Order ................................................................................................................ 17
1.8 Overview of Parameters ............................................................................ 18
Parameters – IN, INOUT and OUTPUT............................................................................ 18
Input Parameters ............................................................................................................ 18
InOut Parameters............................................................................................................ 18
Output Parameters.......................................................................................................... 18
Checkpointing ................................................................................................................. 19
Parameter Access Levels ................................................................................................ 19
Arrays............................................................................................................................. 19
Fixed Size Arrays ............................................................................................................ 19
Dynamically Sized Arrays - Input Dimension Parameters .................................................. 19
Controlling Toolkit Execution using the IN/Execute Parameter .......................................... 19
1.9 Overview of Connections .......................................................................... 20
Connections – I/O ........................................................................................................... 20
2. SPECIFIC PROFIT TOOLKIT FUNCTIONS .................................21

R410 Advanced Process Control Profit Toolkit General Toolkit Function Concepts vii
01/12
Contents
2.1 Overview.................................................................................................... 21
2.2 Profit Toolkit Functions that can be purchased ...................................... 22
2.3 Common Features in ProfitToolkit Functions Purchased from Honeywell23
Filtering .......................................................................................................................... 23
Last Good Value Holding ................................................................................................ 23
Biasing ........................................................................................................................... 23
Engineering Unit Conversion ........................................................................................... 24
Engineering Units ........................................................................................................... 24
Error Messages Raised by Profit Toolkit .......................................................................... 27
Return Status Parameters ............................................................................................... 28
Message Source Files..................................................................................................... 28
Return Status Table ........................................................................................................ 29
Examples Table .............................................................................................................. 32
viii Advanced Process Control Profit Toolkit General Toolkit Function Concepts R410
01/12
Contents
Tables
Table 2-1 Engineering Unit in Functions ..................................................................... 24
Table 2-2 Return Status .............................................................................................28
R410 Advanced Process Control Profit Toolkit General Toolkit Function Concepts ix
01/12
This page is intentionally left blank
R410 Advanced Process Control Profit Toolkit General Toolkit Function Concepts x
01/12
1. General Profit Toolkit Concepts
1.1 Configuring and Deploying Profit Toolkit Application
Profit Suite Runtime Studio
Configuring a Profit Toolkit application requires the following steps in Profit Suite
Runtime Studio:
Step Action
1 In Profit Suite Runtime Studio – create and name the toolkit application.
2 Add the necessary toolkit function blocks; typically a toolkit application
consists of many functions connected together.
3 Function order is extremely important, functions execute top down (I.e. the
function at the top of the tree executes, following by the next function below it
and so on.
4 Configure function connections. Typically configure a functions (Fn1) input
parameter to have an INPUT connection which pulls from another function’s
(Fn2) output parameter. Typically too, Fn1 should be ordered above Fn2. I.e.
you want Fn1 to execute before Fn2.
5 Configure OPC connections for any I/O. Typically an INPUT OPC connection
is set for function inputs, and OUTPUT OPC connections are set for function
outputs.
6 Save the application to an .urt file. The .urt file contains all scheduler, function
and connection information.
R410 Advanced Process Control Profit Toolkit General Toolkit Function Concepts 11
01/12
1.2. Deploying Profit Toolkit on Runtime Computer
1.2 Deploying Profit Toolkit on Runtime Computer

Deploying a Profit Toolkit application (.URT platform file) on a target computer
Step Action
1 Ensure that all the appropriate runtime software is installed on the target
computer (E.g. Fractionator, FCCU Toolkit, PSOS, etc).
2 Copy the .URT file that contains the application into the Platforms directory on
the target computer.
Some applications require additional files to be placed in the Platforms

directory. For example, ProfitSensor Pro and Profit EED require some
additional xml configuration files.
Platforms directory is located on the runtime computer’s \Program

Files\Honeywell\Urt\Platforms folder.
3 Application can be seen in the Profit Suite Operator Station (PSOS) in
application menu. Application is ready to be viewed.
12 Advanced Process Control Profit Toolkit General Toolkit Function Concepts R410
01/12
1.3. Loading an Application via PSOS
1.3 Loading an Application via PSOS

What really happens when Application is Loaded in PSOS
Step Action
1 A process called CoUrtPlatform.exe is invoked.
2 The .URT file (also called the URT platform file) is loaded by
CoUrtPlatform.exe.
3 Based on information in the .URT file, all schedulers, functions and data items
are instantiated.
4 I/O Connections are initialized via the OPC Client for Connections function
block.
01/12
1.4. Activating/Inactivating an Application via PSOS
1.4 Activating/Inactivating an Application via PSOS

What really happens when Application is set Active via PSOS
Step Action
1 Typically there are two schedulers in a single application. The system
scheduler (SysSched) and the application scheduler. Both are activated.
2 The system scheduler starts the checkpoint function block that is responsible
for auto-checkpointing and the history collection function block which
configures embedded PHD to collect items (if configured) from the application.
3 The application scheduler starts the application function blocks (E.g.
Frac/FCCU) and also starts the OPC Client for Connections which is
responsible for any I/O.
What really happens when Application is set Inactive via PSOS

Step Action
1 The application scheduler is set Inactive, which causes the application function
blocks (E.g. Frac/FCCU) and associated OPC Client for Connections to stop
running. As a result no function calculations are done and no I/O is processed.
2 CoUrtPlatform.exe process is not terminated at this time.
01/12
1.5. Reloading or Terminating an Application via PSOS
1.5 Reloading or Terminating an Application via PSOS

Reloading an Application - Changing the Contents of the Platform (URT) File
If a user makes changes to a URT file via PSRS, the changes will not take affect until the
user performs the following steps:
Step Action
1 Make necessary changes in PSRS and save the .URT file.
2 Deploy the .URT file to the target computers Plaforms directory.
3 Terminate the application via the application menu on PSOS (Right Click on
application, then select Terminate Application). The corresponding
CoUrtPlatform.exe process will no longer exist.
4 Restart the application via the application menu on PSOS (Right Click on
application, then select View Application).
5 Application is reloaded with new configuration information.
Terminating an Application - Changing the Contents of the Platform (URT) File

Step Action
1 Terminate the application via the application menu on PSOS (Right Click on
application, then select Terminate Application). The corresponding
CoUrtPlatform.exe process will no longer exist.
01/12
1.6. Removing a Profit Toolkit Application from a Runtime Computer
1.6 Removing a Profit Toolkit Application from a Runtime

Computer
Removing a Profit Toolkit application (.URT platform file) on a runtime computer
Step Action
1 Once the applicaton has been terminated, simply remove the.URT file that
contains the application from the Platforms directory on the runtime computer.
2 Application can no longer be seen in the PSOS’s application menu.
3 Generally it is a good idea to remove any associated configuration files,
although strictly speaking this is not required.
01/12
1.7. Overview of Functions
1.7 Overview of Functions

Functions can be Run in Design and RunTime Environments
One of the most powerful features of Profit Toolkit functions is that they can be executed
in both the design and runtime environments. In the design environment inputs can be
streamed through toolkit functions to generate data for new variables. The output data
can be then be modeled in Profit Design Studio.
General Description of Functions

Toolkit functions are set up to have the function calculate an output value based on user-
supplied inputs. The resultant value is filtered to reduce noise, biased and converted to
toolkit units. Last good value holding is available for every function.
Toolkit Function Execution Order in ProfitController/Optimizer

Profit Toolkit functions that run as part of a Profit Controller or Profit Optimizer
applications generally run on the main application scheduler.
• Toolkits that need to run before ProfitController/Optimizer should be placed above
the CoProfCon/CoProfOpt function block in the tree.
• Toolkits that need to after ProfitController/Optimizer should be placed below the
CoProfCon/CoProfOpt function block in the tree.
An example of this is the asynchronous CV function block, which runs before the
associated controller, hence is above it in the tree.
Function Order
Function order is extremely important for toolkits particularly when a functions input(s)
is pulled from another functions output. Toolkit ordering is discussed in detail in
subsequent sections.
01/12
1.8. Overview of Parameters
1.8 Overview of Parameters

Parameters – IN, INOUT and OUTPUT
Toolkit function parameters are located on the following structures:
IN – Inputs
INOUT – Input/Output parameters
OUTPUT – Output parameters.
Input Parameters
The user has to configure the function inputs in order for the function to work properly.
The input parameters may be configured as follows:
User entered constant value
Connect the input parameter to get its value from a DCS or other external source by
using an OPC connection.
Connect the input parameter to get its value from another toolkit functions output by
using a URT connection.
Depending on the parameter and the default value assigned some parameters may not
require input. The user can ignore these inputs.
InOut Parameters
A typical InOut parameter is a counter like LGV_Count (number of intervals last good
value has been held).
For a counter the parameter is input into the function, incremented by the function and
then the output value is used as input on subsequent executions – thus its both an input
and an output parameter.
Typically InOut parameters do not need to be configured by the user, but in some cases it
is possible that an initial value is required.
Output Parameters
Output parameters can be configured as follows:
Connect the output parameter to push its value to a DCS or other external source by
using an OPC connection.
01/12
1.8. Overview of Parameters
Connect the output parameter to push its value to another toolkit functions input by using
an URT connection.
Rather than connect a tookit output parameter to push its value to another
toolkit functions input by using a URT connection. It is recommended to pull
the output parameter from the input parameter (I.e. setup an input connection
on the input parameter).
Checkpointing
All input, output and inout parameters values are checkpointed to the application’s
checkpoint file, but output values are not loaded when the application is loaded as it
improves the time it takes to load the platform.
Parameter Access Levels

Operators have write access to input and inout parameters. A minimum of Engineer
access is required to write to output parameters.
Arrays
There are two types of array parameters. Fixed size arrays and dynamically sized arrays
that are dimensioned based on an associated input parameter’s value.
Fixed Size Arrays

Fixed size array have a static array size which cannot be changed.
Dynamically Sized Arrays - Input Dimension Parameters

Dynamically sized arrays are dependent on the size of an associated input parameter
(refereed to as a dimension parameter). Consider the return status array parameters,
RetStatus. RetMessage, RetFloat and RetString, all are sized based on the input RetNum
parameter’s values.
Controlling Toolkit Execution using the IN/Execute Parameter

A typical toolkit executes every time the application executes. Toolkit execution can be
controlled so that it only executes when the IN/Execute parameter is set to EXECUTE.
When IN/Execute is set to NONE, the function block will not execute. After the
function completes execution the IN/Execute parameter toggles back to NONE. If the
function is to execute on a subsequent execution IN/Execute must be set back to
EXECUTE.
The gain mappers for PC and PO have an IN/Execute parameter.
01/12
1.9. Overview of Connections
1.9 Overview of Connections

Connections – I/O
Profit Toolkit functions can interface with a wide variety of environments. Profit toolkit
input and output parameters can be configured to input from or output to the following
environments:
• OPC compliant applications
• TPS and Experion (using OPC Client for Connections)
• Embedded PHD and PHD (using OPC Client for History)
• Other toolkit applications/functions.
01/12
2. Specific Profit Toolkit Functions
2.1 Overview
ProfitTookit functions can be purchased from Honeywell. The functions are then
configured and typically functions are connected together to create an application:
01/12
2.2. Profit Toolkit Functions that can be purchased
2.2 Profit Toolkit Functions that can be purchased

Honeywell sells a wide variety of Profit Toolkit functions, including:
• Fractionator Toolkit
• FCCU Toolkit
• Lab Update Toolkit
• Gain Mapper for ProfitController
• Gain Mapper for ProfitOptimizer
01/12
2.3. Common Features in ProfitToolkit Functions Purchased from Honeywell
2.3 Common Features in ProfitToolkit Functions

Purchased from Honeywell
This Section describes features common to all ProfitToolkit functions.
Filtering
Filtering is applied to reduce noise and to ramp a value from its previous value to its
current value as smoothly as possible. Currently the filter types available are a first order
lag filter and a first order lag filter with deadtime. These filters are invoked by selecting a
filter type of 1 or 2 (several additional parameters also have to be filled in). Other filter
types will be available in the future. If filtering is not required for a specific function,
then a filter type of 0 should be selected. Biasing and conversion are sequenced
immediately after the filtering.
For the first order lag filter types, in order to filter from a previous value to the current
value, it is required to store the previous values. When the user sets up a function, a
storage parameter for the previous value is automatically created. The user does not need
to manipulate this parameter, but should be aware of its existence. This parameter is an
array named Filter_Shift.
For several functions, when an intermediate calculated value is being biased, the bias
itself is filtered. This prevents a bumping the output value, when the user enters a new
bias.
Last Good Value Holding

Last good value holding is available for each function. This is invoked by entering a
positive value in the number of intervals to hold the value (LGV_Num). Last good value
is the last function to be invoked. Thus if a bad value is processed or calculated by the
function it will hold the value for the number of intervals specified by the user. The user
can turn off last good value holding by setting LGV_Num to 0, or alternately if the user
requires the last good value held for an infinite period the user can set LGV_Num to a
negative value.
When the user configures a function, storage parameters for last good value holding are
automatically created. The user does not need to manipulate these parameters, but should
be aware of their existence. This parameter is usually an array named LGV_Values.
Biasing
Most Fractionator functions allow biasing of the final output value. The bias value is to
be input in user units.
01/12
WARNING
For the convenience of the user the bias is supplied in user units. Most other
inputs are expected in toolkit units.
Engineering Unit Conversion

The Fractionator functions conversion factors are required to convert output parameters
from toolkit units to user units. For the main output parameters the function will calculate
the output in both user and toolkit units. When the conversion factor is a multiplier, the
equation takes on the following form:
TK units = User units * Conv_Fact
ATTENTION
Use the process functions to supply inputs to Fractionator functions in toolkit
units.
WARNING
Generally, the conversion factors in the functions are not used to convert
input parameters to toolkit units, as the functions expect these values to be
supplied in toolkit units.
Rather conversion factors in the function are used to convert output values to
user units.
Engineering Units
The following table defines the engineering units handled by the functions:
Table 2-1 Engineering Unit in Functions
Engineering Units in Functions
Toolkit User Comment Example Conversion

Units Supplied Factor or
Value Conversion Flag
Factor or
Flag
Pressure Psig Multiplier to Pounds per User 0.14503774

convert to Psig square inch – requires
gauge output in
01/12

Factor or
Flag
Gauge Kpa
Pressure –
Most functions
require input in
these units
Pressure Psi Multiplier to Pounds per

convert to Psia square inch.
Local pressure
(usually around
14.696 psi)
should be
provided in
these units.
This allows
functions to
convert an
input pressure
in psig to psia.
Temperature Deg F Flag indicating 0 indicates Deg User 1 (Flag)

whether user F requires
value is in Deg output in
F or Deg C 1 indicates Deg DegC
C
Does not
support any
other
temperature
units.
01/12

Factor or
Flag
Gravity TK Flag indicating 0 indicates User 1 (Flag)

units whether user Specific requires
value is in Gravity output in
Spgr specific gravity API
@60D or API 1 indicates API gravity
egF/60 Gravity
DegF
Mass Flow Mlb/hr Multiplier to If user must See

convert to convert from example
Mlb/hr volumetric flow in
to mass flow, Flow_Pro
then the user c routine.
must consider
specific gravity
in the
conversion.
Volumetric Mbbl Multiplier to If user must See

Flow /day convert to convert from example
Mbbl/day mass flow to in Flow_
volumetric flow, Proc
then the user routine.
must consider
specific gravity
in the
conversion.
Watson K N/a N/a
Viscosity Centi No conversion User must

stokes factor supply
provided. viscosity in
Centistokes
Enthalpy MBTU Multiplier to Thousands of

/lb convert to BTU per
MBTU/lb pound.
01/12

Factor or
Flag
Heat MMBT Multiplier to Millions of BTU

U/hr convert to per hour.
MMBTU/hr
Mole N/a N/a

Fraction
Error Messages Raised by Profit Toolkit

Each function can raise multiple simultaneous error and/or warning messages. These
messages can be viewed in the following displays:
On the Profit® Viewer Alarms and Event Pane
On Experion– message and alarm displays.
Additionally all functions have an array parameter RetMessage where the current errors
containing the error messages. A parallel array called RetStatus contains the status
information indicating whether the message is a warning or an error. Theses parameters
can be viewed on the PSOS TOOLKIT display.
Most of the messages are errors, however there are a few warnings. The most common
warning is a last good value warning. This indicates that last good value holding is active
(i.e. the output from the function is bad and the last good value is being used).
01/12
Return Status Parameters

The following table lists the output parameters related to error messaging.
Table 2-2 Return Status
Return Status Table - provides a description of the function return status

parameters
Output Input or Description

Output
Parameter
RetNum Input The maximum number of
simultaneous error messages that
can be raised for an instance of a
function.
Ret_Status Output Number of errors/warnings.

Ret_Status is positive when the
highest priority message is an error.
Ret_Status is negative when the
highest priority message is a
warning. Ret_Status is zero, when
there are no warnings or errors.
RetStatus[RetNum] Output Array of current function return

statuses. See Return Status Table
below for details.
RetMessage[RetNum] Output Array of current Error/Warning

Message text.
RetFloat[RetNum] Output Array of float arguments for error

messages. For internal use only.
RetString[RetNum] Output Array of string arguments for error

messages. For internal use only.
Message Source Files

The text for all toolkit error message comes from message source files located in the
..\MsgSource\ProfitToolkit directory. The name of the message source file is
constructed as follows: URT_DLLName_ToolkitFunctionName_1.xml
For example then name of the file that contains messages for the fractionator D86 point
function is: URT_Frac_D86_EFV_Pt_1_Msg.xml
01/12
The xml file includes a msg file, which contains the message text. In the example below
the file that contains the message text is: HSTool_Frac_HS_D86_EFV_Pt.msg.
<?xml version="1.0" ?>


<MessageFile xmlns="MessageFile.xsd">
<Include>URT_UrtToolkitWrapper_1_Msg.xml</Include>
<Include>HSTool_Frac_HS_D86_EFV_Pt.msg</Include>
</MessageFile>
Return Status Table
Shows the error and warning messages associated with the function.
Return Status
Status
value
0 No error occurred
1 The user-entered number of streams is either a bad value or less than

zero.
2 Stream flow is a bad value. Stream number ____ is the stream in error.
3 Stream In or Out is a bad value. Stream number ____ is the stream in

error.
4 Normal boiling point temperature is a bad value
5 Latent heat normal boiling point temperature is a bad value
6 Exponent type must be either –1 or 1.
7 Normal boiling point temperature cannot be –459.67.
8 Liquid molecular weight is a bad value
9 Critical temperature is a bad value
10 Overhead temperature is a bad value
11 The critical temperature must be greater than the overhead temperature.
01/12
Return Status
Status
value
12 The difference between the critical temperature must and the overhead
temperature is negligible or zero.
13 Heat capacity is a bad value.
14 Reflux temperature is a bad value.
15 Latent heat of vaporization is a bad value.
16 The overhead temperature must be greater than the reflux temperature.
17 The selected volumetric or mass output type (User_V_or_M) must be

either 0 or 1.
18 Liquid gravity is a bad value
19 Liquid gravity is a negligible or zero.
20 Internal liquid and vapor conversion (flow) factor is a bad value
21 Internal liquid and vapor conversion (flow) factor is less than or equal to
zero.
22 Vapor gravity is a bad value
23 Vapor gravity is a negligible or zero.
24 Stream Molecular Weight – for stream %0.d - is a bad value
25 Stream gravity - for stream %0.d - is a bad value.
26 Stream Watson K - for stream %0.d - is a bad value.
27 Liquid Molecular Weight is a bad value.
28 Liquid gravity is a bad value.
29 Liquid Watson K is a bad value.
30 Errors filtering internal liquid. See associated message from Filter

function
101 - 104 An error occurred in the Press_PC function. Details of the error can be
found by looking up the resulting status value in the Profit Toolkit
Functions Reference
01/12
Return Status
Status
value
105 - 108 An error occurred in the Temp_PC function. Details of the error can be
Functions Reference
141 - 146 An error occurred in the Filter_First_Ord_Lag function. Details of the

error can be found by looking up the resulting status value in the Profit
Toolkit Functions Reference
155 - 160 An error occurred in the Filter function. Details of the error can be found
by looking up the resulting status value in the Profit Toolkit Functions
Reference
179 - 182 An error occurred in the Mol_WT function. Details of the error can be
Functions Reference
183 - 192 An error occurred in the Enth_HC function. Details of the error can be
Functions Reference
193 - 197 An error occurred in the Enth_Stm function. Details of the error can be
Functions Reference
198 - 205 An error occurred in the Enth_Gas function. Details of the error can be
Functions Reference
Negative Last good value holding is active. The error that is causing the bad value
errors can be determined by looking up the positive of the error value.
01/12
Examples Table
The following table shows example calculations (showing settings for the main inputs
and outputs) for the Top_LandV function.
Top_LandV function
Parameter Input / Example Example Comment

Output 1 – Expon 2 – Expon
= 0 (Sp. =1
Gr.,
WatK) (Sp. Gr.,
WatK)
Stream_Num I 2 2
Stream_Flow\1 I 120 120
Stream_Flow\2 I 80 80
Stream_In_or_Out\1 I 1 1
Stream_In_or_Out\2 I -1 -1
Stream_Gravity\1 I 0.62 0.62
Stream_Gravity\2 I 0.67 0.67
Stream_WatK\1 I 12.1 12.1
Stream_WatK\2 I 11.8 11.8
Stream_Molwt\1 I 0 0
Stream_Molwt\2 I 0 0
Reflux_Temperature I 104 104
OVHD_Temperature I 248 248
Norm_Boil_Pt_Tempe I
rature 0 212
Critical_Temperature I 540 540
Latent_Ht_Norm_Boil I
_Pt 13.6 13.6
Heat_Capacity I 0.3 0.3
01/12
Top_LandV function

= 0 (Sp. =1
Gr.,
WatK) (Sp. Gr.,
WatK)
I Example 1 – Exponent not

calculate Expon = 0.38.
Example 2 – Exponent
Expon_Type 0 1 calculated
Filter_Type I 0 0
Filter_Coeff_Num I 1 1
Filter_Coeff\1 I 5 5
Filter_Shift_Num I 1 1
Filter_Shift\1 I 0 0
Etime I 1 1
Flow_Conv_Fact I 1 1
User_V_or_M I 1 1
LGV_Num I 0 0
Liq_LGV_Count I 0 0
Vap_LGV_Count I 0 0
Liq_LGV_Values\1 I 0 0
Vap_LGV_Values\1 I 0 0
01/12
Top_LandV function

= 0 (Sp. =1
Gr.,
WatK) (Sp. Gr.,
WatK)
RetNum I 10 10
Ret_Status O 0 0
Liq_Value_User_ O
Units 400.9955 342.4225
Liq_Value_TK_Units O 400.9955 342.4225
Vap_Value_User_ O
Units 600.9955 542.4225
Vap_Value_TK_Units O 600.9955 542.4225
Liq_Molwt O 0 0
Vap_Molwt O 0 0
Liq_Gravity O 0.64 0.64
Vap_Gravity O 0.64 0.64
Liq_WatK O 11.98 11.98
Vap_WatK O 11.98 11.98
O Example 1 – Exponent not

calculate Expon = 0.38.
Example 2 – Exponent
Expon 0.38 0.276608 calculated.
Latent_Heat_Vaporiz O
ation 10.76651 13.1696
01/12
Top_LandV function

= 0 (Sp. =1
Gr.,
WatK) (Sp. Gr.,
WatK)
Stream_in_Error O 0 0
Liq_LGV_Count O 0 0
Vap_LGV_Count O 0 0
Liq_LGV_Values\1 O 400.9955 342.4225
Liq_LGV_Values\2 O 400.9955 342.4225
Liq_LGV_Values\3 O 0 0
Liq_LGV_Values\4 O 0.64 0.64
Liq_LGV_Values\5 O 11.98 11.98
Vap_LGV_Values\1 O 600.9955 542.4225
Vap_LGV_Values\2 O 600.9955 542.4225
Vap_LGV_Values\3 O 0 0
Vap_LGV_Values\4 O 0.64 0.64
Vap_LGV_Values\5 O 11.98 11.98
Filter_Shift\1 O 400.9955 342.4225
01/12
Honeywell International
Process Solutions
1860 W Rose Garden Lane
Phoenix, AZ 8502

General Toolkit Function Concepts Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

General Toolkit Function Concepts Guide

Uploaded by

Copyright:

Available Formats

Honeywell Process Solutions

Advanced Process Control

Copyright 2012 by Honeywell International Inc.

Other brand or product names are trademarks of their respective owners.

Honeywell Process Solutions

Honeywell Organization WWW Address (URL)

Organization Phone Number

United States Honeywell International Inc. 1-800-343-0228 Sales

Europe Honeywell PACE [32-2] 728-2711

Latin America Honeywell International Inc. (954) 845-2600

ATTENTION: Identifies information that requires special

TIP: Identifies advice or hints for the user, often in terms of

REFERENCE -EXTERNAL: Identifies an additional source of

REFERENCE - INTERNAL: Identifies an additional source of

CAUTION Indicates a situation which, if not avoided, may result in equipment

CAUTION: Indicates a potentially hazardous situation which, if not

CAUTION symbol on the equipment refers the user to the product

WARNING: Indicates a potentially hazardous situation which, if not

WARNING symbol on the equipment refers the user to the product

WARNING, Risk of electrical shock: Potential shock hazard where

ESD HAZARD: Danger of an electro-static discharge to which

Protective Earth (PE) terminal: Provided for connection of the

Functional earth terminal: Used for non-safety purposes such as

Earth Ground. Functional earth connection. NOTE: This

Chassis Ground: Identifies a connection to the chassis or frame of

1. GENERAL PROFIT TOOLKIT CONCEPTS.................................11

2. SPECIFIC PROFIT TOOLKIT FUNCTIONS .................................21

1.2 Deploying Profit Toolkit on Runtime Computer

Some applications require additional files to be placed in the Platforms

Platforms directory is located on the runtime computer’s \Program

1.3 Loading an Application via PSOS

1.4 Activating/Inactivating an Application via PSOS

What really happens when Application is set Inactive via PSOS

1.5 Reloading or Terminating an Application via PSOS

Terminating an Application - Changing the Contents of the Platform (URT) File

1.6 Removing a Profit Toolkit Application from a Runtime

1.7 Overview of Functions

General Description of Functions

Toolkit Function Execution Order in ProfitController/Optimizer

1.8 Overview of Parameters

Parameter Access Levels

Fixed Size Arrays

Dynamically Sized Arrays - Input Dimension Parameters

Controlling Toolkit Execution using the IN/Execute Parameter

The gain mappers for PC and PO have an IN/Execute parameter.

1.9 Overview of Connections

2.2 Profit Toolkit Functions that can be purchased

2.3 Common Features in ProfitToolkit Functions

Last Good Value Holding

Engineering Unit Conversion

Table 2-1 Engineering Unit in Functions

Engineering Units in Functions

Toolkit User Comment Example Conversion

Pressure Psig Multiplier to Pounds per User 0.14503774

Engineering Units in Functions

Toolkit User Comment Example Conversion

Pressure Psi Multiplier to Pounds per

Temperature Deg F Flag indicating 0 indicates Deg User 1 (Flag)

Engineering Units in Functions

Toolkit User Comment Example Conversion

Gravity TK Flag indicating 0 indicates User 1 (Flag)

Mass Flow Mlb/hr Multiplier to If user must See

Volumetric Mbbl Multiplier to If user must See

Watson K N/a N/a