ICape
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(8)]
void CalcEquilibrium(
string flashType,
Object props
)VB
<DispIdAttribute(8)>
Sub CalcEquilibrium (
flashType As String,
props As Object
)Parameters
- flashType String
- The type of flash to be calculated.
- 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 System.Object containing a String array marshalled from a COM Object.
Remarks
This method is responsible for delegating flash calculations to the
associated Property Package or Equilibrium Server. 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. |
| ECapeBadInvOrder | ECapeBadInvOrder |
| ECapeSolvingError | ECapeSolvingError |
| ECapeOutOfBounds | ECapeOutOfBounds |
| ECapeLicenceError | ECapeLicenceError |