Cantera  3.1.0a1
Loading...
Searching...
No Matches
PreconditionerFactory Class Reference

Factory class to create preconditioner objects. More...

#include <PreconditionerFactory.h>

Inheritance diagram for PreconditionerFactory:
[legend]

Detailed Description

Factory class to create preconditioner objects.

Definition at line 17 of file PreconditionerFactory.h.

Public Member Functions

void deleteFactory () override
 Delete preconditioner factory.
 
- Public Member Functions inherited from Factory< PreconditionerBase >
PreconditionerBasecreate (const string &name, Args... args)
 Create an object using the object construction function corresponding to "name" and the provided constructor arguments.
 
void reg (const string &name, function< PreconditionerBase *(Args...)> f)
 Register a new object construction function.
 
void addAlias (const string &original, const string &alias)
 Add an alias for an existing registered type.
 
string canonicalize (const string &name)
 Get the canonical name registered for a type.
 
bool exists (const string &name) const
 Returns true if name is registered with this factory.
 
- Public Member Functions inherited from FactoryBase
virtual ~FactoryBase ()
 destructor
 

Static Public Member Functions

static PreconditionerFactoryfactory ()
 
- 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
 

Static Private Attributes

static PreconditionerFactorys_factory = 0
 
static std::mutex precon_mutex
 

Additional Inherited Members

- Protected Member Functions inherited from Factory< PreconditionerBase >
void addDeprecatedAlias (const string &original, const string &alias)
 Add a deprecated alias for an existing registered type.
 
- Protected Member Functions inherited from FactoryBase
 FactoryBase ()
 Constructor.
 
virtual void deleteFactory ()=0
 Virtual abstract function that deletes the factory.
 

Constructor & Destructor Documentation

◆ PreconditionerFactory()

PreconditionerFactory ( )
private

Definition at line 30 of file PreconditionerFactory.cpp.

Member Function Documentation

◆ factory()

PreconditionerFactory * factory ( )
static

Definition at line 12 of file PreconditionerFactory.cpp.

◆ deleteFactory()

void deleteFactory ( )
overridevirtual

Delete preconditioner factory.

Implements FactoryBase.

Definition at line 21 of file PreconditionerFactory.cpp.

Member Data Documentation

◆ s_factory

PreconditionerFactory * s_factory = 0
staticprivate

Definition at line 26 of file PreconditionerFactory.h.

◆ precon_mutex

std::mutex precon_mutex
staticprivate

Definition at line 27 of file PreconditionerFactory.h.


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