ReactorFactory.cpp

Go to the documentation of this file.

//! @file ReactorFactory.cpp
 
// 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.
 
#include "cantera/zeroD/ReactorFactory.h"
#include "cantera/zeroD/Reservoir.h"
#include "cantera/zeroD/Reactor.h"
#include "cantera/zeroD/MoleReactor.h"
#include "cantera/zeroD/FlowReactor.h"
#include "cantera/zeroD/ConstPressureReactor.h"
#include "cantera/zeroD/ConstPressureMoleReactor.h"
#include "cantera/zeroD/IdealGasReactor.h"
#include "cantera/zeroD/IdealGasMoleReactor.h"
#include "cantera/zeroD/IdealGasConstPressureReactor.h"
#include "cantera/zeroD/ReactorDelegator.h"
#include "cantera/zeroD/IdealGasConstPressureMoleReactor.h"
 
namespace Cantera
{
 
ReactorFactory* ReactorFactory::s_factory = 0;
std::mutex ReactorFactory::reactor_mutex;
 
ReactorFactory::ReactorFactory()
{
    reg("Reservoir",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new Reservoir(sol, clone, name); });
    reg("Reactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new Reactor(sol, clone, name); });
    reg("ConstPressureReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ConstPressureReactor(sol, clone, name); });
    reg("FlowReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new FlowReactor(sol, clone, name); });
    reg("IdealGasReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new IdealGasReactor(sol, clone, name); });
    reg("IdealGasConstPressureReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new IdealGasConstPressureReactor(sol, clone, name); });
    reg("ExtensibleReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ReactorDelegator<Reactor>(sol, clone, name); });
    reg("ExtensibleIdealGasReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ReactorDelegator<IdealGasReactor>(sol, clone, name); });
    reg("ExtensibleConstPressureReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ReactorDelegator<ConstPressureReactor>(sol, clone, name); });
    reg("ExtensibleIdealGasConstPressureReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ReactorDelegator<IdealGasConstPressureReactor>(sol, clone, name); });
    reg("ExtensibleMoleReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ReactorDelegator<MoleReactor>(sol, clone, name); });
    reg("ExtensibleConstPressureMoleReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ReactorDelegator<ConstPressureMoleReactor>(sol, clone, name); });
    reg("ExtensibleIdealGasMoleReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ReactorDelegator<IdealGasMoleReactor>(sol, clone, name); });
    reg("ExtensibleIdealGasConstPressureMoleReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ReactorDelegator<IdealGasConstPressureMoleReactor>(sol, clone, name); });
    reg("IdealGasConstPressureMoleReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new IdealGasConstPressureMoleReactor(sol, clone, name); });
    reg("IdealGasMoleReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new IdealGasMoleReactor(sol, clone, name); });
    reg("ConstPressureMoleReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ConstPressureMoleReactor(sol, clone, name); });
    reg("MoleReactor",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new MoleReactor(sol, clone, name); });
    // TODO: Remove after Cantera 3.2
    reg("ReactorSurface",
        [](shared_ptr<Solution> sol, bool clone, const string& name)
        { return new ReactorSurface(sol, clone, name); });
}
 
ReactorFactory* ReactorFactory::factory() {
    std::unique_lock<std::mutex> lock(reactor_mutex);
    if (!s_factory) {
        s_factory = new ReactorFactory;
    }
    return s_factory;
}
 
void ReactorFactory::deleteFactory() {
    std::unique_lock<std::mutex> lock(reactor_mutex);
    delete s_factory;
    s_factory = 0;
}
 
shared_ptr<ReactorBase> newReactorBase(
    const string& model, shared_ptr<Solution> contents, bool clone, const string& name)
{
    return shared_ptr<ReactorBase>(
        ReactorFactory::factory()->create(model, contents, clone, name));
}
 
shared_ptr<ReactorBase> newReactor(
    const string& model, shared_ptr<Solution> contents, const string& name)
{
    warn_deprecated("newReactor", "Behavior changes after Cantera 3.2, when a "
        "'shared_ptr<Reactor>' is returned.\nFor new behavior, use 'newReactor4'.");
    warn_deprecated("newReactor", "`clone` argument not specified; Default behavior "
        "will change from `clone=False` to `clone=True` after Cantera 3.2.\n"
        "Use the transitional newReactor4() function to provide a value for the clone "
        "argument");
    return newReactorBase(model, contents, false, name);
}
 
shared_ptr<Reactor> newReactor4(
    const string& model, shared_ptr<Solution> contents, bool clone, const string& name)
{
    auto reactor = std::dynamic_pointer_cast<Reactor>(
        newReactorBase(model, contents, clone, name));
    if (!reactor) {
        throw CanteraError("newReactor4",
            "Model type '{}' does not specify a bulk reactor.", model);
    }
    return reactor;
}
 
shared_ptr<Reservoir> newReservoir(
    shared_ptr<Solution> contents, bool clone, const string& name)
{
    auto reservoir = std::dynamic_pointer_cast<Reservoir>(
        newReactorBase("Reservoir", contents, clone, name));
    if (!reservoir) {
        throw CanteraError("newReservoir",
            "Caught unexpected inconsistency in factory method.");
    }
    return reservoir;
}
 
shared_ptr<ReactorSurface> newReactorSurface(shared_ptr<Solution> contents,
    const vector<shared_ptr<ReactorBase>>& reactors, bool clone, const string& name)
{
    return make_shared<ReactorSurface>(contents, reactors, clone, name);
}
 
}