ICapeThermoMaterialGetOverallProp Method

[DispIdAttribute(4)]
void GetOverallProp(
	string property,
	string basis,
	out Object results
)

<DispIdAttribute(4)>
Sub GetOverallProp ( 
	property As String,
	basis As String,
	<OutAttribute> ByRef results As Object
)

Parameters

property  String

A String identifier of the Physical Property for which values are requested. This must be one of the single-phase Physical Properties or derivatives that can be stored for the overall mixture. The standard identifiers are listed in sections 7.5.5 and 7.6.

basis  String

A String indicating the basis of the results. Valid settings are: “Mass” for Physical Properties per unit mass or “Mole” for molar properties. Use UNDEFINED as a place holder for a Physical Property for which basis does not apply. See section 7.5.5 for details.

results  Object

A double array containing the results vector of Physical Property value(s) in SI units.

The Physical Property values returned by GetOverallProp refer to the overall mixture. These values are set by calling the SetOverallProp method. Overall mixture Physical Properties are not calculated by components that implement the ICapeThermoMaterial interface. The property values are only used as input specifications for the CalcEquilibrium method of a component that implements the ICapeThermoEquilibriumRoutine interface.

It is expected that this method will normally be able to provide Physical Property values on any basis, i.e. it should be able to convert values from the basis on which they are stored to the basis requested. This operation will not always be possible. For example, if the molecular weight is not known for one or more Compounds, it is not possible to convert between a mass basis and a molar basis.

Although the result of some calls to GetOverallProp will be a single value, the return type is CapeArrayDouble and the method must always return an array even if it contains only a single element.

Reference