model.capeopen()

Create constants and functions interfacing to a CAPE-OPEN compliant thermodynamics package.

Syntax

Creating a CAPE-OPEN property package feature.

model.capeopen().create(<ptag>, "PropertyPackage");

Setting and getting properties in a CAPE-OPEN property package feature:

model.capeopen().feature(<ptag>).set(<prop>, <value>);

model.capeopen().feature(<ptag>).getString(<prop>);

Table 2-12: Properties supported by CAPE-OPEN property package

Name	Type	Description
manager_id	String	CAPE-OPEN manager ID.
manager_version	String	CAPE-OPEN manager version.
package_id	String	CAPE-OPEN package ID.
package_desc	String	CAPE-OPEN package description. Only for display in GUI.

model.capeopen().feature(<ptag>).storePersistenceData();

Calling this method after a property package feature has been created, and manager_id and package_id have been set, stores information about how the CAPE-OPEN package was created in the COMSOL model. If the model is later opened on a computer with the CAPE-OPEN manager installed but without the property package, this information can be used to create the required property package.

model.capeopen().feature(<ptag>).create(<ftag>, <type>);

Creates a CAPE-OPEN constant, function, or flash calculation feature. Possible types are CompoundConstant, TemperatureDependentProperty, PressureDependentProperty, OnePhaseProperty, TwoPhaseProperty, and FlashCalculationProperty.

model.capeopen().feature(<ptag>).feature(<ftag>).set(<prop>, <value>);

model.capeopen().feature(<ptag>).feature(<ftag>).getString(<prop>);

model.capeopen().feature(<ptag>).feature(<ftag>).getStringArray(<prop>);

model.capeopen().feature(<ptag>).feature(<ftag>).getStringMatrix(<prop>);

Set and get properties in a CAPE-OPEN constant, function, or flash calculation feature.

Table 2-13: Properties supported by all CAPE-OPEN constant, function, and flash calculation features

Name	Type	Description
prop_basis	String	Basis (“mass” or “mole”) for evaluated properties. Only relevant for some properties.

model.capeopen().feature(<ptag>)).
getAllowedPropertyValues(property) returns the set of allowed values for a property if the set is a finite set of strings; otherwise, it returns null.

CAPE-OPEN Constant Features

CAPE-OPEN constant features are features with the type "CompoundConstant", and are used to define constants that get their value from a thermodynamics package.

Table 2-14: Properties supported by CAPE-OPEN constant features

Name	Type	Description
funcname	String	Name of constant; that is, a variable name that can be used in expressions.
compound	String	Identifier for compound in the CAPE-OPEN property package.
property	String	Identifier for property in the CAPE-OPEN property package.
value	String	Numerical value of constant. This value is only displayed in the GUI. When the constant is evaluated in an expression the value is obtained by calling the CAPE-OPEN property package.

CAPE-OPEN Function Features

A CAPE-OPEN function feature defines a function that can be used to evaluate properties that depend, for example, on temperature or pressure. Different types are TemperatureDependentProperty, PressureDependentProperty, OnePhaseProperty, and TwoPhaseProperty.

Table 2-15: Properties supported by CAPE-OPEN function features

Name	Type	Description
funcname	String	Name of function.
derivatives	String array	Names of partial derivatives of function.
compounds	String array	Identifiers for compounds in the CAPE-OPEN property package.
comp_basis	String	Basis (“mass” or “mole”) for amounts of compounds. Only relevant for functions of type “OnePhaseProperty” or “TwoPhaseProperty.”
property	String	Identifier for the property to evaluate in the CAPE-OPEN property package.
phase	String	Identifier for phase in the CAPE-OPEN property package. Only for features of type “OnePhaseProperty.”
phase1	String	Identifier for first phase in the CAPE-OPEN property package. Only for features of type “TwoPhaseProperty.”
phase2	String	Identifier for second phase in the CAPE-OPEN property package. Only for features of type “TwoPhaseProperty.”
args	String matrix	Names, units, and descriptions for the function arguments. Only for display in GUI.
unit	String	Unit of the function. Only for display in GUI.

Functions of type TemperatureDependentProperty and PressureDependentProperty have a single argument, which is the temperature or pressure, respectively.

Functions of type OnePhaseProperty have temperature and pressure as their first two arguments. If there is more than one compound, there are additional arguments for the fraction of each compound.

Functions of type TwoPhaseProperty have temperature and pressure as their first two arguments. If there is more than one compound, there are additional arguments for the fraction of each compound in each phase.

CAPE-OPEN Flash Calculation Features

CAPE-OPEN flash calculation features are used as an interface for flash calculations, which take amounts of different compounds and two conditions (for example, temperature and pressure) as input and compute the fraction of each compound that is present in each phase.

Table 2-16: Properties supported by CAPE-OPEN flash calculation features

Name	Type	Description
compounds	String array	Identifiers for compounds in the CAPE-OPEN property package.
cond1	String	First flash condition.
cond2	String	Second flash condition.
temperature	String	Name of function evaluating the temperature (if temperature is not one of the flash conditions).
pressure	String	Name of function evaluating the pressure (if pressure is not one of the flash conditions).
inphase	String	Base name for functions evaluating presence of each phase. Function names for each phase are formed by appending _<phase> to the base name.
amounts	String	Base name for functions evaluating amount of each phase. Function names for each phase are formed by appending _<phase> to the base name.
composition	String	Base name for functions evaluating fraction of each compound in each phase. Function names are formed by appending _<phase>_<compound> to the base name.
soltype	String	Solution type (“undefined”, “normal,” or “retrograde”).
args	String matrix	Names, units, and descriptions for the function arguments. Only for display in GUI.
phases	String array	Names of all phases. Only for display in the GUI. The phases used in the flash calculation are determined by the CAPE-OPEN property package.

Each flash calculation feature defines a number of functions. All of the functions take the values of two flash conditions as their first two arguments, followed by arguments for the total amount of each compound.

See Also

model.func()