MaterialStreamSetSinglePhaseProp Method

Request Example View Source

Parameters

property  String

The identifier of the property for which values are set. This must be one of the single-phase properties or derivatives. The standard identifiers are listed in sections 7.5.5 and 7.6.

phaseLabel  String

Phase label of the Phase for which the property is set. The phase label must be one of the strings returned by the GetPhaseList method of the ICapeThermoPhases interface.

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 (CapeArrayDouble) or CapeInterface (see notes).

Implements

ICapeThermoMaterial.SetSinglePhaseProp(String, String, String, Object)

The values argument of SetSinglePhaseProp is either a CapeArrayDouble that contains one or more numerical values to be set for a property, e.g. temperature, or a CapeInterface that may be used to set single-phase properties described by a more complex data structure, e.g. distributed properties. It is required that a component that implements the ICapeThermoMaterial interface will always support the following properties: temperature, pressure, fraction, phaseFraction, flow, totalFlow. Although some properties set by calls to SetSinglePhaseProp will have a single numerical value, the type of the values argument for numerical values is CapeArrayDouble and in such a case the method must be called with values containing an array even if it contains only a single element. The property values set by SetSinglePhaseProp refer to a single Phase. Properties that depend on more than one Phase, for example surface tension or K-values, are set by the SetTwoPhaseProp method of the ICapeThermoMaterial Interface. To set a property using SetSinglePhaseProp, a phaseLabel identifier should be passed that is supported by the Property Package or Material Object, i.e. one that appears in the list returned by the GetPhaseList method of the ICapeThermoPhases interface. Setting such a property should cause the phase to be present on the Material Object, as if it were specified in a call to SetPresentPhases with status Cape_UnknownPhaseStatus. The SetPresentPhases method of this interface does not need to be called before calling SetSinglePhaseProp.