ICapeThermoEquilibriumRoutineCheckEquilibriumSpec Method

Checks whether the Property Package can support a particular type of Equilibrium Calculation.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)

[DispIdAttribute(2)]
bool CheckEquilibriumSpec(
	Object specification1,
	Object specification2,
	string solutionType
)

VBRequest Example

<DispIdAttribute(2)>
Function CheckEquilibriumSpec ( 
	specification1 As Object,
	specification2 As Object,
	solutionType As String
) As Boolean

Parameters

specification1 Object: First specification for the Equilibrium Calculation.
specification2 Object: Second specification for the Equilibrium Calculation.
solutionType String: The required solution type.

Return Value

Boolean
Set to True if the combination of specifications and solutionType is supported or False if not supported.

Remarks

The meaning of the specification1, specification2 and solutionType arguments is the same as for the CalcEquilibrium method.

The result of the check should only depend on the capabilities and configuration (compounds and phases present) of the component that implements the ICapeThermoEquilibriumRoutine interface (eg. a Property package). It should not depend on whether a Material Object has been set nor on the state (temperature, pressure, composition etc.) or configuration of a Material Object that might be set.

If solutionType, specification1 and specification2 arguments appear valid but the actual specifications are not supported or not recognised a False value should be returned.

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.
ECapeInvalidArgument	To be used when an invalid argument value is passed, for example UNDEFINED for solutionType, specification1 or specification2 argument.
ECapeUnknown	The error to be raised when other error(s), specified for this operation, are not suitable.