Cape
A wrapper class for the ICapeThermoMaterial interface.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
[ComVisibleAttribute(false)]
public class CapeThermoMaterialWrapperVB
<ComVisibleAttribute(false)>
Public Class CapeThermoMaterialWrapper- Inheritance
- Object CapeThermoMaterialWrapper
Remarks
This class provides access to the Material Object, whhich is a container
of information that describes a Material stream.
Calculations of thermophysical and thermodynamic properties are performed by a
Property Package using information stored in a Material Object. Results of such
calculations may be stored in the Material Object for further usage. The
ICapeThermoMaterial interface provides the methods to gather information and
perform checks in preparation for a calculation, to request a calculation and
to retrieve results and information stored in the Material Object.
Constructors
| CapeThermoMaterialWrapper | Creates an instance of the CapeThermoMaterialWrapper class for the material specificed. |
Methods
| CalcAndGetLnPhi | This method is used to calculate the natural logarithm of the fugacity coefficients (and optionally their derivatives) in a single Phase mixture. The values of temperature, pressure and composition are specified in the argument list and the results are also returned through the argument list. |
| CalcEquilibrium | CalcEquilibrium is used to calculate the amounts and compositions of Phases at equilibrium. CalcEquilibrium will calculate temperature and/or pressure if these are not among the two specifications that are mandatory for each Equilibrium Calculation considered. |
| CalcSinglePhaseProp | CalcSinglePhaseProp is used to calculate properties and property derivatives of a mixture in a single Phase at the current values of temperature, pressure and composition set in the Material Object. CalcSinglePhaseProp does not perform phase Equilibrium Calculations. |
| CalcTwoPhaseProp | CalcTwoPhaseProp is used to calculate mixture properties and property derivatives that depend on two Phases at the current values of temperature, pressure and composition set in the Material Object. It does not perform Equilibrium Calculations. |
| CheckEquilibriumSpec | Checks whether the Property Package can support a particular type of Equilibrium Calculation. |
| CheckSinglePhasePropSpec | Checks whether it is possible to calculate a property with the CalcSinglePhaseProp method for a given Phase. |
| CheckTwoPhasePropSpec | Checks whether it is possible to calculate a property with the CalcTwoPhaseProp method for a given set of Phases. |
| ClearAllProps | Remove all stored Physical Property values. |
| CopyFromMaterial | Copies all the stored non-constant Physical Properties (which have been set using the SetSinglePhaseProp, SetTwoPhaseProp or SetOverallProp) from the source Material Object to the current instance of the Material Object. |
| CreateMaterial | Creates a Material Object with the same configuration as the current Material Object. |
| Dispose | |
| GetCompoundConstant | Returns the values of constant Physical Properties for the specified Compounds. |
| GetCompoundList | Returns the list of all Compounds. This includes the Compound identifiers recognised and extra information that can be used to further identify the Compounds. |
| GetConstPropList | Returns the list of supported constant Physical Properties. |
| GetNumCompounds | Returns the number of Compounds supported. |
| GetNumPhases | Returns the number of Phases. |
| GetOverallProp | Retrieves non-constant Physical Property values for the overall mixture. |
| GetOverallTPFraction | Retrieves temperature, pressure and composition for the overall mixture. |
| GetPDependentProperty | Returns the values of pressure-dependent Physical Properties for the specified pure Compounds. |
| GetPDependentPropList | Returns the list of supported pressure-dependent properties. |
| GetPhaseInfo | Returns information on an attribute associated with a Phase for the purpose of understanding what lies behind a Phase label. |
| GetPhaseList | Returns Phase labels and other important descriptive information for all the Phases supported. |
| GetPresentPhases | Returns Phase labels for the Phases that are currently present in the Material Object. |
| GetSinglePhaseProp | Retrieves single-phase non-constant Physical Property values for a mixture. |
| GetSinglePhasePropList | Returns the list of supported non-constant single-phase Physical Properties. |
| GetTDependentProperty | Returns the values of temperature-dependent Physical Properties for the specified pure Compounds. |
| GetTDependentPropList | Returns the list of supported temperature-dependent Physical Properties. |
| GetTPFraction | Retrieves temperature, pressure and composition for a Phase. |
| GetTwoPhaseProp | Retrieves two-phase non-constant Physical Property values for a mixture. |
| GetTwoPhasePropList | Returns the list of supported non-constant two-phase properties. |
| GetUniversalConstant | Retrieves the value of a Universal Constant. |
| GetUniversalConstantList | Returns the identifiers of the supported Universal Constants. |
| SetOverallProp | Sets non-constant property values for the overall mixture. |
| SetPresentPhases | Allows the PME or the Property Package to specify the list of Phases that are currently present. |
| SetSinglePhaseProp | Sets single-phase non-constant property values for a mixture. |
| SetTwoPhaseProp | Sets two-phase non-constant property values for a mixture. |
Fields
Extension Methods
| GetEnumNames | (Defined by General) |
| IsValidDouble | (Defined by General) |