GRINS::HomogeneousNeumannBCFactory Class Reference

Generic factory for homogeneous Neumann boundary conditions. More...

#include <homogeneous_neumann_bc_factory.h>

Inheritance diagram for GRINS::HomogeneousNeumannBCFactory:

Collaboration diagram for GRINS::HomogeneousNeumannBCFactory:

Public Member Functions
	HomogeneousNeumannBCFactory (const std::string &bc_type_name)
virtual	~HomogeneousNeumannBCFactory ()
Public Member Functions inherited from GRINS::NeumannBCFactoryAbstract
	NeumannBCFactoryAbstract (const std::string &bc_type_name)
	~NeumannBCFactoryAbstract ()
virtual libMesh::UniquePtr< NeumannBCContainer >	create ()
	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 ()

Protected Member Functions
virtual SharedPtr< NeumannBCAbstract >	build_neumann_func (const GetPot &, MultiphysicsSystem &, const FEVariablesBase &, const std::string &)
	Do nothing. More...
Protected Member Functions inherited from GRINS::NeumannBCFactoryAbstract
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
virtual void	check_state () const
	Helper function to reduce code duplication. More...
virtual void	reset_state ()
	Helper function to redue code duplication. More...

Additional Inherited Members
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)
Protected Attributes inherited from GRINS::NeumannBCFactoryAbstract
bool	_is_homogeneous
	Track if this is a homogeneous Neumann boundary condition. More...
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...

Detailed Description

Generic factory for homogeneous Neumann boundary conditions.

Merely need to set _is_homogeneous to true at construction time, then the create() method in the base classes should just ignore this boundary condition factory and not construct anything, which is what we want for "do nothing" boundary conditions.

Definition at line 38 of file homogeneous_neumann_bc_factory.h.

Constructor & Destructor Documentation

GRINS::HomogeneousNeumannBCFactory::HomogeneousNeumannBCFactory ( const std::string &  bc_type_name )

inline

Definition at line 41 of file homogeneous_neumann_bc_factory.h.

References GRINS::NeumannBCFactoryAbstract::_is_homogeneous.

      : NeumannBCFactoryAbstract(bc_type_name)
    { _is_homogeneous = true; }

virtual GRINS::HomogeneousNeumannBCFactory::~HomogeneousNeumannBCFactory ( )

inlinevirtual

Definition at line 45 of file homogeneous_neumann_bc_factory.h.

{};

Member Function Documentation

virtual SharedPtr<NeumannBCAbstract> GRINS::HomogeneousNeumannBCFactory::build_neumann_func ( const GetPot &  , MultiphysicsSystem &  , const FEVariablesBase &  , const std::string &    )

inlineprotectedvirtual

Do nothing.

Implements GRINS::NeumannBCFactoryAbstract.

Definition at line 53 of file homogeneous_neumann_bc_factory.h.

    { libmesh_error(); // This should never get called
      return SharedPtr<NeumannBCAbstract>(); }

---

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

• src/boundary_conditions/include/grins/homogeneous_neumann_bc_factory.h