ERF_FireEngineRegistry.cpp File Reference

#include <ERF_FireEngineRegistry.H>
#include <AMReX.H>
#include <algorithm>
#include <map>

Include dependency graph for ERF_FireEngineRegistry.cpp:

Functions
bool	register_fire_engine (const std::string &name, FireEngineCreator creator)
	Add an engine to the registry; aborts on a name registered twice. More...
std::vector< std::string >	fire_engine_names ()
	Names erf.fire.engine accepts, sorted; empty when no engine is compiled in. More...
std::unique_ptr< FireEngine >	make_fire_engine (const std::string &name, const FireCouplingParams &params)
	The engine erf.fire.engine names, or nullptr when no engine has that name. More...

Function Documentation

fire_engine_names()

std::vector<std::string> fire_engine_names

(

)

Names erf.fire.engine accepts, sorted; empty when no engine is compiled in.

{
    std::vector<std::string> names;
    for (const auto& kv : fire_engine_registry()) { names.push_back(kv.first); }
    return names;   // std::map keeps them sorted
}

Referenced by FireCouplingParams::read().

Here is the caller graph for this function:

make_fire_engine()

std::unique_ptr<FireEngine> make_fire_engine	(	const std::string &	name,
		const FireCouplingParams &	params
	)

The engine erf.fire.engine names, or nullptr when no engine has that name.

{
    const auto& registry = fire_engine_registry();
    const auto it = registry.find(name);
    if (it == registry.end()) { return nullptr; }
    return it->second(params);
}

Referenced by ERF::initializeFire().

Here is the caller graph for this function:

register_fire_engine()

bool register_fire_engine	(	const std::string &	name,
		FireEngineCreator	creator
	)

Add an engine to the registry; aborts on a name registered twice.

Called by ERF_REGISTER_FIRE_ENGINE; returns true so the macro can hold the result in a static variable.

{
    auto& registry = fire_engine_registry();
    if (name.empty()) {
        amrex::Abort("[FIRE] ERF_REGISTER_FIRE_ENGINE: an engine registered an empty name");
    }
    if (registry.count(name) > 0) {
        amrex::Abort("[FIRE] ERF_REGISTER_FIRE_ENGINE: two engines registered the name \"" + name
                     + "\"; each engine directory in the build must use its own name");
    }
    registry.emplace(name, std::move(creator));
    return true;
}