136
Profit Toolkit Profit Bridge User's Guide Revision 1.3 8/02 AP20-401

Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

  • Upload
    others

  • View
    5

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Toolkit

Profit Bridge User's Guide

Revision 1.3 8/02

AP20-401

Page 2: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

ii Profit Bridge User's Guide 8/02 Honeywell

Copyright, Notices, and Trademarks

Copyright 2001 by Honeywell International Inc.

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 customer. 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. Profit, TDC 3000, and TotalPlant are registered trademarks of Honeywell International Inc. Other product names are trademarks of their respective owners.

Honeywell Industrial Automation and Control

16404 N. Black Canyon Hwy Phoenix, AZ 85053

Page 3: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide iii Honeywell

Table of Contents

ABOUT THIS PUBLICATION ................................................................................................VIII Statement of Work.............................................................................................. viii How This Book Is Organized .............................................................................. viii Writing Conventions Used in This Book .............................................................. ix

REFERENCES ..........................................................................................................................X Documentation...................................................................................................... x Open ..................................................................................................................... x TPS System.......................................................................................................... x Embedded Uniformance...................................................................................... xi

FOR TECHNICAL ASSISTANCE............................................................................................XII SECTION 1 – INTRODUCTION TO PROFIT BRIDGE.................................................... 1

1.1 Overview.............................................................................................................. 1 In This Section ...................................................................................................... 1 What is Profit Bridge?........................................................................................... 1 What Does Profit Bridge Do? ............................................................................... 1 Version Information .............................................................................................. 1

1.2 Profit Suite Overview ......................................................................................... 2 Components ......................................................................................................... 2 Profit Design Studio .............................................................................................. 2 Profit Viewer ......................................................................................................... 3 Profit Controller (RMPCT) .................................................................................... 3 Profit Optimizer (DQP).......................................................................................... 4 Profit Toolkit.......................................................................................................... 4

1.3 Profit Bridge Overview....................................................................................... 6 Purpose ................................................................................................................ 6 Components ......................................................................................................... 6 Gain Scheduling and Profit Bridge........................................................................ 6 When Should Profit Bridge Be Used? .................................................................. 6 When Might Profit Bridge Not Be the Best Technology to Use? .......................... 7

1.4 Profit Bridge Application Architecture ............................................................. 8 Design and Runtime Components........................................................................ 8 Functional Flow..................................................................................................... 9 Gain Extraction Functions..................................................................................... 9 Pre- and Post-Gain Extraction Functions ............................................................. 9 Gain Extraction Loops .......................................................................................... 9 Modeling Functions............................................................................................. 10 GainMapper Application Coordination ................................................................ 10

1.5 Profit Bridge Features...................................................................................... 12 Gain Extraction Concepts ................................................................................... 12 Dependent Variables (“Type”) ............................................................................ 12 Independent Variables (“Type” and “Source Indep”) .......................................... 12

Page 4: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Table of Contents

Profit Bridge User's Guide 8/02 Honeywell iv

Perturbation (“Step Size” and “Deriv Type”)........................................................13 Perturbation Groups (“Pass Index”) ....................................................................14 Simulation Conditions (“Base” and “Step”)..........................................................14 Gain Calculation (“Calc Type” and “Current”) .....................................................15 Gain Validation (“Validated”, “Valid Coeff”, and “Previous”)................................15 Gain Mapping......................................................................................................15 Gain Mapping Mode: OFF, ON, or WARM .........................................................16 Exponential, Maximum Rate-of-Change, and Minimum Change (Deadband) Filtering of Validated Gains (“Valid Coeff”)..........................................................16

SECTION 2 – GAINMAPPER FOR PROFIT CONTROLLER (GAINMAPPERPC) .......17 2.1 Introduction .......................................................................................................17

In This Section ....................................................................................................17 Terminology.........................................................................................................17 Usage of GainMapper .........................................................................................17 Incentive to Use GainMapper..............................................................................17

2.2 Using GainMapper ............................................................................................18 GainMapper Functions Created by RMPCT Point Builder ..................................18 How Many Gains Can be Changed at One Time?..............................................18 Datapool Parameters Involved in a Gain Update................................................18 GainMapper Execution........................................................................................18 Invoking the GainMapper via the Execute Parameter.........................................18 Only Validating the Gains....................................................................................18 Rate of Change Check........................................................................................19 Deadband Check ................................................................................................19 Filtering in the New Gain .....................................................................................20 Example – Using the GainMapper ......................................................................20 How is the Gain Multiplier Calculated?................................................................21

2.3 Error Indications ...............................................................................................22 Errors Reported...................................................................................................22 Actions to Take when an Error is Detected.........................................................22 Return Status Table ............................................................................................22

2.4 Logging Gain Changes.....................................................................................24 How To Enable Logging of Gain Changes..........................................................24

2.5 Profit Controller Datapool ................................................................................25 Datapool Table....................................................................................................25 Input Table ..........................................................................................................26 Output Table .......................................................................................................26

SECTION 3 – GAINMAPPER FOR PROFIT OPTIMIZER (GAINMAPPERPO).............27 3.1 Introduction .......................................................................................................27

In This Section ....................................................................................................27 Terminology.........................................................................................................27 Incentive to Use GainMapperPO ........................................................................27

3.2 Using GainMapperPO .......................................................................................28 GainMapperPO Functions Created by DQP .......................................................28 How Many Gains Can be Changed at one Time?...............................................28

Page 5: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Table of Contents

8/02 Profit Bridge User's Guide v Honeywell

Datapool Parameters Involved in a Gain Update ............................................... 28 GainMapperPO Execution .................................................................................. 28 Invoking the GainMapperPO via the Execute Parameter................................... 29 Only Validating the Gains ................................................................................... 30 Rate of Change Check ....................................................................................... 30 Deadband Check ................................................................................................ 30 Filtering in the New Gain .................................................................................... 30 Gains are Updated by Creating a New YM File .................................................. 30 CC Gains Scaling Factor .................................................................................... 31 Automatically Saving Older Versions of the YM File .......................................... 31 Example – Using the GainMapperPO to Update BM Gains ............................... 31 Example – Using the GainMapperPO to Update CC Gains ............................... 32

3.3 Handling Errors................................................................................................. 34 Errors Reported .................................................................................................. 34 Actions to Take when an Error is Detected ........................................................ 34 Return Status Table............................................................................................ 35

3.4 Logging Gain Changes .................................................................................... 39 How To Enable Logging of Gain Changes ......................................................... 39

3.5 Profit Optimizer Datapool ................................................................................ 40 Datapool Table ................................................................................................... 40 Input Table.......................................................................................................... 41 Output Table ....................................................................................................... 42

SECTION 4 – INSTALLING PROFIT BRIDGE.............................................................. 43 4.1 Installing Profit Bridge ..................................................................................... 43

Items Included on Profit Bridge CD .................................................................... 43 What’s not Included on Profit Bridge CD............................................................ 43 How to Install Profit Bridge ................................................................................. 43 Where to Install Profit Bridge Components ........................................................ 44 Profit Bridge Toolkit Installation CD Layout ........................................................ 44 General Installation Summary ............................................................................ 45 Additional Details on Installing the Gain Mappers .............................................. 46 Installation Scenario 1 ........................................................................................ 46 Installation Scenario 2 ........................................................................................ 47 Installation Scenario 3 ........................................................................................ 47 Installation Scenario 4 ........................................................................................ 48 Installation Scenario 5 ........................................................................................ 48

SECTION 5 – BUILDING PROFIT BRIDGE .................................................................. 49 5.1 Getting Started.................................................................................................. 49

What is Configured?........................................................................................... 49 Begin Configuration ............................................................................................ 50 Select an Existing Application............................................................................. 51 Create a New Application ................................................................................... 51 Delete an Application.......................................................................................... 51 Database Activity ................................................................................................ 52 Configuration Overview ...................................................................................... 52

Page 6: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Table of Contents

Profit Bridge User's Guide 8/02 Honeywell vi

Initial Steps..........................................................................................................53 5.2 Functions List....................................................................................................54

Working in the Functions List..............................................................................54 Insert a New Function .........................................................................................54

5.3 Controller Model Files ......................................................................................57 Description ..........................................................................................................57 What Controller Model Files Provide...................................................................57 Select Controller Model Files ..............................................................................58

5.4 Optimizer Model Files.......................................................................................59 Description ..........................................................................................................59 What Optimizer Model Files Provide...................................................................59 Select Optimizer Model Files...............................................................................60 Relationship of Controller and Optimizer Model Files .........................................60

5.5 Model Data Source............................................................................................61 Description ..........................................................................................................61 Configuration Items .............................................................................................61 Configure Model Data Source.............................................................................65

5.6 Functions for Extraction...................................................................................66 Description ..........................................................................................................66 Configuration Items .............................................................................................66 Configuration Checking.......................................................................................67 Function Behavior ...............................................................................................67

5.7 Variable Connections .......................................................................................68 Description ..........................................................................................................68 Configuration Items .............................................................................................69 Configure Variable Connections .........................................................................71 Change Connection.............................................................................................72 Remove Connection............................................................................................72

5.8 Perturbations.....................................................................................................73 Description ..........................................................................................................73 Configuration Items .............................................................................................73 Configure Perturbations ......................................................................................74

5.9 Gains ..................................................................................................................75 Controller Gains (CV Gains) ...............................................................................75 Optimizer Gains (BO Gains) ...............................................................................80 Provided Gains....................................................................................................81

5.10 Create Configuration File .................................................................................83 Creating the Configuration File............................................................................83

SECTION 6 - RUNNING A PROFIT BRIDGE APPLICATION ......................................85 6.1 Steps to Launch an Application ......................................................................85

Steps to Launch an Application For the First Time .............................................85 Subsequent Launchings of an Application ..........................................................85 Reminder – Set the GMUpdateMode..................................................................85

6.2 Copy Profit Bridge Application Configuration File ........................................86

Page 7: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Table of Contents

8/02 Profit Bridge User's Guide vii Honeywell

Copy Config File ................................................................................................. 86 6.3 Register the Profit Bridge Application............................................................ 87

Read This! .......................................................................................................... 87 Running the Server Registrar Directly ................................................................ 87 Running the Server Registrar from Profit Viewer ............................................... 87 Registering a Profit Bridge Application ............................................................... 88

6.4 Launch a Profit Bridge Application Process.................................................. 89 Launching a Profit Bridge Application With Profit Viewer ................................... 89 Setting GainValid01\ GMUpdateMode using Profit Viewer................................. 91 Launching a Profit Bridge Application with HS MiniBrowser............................... 92 Important Note About HS MiniBrowser............................................................... 92 Setting Parameter Values Using HS MiniBrowser.............................................. 93 Saving HS MiniBrowser Configurations.............................................................. 93 Reading a Saved HS MiniBrowser Configuration ............................................... 94

6.5 End a Profit Bridge Application Process........................................................ 95 Privileged Task Manager .................................................................................... 95 Which Process Do I End?................................................................................... 95 Ending the Process............................................................................................. 95

SECTION 7 – USING THIRD PARTY MODEL SOCKETS............................................ 96 7.1 Socket Overview............................................................................................... 96

What is a Socket?............................................................................................... 96 7.2 Socket Configuration ....................................................................................... 97

Third Party Model Configuration GUI.................................................................. 97 Input Table.......................................................................................................... 97 Output Table ....................................................................................................... 98

APPENDIX A - PROFIT BRIDGE ERROR MESSAGES.................................................. 99 In This Appendix ................................................................................................. 99 Example of Full Error Message .......................................................................... 99 Return To Normal Message ............................................................................... 99

APPENDIX B - DATAPOOL PARAMETERS AND CUSTOM VARIABLES................... 105 In This Appendix ............................................................................................... 105

B.1 Datapool Parameters...................................................................................... 106 B.2 Dependent Variable Parameters (DEPn) ...................................................... 109 B.3 Independent Variable Parameters (INDEPn) ................................................ 111 B.4 Gain Parameters (GAINn)............................................................................... 113 B.5 Profit Bridge Dimension Parameters (GAINEXT1) ...................................... 114 B.6 Profit Bridge Configuration File .................................................................... 115

Header Statements........................................................................................... 115 GainMapper Reserved Custom Variable Names ............................................. 116

Page 8: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

viii Profit Bridge User's Guide 8/02 Honeywell

About This Publication Statement of Work The following table describes the audience, purpose, and scope of this book:

Purpose This book facilitates the use of Profit Bridge for the on-line updating of process model gains in Profit Controller and Profit Optimizer applications. Read this book to: �� Install the Profit Bridge runtime and design software

components. �� Understand Profit Bridge functionality and features. �� Configure a Profit Bridge application using the design

software. �� Implement and run a Profit Bridge application.

Audience Process and control engineers.

How This Book Is Organized

The following table provides an overview of this document's contents.

Section Contents 1 Introduction to Profit

Bridge��� Profit Bridge purpose and when to use �� Profit Bridge architecture and connections with

other Profit Suite applications �� A quick description of related Profit Suite

applications 2 Gain Mapper for Profit

Controller How to use Gain Mapper for Profit Controller

3 Gain Mapper for Profit Optimizer

How to use Gain Mapper for Profit Optimizer

4 Installing Profit Bridge How to install Profit Bridge design and runtime software

5 Building a Profit Bridge Application

How to design, configure, and implement a Profit Bridge application

6 Running a Profit Bridge Application

How to execute a Profit Bridge application

7 Using Third-Party-Model Sockets

How to configure a third-party-model socket

A Profit Bridge Error Messages

Explanations of error messages that can be given by Profit Bridge, and suggestions on how to resolve them

B Datapool Parameters and Custom Variables

Identifies datapool parameters and custom variables contained by a Profit Bridge application

Page 9: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

About This Publication

8/02 Profit Bridge User's Guide ix Honeywell

Writing Conventions Used in This Book

The conventions listed in the following table have been used throughout this book and other books in the APC library.

Convention Meaning "Title" Words in double quotation marks name sections or subsections in this

publication. For example, "Introduction." > Windows pull-down menus and their options are separated by an angle

bracket, >. For example, Under Settings > Communications, set the baud rate.

<KEY> Command keys appear in UPPERCASE within angle brackets. For example, Press <ENTER>.

[BUTTON] Graphic buttons appear within square brackets, [ ]. For example, Touch [TAG].

TPS system user station touch-screen targets appear in rounded boxes. For example, Touch MODIFY NODE

.

Ø and 0 Zero as a value and when there is a chance for confusion with the letter O is given as Ø. In all other cases, zero as a numerical placeholder is given as 0. For examples, 1.0, 10, 101, CVØ1, parameter PØ.

Bold Words in bold type indicate paragraph topics or bring important phrases to your attention.

Courier Messages and information that you type appear in Courier font. display, call The verbs display a screen and call a screen are used interchangeably. display, screen The terms screen and display are used interchangeably when discussing the

graphical interfaces. Italics Words in italic type name book titles, add grammatical emphasis, introduce

words that are being referenced or defined, or represent mathematical variables. The context makes the meaning and use clear.

Shading Shading brings paragraphs and table entries to your attention. UPPERCASE Acronyms, Scan parameters, point names, file names, and paths appear in

UPPERCASE. The context makes the meaning and use clear. Profit Controller,

RMPCT The names Profit Controller (RMPCT), Profit Controller and RMPCT may be used interchangeably.

Profit Design Studio, APC Development Environment

The names Profit Design Studio and APC Development Environment may be used interchangeably.

Profit Optimizer, DQP

The names Profit Optimizer (DQP), Profit Optimizer, and DQP may be used interchangeably.

point.parameter Point.parameter means a point name and one of its parameters. For example, AI100.SP means the SP parameter for the point AI100.

Page 10: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

x Profit Bridge User's Guide 8/02 Honeywell

References Documentation The following documents comprise the Profit Suite library. Title Number

General

Profit Controller (RMPCT) Concepts Reference RM09-400 Profit Controller (RMPCT) Designer’s Guide (Off-Line Design) RM11-410 Profit Optimizer Designer’s Guide (Off-Line Design) PR11-400 Profit Toolkit Designer’s Guide AP11-400 APC Identifier User’s Guide AP09-200 Profit Loop User’s Guide RM11-110 Profit-PID (RPID) User’s Guide RM11-100

Open Profit Suite Installation Guide for Open Systems

Viewer - Controller - Optimizer - Toolkit RM20-501

Profit Controller (RMPCT) User’s Guide for Open Systems RM11-401 Profit Assistant User’s Guide RM11-441 Profit Optimizer User’s Guide for Open Systems PR11-421 Profit Trender User’s Guide RM11-431 Profit Toolkit User’s Guide for Open Systems AP11-401 Profit Toolkit Function Reference AP11-410 FCCU Toolkit User’s Guide for Open Systems AP13-201 Fractionator Toolkit User’s Guide for Open Systems AP13-101 Lab Update User’s Guide AP13-111 Wrapper Builder User’s Guide AP11-411 Profit Bridge User’s Guide AP20-401 Profit SensorPro User's Guide PS11-100 Profit Stepper User’s Guide

TPS System

Profit Controller (RMPCT) Installation Reference for AM, AxM and Open LCN-Side RM20-400 Profit Controller (RMPCT) Commissioning RM20-410 Profit Controller (RMPCT) User’s Guide for AM, AxM and Open LCN-Side RM11-400 Profit Optimizer Installation Reference for AM and Open LCN-Side PR20-400 Profit Optimizer User’s Guide for AM and Open LCN-Side PR11-420 Profit Suite ToolKit AP09-300 TDC Data Converter

Data Collector Step Test Builder

Performance Monitor RMPCT Cascade PV Validation

Simulation BackBuilder Gain Scheduler

Fractionator Toolkit (LCN) AP13-100 FCCU Toolkit (LCN) AP13-200 Furnace Pass Balance Temperature Control User’s Guide AP13-600

Page 11: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Table of Contents

8/02 Profit Bridge User's Guide Honeywell

��

Non-Linear Level Control User’s Guide AP09-700 Embedded Uniformance

Excel Companion User’s Guide (Profit Embedded PHD) AP20-510 Power Point Companion User’s Guide (Profit Embedded PHD) AP20-520 Process Trend User’s Guide (Profit Embedded PHD) AP20-530

Page 12: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

xii Profit Bridge User's Guide 8/02 Honeywell

For Technical Assistance If You Need Assistance

If you need technical assistance, contact your local Honeywell Service Organization, as explained in the following paragraphs.

International Customers

Outside of the United States, contact your local Honeywell Service Organization. If you are not sure of the location or telephone number, call your Honeywell representative for information.

Customers Inside the United States

Within the United States, call the Technical Assistance Center (TAC) at the toll-free number 800-822-7673.

Arizona Customers

Within Arizona, the local number for TAC is 602-313-5558.

Services Provided

Calls to TAC are answered by a dispatcher from 7:00 A.M. to 5:00 P.M., Mountain Standard Time (6:00 A.M. to 4:00 P.M. when daylight savings time is in effect).

Outside of these hours, emergency calls—those regarding a problem that affects your ability to control or view a process—will be received by an answering service, and returned within one hour. TAC maintains its own TPS network, and frequently can duplicate problems on this equipment.

To Obtain a Software Key

To enhance licensing options, Profit Bridge uses a unique hexadecimal code (software key) to activate the control software for each controller built. To obtain this key, contact Honeywell Hi-Spec Solutions at 602-313-4357 or through e-mail at [email protected].

Time-saving Tip To reduce delays and expedite answers to your questions, make specific notes about the problem before calling TAC.

Page 13: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide 1 Honeywell

Section 1 – Introduction to Profit Bridge

1.1 Overview In This Section Section 1 introduces the Profit Bridge components and how they fit into the Profit

Suite architecture. This section also defines circumstances for using Profit Bridge.

What is Profit Bridge?

Profit Bridge is a component of Honeywell’s Profit Suite. It automates the on-line updating of process model gains in Profit Controller and Profit Optimizer applications.

What Does Profit Bridge Do?

