GRINS-0.8.0
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes
GRINS::CatalycityFactoryOldStyleBase Class Referenceabstract

#include <catalycity_factory_old_style_base.h>

Inheritance diagram for GRINS::CatalycityFactoryOldStyleBase:
Inheritance graph
[legend]
Collaboration diagram for GRINS::CatalycityFactoryOldStyleBase:
Collaboration graph
[legend]

Public Member Functions

 CatalycityFactoryOldStyleBase (const std::string &physics_name)
 
 ~CatalycityFactoryOldStyleBase ()
 
- Public Member Functions inherited from GRINS::CatalycityFactoryAbstract
 CatalycityFactoryAbstract (const std::string &physics_name)
 
 ~CatalycityFactoryAbstract ()
 
- Public Member Functions inherited from GRINS::FactoryWithGetPot< CatalycityBase >
 FactoryWithGetPot (const std::string &name)
 
 ~FactoryWithGetPot ()
 
- Public Member Functions inherited from GRINS::FactoryAbstract< CatalycityBase >
virtual ~FactoryAbstract ()
 

Static Public Member Functions

static void set_reactant (const std::string &reactant)
 
static void set_bc_id (const std::string &bc_id)
 
- Static Public Member Functions inherited from GRINS::CatalycityFactoryAbstract
static void set_section (const std::string &section)
 
- Static Public Member Functions inherited from GRINS::FactoryWithGetPot< CatalycityBase >
static void set_getpot (const GetPot &input)
 
- Static Public Member Functions inherited from GRINS::FactoryAbstract< CatalycityBase >
static libMesh::UniquePtr< CatalycityBasebuild (const std::string &name)
 Use this method to build objects of type Base. More...
 

Protected Member Functions

virtual libMesh::UniquePtr< CatalycityBasebuild_catalycity (const GetPot &input, const std::string &section)
 
virtual libMesh::UniquePtr< CatalycityBasebuild_catalycity_old_style (const GetPot &input, const std::string &section, const std::string &reactant_str, const std::string &bc_id_string)=0
 
virtual void check_state () const
 Helper function to reduce code duplication. More...
 
virtual void reset_state ()
 Helper function to reduce code duplication. More...
 
- Protected Member Functions inherited from GRINS::FactoryAbstract< CatalycityBase >
 FactoryAbstract (const std::string &name)
 Constructor is protected. Use the build() method to construct Base objects. More...
 

Static Protected Attributes

static std::string _reactant_str = std::string("DIE!")
 
static std::string _bc_id_str = std::string("DIE!")
 
- Static Protected Attributes inherited from GRINS::CatalycityFactoryAbstract
static std::string _section = std::string("DIE!")
 
- Static Protected Attributes inherited from GRINS::FactoryWithGetPot< CatalycityBase >
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< CatalycityBase >
static FactoryAbstract< CatalycityBase > & 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< CatalycityBase > * > & factory_map ()
 

Detailed Description

Definition at line 33 of file catalycity_factory_old_style_base.h.

Constructor & Destructor Documentation

GRINS::CatalycityFactoryOldStyleBase::CatalycityFactoryOldStyleBase ( const std::string &  physics_name)
inline

Definition at line 37 of file catalycity_factory_old_style_base.h.

38  : CatalycityFactoryAbstract(physics_name)
39  {}
CatalycityFactoryAbstract(const std::string &physics_name)
GRINS::CatalycityFactoryOldStyleBase::~CatalycityFactoryOldStyleBase ( )
inline

Definition at line 41 of file catalycity_factory_old_style_base.h.

41 {};

Member Function Documentation

libMesh::UniquePtr< CatalycityBase > GRINS::CatalycityFactoryOldStyleBase::build_catalycity ( const GetPot &  input,
const std::string &  section 
)
protectedvirtual

Implements GRINS::CatalycityFactoryAbstract.

Definition at line 30 of file catalycity_factory_old_style_base.C.

References _bc_id_str, _reactant_str, and build_catalycity_old_style().

32  {
33  // State of _reactant_str, _bc_id_str verified in check_state() call in create()
34  return this->build_catalycity_old_style( input, section, _reactant_str, _bc_id_str );
35  }
virtual libMesh::UniquePtr< CatalycityBase > build_catalycity_old_style(const GetPot &input, const std::string &section, const std::string &reactant_str, const std::string &bc_id_string)=0
virtual libMesh::UniquePtr<CatalycityBase> GRINS::CatalycityFactoryOldStyleBase::build_catalycity_old_style ( const GetPot &  input,
const std::string &  section,
const std::string &  reactant_str,
const std::string &  bc_id_string 
)
protectedpure virtual
void GRINS::CatalycityFactoryOldStyleBase::check_state ( ) const
protectedvirtual

Helper function to reduce code duplication.

Reimplemented from GRINS::CatalycityFactoryAbstract.

Definition at line 37 of file catalycity_factory_old_style_base.C.

References _bc_id_str, _reactant_str, and GRINS::CatalycityFactoryAbstract::check_state().

38  {
40 
41  if( _reactant_str == std::string("DIE!") )
42  libmesh_error_msg("ERROR: must call set_reactant() before building Catalycity!");
43 
44  if( _bc_id_str == std::string("DIE!") )
45  libmesh_error_msg("ERROR: must call set_bc_id() before building Catalycity!");
46  }
virtual void check_state() const
Helper function to reduce code duplication.
void GRINS::CatalycityFactoryOldStyleBase::reset_state ( )
protectedvirtual

Helper function to reduce code duplication.

Reimplemented from GRINS::CatalycityFactoryAbstract.

Definition at line 48 of file catalycity_factory_old_style_base.C.

References _bc_id_str, _reactant_str, and GRINS::CatalycityFactoryAbstract::reset_state().

49  {
51 
52  _reactant_str = std::string("DIE!");
53  _bc_id_str = std::string("DIE!");
54  }
virtual void reset_state()
Helper function to reduce code duplication.
static void GRINS::CatalycityFactoryOldStyleBase::set_bc_id ( const std::string &  bc_id)
inlinestatic
static void GRINS::CatalycityFactoryOldStyleBase::set_reactant ( const std::string &  reactant)
inlinestatic

Member Data Documentation

std::string GRINS::CatalycityFactoryOldStyleBase::_bc_id_str = std::string("DIE!")
staticprotected
std::string GRINS::CatalycityFactoryOldStyleBase::_reactant_str = std::string("DIE!")
staticprotected

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

Generated on Tue Dec 19 2017 12:47:30 for GRINS-0.8.0 by  doxygen 1.8.9.1