Beruflich Dokumente
Kultur Dokumente
Version 11.1
Corporate
Aspen Technology, Inc.
Ten Canal Park
Cambridge, MA 02141-2201
USA
Phone: (1) (617) 949-1021
Toll Free: (1) (888) 996-7001
Fax: (1) (617) 949-1724
URL: http://www.aspentech.com
Division
Design, Simulation and Optimization Systems
Aspen Technology, Inc.
Ten Canal Park
Cambridge, MA 02141-2201
USA
Phone: (617) 949-1000
Fax:(617) 949-1030
Contents
About This Reference Manual
For More Information ..................................................................................................... vi
Technical Support .......................................................................................................... vii
Contacting Customer Support ................................................................................ vii
Hours ....................................................................................................................... viii
Phone ....................................................................................................................... viii
Fax ............................................................................................................................. ix
E-mail ........................................................................................................................ ix
1
System Overview
Functional Overview of Aspen Plus ............................................................................. 2-2
User Interface System Files ......................................................................................... 2-4
Simulation Engine System Files .................................................................................. 2-4
Files Associated with a Simulation Run...................................................................... 2-5
The Aspen Plus Run Definition File ............................................................................ 2-6
Aspen Plus Utilities ...................................................................................................... 2-9
Simulation Engine Command Line Qualifiers ............................................................ 2-9
System Management
Version 11.1
iii
Accounting Report
Generating a User-Based Accounting Report..............................................................7-2
Running the Accounting Program................................................................................7-4
Creating a New Accounting File...................................................................................7-6
Making Accounting Information Required ..................................................................7-6
Activating Accounting on Windows..............................................................................7-7
Index
iv
System Management
Version 11.1
System Management
Version 11.1
vi
System Management
Version 11.1
Technical Support
Online Technical Support Center
AspenTech customers with a valid license and software maintenance agreement
can register to access the Online Technical Support Center at:
http://support.aspentech.com
This web support site allows you to:
Access current product documentation
Search for tech tips, solutions and frequently asked questions (FAQs)
Search for and download application examples
Search for and download service packs and product updates
Submit and track technical issues
Search for and review known limitations
Send suggestions
Registered users can also subscribe to our Technical Support
e-Bulletins. These e-Bulletins are used to proactively alert users to important
technical support information such as:
Technical advisories
Product updates
Service Pack announcements
Product release announcements
System Management
Version 11.1
vii
Hours
Support Centers
Operating Hours
North America
South America
Europe
Asia and Pacific Region
Phone
Support
Centers
Phone Numbers
North
America
1-888-996-7100
1-281-584-4357
(52) (5) 536-2809
South
America
Europe
viii
(65) 395-39-00
(81) (3) 3262-1743
Singapore
Tokyo
System Management
Version 11.1
Fax
Support Centers
Fax Numbers
North America
South America
Europe
Support Centers
North America
South America
info@tecnosolution.com.ar (Argentina)
tecnosp@aspentech.com (Brazil)
Europe
System Management
Version 11.1
ix
System Management
Version 11.1
Chapter 1
System Management
Version 11.1
1-1
Upgrading
Aspen Plus
Compatibility Issues
Aspen Technology makes every effort to avoid changes in new releases that
introduce incompatibilities with old releases, and to provide migration utilities
when changes are unavoidable. However, most in-house modifications and user
models implemented in previous versions need to be updated or reapplied in
order to work with the new version.
Extensions
Upwardly Compatible?
.bkp
Yes
.apw
No
Quick Restart
No
To create backup files from Quick Restart format, set up the previous version of
Aspen Plus. At the command line, type:
mmbackup RunID
where RunID identifies the simulation model (in Quick Restart format) for which
you are creating the backup file.
To create a backup file from Aspen Plus Document format, open the file in the
version of Aspen Plus with which it was created and select File | Export.
Databank Files
You must rebuild all user and in-house databanks using the Aspen Plus Data
File Management System (DFMS). After an upgrade to a new version of Aspen
Plus, it is advisable to reapply any databank or system definition file (SDF)
modifications, as described in the next section.
For instructions on how to rebuild user and in-house databanks, see Chapter 4,
Adding User and In-House Databanks.
1-2
System Management
Version 11.1
Chapter 1
See
Chapter 5
Chapter 3
In Version 9.x of Aspen Plus, the file extension for these files was
PDF, but it has been changed to APPDF (Aspen Plus PDF) in
order to avoid conflicts with Adobe Acrobat files.
Other Files
Version 11.1 is compatible with the following files from previous releases:
Interactive Aspen Plus (IAP) scripts (.scp)
Insert Libraries (.ilb)
Stream Libraries (.slb)
Run Definition (.def)
Summary (.sum)
System Management
Version 11.1
1-3
Upgrading
Aspen Plus
Load Modules
Generated program executables (load modules) from previous releases, including
general purpose load modules, are not compatible with Version 11.1. For Version
10, the Aspen Plus Simulation Engine has been divided into many Shared or
Dynamic Link Libraries (DLLs). Aspen Plus no longer has a single large program
executable. All documented interfaces to the Aspen Plus simulation engine have
been isolated into a small group of shared libraries.
1-4
System Management
Version 11.1
Chapter 1
Table 1.1 shows the settings that are saved in the user's Windows registry.
Within the user interface, you can access settings shown in the table by clicking
Tools, then Options.
Table 1.1
Option
Setting
runanyway
ftn_check
account-info
alwayssavebkp
Save document as
defsaveasbkp
copyvalue
copyunits
copylabel
copybasis
Time stamp
timestamp
purebank
paramdata
regdbank
component
globalqw, qwformat
globaltemp, tempformat
globalpres, presformat
globalflow, flowformat
globalstrmqw, strmqwformat
Express run
pseudobatch
partial
animation
editinput
continued
System Management
Version 11.1
1-5
Upgrading
Aspen Plus
Table 1.1
mmg.ini Settings You Can Change Within the User Interface (cont.)
Menu Selections
Option
Setting
Server type
servertype
Server name
servername
Username
username
Working directory
workingdir
Run type
runtype
Application template
template
startupdir
BatchFrac
bfracenabled
RateFrac
rtfenabled
Aspen Dynamics
dynaplusenabled
POLYMERS PLUS
polyplusenabled
Text editor
editor
printcommand
autoblockid, blockprefix
showblockid
autostreamid, streamprefix
showstreamid
autoplacement
lockblock, placement
labelscale
Show scale
scale
Show grid
grid
Snap to grid
grid
Grid size
gridresolution
zoomfactor
scrollstep
Title
plottitlefont
Axis label
plotlabelfont
Axis scale
plotscalefont
continued
1-6
System Management
Version 11.1
Chapter 1
Table 1.1
mmg.ini Settings You Can Change Within the User Interface (cont.)
Menu Selections
Option
Setting
Annotation
plottextfont
Legend
plotlegendfont
Grid style
gridstyle
Line style
linestyle
Marker size
plotmarkersize
Show legend
showlegend
plottimestamp
Size
papersize
Source
papersource
Orientation
orientation
Left margin
marginleft
Right margin
marginright
Top margin
margintop
Bottom margin
marginbottom
View menu
Model library
modellibraryview
View menu
Status bar
statusbarview
View, Toolbar
Standard
toolstdvisible
View, Toolbar
Data Browser
tooldatavisible
View, Toolbar
Simulation Run
toolrunvisible
View, Toolbar
Process Flowsheet
toolpfsvisible
View, Toolbar
Draw
tooldrawvisible
View, Toolbar
Dynamic
tooldynvisible
View, Toolbar
Section
toolsectionsvisible
Window menu
worksheetmode,
wallpaperview
Draw toolbar
Color
drawcolor
Draw toolbar
Line style
drawlinestyle
Draw toolbar
Font
drawfont
System Management
Version 11.1
1-7
Upgrading
Aspen Plus
The following changes have been made to the Aspen Plus simulation engine:
COMMON blocks are now stored in INCLUDE files
Aspen Plus COMMONs have been renamed
Aspen Plus routines have been renamed
The following sections describe these changes in detail.
INCLUDE Files
All Aspen Plus COMMON blocks are now stored in INCLUDE files. Rather than
referencing a local copy of a COMMON block, all user subroutines and
Aspen Plus input files with inline Fortran now reference the INCLUDE files. Any
customer COMMONs must have the identical variable list at every reference
point.
1-8
System Management
Version 11.1
Chapter 1
System Management
Version 11.1
1-9
Upgrading
Aspen Plus
1-10
System Management
Version 11.1
Chapter 2
System Overview
This chapter provides a functional overview of Aspen Plus. It also describes:
User interface system files
Simulation engine system files
Files associated with a simulation run
The Aspen Plus Run Definition File
Aspen Plus utilities
Simulation engine command line qualifiers
System Management
Version 11.1
2-1
System
Overview
Table 2.1
Platform Requirements
Operating System
Platform
Name
Version
Windows 95
SP1 (3)
Windows 98
SE (3)
Intel
(2)
Pentium
Windows NT
Fortran Compiler
(3)
Simulation
Engine (1)
User Interface
110
220
110
220
110
220
(1)
2-2
System Management
Version 11.1
Chapter 2
Scenario 1
A typical engineer performing a simulation does the following:
1. Specifies the problem on a graphical flowsheet using the Aspen Plus user
interface. The user interface provides a patented expert system to guide the
engineer through the problem specification.
2. Runs the simulation calculations interactively or in batch mode using the
user interface Run commands. The user interface and the simulation engine
communicate with each other using socket messages and ASCII files. For
details on communications between the user interface and the simulation
engine, see Aspen Plus System Administration.
3. Analyzes the simulation results using the Aspen Plus user interface and the
Aspen Plus history and report files.
Scenario 2
The engineer can also run the simulation engine independently of the user
interface. In this scenario, the engineer:
1. Creates a keyword input language file containing the problem specifications.
2. Runs the simulation engine interactively or in batch mode using the Aspen
command from the operating system command line.
3. Analyzes the simulation results using the Aspen Plus history and report files
generated by the simulation engine.
These methods can be combined. For example, a simulation created or modified
outside of the user interface can be loaded into the user interface for further
study.
The following sections list the files that the user interface and the simulation
engine use and create.
System Management
Version 11.1
2-3
System
Overview
Description
Format
recdef.apr
Data structure definition files, including physical property databanks and expert
system rules
Binary
mmg.hms
Binary
mm.ini
ASCII
mmg.ini
ASCII
*.hlp
Binary
2-4
File Type
Description
.dat
.sdf
.ilb
.slb
.msf
System Management
Version 11.1
Chapter 2
Name
Description
Format
Client/Server
.his
History
Calculation history
ASCII
Server
.apw
User interface
document
Binary
Client
.appdf
Problem data
Binary
Server
.for
Fortran
ASCII
Server
You can export the following types of ASCII files from the File Export menu of
the user interface:
System Management
Version 11.1
File Type
File Name
File Contains
.bkp
Backup
Input description, graphics, optionally results in a compact ASCII format that the
user interface can read
.cpm
.inp
Input
.rep
Report
Simulation results.
.sum
Summary
.dynf
.apt
Application Template
.dxf
Flowsheet Drawing
Flowsheet graphics
2-5
System
Overview
The following types of ASCII files are useful for diagnosing problems:
File Type
Name
Description
.cmp
Compiler output
.for
Fortran
.jnl
Journal
.ld
Linker diagnostics
.opt
Linker options
For
The syntax is
File specifications
symbol: filespec
Command options
symbol:
The engineer specifies the run definition file in the Run Settings dialog box in the
user interface. The names of files specified in the run definition file can exceed
eight characters. However, the name cannot contain any blank spaces in the
name of the file.
The engineer can also specify the run definition file at the operating system
command prompt when using the Aspen command by setting the symbol or
environment variable XDEF.
2-6
System Management
Version 11.1
Chapter 2
Table 2.2 lists valid symbols and specifications for the default file.
Table 2.2
Description
Default File
INPUT
Input file
none
RUNID
none
Problem datafile
runid.appdf
PP1A
USRPP1A databank
none
PP1B
USRPP1B databank
none
PP2A
USRPP2A databank
none
PP2B
USRPP2B databank
none
PP2C
USRPP2C databank
none
XILB
sys.ilb
XULB
user.ilb
XSLB
sys.slb
XSCD
aspcost.dat
UCOS
none
IPCD
inhspcd.dat
ISOL
inhssol.dat
IAQU
inhsaqu.dat
IBIN
inhsbin.dat
XCOM
combust.dat
XDPR
pure10.dat
XPCD
aspenpcd.dat
XFLO
flowtran.dat
XSOL
solids.dat
XAQU
aqueous.dat
XBIN
binary.dat
XBAR
inorgani.dat
XMRL
cpdmrl.dat
XNPL
cpdnpl.dat
continued
System Management
Version 11.1
2-7
System
Overview
Table 2.2
Description
Default File
XNBS
cpdnbs.dat
XJAN
cpdjan.dat
XSGT
cpdsgt.dat
XPC85
pure856.dat
XPC93
pure93.dat
XAQ92
aqu92.dat
XFACT
F*A*C*T databank
factpcd.dat
XPOPCD
polymer.dat
XSEPCD
segment.dat
XSDF
sdffil.sdf
SCRIPT
iap.scp
XDEF
none
XMOD
none
XPDFLC
none
USERNAME
Username
none
NEW_RUNID
none
OLD_RUNID
none
LMHOST
none
IAPFLAG
Interactive flag
none
MMBACKUP
N/A
ITONLY
N/A
BATCH
N/A
TUTOR
N/A
SLAVE
N/A
DLOPT
none
2-8
System Management
Version 11.1
Chapter 2
Table 2.3
Utility Programs
Utility
Description
ACR
Generates accounting reports about Aspen Plus usage at a site. See Chapter 7.
CDFMS
DFMS
Creates and updates Aspen Plus physical property databanks. See Aspen Plus Physical
Property Data.
GETRIDOF
IFMS
MMTBS
SDFRPT
STRLIB
TBS
Creates and modifies the Aspen Plus system definition file. See Chapter 3.
ASPLINK
Generates user shared or dynamic link libraries. See Aspen Plus User Models.
ASPCOMP
For Windows versions of Aspen Plus, the Aspen command must be run from the
Aspen Plus Simulation Engine window.
System Management
Version 11.1
2-9
System
Overview
Typographical Conventions
Following are the conventions used in the simulation engine command line
qualifiers:
Convention
Represents
[ ]
optional qualifier
italics
Note
/insert=abc
-insert abc
2-10
System Management
Version 11.1
Chapter 2
/inhXXX=name ............... Use this qualifier to specify the name of an in-house databank to use in the current simulation.
Valid name specifications are inhpcd, inhsol, and inhaqu. If the option is specified without giving a
value, the default databanks on the Aspen Plus system directory are used. It is possible that one or
more of the /inhXXX options have been modified by the Aspen Plus system administrator at your
site making the desired in-house databank active for every simulation. If so, you do not need to
specify the /inhXXX option unless you wish to override the default set by the system administrator.
/insert=name.................. Use this qualifier to specify the full or relative path name of the insert library that contains inserts
referenced in the current simulation input file. A suffix of .ilb is assumed in the insert library name
and should not be included in the filename.
/itonly ............................. Use this qualifier to execute only the input translation step on your simulation input.
/log ................................. Use this qualifier to create a log of the messages written to the terminal for your current run. The
messages are written to the file RunID.log.
/mm ................................ If you specify /mm with /getridof, then the .sum and .sta files are not deleted. This allows you to
run Aspen Plus with the user interface.
/mmbackup .................... If you specify /mmbackup, then the input translator will create a .bkp file that can be restored to
the user interface. The qualifier /nommbackup disables this option even when the system has
/mmbackup turned on by default.
/ppXX=name .................. Use the pp1a, pp1b, pp2a, pp2b, and pp2c qualifiers to specify the name(s) of user physical property
databanks referenced in the simulation input file. You can specify all the databank options on the
command line, but you may specify each option only once. The argument is the full or relative path
name of the databank to be used in the simulation.
/sponly ............................ Use this qualifier to execute only the Simulation Program step. Specify the /sponly option to follow
an /itonly run, or to continue an interactive simulation run, or when you wish to perform a restart
of a previous simulation that failed because it exceeded the maximum simulation time or number
of iterations. The input_file name is not specified when /sponly is used. These options are not
allowed with /sponly: /itonly, /insert, /ucost, /ppXX, and /inhXXX.
/strlib ............................... Use this qualifier to specify the name of the stream library from which stream data should be
retrieved. The STREAM-LIB paragraph in an Aspen Plus input file is used to specify the stream
data to retrieve.
/ucost=name ................... Use this qualifier to specify the name of a costing data file used in your simulation problem. The
argument is the full or relative path name of the costing databank to be used in the simulation.
/dlopt=name.................... Use this qualifier to specify the name of a file containing a list of object files, archives, or shared
libraries that Aspen Plus should use when performing dynamic links of user routines. List object
and archive filenames one per line. Environment variables and wildcards (*) are allowed. See
Aspen Plus User Models for more information on Dynamic Link Options files.
/defaults=name............... Use this qualifier to specify the name of a file containing default options for your simulation
problem. For more information, see the Aspen Plus Run Definition File, this chapter.
/qsub [arguments] ......... This qualifier causes the job to be submitted to NQS (Network Queuing System) via the qsub
command for execution. Any arguments that appear after the /qsub option are passed as arguments
to the qsub command. This means that any Aspen Plus options must appear before the /qsub
option. Use of this option assumes that your system has the NQS software installed. NQS is not
part of Aspen Plus software.
System Management
Version 11.1
2-11
System
Overview
2-12
System Management
Version 11.1
Chapter 3
Maintaining and
Updating Aspen Plus
This chapter discusses various levels of customization to the Aspen Plus
simulation engine including the following topics:
Modification Levels in Aspen Plus
Maintaining User Routines
Building System Shared Libraries
Integrating In-House Models and Subroutines
Running a System Definition File (SDF) Report
Running the Aspen Plus Table Building System (TBS)
Converting Version 9.x TBS Input Files
System Management
Version 11.1
3-1
Maintaining
and Updating
Aspen Plus
User
In-house
System
User Modifications
User level modifications are generally made for specific simulation models, but
can also be used for many users working on a project. User modifications include:
User insert libraries
Databanks
User unit operation models
Kinetic subroutines
Property subroutines
Stream libraries
3-2
System Management
Version 11.1
Chapter 3
The user develops any necessary subroutines, data, and files, and stores them in
the individual user's directories or in a shared location.
In-House Modifications
In-house modifications are used when modifications need to be available for all
Aspen Plus users. In-house modifications should be performed by the Aspen Plus
administrator. In-house modifications include:
In-house databanks
Built-in user unit operation and property models
Insert files
Frequently, the user can choose between the in-house modifications or the
Aspen Plus system files as delivered.
System Modifications
Since system level modifications affect the files delivered with Aspen Plus, they
are usually more difficult to integrate into a new version than user or in-house
changes. Before making system changes, check whether any user or in-house
modifications can accomplish the same task.
Before creating or modifying system level files, make sure:
The current Aspen Plus version is installed
Your environment is set up for the correct version of Aspen Plus
You use the Aspen Plus system administrator account with privileges to read,
write, and delete files in the Aspen Plus directory tree
When you make system-level changes, you can inadvertently introduce errors
into your system that are difficult to diagnose or fix. Follow these
recommendations to minimize potential problems:
1. If you need to modify an Aspen Plus system routine, contact the AspenTech
Hotline.
2. If you want to create entirely new unit operation models, cost blocks, utilities,
or physical property models, contact the AspenTech Hotline. This chapter
does not cover these types of modifications.
3. If you need to modify the Aspen Plus system source code, first copy the
original routine and then modify the copy. Document your changes with
appropriate comments.
4. Before you modify an Aspen Plus unit operation model, cost block, utility, or
physical property model, make a copy and give the copy a different name.
Modify the copy. This allows you to isolate any problems the new model might
have.
System Management
Version 11.1
3-3
Maintaining
and Updating
Aspen Plus
5. You should not need to modify the Aspen Plus system databanks. Use the
in-house databank feature for large amounts of user data. This avoids the
databank reconciliation problems associated with new releases.
6. The Aspen Plus installation creates the folder
c:\Program Files\AspenTech\Aspen Plus 11.1\Engine\inhouse
for storing in-house modifications, but you may store them elsewhere.
Windows
3-4
Operating System
The parameter dbg is optional. Use it if you plan to debug these routines.
System Management
Version 11.1
Chapter 3
Note
4. Run an input file that requires the user routine(s). For example, if the input
file is gmutest.inp and the RunID is test, type:
aspen gmutest test
System Management
Version 11.1
3-5
Maintaining
and Updating
Aspen Plus
You cannot set a breakpoint on the user routine until it has been loaded
dynamically into a process. First set a breakpoint on IT_USRDBG, the final
routine executed during input translation, then set a breakpoint in your user
routine.
5. Set the Program arguments to the Run ID for your simulation. Type:
TEST
6. Select OK.
7. From the Edit menu, select Breakpoints (Alt+F9).
8. In the Location tab in the Break at: text box, specify IT_USRDBG.
9. From the Build menu, select Start Debug, then Go.
10. In the dialog box indicating that apmain.exe does not contain debugging
information, click OK to continue.
11. Click Cancel to any requests for sources of routines beginning with IT_.
12. When IT_USRDBG is reached, set breakpoints in your user routines by
opening the Fortran file(s) containing your user routine(s). Select Open from
the File menu, navigate to your working directory, then select filename.f. Set
breakpoints (F9) in your user routine and then Go (F5).
Note
See the Microsoft Developer Studio online help for more information on using the
debugger.
3-6
System Management
Version 11.1
Chapter 3
Module Requirements
All Fortran routines listed below must be present when rebuilding the respective
module, where ppuser, zeinit, zemhtxu, and zeusermod are the modules and the
.f files are the Fortran files required by the respective modules.
Note
Table 3.1
The modules ppuser, zeinit, and zeusermod are part of the Aspen
Physical Property System. Files for these modules are installed
with the APrSystem, by default in the directory
C:\Program Files\AspenTech\APrSystem 11.1\Engine\custom.
Module zemhtxu is used only by Aspen Plus and its files are in
C:\Program Files\AspenTech\Aspen Plus 11.1\Engine\custom.
Module Routines
Module
Routines
ppuser
zeinit
getprp.f, iappdb.f
zemhtxu
zeusermod
adcstu.f, adefnu.f, asradu.f, asrptu.f, blrusr.f, cstusr.f, eevalu.f, exmonu.f, fisymu.f, fpuser.f,
getadu.f, iapusr.f, imhtxu.f, insimu.f, itsizu.f, itsubu.f, mhtcku.f, mhtwku.f, mmsrpu.f, mmsusr.f,
npldsu.f, pdatfu.f, ppchku.f, rptusr.f, savusr.f, sempru.f, srpctu.f, sumusr.f, uvalab.f
This example illustrates rebuilding the ppuser module on Windows 95, 98 and
NT systems. For rebuilding modules other than ppuser, substitute the
appropriate module name. Follow these steps:
System Management
Version 11.1
3-7
Maintaining
and Updating
Aspen Plus
1. Open the Aspen Plus Simulation Engine window from the Aspen Plus
program group.
2. Use the Aspcomp command to compile your Fortran routines:
To compile
Type this
Fortran files for your module in the Engine\Custom directory of Aspen Plus or the
APrSystem, including your modifications and additions
3. Type the following command to create the shared library with Asplink:
asplink ppuser
Save the original .LIB and .DLL files before over-writing them
with the customized libraries.
4. Copy the rebuilt .LIB file into the Aspen Plus or APrSystem import library
directory (Engine\lib). Next, copy the rebuilt .DLL file into the Aspen Plus or
APrSystem Simulation Engine system directory (Engine\xeq).
3-8
System Management
Version 11.1
Chapter 3
See
Unit Operation
Chapter 5
2. Create your own custom version of the SDF. See Running the Aspen Plus
Table Building System, this chapter. Place this SDF file in your local
directory instead of in the system directory while you test your
customizations.
System Management
Version 11.1
3-9
Maintaining
and Updating
Aspen Plus
sdfname
outname
Where:
sdfname
Name of the SDF used for the report (the default is system
SDF).
outname
2. Enter the name of the table for which you want to generate a report.
SDFRPT tries to match this name with the list of SDF tables shown at the
end of this chapter and asks you to select a table.
For example, entering PRS for the table name generates the following list:
1.
2.
3.
4.
5.
PRS
PRS
PRS
PRS
PRS
PIPE TABLE
TRANSFLO VALVE TABLE
EMERGENCY RELIEF VENT TABLE
RUPTURE DISK TABLE
SAFETY RELIEF VALVE TABLE
SDFRPT performs partial matching if you enter a question mark (?) before
the name. For example, entering ?DATA for the table name generates the
following list:
1.
2.
3.
4.
3-10
System Management
Version 11.1
Chapter 3
If you entered UOSM first, give the name of a UOS model next. If you entered
PKW, give the name of the PKW you want. If the name is misspelled, the
following message appears:
Cannot find the UOS model name: xxxxxx
Do you wish to try again? (y/n)
If you answer
Then
Yes
No
SDFRPT generates a report file using the name you supplied. This report is
divided into two sections:
Table of contents
Formatted SDF tables
System Management
Version 11.1
3-11
Maintaining
and Updating
Aspen Plus
The following list contains the valid top level tables for SDFRPT:
Standard Option Sets
Component Attribute Type Definitions
Encoded Major Property Routes
Conventional Property Model Defs
Labeled Common Definitions
Physical Property Subroutine List
Major Property Map
Default Monitor CGT Indices
PKW
Cost Block
Substream Type Table
Stream Attr Type Table
Built-in Substream ID Table
Built-in Substream Attribute Table
The Constants Table
Non-conven Top-level Tkw Tables
Variable Type Table
Econ Eval SKW Index
Distillation Curve Types
PC Properties
Property Package Properties
Property Groups
Group Binary Parameter Table
Pitzer Model Data
Equation of State Binary Parameter Table
Electrolyte NRTL Model Data
PCES Property Definition Table
Old Group Liquid Binary Parameter Table
Periodic Table
PP User Subroutine List
PRS Transflo Valve Table
PRS Rupture Disk Table
3-12
System Management
Version 11.1
Chapter 3
Directory
Windows
If you installed Aspen Plus on a different disk drive or directory, use the appropriate path.
The SDF is a structured file with individual entries called tables. There are three
types of tables:
Primary Keyword Tables (PKW)
Secondary Keyword Tables (SKW)
Tertiary Keyword Tables (TKW)
Each table has:
SKW tables linked to a specific PKW table
TKW tables linked to a specific SKW table
Use TBS to add, delete, or replace entries within the top-level tables. When
modifying the PKW table (or any top-level table that has SKWs) you must
replace or delete the entire TBS source data file. You cannot replace data for an
individual SKW or TKW. To change data for an SKW, you must replace the
entire entry for the PKW that defines the SKW. The format of some of the tables
has changed since Version 9.x. For more details, see Converting Version 9.x TBS
Input Files, this chapter.
For example, suppose you want to change the default for the maximum number
of iterations (MAXIT) from 30 to 50 in a FLASH2 unit operation model (UOS)
block. Run TBS on the entire FLASH2 PKW table (FLASH2.UOS data file) that
contains the change for the MAXIT TKW.
This section describes how to modify existing tables. If you want to create a new
TBS table, contact the AspenTech Hotline. Creating a new top-level table, such
as a new unit operation block, is fairly complex. TBS input data has a fixed
format, which requires each character or number to be in a particular column. In
addition, there are many rules for writing a table.
System Management
Version 11.1
3-13
Maintaining
and Updating
Aspen Plus
Windows
All source data use one of eight file types. The TBS source data files consist of
PKW, SKW, and TKW tables.
For example, a TBS data file, STREAM.PKW, is used to define the stream
paragraph in an Aspen Plus input file. STREAM.PKW contains PKW, SKW, and
TKW tables. For this example:
The PKW is called STREAM.
Two of the SKWs are SUBSTREAM and MOLE-FLOW.
Two of the TKWs are COMPONENT and FLOW.
This allows Aspen Plus to recognize the following entry in an Aspen Plus input
file:
STREAM FEED
MOLE-FLOW COMPONENT=WATER FLOW=100
Aspen Plus processes each keyword and tries to find the PKW table STREAM in
the SDF. Then Aspen Plus looks for the
SKW table MOLE-FLOW
TKW table COMPONENT and FLOW
3-14
System Management
Version 11.1
Chapter 3
File Types
The file type indicates the type of data in the file, as described in the table below:
Table 3.2
File Types
File Type
.cst
Cost block
.lcd
.pkw
Primary keyword
.sto
.uos
.utl
Utility model
.rxn
Reaction model
.dat
All file types except .dat contain the minimum amount of TBS input needed to
define a single top-level table entry. These files contain the following line:
tabname
REPLACE
entrynam
Where:
tabname
entrynam
This line also denotes the beginning of a table entry. Therefore, if you want to
change a single number in any top-level table entry, you must use the entire file
as input to TBS.
The .dat files contain all the data needed to define an entire top-level table.
Typically, these files contain many REPLACE lines, each followed by the data for
its table entry.
Updating SDFs
You must update the system SDF if one of these conditions exists:
Site-specific unit operation, physical property, convergence, and other models
exist
An update is needed to fix a problem
System Management
Version 11.1
3-15
Maintaining
and Updating
Aspen Plus
The files for creating the SDF are in the following directory. The header files
define the platform and initialize the SDF. The end files close the SDF.
Operating System
Data Files
Windows
If you installed Aspen Plus on a different drive or directory, use the appropriate path.
The type of header information in the input file depends on whether a new SDF
will be created or an existing SDF will be modified. The best way to create a new
SDF is by using the makesdf procedure to bring all the correct files together.
The TBS table input data is specific for the type of table. This data always begins
with the following line:
tabname
REPLACE
entrynam
DELETE
entrynam
or
tabname
Where:
tabname
entryname
3-16
System Management
Version 11.1
Chapter 3
The first 0 occurs at the 8th column and the second occurs at the 11th column.
The following TBS files need to have a VIRT statement:
All uos files (*.uos)
All cost blocks (*.cst)
All utility blocks (*.utl)
Convergence (cnvrgnce.dat)
The following example shows the use of the VIRT statement unit operation
(UOS) model name XYZZ.
XYZZ
1
-999
-999
+
+
20
20
41
1
0
0
0
0
20
1
1
145
146
SUBROUTINE
SUBR
MODEL
MODL
1
1
1
1
3
MISSING
System Management
Version 11.1
3-17
Maintaining
and Updating
Aspen Plus
3-18
System Management
Version 11.1
Chapter 4
Configuring Physical
Property Databanks
This chapter explains how to add user or in-house databanks to Aspen Plus and
how to customize the user interface to reflect those changes. It includes the
following topics:
Adding User and In-House Databanks
Adding Binary or Pair Parameter Databanks
Adding Ionic Reactions to the Electrolyte Reaction Database
Once you add the databanks to the user interface, you will be able to:
Select the new databanks and their search order on the Components
Specifications Databanks sheet
Display the components on the Components Specifications Selection sheet or
in the Find Component dialog box
System Management
Version 11.1
4-1
Configuring
Physical
Property
Databanks
Windows
set XDATA=db_working_directory
Where db_working_directory is the complete directory specification for the system or in-house databank.
Where:
input_file
output_file
Name you give the DFMS output file that contains the
requested reports and a trace of DFMS operations
The databanks created by DFMS are named dbname.dat, where dbname is the
databank name given in Table 1.1 of Aspen Plus Physical Property Data.
In-house databanks reside in the Aspen Plus system directory or in the directory
location specified by the environment variable XDATA. User databanks reside in
the current directory. When referencing previously built user databanks in
DFMS, make sure they are in the current directory.
4-2
System Management
Version 11.1
Chapter 4
After you have tested the user databanks, you can move them into the
Aspen Plus system directory, or leave them in your working directory. If you
move the user databanks into the Aspen Plus system directory and the databank
file names are different from the system default names, you must modify the
Aspfiles.def file, also located in the system directory, to reflect the new databank
name. Edit the Aspfiles.def and add the dbname using the appropriate entry as a
template for each databank type listed. See Run Definition Files, Chapter 2, for
more information on aspfiles.def file.
After creating your databank in Aspen Plus, define the databank location and
component list by creating a user interface databank input file.
The DFMS command creates the usrpp1a.dat databank in the current directory.
System Management
Version 11.1
4-3
Configuring
Physical
Property
Databanks
This directory contains all the files referred to in the customization procedures.
You must create a user interface databank input file. The input file defines the
databank location and lists the aliases and long names for the components in
your databank. Name the file databankname.dat. This file name will be added to
the MMTBS driver file in the next section.
The file format is:
/*
/* Enclose your comments in slash-asterisk like this
/*
DBANK
ADD
mmdbname
dbtype
password
filename
alias-1
longname-1 charge-1
molwt-1
bp-1
vlstd-1
cas-1
class-1
alias-2
longname-2 charge-2
molwt-2
bp-2
vlstd-2
cas-2
class-2
. . .
*/
*/
*/
Where:
mmdbname
dbtype
password
filename
alias
4-4
for filename.
System Management
Version 11.1
Chapter 4
System Management
Version 11.1
long-name
charge
molwt
bp
vlstd
cas
class
4-5
Configuring
Physical
Property
Databanks
You cannot create your own component class. Use one of the following classes
that are currently used by the built-in system databanks.
1-Alkenes
2,3,4-Alkenes
Acetates
Aldehydes
Aliphatic-ethers
Alkylcyclohexanes
Alkylcyclopentanes
Alkynes
Anhydrides
Aromatic-alcohols
Aromatic-amines
Aromatic-carboxylic-acids
Aromatic-chlorides
Aromatic-esters
C,H,Br-compounds
C,H,F-compounds
C,H,I-compounds
C,H,NO2-compounds
C,H,multihalogen-compounds
C1/C2-aliphatic-chlorides
C3/higher-aliphatic-chlorides
Cycloaliphatic-alcohols
Cycloalkanes
Cycloalkenes
Dialkenes
Dicarboxylic-acids
Dimethylalkanes
Diphenyl/polyaromatics
Elements
Epoxides
Ethyl/higher-alkenes
Formates
Inorganic-acids
Inorganic-bases
Inorganic-gases
Inorganic-halides
Isocyanates/diisocyanates
Ketones
Mercaptans
Methylalkanes
Methylalkenes
Multiring-cycloalkanes
Naphthalenes
Nitriles
Nitroamines
n-Alcohols
n-Aliphatic-acids
n-Aliphatic-primary-amines
n-Alkanes
n-Alkylbenzenes
Organic-salts
Organic/inorganic-compounds
Other-aliphatic-acids
Other-aliphatic-alcohols
Other-aliphatic-amines
Other-alkanes
Other-alkylbenzenes
Other-amines/imines
Other-condensed-rings
Other-ethers/diethers
Other-hydrocarbon-rings
Other-inorganic-salts
Other-inorganics
Other-monoaromatics
Other-polyfunctional-C,H,O
Other-polyfunctional-organics
Other-saturated-aliphatic-esters
Peroxides
Polyfunctional-C,H,N,halide,(O)
Polyfunctional-C,H,O,N
Polyfunctional-C,H,O,halide
Polyfunctional-C,H,O,S
Polyfunctional-acids
Polyfunctional-amides/amines
Polyfunctional-esters
Polyfunctional-nitriles
Polyols
Propionates-and-butyrates
Silanes/siloxanes
Sodium-salts
Sulfides/thiophenes
Terpenes
Unsaturated-aliphatic-esters
If you use a Fortran program to create this databank input file, you must remove
the Fortran carriage control attribute.
4-6
System Management
Version 11.1
Chapter 4
polymer.dat
segment.dat
pure11.dat
pure10.dat
pure93.dat
pure856.dat
ethylene.dat
aqueous.dat
aqu92.dat
inorgani.dat
aspenpcd.dat
solids.dat
combust.dat
You can place your INCLUDE databankname.dat line anywhere within this
group of lines. These INCLUDE lines must stay together in the tbprop.dat file.
System Management
Version 11.1
4-7
Configuring
Physical
Property
Databanks
4-8
K123\USRPP1A.DAT
0
0
0
0
. . .
System Management
Version 11.1
Chapter 4
2. In Tbprop.dat, an MMTBS driver file, add the INCLUDE K123.DAT line after
the PURE93 databank:
INCLUDE
INCLUDE
INCLUDE
INCLUDE
INCLUDE
INCLUDE
INCLUDE
INCLUDE
INCLUDE
INCLUDE
INCLUDE
INCLUDE
INCLUDE
INCLUDE
polymer.dat
segment.dat
pure11.dat
pure10.dat
pure93.dat
k123.dat
pure856.dat
ethylene.dat
aqueous.dat
aqu92.dat
inorgani.dat
aspenpcd.dat
solids.dat
combust.dat
3. Add desired Help files on your databank following the procedure described in
Adding Help for a User or In-House Databank, this chapter.
4. Enter the following command to add the databank:
mmcustom mmtbs
5. To verify that the databank is correctly installed, launch Aspen Plus and open
the file custom.bkp located in your customization directory.
This starts the user interface locally to use the modified RecDef file.
Otherwise, the unmodified system copy of the RecDef file is used.
6. Go to the Components Specifications Databanks sheet and move K123 to the
list of selected databanks. Click the Components Find button on the
Components Specifications Selection sheet. Confirm that a search for
"BROMIDE" will instruct Aspen Plus to find the three "bromide" components,
after selecting K123 as your only choice in the Components Specifications
Databanks sheet.
7. Install the modified files in the system directory. At the system prompt enter:
custinst
System Management
Version 11.1
4-9
Configuring
Physical
Property
Databanks
4-10
System Management
Version 11.1
Chapter 4
File Format
The format for the binary and pair parameter input file is:
/*
*/
/* All input starts in column 1
*/
/* Enclose your comments in slash-asterisk like this sentence
*/
/* Do not put comment lines in the middle of a DBANK REPLACE section */
/* Column numbers for data entry are unimportant as long as
*/
/* there is at least 1 blank between entries
*/
/*
*/
/* Do not exceed 80 columns
*/
/*
*/
/* All parameter values must be in SI units
*/
/*
*/
DBANK REPLACE GAMKIJ
paramtype
n_sections
n_params
paramname
sym_1
sym_2 . . .
n_labellines
n_labels
label1
label2
. . .
. . .
. . .
n_labels
label1
label2
. . .
n_modellines
eosmodel
gammamodel
databankname
n_comp_pairs
comp-i
comp-j
data1
data2
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
comp-i
comp-j
data1
data2
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
Table 4.1 describes parameters for the Binary Pair Parameter Input file.
System Management
Version 11.1
4-11
Configuring
Physical
Property
Databanks
Table 4.1
Description
paramtype
n_sections
Number of parameter sections to follow. See Number of Parameter Sections, this chapter.
n_params
Number of parameters listed in the row. See Number of Parameters Listed inRow, this chapter.
paramname
sym_1
Symmetry code of the first element of a vector parameter, or the symmetry code
of the only element of a scalar parameter (for scalar parameter, sym _1 = 2)
0 = Asymmetric parameter (ij ji).
1 = Asymmetric parameter. Specify ij only. Examples are HENRY and VLCLK.
2 = Symmetric parameter. Specify either ij or ji parameter.
3 = Anti-symmetric parameter ij = ji. Requires only one parameter.
sym_2
sym_n
Symmetry code of the nth element of the vector. See Symmetry Codes for a Vector's nth
Element, this chapter.
n_labellines
n_labels
Number of labels on each row. See Labels on Each Row, this chapter.
label1, label2
Labels for each row. See Labels on Each Row, this chapter.
n_modellines
eosmodel
For equation-of-state binary parameters, eosmodel is the equation-of-state model to which the
parameters apply. For activity coefficient binary parameters, eosmodel is the equationofstate
model for the vapor phase to which this parameter applies. Enter ALL if the parameter applies to
all equation-of-state models. Some common models are ESRK (RedlichKwong), ESHOC
(HaydenO'Connell),and ESIG (Ideal gas).
gammamodel
Activity coefficient model for the liquid phase to which this parameter applies. Enter ALL if the
parameter applies to all activity coefficient models or if the parameter is for an equationofstate
model. Some common models are GMWILSON, GMRENON, and GMUQUAC.
databankname
Name you give the databank, for example, MYDATABANK. This name appears in the Databanks
sheet on the Parameters Binary Interaction and Parameters Electrolyte Pair forms.
n_comp_pairs
Number of component pairs for which parameters are available. Enter a space and a zero (0)
after the number of component pairs.
compi, compj
data1
Parameter 1 for the component pair. Enter two parameters per element for asymmetric
parameters (symmetry code = 0). Enter one parameter per element for all other symmetry
codes.
data2
4-12
Parameter labels determine how you must enter the parameter values. The number of parameter values entered in a row
must be exactly the same as the number of parameter labels defined for the corresponding row.
System Management
Version 11.1
Chapter 4
List only one parameter (n_params = 1) when you specify a vector or multiple
element parameters like NRTL.
Asymmetric parameter (ij ji). You must enter values for ij and ji
separately. For example, for element 1 of NRTL you must enter both aij and
aji.
1=
2=
3=
For example, NRTL has eight elements. Elements 1, 2, 5, and 6 are asymmetric,
while the rest are symmetric:
DBANK REPLACE GAMKIJ
1
1
1 NRTL 0 0 2 2 0
System Management
Version 11.1
4-13
Configuring
Physical
Property
Databanks
aij
cij
fij
aji
dij
fji
bij
eij
Tlower
bji
eji
Tupper
Since only one label needs to be defined for symmetric parameters, only enter cij ,
not cji.
The parameter labels determine how you must enter the parameter values. The
number of parameter values you enter in a row must be exactly the same as the
number of parameter labels defined for the corresponding row.
Component Aliases
You can use the comp-i and comp-j variables to indicate component aliases for
components i and j.
For pair parameters, use a $ between the aliases of two ionic species that form
the electrolyte. For example, for GMELCC pair parameters of H2O and (H+ and
HCO3) enter:
1 GMELCC 0
1
2
cij
cji
1
ESRK GMENRTL ENRTL-RK
302
H2O
H+$HCO38.045000
...
-4.072000
4-14
System Management
Version 11.1
Chapter 4
System Management
Version 11.1
-838.3509
0.0
-206.5626
0.0
4-15
Configuring
Physical
Property
Databanks
Scalar Parameters
Use the following template for scalar parameters, such as the Hayden-O'Connell
binary parameter, HOCETA:
DBANK REPLACE GAMKIJ
1
1
1 HOCETA 2
1
1 aij
1
ESHOC ALL EOS-LIT
1
C2H4O2 C2H4O2 4.5
*/
*/
*/
Running MMTBS
After creating your databank file and modifying the MMTBS driver file, you need
to run MMTBS to update the user interface to reflect your changes. To run
MMTBS, use the following command:
mmcustom mmtbs
For a detailed description of the user interface customization files and their
locations, see Appendix A.
4-16
System Management
Version 11.1
Chapter 4
System Management
Version 11.1
4-17
Configuring
Physical
Property
Databanks
Table 4.2
4-18
Description
rxn_name
Reaction name
rxn_type
Reaction type:
DISS = Complete dissociation
STOIC = Partial dissociation, equilibrium reaction
SALT = Salt precipitation reaction
n_comps
comp_alias
Component alias
coeff
Stoichiometric coefficient:
> 0 = Products of the reaction
< 0 = Reactants of the reaction
salt-flag
K-stoic
K-salt
comp_scale
System Management
Version 11.1
Chapter 4
-1
-1
1
1
-12995.4 -33.5471
1
0
0
System Management
Version 11.1
*/
*/
*/
4-19
Configuring
Physical
Property
Databanks
To test your customization, launch the Aspen Plus User Interface and open the
file custom.bkp located in the custom directory. This starts the interface locally.
If you do not start the user interface using this command, Aspen Plus uses the
unmodified system copy of the RecDef file. Verify that the reactions you added
can be selected in the Reactions Chemistry forms, or in the Electrolyte Wizard.
Enter this command at the DOS prompt to install the changes made to the user
interface system directory:
custinst
4-20
System Management
Version 11.1
Chapter 5
Configuring Physical
Property Methods
This chapter describes how to customize the Aspen Plus physical property
system. These customizations apply to all Aspen Plus and Properties Plus runs.
This chapter includes the following topics:
Overview
Customizing the Aspen Plus Simulation Engine
Customizing the Aspen Plus User Interface
Creating In-House Physical Property Models, Routes, and Methods
System Management
Version 11.1
5-1
Configuring
Physical
Property
Methods
Overview
The major steps for customizing the physical property methods are:
1. Modify or create Aspen Plus simulation engine customization files.
2. Run the Aspen Plus Table Building System (TBS) to update the simulation
engine with your changes.
3. Test your changes in the simulation engine using input language.
4. Use essentially the same customization files from the Aspen Plus simulation
engine to customize the user interface. Run the Aspen Plus user interface
Table Building System (MMTBS) to update the user interface Record
Definition (RecDef) files.
5. Modify or create Help files to add Help and prompts for your changes.
6. Run the Aspen Plus user interface Hypertext Management (HTM) system to
update the binary Help file, mmg.hms, with the new information.
7. Test your changes in the Aspen Plus user interface.
8. Copy the modified files to the system directory for general use.
5-2
System Management
Version 11.1
Chapter 5
3. Run the Table Building System (TBS) to modify the System Definition File
(SDF).
4. Install the SDF file in Aspen Plus.
The following sections describe these steps.
Windows
Table 5.1
If you install the Aspen Plus simulation engine on a different disk drive or directory, enter the appropriate drive name and
directory location.
Description
*.lcd
ppcnvpmd.dat
ppenmprt.dat
ppensprt.dat
ppsublst.dat
*.sto
System Management
Version 11.1
Command
Property methods
Each property parameter definition is stored as a separate file with the .lcd file type.
Each property method is stored as a separate file with the .sto file type.
5-3
Configuring
Physical
Property
Methods
The files listed in Table 5.1 are located in the Aspen Physical Property System
TBS directory:
Operating System
Windows
Directory
C:\Program Files\AspenTech\APrSystem 11.1\Engine\tbs
If you install Aspen Plus on a different disk drive or directory, enter the appropriate drive name and
directory location.
These files are delivered in compressed format. You must extract them by using
the following command:
Operating System
Command
Windows
extr_tbs
Where filename.lis is the file containing the list of all TBS customization files.
The maketbs command creates the tbsupd.dat file. This file lets you run TBS
to update the SDF.
4. If you want to combine all the TBS files in your local directory into one file
without creating the list file, use this command:
maketbs all
5-4
System Management
Version 11.1
Chapter 5
Windows
Command
COPY "C:\Program Files\AspenTech\Aspen Plus 11.1\Engine\XEQ\SDFFIL.SDF"
SDFNEW.SDF
If you install Aspen Plus on a different disk drive or directory, enter the appropriate drive name and directory location.
2. Run the TBS using the TBS update file, tbsupd.dat, created in the previous
section:
tbs tbsupd.dat
Windows
Command
COPY SDFNEW.SDF
"C:\Program Files\AspenTech\Aspen Plus 11.1\Engine\XEQ\SDFFIL.SDF"
You must remove write protection from the system SDF before copying the new file.
If you install Aspen Plus on a different disk drive or directory, enter the appropriate drive name and directory location.
You can then delete the SDF file from the customization directory.
Important
System Management
Version 11.1
5-5
Configuring
Physical
Property
Methods
5-6
System Management
Version 11.1
Chapter 5
System Management
Version 11.1
5-7
Configuring
Physical
Property
Methods
5. Define each new subroutine in the Physical Property Subroutine List Table.
See Appendix B, Figure B.3 for their locations. Next, you must modify the
following:
System Fortran routine
To call the
Filename
ppuser_phcciu
Initialization subroutine
phcciu.f
ppuser_esmnu, ppuser_esmnu0
esmnu.f, esmnu0.f
ppuser_mdmon9
mdmon9.f
9. Copy the Aspen Plus System Definition File (SDF) to your customization
directory. See Running the Aspen Plus Table Building System, this chapter.
10. Run TBS to update the SDF using the tbsupd.dat file:
tbs tbsupd.dat
The Lee-Kesler model to calculate mixture enthalpy, entropy, and Gibbs energy
An in-house model, VLMOD, to calculate liquid mixture molar volume
The VLMOD model is coded in a Fortran subroutine called VL900. You must create:
5-8
System Management
Version 11.1
Chapter 5
HVMX24
HVMX13
HLMX106
HLMX13
GVMX30
GVMX13
GLMX106
GLMX13
SVMX24
SVMX13
SLMX98
SLMX13
VLMX20
VLNEW
PHILMX
GVMX
SLMX
MUVMX
KLMX
SIGLMX
HV
GL
VV
DV
KV
PHIS
PHILMX104
GVMX13
SLMX13
MUVMX02
KLMX01
SIGLMX02
HV09
GL11
VV07
DV02
KV01
PHIS06
HVMX
GLMX
VVMX
MULMX
DVMX
PHIV
HL
SV
VL
MUL
KL
HVMX13
GLMX13
VVMX24
MULMX03
DVMX02
PHIV09
HL12
SV09
VL01
MUL01
KL01
2. In the ppenmprt.dat file define the new route, VLNEW, that uses the new model VLMOD.
Add this change to the end of the ppenmprt.dat file:
PPENMPRT REPLACE
VLNEW
VLMX
1
1
VLMX
VLMOD
0
0
0
0
900
You do not need to modify the ppensprt.dat file, because the new property method does
not require a new subordinate property route.
3. In the ppcnvpmd.dat file, define the new model VLMOD. This model references the
Fortran subroutine VL900 and the property parameter VLLC. This model does not use
work area, model option codes, or an initialization subroutine. (From Figure B.1, n1 = 0,
n2 = 0, iwaq = iwal = iwac = 0, rwaq = rwal = rwac = 0.)
Add the following table to the end of the ppcnvpmd.dat file:
System Management
Version 11.1
5-9
Configuring
Physical
Property
Methods
PPCNVPMD REPLACE
VLMOD
VLMX
900
0111 00001
0
0
0
1
VL900
1
VLLC
00001
Also save the table in another file, vlmod.dat, which will be used in the Aspen Plus user
interface customization.
The new subroutine VL900 is defined in step 4. The new property parameter VLLC is
defined in step 5.
4. In the ppsublst.dat file, define the new subroutine VL900. Add the following line to the end
of the ppsublst.dat file:
PPSUBLST REPLACE VL900
You must also modify the system routine ppuser_mdmon9 to call the new routine vl900 as
described in Appendix B, Modifying Aspen Plus System Routines. Compile both vl900.f
and mdmon9.f in the customization directory.
5. In a new vllc.lcd file, define the new property parameter VLLC. This is a unary scalar
parameter with parameter index number = 900. It defaults to missing (1D35) and can be
regressed. The units for this parameter are SI. Units conversion is not allowed (the
conversion code of 44 for dimensionless units is used).
PPLCDEFS REPLACE
User
1
1
1D35
1
44
1
44
VLLC
Molar Volume
1
0
900
1
6. Prepare these TBS files for running TBS by creating the TBS update file. In a new file
called pr-lk.lis, list all the TBS files:
pr-lk.sto
ppenmprt.dat
ppcnvpmd.dat
ppsublst.dat
vllc.lcd
5-10
System Management
Version 11.1
Chapter 5
Use the following command to run the MMTBS to update the RecDef files.
mmcustom mmtbs
Note
System Management
Version 11.1
You must have write access to the user interface system directory
to run custinst.
5-11
Configuring
Physical
Property
Methods
5-12
System Management
Version 11.1
Chapter 5
ppstoptn.dat
lcd_cust.dat
mdl_cust.dat
ppenmprt.dat
Since no new files are created, the driver tbcustom.dat does not need to be updated.
Copy the above files to the customization directory for the Aspen Plus user interface, as
follows:
C:\Program Files\AspenTech\APrSystem 11.1\GUI\Custom
To add the property methods and Help information to the user interface, follow these steps:
1. Run MMTBS to update the user interface RecDef files using the TBS input files you
created:
mmcustom mmtbs
2. Create a new file, pr_lk.hxt, to store all your Help and prompts. To add the user interface
Help and prompts for the new property method PR-LK, add the following to the pr_lk.hxt
file:
>p_replace P_PPSTOPTN_PR-LK
Peng-Robinson with Lee-Kesler for enthalpy and in-house model
for liquid molar volume. Help for description
>endmessage
>h_replace H_PPSTOPTN_PR-LK
custom.hlp #1
>endmessage
The file custom.hlp is created following the procedure described in Appendix A for the
creation of Windows Help. Figure 5.1 shows the contents of the custom.rtf file that may be
used to create the Windows Help.
For more information on Windows Help, see Creating Help and Prompts, Appendix A.
3. Add a prompt for the new major property route VLNEW to the pr_lk.hxt file.
>p_replace P_PPENMPRT_VLMX_VLNEW
Liquid mixture molar volume calculated using in-house VLMOD model
>endmessage
4. Add a prompt for the new property model VLMOD to the pr_lk.hxt file.
>p_replace P_PPCNVPMD_VLMX_VLMOD
In-house model for liquid mixture molar volume
>endmessage
5. Add the prompt for the new liquid molar volume parameter VLLC to the pr_lk.hxt file:
>p_replace P_PPLCDEFS_VLLC
Parameter for the in-house model for liquid mixture molar volume, VLMOD
>endmessage
System Management
Version 11.1
5-13
Configuring
Physical
Property
Methods
6. Modify the Help driver file, tbcustom.hxt, to list your Help file, pr_lk.hxt. Use this command
to update the user interface binary Help file:
mmcustom htm
7. To confirm your customization, start the user interface. Go to the Properties Specifications
Global sheet and get the list on the Property Method list box. Confirm that PR_LK appears
on the list.
8. On the Properties Property Methods Routes sheet, confirm that route HVMX13 calculates
the property HVMX, route HLMX13 calculates the property HLMX, and so on.
9. Examine the new prompts associated with these entries.
10. On the Property Methods Models sheet, confirm that Aspen Plus calculates the property
VLMX, using the model VLMOD.
11. On the Parameters Pure Component Scalar form, use List on the Parameters field.
Confirm that the parameter VLLC appears in the list.
12. Install the RecDef and Help files into the user interface system directory by using the
command:
custinst
The new property method with customized routes and models are now installed for in-house
use.
5-14
System Management
Version 11.1
Chapter 5
Figure 5.1
Change
Uses Lee-Kesler Enthalpy Model.
Uses Lee-Kesler Entropy Model.
System Management
Version 11.1
5-15
Configuring
Physical
Property
Methods
5-16
System Management
Version 11.1
Chapter 6
Configuring Pressure
Relief, Pipe, and Valve
Equipment Data
This chapter contains the following topics:
Overview
Liquid Service Safety Relief Valves
Gas/2-Phase Service Safety Relief Valves
Rupture Disks
Pipes for Pressure Relief and the Pipe Model
Emergency Relief Vents
Inlet and Tail Pipe Vents
Valves for the Valve Model
Overview
Pres-Relief (the Aspen Plus pressure relief calculation system) and the Valve and
Pipe unit operation models uses table that define pipes, valves, emergency relief
vents, and rupture disks. You can customize these tables by changing the
appropriate data files (located in the user interface CUSTOM directory) and
processing them using the Aspen Plus User Interface Table Building System
(MMTBS).
For more information about running MMTBS and applying your changes, see
Chapter 4.
System Management
Version 11.1
6-1
Configuring
Pressure
Relief, Pipe,
and Valve
Equipment
Data
This file
liqtable.dat
gastable.dat
rupture.dat
Rupture disks
pipe.dat
Pipes used in the pressure relief system and the Pipe unit operation model
ervtable.dat
transflo.dat
valve.dat
6-2
System Management
Version 11.1
Chapter 6
The over-pressure factor defaults to 1.1. To customize the table, modify the
liqtable.dat file. Figure 6.1 shows the file organization.
Note
Figure 6.1
Where:
no_types
name_typei =
no_manuf
=
no_series
Number of manufacturers
Name of jth manufacturer. Repeat this section for each
manufacturer.
Number of series from the jth manufacturer
seriesk
no_size
sizem
t_diamm
i_diamm
o_diamm
cdm
opfm
name_manufj =
System Management
Version 11.1
Number of types
Name of ith type. Repeat this section for each type.
6-3
Configuring
Pressure
Relief, Pipe,
and Valve
Equipment
Data
Figure 6.2
liqtable.dat File
Keywords and Data
PRSRV REPLACE LIQUID
Comments
Liquid service table
CONV
CROSBY
JLT
1_2_0.398_(D)
1_2_0.531_(E)
DRESSER
1900
1_2_0.4036_(D)
1_2_0.5387_(E)
1.5_2_0.674_(F)
0.674
1.61
1.5_2.5_0.863_(G)0.863
1.61
6-4
Where:
size = Valve size
t_diam = Throat diameter in inches
i_diam = Inlet diameter in inches
o_diam = Outlet diameter in inches
cd = Discharge coefficient
opf = Over-pressure factor
System Management
Version 11.1
Chapter 6
System Management
Version 11.1
6-5
Configuring
Pressure
Relief, Pipe,
and Valve
Equipment
Data
To customize the table, modify the gastable.dat file. Figure 6.3 shows the
organization of the file. The indentation is for reading clarity only.
Figure 6.3
Where:
no_types
6-6
=
name_typei =
no_manuf
=
Number of types
name_manufj =
no_series
seriesk
no_size
sizem
t_diamm
i_diamm
o_diamm
cdm
Discharge coefficient
System Management
Version 11.1
Chapter 6
Figure 6.4
gastable.dat File
Keywords and Data
PRSRV REPLACE GAS/2-PHASE
Comments
Gas or 2-phase service table.
CONV
CROSBY
JOS
1_2_0.398_(D)
1_2_0.531_(E)
2.067 0.961
DRESSER
1900
1_2_0.4306_(D)
1_2_0.5387_(E)
1.5_2_0.674_(F)
0.674
1.61
2.067 0.950
1.5_2.5_0.863_(G) 0.863
1.61
2.469 0.950
System Management
Version 11.1
Where:
size = Valve size
t_diam = Throat diameter in inches
i_diam = Inlet diameter in inches
o_diam = Outlet diameter in inches
cd = Discharge coefficient
6-7
Configuring
Pressure
Relief, Pipe,
and Valve
Equipment
Data
Figure 6.5
act_diamj
act_diamj+1
cdj
cdj+1
Where:
manuf
Manufacturer type
no_style
Number of styles
name_stylei =
6-8
manuf
no_sizes
nom_diamj
act_diamj
cdj
System Management
Version 11.1
Chapter 6
Figure 6.6
rupture.dat File
Keywords and Data
PRRUP
REPLACE
Comments
ZOOK
MONO
.5-IN
.5
.888
nom_diam act_diam cd
.75-IN
.75
.888
nom_diam act_diam cd
1-IN
1.
.888
nom_diam act_diam cd
INVERTED
.5-IN
.5
.779
nom_diam act_diam cd
.75-IN
.75
.779
nom_diam act_diam cd
PRRUP
REPLACE
FIKE
.5-IN
.5
.62
nom_diam act_diam cd
.75-IN
.742
.62
nom_diam act_diam cd
1-IN
.9568
.62
nom_diam act_diam cd
CP
.5-IN
.5
.62
nom_diam act_diam cd
.75-IN
.742
.62
nom_diam act_diam cd
1-IN
.9568
.62
nom_diam act_diam cd
1.5-IN
1.5
.62
nom_diam act_diam cd
System Management
Version 11.1
Where
nom _diam = Nominal diameter
act_diam = Actual diameter in inches
cd = Discharge coefficient
6-9
Configuring
Pressure
Relief, Pipe,
and Valve
Equipment
Data
Figure 6.7
Where:
material
no_sch
schedulei
no_diam
nom_diamj
act_diamj
roughnessj =
6-10
roughnessj
roughnessj+1
System Management
Version 11.1
Chapter 6
Figure 6.8 is an abbreviated version of the delivered pipe.dat file for carbon-steel.
The comments provided here are not included in the file.
Figure 6.8
pipe.dat File
Keywords and Data
PRPIPE REPLACE
Comments
CARBON-STEEL
10
0.25-IN
0.410
.00015
0.375-IN
0.545
.00015
0.500-IN
0.674
.00015
20
1-IN
1.073
.00015
2-IN
2.111
.00015
3-IN
3.164
.00015
System Management
Version 11.1
Where:
nom_diam = Nominal diameter
act_diam = Actual diameter in inches
roughness = Absolute roughness in feet
6-11
Configuring
Pressure
Relief, Pipe,
and Valve
Equipment
Data
Figure 6.9
6-12
act_diamj
act_diamj+1
setpointj
setpointj+1
System Management
Version 11.1
Chapter 6
Where:
manuf
Manufacturer type
=
name_stylei =
no_style
Name of style
no_sizes
nom_diamj
act_diamj
setpointj
Figure 6.10 is an abbreviated version of the delivered ervtable.dat file. The file
does not include comments.
Figure 6.10
ervtable.dat File
Keywords and Data
PRERV REPLACE
Comments
PROTECTOSEAL
7800
2-IN
1.888
-2
3-IN
2.764
-2
4-IN
3.598
-2
9800
2-IN
1.487
3-IN
2.263
PRERV
REPLACE
GROTH
2100
16-IN
8.016
20-IN
9.944
24-IN
12.092
System Management
Version 11.1
Where:
nom_diam = Nominal diameter
act_diam = Actual diameter in inches
setpoint = Suggested setpoint in psig
6-13
Configuring
Pressure
Relief, Pipe,
and Valve
Equipment
Data
891d 4
K=
Cv 2
Where d is the valve diameter in inches
For more information about this method, see Flow of Fluids Through Valves,
Fittings, and Pipe, Technical Paper No. 410, Crane Co., 104 N. Chicago St.,
Joliet, IL 60434, 1988, p. A-31.
To customize the valve table, modify the transflo.dat file. Figure 6.11 shows the
file organization. The indentation is for reading clarity only.
Figure 6.11
6-14
port_areaj
port_areaj+1
flow_coeffj
flow_coeffj+1
System Management
Version 11.1
Chapter 6
Where:
manuf
=
name_stylei =
no_styles
Manufacturer type
Number of styles available for manufacturer type
Name for ith style. Repeat this section for each style.
no_sizes
Number of sizes
nom_diamj
port_areaj =
flow_coeffj =
Figure 6.12 is an abbreviated version of the delivered transflo.dat file. The file
does not include comments.
Figure 6.12
transflo.dat File
Keywords and Data
PRTRAN REPLACE KTM
BALL-L-PORT
1.5-IN
2.03583
53.
nom_diam
port_area
flow_coeff
2-IN
3.3556
110.
nom_diam
port_area
flow_coeff
2.5-IN
4.78775
160.
nom_diam
port_area
flow_coeff
BALL-T-PORT
1.5-IN
2.03583
50.
nom_diam
port_area
flow_coeff
2-IN
3.3556
100.
nom_diam
port_area
flow_coeff
2.5-IN
4.78775
150.
nom_diam
port_area
flow_coeff
3-IN
7.39265
240.
nom_diam
port_area
flow_coeff
System Management
Version 11.1
Comments
Where:
nom_diam = Nominal diameter
port_area = Port area
flow_coeff = Flow coefficients
6-15
Configuring
Pressure
Relief, Pipe,
and Valve
Equipment
Data
6-16
System Management
Version 11.1
Chapter 6
To customize the table, modify the valve.dat file. Figure 6.13 shows the
organization of the file. The indentation is for reading clarity only.
Figure 6.13
Fln
Where:
name_typei
no_manufs
Number of manufacturers
name_manufj
no_series/style
Number of series/styles
name_series/stylek =
no_sizes
=
System Management
Version 11.1
Fl1
sizel
no_points
6-17
Configuring
Pressure
Relief, Pipe,
and Valve
Equipment
Data
Figure 6.14 is an abbreviated version of the delivered valve.dat file. The file does
not include comments.
Figure 6.14
valve.dat File
Keywords and Data
VALDAT REPLACE
Comments
BALL
NELES-JAMESBURY
5000_REDUCED_PORT-FLANGED
20
0.5-IN
10
10
0.1
0.91
0.82
Vp Cv XT Fl
20
0.2
0.91
0.82
Vp Cv XT Fl
30
0.4
0.90
0.80
Vp Cv XT Fl
40
0.7
0.88
0.75
Vp Cv XT Fl
50
1.2
0.85
0.67
Vp Cv XT Fl
60
1.9
0.80
0.57
Vp Cv XT Fl
70
2.7
0.74
0.42
Vp Cv XT Fl
80
4.2
0.65
0.28
Vp Cv XT Fl
90
6.3
0.55
0.20
Vp Cv XT Fl
100
9.0
0.48
0.15
Vp Cv XT Fl
0.75-IN
METAL_SEATED_FULL_PORT
16
1-IN
10
10
0.68
0.91
0.82
Vp Cv XT Fl
20
1.51
0.91
0.82
Vp Cv XT Fl
continued
6-18
System Management
Version 11.1
Chapter 6
Figure 6.14
0.80
Comments
Vp Cv XT Fl
40
4.89
0.88
0.75
Vp Cv XT Fl
50
7.70
0.85
0.67
Vp Cv XT Fl
60
11.5
0.80
0.57
Vp Cv XT Fl
70
17.0
0.74
0.42
Vp Cv XT Fl
80
26.0
0.67
0.30
Vp Cv XT Fl
90
38.0
0.59
0.20
Vp Cv XT Fl
100
52.0
0.51
0.15
Vp Cv XT Fl
1.5-IN
VALDAT
BUTTERFLY
NELES-JAMESBURY
ANSI_CLASS_150
13
3-IN
10
10
12.5
0.76
0.42
Vp Cv XT Fl
20
31.3
0.79
0.42
Vp Cv XT Fl
30
51.0
0.82
0.43
Vp Cv XT Fl
40
75.0
0.83
0.44
Vp Cv XT Fl
50
103.0
0.83
0.45
Vp Cv XT Fl
60
137.0
0.82
0.42
Vp Cv XT Fl
70
174.0
0.80
0.34
Vp Cv XT Fl
80
208.0
0.75
0.25
Vp Cv XT Fl
90
229.0
0.70
0.18
Vp Cv XT Fl
100
235.0
0.65
0.15
Vp Cv XT Fl
4-IN
System Management
Version 11.1
6-19
Configuring
Pressure
Relief, Pipe,
and Valve
Equipment
Data
6-20
System Management
Version 11.1
Chapter 7
Accounting Report
This chapter contains the following topics:
Generating a User-Based Accounting Report
Running the Accounting Program
Creating a New Accounting File
Making Accounting Information Required
Activating Accounting on Windows
You can use the Aspen Plus accounting program to generate reports on the use of
Aspen Plus at a particular site. Every Aspen Plus run writes run information to
the Aspen Plus accounting file, which is stored in the Aspen Plus accounting
directory. The accounting program generates reports based on information in the
accounting file. You specify the level of detail to include in the report. The top
levels of detail are:
Number of runs for each user
A user-based accounting report showing the number of runs for each user in
each of the three months in a calendar quarter
A non user-based accounting report showing the number of runs plus details
in an arbitrary time period
Statistical information about usage at the site, including several measures of
problem size
Statistical information about usage by each user and a list of runs made by
each user
You can select the type of report to generate and the time period to report when
you run the accounting program.
The accounting program has different reporting capabilities from the
AspenTech License Manager, described in the AspenTech License Manager
Installation and Reference Guide. The License Manager only records
simultaneous use of Aspen Plus and layered products (that is, more than one
person running Aspen Plus at the same time). The accounting program reports
information about each run.
System Management
Version 11.1
7-1
Accounting
Report
The accounting file is not generated by default under Windows. To activate the
accounting file for Windows platforms, see Activating Accounting on Windows,
this chapter. You must activate the accounting program before any Aspen Plus
usage will be recorded.
You are prompted for the name of the accounting file. The default name is
given in brackets:
Enter the Aspen Plus Master Accounting Filename
[C:\Progra~1\ASPENT~1\ASPENP~1.1\Engine\xeq\Aspen.msf]:
Answer yes.
7. The system asks for which calendar quarter you want to generate the report:
PLEASE SELECT THE TIME PERIOD:
1
FIRST QUARTER
2
SECOND QUARTER
3
THIRD QUARTER
4
FOURTH QUARTER
5
OTHER TIME PERIOD
7-2
System Management
Version 11.1
Chapter 7
In most cases, the detailed report is not needed. You may want to generate
the report if the number of runs reported in the standard report is
questionable. Generating the detailed report will increase the time required
to run the program.
10. Answer yes or no.
The accounting program will begin running. The length of the run depends on the
size of the accounting file.
The files created by the accounting program are:
File
Description
runid.rp1
Contains a table listing the users and the number of runs made. One table is created for each month.
runid.rp2
Contains a listing of each run made. This file is generated only if you answer yes in Step 9.
Note
System Management
Version 11.1
7-3
Accounting
Report
4. The system prompts you for the name of the accounting file. The default
name is given in brackets:
Enter the Aspen Plus Master Accounting Filename
[C:\Progra~1\ASPENT~1\ASPENP~1.1\Engine\xeq\Aspen.msf]:
7-4
System Management
Version 11.1
Chapter 7
The accounting report contains tables of usage based on your choices. The
logon ID is the Windows account name. The remaining four items (account
number, project ID, project name, and user name) can be entered on the
Setup Specifications Accounting sheet in the Aspen Plus user interface. See
the Aspen Plus User Guide, Volume 1, Chapter 5.
The program asks for the beginning and ending dates for the report:
PLEASE ENTER THE DATE FOR THE START OF THE REPORTING PERIOD. (MM DD YYYY)
PLEASE ENTER THE DATE FOR THE END OF THE REPORTING PERIOD. (MM DD YYYY)
9. Enter the start and end dates. The program selects and reports on the
Aspen Plus runs that occurred between the start and end dates.
You are asked if you want the detailed run statistic report and the user
report:
DO YOU WANT THE RUN STATISTICS TABLES AND USER REPORTS? (YES/NO)
The user reports contain statistical information on runs made by each user.
Detailed information is given on each run made by each user, including the
date, time, and the input file name. In most cases, this information is not
needed. If you answer yes to this question, it takes considerably longer to
generate the accounting report.
10. Answer yes or no.
The accounting program begins running. The length of the run depends on the
size of the accounting file.
The accounting program creates these files:
File
Description
runid.his
History file. Contains information on the run, such as number of records read, run time, and options chosen.
runid.urp
User report file. Contains detailed information on each ID found in the reporting period. Includes a log of every
Aspen Plus run made, a run analysis summary, and a resource unit summary.
runid.srp
System report file. Contains statistics for all Aspen Plus runs made during the reporting period.
runid.rp1
runid.rp2
Contains a listing of each run made when the detailed report option is specified.
System Management
Version 11.1
Generated for non user-based reports when Run Statistic Tables and User Report is specified.
7-5
Accounting
Report
Command
Windows
Where C:\Program Files\AspenTech\Aspen Plus 11.1 is the drive and directory where Aspen Plus is installed
4. Execute the accounting program. Use the appropriate command for your
operating system:
Operating System
Command
Windows
ACR NEWFILE
7-6
System Management
Version 11.1
Chapter 7
If you want to modify the Aspen Plus simulation engine to require accounting
information, contact the AspenTech hotline. You need a License Key Certificate
for the AspenTech License Manager.
System Management
Version 11.1
7-7
Accounting
Report
Windows 95/98
1. Append the following line to the bottom of the AUTOEXEC.BAT file for all
appropriate PCs:
SET ASPACCT=ON
Windows NT
For Windows NT systems, set the accounting environment variable for the
system rather for a single user account.
1. On the Task bar, click Start, then Settings, and Control Panel.
2. Double-click the System icon, and go to the Environments sheet.
3. Click any variable labeled as System Variables in the list.
4. At the bottom of the page, click the Variable field and replace the entry with
ASPACCT.
5. Click the Value field and replace the entry with ON.
6. Click Set, then OK to save the settings.
7-8
System Management
Version 11.1
Appendix A
System Management
Version 11.1
A-1
Customizing
the Aspen Plus
User Interface
Table A.1
Description
recsav.apr
mmg.hms
pp***.dat
lcd_cust.dat
mdl_cust.dat
*.hxt
*.srt
tbcustom.dat
tbcustom.hxt
The *.dat and *.hxt files for Windows are in the following Aspen Plus user
interface system directory:
C:\Program Files\AspenTech\APrSystem 11.1\GUI\custom
To customize the Aspen Plus user interface, follow these steps:
1. Create a directory to store the customization files you need to modify.
2. Modify the files.
3. Test your customization in the new directory.
You can use most simulation engine TBS (Table Building System) files for
directly running MMTBS.
For the simulation engine, Aspen Plus stores each property method or parameter
definition separately in a .sto or .lcd file. The following table describes where
property methods and parameter definitions for the user interface are stored:
A-2
System Management
Version 11.1
Appendix A
All
Are stored in
Property methods
ppstoptn.dat
Parameter definitions
pplcdefs.dat
For property methods, add your customized .sto file, without the TBS header and
footer, to the Aspen Plus user interface file, ppstoptn.dat.
For parameter definitions, store your customized TBS pplcdef.dat files in a
special user interface file, lcd_cust.dat. Do not store them with the user interface
system file, pplcdefs.dat.
For property model definitions, store your customized files from the TBS
ppcnvpmd.dat file in a special user interface file, mdl_cust.dat. Do not store them
with the user interface system file ppcnvpmd.dat.
You can use the customized ppenmprt.dat and ppensprt.dat files directly in the
user interface.
For more information:
To modify the
Databank files
Creating Help
Aspen Plus uses the Windows Help system to display Help. To create your own
Help integrated with the Aspen Plus Help files, follow these steps:
1. Modify the existing Help source file(s) in Microsoft Word.
2. Assign map numbers to Help topics in the Help project file (.hpj).
3. Compile the Help source file(s) into a Windows Help file.
4. Modify the Aspen Plus user interface to integrate the new Help you created.
You can also build an optional table of contents file. Table A.2 lists the files you
need to create your own Help:
System Management
Version 11.1
A-3
Customizing
the Aspen Plus
User Interface
Table A.2
Description
Available from
custom.rtf
userdata.rtf
custom.hpj
HCWSETUP.EXE
You need Microsoft's Help compiler to compile the Help source files into Help.
You can obtain the Help compiler and utilities from:
http://support.microsoft.com/support/kb/articles/Q170/6/89.asp
Download the HCWSETUP.EXE, a self-extracting program that installs the Help
compiler and Microsoft Help Workshop components. You can also use the
following optional file:
File
Description
Available from
custom.cnt
The files listed in Table A.2 have been tested and work with Microsoft Word 7.0
and the Microsoft Help Workshop 4.03.
For
It is recommended that you use Microsoft Word Version 7.0 to edit the Help
source files. You can use any word processing program that reads and writes
Rich Text Format (RTF), but some of these programs may not be able to read the
Word formatted template we provide.
A-4
System Management
Version 11.1
Appendix A
A Help popup window does not have scroll bars, so for help
displayed in a popup window, you should limit the amount of
information in a topic to a few lines.
If you want to add more topics than the number supplied in the custom.rtf file,
you may copy and paste the example topic information into a new .rtf file. You
will, however, need to change the topic identifier of the new topic. In Windows
Help, each Help topic is identified by a unique topic ID. To change the topic ID
after copying and pasting a topic, follow these steps:
1. In the newly created file that contains the pasted example topic, from the
View menu, select Footnotes. The system displays a # footnote with the text
"Topic1" next to it.
2. Change the text "Topic1" to a topic ID of your choice. This ID must be unique,
such as Topic4. It cannot begin or end with spaces, cannot begin with a
number, and it cannot contain these symbols: # = + @ * % !
System Management
Version 11.1
A-5
Customizing
the Aspen Plus
User Interface
3. Next to the $ footnote sign, change the title "Topic1" to the title of your Help
topic.
4. As you incrementally add Help topics in this way (one per .rtf file), ensure
that you change each topic's ID to a unique identifier every time.
When saving your Help source file(s) before compiling, make sure you save them
with the file extension .rtf. The Help compiler only accepts .rtf files.
A-6
System Management
Version 11.1
Appendix A
3. Add a map number by clicking Add and entering the topic ID and map
number. Edit an existing Map number by selecting the topic and clicking edit.
The topic ID you enter must be the same as the topic ID you used for the #
footnote for the topic in the .rtf file. See Modifying the Help Source Files, this
chapter, for more information.
If you add more topics to your Help by creating new Help source (.rtf) files, then
you need to add the names of the new files to the .hpj file:
1. Open the appropriate .hpj file that AspenTech provides (custom.hpj), using
Microsoft Help Workshop.
2. Click the Files button on the right side of the custom.hpj window.
The Topic Files dialog box appears.
3. Click Add to add the names of your new .rtf files.
Important
4. Update the contents file, if desired. When you double-click the custom.cnt file,
it should open in Help Compiler Workshop. Use the buttons at the right to
add additional topics and headings, or to rearrange them. When you add a
topic, be sure to specify its topic ID (the string in its # footnote in the help
source file).
5. To install and test your customized Help, you need to copy the files to the
system using the custinst command (see Installing the New Files, this
chapter). To just update the help files without updating other files, copy the
.hlp and .cnt files to the GUI\xeq directory of programs which will use them,
such as C:\Program Files\AspenTech\Aspen Plus 11.1\GUI\xeq .
System Management
Version 11.1
A-7
Customizing
the Aspen Plus
User Interface
Where:
custom.hlp
#100
It is also useful to provide prompts for your customization. Prompts are included
in the Aspen Plus Help (*.hxt) file.
Prompts Format
Prompts have the following format in the Help file:
>p_replace P_context_string_ID
Prompt text
>endmessage
Where:
>p_replace
P_context_string_ID
Prompt text
>endmessage
Prompts can be up to two lines, with 126 characters per line. Prompts for
component databanks use a different format and are stored in the tbmsg.txt file.
See Adding Prompts and Help for a User or In-House Databank, Chapter 6, for
more information.
A-8
System Management
Version 11.1
Appendix A
You must run the command Mmcustom to incorporate your changes into the
interface. See Running the User Interface Customization System, this appendix.
System Management
Version 11.1
To run
To update
tbcustom.dat
MMTBS
tbcustom.hxt
HTM
A-9
Customizing
the Aspen Plus
User Interface
If you add property parameters, models, routes, and methods to the existing
MMTBS files, you do not need to change the MMTBS driver file. If you save your
changes in new files, modify the MMTBS driver file to include the names of the
new files.
If you add Help and prompts to existing Help files (*.hxt), list the names of the
modified Help files in tbcustom.hxt before running the HTM program. If you save
your Help and prompts in new files, list the new file names in the tbcustom.hxt
file.
2. Update the HTM driver file (tbcustom.hxt) to list the .hxt files that have been
added or modified.
3. Enter the following command to update the user interface Help file with your
Help and prompts:
mmcustom htm
A-10
System Management
Version 11.1
Appendix A
When the user interface customization is complete, you may erase the RecDef
and .hlp files in the customization directory. Save the TBS input, .hxt, .rtf, .cnt,
and .hpj files for customizing future releases of the user interface.
System Management
Version 11.1
A-11
Customizing
the Aspen Plus
User Interface
A-12
System Management
Version 11.1
Appendix B
System Management
Version 11.1
B-1
TBS File
Descriptions
Figure B.1
B-2
1
5
2
0
PPCNVPMD REPLACE
propname
iwaq
n1
opcode
n2
intsub
n3
mnsub
10
n4
11
ppname
2
5
3
5
4
0
4
5
5
0
5
5
6
0
6
5
7
0
7
5
8
0
modelnam
idxcgt
iwal
3
0
mid1 mid2
iwac
rwaq
mid3
rwal
opcode
opcode
opcode
intsub
intsub
intsub
mnsub
mnsub
mnsub
ppname
ppname
ppname
rwac
System Management
Version 11.1
Appendix B
Table B.1
Description
modelnam
Model name
propname
Property name
idxcgt
mid1
mid2
mid3
iwaq
iwal
iwac
rwaq
rwal
rwac
n1
opcode
n2
intsub
n3
mnsub
n4
ppname
Real work area = rwaq * NCC2 + rwal*NCC + rwac, where NCC is the total number of conventional components in the
simulation. The real work area required is determined by the size of any temporary real storage area required in the
mainline subroutines.
Enter four values or names on each line. Use as many lines as necessary.
System Management
Version 11.1
B-3
TBS File
Descriptions
Table B.2 describes the layout of the mid1, mid2, and mid3 Model Implemented
Derivative Codes for the Conventional Property Model Definition Table.
Table B.2
Description
mid1 dcba
a = implementation of property.
Options: 0 = not implemented; 1 = implemented
b = implementation of temperature derivatives (dn/dTn).
Options: 0 = not implemented; 1 = d/dT; 2 = d/dT, and d2/dT2; 3 = d/dT, d2/dT2, and d3/dT3
c = implementation of first order pressure derivative (d/dP).
Options: 0 = not implemented; 1 = implemented
d = implementation of composite temperature and pressure derivatives(d[n+1]/dPdTn).
Options: 0 = not implemented; 1 = d2/dPdT; 2 = d2/dPdT, and d3/dPdT2
mid2 kjihg
mid3 ponml
B-4
System Management
Version 11.1
Appendix B
It does not require any integer work area, but it requires real work area with size = 2 * NCC +
6 * NCC. NCC is the total number of conventional components in the simulation. This model
does not have a model option code. It requires:
1
1
12345 67890
5
PPCNVPMD REPLACE
2
0
GAMMA
GM07
GM06
10
GMUQR
GMUQQ
11
GMUQQ1
UNIQ
2
5
GMUQUAC
108
0
3
0
3
5
4
0
0021 00011
0
GMUQL
4
5
5
0
5
5
6
0
6
5
7
0
7
5
8
0
00011
6
GMUQAA
When the number of option codes is zero (n1 = 0), you do not need to supply the option code
values. The line for entering opcode is skipped.
System Management
Version 11.1
B-5
TBS File
Descriptions
Figure B.2
B-6
1
1
12345 67890
5
PPLCDEFS REPLACE
2
0
2
5
ppname
3
0
3
5
4
0
4
5
5
0
5
5
6
0
6
5
7
0
7
5
Parameter description
pptype
default value
default value
default value
default value
lower bound
lower bound
lower bound
lower bound
upper bound
upper bound
upper bound
upper bound
nominal value
nominal value
nominal value
nominal value
regression code
regression code
regression code
regression code
10
symmetric code
symmetric code
symmetric code
symmetric code
11
param labal
param label
param label
param label
12
13
no units row
14
ur
15
ppinput
j
ur
ur
ppno
dataset
l
n0
8
0
kion
ur
System Management
Version 11.1
Appendix B
Table B.3 describes the parameters for the Property Parameter Definition Table:
Table B.3
Description
ppname
Parameter description
pptype
ppinput
dataset
n0
kion
Number of elements for parameter. For example, PLXANT has nine elements.
ppno
Defaults to zero.
continued
System Management
Version 11.1
B-7
TBS File
Descriptions
Table B.3
B-8
Description
Regression code:
0 = No regression code. Parameter cannot be regressed.
1 = Supply regression code
default value
Parameter default value (in SI units, one value per element). Required.
lower bound
upper bound
nominal value
regression code
0 = Cannot be regressed
1 = Can be regressed
2 = Unconditionally used in regression. Defaulted on the
Properties Regression form.
> 5 = Delta T. If delta T of data is greater than the code value, the parameter
can be regressed.
< 0 = Number of data points. If number of data points is greater than the
absolute value of the code, the parameter can be regressed.
symmetric code
param label
Encoded units conversion flag (see Units Conversion Flag, this chapter).
no units row
ur
Defaults to zero.
Units rows for all units in Aspen Plus are summarized in Table B.4.
System Management
Version 11.1
Appendix B
Table B.4 describes the units rows for all units in Aspen Plus.
Table B.4
Description
Units Row
Description
Area
35
Filter resistance
Composition
36
Density
37
Mole density
Diffusivity
38
Mass density
Energy
39
Mole enthalpy
Enthalpy
40
Mass enthalpy
Entropy
41
Mole entropy
Fiscal
42
Mass entropy
Flow
43
Mole volume
10
Mass flow
44
Dimensionless
11
Mole flow
45
Dipole moment
12
Volume flow
46
Solubility parameter
13
Enthalpy flow
47
Electrical power
14
Force
48
Electric price
15
49
16
50
UA
17
Length
51
Moles
18
Mass
52
Work
19
Power
53
Heat
20
Pressure
54
Area-price
21
Surface tension
55
Volume-price
22
Temperature
56
Item-price
23
Thermal conductivity
57
Number concentration
24
Time
58
Mass concentration
25
Velocity
59
Inverse time
26
Viscosity
60
27
Volume
61
Flux
28
Frequency
62
Area usage
29
Unit-price
63
Volume usage
30
Energy-price
64
Mole concentration
31
Delta-T
65
Power-volume
32
Angle
66
33
Head
67
Specific area
34
68
Inverse length
continued
System Management
Version 11.1
B-9
TBS File
Descriptions
Table B.4
Description
Units Row
Description
69
Chrom velocity
88
Volume enthalpy
70
Mass flux
89 - 99
71
Solvent permeability
100
72
Solute permeability
101
Friction factor
73
Water rate
102
74
103
75
Pressure drop
104
76
Packing factor
105
77
106
78
Inverse area
107
79
108
80
Heat flux
109
81
Inverse temperature
110
82
Inverse pressure
111
Sound level
83
Temperature-volume
112
Moment of inertia
84
Vflow-length
113
Voltage
85
Contents
114
Current
86
Population density
115
87
116
Meaning
-n
Used for simple conversions that do not depend on any other element.
For example, -1 means the units conversion formula for this element begins on the first line of the Units Conversion
Formula section, and -5 means the formula begins on the fifth line.
B-10
System Management
Version 11.1
Appendix B
Aspen Plus allows the following operands and variables in the units conversion
formula:
Operand
Description
Example
A...Z
[i]
[20] = pressure
Aspen Plus allows the following functions in the units conversion formula:
Function
Description
Example
Multiply
x y * = x*y
Divide
x y / = x/y
Add
x y + = x+y
Subtract
x y - = x-y
Exponentiation
x y ^ = xy
Conditional
log
Natural log
x log = log(x)
End of formula
Use the conditional ("function?") to ask if a parameter exists (see the following
example). The conditional is often used for absolute temperature requirements.
An example is the extended Antoine equation. When the ln(T) term is non-zero,
you must use the absolute temperature units. The additive portion of the
temperature conversion factor, [22B], is ignored. See the following example for
more details.
System Management
Version 11.1
B-11
TBS File
Descriptions
The first four parameters are the correlation coefficients. The last two parameters are
temperature limits of the correlation.
The six parameters (A...F) are represented by a vector of six elements. A is the first element,
B the second, up to F, the sixth element. If the parameter contains additional elements, you
can use G for the seventh element, and so on. Once you exhaust A to Z, you can use AA,
AB,...AZ. After AZ, you can use BA, BB, and so on.
You can derive the following elements in the new units:
(new A) = A + ln[20] (C*ln[22])(D*[22B]/[22])
(new B) = B*[22]
(new C) = C
(new D) = D/[22]
(new E) = E*[22] + [22B]
(new F) = F*[22] + [22B]
Where:
[20]
[22]
[22B]
=
=
=
If elements B and C are not zero, Aspen Plus can convert the formula only if it assumes
absolute temperature units (R or K). The conversion formula and conditional function (?)
addresses this situation.
The units conversion codes, and units conversion formulas for the property parameters
definition file of this parameter are listed in the following table:
1
12345 67890
1
5
2
0
2
5
3
0
3
5
4
0
4
5
5
0
5
5
6
0
6
5
7
0
7
5
8
0
1
2
-1
-2
22
22
20
22
44
-3
44
B [22] * ;
D [22] / ;
B-12
System Management
Version 11.1
Appendix B
The first units conversion code (1) indicates that the conversion formula for the first element
(A) is on the first line of the units conversion formula section (line 6, above).
The second conversion code (2) indicates that the conversion formula for the second element
(B) is on the second line of the units conversion formula section (line 7, above). This
conversion would have been 3, had the first formula wrapped to the second line. You can use
up to 72 columns on one line to specify the formula.
The 44 indicates this is a simple conversion. It uses units row 44, dimensionless, from Table
B.4. Therefore, the third element (C) is not converted.
The 4th conversion code (3) points to the third formula line (line 8, above) for conversion of
element four (D).
On the second line of the units conversion codes, (line 3, above) the two 22s indicate simple
temperature conversion for the lower and upper temperature limits.
Units conversion formulas are used for the second (B) and fourth (D) elements, although their
conversions do not involve other elements. Absolute temperature units must be used when
these elements are non-zero. Only the multiplicative conversion factor [22] should be used. If
you use the simple conversion code of 22, the parameters will be converted incorrectly:
(new value) = (old value) * [multiplicative factor] + [additive factor]
To show the sequence of operation, parentheses are added to the conversion formula of
element 1:
(((A ([20] LOG +) (C ([22] LOG *) ) ((D ([22B] [22] /) *) ((1 (B ?) ) (1 (C ?) ) *) *) )
The term containing [22B] contains the additive factor for temperature. You cannot use this
factor if B or C is non-zero. If B exists:
System Management
Version 11.1
22
44
B-13
TBS File
Descriptions
B-14
1
1
12345 67890
5
PPLCDEFS REPLACE
2
0
2
5
Critical temperature
1D35
5.
5000.
0.5074D3
22
10
11
22
1
1
3
5
4
0
4
5
5
0
5
5
6
0
6
5
7
0
7
5
8
0
TC
3
0
416
System Management
Version 11.1
Appendix B
1
1
12345 67890
5
PPLCDEFS REPLACE
2
0
2
5
PLXANT
3
0
3
5
4
0
4
5
5
0
5
5
6
0
6
5
Extended Antoineparameters
-1D35
1D3
.893609D2
10
1D3
11
12
100
13
14
-1
-3
-4
-5
15
44
-6
44
22
16
22
17
18
20
1
1
22
1
356
7
0
7
5
8
0
10
44
? - * * * - ;
22 D [22] / ;
23 F [22] G ^ / ;
System Management
Version 11.1
B-15
TBS File
Descriptions
Default to zero
Can be regressed (regression code > 0)
Are asymmetric (symmetric code = 0)
The last two elements are temperature limits which default to zero and 1000 K. The
temperature limits cannot be regressed (regression code = 0) and are symmetric (symmetric
code = 2). The parameter labels appear on Properties Parameters Binary forms.
Elements 1, 2, and 4 require complex units conversion formulas which begin on lines 1, 2, and
3, respectively, of the Units Conversion Formula section. Element 3 is dimensionless (units
flag = 44). The last two elements have temperature units (units flag = 22).
1
1
1
12345 67890
5
PPLCDEFS REPLACE
2
0
2
5
WILSON
3
0
0D0
0D0
0D0
1D3
60
10
11
aij
12
3
0
3
5
4
0
1
480
4
5
5
0
5
5
6
0
6
5
7
0
7
5
8
0
1
0D0
0D0
100
aji
bij
bji
cij
cji
dij
dji
13
Tlower
Tupper
14
-1
-2
44
-3
15
22
22
16
17
44
22
B-16
System Management
Version 11.1
Appendix B
Figure B.3
1
1
12345 67890
5
PPSUBLST REPLACE
2
0
2
3
5
0
subrname
3
5
4
0
4
5
5
0
5
5
6
0
6
5
7
0
7
5
8
0
2
3
System Management
Version 11.1
Routine
Filename
ppuser_phcciu
phcciu.f
ppuser_mdmon9
mdmon9.f
ppuser_esmnu
esmnu.f
ppuser_esmnu0
esmnu0.f
B-17
TBS File
Descriptions
Windows NT/95
Directory
C:\Program Files\AspenTech\Aspen Plus 11.1\Engine\USER
If you install Aspen Plus on a different disk drive or directory, enter the appropriate drive name and
directory location. The routines are extracted by issuing the user command at the command line prompt of the Aspen Plus
Simulation Engine window.
After modifying any of these routines, you must rebuild the ppuser shared
library. See Chapter 3.
2. Specify the initialization routine names in the DATA statement for variable
ISUB. For example, suppose the two initialization routines are USRIN1 and
USRIN2. The DATA statement should read:
DATA ISUB/4HUSRI, 4HN1
,4HUSRI,4HN2
4. For each label defined in step 3, call the initialization routine with the routine
name defined in step 2. For example:
10
20
Where MNDS is the maximum number of data sets defined for this model and
is in the argument list of phcciu.f. Do not define MNDS. Instead, pass MNDS
as an input variable to the initialization routine.
B-18
System Management
Version 11.1
Appendix B
Use label 10 to call the mainline subroutine defined for a property model that
has a computed GO TO index of 900 (parameter idxcgt=900 in Figure B.1).
Use label 20 to call a subroutine corresponding to idxcgt=901, and so on.
2. For each label defined in step 1, call the mainline subroutine. The following
input variables are available:
Variable
Type
Dimension
Description
REAL*8
Temperature (K)
PSYS
REAL*8
B(P(1))
REAL*8
INTEGER
IDX
INTEGER
REAL*8
KDIAG
INTEGER
NDS
INTEGER
KCMOD
INTEGER
IB(LBB+9)
INTEGER
10
IRW5
INTEGER
IIW
INTEGER
Type
Dimension
Description
REAL*8
REAL*8
Q(ID11)
REAL*8
Q(ID11)
REAL*8
Equation-of-state subroutines for mixtures are used to calculate both pure and
mixture properties when invoked from an equation-of-state-based property
method (for example, PENG-ROB). These user models are invoked from the
system routine ppuser_esmnu (file esmnu.f). The pure component version of the
models is necessary only if the user wants the equation of state to also calculate
pure component reference states for activity coefficient based methods. In this
case, the user routines are invoked from the system routine ppuser_esmnu0 (file
esmnu0.f).
System Management
Version 11.1
B-19
TBS File
Descriptions
Label 1010 is used to call the first in-house equation-of-state model that has a
computed GO TO index of 51 (parameter idxcgt = 51 in Figure B.1 for
propname = EOS or parameter idxcgt = 51 for EOS0). Use label 1020 to call
the EOS subroutine corresponding to idxcgt = 52 (or 52 for EOS0). This
section handles both property calculations and property temperature
derivative calculations.
B-20
System Management
Version 11.1
Appendix B
2. For each label defined in steps 1 and 2, call the mainline equation-of-state
routine. The following input variables are available:
System Management
Version 11.1
Variable
Type
Dimension
Description
REAL*8
Temperature (K)
REAL*8
REAL*8
INTEGER
IDX
INTEGER
IRW1
INTEGER
IIW
INTEGER
KVL
INTEGER
NDS
INTEGER
KDIAG
INTEGER
IB(LBB+9)
INTEGER
10
KCALC (1)
INTEGER
KCALC (2)
INTEGER
KCALC (3)
INTEGER
KCALC (4)
INTEGER
KCALC (5)
INTEGER
B-21
TBS File
Descriptions
Variable
Type
Dimension
Description
PHIMX
REAL*8
PHIMX (NP1)
REAL*8
DHMX(1)
REAL*8
DHMX (2)
REAL*8
DSMX (1)
REAL*8
DSMX (2)
REAL*8
DGMX (1)
REAL*8
DGMX (2)
REAL*8
VMX (1)
REAL*8
VMX (2)
REAL*8
ZMX(1)
REAL*8
Compressibility factor
ZMX(2)
REAL*8
CVMX(1)
REAL*8
CVMX(2)
REAL*8
NP1 is available from the argument list of the esmnu and esmnu0 routines.
B-22
System Management
Version 11.1
Appendix B
Figure B.4
System Management
Version 11.1
1
1
12345 67890
5
PPENMPRT REPLACE
propname
n1
mdlprop
n2
m-opcode
n3
majprop
n4
10
subprop
11
n5
12
r-opcode
2
0
2
5
routeid
3
0
3
5
4
0
4
5
5
0
5
5
6
0
6
5
7
0
7
5
8
0
method
model
setno
monitor
m-opcode
m-opcode
m-opcode
m-opcode
m-opcode
majprop
majprop
majprop
majprop
majprop
subprop
subprop
subprop
subprop
subprop
r-opcode
r-opcode
r-opcode
r-opcode
r-opcode
B-23
TBS File
Descriptions
Table B.5
Description
routeid
Property route ID
propname
method
n1
mdlprop
model
Model name
setno
monitor
n2
m-opcode
n3
majprop
majroute
n4
subprop
subroute
n5
r-opcode
B-24
System Management
Version 11.1
Appendix B
Figure B.5 shows the layout for the Subordinate Property Route table:
Figure B.5
System Management
Version 11.1
1
1
12345 67890
5
PPENSPRT REPLACE
propname
n1
mdlprop
n2
m-opcode
n3
majprop
n4
10
subprop
11
n5
12
r-opcode
2
0
2
5
routeid
3
0
3
5
4
0
4
5
5
0
5
5
6
0
6
5
7
0
7
5
8
0
method
model
setno
monitor
m-opcode
m-opcode
m-opcode
m-opcode
m-opcode
majprop
majprop
majprop
majprop
majprop
subprop
subprop
subprop
subprop
subprop
r-opcode
r-opcode
r-opcode
r-opcode
r-opcode
B-25
TBS File
Descriptions
Table B.6
Description
routeid
Property route ID
propname
method
n1
mdlprop
model
Model name
setno
monitor
n2
m-opcode
n3
majprop
majroute
n4
subprop
subroute
n5
r-opcode
B-26
System Management
Version 11.1
Appendix B
The WHENRY model has one model option code (n2 = 1). The option code value of 2
(m-opcode = 2) indicates the Henry's constant in the mixture is calculated by surface-area
averaging. For solvents, this route calculates the reference state fugacity coefficient (majprop
= PHIL) by the major property route PHIL04. The major property route PHILMX24 uses one
route option code (n5 = 1), with option code value of 1 (r-opcode = 1).
1
System Management
Version 11.1
1
1
12345 67890
5
PPENMPRT REPLACE
PHILMX
GAMMA
WHNRY
10
PHIL
11
12
HNRY
13
14
2
0
2
3
5
0
PHILMX24
3
5
4
0
4
5
5
0
5
5
6
0
6
5
7
0
7
5
8
0
GMRENON
107
WHENRY
203
PHIL04
HNRY01
B-27
TBS File
Descriptions
The vapor pressure (mdlprop = PL) is calculated from the extended Antoine model
(model = PL0XANT) which has no model option code (n2=0). The heat of vaporization
(mdlprop = DHVL) is calculated from the Watson model (model = DHVLWTSN). The vapor
enthalpy departure (subprop = DHV) is calculated from subordinate property route DHV00. The
liquid enthalpy pressure correction (subprop = DHLPC) is calculated from subordinate property
route DHLPC00. This route does not reference any major property route (n3 = 0) and does not
use the route option code (n5 = 0).
1
B-28
1
1
12345 67890
5
PPENSPRT REPLACE
DHL
PL
DHVL
10
DHV
11
2
0
2
5
DHL00
3
0
3
5
4
0
4
5
5
0
5
5
6
0
6
5
7
0
7
5
8
0
PL0XANT
101
DHVLWTSN
123
DHV00
DHLPC
DHLPC00
System Management
Version 11.1
Appendix B
Figure B.6
1
1
12345 67890
5
PPSTOPTN REPLACE
2
0
2
5
opsetid
3
0
3
5
4
0
4
5
5
0
5
5
6
0
6
5
7
0
propname
routeid
propname
routeid
propname
routeid
propname
routeid
propname
routeid
propname
routeid
propname
routeid
propname
routeid
propname
routeid
propname
routeid
propname
routeid
propname
routeid
7
5
8
0
Table B.7
System Management
Version 11.1
Description
opsetid
Property method ID
propname
routeid
B-29
TBS File
Descriptions
1
1
12345 67890
5
PPSTOPTN REPLACE
2
0
2
5
NRTL
3
0
4
0
4
5
5
0
5
5
6
0
6
5
7
0
34
PHIMVX
PHIVMX00
PHILMX
PHILMX86
HVMX
HVMX00
HLMX
HLMX86
GVMX
GVMX00
GLMX
GLMX86
SVMX
SVMX00
SLMX
SLMX86
VVMX
VVMX00
VLMX
VLMX01
MUVMX
MUVMX01
MULMX
MULMX01
KVMX
KVMX01
KLMX
KLMX01
DVMX
DVMX01
DLMX
DLMX02
SIGLMX
SIGLMX01
PHIV
PHIV00
PHIL
PHIL00
HV
HV00
HL
HL00
10
GV
GV00
GL
GL00
SV
SV00
11
SL
SL00
VV
VV00
VL
VL01
12
MUV
MUV01
MUL
MUL01
KV
KV01
13
KL
KL01
DV
DV01
DL
DL01
14
SIGL
SIGL01
B-30
3
5
7
5
8
0
System Management
Version 11.1
B
Binary databanks
adding 4-10
creating input files 4-10
Building a Help table-of-contents file A-9
Building system shared libraries 3-7
Index
A
Accounting
program 7-4
report 7-1
report, user-based 7-2
required information 7-6
Accounting environment variable
setting 7-8
Accounting file
creating 7-6
initializing 7-7
Accounting program
activating 7-8
Adding Help
for databanks 4-7
Aspen Plus
COMMONs renamed 1-8
customizing simulation engine 5-2
customizing user interface 5-6
debugging 3-5
Help files, modifying A-8
INCLUDE files 1-8
in-house modifications 3-3
introduction 2-2
maintaining and updating 3-1
modification levels 3-2
routine names 1-9
run definition file 2-6
system modifications 3-3
table building system, running 3-12, 5-5
units rows available B-9
user modifications 3-2
utilities 2-9
Assigning map numbers A-6
System Management
Version 11.1
C
Command line qualifiers 2-9, 2-10
Compatibility issues 1-2
load modules 1-4
maintaining upward compatibility 1-4
system definition files 1-3
user interface initialization files 1-4
Compiling Help source files A-7
Compiling user routines 3-4
Configuring
physical property databanks 4-1
physical property methods 5-1
Converting
TBS input files 3-17
user routines 3-9
Converting Fortran
COMMONs renamed 1-8
INCLUDE files 1-8
inline 1-8
routine names 1-9
subroutines 1-8
Creating
custom SDF files 3-9
databank input files 4-4
databanks 4-2
Help files A-3
physical property models, routes, methods B-1
user interface input files 4-10
Customization files
MMTBS A-2
Customization system for user interface
running A-10
Customizing
Aspen Plus simulation engine 5-2
Aspen Plus user interface 5-6
Help source files A-4
D
Databanks
adding binary 4-10
E
Electrolyte reaction database
adding ionic reactions 4-17
Emergency relief vents 6-12
F
Files
MMTBS customization A-2
simulation run 2-5
Format
prompts A-8
Fortran
converting subroutines 1-8
inline, debugging 3-5
modifying source code 3-9
G
Gas/2-phase service safety relief valves 6-5
H
Help driver files
modifying A-9
Help files
adding for databanks 4-7
adding for models, routes, property methods 5-12
creating A-3
customizing A-4
modifying Aspen Plus A-8
Help source files
compiling A-7
modifying A-4
I
In-house databanks
adding 4-1
In-house models and subroutines
integrating 3-8
Initialization files 1-4
Inlet pipe valves 6-14
Inline Fortran 3-4
converting 1-8
Input file
binary databanks, creating 4-10
header templates 4-14
ionic reactions database, creating 4-18
pair parameter databanks, creating 4-10
Installing
databanks 4-8
Help files A-11
RECDEF files A-11
system definition files 5-5
Ionic reactions
adding to electrolyte reaction database 4-17
creating input file 4-18
L
Liquid service safety relief valves 6-2
Load modules 1-4
M
Maintaining and updating Aspen Plus 3-1
Maintaining upward compatibility 1-4
Major property route table B-23
parameters B-24
Map numbers
assigning to Help topics A-6
MMTBS
customization files A-2
running 4-7, 4-16, 4-20
MMTBS driver file
modifying 4-7, 4-16, 4-19, A-9
Models
adding to simulation engine 5-7
adding to user interface 5-11
Modifying
Aspen Plus 3-2
Aspen Plus Help files A-8
Help driver files A-9
Help source files A-4
System Management
Version 11.1
N
NRTL binary parameters 4-15
P
Pair parameter databanks
adding 4-10
creating input files 4-10
Physical property databanks
configuring 4-1
Physical property method table B-29
parameters B-29
Physical property methods
configuring 5-1
Physical property models, routes, methods
creating 5-6
Physical property subroutine list table B-17
Pipes
pressure relief 6-10
valves 6-14
Pressure relief
configuring equipment data 6-1
pipes 6-10
rupture disks 6-8
Prompts
adding for models, routes, property methods 5-12
format A-8
Property methods
adding to simulation engine 5-7
adding to user interface 5-11
example of file NRTL.STO B-30
Property model definition table B-2
Property parameter definition table B-6
parameters B-7
Property route tables
major B-23, B-27
subordinate B-25, B-28
R
Relief valves
gas/2-phase service safety 6-5
Reports
accounting 7-1
System Management
Version 11.1
Routes
adding to simulation engine 5-7
adding to user interface 5-11
Routines
user 3-4
Running
accounting program 7-4
MMTBS 4-7, 4-16, 4-20
Rupture disks 6-8
S
Scalar parameters 4-16
SDF files
creating custom 3-9
Simulation engine
adding models, routes, property methods 5-7
command line qualifiers 2-9
processes for running 2-2
system files 2-4
Simulation run files 2-5
Standard physical property method table B-29
Subordinate property route table B-25
parameters B-26
System configuration 2-1
System definition files 1-3, 3-13
installing 5-5
running report system 3-10
updating 3-15
System files
simulation engine 2-4
user interface 2-4
System overview 2-1
System shared libraries
building 3-7
Windows 3-7
T
Table building system
converting files 3-17
customization files 5-3, B-1
file descriptions B-1
file types 3-15
files, creating from customization files 5-4, B-1
program 3-14
running 3-12, 5-5
system definition files 3-13
updating system definition files 3-15
Table-of-contents file for Help
building A-9
U
Units conversion
flags B-10
formulas B-10
Upgrading Aspen Plus 1-1
Upgrading user interface files 1-2
Upward compatibility
maintaining 1-4
User databanks
adding 4-1
User interface
adding models, routes, property methods 5-11
creating databank files 4-4
customizing A-1
running customization system A-10
system files 2-4
testing changes in 4-16
upgrading 1-2
User routines
compiling 3-4
converting 3-9
debugging on Windows 3-5
maintaining 3-4
User-based accounting report 7-2
V
Valves
liquid service safety relief 6-2
Vents
emergency relief 6-12
W
Wilson binary parameters 4-15
System Management
Version 11.1