Profit Bridge enables the calculation and updating of Profit Controller and Profit Optimizer process model gains. Profit Bridge can use any of the following as process models to calculate the process model gains:

�� Honeywell inferential-property functions

�� Third-party models

�� Custom functions

Profit Bridge functions are executed as part of a Profit Toolkit application and corresponding Profit Controller and/or Profit Optimizer applications.

Version Information

Profit Bridge functionality was introduced in version 220.00 of the Profit Design Studio.

Page 14: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 2

1.2 Profit Suite Overview Components Profit Suite consists of both design and runtime components:

�� Design: The primary design component is called Profit Design Studio (formerly called Advanced Process Control Development Environment, APCDE).

�� Runtime: The primary runtime components include the following:

– Profit Controller - Profit Toolkit

– Profit Optimizer - Profit Viewer

Each of these components is further described in this section.

The following figure shows Profit Suite components and their general interaction.

Figure 1.1-1. Example Configuration

Profit Design Studio

Honeywell’s Profit Design Studio, the primary design component, is a Microsoft Windows-based environment that enables many advanced process control tools to be implemented through a common interface. Profit Design Studio functionality can be easily expanded by the addition of task-specific components (libraries that are dynamically loaded as needed).

Several components are currently available for use in Profit Design Studio and Profit Bridge is one such component.

Page 15: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.2 Profit Suite Overview

8/02 Profit Bridge User's Guide Honeywell

3

Profit Viewer

Profit Viewer is the primary user interface to on-line applications. Parameters of Profit Controller, Profit Optimizer, and Profit Toolkit applications can be viewed and modified.

Figure 1.1-3. Profit Viewer Application Menu

Profit Controller (RMPCT)

Profit Controller is a robust multivariable predictive control technology (RMPCT). Its Profit Design Studio component is used to create the configuration and model files necessary for its execution, based on the model provided by the PDS Identifier. The controller can be used on-line to control the actual process, and can also be tested on a simulated process using the off-line software.

Figure 1.1-4. Profit Viewer with Profit Controller

Page 16: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.2 Profit Suite Overview

Profit Bridge User's Guide 8/02 Honeywell 4

Profit Optimizer (DQP)

Profit Optimizer is a distributed quadratic program (DQP) optimizer that runs in a fully dynamic fashion to provide optimal guidance to multiple Profit Controller applications. Its Profit Design Studio component creates the configuration and model files that are necessary for its execution by merging the associated Profit Controller model files.

Figure 1.1-5. Profit Viewer with Profit Optimizer

Profit Toolkit

Profit Toolkit is an application and function library that supports the run-time execution of functions from other Toolkit libraries. Currently, Profit Toolkit supports libraries for Fluid Catalytic Cracking Units (FCCU Toolkit), fractionators (Frac Toolkit), automated process model gain updating for Profit Controller and Profit Optimizer (Profit Bridge), and various other general-purpose functions.

Page 17: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.2 Profit Suite Overview

8/02 Profit Bridge User's Guide Honeywell

5

Figure 1.1-6. Profit Viewer with Profit Toolkit

Page 18: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 6

1.3 Profit Bridge Overview Purpose Profit Bridge enables the calculation, validation, and online updating of Profit

Controller and Profit Optimizer process model gains. Profit Bridge can use �� Honeywell inferential-property functions, �� third-party models, and �� custom functions as process models to calculate the process model gains.

Components Profit Bridge consists of an off-line configuration tool in Profit Design Studio and on-line components. The on-line components are distributed among a Profit Toolkit application and the corresponding Profit Controller and Profit Optimizer applications whose process model gains are updated.

The Profit Toolkit application extracts and validates the gains using process model functions. The gain extraction functions include the process model functions, independent variable perturbing function, gain calculation function, and gain validation function. The Profit Toolkit application then sends the validated gain information to the pertinent Profit Controller and Optimizer applications.

The Profit Controller and Profit Optimizer applications update their respective gains. The gain updating is performed using the gain mapper function and the on-line gain/delay updating features of Profit Controller and Profit Optimizer. The gain mapper collects the validated gain information sent by the Profit Toolkit application, then applies filter, rate-of-change, and deadband processing.

Gain Scheduling and Profit Bridge

Traditionally, gain scheduling is thought of as the implementation of different controller gains based on a look-up table and process values. The goal is to tune the controller appropriately for changing process characteristics based on the measurements of process conditions.

Profit Bridge accomplishes a similar result by providing process model gains to model-based controllers. In addition to being able to use process model functions that return values based on a look-up, Profit Bridge can be used with process models based on fundamental chemical engineering principles and statistics.

When Should Profit Bridge Be Used?

Use of Profit Bridge should be considered when process gains change significantly enough over normal or expected operating conditions where the control performance is unacceptable and/or the optimization direction pushes the process to an inferior solution. Profit Bridge should be used when a sufficiently accurate process model is available or can be economically developed.

An example of a good use of Profit Bridge would be for optimizing product yields when a process model is available that can be used to improve product yield predictions.

Page 19: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.3 Profit Bridge Overview

8/02 Profit Bridge User's Guide Honeywell

7

When Might Profit Bridge Not Be the Best Technology to Use?

Profit Bridge might not be advantageous for improving control performance

�� for processes whose gain characteristics vary little, i. e., where their gain characteristics are nearly linear.

�� for processes that are not modeled accurately enough. �� if, with respect to the desired closed-loop response time, significant changes

in process gain are relatively frequent, and the process exhibits relatively large time delays or inverse-response characteristics. The effects of such process nonlinearities on control performance might be better handled through the use of CV transformations.

Page 20: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 8

1.4 Profit Bridge Application Architecture Design and Runtime Components

As mentioned in Sections 1, 4 and 5, the runtime components are distributed among a Profit Toolkit application and the corresponding Profit Controller and Profit Optimizer applications whose process model gains are updated. The Profit Toolkit application contains the process model functions and gain extraction functions. The corresponding Profit Controller and/or Profit Optimizer applications contain the gain mapper function.

The configuration file for the Profit Bridge application is configured with Profit Design Studio. In addition, the configuration file for Profit Optimizer and Controller is modified by Profit Design Studio when Profit Bridge is configured. See the following figure for an example.

Figure 1.4-1. Profit Bridge Design and Runtime Connections Example

Design

Runtime

Profit Toolkit(Gain Extraction)

Application

ProcessModel

IndependentVariable Values

Dependent Variableand/or Gain Values

Profit Controlleror Optimizer

Application w/GainMapper

Validated Gains andrelated info.

Profit Controllerand Optimizer

model files

Profit DesignStudio

- Profit Bridge

Profit Controllerand Optimizer

configuration files

Profit Toolkit/Profit Bridge

configuration file

Page 21: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.4 Profit Bridge Application Architecture

8/02 Profit Bridge User's Guide Honeywell

9

Functional Flow A Profit Bridge application has the following functional flow at each execution.

�� Read process data and application parameters �� Perform pre-extraction functions �� Perform gain extraction functions �� Perform post-extraction functions �� Write gain information to applications with gain mappers Figure 1.4-2 illustrates this.

Figure 1.4-2. Profit Bridge Runtime Functional Flow

RetrieveInputData

Pre-ExtractionFunctions

Gain Extraction Post-ExtractionFunctions

ExportGainData

Gain Extraction Functions

Some modeling systems are able to provide steady-state process gains directly for a specified set of independent variable values. Such functions are configured as post-extraction functions.

For those modeling functions or systems that do not provide the gains directly, Profit Bridge provides the HSTool_GainPerturb (perturbation) and HSTool_GainCalculate (gain calculation) functions to facilitate gain extraction. These functions are executed for the perturbed sets of independent variables.

In addition, Profit Bridge provides the HSTool_GainValidate function to validate the calculated and provided gains. This function is configured as the last post-extraction function.

Pre- and Post-Gain Extraction Functions

The pre-extraction and post-extraction function sections are provided for flexibility. In addition to the uses just mentioned, additional filtering, validation, units conversion, or other desired processing could be configured for these sections.

Gain Extraction Loops

The gain extraction requires multiple executions of the perturbation, process model, and gain calculation functions. Consequently, these functions are executed inside a double loop. The outer loop is for the independent variable perturbation groups. The inner loop is for the perturbation steps. Figure 1.4-3 illustrates this.

Page 22: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.4 Profit Bridge Application Architecture

Profit Bridge User's Guide 8/02 Honeywell 10

Modeling Functions

Profit Bridge accommodates any function written to execute under Profit Toolkit. These functions include

�� Honeywell inferential-property functions �� third-party modeling systems �� custom functions To enable third-party modeling systems to execute as a Profit Toolkit function, the model system will be encapsulated in a Toolkit wrapper called a model socket. For example, there could be model sockets for Dot Product Inc.’s NOVA Optimization and Modeling System or for KBC’s FCC-SIM. Any additional custom functions must be encapsulated in a Toolkit wrapper.

Figure 1.4-3. Gain Extraction Loops

GainMapper Application Coordination

Each Profit Controller or Profit Optimizer with a GainMapper Toolkit function has a set of custom variables that serves as a buffer for receiving [via OLE for Process Control (OPC)] the gain information to be used for updating. These custom variables are considered buffers because they can be used by multiple Profit Bridge Toolkit applications, since their contents are not necessarily specific to a single Profit Bridge toolkit application.

The gain mapper function monitors the value of its “GainMapperPC1\Execute” (or “GainMapperPO1\Execute”) custom variable. When this value is 0 or less (OFF mode), the GainMapper functionality is skipped. When this value is 1 (ON mode), the GainMapper functionality is executed and the model gains are updated. When this value is 2 (WARM mode), the GainMapper validation and filtering functionality is executed, but the model gains are not updated. After the GainMapper has executed, the GainMapper resets its “\Execute” variable to zero.

Page 23: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.4 Profit Bridge Application Architecture

8/02 Profit Bridge User's Guide Honeywell

11

In the gain extraction application, elements of the “GMUpdate” array are connected (via OPC) to each gain mapper’s “\Execute” variable. A value of 0 in the “\Execute” variable indicates that the gain mapper application is “unlocked” and it’s gains can be updated. Any non-zero value indicates that the gain mapper is “locked” and its gain mapper is in use by another application.

As the process model gains are validated by the Profit Bridge Toolkit application, the gain values, associated dependent and independent variable indices, and other related data are stored into the Profit Bridge Toolkit application’s variables that correspond to “unlocked” gain mapper applications. Values are not stored if the associated gain mapper application is “locked.” Figure 1.4-4 illustrates the connections between a Profit Bridge Toolkit application and a Profit Controller application.

Figure 1.4-4. Profit Bridge-to-Profit Controller Communications

Profit Bridge Toolkit App.

GMUpdate[n]

Gain Values,Indices, and

other related data

GainValidation

set

set

Profit Controller App.

GainMapperPC1\Execute

Gain Values,Indices, and

other related data

GainMapper

reset

reset

OPC

OPC

Page 24: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 12

1.5 Profit Bridge Features Gain Extraction Concepts

Before presenting features of Profit Bridge, a few concepts about gain extraction are reviewed.

