Stores input information for a boundary condition. More...

#include <Panzer_BC.hpp>

Classes
struct	BCEquality

struct	BCHash

Public Member Functions
	BC (std::size_t bc_id, BCType bc_type, std::string sideset_id, std::string element_block_id, std::string equation_set_name, std::string strategy)
	Ctor. More...

	BC (std::size_t bc_id, BCType bc_type, std::string sideset_id, std::string element_block_id, std::string equation_set_name, std::string strategy, const Teuchos::ParameterList &p)
	Ctor with Teuchos::ParameterList for extra params. More...

	BC (std::size_t bc_id, const Teuchos::ParameterList &p)
	Ctor based on ParameterList. More...

	BC (std::size_t bc_id, const Teuchos::ParameterList &p, const Teuchos::RCP< panzer::GlobalData > gd)
	Ctor based on ParameterList. More...

	~BC ()
	Dtor. More...

std::size_t	bcID () const
	Returns a unique identifier for this bc - needed for unique parameter setting in LOCA and for map key comparisons (strict weak ordering). More...

BCType	bcType () const
	Returns the boundary condition type (Dirichlet or Neumann or Interface). More...

std::string	sidesetID () const
	Returns the set id. More...

std::string	elementBlockID () const
	Returns the element block id associated with this sideset. More...

std::string	elementBlockID2 () const
	Returns the second element block id associated with this sideset. More...

std::string	equationSetName () const
	Returns the unknown name/keyword. More...

std::string	equationSetName2 () const
	Returns the second unknown name/keyword. More...

std::string	strategy () const
	Returns the keyword used to construct a bc strategy. More...

Teuchos::RCP< const Teuchos::ParameterList >	params () const
	Returns a parameter list with user defined parameters for bc. More...

Teuchos::RCP< panzer::GlobalData >	global_data () const
	Returns the RCP to the global data. More...

Teuchos::RCP < Teuchos::ParameterList >	nonconstParams () const
	Returns a nonconst parameter list with user defined parameters for bc. Nonconst is meant to be used for parameter list validation. More...

std::string	identifier () const
	A unique string identifier for this boundary condition. More...

void	print (std::ostream &os) const
	Print object using an ostream. More...

Private Member Functions
void	validateParameters (Teuchos::ParameterList &p) const

Private Attributes
std::size_t	m_bc_id

BCType	m_bc_type

std::string	m_sideset_id

std::string	m_element_block_id

std::string	m_element_block_id2

std::string	m_equation_set_name

std::string	m_equation_set_name2

std::string	m_strategy

Teuchos::RCP < Teuchos::ParameterList >	m_params

Teuchos::RCP< panzer::GlobalData >	m_gd

Related Functions
(Note that these are not member functions.)
void	buildBCs (std::vector< panzer::BC > &bcs, const Teuchos::ParameterList &p, const Teuchos::RCP< panzer::GlobalData > global_data)
	Nonmember constructor to build BC objects from a ParameterList. More...

Detailed Description

Stores input information for a boundary condition.

Definition at line 48 of file Panzer_BC.hpp.

Constructor & Destructor Documentation

panzer::BC::BC	(	std::size_t	bc_id,
		BCType	bc_type,
		std::string	sideset_id,
		std::string	element_block_id,
		std::string	equation_set_name,
		std::string	strategy
	)

Ctor.

Definition at line 45 of file Panzer_BC.cpp.

panzer::BC::BC	(	std::size_t	bc_id,
		BCType	bc_type,
		std::string	sideset_id,
		std::string	element_block_id,
		std::string	equation_set_name,
		std::string	strategy,
		const Teuchos::ParameterList &	p
	)

Ctor with Teuchos::ParameterList for extra params.

Definition at line 62 of file Panzer_BC.cpp.

panzer::BC::BC	(	std::size_t	bc_id,
		const Teuchos::ParameterList &	p
	)

Ctor based on ParameterList.

Definition at line 82 of file Panzer_BC.cpp.

panzer::BC::BC	(	std::size_t	bc_id,
		const Teuchos::ParameterList &	p,
		const Teuchos::RCP< panzer::GlobalData >	gd
	)

