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
{
 
class Reactor;
class Reservoir;
 
//! 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>, bool, const string&>
{
public:
    static ReactorFactory* factory();
 
    void deleteFactory() override;
 
private:
    static ReactorFactory* s_factory;
    static std::mutex reactor_mutex;
    ReactorFactory();
};
 
//! Factory class to create ReactorSurface objects
//!
//! This class is mainly used via the newReactorSurface() function, for example:
//!
//! ```cpp
//!     shared_ptr<ReactorSurface> rsurf1 = newReactorSurface(
//!         surf_phase, {reactor1, reactor2});
//! @tem
//! ```
class ReactorSurfaceFactory : public Factory<ReactorSurface,
    shared_ptr<Solution> /* surface */,
    span<shared_ptr<ReactorBase>> /* adjacent reactors */,
    bool /* clone */, const string& /* name */>
{
public:
    static ReactorSurfaceFactory* factory();
    void deleteFactory() override;
 
private:
    static ReactorSurfaceFactory* s_factory;
    static std::mutex s_mutex;
    ReactorSurfaceFactory();
};
 
//! @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 ReactorBase object of the specified type and contents.
//! @since  New in %Cantera 3.2.
shared_ptr<ReactorBase> newReactorBase(
    const string& model, shared_ptr<Solution> phase, bool clone=true,
    const string& name="(none)");
 
//! Create a Reactor object of the specified type and contents
//! @param  model  Reactor type to be created. See [this list of reactor
//!     types](../reference/reactors/index.html) for available options.
//! @param phase  Solution object to model the thermodynamic properties and
//!     reactions occurring in the reactor
//! @param clone  Determines whether to clone `sol` so that the internal state of this
//!     reactor is independent of the original Solution object and any Solution objects
//!     used by other reactors in the network.
//! @param name  Name of the reactor.
//! @since  Starting in %Cantera 4.0, returns a `shared_ptr<Reactor>` instead of a
//!     `shared_ptr<ReactorBase>`.
shared_ptr<Reactor> newReactor(
    const string& model, shared_ptr<Solution> phase, bool clone=true,
    const string& name="(none)");
 
//! @copydoc newReactor
//! @deprecated Transitional method; to be removed after %Cantera 4.0.
inline shared_ptr<Reactor> newReactor4(const string& model, shared_ptr<Solution> phase,
                                bool clone=true, const string& name="(none)")
{
    return newReactor(model, phase, clone, name);
}
 
//! Create a Reservoir object with the specified contents
//! @param phase  Solution object to model the contents of this reservoir
//! @param clone  Determines whether to clone `sol` so that the internal state of this
//!     reservoir is independent of the original Solution object and any Solution
//!     objects used by other reactors in the network.
//! @param name  Name of the reservoir.
//! @since New in %Cantera 3.2.
shared_ptr<Reservoir> newReservoir(
    shared_ptr<Solution> phase, bool clone=true, const string& name="(none)");
 
//! Create a ReactorSurface object with the specified contents and adjacent reactors
//! participating in surface reactions.
//!
//! The type of the reactor surface is automatically determined based on the types of
//! the adjacent reactors.
//!
//! @param phase  Solution (Interface) object to model the thermodynamic properties
//!     and reactions occurring in the reactor
//! @param  reactors  List of Reactors adjacent to this surface, whose contents
//!     participate in reactions occurring on this surface.
//! @param clone  Determines whether to clone `sol` so that the internal state of this
//!     surface is independent of the original Interface object and any Solution objects
//!     used by other reactors in the network except those in the `reactors` list.
//! @param name  Name of the reactor surface.
//! @since  New in %Cantera 3.2.
shared_ptr<ReactorSurface> newReactorSurface(
    shared_ptr<Solution> phase, span<shared_ptr<ReactorBase>> reactors,
    bool clone=true, const string& name="(none)");
 
//! Create a ReactorSurface object with the specified contents and adjacent reactors
//! participating in surface reactions.
//! @param  model  Type of ReactorSurface to be created.
//! @param phase  Solution (Interface) object to model the thermodynamic properties
//!     and reactions occurring in the reactor
//! @param  reactors  List of Reactors adjacent to this surface, whose contents
//!     participate in reactions occurring on this surface.
//! @param clone  Determines whether to clone `sol` so that the internal state of this
//!     surface is independent of the original Interface object and any Solution objects
//!     used by other reactors in the network except those in the `reactors` list.
//! @param name  Name of the reactor surface.
//! @since  New in %Cantera 4.0.
shared_ptr<ReactorSurface> newReactorSurface(
    const string& model, shared_ptr<Solution> phase,
    span<shared_ptr<ReactorBase>> reactors,
    bool clone=true, const string& name="(none)");
 
//! @}
 
}
 
#endif