For a given dependent variable and independent variable pair, gain extraction obtains the ratio of the steady-state change of the dependent variable value to the change of the independent variable value (that caused the change in the dependent variable). To do this, it uses a process model at specified sets of process conditions. The change in the independent variable value is called the perturbation step size. The ratio is called the gain and is calculated as follows:

)1()2()1()2(

conditiontindependenconditiontindependenconditiondependentconditiondependentGain

Example: A distillation column model yields an overhead impurity concentration of y1 at a reflux flow rate of u1. Likewise, the distillation column model yields an overhead impurity concentration of y2 at a reflux flow rate of u2. The steady-state process gain for these conditions is (y2-y1)/(u2-u1), given that all other independent variables that affect the overhead impurity were held constant. So the gain can be thought of as a measure of the average response of a dependent variable to a unit change of the independent variable across a set of process conditions. As the perturbation step size gets infinitesimally small, the gain approximates the derivative of the dependent variable with respect to the independent variable.

Dependent Variables (“Type”)

Profit Bridge characterizes its dependent variables as Controlled Variables (CV), Bridge Output Variables (BO), and Combined Constraint Variables (CC). CVs are associated with Profit Controller applications. BOs and CCs are associated with Profit Optimizer applications. The off-line configuration software sets the dependent variable Type* parameter in the Profit Toolkit configuration file, to correspond to one of the above values. * The Type parameter for dependent variables is a number: 0 indicates “CV”, 1 indicates “BO”, and 2 indicates “CC.”

Independent Variables (“Type” and “Source Indep”)

Profit Bridge characterizes its independent variables as Manipulated Variables (MV), Disturbance Variables (DV), and Clone DVs. The off-line configuration software sets the independent variable Type* parameter in the configuration file.

Page 25: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.5 Profit Bridge Features

8/02 Profit Bridge User's Guide Honeywell

13

When an independent variable appears in more than one control application (possibly under different names), one instance of that independent variable must be (implicitly) specified as the source, with type MV or DV, and the remaining instances must be defined as Clone DVs. The source is typically a MV and its Source Indep parameter is set to zero. The remaining DVs are specified as Clone DVs and their Source Indep parameters are set to the index of the source MV or DV in their control application. * The Type parameter for independent variables is a number: 0 indicates “MV”, 1 indicates “DV”, and 2 indicates “Clone DV.”

Perturbation (“Step Size” and “Deriv Type”)

Perturbation can be thought of as moving the process (or process model) from one set of conditions to another by changing an independent variable value. When the process gain is desired for a specific process condition (the reference condition), the independent variable change is small so that both the original and perturbed conditions are near the specific condition. The numerical differentiation (gain calculation) is done using data from these conditions. You set the size of the perturbation with the independent variable Step Size parameter. Three different types of numerical differentiation are available: Forward, Backward, and Central differentiation. In forward differentiation, the step size is added to the independent variable reference condition to obtain the perturbed condition. In backward differentiation, the step size is subtracted from the reference condition to obtain the perturbed condition. In central differentiation, half of the step size is added to the independent variable reference condition to obtain one perturbed condition and half of the step size is subtracted from the independent variable reference condition to obtain a second perturbed condition. The two perturbed conditions are used to calculate the process model gain. The differentiation type is set with the Deriv Type parameter*. A fourth option for Deriv Type is None *. This option is specified for independent variables that are only used with modeling systems that provide gains directly. A Clone DV gets its reference value, Step Size, and Deriv Type values from the independent variable identified as its source. Currently, with small step sizes, it will make little difference whether forward, backward, or central differentiation type is chosen. For independent variables that are to be perturbed, leaving the differentiation type at the default (forward) is recommended. (* The Deriv Type parameter is a number: 0 indicates “none”, 1 indicates “forward”, 2 indicates “backward”, and 3 indicates “central”.)

Page 26: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.5 Profit Bridge Features

Profit Bridge User's Guide 8/02 Honeywell 14

Perturbation Groups (“Pass Index”)

Another characteristic associated with perturbation is the perturbation group. Sometimes a group of independent variables has no effect on the same dependent variables. For example, independent variable u1 may have modeled relationships only with dependent variables y1 and y2; and independent variable u2 may have modeled relationships only with dependent variables y3 and y4. If the independent variables do not affect any of the same dependent variables, the independent variables can be assigned to the same perturbation group so that they are perturbed simultaneously, thus saving computation time.

Specify the independent variables to be perturbed on the same execution pass by giving them a common positive integer Pass Index value. Think of the Pass Index as a perturbation group number. If the Pass Index for an independent variable is set to zero (its default) in the design configuration, it is reassigned a unique Pass Index value at run time. Clone DVs, however, are assigned the Pass Index of their source.

Simulation Conditions (“Base” and “Step”)

The independent variable conditions simulated with the process models are found in the Base array parameter of the independent variables. Likewise, the corresponding calculated dependent variable conditions are stored in the Base array parameter of the dependent variables. At the beginning of each execution interval, the reference values of the independent variables are read in and stored in the Base[0] elements. The reference value is configured as the current value of the MV or DV. Using the independent variable’s Base[0] and StepSize, values for the Base[1] and possibly Base[2] elements are calculated. For independent variables whose DerivType is “forward” or “backward,” only the Base[1] element is calculated. For independent variables whose DerivType is “central,” both Base[1] and Base[2] are calculated. At each iteration of the gain extraction loop, the appropriate Base[ ] element for each independent variable is moved into its Step parameter. The value of the Step parameter is passed into the model function. In the corresponding iterations, the model function executes and returns the calculated value of the dependent variable into its Step parameter. At the execution of the gain calculation function, the dependent variable’s Step parameter is moved into the appropriate element of its Base array. Note that modeling functions outside the gain extraction loop only require the Base[0] parameter values of the independent variables. If there are no modeling functions inside the loop, then the Base[1], Base[2] and Step parameters are not used. In this case, use of the Base[0] parameter for dependent variables depends on the modeling function and is optional.

Page 27: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.5 Profit Bridge Features

8/02 Profit Bridge User's Guide Honeywell

15

Gain Calculation (“Calc Type” and “Current”)

The gain calculation function executes each iteration inside the gain extraction loop. However, the gains are only calculated once all required information is available, which is on the last iteration. Gains that are to be calculated by the gain calculation function inside the loop have a Calc Type* of “calculated.” * As each gain is associated with a dependent and an independent variable, the gain calculation method depends on the DerivType of the associated independent variable. For gains associated with an independent variable whose DerivType is “forward” or “backward”, the Base[1] and Base[0] elements of the independent and dependent variables are used. For gains associated with independent variables whose DerivType is “central”, Base[2] and Base[1] are used. The results of the gain calculation are stored in the gain’s Current parameter. Gains that are to be provided by modeling functions outside the loop have a Calc Type of “provided”*. As with the “calculated” gains, modeling functions outside the loop store the “provided” gains in the Current parameter. If for some reason a specific gain should not be calculated, its Calc Type can be set to “don’t calculate”*. (* The Calc Type parameter is actually a number: 0 indicates “don’t calculate”, 1 indicates “calculate”, and 2 indicates “provided”. The user interface term “extracted” gain is synonymous with “calculated” gain. The user interface term “Extracted with modifications” is a type of “calculated” gain.)

Gain Validation (“Validated”, “Valid Coeff”, and “Previous”)

After all gains have been calculated or provided, the gain values are tested against two validation criteria in the Gain Validation function. The gains are checked against maximum and minimum values. The maximum value is stored in parameter Valid Coeff[0]. The minimum value is stored in Valid Coeff[1].

If the gain’s current parameter value fails a validation test, the gain can be clamped at the limit or rejected. This option is chosen at configuration time. To change this option at runtime, parameter Valid Coeff[2] is set to 0 to reject the gain or is set to 1 to clamp the gain at the violated limit.

If the gain passes the validation or the gain is clamped at a limit, the current calculated gain is copied into the Validated parameter. If the gain fails the validation and is rejected, the Previous validated gain value is copied into the Validated parameter.

Once gains have been validated, the validated gain values and associated mapping indices and filtering parameter values are copied into buffer arrays to be sent to the Profit Controller and/or Profit Optimizer applications with GainMapper functionality.

Gain Mapping At each execution interval of the Profit Controller or Profit Optimizer application, its GainMapper function checks the gain information buffer arrays and the “\Execute” custom variable for new data with which to update the process gains of its application. See Section 2 of this manual for more detail of the gain mapping process.

Page 28: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 1 – Introduction to Profit Bridge 1.5 Profit Bridge Features

Profit Bridge User's Guide 8/02 Honeywell 16

Gain Mapping Mode: OFF, ON, or WARM

The value that the Profit Bridge Toolkit application uses to set the value of the GainMapper’s “\Execute” variable is specified by the toolkit’s custom variable “GainValid1\GMUpdateMode”.

When this value is 0 or less (OFF mode), the GainMapper functionality is skipped. When this value is 1 (ON mode), the GainMapper functionality is executed and the model gains are updated. When this value is 2 (WARM mode), the GainMapper validation and filtering functionality is executed, but the model gains are not updated. After the GainMapper has executed, its “\Execute” variable is reset to 0.

Exponential, Maximum Rate-of-Change, and Minimum Change (Deadband) Filtering of Validated Gains (“Valid Coeff”)

The gain mapper function implements exponential, maximum rate-of-change, and minimum change (deadband) filtering of the process gains. The parameter values for these filters are provided to the gain mapper by the Profit Bridge Toolkit application. The exponential filter coefficient is specified as a number from zero to one in the Valid Coeff[3] parameter. The coefficient specifies the fraction of the current value applied to the filtered value. So a value of one implies no filtering. A value near zero implies very heavy filtering. And zero is not a legal value. The filtering equation is

)1(*)1()(*)( ���� tgctgctg ff

where g(t) is the validated gain at update interval t, gf(t) is the filtered gain at time, and c is the filter coefficient. The maximum rate-of-change value is specified as a positive value with engineering units of the gain’s units per update. This value is specified in the Valid Coeff[4] parameter. The gain is rejected if the magnitude of the difference between its current value and previous value is greater than the maximum rate-of-change specified. The minimum change value is specified as a positive value with engineering units of the gain’s units per update. This value is specified in the Valid Coeff[5] parameter. The model gain is not updated if the magnitude of the difference between its current value and the previous value is smaller than the minimum change specified.

Page 29: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide 17 Honeywell

Section 2 – GainMapper for Profit Controller (GainMapperPC)

2.1 Introduction In This Section This section describes the use of the GainMapper for Profit Controller (Function

alias: GainMapperPC) toolkit function, its related error indications, how it logs gain changes, and its Datapool inputs and outputs.

Terminology GainMapper An optional toolkit function that, depending on the value of its custom variable, updates the model gains and performs validation and filtering.

GainMapperPC An optional toolkit function that takes a list of new gains and their respective CV and MV/DV indices and updates the corresponding gain multiplier, thereby affecting a gain change for the CV/MV-DV pair.

CV/MV-DV pair Another way of saying CV/MV or CV/DV pair. A unique model (therefore gain) is associated with each CV/MV or CV/DV pair.

Usage of GainMapper

GainMapper can either be used as part of a greater gain extraction scheme or can be used as a stand-alone utility.

Incentive to Use GainMapper

GainMapper provides you with a mechanism to update a set of gains. This mechanism is generally used when “swinging” a set of gains, because a process has changed operating regions, for example, in a refinery on a Crude Oil swing. Typically GainMapper is used as part of a “gain update” scheme where a program such as another toolkit function inputs the desired gains into the GainMapper.

Page 30: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 18

2.2 Using GainMapper GainMapper Functions Created by RMPCT Point Builder

The Profit Controller (RMPCT) Point Builder creates a single instance of the GainMapper toolkit function with the following alias:

GainMapperPC – which stands for GainMapper for Profit Controller. How Many Gains Can be Changed at One Time?

The size of the gain mapping array is determined by Profit Design Studio, based on the number of non-null models in the controller.

Datapool Parameters Involved in a Gain Update

The following custom Datapool parameters must be set accordingly to do a gain update. Here are the descriptions of the Datapool parameters:

�� GMGain[1..nn] – New set of Gains

�� GMCVIndex[1..nn] – CV number corresponding to desired gain

�� GMMVDVIndex[1..nn] – MV or DV number corresponding to desired gain

�� GMFilterCoeff[1..nn] – Gain filtering parameter values

�� GMROCLimit[1..nn] – Maximum rate of change limit for gains

�� GMROCDeadband[1..nn] – Deadband limit for gains

�� GMErrorAction – What action to take if errors are encountered GainMapper Execution

The GainMapper will not Execute if the Execute parameter is equal to zero. The GainMapper will execute only when the Execute parameter is set to a non-zero value. Following the execution, the Execute parameter is set back to zero.

Invoking the GainMapper via the Execute Parameter

The GainMapper supports invocation commands via the Execute parameter. The following commands are available:

�� Update – attempts to update the gains according to gain mapping data.

�� Validate – validates the gain mapping data and reports any errors, for example CV and MV indices, the gain value, etc. This command does not change gains under any circumstances.

Only Validating the Gains

If you decide to validate the gains without doing an update, then the Execute parameter should be set to 2. Once the validation is complete, Execute is automatically reset to 0, and any error messages are displayed in the message log and in the Return parameters. See the Return Status table below.

Note: It is a good idea to use the “validation” option if you are unfamiliar with the operation of GainMapper.

Page 31: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 2- GainMapper for Profit Controller (GainMapperPC) 2.2 Using GainMapper

8/02 Profit Bridge User's Guide Honeywell

19

Rate of Change Check

The GainMapper does rate of change limit checking on the new gain based on a rate of change limit that you supply.

The gain will not update, if …

Abs(New Gain – Current Gain) > Abs(ROC Limit)

Abs is absolute value. Deadband Check The GainMapper does deadband checking on the new gain based on a rate of

change limit that you supply. Simply put, the gain will only change if the gain change is greater than the deadband.

The gain will not update, if …

Abs(New Gain – Current Gain) < Abs(ROC Deadband)

Abs is absolute value.

Page 32: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 2- GainMapper for Profit Controller (GainMapperPC) 2.2 Using GainMapper

Profit Bridge User's Guide 8/02 Honeywell 20

Filtering in the New Gain

You can set a filter coefficient that allows a gain to be ramped from its current gain to its new gain in a smooth fashion.

The new gain is calculated as follows: NewGain = DesiredGain * GMFilterCoeff + Current Gain * (1 – GMFilterCoeff[I]) If the filter coefficient is set to either bad value or 1, then filtering is effectively disabled and the new gain is applied in full. The filter coefficient must be a value greater than zero and less than or equal to 1.

Example – Using the GainMapper

In order to use the software, you must set the aforementioned Datapool parameters. You must identify the CV/MV or CV/DV pairs whose gains will be changed. This is done by identifying the CVs by their numerical order in the Profit Controller and identifying the MVs and DVs by their numerical order in the Profit Controller. Note that DVs must be treated as an extension to the MVs. Here is an example: Let’s say that Profit Controller had five CVs, three MVs, and two DVs. If you wanted to change the gains of pairs CV3 and MV2 to 5, CV3 and DV2 to 2.2, CV4 and MV1 to 0.25, CV4 and MV3 to 0.1, and CV4 and DV1 to 0.5, the corresponding values of parameters GMCVIndex, GMMVDVIndex and GMGain would be set as follows:

Array

Location GMCVIndex GMMVDVIndex GMGain Description

1 3 2 5 Change gain of CV3 and MV2 to 5 2 3 5 2.2 Change gain of CV3 and DV2 to 2.2

(note that the GMMVDVIndex is set to 5 = total # of MVs + DV# = 2 + 3

3 4 1 0.25 Change gain of CV4 and MV1 to 0.25 4 -9999 -9999 ------ Ignore this row 5 4 3 0.1 Change gain of CV4 and MV3 to 0.1 6 4 4 0.5 Change gain of CV4 and DV1 to 0.5 7 -999 -999 ------ Set GMCVIndex and/or

GMMVDVIndex to –999 to indicate to the GainMapper to stop processing gains.

Note that the array location where the CV/MV or CV/DV pair is entered is not

relevant. An error will occur if either GMCVIndex or GMMVDVIndex contains a zero or a negative value in the array. GMCVIndex and GMMVDVIndex must be integers.

Page 33: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 2- GainMapper for Profit Controller (GainMapperPC) 2.2 Using GainMapper

8/02 Profit Bridge User's Guide Honeywell

21

How is the Gain Multiplier Calculated?

The GainMapper calculates the gain multiplier as follows:

GainMult = gFactorMVDVScalinactorCVScalingFDesignGain

NewGain*

1*

The following inferences are made from this equation: DesignGain, CVScalingFactor and MVDVScalingFactor must all be non-zero values; the implication being that you can only change gains for valid, non-null models.

Page 34: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

� ������������� ��� ������ �����

� ������������

2.3 Error Indications Errors Reported All errors are logged to the application’s log file. A typical error message is

shown: “Can't update gain for Rownn CVnn/MVDVnn. Problem is ………” So, a typical error message contains the following information: �� Row Number, the index in the Gain Mapping arrays. �� The CV/MV-DV pair, whose gain you are attempting to change. And finally, �� The problem associated with the given CV/MD-DV pair. See the Return Status Table below for a complete list of errors.

Actions to Take when an Error is Detected

The error handling options, which can be configured using the GMErrorAction parameter, are as follows: �� Skip the gain(s) in error, but continue with the rest of the gain updates

(GMErrorAction = 0), �� Skip all updates when an error is encountered (GMErrorAction = 1).

Return Status Table

The tables that follow show the error and warning messages associated with the function.

Return Status Table

Status value

Description

0 No error occurred. 1 The following messages will be displayed if there are problems with reading or writing to the

Datapool. �� Can't attach to Datapool parameter - _______ �� Can't get Datapool parameter - _______ �� Can't put Datapool parameter - _______ ______ indicates the parameter involved in the attach/get/put.

Note that the previous messages should not appear in a normal operating scenario, as it should always be possible to read/write to the Datapool.

2 Can't update gain for Rownn CVnn/MVDVnn. Problem is CV# > total number of CVs. 3 Can’t update gain for Rownn CVnn/MVDVnn. Problem is CV# is bad. 4 Can’t update gain for Rownn CVnn/MVDVnn. Problem is CV# < 1. 5 Can’t update gain for Rownn CVnn/MVDVnn. Problem is MV/DV# > Number of MV+DVs. 6 Can’t update gain for Rownn CVnn/MVDVnn. Problem is MV/DV# is bad. 7 Can’t update gain for Rownn CVnn/MVDVnn. Problem is MV/DV# < 1. 8 Can’t update gain for Rownn CVnn/MVDVnn. Problem is Gain is bad.

Page 35: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 2- GainMapper for Profit Controller (GainMapperPC) 2.2 Error Indications

8/02 Profit Bridge User's Guide Honeywell

��

Return Status Table

Status value

Description

9 Can’t update gain for Rownn CVnn/MVDVnn. See parameter CVnn.ModelIndex[nn]. Problem is Model Index is bad.

10 Can’t update gain for Rownn CVnn/MVDVnn. See parameter CVnn.ModelIndex[nn]. Problem is Model Index is > number of submodels.

11 Can’t update gain for Rownn CVnn/MVDVnn. See parameter CVnn.ModelIndex[nn]. Problem is Model Index is <= 0.

12 Can’t update gain for Rownn CVnn/MVDVnn. See parameter CVnn.ScalingFactor. Problem is CV Scaling Factor is bad.

13 Can’t update gain for Rownn CVnn/MVDVnn. See parameter CVnn.ScalingFactor. Problem is CV Scaling Factor is zero.

14 Can’t update gain for Rownn CVnn/MVDVnn. See parameter MVnn.ScalingFactor. Problem is MV Scaling Factor is bad.

15 Can’t update gain for Rownn CVnn/MVDVnn. See parameter MVnn.ScalingFactor. Problem is MV Scaling Factor is zero.

16 Update flag of ___ is invalid, value must be either 1 or 2. No gains updated. Note that ___ is the invalid user setting.

17 Can’t update gain for Rownn CVnn/MVDVnn. Problem is filter coefficient must be > 0 and <= 1.

18 Can’t update gain for Rownn CVnn/MVDVnn. Problem is gain change is > rate of change limit.

19 Can’t update gain for Rownn CVnn/MVDVnn. Problem is gain change is < deadband. 20 GMGAIN array either doesn't exist.

Note: This typically means that the GMGAIN custom variable has not been included in the CFG file.

21 Was not able to load message file: _______. Note: This typically means that a message file associated with gain mapping has not been properly installed.

Page 36: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 24

2.4 Logging Gain Changes How To Enable Logging of Gain Changes

The GainMapper provides a mechanism to log successful gain updates to the application log file. This mechanism may be turned on using the DoLogging parameter. A value of 0 for this parameter turns logging off, and a value of 1 for this parameter turns logging on. The default has logging turned off so the application log file is not inundated with gain change information. The following format message is sent to the log file: Gain updated for Rownn CVnn/MVDVnn. Current Gain is x.xxxxxx, Gain is filtering to x.xxxxxx

Page 37: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide Honeywell

��

2.5 Profit Controller Datapool Datapool Table The Datapool tables that follow provide a description of the function gain mapper

inputs and outputs that are resident as custom parameters in the Profit Controller Datapool.

Input [ ]

denotes array

Description

GMGain[ ] Array of new gains to be mapped into a corresponding multiplier.

GMCVIndex[ ] Array of CV numbers that corresponds to the new gain. Setting this value to –999, indicates that gain processing should stop at this array index. Setting this value to –9999, indicates that gain processing is skipped for this array index.

GMMVDVIndex[ ] Array of MV or DV numbers that corresponds to the new gain. When inputting a DV index, set the value equal to the total number of MVs plus the DV number. The combination of GMCVIndex and GMMVDVIndex makes up the CV/MV-DV pair. Setting this value to –999 indicates that gain processing should stop at this array index. Setting this value to –9999, indicates that gain processing is skipped for this array index.

GMFilterCoeff[ ] Array of filter coefficients. Value should be greater than zero and less than or equal to 1. The full gain is applied (thereby no filtering is done) if this value is set to NaN.

GMROCLimit[ ] Array of gain rate of change limits (in gain units). The absolute value of GMROCLimit will be used. No rate of change limit check is done if this value is set to NaN. The gain will not be changed if the gain change exceeds this limit.

GMROCDeadBand[ ] Array of gain deadband (in gain units). The absolute value of GMROCDeadBand will be used. No deadband check is done if this value is set to NaN. The gain will only be changed if the gain change exceeds this limit.

GMErrorAction Action to take when an error is encountered. 0 = Skip the gain(s) in error and continue with the rest of the gains. 1 = Skip all updates when an error is encountered.

Output Description

Execute Flag indicating whether to update the gains. 0 = No update 1 = Update gains 2 = Validate gains (this command does not do an update) Following the update or validation, the parameter is automatically set back to 0.

Page 38: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 2- GainMapper for Profit Controller (GainMapperPC) 2.5 Profit Controller Datapool

� ������������� ��� ������ �����

� ������������

Input Table The input table provides a description of the function inputs. Input Table

Input Description Execute Flag indicating whether to update the gains.

0 = No update 1 = Update gains 2 – Validate gains (this command does not do an update) Following the update or validation, the parameter is automatically set back to 0.

DoLogging Flag indicating whether to log successful gain requests (0=no logging, 1=do logging). Note that successful gain updates are logged into the application message log as follows: Gain updated for Rownn CVnn/MVDVnn. Current Gain is x.xxxxxx. Gain is filtering to x.xxxxxx.

MessagePrefix Message Prefix for log messages. For internal use only.

RetNum The maximum number of simultaneous messages to be raised for this function. This value is set to 20.

Output Table The output table provides a description of the function outputs. Output Table

Output [ ] denotes array

Eng. Units

Description

Ret_Status Number of error messages The sign of Ret_Status (either positive or negative) also controls the coloring of the function error status Red = positive = at least one error message is displayed Yellow = negative = These are only warning message(s)

RetStatus[RetNum] Array of current function return statuses. See the Return Status Table in Section 3.3. RetMessage[RetNum] String Array of messages containing the current set of error messages raised against the

function. RetFloat[RetNum] Array of float arguments associated with the error messages. For internal use only.

RetString[RetNum] String Array of string arguments associated with the error messages. For internal use only.

Page 39: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide 27 Honeywell

Section 3 – GainMapper for Profit Optimizer (GainMapperPO)

3.1 Introduction In This Section This section describes the use of the GainMapper for Profit Optimizer (Function

alias: GainMapperPO) toolkit function, it’s related error indications, how it logs gain changes, and it’s Datapool inputs and outputs.

Terminology Application This can refer to a variety of things, including the DQP application, or the RMPCT application. However as it relates to the GainMapper, it refers specifically to the RMPCT applications associated with DQP.

Profit Optimizer A distributed quadratic program (DQP) optimizer that runs in a fully dynamic fashion to provide optimal guidance to multiple Profit Controller applications.

BM Bridge Model BI & BO Bridge Input and Bridge Output CC Combined Constraints GainMapper An optional toolkit function that, depending on the value of

its custom variable, updates the model gains and performs validation and filtering.

GainMapperPO An optional toolkit that takes a set of new Bridge Model gains and Combined Constraint gains and their corresponding application indices and updates the gain, thereby affecting a gain change.

YM File This is a Model File, and it contains model information used by DQP, such as gains, time constants, etc.

CV/MV-DV pair Another way of saying CV/MV or CV/DV pair. A unique model (therefore gain) is associated with each CV/MV or CV/DV pair.

Incentive to Use GainMapperPO

GainMapperPO provides you with a mechanism to update a set of gains. In general, this mechanism is used when “swinging” a set of gains (if you had many gains) due to a process having changed operating regions, like on a refinery Crude oil swing for example. Typically, GainMapper is used as part of a “gain update” scheme where a program such as another toolkit sets the desired gains.

Page 40: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 28

3.2 Using GainMapperPO GainMapperPO Functions Created by DQP

The DQP point builder creates a single instance of the GainMapperPO toolkit function with the following alias: GainMapperPO – which stands for GainMapper for Profit Optimizer.

How Many Gains Can be Changed at one Time?

Profit Design Studio determines this based the number of non-null BM and CC models in the optimizer. The minimum BM gain mapping array size is 500. The minimum CC gain mapping array size is 500.

Datapool Parameters Involved in a Gain Update

The following standard Datapool parameters must be set accordingly to perform a gain update (See the Datapool table below for detailed description for the parameters). Note there are two sets of arrays, one to set the BM gains, and one to set the CC gains. The following parameters are associated with updating the BM gains: �� GMBMGain[1..N] – New set of BM Gains �� GMBIAPPIndex[1..N] - RMPCT Application number of Bridge Index

corresponding to desired gain �� GMBIMVDVIndex[1..N] – Bridge Input MV or DV number corresponding to

desired gain �� GMBOAPPIndex[1..N]-RMPCT Application number of Bridge Output

corresponding to desired gain �� GMBODVIndex[1..N] – Bridge Output DV or MV number corresponding to

desired gain �� GMBMFilterCoeff[1..N] – Filter coefficient corresponding to the desired gain �� GMBMROCLimit[1..N] – ROC limit corresponding to the desired gain �� GMBMROCDeadBand[1..N] – Deadband corresponding to the desired gain The following parameters are associated with updating the CC gains: ��GMCCGain[1..N] – New set of CC gains ��GMCCIndex[1..N] – CC Index corresponding to gain ��GMCCAPPIndex[1..N] – RMPCT Application number corresponding to CC

gain ��GMCCMVDVIndex[1..N] – DV or MV # corresponding to CC gain ��GMCCFilterCoeff[1..N] – Filter coefficient corresponding to the desired gain ��GMCCROCLimit[1..N] – ROC limit corresponding to the desired gain ��GMCCROCDeadband[1..N] – Deadband corresponding to the desired gain The following is a general parameter associated with updating the BM and CC gains: �� GMErrorAction – What action to take if errors are encountered

GainMapperPO Execution

The GainMapperPO will not execute if the Execute parameter is equal to zero. The GainMapperPO will only execute when the Execute parameter is set to a non-zero value. Following the execution, the Execute parameter is set back to zero.

Page 41: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.2 Using GainMapperPO

8/02 Profit Bridge User's Guide Honeywell

29

Invoking the GainMapperPO via the Execute Parameter

The GainMapperPO supports invocation commands via the Execute parameter. The following commands are available: ��Update – attempts to update the gains according to gain mapping data. ��Validate – validates the gain mapping data and reports any errors. (Example:

CV and MV indices, the gain value, etc.) This command does not change gains under any circumstances.

Page 42: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.2 Using GainMapperPO

Profit Bridge User's Guide 8/02 Honeywell 30

Only Validating the Gains

If you decide to validate the gains without performing an update, set the Execute parameter to 2. Once the validation is complete, Execute is automatically reset to 0, and any error messages are displayed in the message log and in the Return parameters. See the Return Status table in Section 3.3. Note: You may want to use the “validation” option if unfamiliar with the operation of GainMapperPO.

Rate of Change Check

The GainMapperPO does rate of change limit checking on the new gain based on a rate of change limit that you supply. The gain will not update, if …

Abs(New Gain – Current Gain) > Abs(ROC Limit) Abs is the absolute value.

Deadband Check The GainMapper does deadband checking on the new gain based on a rate of change limit that you supply. Simply put, the gain will only change if the gain change is greater than the deadband.

The gain will not update, if …

Abs(New Gain – Current Gain) < Abs(ROC Deadband)

Abs is absolute value.

Filtering in the New Gain

You can set a filter coefficient, which allows a gain to be ramped from its current gain to its new gain in a smooth fashion. The new gain is calculated as follows:

NewGain = DesiredGain * Filter Coefficient + Current Gain * (1 – Filter Coefficient)

If the filter coefficient is set to either bad value or 1, then filtering is effectively disabled and the new gain is applied in full. The filter coefficient must be a value greater than zero and less than or equal to 1.

Gains are Updated by Creating a New YM File

Unlike the Profit Controller GainMapper, the GainMapperPO does not have a direct mechanism for updating gains (Note: Profit Controller gains are easily updated by updating gain multipliers). So, the GainMapper for Profit Optimizer must update the gains in a round-about way by writing a new model file (.YM) with the new gain information, then initiating a Model File read-on-the-fly.

Page 43: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.2 Using GainMapperPO

8/02 Profit Bridge User's Guide Honeywell

31

CC Gains Scaling Factor

You normally do not have to be concerned about scaling the gains, but be aware that the GainMapperPO writes scaled CC gains to the YM file. The scaled gains are calculated as follows:

New Gain = GMCCGain[I] * Scaling Factor for CC Where GMCCGain[I] is the new gain you have specified.

The BM gains are not scaled. Automatically Saving Older Versions of the YM File

To allow recovery due to a corrupted or bad YM file, a configurable number of older versions of the YM file are saved automatically by the GainMapperPO. The backup file is named the same as the original YM filename names, with a suffix appended as follows: OriginalName.ym.1 OriginalName.ym.2 …. OriginalName.ym.N Where N is configurable via toolkit parameter NumFilesSave. Once N files have been saved, then the numbering restarts at 1.

Example – Using the GainMapperPO to Update BM Gains

In order to update the Bridge Model gains, you must set the aforementioned Datapool parameters appropriately. For each gain that needs to be changed, you must identify the RMPCT application associated with the BI and its corresponding MV/DV, and you must identify the application associated with the BO and its corresponding DV. This is done by identifying the RMPCT application number of the BI and BO by their numerical order in DQP and by identifying the MVs and DVs by the numerical order in the their RMPCT. Note: For the BIs, the DVs must be treated as an extension to the MVs. For example: Let’s say that DQP had three RMPCTs with the following configuration:

RMPCT Configuration of Applications in DQP

In RMPCT # of MVs

In RMPCT # of DVs

1 5 2 2 3 1 3 6 2

To change the BM gains: �� For the BI associated with RMPCT application 3 – MV2, and the BO

associated with RMPCT application 2 – DV1, set the gain to 7.3. �� For the BI associated with RMPCT application 1 – DV2, and the BO

associated with RMPCT application 1 – DV1, set the gain to 6.6.

Page 44: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.2 Using GainMapperPO

Profit Bridge User's Guide 8/02 Honeywell 32

For this example, parameters GMBIAppIndex, GMBIMVDVIndex, GMBOAppIndex, GMBODVIndex and GMBMGain should be set as follows.

Array Location

GMBIApp Index

GMBIMVDV Index

GMBOApp Index

GMBODV Index

GMBM Gain

Description

1 3 2 2 1 7.3 Change gain of BI3 MV2 and BO2 DV1 to 7.3 Note: For the BO DV, the DV# is input directly. It is not offset by the # of MVs.

2 -9999 -9999 -9999 -9999 ----- Skip processing this row. A skipped row is not required in this example. The row is skipped here to show that skipping a row is possible by setting the indices to –9999.

3 1 7 3 1 6.6 Change gain of BI1 DV2 and BO3 DV1 to 6.6 Note: For the BI DV, the DV# is offset by the # of MVs (GMBIMVDV = 5(# of MVs) + 2 (DV#) = 7)

4 -999 -999 -999 -999 ----- Indicate end of processing by setting either (or all) of the Indexes to –999.

The array location where the BO and BI pair is entered is not relevant. An error

will occur if GMBIAppIndex, GMBIMVDVIndex, GMBOAppIndex, or GMBODVIndex contains a zero or a negative value. The parameters must also be integers.

Example – Using the GainMapperPO to Update CC Gains

For each Combined Constraint gain that needs to be changed, you must identify the Combined Constraint Index, the associated RMPCT application, and its corresponding MV/DV. This is done by identifying the Combined Constraint number, as it is known in DQP and by identifying the MVs and DVs by the numerical order in their RMPCT. Note: DVs must be treated as an extension to the MVs. For example: Assume that DQP has three RMPCTs, with 5 CCs, and you want to change MV4 and DV2 for the CCs, as shown below.

CC Number RMPCT Configuration of Applications in DQP

In RMPCT # of MVs

In RMPCT # of DVs

MV/DV to change

New Gain Setting

3 1 5 2 MV4 8.8 ------ 2 3 1 ------ ------

4 3 6 2 DV2 7.4

Page 45: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.2 Using GainMapperPO

8/02 Profit Bridge User's Guide Honeywell

33

In this case parameters GMCCIndex, GMCCAppIndex, GMCCMVDVIndex and

GMCCGain would be set as follows.

Array Location

GMCC Index

GMCCApp Index

GMCCMVDV Index

GMCC Gain

Description

1 3 1 4 8.8 Change gain of CC3, RMPCT 1 MV4 to 8.8 2 -9999 -9999 -9999 ----- Skip processing this row. A skipped row is not

required in this example. The row is skipped to show that skipping a row is possible by setting the indices to –9999.

3 4 3 8 7.4 Change gain of CC4, RMPCT 3 DV2 to 8.8 Note that for the DV, the DV# is offset by the # of MVs. (GMBIMVDV = 6(# of MVs) + 2 (DV#) = 8)

4 -999 -999 -999 ----- Indicate end of processing by setting either of the Indexes to –999.

Note that the array location where the CC gain mapping information is entered is

not relevant. An error will occur if GMCCIndex, GMCCAppIndex or GMCCMVDVIndex contains a zero or a negative value. The parameters must also be integers.

Page 46: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 34

3.3 Handling Errors Errors Reported All errors are logged to the applications log file. A typical BM error message is

output as follows: “Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is ………”

A typical error message for CCs is: “Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is .……”

Error messages usually contain the following information, making it easy to identify the problem: �� Row Number, the row with the problem. For BMs: �� BI(MVDVxx.nn) – The BI, where xx is the application number and nn is

MV/DV number. �� BO(DVxx.nn) – The BO, where xx is the application number and nn is the

DV number. For CCs: �� CCnn MVDVxx.nn – The CC number and corresponding application xx and

MV or DV nn See the Return Status Table in Section 3.3 for a complete list of errors.

Actions to Take when an Error is Detected

You have control over what actions to take if an error is detected during the BM or CC gain update. The options can be configured using the GMErrorAction parameter, and are: �� Skip any gain(s) in error, but do all other gain updates (GMErrorAction = 0) �� Skip BM gains if there is a BM error, attempt to do the CC gains

(GMErrorAction = 1) �� Skip CC gains if there is a CC error, attempt to do the BM gains

(GMErrorAction = 2) �� Skip all updates when an error is encountered (GMErrorAction = 3)

Page 47: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.3 Handling Errors

8/02 Profit Bridge User's Guide Honeywell

��

Return Status Table

This table provides a list of Return Status values and describes the error and warning messages for each value, associated with the function.

Return Status

Status value

Description

0 No error occurred 1 The following messages will be displayed if there are problems with reading or writing to the

Datapool. �� Can't attach to Datapool parameter - _______ �� Can't get Datapool parameter - _______ �� Can't put Datapool parameter - _______ ______ indicates the parameter involved in the attach/get/put. Note that the previous messages should not arise in a normal operating scenario, as it should always be possible to read/write to the Datapool.

2 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BO application number GMBOAPPIndex is bad.

3 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BO application number GMBOAPPIndex < 1.

4 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BO application number GMBOAPPIndex > # RMPCTs in DQP.

5 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BO DV# GMBODVIndex is bad.

6 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BO DV# GMBODVIndex < 1.

7 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BO DV# GMBODVIndex > # DVs in RMPCT Application.

Page 48: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.3 Handling Errors

Profit Bridge User's Guide 8/02 Honeywell 36

8 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BI application number GMBIAPPIndex is bad.

9 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BI application number GMBIAPPIndex < 1.

10 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BI application number GMBIAPPIndex > # RMPCTs in DQP.

11 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BI MV/DV# GMBIMVDVIndex is bad.

12 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BI MV/DV# GMBIMVDVIndex < 1.

13 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BI MV/DV# GMBIMVDVIndex > #MVs + #DVs in RMPCT Application.

Page 49: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.3 Handling Errors

8/02 Profit Bridge User's Guide Honeywell

37

14 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BM Gain GMBMGain is bad.

15 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). This BO is not configured as part of this DQP.

16 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). This BI is not configured as part of this DQP.

