ReactorFactory.h

Go to the documentation of this file.

//! @file ReactorFactory.h
 
// This file is part of Cantera. See License.txt in the top-level directory or
// at https://cantera.org/license.txt for license and copyright information.
 
#ifndef REACTOR_FACTORY_H
#define REACTOR_FACTORY_H
 
#include "cantera/zeroD/ReactorBase.h"
#include "cantera/base/FactoryBase.h"
 
namespace Cantera
{
 
//! Factory class to create reactor objects
//!
//! This class is mainly used via the newReactor() function, for example:
//!
//! ```cpp
//!     shared_ptr<ReactorBase> r1 = newReactor("IdealGasReactor");
//! ```
class ReactorFactory : public Factory<ReactorBase, shared_ptr<Solution>, const string&>
{
public:
    static ReactorFactory* factory();
 
    void deleteFactory() override;
 
private:
    static ReactorFactory* s_factory;
    static std::mutex reactor_mutex;
    ReactorFactory();
};
 
//! @defgroup reactorGroup Reactors
//! Zero-dimensional objects representing stirred reactors.
//! Reactors simulate time-dependent behavior considering gas-phase chemistry.
//! Reactor objects should be instantiated via the newReactor() function, for example:
//!
//! ```cpp
//!     shared_ptr<ReactorBase> r1 = newReactor("IdealGasReactor");
//! ```
//! @ingroup zerodGroup
//! @{
 
//! Create a Reactor object of the specified type
//! @since Starting in %Cantera 3.1, this method returns a `shared_ptr<ReactorBase>`
//! @deprecated Transitional method. Use newReactor() with contents instead.
shared_ptr<ReactorBase> newReactor(const string& model);
 
//! Create a Reactor object of the specified type and contents
//! @since New in %Cantera 3.1.
shared_ptr<ReactorBase> newReactor(
    const string& model, shared_ptr<Solution> contents, const string& name="(none)");
 
//! Create a Reactor object of the specified type
//! @since New in %Cantera 3.0.
//! @deprecated Transitional method. Use newReactor() instead.
shared_ptr<ReactorBase> newReactor3(const string& model);
 
//! @}
 
}
 
#endif