Matlab CAPE-OPEN Thermo Import

This Matlab package allows for importing CAPE-OPEN version 1.1 thermodynamic and physical Property Packages into Matlab. A command driven package allows for selecting a CAPE-OPEN Property Package, and then perform thermodynamic and physical property calculations as well as thermodynamic equilibrium calculations inside Matlab.

The package defines the interfaces to communicate with CAPE-OPEN thermodynamic and physical Property Packages; it does not implement the thermodynamic engine itself. To use this package, you will need to have Matlab (version 7.7 or higher) as well as a CAPE-OPEN version 1.1 compliant thermo system installed (for example, TEA which is shipped with the freely available CAPE-OPEN simulation environment COCO Simulator).

To get started with the Matlab CAPE-OPEN thermo import, type help capeOpen in Matlab after installation.

An example:

» handle=capeOpenGetPackage('TEA (CAPE-OPEN 1.1)','C1_C2');
» %let's calculate and plot the phase envelope at 1 atm for this system
» frac=0:0.05:1;
» X=[frac' 1-frac']

X =

         0    1.0000
    0.0500    0.9500
    0.1000    0.9000
    0.1500    0.8500
    0.2000    0.8000
    0.2500    0.7500
    0.3000    0.7000
    0.3500    0.6500
    0.4000    0.6000
    0.4500    0.5500
    0.5000    0.5000
    0.5500    0.4500
    0.6000    0.4000
    0.6500    0.3500
    0.7000    0.3000
    0.7500    0.2500
    0.8000    0.2000
    0.8500    0.1500
    0.9000    0.1000
    0.9500    0.0500
    1.0000         0

» P=101325;
» tbub=capeOpenEquilibriumProp(handle,'temperature',X,'pressure',P,'vaporFraction',0);
» tdew=capeOpenEquilibriumProp(handle,'temperature',X,'pressure',P,'vaporFraction',1);
» plot(frac,[tdew tbub])

Requirements

Matlab CAPE-OPEN Thermo Import will function with CAPE-OPEN version 1.1 compliant thermodynamic Property Package Managers and stand-alone Property Packages. Note that the ThermoSystemAdapter can be used to convert CAPE-OPEN version 1.0 compliant Thermo Systems to CAPE-OPEN version 1.1.

Matlab version 7.7 or higher, must be installed and running at your system. Matlab CAPE-OPEN Thermo Import has been tested with Matlab versions 7.7, 7.8, 7.9, 7.10, 7.11, 7.12, 7.13, 7.14, 8.0, 8.1, 8.2, 8.3, 8.4, 8.5, 8.6, 9.0, 9.1, 9.2, 9.3, 9.4, 9.5, 9.6, 9.7, 9.8, 9.9, 9.10, 9.11, 9.12, 9.13, 9.14, 23.2 and 24.1.

CAPE-OPEN/COCO
Compliant

More information

Online Help
van Baten, J.M., Rapid prototyping of unit operation models using generic tools and CAPE-OPEN, extended abstract, 6th US CAPE-OPEN conference, AIChE annual meeting, Nashville, November 2009.
Attarakih, M, Alzyodb, S., Fricke, A., Population balance modelling of pulsed packed bed extraction columns using PPBLab software, Computer Aided Chemical Engineering, Proceedings of the 27th European Symposium on Computer Aided Process Engineering – ESCAPE 27 October 1st - 5th, 2017, Barcelona

Availability

The Matlab CAPE-OPEN Thermo Import installer is available from the Downloads Page.

Matlab CAPE-OPEN Thermo Import is free of charge for personal and academic use.

For commercial use, a license fee must be paid. Licensing is on a per-person basis (and can be used on multiple computers). Commercial license fee for a perpetual license is € 400,- (if you are outside the European union or inside Spain, VAT of 21% is applicable).

For other forms of licenses, please contact info@amsterchem.com.

Please see the Downloads page for downloading the Matlab CAPE-OPEN Thermo Import installer.

Notes on the Matlab path

