KineticsFactory Class Reference

Factory for kinetics managers. More...

#include <KineticsFactory.h>

Inheritance diagram for KineticsFactory:

Collaboration diagram for KineticsFactory:

Public Member Functions
virtual void	deleteFactory ()
	Virtual abstract function that deletes the factory.
virtual Kinetics *	newKinetics (XML_Node &phase, std::vector< ThermoPhase * > th)
	Create a new kinetics manager.
virtual Kinetics *	newKinetics (std::string model)
	Return a new, empty kinetics manager.

Static Public Member Functions
static KineticsFactory *	factory ()
static void	deleteFactories ()
	static function that deletes all factories in the internal registry maintained in a static variable

Static Private Attributes
static KineticsFactory *	s_factory = 0
static mutex_t	kinetics_mutex

Detailed Description

Factory for kinetics managers.

Definition at line 33 of file KineticsFactory.h.

Member Function Documentation

virtual void deleteFactory ( )

inlinevirtual

Virtual abstract function that deletes the factory.

This must be properly defined in child objects.

Implements FactoryBase.

Definition at line 51 of file KineticsFactory.h.

Kinetics * newKinetics ( XML_Node &  phaseData, std::vector< ThermoPhase * >  th  )

virtual

Create a new kinetics manager.

Return a new kinetics manager that implements a reaction mechanism specified in a CTML file.

In other words, the kinetics manager, given the rate constants and formulation of the reactions that make up a kinetics mechanism, is responsible for calculating the rates of progress of the reactions and for calculating the source terms for species.

Input

phaseData = This is an XML_Node that contains the xml data describing the phase. Of particular note to this routine is the child xml element called "kinetics". The element has one attribute called "model", with a string value. The value of this string is used to decide which kinetics manager is used to calculate the reacton mechanism.

Return

Pointer to the new kinetics manager.

Definition at line 51 of file KineticsFactory.cpp.

References XML_Node::child(), and Cantera::importKinetics().

Kinetics * newKinetics ( std::string  model )

virtual

Return a new, empty kinetics manager.

Definition at line 121 of file KineticsFactory.cpp.

static void deleteFactories ( )

inlinestaticinherited

static function that deletes all factories in the internal registry maintained in a static variable

Definition at line 28 of file FactoryBase.h.

References FactoryBase::s_vFactoryRegistry.

---

The documentation for this class was generated from the following files:

• KineticsFactory.h
• KineticsFactory.cpp