Ctor based on ParameterList.

Definition at line 111 of file Panzer_BC.cpp.

panzer::BC::~BC ( )

Dtor.

Definition at line 142 of file Panzer_BC.cpp.

Member Function Documentation

std::size_t panzer::BC::bcID ( ) const

Returns a unique identifier for this bc - needed for unique parameter setting in LOCA and for map key comparisons (strict weak ordering).

Definition at line 147 of file Panzer_BC.cpp.

panzer::BCType panzer::BC::bcType ( ) const

Returns the boundary condition type (Dirichlet or Neumann or Interface).

Definition at line 154 of file Panzer_BC.cpp.

std::string panzer::BC::sidesetID ( ) const

Returns the set id.

Definition at line 161 of file Panzer_BC.cpp.

std::string panzer::BC::elementBlockID ( ) const

Returns the element block id associated with this sideset.

Definition at line 168 of file Panzer_BC.cpp.

std::string panzer::BC::elementBlockID2 ( ) const

Returns the second element block id associated with this sideset.

Definition at line 175 of file Panzer_BC.cpp.

std::string panzer::BC::equationSetName ( ) const

Returns the unknown name/keyword.

Definition at line 182 of file Panzer_BC.cpp.

std::string panzer::BC::equationSetName2 ( ) const

Returns the second unknown name/keyword.

Definition at line 189 of file Panzer_BC.cpp.

std::string panzer::BC::strategy ( ) const

Returns the keyword used to construct a bc strategy.

Definition at line 196 of file Panzer_BC.cpp.

Teuchos::RCP< const Teuchos::ParameterList > panzer::BC::params ( ) const

Returns a parameter list with user defined parameters for bc.

Definition at line 203 of file Panzer_BC.cpp.

Teuchos::RCP< panzer::GlobalData > panzer::BC::global_data ( ) const

Returns the RCP to the global data.

Definition at line 210 of file Panzer_BC.cpp.

Teuchos::RCP< Teuchos::ParameterList > panzer::BC::nonconstParams ( ) const

Returns a nonconst parameter list with user defined parameters for bc. Nonconst is meant to be used for parameter list validation.

Definition at line 218 of file Panzer_BC.cpp.

std::string panzer::BC::identifier ( ) const

A unique string identifier for this boundary condition.

Definition at line 225 of file Panzer_BC.cpp.

void panzer::BC::print ( std::ostream & os ) const

Print object using an ostream.

Definition at line 234 of file Panzer_BC.cpp.

void panzer::BC::validateParameters ( Teuchos::ParameterList & p ) const

private

Definition at line 271 of file Panzer_BC.cpp.

Friends And Related Function Documentation

void buildBCs	(	std::vector< panzer::BC > &	bcs,
		const Teuchos::ParameterList &	p,
		const Teuchos::RCP< panzer::GlobalData >	global_data
	)

Member Data Documentation

std::size_t panzer::BC::m_bc_id

private

Definition at line 138 of file Panzer_BC.hpp.

BCType panzer::BC::m_bc_type

private

Definition at line 140 of file Panzer_BC.hpp.

std::string panzer::BC::m_sideset_id

private

Definition at line 142 of file Panzer_BC.hpp.

std::string panzer::BC::m_element_block_id

private

Definition at line 144 of file Panzer_BC.hpp.

std::string panzer::BC::m_element_block_id2

private

Definition at line 146 of file Panzer_BC.hpp.

std::string panzer::BC::m_equation_set_name

private

Definition at line 148 of file Panzer_BC.hpp.

std::string panzer::BC::m_equation_set_name2

private

Definition at line 150 of file Panzer_BC.hpp.

std::string panzer::BC::m_strategy

private

Definition at line 152 of file Panzer_BC.hpp.

Teuchos::RCP<Teuchos::ParameterList> panzer::BC::m_params

private

Definition at line 154 of file Panzer_BC.hpp.

Teuchos::RCP<panzer::GlobalData> panzer::BC::m_gd

private

Definition at line 156 of file Panzer_BC.hpp.

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation