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

#include <neumann_bc_old_style_factory_abstract.h>

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

Public Member Functions

 NeumannBCOldStyleFactoryAbstract (const std::string &bc_type_name)
 
 ~NeumannBCOldStyleFactoryAbstract ()
 
- Public Member Functions inherited from GRINS::NeumannBCFactoryAbstract
 NeumannBCFactoryAbstract (const std::string &bc_type_name)
 
 ~NeumannBCFactoryAbstract ()
 
virtual libMesh::UniquePtr< NeumannBCContainercreate ()
 Creates NeumannBCContainer for this Factory object. More...
 
- Public Member Functions inherited from GRINS::BCFactoryAbstract< NeumannBCContainer >
 BCFactoryAbstract (const std::string &bc_type_name)
 
 ~BCFactoryAbstract ()
 
- Public Member Functions inherited from GRINS::FactoryWithGetPot< NeumannBCContainer >
 FactoryWithGetPot (const std::string &name)
 
 ~FactoryWithGetPot ()
 
- Public Member Functions inherited from GRINS::FactoryAbstract< NeumannBCContainer >
virtual ~FactoryAbstract ()
 

Static Public Member Functions

static void set_value_var_old_style (const std::string &value_var)
 Input variable for parsing old style. More...
 
static void set_value_index_old_style (unsigned int idx)
 Input variable index for parsing old style. More...
 
- Static Public Member Functions inherited from GRINS::BCFactoryAbstract< NeumannBCContainer >
static void set_system (MultiphysicsSystem &system)
 
static void set_bc_ids (const std::set< BoundaryID > &bc_ids)
 Boundary id for the current boundary condition section. More...
 
static void set_fe_var (const FEVariablesBase &fe_var)
 Active variable for the current boundary condition. More...
 
static void set_section (const std::string &section)
 Sets the current section of the input file. More...
 
static bool have_bc_type (const std::string &bc_type)
 
- Static Public Member Functions inherited from GRINS::FactoryWithGetPot< NeumannBCContainer >
static void set_getpot (const GetPot &input)
 
- Static Public Member Functions inherited from GRINS::FactoryAbstract< NeumannBCContainer >
static libMesh::UniquePtr< NeumannBCContainerbuild (const std::string &name)
 Use this method to build objects of type Base. More...
 

Protected Member Functions

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::NeumannBCFactoryAbstract
virtual SharedPtr< NeumannBCAbstractbuild_neumann_func (const GetPot &input, MultiphysicsSystem &system, const FEVariablesBase &fe_var, const std::string &section)=0
 Builds the NeumannBCAbstract object for Neumann boundary conditions. More...
 
void check_for_flux (const GetPot &input, const std::string &section, const std::vector< std::string > &var_names)
 Checks that the flux variable has been set. More...
 
- Protected Member Functions inherited from GRINS::BCFactoryAbstract< NeumannBCContainer >
void check_for_multiple_expressions (const GetPot &input, const std::string &section, const std::string &var_name) const
 Ensure that there is only one expression for the [Section/var_name] variable. More...
 
void build_var_indices (const MultiphysicsSystem &system, const std::vector< std::string > &var_names, std::vector< VariableIndex > &var_indices) const
 
- Protected Member Functions inherited from GRINS::FactoryAbstract< NeumannBCContainer >
 FactoryAbstract (const std::string &name)
 Constructor is protected. Use the build() method to construct Base objects. More...
 

Static Protected Attributes

static std::string _value_var_old_style = std::string("DIE!")
 
static unsigned int _value_idx_old_style = libMesh::invalid_uint
 
- Static Protected Attributes inherited from GRINS::BCFactoryAbstract< NeumannBCContainer >
static MultiphysicsSystem_system
 We store only a raw pointer here because we can't make a copy. More...
 
static const std::set< BoundaryID > * _bc_ids
 BoundaryID for constructing a particular boundary condition. More...
 
static const FEVariablesBase_fe_var
 The FEVariablesBase class associated with the boundary condition being built. More...
 