The RegisterWithMatlab.exe utility will - if invoked for an All Users installation - add the appropriate statements to the Matlab pathdef.m file for the CAPE-OPEN Thermo Import libraries to be loaded properly. This utility will modify C:\Program Files\Matlab\<version>\toolbox\local\pathdef.m file by default. To this it will add the C:\Program Files\Matlab CAPE-OPEN Thermo Import\.

For Windows Vista and later, a virtual store copy of pathdef.m may exist, e.g. C:\Users\<myname>\AppData\Local\VirtualStore\Program Files\MATLAB\<version>\toolbox\local\pathdef.m. In this case, the modifications made to the system copy will not affect Matlab's path and it will appear as if the path registration has failed. This situation will only occur on systems on which the user has edited the pathdef.m file.

To resolve this situation, please manually copy the added lines from the system copy of pathdef.m to the user copy.

For a Current User installation, the matlab path modification needs to be done manually. The easiest solution is to add a startup.m file to the userpath folder (type userpath in Matlab to see which folder this is). In this file, an addpath statements needs to appear which adds the Matlab CAPE-OPEN Thermo Import installation folder. The RegisterWithMatlab.exe utility will identify this folder, but will not make the changes.

Notes on x86 thermo servers

Matlab 8.6 (2015b) is the last matlab to support the win32/x86 platform; after this, only x64 is supported for Windows. The x64 version of Matlab CAPE-OPEN Thermo Import will support loading x86 thermodynamic servers. However, this cannot be done in-process and will come with a performance penalty.

If you are working with thermodynamic servers that are not (yet) available for x64 windows, perhaps consider keeping a copy of an x86 Matlab installed on your machine, if performance of your application is of importance.

Change log

Version 1.0.3

fixed sizes of return values of phase fractions and phase compositions of capeOpenEquilibrium

Version 1.0.4

calling put_simulationContext after rather than before Initialize
fixed call to Terminate for Property Packages

Version 1.0.5

corrected GetEquilibriumProp in case all no properties are to be calculated; old property list was used (answers were correct, but warnings were produced)
corrected availability of pressure derivatives of single- and two-phase properties

Version 1.0.6

corrected GetEquilibriumProp for request of multiple properties
smarter selection of default version (newest version) for registration tool

Version 1.0.7

fixed crash on failure to create property package

Version 1.0.8

compiler with newer compiler
registration tool no longer shows unsupported Matlab versions
support for x64 matlab (requires Matlab x64 7.1 or higher)
new installer (NSIS based)

Version 1.0.9

Fixed dependency of COM bridge on VC runtime libraries

Version 1.0.10

current-user installation option (allows for installation for users without administrative rights)

Version 1.0.11

disallowed basis conversions on mole number derivatives
corrected basis conversions on mole fraction derivatives

Version 1.0.12

fixed problems with uninstallation of current user install
next installation will default to single user in case only single user version is already installed

Version 1.0.13

fixed problems with result phase list of capeOpenCalcEquilibrium

Version 2.0.0.0

Compiler upgrade
Help spell checked
Code spell checked
M-files spell checked
Code signed
30 day registration-free operation allowed; after that free or commercial registration is required
Inter procedural optimization
Resolved possible memory leaks

Version 2.0.0.1

Re-established WinXP support

Version 2.0.0.2

Compiler upgrade
Fix to mass basis conversion for mole fraction derivatives

Version 2.0.0.3

Compiler upgrade
Changed default installation folder for current user

Version 2.0.0.4

Compiler upgrade
Check for sum(X)=1 to avoid composition unit of measure confusion

Version 2.0.0.5

Compiler upgrade
Removed support for Matlab versions prior to 7.7
Removed support for Windows XP
Fixed problems with backward compatibility

Version 2.0.0.6

Compiler upgrade
Added ability to enter registration code as argument to capeOpenAbout

Version 2.0.0.7

Compiler upgrade
Work-around 2023.2 read-only flag on pathdef.m
No longer using MexW sub-folder
File naming defaults to 64 bit systems (using x86 postfix rather than x64 postfix)