MaterialStreamCheckTwoPhasePropSpec Method

Request Example View Source

Parameters

property  String

The identifier of the property to check. To be valid this must be one of the supported two-phase properties (including derivatives), as given by the GetTwoPhasePropList method.

phaseLabels  Object

Phase labels of the Phases for which the properties are to be calculated. The Phase labels must be two of the identifiers returned by the GetPhaseList method on the ICapeThermoPhases interface.

Return Value

Boolean
Set to True if the combination of property and phaseLabels is supported, or False if not supported.

Implements

ICapeThermoPropertyRoutine.CheckTwoPhasePropSpec(String, Object)

The result of the check should only depend on the capabilities and configuration (Compounds and Phases supported) of the component that implements the ICapeThermoPropertyRoutine interface (e.g. a Property Package). It should not depend on whether a Material Object has been set nor on the state (temperature, pressure, composition etc.), or configuration of a Material Object that might be set. It is expected that the PME, or other client, will use this method to check whether the properties it requires are supported by the Property Package when the Property Package is imported. If any essential properties are not available, the import process should be aborted. If either the property argument or the values in the phaseLabels arguments are not recognised by the component that implements the ICapeThermoPropertyRoutine interface this method should return False.