ICapeThermoMaterialSetOverallProp Method

[DispIdAttribute(10)]
void SetOverallProp(
	string property,
	string basis,
	Object values
)

<DispIdAttribute(10)>
Sub SetOverallProp ( 
	property As String,
	basis As String,
	values As Object
)

Parameters

property  String

CapeString The identifier of the property for which values are set. This must be one of the single-phase 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

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.

values  Object

Values to set for the property.

The property values set by SetOverallProp refer to the overall mixture. These values are retrieved by calling the GetOverallProp method. Overall mixture 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.

Although some properties set by calls to SetOverallProp will have a single value, the type of argument values is CapeArrayDouble and the method must always be called with values as an array even if it contains only a single element.

Reference