17 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is model index. 18 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is model is NULL. 19 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). IJP value is < 0. 20 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC application number

GMCCAPPIndex is bad. 21 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC application number

GMCCAPPIndex < 1. 22 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC application number

GMCCAPPIndex > # RMPCTs in DQP. 23 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC MV/DV#

GMCCMVDVIndex is bad. 24 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC MV/DV#

GMCCMVDVIndex < 1. 25 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC MV/DV#

GMCCMVDVIndex > (#MVs + #DVs) in RMPCT Application. 26 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC Gain GMCCGain is

bad. 27 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC Index GMCCIndex is

bad. 28 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC Index GMCCIndex < 1. 29 Problem is CC Index GMCCIndex > Total # of CCs. 30 Can't change CC gain for Rownn (CCnn MVDVxx.nn). This CC is not configured as part of

this DQP. 31 The private DQP Datapool pointer is NULL. 32 Update flag of ___ is invalid, value must be either 1 or 2. No gains updated.

Note that ___ is the invalid user setting. 33 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BM filter

coefficient GMBMFilterCoeff must be > 0 and <= 1 34 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC filter coefficient

GMCCFilterCoeff must be > 0 and <= 1

Page 50: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.3 Handling Errors

Profit Bridge User's Guide 8/02 Honeywell 38

35 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BM gain change is > rate of change limit

36 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC gain change is > rate of change limit

37 Can't change BM gain for Rownn BI(MVDVxx.nn) BO(DVxx.nn). Problem is BM gain change is < deadband.

38 Can't change CC gain for Rownn (CCnn MVDVxx.nn). Problem is CC gain change is < deadband.

39 GMBMGain array either doesn't exist. Note: This typically means that the GMBMGain custom variable has not been included in the CFG file.

40 GMCCGain array either doesn't exist. Note: This typically means that the GMCCGain custom variable has not been included in the CFG file.

41 Was not able to load message file: ________ Note: This typically means that a message file associated with gain mapping has not been properly installed.

Page 51: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide Honeywell

39

3.4 Logging Gain Changes How To Enable Logging of Gain Changes

The GainMapperPO provides a mechanism to log successful BM and CC gain updates to the application log file. This mechanism may be turned on using the DoLogging parameter. A value of 0 for this parameter turns logging off, and a value of 1 for this parameter turns logging on. The default has logging turned off, so that the application log file is not inundated with gain change information. The following format messages are sent to the log file: Gain updated for BM gain on Rownn BI(MVDVnn.nn) BO(DVn.n). Current Gain is x.xxxxxx, Gain is filtering to x.xxxxxx. Gain updated for CC gain on Rownn (CCnn MVDVnn.nn). Current Gain is x.xxxxxx, Gain is filtering to x.xxxxxx.

Page 52: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

� ������������� ��� ������ �����

� ������������

3.5 Profit Optimizer Datapool Datapool Table The Datapool table provides a description of the function inputs and outputs that

are resident as custom variables in the Profit Optimizer Datapool.

Input [ ] denotes array

Description

GMBMGain[ ] Array of new BM gains

GMBIAppIndex[ ] The RMPCT Application number of Bridge Input that corresponds to the new gain. Setting this value to –999 indicates that BM gain processing should stop at this array index. Setting this value to –9999 indicates that BM gain processing is skipped for this array index.

GMBIMVDVIndex[ ] The MV or DV number of Bridge Input that corresponds to the new gain. If specifying a DV, this number should be offset by the total number of MV in the Bridge Inputs RMPCT application. Setting this value to –999 indicates that BM gain processing should stop at this array index. Setting this value to –9999 indicates that BM gain processing is skipped for this array index.

GMBOAppIndex[ ] The RMPCT Application number of Bridge Output that corresponds to the new gain. Setting this value to –999 indicates that BM gain processing should stop at this array index. Setting this value to –9999 indicates that BM gain processing is skipped for this array index.

GMBODVIndex[ ] The DV number of Bridge Output that corresponds to the new gain. The DV number should not be offset. Setting this value to –999 indicates that BM gain processing should stop at this array index. Setting this value to –9999 indicates that CC gain processing is skipped for this array index.

GMBMFilterCoeff[ ] Array of BM gain filter coefficients. Value should be greater than zero and less than or equal to 1. The full gain is applied (which means no filtering is done) if this value is set to NaN.

GMBMROCLimit[ ] Array of BM Gain rate of change limits (in gain units). The absolute value of GMBMROCLimit will be used. No rate of change limit check is done if this value is set to NaN.

GMROCDeadBand[ ] Array of BM gain deadband (in gain units). The absolute value of GMROCBMDeadBand will be used. No deadband check is done if this value is set to NaN. The gain will only be changed if the gain change exceeds this limit.

GMCCGain[ ] The new CC gain.

GMCCIndex[ ] The CC Number that corresponds to the new gain. Setting this value to –999 indicates that CC gain processing should stop at this array index. Setting this value to –9999 indicates that CC gain processing is skipped for this array index.

Page 53: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.5 Profit Optimizer Datapool

8/02 Profit Bridge User's Guide 41 Honeywell

GMCCAppIndex[ ] The RMPCT Application number of CC that corresponds to the new gain.

Setting this value to –999 indicates that CC gain processing should stop at this array index. Setting this value to –9999 indicates that CC gain processing is skipped for this array index.

GMCCMVDVIndex[ ] The MV or DV number of CC that corresponds to the new gain. If specifying a DV, this number should be offset by the total number of MVs in the RMPCT application. Setting this value to –999 indicates that CC gain processing should stop at this array index. Setting this value to –9999 indicates that CC gain processing is skipped for this array index.

GMCCFilterCoeff[ ] Array of CC gain filter coefficients. Value should be greater than zero and less than or equal to 1. The full gain is applied (which means no filtering is done) if this value is set to NaN.

GMCCROCLimit[ ] Array of CC Gain rate of change limits (in gain units). The absolute value of GMCCROCLimit will be used. No rate of change limit check is done if this value is set to NaN.

GMCCROCDeadBand[ ]

Array of CC gain deadband (in gain units). The absolute value of GMROCCCDeadBand will be used. No deadband check is done if this value is set to NaN. The gain will only be changed if the gain change exceeds this limit.

GMErrorAction Action to take when an error is encountered. 0 = Skip any gains in error, but do all other gain updates 1 = Skip BM gains if there is a BM error 2 = Skip CC gains if there is a CC error 3 = Skip all updates when an error is encountered

Input Table The input table provides a description of the function inputs.

Input Table

Input Description

Execute Flag indicating whether to update the gains 0 = No update 1 = Update gains 2 – Validate gains, this command does not do an update To do gain mapping or validation for a new set of gains, set this parameter to 1 or 2, following the update, the parameter is automatically set back to 0.

DoLogging Flag indicating whether to log successful gain requests (0=no logging, 1=log BM, 1=log CC, log BM and CC). Note that successful gain updates are logged into the application message log as follows: Gain updated for BM gain on Rownn BI(MVDVnn.nn) BO(DVn.n). Current Gain is x.xxxxxx.

Page 54: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 3- GainMapper for Profit Optimizer (GainMapperPO) 3.5 Profit Optimizer Datapool

Profit Bridge User's Guide 8/02 Honeywell 42

Input Table

Input Description Gain is filtering to x.xxxxxx. Gain updated for CC gain on Rownn (CCnn MVDVnn.nn). Current Gain is x.xxxxxx. Gain is filtering to x.xxxxxx.

MessagePrefix Message Prefix for log messages. For internal use only NumFilesSave Number of older version model files (.YM) to save FileSuffix Next saved YM file to will have this suffix (this value is incremented automatically)

RetNum The maximum number of simultaneous messages to be raised for this function. The value is set to 20

Output Table The output table provides a description of the function outputs.

Output Table

Output [ ] denotes array

Eng. Units

Description

Ret_Status Number of error messages This sign (either positive or negative) of Ret_Status also controls the coloring of the function error status Red = positive = at least one error message is displayed Yellow = negative = These are only warning message(s)

RetStatus[RetNum ] Array of current function return statuses. See Return Status Table below for details. RetMessage[RetNum] String Array of messages containing the current set of error messages raised against the

function. RetFloat[RetNum] Array of float arguments associated with the error messages. For internal use only.

RetString[RetNum] String Array of string arguments associated with the error messages. For internal use only. FileSuffix Next YM file to save will have this suffix (this value is incremented automatically).

Page 55: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide Honeywell

43

Section 4 – Installing Profit Bridge

4.1 Installing Profit Bridge Items Included on Profit Bridge CD

The following items are included on the Profit Bridge CD. ��Profit Bridge Toolkit, which includes:

��Profit Toolkit Engine ��Gain Extraction toolkit ��GainMappers for Profit Controller and Profit Optimizer

��Profit Design Studio ��Profit Viewer ��Common components required for any “Profit” application

��Embedded PHD Components ��Microsoft System Files ��HCI Runtime

��Documentation What’s not Included on Profit Bridge CD

The Third-Party Model Sockets (FCC-Sim Socket or NOVA socket, for example) are not included on the Profit Bridge CD. These are supplied separately.

How to Install Profit Bridge

Profit Bridge is a Profit Toolkit application. The installation steps are the similar to those of other Profit Toolkit installations. However, because a Profit Bridge application has multiple components that can be distributed across different nodes, Profit Bridge has a number of installation configurations. The general Profit Toolkit installation steps are detailed in Section 10 of the Profit Suite Installation Guide (Section 10 – Installing Profit Toolkit) and summarized below. Detailed Profit Bridge installation instructions can also be found in Section 11 of the Profit Suite Installation Guide. Five Profit Bridge installation scenarios are described following the general installation summary.

Page 56: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

44 Profit Bridge User's Guide 8/02 Honeywell

Where to Install Profit Bridge Components

1. Profit Bridge components must be installed on machines where PDS is to be used to configure a Profit Bridge application.

2. Profit Bridge components must also be installed on machines where a simulation or runtime Profit Bridge application is to execute.

3. Gain Mappers must be installed on the machines where associated Profit Controller and Profit Optimizer applications are to execute.

Profit Bridge Toolkit Installation CD Layout

Section 4- Installing Profit Bridge 4.1 Installing Profit Bridge

Page 57: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 4- Installing Profit Bridge 4.1 Installing Profit Bridge

8/02 Profit Bridge User's Guide Honeywell

45

General Installation Summary

This summary assumes other necessary software has been previously installed. Refer to the installation scenarios below.

1. If currently running applications use an older version of the toolkit to be installed, stop the applications using Privtaskmgr.exe. (If these applications have OPC connections to other Profit Suite applications, those other applications must be stopped as well.)

2. Remove any older version of the same toolkit using the Windows Add/Remove Programs utility.

3. Open the ProfitBridge Toolkit folder on the CD and double click the setup.exe file to start the installation.

If thorough testing of the software has not been performed on your operating system version, a warning message will be issued. Contact Honeywell before attempting to use the software with such operating systems for runtime control of live processes.

If a Profit Toolkit application has been previously installed, Profit Bridge Toolkit will be installed on the same disk drive. If not, the user is prompted to enter the letter of the drive on which to install the software.

4. To install the Gain Mapper for Profit Controller or Profit Optimizer, repeat steps 1 through 3, applying the same steps for the Gain Mapper software instead of for Profit Bridge. The setup.exe files for these applications can be found in the ProfitControllerGainMapper and ProfitOptimizerGainMapper folders on the installation CD, respectively.

Page 58: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 4- Installing Profit Bridge 4.1 Installing Profit Bridge

Profit Bridge User's Guide 8/02 Honeywell 46

Additional Details on Installing the Gain Mappers

Although the GainMappers are installed from the Profit Bridge CD, the Mappers run as toolkit functions that are part of Profit Controller and Profit Optimizer applications. After the Profit Bridge Toolkit CD has been installed, ensure that any Profit Controller or Profit Optimizer applications that require gain mapping have the gain mapping records in their configuration (CFG) file.

To determine if the gain mapping records are in the Profit Controller and/or Optimizer configuration file, view the appropriate CFG file and look for a record similar to this: (Note that the Profit Optimizer application references GainMapperPO instead of GainMapperPC.)

Server, HS_Toolkit_1_0, order 999 … Options, HSTool_GainMapperPC, HS_GainMapperPC, Begin, GainMapperPC1

If this record is found in the CFG file, you only need to set the Profit Controller/Optimizer Inactive, then Active. This will load and run the newly installed GainMapper DLLs.

If the record is not found in the CFG file, you must regenerate the configuration file from the Profit Design Studio using the appropriate Runtime Configuration utility. This will put the GainMapper records in the CFG file. Subsequently, set the Profit Controller/Optimizer Inactive, then Active. This will load and run the newly installed GainMapper DLLs.

Installation Scenario 1

This scenario includes Profit Bridge for design simulation and configuration build on a different node than runtime application.

1. Install Profit Design Studio (PDS 235.0 or newer) See Section 2 of Profit Toolkit Designer’s Guide or Section 13 of the Profit Suite Installation Guide for Open Systems.

2. Follow steps 1 through 3 of the General Installation Summary above.

3. Install other necessary toolkits using their specific installation instructions. For example, install the nonlinear model functions that are to be used by Profit Bridge.

Page 59: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 4- Installing Profit Bridge 4.1 Installing Profit Bridge

8/02 Profit Bridge User's Guide Honeywell

47

Installation Scenario 2

This scenario includes running Profit Bridge on a different node than associated Profit Controller and Profit Optimizer applications. (Assume PDS is not to be installed on these runtime nodes.)

1. On the modeling system node (where Profit Bridge will reside), use procedures in Sections 1 through 7 of the Profit Suite Installation Guide for Open Systems to install the following:

a. Embedded PHD Components (optional)

i. Embedded PHD Server

ii. PHD Patch

iii. Uniformance Desktop

b. Microsoft System Files

c. HCI Runtime

d. Profit Viewer

2. On the modeling system node, install Profit Bridge following steps 1 through 3 of the General Installation Summary above.

3. On the nodes with associated Profit Controllers, install the Gain Mapper for Profit Controller, following step 4 of the General Installation Summary above.

4. On the node with the associated Profit Optimizer, install the Gain Mapper for Profit Optimizer, following step 4 of the General Installation Summary above.

Installation Scenario 3

This scenario includes Profit Bridge for Runtime on the same node as existing Profit Controller and/or Profit Optimizer applications. (Assume PDS is not to be installed on these runtime nodes.)

1. Install Profit Bridge following steps 1 through 3 of the General Installation Summary above.

2. On the nodes with associated Profit Controllers, install the Gain Mapper for Profit Controller, following step 4 of the General Installation Summary above.

3. On the node with the associated Profit Optimizer, install the Gain Mapper for Profit Optimizer, following step 4 of the General Installation Summary above.

Page 60: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 4- Installing Profit Bridge 4.1 Installing Profit Bridge

Profit Bridge User's Guide 8/02 Honeywell 48

Installation Scenario 4

This scenario includes Profit Bridge for Runtime on the same node as existing pre-R205 Profit Controller and/or Profit Optimizer applications.

1. Upgrade the existing pre-R205 Profit Controller and Profit Optimizer applications to R205 following the procedures in the Profit Suite Installation Guide for Open Systems and the Profit Controller/Profit Viewer/Profit Trender Release Notes.

2. Follow the procedures outline in Scenario 3.

Installation Scenario 5

This scenario includes Profit Bridge for Runtime on the same node as non-existing Profit Controller and/or Profit Optimizer applications.

1. Install Profit Controller and Profit Optimizer applications following the procedures in the Profit Suite Installation Guide for Open System.

2. Follow the procedures outline in Scenario 3.

Page 61: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide 49 Honeywell

Section 5 – Building Profit Bridge

5.1 Getting Started What is Configured?

Profit Bridge configuration is the process of defining the connections between model functions in Profit Bridge and Profit Controller and Profit Optimizer variables. These model functions can be:

�� Honeywell inferential-property functions, �� third-party models, or �� custom functions.

Page 62: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.1 Getting Started

Profit Bridge User's Guide 8/02 Honeywell 50

Begin Configuration To begin Profit Bridge configuration, follow these steps:

Step Action 1 Start the Profit Design Studio. 2 From the main menu bar, choose Tools>Profit Toolkit>Configuration

Wizards. 3 In the list of configuration Graphical User Interfaces (GUIs), choose

ProfitBridgeConfigGUI. The Select Profit Bridge Application window appears, as shown in the following figure. It shows a list of Profit Bridge applications (if any) currently in the database. From this window, an application can be created, an existing application can be modified, or an application can be deleted.

Page 63: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.1 Getting Started

8/02 Profit Bridge User's Guide Honeywell

51

Select an Existing Application

To select an existing Profit Bridge application, complete the following steps.

Step Action 1 From the Select Profit Bridge Application, click the desired application

name from those listed. 2 Click the [Select] button. (NOTE: You could also have double-clicked

the application name to select it.)

Create a New Application

Perform the following steps to create a new Profit Bridge application.

Step Action 1 In the Select a Profit Bridge Application window, click the [New]

button. 2 Complete the resulting dialog box as follows:

�� Enter a name for the application. The name must be no longer than 16 characters. It can contain numbers.

�� Optional: Enter a description for the application (no more than 255 characters).

3 Click Create.

Delete an Application

Perform the following steps to delete a Profit Bridge application.

WARNING: Deleted applications CANNOT be recovered.

Step Action 1 From the Select Profit Bridge Application display, click the desired

application name from those listed. 2 Click the [Delete] button. A confirmation warning appears before the

application is deleted.

Page 64: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.1 Getting Started

Profit Bridge User's Guide 8/02 Honeywell 52

Database Activity After an application is selected or created, the first (main) panel of the configuration window Select Config Files appears. Before the main window appears, the program reads in the data for the application from the database file (C:\users\HiSpec\Apps\Solutions.mdb). If the file is not found, a new one is created automatically.

Configuration Overview

The following figure shows the main configuration window for Profit Bridge configuration. All displays for configuring Profit Bridge are accessed from this window, using the buttons at the top of the window. The File menu is used to create a Profit Bridge configuration file, and to exit the GUI.

On the Profit Bridge Configuration window, the configuration displays include:

�� Select Config Files

�� Model Data Source

�� Functions for Extraction

�� Connections

�� Perturbations

�� CV Gains

�� BO Gains

�� CC Gains These displays can be accessed one at a time. Once any of these displays is

accessed, it must be closed before any other displays or actions outside of the display are permitted.

Page 65: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.1 Getting Started

8/02 Profit Bridge User's Guide Honeywell

53

Initial Steps The first stage of configuration is to insert one or more toolkit functions and select model files. (You cannot access the other configuration displays until this stage is completed.) The main tasks are as follows:

Stage Action 1 From the Profit Bridge Configuration window, Select Config Files

display, insert and configure a toolkit function. Refer to "Working in the Functions List" and "Insert a New Function" later in this topic.

2 Select one or more controller model files (*.xm) or an optimizer model file (*.ym). Refer to "Controller Model Files" and "Optimizer Model Files" in this section.

3 Strongly recommended: Insert all functions and select all model files before continuing configuration. Adding or deleting functions or model files later can cause configuration data to be lost.

Page 66: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 54

5.2 Functions List Working in the Functions List

The Functions list displays the function order number, function alias, and the function type. Use the buttons to the right of the function list as follows:

Button Action

Insert a new function

Delete a selected function

Rename a selected function

Move a function up in the list of functions

Move a function down in the list of functions

Note: These buttons may be disabled when a function is not selected or its location in the list prevents up or down movement.

Insert a New Function

To insert a new function, complete the following steps. NOTE: There is no requirement for any of the functions to be a third-party model socket function. Also, you are not required to have more than one function.

Page 67: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.2 Functions List

8/02 Profit Bridge User's Guide Honeywell

55

Step Action 1 Identify the type of function you want to add. 2 In the Profit Bridge Configuration window, Select the Select

Config Files display and click the Insert New Function button.

The following dialog box appears:

Page 68: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.2 Functions List

Profit Bridge User's Guide 8/02 Honeywell 56

3 From the Function Type list, select the needed category of function.

The function types shown in the list are all of those found on the computer. If the needed type is missing, exit the GUI, install it from the appropriate Profit Toolkit disk, and run the Profit Bridge configuration GUI again.

4 Selecting a function type automatically causes a default function alias to be generated. The alias must be unique. If desired, you may change the default alias. But, ensure that it is unique or an error message appears.

5 Click [Insert]. The new function is added to the function list. The New Function Procedure dialog box remains open so that you can add other new functions.

6 Repeat steps 1 – 5 for each new function. 7 When finished, click [Close] to add the final new function and close

the dialog box. 8 The order of the functions in the Function Type list is the

order in which they are executed in the Profit Bridge application. Use the “function move up” or “function move down” buttons (shown to the right) to change the order of the functions in the list, which changes the order of execution.

Page 69: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide Honeywell

57

5.3 Controller Model Files Description The Controller Model Files list displays the names of controller model files

selected for this part of Profit Bridge configuration:

File list An index number and a controller file name are listed. The index number is used in later displays to show which controller owns the CV, MV, or DV. It is possible to have controller file index numbers that are not consecutive and do not start at one. This can occur because the optimizer references controllers, and its optimizer file index number has precedence over any controller files that are not referenced by the optimizer.

See also "Relationship of Controller and Optimizer Model Files" in Section 5.4.

Controller list buttons Use the buttons to the right of the list as follows: Button Action

Select a controller model file.

Delete a controller model file from the list (does not delete it from the system). NOTE: Some controllers cannot be removed if they are the source for a DV clone. A warning message appears if removal of a source controller is attempted, preventing the removal.

What Controller Model Files Provide

The controller model files supply:

�� Number of CVs

�� Number of MVs

�� Number of DVs

�� Gains for CV/MV and CV/DV pairs

�� Names of the CVs, MVs, and DVs

Page 70: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.3 Controller Model Files

Profit Bridge User's Guide 8/02 Honeywell 58

Select Controller Model Files To select controller model files, follow these steps:

Step Action 1 Identify the needed controller model file(s). Note that when a file is

selected, it is checked for the following: �� A model configuration file must be a toolkit configuration file for a

third-party socket model. 2 In the Profit Bridge Configuration window, Select the Select Config

Files display. 3 Click the Select Controller Model File(s) button (shown to the

right).

4 In the resulting standard Windows Open dialog box, navigate to and select the needed file.

5 Click the Open button. This opens the Controller Naming dialog box. 6 In the Controller Naming dialog box, if you want to use the default file

name given, click OK. If you want to choose another name, type the desired name, following these naming rules:

The name of the controller can be different from the model file, so the option to change the controller name is presented. The name cannot be over sixteen characters. The name is checked for validity and then added to the Controller Model File list. If the Controller Model file is found to be invalid, it is rejected. If possible, a message will display explaining why.

7 Repeat steps 2 through 6 for all controller model files to be included. Remember, only one controller at a time can be selected.

Page 71: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide Honeywell

59

5.4 Optimizer Model Files Description The Optimizer Model File list displays the name of optimizer model file that has

been selected for this part of Profit Bridge configuration:

File list The Optimizer Model File list is presented in a "tree" view. This view shows the name of the optimizer file and all the controllers referenced by it, preceded by the controller’s index number. If the controllers are not visible, double clicking on the optimizer file name causes the “tree” to open and show all the referenced controllers.

Clicking the (plus sign) next to a controller displays the number of CVs, MVs, and DVs within the controller.

Optimizer list buttons

Use the buttons to the right of the list to add or delete an optimizer model file, in the same manner as adding a controller model file. Refer to Section 5.3 on how to use these buttons.

What Optimizer Model Files Provide

An optimizer model file supplies the following information:

�� Number of CCs �� Number of BOs �� Number of controllers �� Number of CVs per controller �� Number of MVs per controller �� Number of DVs per controller �� Gains for BO/MV and BO/DV pairs �� Gains for CC/MV and CC/DV pairs �� Names and order of the controllers optimized

Page 72: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.4 Optimizer Model Files

Profit Bridge User's Guide 8/02 Honeywell 60

Select Optimizer Model Files To select an optimizer model file, follow these steps:

Step Action 1 Identify the needed optimizer model file. 2 In the Profit Bridge Configuration window, Select the Select Config

Files display. 3 Click the Insert Function button (shown to the right).

4 In the resulting standard Windows Open dialog box, navigate to and

select the needed file. 5 Click the Open button. This opens the Optimizer Naming dialog box. 6 In the Optimizer Naming dialog box, if you want to use the default file

name given, click OK. If you want to choose another name, type the desired name, following these naming rules:

The optimizer can have a name that is different from the model file. The name can be changed after the model file is selected. The name cannot be more than sixteen characters long. The file name is checked for validity, then it is added to the Optimizer Model File list. Only one optimizer is allowed. If a file is invalid, it is rejected. If possible, a message will display explaining why.

Relationship of Controller and Optimizer Model Files

The optimizer model file selected can affect the order of the controller files, if there are any controller files selected. An optimizer references two or more controllers and these referenced controllers determine the order of the controller in the Controller File list.

Any controller files that match a controller referenced by the optimizer must have the same index number. Any controller files not referenced by the optimizer will have index numbers greater than the last index number of a referenced controller.

Page 73: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide Honeywell

61

5.5 Model Data Source Description The following figure shows the Model Data Source panel of the Profit Bridge

Configuration window.

Use this panel to view and change the data sources for the function input variables within the model application. The information in the grid is read from the model configuration file selected on the Select Config Files display.

This panel cannot be accessed unless a function has been inserted. Refer to Section 5.2 for details on inserting functions.

Configuration Items

Contents of the Model Data Source panel and associated configuration actions are explained in the following paragraphs.

Page 74: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.5 Model Data Source

Profit Bridge User's Guide 8/02 Honeywell 62

Gain Validation Func.

Displays the following window:

When function is the type of source selected.

This window is used to set the input source for the gain validation function GMUpdateMode parameter. The parameter GMUPdateMode specifies the 'gain update mode'. A value of 0 (OFF) for the gain update mode means that no gains are transferred to the gain mappers; a value of 1 (ON) means that the gains will be sent to the gain mappers for validation and subsequent downloading to Profit Controller or Profit Optimizer; a value of 2 (WARM) means that the gains will be sent to the gain mappers only for validation only. By setting the value of the gain update mode from another toolkit function, a user can provide additional validity checks in addition to the standard Profit Bridge validity checking. For example, if the custom validity checks pass, then the gain update mode can be set to the requested gain update mode entered into the DCS; if the validity checks fail, then the gain update mode can be set to 0 until all the custom validity checks pass.

Selected Model Function

Lists all functions inside the model application. Select which function to view from this list.

Function Variable, Array Index

These two columns are view only. They show the name of the function input variables and the array index numbers for the variable.

Note: An index number of –1 means the variable is not an array.

Page 75: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.5 Model Data Source

8/02 Profit Bridge User's Guide Honeywell

63

Source The Source column shows the current data source for each function variable. Clicking on a source cell causes a drop down list to appear with these six source choices:

�� CONST: Constant numeric or string value

�� FUNC: Output parameter from a function within this application

�� OPC: Parameter from an OPC server

�� STD Standard variable from the Profit Bridge application

�� PHD: Parameter from a PHD server

�� TPS: Parameter from a TotalPlant Solution system device (the AM for example)

The source selected determines if the Name or Constant cell is used, as explained in the following paragraphs.

Name The Name column is used to specify the function and output parameter to be associated with each function variable. This column is used with source types OPC, PHD, STD, TPS, and FUNC. For OPC, PHD, and TPS sources, enter data as follows:

�� OPC: Server Name.parameter(x)

�� PHD: PHD tagname

�� TPS: Tagname.parameter(x) where x is the array number (The array number is only needed on parameters that are arrays.) If FUNC is the source, clicking in a Name cell opens the Select Function Output dialog box, as shown in the following figure.

In this dialog box, in the Application Functions field, select one of the functions currently in the Functions list, and a corresponding output parameter. Only the

Page 76: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.5 Model Data Source

Profit Bridge User's Guide 8/02 Honeywell 64

function outputs with a numeric value are available, no string values. Click the [Select] button. The selected function and its output parameter will appear in the Name cell. If STD is the source, clicking in the Name cell opens Profit Bridge Application Variables dialog box as shown in the following figure.

In this dialog box, there are two categories of variables, standard and custom. The option buttons on the far left are used to select which type of variable to use. If you have selected standard variables, select one of the variables and it’s index (Note: GAINEXT1 has no index). After the variable type and index are selected, select a parameter, and if available, select a parameter index. If you have selected custom variables, use the option buttons to select the desired custom variable. Click the [Select] button. The selected variable and its parameter will appear in the Name cell.

Page 77: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.5 Model Data Source

8/02 Profit Bridge User's Guide Honeywell

65

Constant

For a CONST source, enter the constant numeric or string value to be associated with the function variable.

Configure Model Data Source

Complete the Model Data Source configuration panel as follows:

Step Action 1 Complete the insertion of toolkit functions and selection of model

files. (Refer to Sections 5.2 through 5.4.)

2 Click the [Model Data Source] button in the Profit Bridge Configuration window.

3 Select the model function you want to configure from the Selected Model Function list.

4 For each listed function variable, choose a source type.

5 For each listed function variable, depending on the source type, either �� enter or choose a corresponding function and output parameter

(Name column), or �� enter a constant numeric or string value to be associated with

the function variable.

Page 78: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 66

5.6 Functions for Extraction Description The following figure shows the selections of the Funcs for Extraction panel of the

Profit Bridge Configuration window.

This panel cannot be accessed unless a function has been inserted. Refer to Section 5.2 for details on inserting functions.

Configuration Items

Contents of the Funcs for Extraction panel and associated configuration actions are explained in the following paragraphs.

Last Function Before Extraction

Loop

Select the last function before the model loop from this list. The list of available functions includes all functions defined in the functions list. (Refer to Section 5.2.) Typically, these functions perform data validation, unit conversion, etc. of the input variables to the application. The functions are listed by function name, in the execution order. If there are no functions to be executed before the gain extraction loop, select “No Functions.”

First Function After Extraction Loop

Select the first function after the gain extraction loop from this list. The functions for selection are only those functions whose execution order is after the ’last function before extraction loop’. The functions are listed by function name, in execution order. If there are no functions after the loop, select “No Functions.”

Ending Function for Provided Gains

Use this list to extend the number of functions available for provided gains. The functions for selection are only those functions whose execution order is after the ’first function after extraction loop’. The functions are listed by function name, in execution order.

This list is disabled if the first function after the extraction loop is the last available function or if “No Functions” is selected.

Page 79: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.6 Functions for Extraction

8/02 Profit Bridge User's Guide Honeywell

67

Configuration Checking

When changes are made to these functions, configuration checking is performed to ensure that the functions selected are consistent with each other.

For example, if a new ‘last function before the loop’ is chosen, it is compared to the first function after the loop list and the ending function for provided gains list. If the new last function before the loop is after the current first function after the loop, the first function after the loop is automatically changed to the next function in the list or “No Functions” if there are no more functions.

The same action occurs when the selected first function after the loop for extraction is changed so that it is after the ending function for provided gains function.

Function Behavior Once selections are made, the following action occurs:

�� Functions before the Starting Function are placed before the looping functions for perturbing inputs and calculating gains.

�� Functions from the Starting Function through the Ending Function execute inside the gain perturbation and gain calculation function loop.

�� Functions following the Ending Function execute after the gain perturbation/calculation function loop but before the gain validation function.

Page 80: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 8/02 Honeywell 68

5.7 Variable Connections Description The following figure shows the (Variable) Connections panel of the Profit Bridge

Configuration window. Use this panel to connect the controller CVs, MVs, and DVs, the optimizer bridge outputs (BOs), combined constraints (CCs), and the MVs and DVs of the controllers with the functions dependent and independent variables.

This panel is accessible when all of the following conditions are met:

�� At least one function has been inserted (refer to Section 5.2).

�� A controller or optimizer model file has been selected in the Select Config Files panel (refer to Section 5.3 or 5.4).

�� An extraction loop has been defined (refer to Section 5.6).

Page 81: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.7 Variable Connections

8/02 Profit Bridge User's Guide Honeywell

69

Configuration Items

Contents of the Connections panel and associated configuration actions are explained in the following paragraphs.

Views �� Choose one view option at a time to display the connections for the Controller CVs, Optimizer BOs, or Optimizer CCs, respectively.

Note that:

�� If no optimizer model file is selected, the Optimizer view options are not visible.

�� If no controller model file is selected, the CVs view option is not available.

The view shown on the previous page was an example of the Controller CVs view. The following figure shows an example of the Optimizer CCs view.

Page 82: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.7 Variable Connections

Profit Bridge User's Guide 8/02 Honeywell 70

Lists Each set of lists consists of the following: �� A list of all the unselected controller or optimizer variables on the left �� A list of unselected model variables on the right �� A list of controller or optimizer variables paired with a model variable Details regarding the lists and the elements within them are presented in the following table.

List or List Element Details

Unselected variables lists Created by reading the controller and optimizer model files to determine the number of CVs, MVs, DVs, bridge outputs, and combined constraints.

CVs, MVs, DVs in the list The variable type with the controller index number and variable number appended (for example, CV2.4, MV1.5, DV3.2).

Bridge outputs and combined constraints in the list

The variable type and the variable number (for example, CC2, BO5).

Unselected model dependent and independent variables lists

From the functions inserted into the functions list in the first panel and within an extraction loop defined on the Funcs for Extraction panel (the functions defined by the starting and ending extraction functions).

Independent model variables list

Function input parameters, which are scalar values. All the function parameters are prefixed with the function alias name.

Dependent model variables list

Function output parameters, which are scalar values. All the function parameters are prefixed with the function alias name.

Variables connection list Created when you move variables �� from the unselected controller or optimizer list and the model

independent and dependent variables �� to the selected list Refer to the following paragraph for details on this procedure.

Page 83: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.7 Variable Connections

8/02 Profit Bridge User's Guide Honeywell

71

Configure Variable Connections Follow the steps below to configure variable connections.

Step Action 1 Preparation:

�� Complete the insertion of toolkit functions and selection of model files. (Refer to Sections 5.2 through 5.4.)

�� Define an extraction loop. (Refer to Section 5.6.) �� Identify the connections you want to make.

2 Click the [Funcs for Extraction] button. The Connection button becomes active. 3 Click the [Connections] button. 4 Determine the type of view needed for the connections you want to make, and select

that view. To Make This Connections… Choose this View Controller Control Variables (CVs) Controller CVs Optimizer Bridge Outputs (BOs) Optimizer BOs Optimizer Combined Constraints (CCs) Optimizer CCs 5 Select a controller or optimizer variable for which you want to make a connection and

click the button with the arrow pointing from the variable list to the connections list. More than one variable may be selected by using the shift or control keys. Results: �� The variable is added to the connections list, with a blank for the other half of the

connection. �� The variable is removed from its source list.

6 Select the model independent or dependent variable to be paired with the one moved in step 5 and click the button with the arrow pointing from the variable list to the connections list. More than one variable may be selected by using the shift or control keys. Results: �� The desired connection between the controller or optimizer variable and model

independent or dependent variable is made. �� Model variables selected for a controller are still available for pairing up with the

optimizer variables and vice versa. �� The connected variables are automatically ordered by the controller or optimizer

variable order. 7 Repeat steps 5 and 6 for each connection to be made.

Page 84: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.7 Variable Connections

Profit Bridge User's Guide 8/02 Honeywell 72

Change Connection

To remove one variable in a pair so another variable can be used for the connection, right-click that variable and select [Delete] on the resulting pop-up menu. The deleted variable returns to the appropriate unselected list and a new connection can be made with the remaining variable. A connection can only be changed by selecting it, then clicking on the arrow pointing from the connection list to the dependent or independent variable list. This removes the independent or dependent variable returning it to the independent or dependent variable list but leaves the controller or optimizer variable. A new independent or dependent variable can now be selected and moved into the blank space created.

Remove Connection

To remove a connected pair of variables, select a connection and click on the arrow pointing from the connection list to the controller or optimizer variable list. The entire connection is removed and variables returned to the appropriate lists.

Page 85: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide Honeywell

73

5.8 Perturbations Description The following figure shows the configuration area of the Perturbations panel of

the Profit Bridge Configuration window.

This panel cannot be accessed until at least one MV/DV connection is made in the Connections panel (refer to Section 5.7).

Configuration Items

The contents of the Perturbations panel and associated configuration actions are explained in the following paragraphs.

Connected MVs and DVs

This list shows MVs and DVs that are connected to a model function input parameter. It is used to select which MVs and DVs will be perturbed and how they are perturbed. The list is sorted by

�� Controller index

�� Variable type

�� Variable index

Perturb Group The perturb group number is used to group MVs and DVs into groups that are to be perturbed simultaneously. The group number can be any positive integer.

A group number of 0 (zero) can be used to indicate it will be assigned to its own unique group number on-line and be perturbed by itself.

Abs.Step Size The absolute step size is the maximum size of the perturbation made to the MV or DV. The number can be any positive non-zero real number. Very large or small numbers are displayed in scientific notation (for example, 5.12E-05 or 6.02E07).

Perturbation Type Choose from Backward, Forward, Central, Clone, or No perturbation.

Clone Source If the perturbation type is Clone, the Clone Source field is active. Click the Clone Source field to choose the MV or DV to be cloned from the drop down list.

Page 86: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.8 Perturbations

Profit Bridge User's Guide 8/02 Honeywell 74

Configure Perturbations Follow these steps to configure perturbations.

Step Action 1 Preparation:

�� Make needed MV/DV connections in the Connections panel (refer to Section 5.7).

�� Identify the perturbations you want to define. 2 Click the Perturbations button. 3 Specify the perturbation definition for each MV and DV in the list as one of the

following: �� Specific perturbation: Go to step 4 �� Cloned perturbation: Go to step 5 �� No perturbation: Go to step 6 Complete the appropriate step for each MV and DV.

4 For a specific perturbation, follow these steps by clicking the appropriate cell corresponding to the MV or DV for which perturbation is being defined: �� Enter a group number in the Perturb Group cell. �� Enter a maximum size of the perturbation in the Abs. Step Size cell. �� Choose Perturb Backward, Perturb Forward, or Perturb Central in the

Perturbation Type cell. Details about these configuration items can be found in this section, under Configuration Items.

5 For cloned perturbation, �� Choose Clone in the Perturbation Type cell. �� Choose the appropriate MV or DV in the Clone Source cell.

6 For no perturbation, choose Do Not Perturb in the Perturbation Type cell.

Page 87: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide Honeywell

75

5.9 Gains Controller Gains (CV Gains)

Below is the Controller Gains (CV Gains) panel, which is used to select/unselect gains and to modify the validation and filter parameters for each controller gain. The panel cannot be viewed until at least one CV is connected with a function output and at least one MV or DV is connected with a function input.

A drop down list in the upper right corner called Selected Controller controls which controller gains are displayed. The controller names in that list are the configuration file names.

Page 88: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.9 Gains

Profit Bridge User's Guide 8/02 Honeywell 76

The gains grid is a matrix displaying all the derivative gain values for each CV/MV/DV pairing which have been connected to a dependent and independent variable.

Page 89: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.9 Gains

8/02 Profit Bridge User's Guide Honeywell

77

Below are the definitions of the various background shading and bold character usage:

�� Gains selected for extraction have a white background.

�� Gains unselected for extraction have a gray background.

�� Null models are blacked out.

�� Gains that are directly provided by a model or are extracted and then modified by a function, are shown in bold.

If a CV, MV, or DV is not connected to a model variable, it is not shown. On the lower-right side of the screen, if you have selected the Gain Source to be either “Provided” or “Extracted with modifications,” the “Provided Gains” button in the top-right side will be enabled (not grayed out), and the gain value is bold.

On the CV Gains panel, a key is provided in the lower right corner to help remember the scheme. The gain values shown in the cells are provided for reference to help determine validation and filter parameters.

Page 90: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.9 Gains

Profit Bridge User's Guide 8/02 Honeywell 78

A gain is selected or unselected by right clicking on it or using the selected

checkbox. Left clicking opens the Validation & Filter Parameters panel (shown below), which allows you to modify the validation and filter parameters for that gain. NOTE: Left clicking only works on selected gains. Any clicking on a null model produces no actions

Page 91: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.9 Gains

8/02 Profit Bridge User's Guide Honeywell

79

On the right side of the Validation & Filter Parameters panel are the validation and filtering parameters for each gain. The frame title shows the gain currently selected. The validation and filtering parameters have the following error checking:

Maximum value must be greater than the minimum value Minimum value must be less than the maximum value Filter coefficient must be greater than zero and equal to or less than one Minimum change must be less than the maximum change

The default values are:

Maximum value 100 Minimum value -100 Maximum change 1 Minimum change 0 Filter coefficient 1 Invalid value is Clamped

The first four values, maximum value, minimum value, maximum change and minimum change, are used for validation of the gain value. The action for invalid value options controls how to handle a value failing validation, based on the validation parameters. The clamp option keeps the gain value at the minimum or maximum value. The reject option keeps the gain value at the last valid value.

The filter coefficient is used in a first order filter:

Filtered value = (coefficient * new gain value) � ((1 � coefficient) * previous gain value)

A coefficient value of one means no filtering. The smaller the coefficient value, the greater the filtering.

The last option is the source of the gain. The default is extracted. If gains are to be provided by a function, the Provided Gains button is enabled. If gains are to be extracted, and then modified by a function, the Extracted with modifications button is enabled. Any provided gain or extracted gain with modifications must be configured with a source. This option is not provided if the CV, MV, or DV of the gain pair is not connected to a dependent or independent variable.

Page 92: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.9 Gains

Profit Bridge User's Guide 8/02 Honeywell 80

Optimizer Gains (BO Gains)

Below is the Optimizer Bridge Output Gains panel, which is used to select or unselect gains and to modify the validation and filter parameters for each bridge output gain.

The panel cannot be viewed until at least one BO is connected with a function output and at least one MV or DV is connected with a function input.

Page 93: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.9 Gains

8/02 Profit Bridge User's Guide Honeywell

81

Below is a close-up view of a portion of the Optimizer Bridge Output Gains list.

The Optimizer Combined Constraint Gains panel is laid out in the same manner, as shown below.

The gains grid is a matrix displaying all the derivative gain values for each BO/MV/DV or CC/MV/DV pairing. The grid behaves the same as the controller grid described previously.

The validation and filtering parameters work the same way as the controller gains validation and filtering parameters.

Provided Gains The gains that have the gain source option provided, that are extracted with modifications, or that have a CV, MV, or DV not connected to an independent or dependent variable, need to have a source defined for the gain. The Provided Gains display (shown below) lists all the CV – MV/DV pairs, with a source provided option selected.

Page 94: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 5 – Building Profit Bridge 5.9 Gains

Profit Bridge User's Guide 8/02 Honeywell 82

Click on either the source function or the output parameter cell for a pair, and the following window appears.

You select a function and a scalar output from it. The functions available are

shown in a drop down list under Application Functions, and are only those within the range of functions selected in the extraction functions display.

Page 95: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

8/02 Profit Bridge User's Guide Honeywell

83

5.10 Create Configuration File Creating the Configuration File

To create the configuration file, on the main menu select File > Create Configuration File. (As an alternative, you could press Ctrl+R.)

The data entered is checked first and any errors are reported. If no errors are found, a standard Windows “Save” window appears, and you would specify where the configuration file is to be saved.

The creation of a configuration file can take over a minute for a large number of gains. A confirmation message is displayed when the configuration file is successfully written.

Page 96: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

84 Profit Bridge User's Guide 8/02 Honeywell

Section 6 - Running a Profit Bridge Application

6.1 Steps to Launch an Application Steps to Launch an Application For the First Time

The following steps are required to launch a Profit Bridge application for the first time. Details on performing these steps can be found starting with Section 6.2.

1. Copy the Profit Bridge application configuration file to the \users\HiSpec\config directory

2. Register the application

3. Launch the application with Profit Viewer or HS MiniBrowser

4. Set its gain mapper update mode parameters Subsequent Launchings of an Application

For subsequent launchings of the same application, only these steps are needed.

1. Launch the application with Profit Viewer or HS MiniBrowser, and

2. Set its gain mapper update mode parameters.

Reminder – Set the GMUpdateMode

Once a Profit Bridge application is launched, gains in the corresponding Profit Controller and Profit Optimizer applications will not update until the gain Valid01\GMUpdateMode parameter of the Profit Bridge is set to one, which corresponds to an Update Mode of ON.

The default value is zero, which corresponds to OFF. The parameter value can also be set to two, which corresponds to WARM.

See Section 6.4 “Setting Parameter Values Using HS MiniBrowser” for information about how to use HS MiniBrowser to set Profit Bridge parameter values on line.

Page 97: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 85 Honeywell

6.2 Copy Profit Bridge Application Configuration File Copy Config File The Profit Bridge application configuration file is generated using the Profit

Bridge Configuration GUI component of Profit Design Studio. The configuration file must be copied to the \users\HiSpec\config directory before the corresponding application can be registered.

The configuration file name will be the name of the application plus the “.cfg” extension.

HemalathaS
8/02
Page 98: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

86 Profit Bridge User's Guide Honeywell

6.3 Register the Profit Bridge Application Read This! A Profit Bridge application is registered using the Server Registrar program. The

Server Registrar program can be run directly or through a Profit Viewer menu. The Server Registrar program is installed when the gain extraction component of Profit Bridge is installed (or when Profit Controller, Profit Optimizer, Profit Viewer, or another Profit Toolkit is installed).

Running the Server Registrar Directly

The Server Registrar program can be run by selecting:

Start>Programs>Honeywell HiSpec Solutions>Server Registrar

Running the Server Registrar from Profit Viewer

The Server Registrar program can also be run from Profit Viewer, as follows.

1. Start up an instance of Profit Viewer by selecting Start>Programs>Honeywell HiSpec Solutions>ProfitViewer

2. In the “Program Applications” menu, select: Add Profit Viewer Local Application (Server Registrar) and click the “Go” button.

For more information on using Profit Viewer, see the Profit Controller User’s Guide for Open Systems.

HemalathaS
8/02
Page 99: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 6 – Running a Profit Bridge Application 6.3 Register the Profit Bridge Application

Profit Bridge User's Guide 87 Honeywell

Registering a Profit Bridge Application

To register a Profit Bridge application, once the Server Registrar program is running:

1. Click on the Profit Bridge application to be registered in the “Non-Registered Applications” fields of the Server Registrar window.

2. Click on the “Register->” button, and a dialog will appear. Select “Register” in the dialog box and the application will then appear in the “Registered Applications – Application Status” list.

3. Click the “Exit” button to finish.

HemalathaS
8/02
Page 100: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

88 Profit Bridge User's Guide Honeywell

6.4 Launch a Profit Bridge Application Process Launching a Profit Bridge Application With Profit Viewer

To launch a Profit Bridge application with Profit Viewer:

1. Start the Profit Viewer program by selecting Start>Programs>Honeywell HiSpec Solutions>Profit Viewer.

2. Select the desired Profit Bridge application (note that the type of application should be “Toolkit”) from the “Application Status” list, then click the “View” button.

A dialog box asks if you want to connect to the selected application.

Click on “Yes” to proceed. An example of the dialog box follows.

HemalathaS
8/02
Page 101: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 6 – Running a Profit Bridge Application 6.4 Launch a Profit Bridge Application Process

Profit Bridge User's Guide 89 Honeywell

The Profit Bridge application will now proceed to start.

NOTE: Any OPC application (e.g., Profit Controller, Profit Optimizer, or other Profit Toolkit applications) that the Profit Viewer application attempts to connect to will be started if that application is not already running. (This is a Microsoft Windows NT feature.)

Once the application has started, Profit Viewer will display its functions, as shown below.

HemalathaS
8/02
Page 102: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 6 – Running a Profit Bridge Application 6.4 Launch a Profit Bridge Application Process

90 Profit Bridge User's Guide Honeywell

Setting GainValid01\ GMUpdateMode using Profit Viewer

The GainValid01\GMUpdateMode variable is the second input variable to function GainValid01. Thus, its value can be modified using Profit Viewer. To do this:

1. Click on the [+] next to the GainValid01 function. This will expand the function so that its inputs and outputs can be viewed.

2. Click on the Value of the GainValid01\GMUpdateMode. This will produce a dialog box in which the value can be changed.

3. Change the value and click [Enter].

See the following figure as an example.

HemalathaS
8/02
Page 103: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 6 – Running a Profit Bridge Application 6.4 Launch a Profit Bridge Application Process

Profit Bridge User's Guide 91 Honeywell

Launching a Profit Bridge Application with HS MiniBrowser

To launch a Profit Bridge application with HS MiniBrowser:

1. Start the HS MiniBrowser program by selecting Start>Programs>Honeywell HiSpec Solutions>HSMiniBrowser (or by double-clicking on “\Program Files\Honeywell\HiSpec Solutions\HSMiniBrowser.exe).

2. Type the Profit Bridge application name in the “Server Name” field. 3. Click the [Connect] button.

When Windows NT receives a request to connect an OPC client to its server, NT will start that OPC server (if the server was not already running).

Likewise, once the Profit Bridge application is running, it will request connection to its corresponding Profit Controller and Profit Optimizer applications. If they are not running, Windows NT will start those application tasks as well.

Important Note About HS MiniBrowser

IMPORTANT: HS MiniBrowser is not intended to be the primary method for launching Profit Bridge applications. It is only recommended to do so when a Profit Viewer with such functionality is not available.

HS MiniBrowser is a general utility designed to monitor and specify data using the OPC standard. It performs no validity or consistency checks on data entered.

HemalathaS
8/02
Page 104: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 6 – Running a Profit Bridge Application 6.4 Launch a Profit Bridge Application Process

92 Profit Bridge User's Guide Honeywell

Setting Parameter Values Using HS MiniBrowser

Until an on-line GUI is provided for Profit Bridge applications, HS MiniBrowser can be used to set parameter values while the application is running on-line. The recommended option, however, is to set the parameter values in the design GUI, rebuild the Profit Bridge application configuration file, and then restart the application with the new configuration file.

To specify a parameter:

1. Enter the parameter ID in the “New Item Id” box. - For custom variables, such as the GainValid01\GMUpdateMode parameter, the parameter ID is the parameter name (e.g., GainValid01\GMUpdateMode).- For standard variables, such as the minimum value of the fifteenth gain, the parameter ID is variable name, followed by a period, followed by the parameter name (e.g., GAIN15.ValidCoef(1)). - See Appendix B for the list of Profit Bridge parameters.

2. Click the [Add] button. The parameter ID, its current value, and the time-stamp of that value will display in the area below the New Item Id field.

3. Click on the parameter value to be changed. - If a value cannot be changed, its value will appear dimmed.

4. Type the new value in the “Control Item Value” field.

5. Click the [Enter] button.

Saving HS MiniBrowser Configurations

HS MiniBrowser allows you to save a configuration that has been entered into an “Item ID” file, so that it can be reused. To save an Item ID file:

1. Enter the file name (with an “.itm” extension) in the “Item ID File” field.

2. Click on the [Write] button.

If all of the Item Ids in the configuration are generic names, which means they are applicable to any Profit Bridge application, then the configuration file can be reused later with any Profit Bridge application.

HemalathaS
8/02
Page 105: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 6 – Running a Profit Bridge Application 6.4 Launch a Profit Bridge Application Process

Profit Bridge User's Guide 93 Honeywell

Reading a Saved HS MiniBrowser Configuration

To load a previously saved HS MiniBrowser configuration:

1. Click on the [Browse...] button 2. Click on the name of the Item Id file that contains the saved configuration 3. Click on the [Open] button 4. Click on the [Read] button

If any Item Id values are being displayed before the Item Id file is to be read, the displayed values can be removed by clicking the [Clear] button prior to clicking the “Read” button.

HemalathaS
8/02
Page 106: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

94 Profit Bridge User's Guide 8/02 Honeywell

6.5 End a Profit Bridge Application Process Privileged Task Manager

The standard task manager program provided with Windows NT cannot stop a Profit Toolkit application. A highly privileged version is provided to do this when required. It can be found at

�� \Program Files\Honeywell\HiSpec Solutions\privtskmgr.exe

Which Process Do I End?

When several Profit Toolkit applications are executing simultaneously, several processes with the image name “ProfitToolkit.ex” will be displayed. Each of these processes has a unique Process ID (PID).

The application names and corresponding Process IDs can be found in the file

�� \user\HiSpec\Apps\rstrtreg.txt

Open this file with a text editor. Ending the Process

To end the process

1. Start the privtskmgr.exe

2. Select the [Processes] tab

3. Click on [Image Name] to sort alphabetically

4. Use the rstrtreg.txt file to determine which PID corresponds to the application to be ended

5. Click on the Image Name corresponding to that PID

6. Click on the [End Process] button

Page 107: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 95 Honeywell

Section 7 – Using Third Party Model Sockets

7.1 Socket Overview What is a Socket? A third party model socket is a toolkit function that executes a third party model

such as a steady-state simulation program, a reactor model, etc. These sockets are designed with a defined set of inputs and outputs that allow Profit Bridge to easily perturb inputs to the model, obtain outputs from the model, and calculate derivatives for use in Profit Controller and Profit Optimizer applications.

In addition, these sockets can be executed as Toolkit applications on their own for purposes such as process monitoring, analyzer updating, etc.

HemalathaS
8/02
Page 108: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

96 Profit Bridge User's Guide Honeywell

7.2 Socket Configuration Third Party Model Configuration GUI

Sockets that are used within a Profit Bridge application are configured using the toolkit function editor in the Profit Bridge GUI. Sockets that are to be run stand-alone as a toolkit application can be configured using the Third Party Model Configuration GUI, which is a specialized interface designed for each type of third party model socket.

The Third Party Model Configuration GUI allows model sockets to be configured along with other supporting toolkit functions that may be needed. The GUI is described in the documentation for the specific third party model socket, since proprietary information may be needed to configure the socket.

The following tables show the Third Party Model Socket input and output structure.

Input Table The input table provides a description of the function inputs.

Input [ ] denotes array Description

Num_Input_Variables Number of input variables. Must be greater than zero.

Num_Output_Variables Number of output variables. Must be greater than zero.

Num_Derivatives Number of derivatives variables. Must be greater than zero.

Input_Variable_Values[ ] Value of the input variable, typically supplied by an external source (e.g. toolkit, TPS system, PHD). Array size is set by Num_Input_Variables

Input_Variable_Names[ ] An array of input variable names. Array size is set by Num_Input_Variables

Output_Variable_Names[ ] An array of output variable names. Array size is set by Num_Output_Variables

Independent_Variable_Names[ ] An array of independent variable names. Array size is set by Num_Derivatives, names are supplied from the Input_Variable_Names array.

Dependent_Variable_Names[ ] An array of dependent variable names. Array size is set by Num_Derivatives, names are supplied from the Output_Variable_Names array.

Model_specific_inputs The number and name of this type of input is specific to the model socket being configured. Typical examples of these inputs are a model configuration file or a model working directory.

RetNum Maximum number of simultaneous messages that can be raised.

HemalathaS
8/02
Page 109: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Section 7 – Using Third Party Model Sockets 7.2 Socket Configuration

Profit Bridge User's Guide 97 Honeywell

Output Table The output table provides a description of the function outputs.

Output

[ ] denotes array

Description Ret_Status Number of error messages

The sign of Ret_Status (either positive or negative) also controls the coloring of the function error status Red = positive = at least one error message is displayed Yellow = negative = These are only warning message(s)

RetStatus[RetNum] Array of current function return statuses. RetMessage[RetNum] Array of messages containing the current set of error messages raised against the

function. RetFloat[RetNum] Array of float arguments associated with the error messages. For internal use only.

RetString[RetNum] Array of string arguments associated with the error messages. For internal use only.

Output_Variable_Values[ ] Output values for the model, array size is set by Num_Output_Variables

Derivative_Values[ ] Derived gain values, array size is set by Num_Derivatives

HemalathaS
8/02
Page 110: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

98 Profit Bridge User's Guide Honeywell

Appendix A - Profit Bridge Error Messages

In This Appendix This appendix contains details on error messages that relate to one or all of the following functions within Profit Bridge: HSTool_GainPerturb, HSTool_GainCalculate, and HSTool_GainValidate. For each error message you will find the meaning, an example of the error message, a possible cause, how the system will react (program action), and a suggested response or action to take upon receiving a particular error message. Table A-1 contains error message descriptions that are common to all three of the above functions. Tables A-2 through A-4 contain error message descriptions that are unique to each function.

Example of Full Error Message

Below is an example of an entire error message from the log file, with a description of each field:

A = Date D = Applic Name (OPC server Name) G = Function Instance Name B = Time E = Function Library Name (dll) H = Message Status Number C = Application Type F = Function Name I = Error Message Return To Normal Message

When an error has cleared, a RETURN TO NORMAL message appears.

Using this error message as an example:

M4: Error - GAIN[4] (CV Gain[4]) Current = bad value status.

When it has cleared, this message would appear:

M4: RETURN TO NORMAL Error - GAIN[4] (CV Gain[4]) Current = bad value status.

HemalathaS
8/02
Page 111: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix A – Profit Bridge Error Messages

Profit Bridge User's Guide 99 Honeywell

Table A-1 The following are error messages common to HSTool_GainPerturb, HSTool_GainCalculate, and HSTool_GainValidate.

M1: Error – Message text Meaning: Message text indicates meaning. Usually indicates a configuration error not

handled by one of the more specific configuration errors below.

Example: Error – Can’t get Datapool parameter – NumRMPCT.

Possible Cause: Should not happen unless configuration has been incorrectly modified manually or an incompatible version of the design builder has been used.

Program Action: Toolkit function in which error occurred does not execute.

Suggested Response:

Rebuild the Profit Bridge application configuration file using a compatible version of the off-line GUI.

HemalathaS
8/02
Page 112: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix A – Profit Bridge Error Messages

100 Profit Bridge User's Guide 8/02 Honeywell

M2: Error – GAIN[i] (type[j]) parameter = value < limit, its minimum. or M2: Error – DEP[i] (type[j]) parameter = value < limit, its minimum. or M2: Error – INDEP[i] parameter = value < limit, its minimum. or M2: Error – parameter = value < limit, its minimum.

Meaning: A configuration parameter value is less than its allowed minimum value.

Example: M2: Error – INDEP[7] Source Indep = -1 < 0, its minimum.

Possible Cause: Should not happen unless configuration has been incorrectly modified manually or an incompatible version of the design builder has been used.

Program Action: If parameter is associated with a process variable (DEP, INDEP or GAIN), then perturbations or calculations associated with that variable will not be done. If parameter is not associated with a specific process variable, the toolkit function in which error occurred does not execute.

Suggested Response:

Rebuild the Profit Bridge application configuration file using a compatible version of the off-line GUI.

M3: Error – GAIN[i] (type[j]) parameter = value > limit, its maximum. or M3: Error – DEP[i] (type[j]) parameter = value > limit, its maximum. or M3: Error – INDEP[i] parameter = value > limit, its maximum. or M3: Error – parameter = value > limit, its maximum.

Meaning: A configuration parameter value is greater than its allowed maximum value.

Example: M3: Error – GAIN[25] (CCGAIN[3]) Indep Var Index = 115 > 100, its maximum.

Possible Cause: Should not happen unless configuration has been incorrectly modified manually or an incompatible version of the design builder has been used.

Program Action: If parameter is associated with a process variable (DEP, INDEP or GAIN), then perturbations or calculations associated with that variable will not be done. If parameter is not associated with a specific process variable, the toolkit function in which error occurred does not execute.

Suggested Response:

Rebuild the Profit Bridge application configuration file using a compatible version of the off-line GUI.

Page 113: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix A – Profit Bridge Error Messages

Profit Bridge User's Guide 101 Honeywell

M4: Error – GAIN[i] (type[j]) parameter = bad value status. or M4: Error – DEP[i] (type[j]) parameter = bad value status. or M4: Error – INDEP[i] parameter = bad value status. or M4: Error – parameter = bad value status.

Meaning: A configuration parameter value has a bad value status.

Example: M4: Error – DEP[16] (CV[16]) Base[2] = bad value status.

Possible Cause: Associated Profit Controller or Profit Optimizer application is initializing, or Profit Bridge application is initializing from a checkpoint file that contains a bad value status for a variable, or a value from the DCS has a bad value status.

Program Action: If parameter is associated with a process variable (DEP, INDEP or GAIN), then perturbations or calculations associated with that variable will not be done. If parameter is not associated with a specific process variable, the toolkit function in which error occurred does not execute.

Suggested Response:

Check to see if any applications were initializing. If application was not initializing or if error does not clear after application is done initializing, check the parameter source to see why it has a bad value status.

Table A-2 Error message for HSTool_GainPerturb

M10: Error – INDEP[i] Deriv Type = value. Invalid derivative type. Meaning: The DerivType configuration parameter value for the indicated independent

variable is invalid.

Example: M10: Error – INDEP[7] Deriv Type = 5. Invalid derivative type.

Possible Cause: Should not happen unless configuration has been incorrectly modified manually or an incompatible version of the design builder has been used.

Program Action: Perturbations and calculations associated with that independent invariable will not be done.

Suggested Response:

Rebuild the Profit Bridge application configuration file using a compatible version of the off-line GUI.

HemalathaS
8/02
Page 114: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix A – Profit Bridge Error Messages

102 Profit Bridge User's Guide Honeywell

Table A-3 Error message for HSTool_GainCalculate

M10: Error – GAIN[i] (type[j]) is not calculated. DEP value from model is bad. Meaning: A dependent variable value needed to calculate GAIN[i] has a bad value status.

The gain will not be calculated.

Example: M10: Error – GAIN[259] (BMGAIN[11]) is not calculated. DEP value from model is bad.

Possible Cause: The dependent variable value has been given a bad value status by the modeling system or function.

Program Action: The indicated gain is not calculated.

Suggested Response:

Determine why the modeling system or function is returning a bad value status.

Table A-4 Error messages for HSTool_GainValidate

M10: Error – Number of gains to validate is zero. Meaning: There are no gains configured for validation.

Example: M10: Error - Number of gains to validate is zero.

Possible Cause: The value of parameter GAINEXT1.NumGains is less than 1.

Program Action: Gains are not calculated.

Suggested Response:

Rebuild the Profit Bridge application configuration file using a compatible version of the off-line GUI.

M11: Error – GAIN[i] (type[j]) Calculated Gain > value, its maximum. Meaning: The indicated gain has failed the validation check of its maximum value and has

been rejected.

Example: M11: Error - GAIN[517] (CVGAIN[87]) Calculated Gain > 100.0000, its maximum

Possible Cause: The calculated gain is greater than its entered maximum limit.

Program Action: The gain is rejected and the previous good gain is used.

Suggested Response:

Evaluate if model calculations are bad or if limit is unreasonable.

HemalathaS
8/02
Page 115: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix A – Profit Bridge Error Messages

Profit Bridge User's Guide 103 Honeywell

M12: Error – GAIN[i] (type[j]) Calculated Gain < value, its minimum. Meaning: The indicated gain has failed the validation check of its minimum value and has

been rejected.

Example: M12: Error - GAIN[517] (CVGAIN[87]) Calculated Gain < 20.0000, its minimum

Possible Cause: The calculated gain is less than its entered minimum limit.

Program Action: The gain is rejected and the previous good gain is used.

Suggested Response:

Evaluate if model calculations are bad or if limit is unreasonable.

HemalathaS
8/02
Page 116: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

104 Profit Bridge User's Guide Honeywell

Appendix B - Datapool Parameters and Custom Variables

In This Appendix This appendix describes the Datapool parameters and custom variables contained

by a Profit Bridge application.

Topics include:

�� Datapool Parameters

�� Dependent Variable Parameters (DEPn)

�� Independent Variable Parameters (INDEPn)

�� Gain Parameters (GAINn)

�� Profit Bridge Dimension Parameters (GAINEXT1)

�� Profit Bridge Configuration File

HemalathaS
8/02
Page 117: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 105 Honeywell

B.1 Datapool Parameters Description The following table lists Datapool parameters.

Structure C Name Writeable Config Name Array /Size

DEP Begin_Of_Dep TRUE # 0 DEP_Type TRUE Type 1 DEP_Map_App_Index TRUE Map App Index 1 DEP_Map_Index TRUE Map Index 1 DEP_Current TRUE Current 1 DEP_Step TRUE Step 1 DEP_Base TRUE Base 5 DEP_Index TRUE CV Index 1 DEP_CC_Index TRUE CC Index 1 DEP_BO_Index TRUE BO Index 1 DEP_DV_Index TRUE DV Index 1 End_Of_Dep TRUE # 0 DEP_Var_Description TRUE Dep Var Description 0 End _Of_Dep_String TRUE # 0

HemalathaS
8/02
Page 118: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix B – Datapool Parameters and Custom Variables B.1 Datapool Parameters

106 Profit Bridge User's Guide Honeywell

INDEP Begin_Of_Indep TRUE # 0 INDEP_Type TRUE Type 1 INDEP_Map_App_Index TRUE Map App Index 1 INDEP_Map_Index TRUE Map Index 1 INDEP_PASS_Index TRUE Pass Index 1 INDEP_Step TRUE Step 1 INDEP_Step_Size TRUE Step Size 1 INDEP_Base TRUE Base 5 INDEP_DerivType TRUE Deriv Type 1 INDEP_MV_Index TRUE MV Index 1 INDEP_DV_Index TRUE DV Index 1 INDEP_Source_Indep TRUE Source Indep 1 End_Of_Indep TRUE # 0 INDEP_Var_Description TRUE Indep Var Description 0 End _Of_Indep_String TRUE # 0

GAIN Begin_Of_Gain TRUE # 0 GAIN_Type TRUE Type 1 GAIN_Dep_Var_Index TRUE Dep Var Index 1 GAIN_InDep_Var_Index TRUE Indep Var Index 1 GAIN_Original TRUE Original 1 GAIN_Previous TRUE Previous 1 GAIN_Current TRUE Current 1 GAIN_Validated TRUE Validated 1 GAIN_ValidCoef TRUE ValidCoef 100 GAIN_Calc_Type TRUE Calc Type 1 GAIN_Err_Status TRUE Err Status 1 GAIN_Map_App_Index TRUE Map App Index 1 GAIN_Map_Index TRUE Map Index 1 End _Of_Gain TRUE # 0 GAIN_Var_Description TRUE Gain Var Description 0 End _Of_Gain_String TRUE # 0

HemalathaS
8/02
Page 119: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix B – Datapool Parameters and Custom Variables B.1 Datapool Parameters

Profit Bridge User's Guide 107 Honeywell

GainExt Begin_Of_GainExt TRUE # 0 GE_Num_Rmpct TRUE Num Rmpct 1 GE_Num_CV TRUE Num CV 1 GE_Num_CC TRUE Num CC 1 GE_Num_BO TRUE Num BO 1 GE_Num_MVDV TRUE Num MVDV 1 GE_Num_CVGain TRUE Num CVGain 1 GE_Num_CCGain TRUE Num CCGain 1 GE_Num_BOGain TRUE Num BOGain 1 GE_Num_Passes TRUE Num Passes 1 GE_Num_MVDV_Pass TRUE Num MVDV Pass 1000 GE_Num_Steps_Max TRUE Num Steps Max 1 GE_Num_Valid_Coef TRUE Num Valid Coef 1 GE_GM_Update TRUE GM Update 1000 End_Of_GainExt TRUE # 0 GainExt_Var_Description TRUE GainExt Var Description 0 End_Of_GainExt_String TRUE # 0 End_Of_Datapool TRUE Last Entry of Datapool 0

HemalathaS
8/02
Page 120: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

108 Profit Bridge User's Guide Honeywell

B.2 Dependent Variable Parameters (DEPn) Description Dependent variables include:

�� Controlled Variables (CV) of RMPCT applications

�� Combined Constraint (CC) and Bridge Output (BO) variables of DQP applications

Parameter Description Values Default Type Kind of dependent variable: CV, CC, or BO 0 = CV 1 = CC

2 = BO

Map App Index

Application Index: �� CVs: 0 (not used with CVs) �� CCs: 0 (not used with CCs) �� BOs: index of RMPCT in DQP app for associated BO DV

0 to MAX_NUM_RMPCT

Map Index Variable index in associated application: �� CVs: index in RMPCT App �� CCs: index in DQP App �� BOs: index in RMPCT of associated BO DV

Non-negative

Current Current process value: �� CVs: Read Value �� CCs: Value �� BOs: Read Value For information display only.

Step Value calculated by the model system in response to most recent set of independent variable values. This value can change during any one execution interval of the Profit Bridge application, because the model/toolkit can be executed many times in one interval.

Base[ ] Set of step values used for gain calculations. These values correspond to the Base values of the most recently perturbed set of independent variables. These values can change during any one execution interval of the Profit Bridge, because the model/toolkit can be executed many times in one interval.

CV Index Variable index in its associated RMPCT App. Used only with CV variables, otherwise set to 0. Used for message and display information.

0 to MAX_CV_PER_CON

0

CC Index Variable index in its associated DQP App; used for message and display information. Used only with CC variables, otherwise set to 0.

0 to MAX CC PER DQP

0

BO Index Variable index in its associated DQP App; used for message and display information. Used only with BO variables, otherwise set to 0.

0 to MAX BO PER DQP

0

HemalathaS
8/02
Page 121: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix B – Datapool Parameters and Custom Variables B.2 Dependent Variable Parameters (DEPn)

Profit Bridge User's Guide 109 Honeywell

DV Index Variable index of the associated BO DV in its associated RMPCT App; used

for message and display information. Used only with BO variables, otherwise set to 0.

0 to MAX_DV_PER_CON

0

HemalathaS
8/02
Page 122: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

110 Profit Bridge User's Guide Honeywell

B.3 Independent Variable Parameters (INDEPn) Description Independent variables include Manipulated Variables (MV) and Disturbance

Variables (DV) of RMPCT applications.

Parameter Description Values Default Type Kind of independent variable: MV or DV. 0 = MV 1 = DV

2 = CLONEDV

Map App Index Application Index of associated RMPCT in associated DQP, if any. If there is no associated DQP, this value is 0.

0 to MAX_NUM_RMPCT

Map Index MVDV Variable index in associated RMPCT application. �� MVs: index of MV in RMPCT App �� DVs: index of DV in RMPCT App plus the total

number of MVs in that RMPCT App.

1 to MAX_MV_PER_CON + MAX_DV_PER_CON

Pass Index Perturb group number. If more than one INDEP is to be perturbed simultaneously during an execution of the model/toolkit, those INDEPs are assigned the same group number. A group number of 0 indicates that the INDEP will be perturbed by itself. It will be assigned a unique Pass Index on-line.

0 to MAX_MVDV_INDEX-1 (999)

0

Step Value this INDEP passed to the model/toolkit for an execution of model/toolkit. This value can change during any one execution interval of the Profit Bridge application because the model/toolkit can be executed many times in one interval.

Step Size Perturb step size. The difference between two consecutive STEP values when this INDEP is perturbed. This value is used to calculate values in the Base parameter.

Base[ ] Set of independent variable values used to perturb a model/toolkit to generate a set of DEP Base values for gain calculations. Base[0] is the reference value for the gain and is (currently) set to the current value of the MV or DV. These values are used to set the Step value for specific execution passes of the model/toolkit. Base[0] values: �� MV: Read Value from RMPCT’s MV �� DV: Active Value from RMPCT’s DV

Deriv Type Specifies the finite differencing method used to calculate the Base values: 0 = Don’t perturb 2 = Backward difference 1 = Forward difference 3 = Central difference

0 to 3 1

HemalathaS
8/02
Page 123: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix B – Datapool Parameters and Custom Variables B.3 Independent Variable Parameters (INDEPn)

Profit Bridge User's Guide 111 Honeywell

Parameter Description Values Default MV Index Variable index in its associated RMPCT App.

Used only with MV variables, otherwise set to 0. Used for message and display information.

0 to MAX_MV_PER_CON

0

DV Index Variable index in its associated RMPCT App. Used only with DV variables, otherwise set to 0. Used for message and display information.

0 to MAX_DV_PER_CON 0

Source Indep Index of another INDEP that is this INDEP’s source when this INDEP is a clone

0 to Number of Gain Ext Indeps

0

HemalathaS
8/02
Page 124: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

112 Profit Bridge User's Guide Honeywell

B.4 Gain Parameters (GAINn) Description In the following table, reference is made to three different gain “types”:

�� CV gains, associated with RMPCT CVs

�� CC gains, associated with DQP CCs

�� BM (Bridge Model) gains: associated with DQP bridge models. Each model has an associated DEP and INDEP variable.

Parameter Description Values Default Type Kind of gain: CV, CC, or BM 0 = CV 1 = CC

2 = BM

Dep Var Index Index of the associated DEP variable. 1 to Number of Gain Ext Deps

Indep Var Index Index of the associated INDEP variable. 1 to Number of Gain Ext Indeps

Current Most recently calculated (or provided) unvalidated gain. Validated Most recently calculated (or provided) validated gain. Currently, this value

is set to the bad value status by the GainMapper after it is used by the GainMapper.

ValidCoef[ ] Parameters used to validate the current gain: [0] – Maximum value [1] – Minimum value [2] – Action on limit violation: 0=reject, 1=clamp [3] – Filter coefficient: 0 > f >= 1 (1=no filtering) [4] – Maximum rate-of-change per validation interval [5] – Minimum change per validation interval [6 through 19] – Future use

Calc Type How gain is calculated: 0 = Don’t calculate or validate 1 = Calculate 2 = Provided by model

0, 1, or 2 1

Err Status Error status. Return status from gain calculation and validation. Good = 0. 0 Map App Index Application Index for Mapping Non-negative Map Index Index into mapping arrays (custom variables) Non-negative

HemalathaS
8/02
Page 125: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 113 Honeywell

B.5 Profit Bridge Dimension Parameters (GAINEXT1) Description This structure contains the dimension values for the Profit Bridge application.

Parameter Description Values Default Num Rmpct Number of RMPCT applications associated with this Profit Bridge

application. For information only. 1 to MAX_NUM_RMPCT

Num CV Number of DEP variables that are RMPCT controlled variables (CVs) Non-negative Num CC Number of DEP variables that are DQP combined constraint variables

(CCs) Non-negative

Num BO Number of DEP variables that are DQP bridge output variables (BOs) Non-negative Num MVDV Number of INDEP variables Non-negative Num CVGain Number of GAIN variables that are for CVs Non-negative Num CCGain Number of GAIN variables that are for CCs Non-negative Num BOGain Number of GAIN variables that are for BOs Non-negative Num Passes The largest Pass Index (Perturb Group Number). Value is determined

online at runtime. Non-negative

Num Steps Max The number of perturb steps needed for the INDEP derivative type requiring the most number of steps. This determines which elements of the INDEP Base and DEP Base arrays are used for gain calculations. The design software should set this value to 2. The value may be reduced online at runtime if fewer perturb steps are needed.

0 to 2 2

Num Valid Coef The number of gain validation parameters. Determines which elements of GAIN Valid Coef [ ] are used.

5 5

GM Update[ ] The GainMapper Update flags array. Index into array corresponds to GAINn.MapAppIndex values. Value is set to 1 by Gain Validation routine to signal to GainMapper application that gains are available for updates. GainMapper application resets this value to 0 after implementing the updates.

0 or 1 0

HemalathaS
8/02
Page 126: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

114 Profit Bridge User's Guide Honeywell

B.6 Profit Bridge Configuration File Header Statements

The following is an example of a Profit Bridge application configuration file header information:

Header, TOOLKIT, Standard Configuration Gain Ext, 1 // 1=Is a Profit Bridge App Number of Gain Ext Gains, 23 // Total Number of Gains Validated Number of Gain Ext Deps, 10 // Number of Dependent variables Number of Gain Ext Indeps, 9 // Number of Independent variables

Parameter Description Values Default Gain Ext Profit Bridge Application flag

0 = Not a Profit Bridge Application 1 = It is a Profit Bridge Application

0 or 1

Number of Gain Ext Gains Total number of gains to be calculated or validated. If this value is zero, then gains are not calculated or validated. Some gains may be calculated and others may be provided directly by model systems.

Non-negative

Number of Gain Ext Deps Total number of dependent variables associated with the gains. If this number is zero, then gains are not calculated or validated.

Non-negative

Number of Gain Ext Indeps Total number of independent variables associated with the gains or to be perturbed.

Positive

HemalathaS
8/02
Page 127: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix B – Datapool Parameters and Custom Variables B.6 Profit Bridge Configuration File

Profit Bridge User's Guide 115 Honeywell

GainMapper Reserved Custom Variable Names

The following paragraphs describe CV, CM, and BM gains. An example and discussion are provided for each type of gain..

CV Gains The following example shows the configuration file lines and custom variables used to map to Controlled Variable gains in a Profit Controller application.

// Controlled Variable (CV) Gain Mapping

//

// Mapping to APP1 called RMPCT1

APP1\GMGain, ARRAY500(Value=1.#QNAN0;Chkpnt=1), , RMPCT1, GMGain , 0..6

APP1\GMCVIndex, ARRAY500(Value=1.#QNAN0;Chkpnt=1), , RMPCT1, GMCVIndex , 0..6

APP1\GMMVDVIndex, ARRAY500(Value=1.#QNAN0;Chkpnt=1), , RMPCT1, GMMVDVIndex , 0..6

APP1\GMFilterCoeff, ARRAY500(Value=1.#QNAN0;Chkpnt=1), , RMPCT1, GMFilterCoeff, 0..6

APP1\GMROCLimit, ARRAY500(Value=1.#QNAN0;Chkpnt=1), , RMPCT1, GMROCLimit , 0..6

APP1\GMROCDeadband, ARRAY500(Value=1.#QNAN0;Chkpnt=1), , RMPCT1, GMROCDeadband, 0..6

In the above example, the gain information for seven gains is mapped to custom variables for the GainMapper, in a Profit Controller application called RMPCT1. Note the following:

�� All arrays have a minimum of 500 elements.

�� The design software must increase the array sizes, if necessary. This becomes necessary when more than 500 GAINs have the same MapAppIndex value.

�� This example is for GAINs having a MapAppIndex = 1.

�� The value of n in APPn corresponds to the MapAppIndex.

�� The GAIN having MapIndex = 0 has its information in the first array element of each array. The GAIN having MapIndex = 1 has its information in the second array element of each array, and so on.

�� The variables in the example are as follows:

APPn\GMGain: Validated CV gain values

APPn\GMCVIndex: Value of the Map Index parameter of the DEP variable that corresponds to the GAIN’s Dep Var Index

APPn\GMMVDV: Index Value of the Map Index parameter of the INDEP variable that corresponds to the GAIN’s Indep Var Index

APPn\GMFilterCoeff: Filter coefficient value implemented by the mapper

HemalathaS
8/02
Page 128: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix B – Datapool Parameters and Custom Variables B.6 Profit Bridge Configuration File

116 Profit Bridge User's Guide Honeywell

APPn\GMROCLimit: Rate-of-change limit value implemented by the mapper

APPn\GMROCDeadband: Deadband limit value implemented by the mapper

CC Gains The following example shows the configuration file lines and custom variables used to map to Combined Constraint gains in a Profit Optimizer application.

// Combined Constraint (CC) Gain Mapping

//

// Mapping to APP0 called DQP1

APP0\GMCCGain, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMCCGain , 0..4

APP0\GMCCIndex, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMCCIndex , 0..4

APP0\GMCCMVDVIndex, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMCCMVDVIndex , 0..4

APP0\GMCCAppIndex, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMCCAppIndex , 0..4

APP0\GMCCFilterCoeff,ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMCCFilterCoeff, 0..4

APP0\GMCCROCLimit, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMCCROCLimit , 0..4

APP0\GMCCROCDeadband,ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMCCROCDeadband, 0..4

In this example, the gain information for five gains is mapped to custom variables for the GainMapper in a Profit Optimizer application called DQP1. Note the following:

�� All arrays have a minimum of 1000 elements.

�� The design software must increase the array sizes, if necessary. This becomes necessary when more than 1000 combined constraint GAINs have the same MapAppIndex value.

�� This example is for GAINs having a MapAppIndex = 0.

�� The value of n in APPn corresponds to the MapAppIndex.

�� The GAIN having MapIndex = 0 has its information in the first array element of each array; the GAIN having MapIndex = 1 has its information in the second array element of each array, and so on.

�� The variables in the example are as follows:

APPn\ GMCCGain: Validated CC gain values

APPn\ GMCCIndex: Value of the Map Index parameter of the DEP variable that corresponds to the GAIN’s Dep Var Index

APPn\ GMCCMVDVIndex: Value of the Map Index parameter of the INDEP variable that corresponds to the GAIN’s Indep Var Index

HemalathaS
8/02
Page 129: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix B – Datapool Parameters and Custom Variables B.6 Profit Bridge Configuration File

Profit Bridge User's Guide 117 Honeywell

APPn\ GMCCAppIndex: Value of the Map App Index parameter of the INDEP variable that corresponds to the GAIN’s Indep Var Index

APPn\ GMCCFilterCoeff: Filter coefficient value implemented by the mapper

APPn\ GMCCROCLimit: Rate-of-change limit value implemented by the mapper

APPn\ GMCCROCDeadband: Deadband limit value implemented by the mapper

BM Gains The following example shows the configuration file lines and custom variables used to map to Bridge Model gains in a Profit Optimizer application.

// Bridge Model (BM) Gain Mapping

//

// Mapping to APP0 called DQP1

APP0\GMBMGain, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMBMGain , 0..1

APP0\GMBODVIndex, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMBODVIndex , 0..1

APP0\GMBOAppIndex, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMBOAppIndex , 0..1

APP0\GMBIMVDVIndex, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMBIMVDVIndex , 0..1

APP0\GMBIAppIndex, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMBIAppIndex , 0..1

APP0\GMBMFilterCoeff,ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMBMFilterCoeff, 0..1

APP0\GMBMROCLimit, ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMBMROCLimit , 0..1

APP0\GMBMROCDeadband,ARRAY1000(Value=1.#QNAN0;Chkpnt=1), , DQP1, GMBMROCDeadband, 0..1

In this example, the gain information for two gains is mapped to custom variables for the GainMapper in a Profit Optimizer application called DQP1. Note the following: �� All arrays have a minimum of 1000 elements. �� The design software must increase the array sizes, if necessary. This becomes

necessary when more than 1000 bridge model GAINs have the same MapAppIndex value.

�� This example is for GAINs having a MapAppIndex = 0. �� The value of n in APPn corresponds to the MapAppIndex. �� The GAIN having MapIndex = 0 has its information in the first array element

of each array; the GAIN having MapIndex = 1 has its information in the second array element of each array, and so on.

�� The variables in the example are as follows: APPn\ GMBMGain: Validated BM gain values

APPn\ GMBODVIndex: Value of the Map Index parameter of the DEP variable that corresponds to the GAIN’s Dep Var Index

HemalathaS
8/02
Page 130: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Appendix B – Datapool Parameters and Custom Variables B.6 Profit Bridge Configuration File

118 Profit Bridge User's Guide Honeywell

APPn\ GMBOAppIndex: Value of the Map App Index parameter of the DEP variable that corresponds to the GAIN’s Dep Var Index

APPn\ GMBIMVDVIndex: Value of the Map Index parameter of the INDEP variable that corresponds to the GAIN’s Indep Var Index

APPn\ GMBIAppIndex: Value of the Map App Index parameter of the INDEP variable that corresponds to the GAIN’s Indep Var Index

APPn\ GMBMFilterCoeff: Filter coefficient value implemented by the mapper

APPn\ GMBMROCLimit: Rate-of-change limit value implemented by the mapper

APPn\ GMBMROCDeadband: Deadband limit value implemented by the mapper

HemalathaS
8/02
Page 131: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Profit Bridge User's Guide 119 Honeywell

Index

A APCDE, 2 Application

Launching, 79, 83 Registering, 81

Architecture – Profit Bridge, 8

B Bridge Model (BM) Gains, 107, 112

C Calculations, Gain Multiplier, 21 Clone DVs, 12 Combined Constraint (CC) Gains, 107 Configuration File, 109 Configuring Perturbations, 72 Configuring Variable Connections, 69 Connections, Variable, 66 Controlled Variable (CV) Gains, 107, 110 Controller and Optimizer Model File Relationship, 58 Controller Gains, 73 Controller Model Files, 55 Conventions, xii Custom Variables, 101 CV Gains, 73

D Datapool Parameters, 18, 28, 101, 102 Datapool, Gain Mapper Inputs and Outputs, 25 Datapool, Inputs and Outputs, 39 Dependent Variables, 15, 104 DEPn, 104 Derivitive Gain Values, 74

HemalathaS
8/02
Page 132: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Index

120 Profit Bridge User's Guide Honeywell

Differentiation, 13 Dimension Parameters, 108 Disturbance Variables, 12 DQP, 4, 27

E Error messages, 95 Error Reporting, 22 Exponential Filtering, 16 Extraction Loops, 64 Extraction, Functions for, 64

F FCCU Toolkit, 5 Filtering

Exponential, 16 For Smooth Ramping, 20, 30 Rate of Change, 16, 30

Functions for Extraction, 64 Functions List, 53

G Gain Calculation, 15 Gain Extraction, 6, 9

Concepts, 12 Loops, 9

Gain Multiplier, 21 Gain Parameters, 107 Gain Scheduling, 6 Gain Source

Extracted with modifications, 74 Provided, 74

Gain Updates, 30 Gain Validation, 15 GainMapper, 10, 17

BM Gains, 112 CV Gains, 110 Error Reporting, 22 Example of Use, 20 Execution, 18

HemalathaS
8/02
Page 133: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Index

Profit Bridge User's Guide 123 Honeywell

General usage of, 17 Rate of Change Check, 19, 30 Reserved Custom Variable Names, 110 Return Status Table, 22 Setting Datapool parameters, 18 Setting Filter for Smooth Ramping, 20 Setting Mode, 16 Terminology, 17 Validating only the gains, 18 Why to use it, 17

GainMapperPO, 27 Error Reporting, 34 Execution, 29 Invoking through Execute Parameter, 29 Rate of Change Check, 30 Setting Filter for Smooth Ramping, 30 Terminology, 27 Updating Gains, 30 Validating only the gains, 30 Why to use it, 27 YM File Usage, 30

GAINn, 107 Gains

Bridge Model (BM), 112 Controlled Variable (CV), 110 Controller, 73 Optimizer, 76 Validation and Filter Parameters, 75

GMUpdate, 11

H HS MiniBrowser

Launching Profit Bridge Application, 83 Reading a Saved Configuration, 88 Saving Configurations, 87 Setting Parameters Values, 87

I Independent Variables, 14, 15, 105 INDEPn, 105 Installing GainMapper, 45 Installing Profit Bridge, 43

HemalathaS
8/02
Page 134: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Index

124 Profit Bridge User's Guide Honeywell

Introduction to Profit Bridge, 1

L Launching an Application, 79 Launching Profit Bridge Application, 83 Logging Gain Changes, 24, 38

M Manipulated Variables, 12 Model Data Source, 59 Model Data Source Configuration, 63 Model sockets, 91 Modeling Functions, 10

O OPC Application, Starting, 84 OPC Client, 86 OPC Server, 86 Optimizer Gains, 76 Optimizer Model Files, 57 Overview

Profit Bridge, 1, 6 Profit Controller, 4 Profit Design Studio, 2 Profit Optimizer, 4 Profit Toolkit, 5 Profit Viewer, 3

P Parameters

Datapool, 101, 102 Dimension, 108 Gain, 107

Perturb Groups, 71 Perturbation, 13 Perturbation Configuration Items, 71 Perturbation Groups, 14 Perturbations, 71 Privileged Task Manager, 89 Profit Bridge

HemalathaS
8/02
Page 135: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Index

Profit Bridge User's Guide 125 Honeywell

Applications, 49 Configuring, 49 Creating a New Application, 50 Deleting an Application, 50 Modeling Functions, 10 Offline and Online Components, 8 Online Functional Flow, 9 Optimizer Model Files, 57 Selecting an Existing Application, 50 When Not to Use, 7 When to Use, 6

Profit Bridge CD, What’s Included, 43 Profit Bridge Configuration

Controller Gains, 73 Controller Model Files, 55 Database Activity, 51 Functions for Extraction, 64 Functions List, 53 Inserting a New Function, 53 Model Data Source, 59 Optimizer Gains, 76 Overview, 51 Perturbations, 71 Third party sockets, 92 Variable Connections, 66

Profit Optimizer, 4, 27 Profit Suite components, 2 Profit Toolkit, 5 ProfitBridgeConfigGUI, 49 Provided Gains, 77

R Rate of Change Filtering, 16 Registering Profit Bridge Application, 81 Return Status Table

GainMapper, 22 GainMapperPO, 35

RMPCT, 4

S Saving Older Versions of YM File, 31 Selecting Controller Model files, 56

HemalathaS
8/02
Page 136: Profit Bridge User's Guide - Honeywell...About This Publication 8/02 Profit Bridge User's Guide ix Honeywell Writing Conventions Used in This Book The conventions listed in the following

Index

126 Profit Bridge User's Guide Honeywell

Server Registrar, 81 Setting Parameter Values Using HS MiniBrowser, 87 Simulation Conditions, 14 Sockets, 91

Configuration, 91 Inputs, 91 Outputs, 93 Third party, 91

T TAINEXT1, 108 Technical Assistance, xiv Third Party Model Configuration GUI, 92 Third party model sockets, 91

V Valid Coeff, 15 Variable Connections, 66 Variable Connections

Changing, 70 Removing, 70

Variables Custom, 101 Dependent, 104 Independent, 105

Variables List, 68 Variables, Standard and Custom, 61 Version of Profit Design Studio, 1

Y YM File, 31

HemalathaS
8/02