ICape Thermo Property PackageCalc Equilibrium Method
Calculate some equilibrium values
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#
[DispIdAttribute(6)]
void CalcEquilibrium(
Object materialObject,
string flashType,
Object props
)VB
<DispIdAttribute(6)>
Sub CalcEquilibrium (
materialObject As Object,
flashType As String,
props As Object
)Parameters
- materialObject Object
- The MaterialObject for the Calculation.
- flashType String
- Flash calculation type.
- props Object
- Properties to be calculated at equilibrium. emptyObject for no properties. If a list, then the property values should be set for each phase present at equilibrium. A reference to a System.Object containing a String array marshalled as a COM Object.
Remarks
Method responsible for calculating/delegating flash calculation requests. It
must set the amounts, compositions, temperature and pressure for all phases
present at equilibrium, as well as the temperature and pressure for the overall
mixture, if not set as part of the calculation specifications. See CalcProp
and CalcEquilibrium for more information.
Exceptions
| ECapeUnknown | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeInvalidArgument | To be used when an invalid argument value is passed, for example, an unrecognised Compound identifier or UNDEFINED for the props argument. |
| ECapeSolvingError | ECapeSolvingError |
| ECapeOutOfBounds | ECapeOutOfBounds |
| ECapeLicenceError | ECapeLicenceError |