GRINS::VariableFactoryBase Class Reference

Common implementations. More...

#include <variable_factory.h>

Inheritance diagram for GRINS::VariableFactoryBase:

Collaboration diagram for GRINS::VariableFactoryBase:

Public Member Functions
	VariableFactoryBase (const std::string &name)
	~VariableFactoryBase ()
Public Member Functions inherited from GRINS::VariableFactoryAbstract
	VariableFactoryAbstract (const std::string &name)
	~VariableFactoryAbstract ()
virtual libMesh::UniquePtr< FEVariablesBase >	create ()
	Subclasses implement the actual construction of the Base object in create(). More...
Public Member Functions inherited from GRINS::FactoryWithGetPot< FEVariablesBase >
	FactoryWithGetPot (const std::string &name)
	~FactoryWithGetPot ()
Public Member Functions inherited from GRINS::FactoryAbstract< FEVariablesBase >
virtual	~FactoryAbstract ()

Protected Member Functions
virtual std::string	parse_fe_family_impl (const GetPot &input, const std::string &var_section)
virtual std::string	parse_fe_order_impl (const GetPot &input, const std::string &var_section)
Protected Member Functions inherited from GRINS::VariableFactoryAbstract
virtual void	check_create_state () const
	Helper function to check required data is set when calling create() More...
virtual void	reset_create_state ()
	Helper function to reset data before next call to create() More...
virtual libMesh::UniquePtr< FEVariablesBase >	build_fe_var (const std::vector< std::string > &var_names, const std::vector< VariableIndex > &var_indices, const std::set< libMesh::subdomain_id_type > &subdomain_ids)=0
	Subclasses implement construction of the FEVariablesBase object using the var_names and var_indices. More...
virtual std::vector< std::string >	parse_var_names (const GetPot &input, const std::string &var_section)=0
std::string	parse_var_option (const GetPot &input, const std::string &var_section, const std::string &option, const std::string &default_val) const
Protected Member Functions inherited from GRINS::FactoryAbstract< FEVariablesBase >
	FactoryAbstract (const std::string &name)
	Constructor is protected. Use the build() method to construct Base objects. More...

Additional Inherited Members
Static Public Member Functions inherited from GRINS::VariableFactoryAbstract
static std::vector< std::string >	build_var_names (const std::string &name)
	Build the variable names for the FEVariablesBase type (name), returned in the std::vector. More...
static std::string	parse_fe_family (const std::string &name)
static std::string	parse_fe_order (const std::string &name)
static void	set_var_names (const std::vector< std::string > &var_names)
	Set the variable names before calling create() More...
static void	set_var_indices (const std::vector< VariableIndex > &var_indices)
	Set the variable indices before calling create() More...
static void	set_var_section (const std::string &var_section)
	Set the section for the input file before calling build_var_names() More...
static void	set_subdomain_ids (const std::set< libMesh::subdomain_id_type > &subdomain_ids)
Static Public Member Functions inherited from GRINS::FactoryWithGetPot< FEVariablesBase >
static void	set_getpot (const GetPot &input)
Static Public Member Functions inherited from GRINS::FactoryAbstract< FEVariablesBase >
static libMesh::UniquePtr< FEVariablesBase >	build (const std::string &name)
	Use this method to build objects of type Base. More...
Static Protected Member Functions inherited from GRINS::VariableFactoryAbstract
static void	check_build_parse_state ()
	Helper function to check required data is set when calling build_* or parse_* methods. More...
static void	reset_build_parse_state ()
	Helper function to check required data is set when calling build_* or parse_* methods. More...
Static Protected Member Functions inherited from GRINS::FactoryAbstract< FEVariablesBase >
static FactoryAbstract< FEVariablesBase > &	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...
static DerivedType &	get_factory_subclass (const std::string &name)
	Like get_factory, but will downcast to DerivedType. More...
static std::map< std::string, FactoryAbstract< FEVariablesBase > * > &	factory_map ()
Static Protected Attributes inherited from GRINS::VariableFactoryAbstract
static const std::vector< std::string > *	_var_names = NULL
	Variable component names needed for FEVariableBase construction. More...
static const std::vector< VariableIndex > *	_var_indices = NULL
	Variable component indices needed for FEVariableBase construction. More...
static std::string	_var_section = std::string("DIE!")
	Section of input to parse variable names in build_var_names. More...
static const std::set< libMesh::subdomain_id_type > *	_subdomain_ids = NULL
	Subdomain ids for the variable. More...
Static Protected Attributes inherited from GRINS::FactoryWithGetPot< FEVariablesBase >
static const GetPot *	_input
	We store only a raw pointer here because we can't make a copy. More...

Detailed Description

Common implementations.

Definition at line 141 of file variable_factory.h.

Constructor & Destructor Documentation

GRINS::VariableFactoryBase::VariableFactoryBase ( const std::string &  name )

inline

Definition at line 145 of file variable_factory.h.

      : VariableFactoryAbstract(name)
    {}

GRINS::VariableFactoryBase::~VariableFactoryBase ( )

inline

Definition at line 149 of file variable_factory.h.

{}

Member Function Documentation

virtual std::string GRINS::VariableFactoryBase::parse_fe_family_impl ( const GetPot &  input, const std::string &  var_section  )

inlineprotectedvirtual

Implements GRINS::VariableFactoryAbstract.

Reimplemented in GRINS::ScalarVariableFactory< VariableType >.

Definition at line 153 of file variable_factory.h.

References GRINS::VariableFactoryAbstract::parse_var_option().

    {
      return this->parse_var_option(input,var_section,std::string("fe_family"),std::string("DIE!"));
    }

virtual std::string GRINS::VariableFactoryBase::parse_fe_order_impl ( const GetPot &  input, const std::string &  var_section  )

inlineprotectedvirtual

Implements GRINS::VariableFactoryAbstract.

Definition at line 158 of file variable_factory.h.

References GRINS::VariableFactoryAbstract::parse_var_option().

    {
      return this->parse_var_option(input,var_section,std::string("order"),std::string("DIE!"));
    }

---

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

• src/variables/include/grins/variable_factory.h