ICapeReactionChemistryGetReactionParameters Method

[DispIdAttribute(12)]
Object GetReactionParameters(
	string reacId
)

<DispIdAttribute(12)>
Function GetReactionParameters ( 
	reacId As String
) As Object

Parameters

reacId  String

The name of the reaction obtained from the GetReactionsIds method.

Return Value

GetReactionParameters returns a collection of CAPE-OPEN parameters [6] that characterize the rate expression used by the reaction model in a Reaction Package. For a PowerLaw model this collection would contain parameters for activation energy, pre-exponential factor and compound exponents for example. It is up to the Reactions Package implementor to decide whether a client can update the values of these parameters. If this operation is allowed, then the implementor must also provide support for persistence [5] interfaces, so that the updated values can be saved and restored. In this case the COSE is also responsible for calling the persistence methods.

Deliberately, the standard does not define the names of the parameters that may appear in such a collection, even for well-known reaction models, such as PowerLaw and Langmuir – Hinshelwood – Hougen – Watson (LHHW). This is because the formulation of well-known models is not fixed, and because the standard needs to support custom models as well as the well-known models.

This decision is not expected to be restrictive: in most cases the (software) client of a Reactions Package does not need to know what model the package implements and what parameters it has. However, the parameters may be of interest to an end-user who wants to adjust or estimate the parameter values. In these cases the COSE can invoke the Reaction Package’s own GUI, or, if it doesn’t have one, present the parameters in a generic grid. It is the Reaction Package implementor’s responsibility to provide documentation for the parameters so that an enduser can understand how they are used.

Reference