Abstract factory that provides availability of GetPot and a physics_name. More...

#include <factory_with_getpot_physics_name.h>

Inheritance diagram for GRINS::FactoryWithGetPotPhysicsName< Base >:

Collaboration diagram for GRINS::FactoryWithGetPotPhysicsName< Base >:

Public Member Functions
	FactoryWithGetPotPhysicsName (const std::string &name)

	~FactoryWithGetPotPhysicsName ()

Public Member Functions inherited from GRINS::FactoryWithGetPot< Base >
	FactoryWithGetPot (const std::string &name)

	~FactoryWithGetPot ()

Public Member Functions inherited from GRINS::FactoryAbstract< Base >
virtual	~FactoryAbstract ()

virtual libMesh::UniquePtr< Base >	create ()=0
	Subclasses implement the actual construction of the Base object in create(). More...

Static Public Member Functions
static void	set_physics_name (const std::string &physics_name)
	Setter for physics name. More...

Static Public Member Functions inherited from GRINS::FactoryWithGetPot< Base >
static void	set_getpot (const GetPot &input)

Static Public Member Functions inherited from GRINS::FactoryAbstract< Base >
static libMesh::UniquePtr< Base >	build (const std::string &name)
	Use this method to build objects of type Base. More...

Protected Member Functions
template<>
std::string	_physics_name

template<>
std::string	_physics_name

Protected Member Functions inherited from GRINS::FactoryWithGetPot< Base >
template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

template<>
const GetPot *	_input

Protected Member Functions inherited from GRINS::FactoryAbstract< Base >
	FactoryAbstract (const std::string &name)
	Constructor is protected. Use the build() method to construct Base objects. More...

template<>
std::map< std::string, FactoryAbstract< CatalycityBase > * > &	factory_map ()

template<>
std::map< std::string, FactoryAbstract< libMesh::DirichletBoundary > * > &	factory_map ()

template<>
std::map< std::string, FactoryAbstract< NeumannBCContainer > * > &	factory_map ()

template<>
std::map< std::string, FactoryAbstract< Physics > * > &	factory_map ()

template<>
std::map< std::string, FactoryAbstract< Solver > * > &	factory_map ()

template<>
std::map< std::string, FactoryAbstract< libMesh::ErrorEstimator > * > &	factory_map ()

template<>
std::map< std::string, FactoryAbstract< FEVariablesBase > * > &	factory_map ()

Static Protected Attributes
static std::string	_physics_name

Static Protected Attributes inherited from GRINS::FactoryWithGetPot< Base >
static const GetPot *	_input
	We store only a raw pointer here because we can't make a copy. More...

Additional Inherited Members
Static Protected Member Functions inherited from GRINS::FactoryAbstract< Base >
static FactoryAbstract< Base > &	get_factory (const std::string &name)
	Helper method that looks up the factory and returns it if present, or error if it's not. More...

template<typename DerivedType >
static DerivedType &	get_factory_subclass (const std::string &name)
	Like get_factory, but will downcast to DerivedType. More...

static std::map< std::string, FactoryAbstract< Base > * > &	factory_map ()

Detailed Description

template<typename Base>
class GRINS::FactoryWithGetPotPhysicsName< Base >

Abstract factory that provides availability of GetPot and a physics_name.

Definition at line 35 of file factory_with_getpot_physics_name.h.

Constructor & Destructor Documentation

template<typename Base>

GRINS::FactoryWithGetPotPhysicsName< Base >::FactoryWithGetPotPhysicsName ( const std::string & name )

inline

Definition at line 38 of file factory_with_getpot_physics_name.h.

39 : FactoryWithGetPot<Base>(name)

40 {}

template<typename Base>

GRINS::FactoryWithGetPotPhysicsName< Base >::~FactoryWithGetPotPhysicsName ( )

inline

Definition at line 42 of file factory_with_getpot_physics_name.h.

42 {};

Member Function Documentation

template<>

std::string GRINS::FactoryWithGetPotPhysicsName< Physics >::_physics_name ( )

protected

Definition at line 36 of file physics_factory_base.h.

Referenced by GRINS::FactoryWithGetPotPhysicsName< Physics >::set_physics_name().

template<>

std::string GRINS::FactoryWithGetPotPhysicsName< Physics >::_physics_name ( )

protected

Definition at line 41 of file physics_factory_base.C.

template<typename Base>

static void GRINS::FactoryWithGetPotPhysicsName< Base >::set_physics_name ( const std::string & physics_name )

inlinestatic

Setter for physics name.

We need the physics_name to pass to the constructor, so we need to provide a hook to get it. Note that this should be the "full" physics name, including suffixes, etc. Subclasses dictate final behavior, but generally, this MUST be called each time build() is called as the expected behavior is for the physics_name to be reset after the build() call.

Definition at line 51 of file factory_with_getpot_physics_name.h.

52 { _physics_name = physics_name; }

GRINS::FactoryWithGetPotPhysicsName::_physics_name

std::string _physics_name

Definition: physics_factory_base.h:36