#include <neumann_bc_factory_abstract.h>

Inheritance diagram for GRINS::NeumannBCFactoryAbstract:

[legend]

Collaboration diagram for GRINS::NeumannBCFactoryAbstract:

[legend]

Public Member Functions
	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 &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

virtual void	check_state () const
	Helper function to reduce code duplication. More...

virtual void	reset_state ()
	Helper function to redue code duplication. More...

Protected Attributes
bool	_is_homogeneous
	Track if this is a homogeneous Neumann boundary condition. 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)

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

Definition at line 34 of file neumann_bc_factory_abstract.h.

Constructor & Destructor Documentation

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

inline

Definition at line 37 of file neumann_bc_factory_abstract.h.

       : BCFactoryAbstract<NeumannBCContainer>(bc_type_name),
       _is_homogeneous(false)
     {}

GRINS::NeumannBCFactoryAbstract::~NeumannBCFactoryAbstract ( )

inline

Definition at line 42 of file neumann_bc_factory_abstract.h.

42 {};

Member Function Documentation

virtual SharedPtr<NeumannBCAbstract> GRINS::NeumannBCFactoryAbstract::build_neumann_func	(	const GetPot &	input,
		MultiphysicsSystem &	system,
		const FEVariablesBase &	fe_var,
		const std::string &	section
	)

protectedpure virtual

Builds the NeumannBCAbstract object for Neumann boundary conditions.

Subclasses should override this function to build the NeumannBCAbstract object that corresponds to the variables passed in var_names. The FEVariableBase object corresponds to the variable associated with this boundary condition, e.g. Velocity. The section arguments corresponds to the section to parse for the flux in the input file, e.g. input(section+"/"+flux). Note that for Variables with more than one component, the flux input should be a vector the size of the var_names object, even if one of the components is zero.

Referenced by create().

void GRINS::NeumannBCFactoryAbstract::check_for_flux	(	const GetPot &	input,
		const std::string &	section,
		const std::vector< std::string > &	var_names
	)

protected

Checks that the flux variable has been set.

Check for both the presence of [section/flux] and that the size is the same as var_names. For example, if we are setting a traction vector for Displacement variables, then the input flux vector (traction) should have the name number of components as var_names.

Definition at line 58 of file neumann_bc_factory_abstract.C.

Referenced by GRINS::ParsedFunctionNeumannBCFactory< FunctionType >::build_neumann_func().

   {
     if( !input.have_variable(flux_input) )
       libmesh_error_msg("ERROR: Could not find input specification for "+flux_input+"!");
 
     unsigned int flux_size = input.vector_variable_size(flux_input);
     if( flux_size != var_names.size() )
       {
         std::string error_msg = "ERROR: Mismatch in size between flux input and variables size!\n";
         error_msg += "       Found flux size      = "+StringUtilities::T_to_string<unsigned int>(flux_size)+"\n";
         error_msg += "       Found variables size = "+StringUtilities::T_to_string<unsigned int>(var_names.size())+"\n";
         libmesh_error_msg(error_msg);
       }
   }

libMesh::UniquePtr< NeumannBCContainer > GRINS::NeumannBCFactoryAbstract::create ( )

virtual

Creates NeumannBCContainer for this Factory object.

This method will handle the creation and population of all aspects of the NeumannBCContainer except the function object that is used to evaluate the flux, the NeumannBCAbstract object. The construction of NeumannBCAbstract subclasses is deferred to subclasses of this factory and should be implemented in the build_neumann_func method.

Note that an empty libMesh::UniquePtr<NeumannBCContainer> may be returned from create() if the parsed boundary condition type is a homogeneous one. This is allowed since we force the user to specify boundary conditions for every Variable, for every boundary in the hopes of reducing input file errors at runtime.

Definition at line 33 of file neumann_bc_factory_abstract.C.

References GRINS::BCFactoryAbstract< NeumannBCContainer >::_bc_ids, GRINS::BCFactoryAbstract< NeumannBCContainer >::_fe_var, GRINS::FactoryWithGetPot< NeumannBCContainer >::_input, _is_homogeneous, GRINS::BCFactoryAbstract< NeumannBCContainer >::_section, GRINS::BCFactoryAbstract< NeumannBCContainer >::_system, build_neumann_func(), GRINS::BCFactoryAbstract< NeumannBCContainer >::check_state(), and GRINS::BCFactoryAbstract< NeumannBCContainer >::reset_state().

   {
     libMesh::UniquePtr<NeumannBCContainer> container;
 
     // Only build the container if the Neumann BC is *not* homogeneous
     // Otherwise, we just return and empty (NULL) UniquePtr.
     if(!_is_homogeneous)
       {
         // Make sure all necessary state has been setup
         this->check_state();
 
         SharedPtr<NeumannBCAbstract>
           func = this->build_neumann_func( *_input, *_system, *_fe_var, this->_section );
 
         libmesh_assert(func);
 
         container.reset(new NeumannBCContainer(*_bc_ids,*_fe_var,func));
 
         // Reset state for error checking during next construction
         this->reset_state();
       }
 
     return container;
   }

Member Data Documentation

bool GRINS::NeumannBCFactoryAbstract::_is_homogeneous

protected

Track if this is a homogeneous Neumann boundary condition.

If so, then we literally do nothing: don't create a NeumannBCAbstract object, don't create a NeumannBCContainer, etc. Default is false, so subclasses have to opt-in appropriately.

Definition at line 66 of file neumann_bc_factory_abstract.h.

Referenced by create(), and GRINS::HomogeneousNeumannBCFactory::HomogeneousNeumannBCFactory().

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

src/boundary_conditions/include/grins/neumann_bc_factory_abstract.h
src/boundary_conditions/src/neumann_bc_factory_abstract.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation