ICapeReactionsRoutineCalcReactionProp Method

[DispIdAttribute(1)]
void CalcReactionProp(
	Object props,
	string phase,
	Object reacIds,
	string basis
)

<DispIdAttribute(1)>
Sub CalcReactionProp ( 
	props As Object,
	phase As String,
	reacIds As Object,
	basis As String
)

Parameters

props  Object

The Reaction Property to be calculated.

phase  String

The qualified phase for the results.

reacIds  Object

The qualified reactions for the Reaction Property. NULL to specify all reactions in the set.

basis  String

Qualifies the basis of the Reaction Property (i.e., mass /mole). Default is mole. Use NULL only as a placeholder for property for which basis does not apply.

Return Value

The Reactions Package is passed a list of reaction properties to be calculated, the reaction IDS for which the properties are required, and the calculation basis for the reaction properties (i.e. mole or mass). A material object containing the thermodynamic state variables that need to be used for calculating the reaction properties (e.g. T, P and compositions) is passed separately via a call to the setMaterial method of the Reaction Package’s ICapeThermoContext interface.

The results of the calculation will be written to the reaction object passed to the Reactions Package via either the ICapeKineticReactionContext interface for a kinetic reaction package, or the ICapeElectrolyteReactionContext interface for an Electrolyte Property Package.

Reference