GRINS::ParsedFunctionDirichletBCFactory< FunctionType > Class Template Reference

#include <parsed_function_dirichlet_bc_factory.h>

Inheritance diagram for GRINS::ParsedFunctionDirichletBCFactory< FunctionType >:

Collaboration diagram for GRINS::ParsedFunctionDirichletBCFactory< FunctionType >:

Public Member Functions
	ParsedFunctionDirichletBCFactory (const std::string &bc_type_name)
	~ParsedFunctionDirichletBCFactory ()
Public Member Functions inherited from GRINS::DirichletBCFactoryFunctionBase< FunctionType >
	DirichletBCFactoryFunctionBase (const std::string &bc_type_name)
	~DirichletBCFactoryFunctionBase ()
Public Member Functions inherited from GRINS::DirichletBCFactoryAbstract
	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 ()
Public Member Functions inherited from GRINS::ParsedFunctionFactoryHelper< FunctionType >
	ParsedFunctionFactoryHelper ()
	~ParsedFunctionFactoryHelper ()

Protected Member Functions
virtual libMesh::UniquePtr< FunctionType >	build_func (const GetPot &input, MultiphysicsSystem &system, std::vector< std::string > &var_names, const std::string &section)
	Builds the Parsed(FEM)Function objects for boundary conditions. More...
Protected Member Functions inherited from GRINS::DirichletBCFactoryFunctionBase< FunctionType >
libMesh::UniquePtr< libMesh::DirichletBoundary >	make_dirichlet_boundary (const std::set< BoundaryID > &bc_ids, const libMesh::System &system, libMesh::UniquePtr< FunctionType > &func, const std::vector< VariableIndex > &var_indices)
	Dispatch, based on FunctionType, to the correct DirchletBoundary construction. More...
virtual const std::vector< std::string > &	get_var_names () const
	Helper function that can be overridded in subclasses. More...
template<>
libMesh::UniquePtr< libMesh::DirichletBoundary >	make_dirichlet_boundary (const std::set< BoundaryID > &bc_ids, const libMesh::System &, libMesh::UniquePtr< libMesh::FunctionBase< libMesh::Number > > &func, const std::vector< VariableIndex > &var_indices)
template<>
libMesh::UniquePtr< libMesh::DirichletBoundary >	make_dirichlet_boundary (const std::set< BoundaryID > &bc_ids, const libMesh::System &system, libMesh::UniquePtr< libMesh::FEMFunctionBase< libMesh::Number > > &func, const std::vector< VariableIndex > &var_indices)
Protected Member Functions inherited from GRINS::DirichletBCFactoryAbstract
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...
Protected Member Functions inherited from GRINS::ParsedFunctionFactoryHelper< FunctionType >
libMesh::UniquePtr< FunctionType >	build_parsed_func (const MultiphysicsSystem &system, const std::string &expression)
libMesh::UniquePtr< FunctionType >	build_composite_func ()
template<>
libMesh::UniquePtr< libMesh::FunctionBase< libMesh::Number > >	build_parsed_func (const MultiphysicsSystem &, const std::string &expression)
template<>
libMesh::UniquePtr< libMesh::FEMFunctionBase< libMesh::Number > >	build_parsed_func (const MultiphysicsSystem &system, const std::string &expression)
template<>
libMesh::UniquePtr< libMesh::FunctionBase< libMesh::Number > >	build_composite_func ()
template<>
libMesh::UniquePtr< libMesh::FEMFunctionBase< libMesh::Number > >	build_composite_func ()

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

template<typename FunctionType>
class GRINS::ParsedFunctionDirichletBCFactory< FunctionType >

Definition at line 36 of file parsed_function_dirichlet_bc_factory.h.

Constructor & Destructor Documentation

template<typename FunctionType>

GRINS::ParsedFunctionDirichletBCFactory< FunctionType >::ParsedFunctionDirichletBCFactory ( const std::string &  bc_type_name )

inline

Definition at line 41 of file parsed_function_dirichlet_bc_factory.h.

      : DirichletBCFactoryFunctionBase<FunctionType>(bc_type_name),
      ParsedFunctionFactoryHelper<FunctionType>()
    {}

template<typename FunctionType>

GRINS::ParsedFunctionDirichletBCFactory< FunctionType >::~ParsedFunctionDirichletBCFactory ( )

inline

Definition at line 46 of file parsed_function_dirichlet_bc_factory.h.

{};

Member Function Documentation

template<typename FunctionType >

libMesh::UniquePtr< FunctionType > GRINS::ParsedFunctionDirichletBCFactory< FunctionType >::build_func ( const GetPot &  input, MultiphysicsSystem &  system, std::vector< std::string > &  var_names, const std::string &  section  )

protectedvirtual

Builds the Parsed(FEM)Function objects for boundary conditions.

The variable names passed in will correspond to only a single VariableBase object, e.g. Velocity. The expected behavior is that if the user didn't specify a value for all the variables, then the unspecified variables will be set to zero. However, the user must've set at least one. The section arguments corresponds to the section to parse for the variables in the input file, e.g. input(section+"/"+var_names[0]).

This is really a "composite" function.

Implements GRINS::DirichletBCFactoryFunctionBase< FunctionType >.

Definition at line 40 of file parsed_function_dirichlet_bc_factory.C.

  {
    libmesh_assert( !var_names.empty() );

    libMesh::UniquePtr<FunctionType> all_funcs;
    all_funcs.reset( this->build_composite_func().release() );

    typedef typename TypeFrom<FunctionType>::to_composite composite_type;
    composite_type * composite_func =
      libMesh::cast_ptr<composite_type *>(all_funcs.get());

    // We're given the active variables in var_names. Let's first check
    // which ones the user actually set in the input file.
    // If there's only one variable in var_names, then check_for_vars will
    // error if the user didn't set it, so we don't need to consider that
    // case here.
    std::set<std::string> vars_found;
    this->check_for_vars(input,section,var_names,&vars_found);

    for( std::vector<std::string>::const_iterator var = var_names.begin();
         var < var_names.end(); ++var )
      {
        std::vector<VariableIndex> var_idx(1,system.variable_number(*var));

        // If the user set this variable in input, parse the expression and
        // add it to the composition function
        if( vars_found.find(*var) != vars_found.end() )
          {
            std::string expression = input(section+"/"+(*var),"DIE!");

            composite_func->attach_subfunction
              (TypeFrom<FunctionType>::to_parsed(system, expression), var_idx);
          }
        // Otherwise, we set this variable to be zero.
        else
          {
            composite_func->attach_subfunction
              (TypeFrom<FunctionType>::to_zero(), var_idx);
          }
      }

    return all_funcs;
  }

---

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

• src/boundary_conditions/include/grins/parsed_function_dirichlet_bc_factory.h
• src/boundary_conditions/src/parsed_function_dirichlet_bc_factory.C