static std::string _section
 
- Static Protected Attributes inherited from GRINS::FactoryWithGetPot< NeumannBCContainer >
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< NeumannBCContainer >
static FactoryAbstract< NeumannBCContainer > & 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< NeumannBCContainer > * > & factory_map ()
 
- Protected Attributes inherited from GRINS::NeumannBCFactoryAbstract
bool _is_homogeneous
 Track if this is a homogeneous Neumann boundary condition. More...
 

Detailed Description

Definition at line 33 of file neumann_bc_old_style_factory_abstract.h.

Constructor & Destructor Documentation

GRINS::NeumannBCOldStyleFactoryAbstract::NeumannBCOldStyleFactoryAbstract ( const std::string &  bc_type_name)
inline

Definition at line 36 of file neumann_bc_old_style_factory_abstract.h.

37  : NeumannBCFactoryAbstract(bc_type_name)
38  {}
NeumannBCFactoryAbstract(const std::string &bc_type_name)
GRINS::NeumannBCOldStyleFactoryAbstract::~NeumannBCOldStyleFactoryAbstract ( )
inline

Definition at line 40 of file neumann_bc_old_style_factory_abstract.h.

40 {};

Member Function Documentation

void GRINS::NeumannBCOldStyleFactoryAbstract::check_state ( ) const
protectedvirtual

Helper function to reduce code duplication.

Reimplemented from GRINS::BCFactoryAbstract< NeumannBCContainer >.

Definition at line 34 of file neumann_bc_old_style_factory_abstract.C.

References _value_idx_old_style, _value_var_old_style, and GRINS::BCFactoryAbstract< NeumannBCContainer >::check_state().

35  {
37 
38  if( this->_value_var_old_style == std::string("DIE!") )
39  libmesh_error_msg("ERROR: must call set_value_var_old_style() before building boundary condition!");
40 
41  if( this->_value_idx_old_style == libMesh::invalid_uint )
42  libmesh_error_msg("ERROR: must call set_value_index_old_style() before building boundary condition!");
43  }
virtual void check_state() const
Helper function to reduce code duplication.
void GRINS::NeumannBCOldStyleFactoryAbstract::reset_state ( )
protectedvirtual

Helper function to reduce code duplication.

Reimplemented from GRINS::BCFactoryAbstract< NeumannBCContainer >.

Definition at line 45 of file neumann_bc_old_style_factory_abstract.C.

References _value_idx_old_style, _value_var_old_style, and GRINS::BCFactoryAbstract< NeumannBCContainer >::reset_state().

46  {
48  this->_value_var_old_style = std::string("DIE!");
49  this->_value_idx_old_style = libMesh::invalid_uint;
50  }
virtual void reset_state()
Helper function to redue code duplication.
static void GRINS::NeumannBCOldStyleFactoryAbstract::set_value_index_old_style ( unsigned int  idx)
inlinestatic

Input variable index for parsing old style.

Deprecated, only used for backward compatibility.

Definition at line 49 of file neumann_bc_old_style_factory_abstract.h.

References _value_idx_old_style.

Referenced by GRINS::OldStyleBCBuilder::set_neumann_bc_factory_old_style_quantities().

static void GRINS::NeumannBCOldStyleFactoryAbstract::set_value_var_old_style ( const std::string &  value_var)
inlinestatic

Input variable for parsing old style.

Deprecated, only used for backward compatibility.

Definition at line 44 of file neumann_bc_old_style_factory_abstract.h.

References _value_var_old_style.

Referenced by GRINS::OldStyleBCBuilder::set_neumann_bc_factory_old_style_quantities().

Member Data Documentation

unsigned int GRINS::NeumannBCOldStyleFactoryAbstract::_value_idx_old_style = libMesh::invalid_uint
staticprotected
std::string GRINS::NeumannBCOldStyleFactoryAbstract::_value_var_old_style = std::string("DIE!")
staticprotected

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

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