ReactionSet Class

Definition

Namespace: DWSIM.Thermodynamics.BaseClasses
Assembly: DWSIM.Thermodynamics (in DWSIM.Thermodynamics.dll) Version: 10.0.0.0
C#Request Example
[SerializableAttribute]
[ComVisibleAttribute(true)]
public class ReactionSet : ICloneable, 
	ICustomXMLSerialization, ICapeIdentification, ICapeUtilities, ICapeCollection, ICapeReactionsRoutine, 
	ICapeReactionChemistry, ICapeThermoContext, ICapeKineticReactionContext, ICapeReactionProperties, ICapeThermoMaterialContext, 
	IReactionSet
Inheritance
Object    ReactionSet
Implements
ICapeCollection, ICapeIdentification, ICapeKineticReactionContext, ICapeReactionChemistry, ICapeReactionProperties, ICapeReactionsRoutine, ICapeThermoContext, ICapeThermoMaterialContext, ICapeUtilities, ICustomXMLSerialization, IReactionSet, ICloneable

Constructors

ReactionSet Initializes a new empty instance of the ReactionSet class.
ReactionSet(String, String, String) Initializes a new instance of the ReactionSet class with the specified ID, name, and description.

Properties

ComponentDescriptionGets or sets the CAPE-OPEN component description for this reaction set.
ComponentNameGets or sets the CAPE-OPEN component name for this reaction set.
DescriptionGets or sets the text description for this reaction set.
IDGets or sets the unique identifier for this reaction set.
NameGets or sets the name of this reaction set.
parametersGets the CAPE-OPEN parameter collection associated with this reaction package.
ReactionsGets the dictionary of reaction set entries, keyed by reaction ID.
simulationContextSets the CAPE-OPEN simulation context (flowsheet) for this reaction package.

Methods

CalcReactionProp The Reactions Package is passed a list of reaction properties to be calculated.
Clone Creates a deep copy of this reaction set with a new unique ID.
Count Returns the number of parameters in the CAPE-OPEN parameter collection.
DisableReaction Disables a reaction so it is inactive in calculations within this reaction set.
Edit Opens the CAPE-OPEN editor UI for this reaction package. Not implemented.
EnableReaction Enables a reaction so it is active in calculations within this reaction set.
GetBaseReactant Returns the name of the base reactant for a particular reaction.
GetIDbyName Returns the reaction ID corresponding to the given reaction name within the flowsheet.
GetNumberOfReactionCompounds Gets the number of compounds occurring in a particular reaction within a Reactions Package.
GetNumberOfReactions Gets the number of reactions contained in the Reactions Package.
GetPhaseCompounds Returns the number and ids of the compounds in the specified phase.
GetReactionCompoundIds Get the identifiers of the components participating in the specified reaction within the reaction set defined in the Reactions Package.
GetReactionConcBasis Gets the concentration basis required that will be used by a particular reaction in its rate equation. Qualifiers defined in the THRM spec can be used here (i.e. “fugacity”, “moleFraction”, etc)
GetReactionParameters Returns a collection containing the rate expression parameters for a particular reaction.
GetReactionPhase Gets the phase on which a particular reaction contained in the Reactions Package will take place.
GetReactionProp Gets the value of the specified reaction property within a reactions object.\
GetReactionRateBasis Gets the phase on which the reactions contained in the package will take place.
GetReactionsIds Returns the identifiers of all the reactions contained within the Reactions Package.
GetReactionType Returns the type of a particular reaction contained in the Reactions Package.
GetStoichiometricCoefficients Returns the stoichiometric coefficients of the specified reaction (positive numbers indicate products, negative numbers indicate reactants)
Initialize Initializes the CAPE-OPEN parameter collection for this reaction package.
Item Returns the parameter at the specified index or with the specified name from the CAPE-OPEN parameter collection.
LoadData Loads reaction set data from a list of XML elements.
ObjectCopy Performs a binary serialization-based deep copy of a ReactionSet object.
SaveData Saves reaction set data to a list of XML elements for serialization.
SetMaterial Associates a material stream with this reaction package for thermodynamic context.
SetMaterial1 Associates a material stream with this reaction package via the ICapeThermoMaterialContext interface.
SetReactionObject Sets the kinetic reaction object used during CAPE-OPEN rate calculations.
SetReactionProp Sets the values of the specified reaction property within a reactions object. The qualifiers passed in determine the reactions, phase and calculation basis for which the property will be got
SetReactionRank Sets the priority rank of a reaction within this reaction set.
Terminate Terminates and cleans up the CAPE-OPEN reaction package. No action required.
ToString Returns the reaction set name, or the default object string if the name is empty.
(Overrides ObjectToString)
UnsetMaterial Dissociates the current material stream from this reaction package.

Fields

Extension Methods

GetEnumNames
(Defined by General)
IsValidDouble
(Defined by General)

See Also