Cape Thermo Material WrapperSet Overall Prop Method
Definition
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
public void SetOverallProp(
string property,
string basis,
double[] values
)Public Sub SetOverallProp (
property As String,
basis As String,
values As Double()
)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 Double
- Values to set for the property.
Remarks
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.
Exceptions
| ECapeNoImpl | The operation is “not” implemented even if this method can be called for reasons of compatibility with the CAPE-OPEN standards. That is to say that the operation exists, but it is not supported by the current implementation. This method may not be required if the PME does not deal with any single-phase property. |
| ECapeInvalidArgument | To be used when an invalid argument value was passed, that is a value that does not belong to the valid list described above, for example UNDEFINED for property. |
| ECapeOutOfBounds | One or more of the entries in the values argument is outside of the range of values accepted by the Material Object. |
| ECapeUnknown | The error to be raised when other error(s), specified for the SetSinglePhaseProp operation, are not suitable. |