getAggregationState

getAggregationState obtains a number identifying the aggregation state of a given phase name. Can be used in conjunction with getFeedEquilibrium or getEquilibrium to check the phases returned in thermodynamic equilibrium.

Syntax

Arguments:

phaseName
String; name of the phase to check. Defined phases depend on the underlying thermodynamic system.

Returns:

stateID
Integer; identifier for the aggregation state. The following identifiers are defined:

//definition of phase constants
AGGSTATE_UNKNOWN=0;
AGGSTATE_VAPOR=1;
AGGSTATE_LIQUID=2;
AGGSTATE_SOLID=3;

Example

» getAggregationState('liquid')==AGGSTATE_LIQUID

ans =

     1

» getAggregationState('liquid')==AGGSTATE_VAPOR

ans =

     0