PropertyPackageGetPhaseInfo Method

Request Example View Source

Parameters

phaseLabel  String

A (single) Phase label. This must be one of the values returned by GetPhaseList method.

phaseAttribute  String

One of the Phase attribute identifiers from the table below.

Return Value

Object
The value corresponding to the Phase attribute identifier – see table below.

Implements

ICapeThermoPhases.GetPhaseInfo(String, String)

GetPhaseInfo is intended to allow a PME, or other client, to identify a Phase with an arbitrary label. A PME, or other client, will need to do this to map stream data into a Material Object, or when importing a Property Package. If the client cannot identify the Phase, it can ask the user to provide a mapping based on the values of these properties. The list of supported Phase attributes is defined in the following table: Phase attribute identifier Supported values StateOfAggregation One of the following strings: Vapor Liquid Solid Unknown KeyCompoundId The identifier of the Compound (compId as returned by GetCompoundList) that is expected to be present in highest concentration in the Phase. May be undefined in which case UNDEFINED should be returned. ExcludedCompoundId The identifier of the Compound (compId as returned by GetCompoundList) that is expected to be present in low or zero concentration in the Phase. May not be defined in which case UNDEFINED should be returned. DensityDescription A description that indicates the density range expected for the Phase. One of the following strings or UNDEFINED: Heavy Light UserDescription A description that helps the user or PME to identify the Phase. It can be any string or UNDEFINED. TypeOfSolid A description that provides more information about a solid Phase. For Phases with a “Solid” state of aggregation it may be one of the following standard strings or UNDEFINED: PureSolid SolidSolution HydrateI HydrateII HydrateH Other values may be returned for solid Phases but these may not be understood by most clients. For Phases with any other state of aggregation it must be UNDEFINED.