Cantera  4.0.0a1
Loading...
Searching...
No Matches
ReactorSurfaceFactory Class Reference

Factory class to create ReactorSurface objects. More...

#include <ReactorFactory.h>

Inheritance diagram for ReactorSurfaceFactory:
[legend]

Detailed Description

Factory class to create ReactorSurface objects.

This class is mainly used via the newReactorSurface() function, for example:

shared_ptr<ReactorSurface> rsurf1 = newReactorSurface(
surf_phase, {reactor1, reactor2});
@tem
shared_ptr< ReactorSurface > newReactorSurface(shared_ptr< Solution > phase, const vector< shared_ptr< ReactorBase > > &reactors, bool clone, const string &name)
Create a ReactorSurface object with the specified contents and adjacent reactors participating in sur...

Definition at line 47 of file ReactorFactory.h.

Public Member Functions

void deleteFactory () override
 Virtual abstract function that deletes the factory.
 
- Public Member Functions inherited from Factory< ReactorSurface, shared_ptr< Solution >, const vector< shared_ptr< ReactorBase > > &, bool, const string & >
ReactorSurfacecreate (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< ReactorSurface *(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 ReactorSurfaceFactoryfactory ()
 
- 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 ReactorSurfaceFactorys_factory = 0
 
static std::mutex s_mutex
 

Additional Inherited Members

- Protected Member Functions inherited from Factory< ReactorSurface, shared_ptr< Solution >, const vector< shared_ptr< ReactorBase > > &, bool, const string & >
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

◆ ReactorSurfaceFactory()

ReactorSurfaceFactory ( )
private

Definition at line 116 of file ReactorFactory.cpp.

Member Function Documentation

◆ factory()

ReactorSurfaceFactory * factory ( )
static

Definition at line 102 of file ReactorFactory.cpp.

◆ deleteFactory()

void deleteFactory ( )
overridevirtual

Virtual abstract function that deletes the factory.

This must be properly defined in child objects.

Implements FactoryBase.

Definition at line 110 of file ReactorFactory.cpp.

Member Data Documentation

◆ s_factory

ReactorSurfaceFactory * s_factory = 0
staticprivate

Definition at line 57 of file ReactorFactory.h.

◆ s_mutex

std::mutex s_mutex
staticprivate

Definition at line 58 of file ReactorFactory.h.


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