Cape Thermo Material WrapperGet TDependent Property Method
Definition
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
private void GetTDependentProperty(
string[] props,
double temperature,
string[] compIds,
ref double[] propVals
)Private Sub GetTDependentProperty (
props As String(),
temperature As Double,
compIds As String(),
ByRef propVals As Double()
)Parameters
- props String
- The list of Physical Property identifiers. Valid identifiers for temperature-dependent Physical Properties are listed in section 7.5.3
- temperature Double
- Temperature (in K) at which properties are evaluated.
- compIds String
- List of Compound identifiers for which Physical Properties are to be retrieved. Set compIds = UNDEFINED to denote all Compounds in the component that implements the ICapeThermoCompounds interface .
- propVals Double
- Physical Property values for the Compounds specified.
Remarks
The GetTDependentPropList method can be used in order to check which Physical Properties are available.
If the number of requested Physical Properties is P and the number of Compounds is C, the propvals array will contain C*P values. The first C will be the values for the first requested Physical Property followed by C values for the second Physical Property, and so on.
Properties are returned in a fixed set of units as specified in section 7.5.3.
If the compIds argument is set to UNDEFINED this is a request to return property values for all compounds in the component that implements the ICapeThermoCompounds interface with the compound order the same as that returned by the GetCompoundList method. For example, if the interface is implemented by a Property Package component the property request with compIds set to UNDEFINED means all compounds in the Property Package rather than all compounds in the Material Object passed to the Property package.
If any Physical Property is not available for one or more Compounds, then undefined values must be returned for those combinations and an ECapeThrmPropertyNotAvailable exception must be raised. If the exception is raised, the client should check all the values returned to determine which is undefined.
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 exception should be raised if no Compounds or no Physical Properties are supported. |
| ECapeLimitedImpl | One or more Physical Properties are not supported by the component that implements this interface. This exception should also be raised (rather than ECapeInvalidArgument) if any element of the props argument is not recognised since the list of properties in section 7.5.3 is not intended to be exhaustive and an unrecognised Physical Property identifier may be valid. If no properties at all are supported ECapeNoImpl should be raised (see above). |
| ECapeInvalidArgument | To be used when an invalid argument value is passed, for example UNDEFINED for argument props. |
| ECapeOutOfBounds | The value of the temperature is outside of the range of values accepted by the Property Package. |
| ECapeThrmPropertyNotAvailable | At least one item in the properties list is not available for a particular compound. |
| ECapeUnknown | The error to be raised when other error(s), specified for the operation, are not suitable. |
| ECapeBadInvOrder | The error to be raised if the Property Package required the SetMaterial method to be called before calling the GetTDependentProperty method. The error would not be raised when the GetTDependentProperty method is implemented by a Material Object. |