Customized Developers User-added Unit Operation Data

Customized Developer’s User-added Unit Operation Data

The "Customized" Data Entry Window

You have the option of defining a Custom Data Entry Window for use by all user-added unit operations that utilize a specific user-added calculation subroutine. All custom windows are based on the "standard" data entry window for a user-added unit operation. Basically, customization allows developers to attach labels, descriptive text, and other information to the various input elements, particularly the four standard data input tables. In this way, elements and blocks of elements of the standard arrays are grouped and renamed to better reflect the actual data requirements of the unit operation. This article is a brief introduction to many of the available customization options.

The standard PRO/II User-added Unit Operations use the default names US1 - US20 (corresponding to the FORTRAN subroutines USER41 - USER60). If you create a customized data entry window for a User-added calculation subroutine, the name that is selected for it will replace one of the default names in the list of available subroutine names that is displayed when a User-added unit is laid down on the PFD.

Creating a "Customized" Data Entry Window

A customized data entry window requires the creation of two ASCII files. They must be created in the directory specified by the UserConfigDir= entry in the [GUIDefaults] section of the PROII.INI file. These two files are named UASLIST.INI and USERXX.INI, and are described below.

UASLIST.INI

This file contains the User-specified names for specific User-added calculation subroutines that will be displayed in place of the default names US1 - US20 (corresponding to the FORTRAN subroutines USER41 - USER60). Each line in the file has two entries; the entry number in the list of User-added subroutine names, and the actual text that is to be displayed for the User-added subroutine. An example of a typical UASLIST.INI file is shown below:

Example UASLIST.INI file:

1 PIPE DP Routine

2 Stream Heating Value

These entries in the UASLIST.INI file will result in the following list of available User-added calculation subroutines being displayed when a User-added Unit is laid down on the PFD:

PIPE DP Routine

Stream Heating Value

US03

US04

...

US20

USERXX.INI

This file contains the variable names and array locations for all of the Real, Supplemental, Integer, and Heat Balance Data values that the specific User-added calculation subroutine requires or that can be input by the User. For a User-added subroutine with a customized data entry window, a user will only be able to enter values for the data items specified in this file. The "XX" in the name of the USERXX.INI file corresponds to the respective User-added subroutine referenced, i.e. the User-added subroutine USER42 with a user-specified name of "PIPE DP Routine" above would need a "USER42.INI" file to describe the required data for the calculations. An example of a typical USERXX.INI file is shown below:

Example USER42.INI file:

IPARM 1 "Print Control" Required

RPARM 1 "Diameter (in)" Required

RPARM 2 "Length (ft)" Required

...

SUPPLE 1 "No. Of Segment" Required

...

$image\EDIT03.gif$ The first entry on each line indicates to which data array the variable belongs.

$image\EDIT03.gif$ The second entry is the array number where the data value entered by the User will be stored for access by the User-added calculational subroutine.

$image\EDIT03.gif$ The third entry is the label to be displayed for the variable in the customized data entry window. This entry must be enclosed in double quotes (’r;’)

$image\EDIT03.gif$ The fourth entry on each line indicates whether data entry for the item is Optional or is Required. The default is Optional, and this entry is not required. If you want a value to be shown as required, you must spell out the key word Required. The case doesn’t matter (i.e. upper, lower, random mixed, etc.). However, abbreviations and misspellings cause this key word to be ignored, so the data entry will be shown as Optional.

Entries in the example USER42.INI file (shown above) display the specified data values and variable names in the custom data-entry window. To display this custom input window, follow these steps.

$image\EDIT03.gif$ Lay down a User-Added Unit Operation icon on the PFD.

$image\EDIT03.gif$ When the UAS Unit Op Configuration window (automatically) appears, select PIPE DP Routine from the drop down list. Press OK to exit the window.

$image\EDIT03.gif$ Right click the new icon on the PFD to display the control menu; then select Data Entry… The custom data entry window will appear.

You may also enter data into the variables in the Real Data table using the Define system.

Values in the Real Data table are available to other unit operations by means of SPECs, VARYs and DEFINEs. The other tables are private and are not available outside the User-added Unit Operation.

Reorder Streams button

If a User-added Unit Operation has more than one feed or product, they are listed in the order in which they were laid down on the Process Flow Diagram. You may need to reorder the streams so that they are presented in the correct order (i.e., as expected by the User-added Unit Operation). For example, the User-added Unit Operation may always feed vapor to the first product stream and liquid to the second.

Push the button to display the User-added Unit Operation - Stream Reordering Window That window allows you can change the stream order.

How to get to this window

The customized developer’s data entry window for a User-added Unit Operation is accessed by double clicking on the icon laid down on the Process Flow Diagram for the User-added Unit Operation.

$image\SML_LINE.gif$

User-added Unit Operation - Technical Information

Standard Developer's User-added Unit Operation Data

Toolbar

Unit and Description

OK and Cancel Buttons

Thermodynamic System