GRINS::FactoryWithGetPotPhysicsName< Base > Class Template Reference

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 ()

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)

Protected Member Functions
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

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...

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.

      : FactoryWithGetPot<Base>(name)
    {}

template<typename Base>

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

inline

Definition at line 42 of file factory_with_getpot_physics_name.h.

{};

Member Function Documentation

template<>

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

protected

Definition at line 44 of file physics_factory_base.C.

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

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.

    { _physics_name = physics_name; }

Member Data Documentation

template<typename Base>

std::string GRINS::FactoryWithGetPotPhysicsName< Base >::_physics_name

staticprotected

Definition at line 56 of file factory_with_getpot_physics_name.h.

---

The documentation for this class was generated from the following file:

• src/common/include/grins/factory_with_getpot_physics_name.h