Cantera 2.6.0

ReactorFactory.h
Go to the documentation of this file.
1//! @file ReactorFactory.h
2
3// This file is part of Cantera. See License.txt in the top-level directory or
4// at https://cantera.org/license.txt for license and copyright information.
5
6#ifndef REACTOR_FACTORY_H
7#define REACTOR_FACTORY_H
8
9#include "cantera/zeroD/ReactorBase.h"
10#include "cantera/base/FactoryBase.h"
11
12 namespace Cantera
13{
14
15//! Factory class to create reactor objects
16//!
17//! This class is mainly used via the newReactor() function, for example:
18//!
19//! ```cpp
20//! unique_ptr<ReactorBase> r1(newReactor("IdealGasReactor"));
21//! ```
22//!
23//! @ingroup ZeroD
24 class ReactorFactory : public Factory<ReactorBase>
25{
26 public:
27 static ReactorFactory* factory() {
28 std::unique_lock<std::mutex> lock(reactor_mutex);
29 if (!s_factory) {
30 s_factory = new ReactorFactory;
31 }
32 return s_factory;
33 }
34
35 virtual void deleteFactory() {
36 std::unique_lock<std::mutex> lock(reactor_mutex);
37 delete s_factory;
38 s_factory = 0;
39 }
40
41 //! Create a new reactor by type name.
42 /*!
43 * @param reactorType the type to be created.
44 */
45 virtual ReactorBase* newReactor(const std::string& reactorType);
46
47 private:
48 static ReactorFactory* s_factory;
49 static std::mutex reactor_mutex;
50 ReactorFactory();
51};
52
53//! Create a Reactor object of the specified type
54//! @ingroup ZeroD
55 inline ReactorBase* newReactor(const std::string& model)
56{
57 return ReactorFactory::factory()->newReactor(model);
58}
59
60}
61
62#endif
FactoryBase.h
File contains the FactoryBase class declarations.
ReactorBase.h
Cantera::Factory
Factory class that supports registering functions to create objects.
Definition: FactoryBase.h:70
Cantera::ReactorBase
Base class for stirred reactors.
Definition: ReactorBase.h:49
Cantera::ReactorFactory
Factory class to create reactor objects.
Definition: ReactorFactory.h:25
Cantera::ReactorFactory::newReactor
virtual ReactorBase * newReactor(const std::string &reactorType)
Create a new reactor by type name.
Definition: ReactorFactory.cpp:41
Cantera::ReactorFactory::deleteFactory
virtual void deleteFactory()
Virtual abstract function that deletes the factory.
Definition: ReactorFactory.h:35
Cantera::newReactor
ReactorBase * newReactor(const std::string &model)
Create a Reactor object of the specified type.
Definition: ReactorFactory.h:55
Cantera
Namespace for the Cantera kernel.
Definition: AnyMap.cpp:557