Cantera  3.1.0a1
KineticsFactory Class Reference

Factory for kinetics managers. More...

#include <KineticsFactory.h>

Inheritance diagram for KineticsFactory:
[legend]

Detailed Description

Factory for kinetics managers.

Definition at line 21 of file KineticsFactory.h.

Public Member Functions

void deleteFactory () override
 Virtual abstract function that deletes the factory. More...
 
KineticsnewKinetics (const string &model)
 Return a new, empty kinetics manager. More...
 
- Public Member Functions inherited from Factory< Kinetics >
Kineticscreate (const string &name, Args... args)
 Create an object using the object construction function corresponding to "name" and the provided constructor arguments. More...
 
void reg (const string &name, function< Kinetics *(Args...)> f)
 Register a new object construction function. More...
 
void addAlias (const string &original, const string &alias)
 Add an alias for an existing registered type. More...
 
string canonicalize (const string &name)
 Get the canonical name registered for a type. More...
 
bool exists (const 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 KineticsFactoryfactory ()
 
- 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 KineticsFactorys_factory = 0
 
static std::mutex kinetics_mutex
 

Additional Inherited Members

- Protected Member Functions inherited from Factory< Kinetics >
void addDeprecatedAlias (const string &original, const string &alias)
 Add a deprecated alias for an existing registered type. More...
 
- Protected Member Functions inherited from FactoryBase
 FactoryBase ()
 Constructor. More...
 

Member Function Documentation

◆ deleteFactory()

void deleteFactory ( )
overridevirtual

Virtual abstract function that deletes the factory.

This must be properly defined in child objects.

Implements FactoryBase.

Definition at line 48 of file KineticsFactory.cpp.

◆ newKinetics()

Kinetics * newKinetics ( const string &  model)

Return a new, empty kinetics manager.

Definition at line 54 of file KineticsFactory.cpp.


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