#include <dirichlet_bc_factory_abstract.h>

Inheritance diagram for GRINS::DirichletBCFactoryAbstract:

Collaboration diagram for GRINS::DirichletBCFactoryAbstract:

Public Member Functions
	DirichletBCFactoryAbstract (const std::string &bc_type_name)

	~DirichletBCFactoryAbstract ()

Public Member Functions inherited from GRINS::BCFactoryAbstract< libMesh::DirichletBoundary >
	BCFactoryAbstract (const std::string &bc_type_name)

	~BCFactoryAbstract ()

Public Member Functions inherited from GRINS::FactoryWithGetPot< libMesh::DirichletBoundary >
	FactoryWithGetPot (const std::string &name)

	~FactoryWithGetPot ()

Public Member Functions inherited from GRINS::FactoryAbstract< libMesh::DirichletBoundary >
virtual	~FactoryAbstract ()

virtual libMesh::UniquePtr< libMesh::DirichletBoundary >	create ()=0
	Subclasses implement the actual construction of the Base object in create(). More...

Protected Member Functions
void	check_for_vars (const GetPot &input, const std::string &section, const std::vector< std::string > &var_names, std::set< std::string > *vars_found=NULL)
	Helper function. More...

Protected Member Functions inherited from GRINS::BCFactoryAbstract< libMesh::DirichletBoundary >
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 Member Functions inherited from GRINS::FactoryAbstract< libMesh::DirichletBoundary >
	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::BCFactoryAbstract< libMesh::DirichletBoundary >
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< libMesh::DirichletBoundary >
static void	set_getpot (const GetPot &input)

Static Public Member Functions inherited from GRINS::FactoryAbstract< libMesh::DirichletBoundary >
static libMesh::UniquePtr< libMesh::DirichletBoundary >	build (const std::string &name)
	Use this method to build objects of type Base. More...

Static Protected Member Functions inherited from GRINS::FactoryAbstract< libMesh::DirichletBoundary >
static FactoryAbstract< libMesh::DirichletBoundary > &	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< libMesh::DirichletBoundary > * > &	factory_map ()

Static Protected Attributes inherited from GRINS::BCFactoryAbstract< libMesh::DirichletBoundary >
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< libMesh::DirichletBoundary >
static const GetPot *	_input
	We store only a raw pointer here because we can't make a copy. More...

Detailed Description

Definition at line 36 of file dirichlet_bc_factory_abstract.h.

Constructor & Destructor Documentation

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

inline

Definition at line 39 of file dirichlet_bc_factory_abstract.h.

40 : BCFactoryAbstract<libMesh::DirichletBoundary>(bc_type_name)

41 {}

GRINS::DirichletBCFactoryAbstract::~DirichletBCFactoryAbstract ( )

inline

Definition at line 43 of file dirichlet_bc_factory_abstract.h.

43 {};

Member Function Documentation

void GRINS::DirichletBCFactoryAbstract::check_for_vars	(	const GetPot &	input,
		const std::string &	section,
		const std::vector< std::string > &	var_names,
		std::set< std::string > *	vars_found = `NULL`
	)

protected

Helper function.

This will search the given section to make sure at least one of the var names as been set. An error will be thrown if no vars were found to be set. Those vars that have been set in the input file are returned in the vars_found variable, if vars_found is not NULL.

Definition at line 55 of file dirichlet_bc_factory_abstract.C.

Referenced by GRINS::ConstantFunctionDirichletBCFactory::build_func().

   {
     if( vars_found )
       vars_found->clear();
 
     bool found_var = false;
 
     for( std::vector<std::string>::const_iterator name = var_names.begin();
          name < var_names.end(); ++name )
       {
         if( input.have_variable( section+"/"+(*name) ) )
           {
             found_var = true;
 
             if( vars_found )
               vars_found->insert( (*name) );
           }
       }
 
     // If no variables were found to be set, error out printing
     // the section and the variable names we were looking for.
     if( !found_var )
       {
         std::string err_msg = "ERROR: Could find any active variable assigned a Dirichlet boundary value\n";
         err_msg += "       in section "+section+". Active variables are:\n";
 
         for( std::vector<std::string>::const_iterator name = var_names.begin();
              name < var_names.end(); ++name )
           err_msg += "       "+(*name)+"\n";
 
         libmesh_error_msg(err_msg);
       }
 
     if( vars_found )
       libmesh_assert(!vars_found->empty());
   }

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation