Factory for kinetics managers. More...
#include <KineticsFactory.h>
Public Member Functions | |
| virtual void | deleteFactory () |
| Virtual abstract function that deletes the factory. More... | |
| virtual Kinetics * | newKinetics (XML_Node &phase, std::vector< ThermoPhase * > th) |
| Return a new kinetics manager that implements a reaction mechanism specified in a CTML file. More... | |
| virtual Kinetics * | newKinetics (const std::string &model) |
| Return a new, empty kinetics manager. More... | |
 Public Member Functions inherited from Factory< Kinetics > | |
| Kinetics * | create (const std::string &name, Args... args) |
| Create an object using the object construction function corresponding to "name" and the provided constructor arguments. More... | |
| void | reg (const std::string &name, std::function< Kinetics *(Args...)> f) |
| Register a new object construction function. More... | |
| void | addAlias (const std::string &original, const std::string &alias) |
| Add an alias for an existing registered type. More... | |
| std::string | canonicalize (const std::string &name) |
| Get the canonical name registered for a type. More... | |
| bool | exists (const std::string &name) const |
Returns true if name is registered with this factory. More... | |
| Public Member Functions inherited from FactoryBase | |
| virtual | ~FactoryBase () |
| destructor More... | |
Static Public Member Functions | |
| static KineticsFactory * | factory () |
| Static Public Member Functions inherited from FactoryBase | |
| static void | deleteFactories () |
| static function that deletes all factories in the internal registry maintained in a static variable More... | |
Static Private Attributes | |
| static KineticsFactory * | s_factory = 0 |
| static std::mutex | kinetics_mutex |
Additional Inherited Members | |
| Protected Member Functions inherited from Factory< Kinetics > | |
| void | addDeprecatedAlias (const std::string &original, const std::string &alias) |
| Add a deprecated alias for an existing registered type. More... | |
| Protected Member Functions inherited from FactoryBase | |
| FactoryBase () | |
| Constructor. More... | |
Detailed Description
Factory for kinetics managers.
Definition at line 29 of file KineticsFactory.h.
Member Function Documentation
◆ deleteFactory()
|
inlinevirtual |
Virtual abstract function that deletes the factory.
This must be properly defined in child objects.
Implements FactoryBase.
Definition at line 40 of file KineticsFactory.h.
◆ newKinetics() [1/2]
|
virtual |
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.
- Parameters
-
phase 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 reaction mechanism. th Vector of phases. The first phase is the phase in which the reactions occur, and the subsequent phases (if any) are e.g. bulk phases adjacent to a reacting surface.
- Returns
- Pointer to the new kinetics manager.
- Deprecated:
- The XML input format is deprecated and will be removed in Cantera 3.0.
Definition at line 23 of file KineticsFactory.cpp.
References XML_Node::child(), Cantera::importKinetics(), and Cantera::newKinetics().
◆ newKinetics() [2/2]
|
virtual |
Return a new, empty kinetics manager.
Definition at line 50 of file KineticsFactory.cpp.
References Cantera::toLowerCopy().
The documentation for this class was generated from the following files:
