Panzer  Version of the Day
Classes | Public Member Functions | Private Member Functions | Private Attributes | Related Functions | List of all members
panzer::BC Class Reference

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::GlobalDataglobal_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::GlobalDatam_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 80 of file Panzer_BC.hpp.

Constructor & Destructor Documentation

◆ BC() [1/4]

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 75 of file Panzer_BC.cpp.

◆ BC() [2/4]

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 92 of file Panzer_BC.cpp.

◆ BC() [3/4]

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

Ctor based on ParameterList.

Definition at line 112 of file Panzer_BC.cpp.

◆ BC() [4/4]

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 141 of file Panzer_BC.cpp.

◆ ~BC()

panzer::BC::~BC ( )

Dtor.

Definition at line 172 of file Panzer_BC.cpp.

Member Function Documentation

◆ bcID()

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 177 of file Panzer_BC.cpp.

◆ bcType()

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

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

Definition at line 184 of file Panzer_BC.cpp.

◆ sidesetID()

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

Returns the set id.

Definition at line 191 of file Panzer_BC.cpp.

◆ elementBlockID()

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

Returns the element block id associated with this sideset.

Definition at line 198 of file Panzer_BC.cpp.

◆ elementBlockID2()

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

Returns the second element block id associated with this sideset.

Definition at line 205 of file Panzer_BC.cpp.

◆ equationSetName()

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

Returns the unknown name/keyword.

Definition at line 212 of file Panzer_BC.cpp.

◆ equationSetName2()

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

Returns the second unknown name/keyword.

Definition at line 219 of file Panzer_BC.cpp.

◆ strategy()

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

Returns the keyword used to construct a bc strategy.

Definition at line 226 of file Panzer_BC.cpp.

◆ params()

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

Returns a parameter list with user defined parameters for bc.

Definition at line 233 of file Panzer_BC.cpp.

◆ global_data()

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

Returns the RCP to the global data.

Definition at line 240 of file Panzer_BC.cpp.

◆ nonconstParams()

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 248 of file Panzer_BC.cpp.

◆ identifier()

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

A unique string identifier for this boundary condition.

Definition at line 255 of file Panzer_BC.cpp.

◆ print()

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

Print object using an ostream.

Definition at line 264 of file Panzer_BC.cpp.

◆ validateParameters()

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

Definition at line 300 of file Panzer_BC.cpp.

Friends And Related Function Documentation

◆ buildBCs()

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

Nonmember constructor to build BC objects from a ParameterList.

Member Data Documentation

◆ m_bc_id

std::size_t panzer::BC::m_bc_id
private

Definition at line 170 of file Panzer_BC.hpp.

◆ m_bc_type

BCType panzer::BC::m_bc_type
private

Definition at line 172 of file Panzer_BC.hpp.

◆ m_sideset_id

std::string panzer::BC::m_sideset_id
private

Definition at line 174 of file Panzer_BC.hpp.

◆ m_element_block_id

std::string panzer::BC::m_element_block_id
private

Definition at line 176 of file Panzer_BC.hpp.

◆ m_element_block_id2

std::string panzer::BC::m_element_block_id2
private

Definition at line 178 of file Panzer_BC.hpp.

◆ m_equation_set_name

std::string panzer::BC::m_equation_set_name
private

Definition at line 180 of file Panzer_BC.hpp.

◆ m_equation_set_name2

std::string panzer::BC::m_equation_set_name2
private

Definition at line 182 of file Panzer_BC.hpp.

◆ m_strategy

std::string panzer::BC::m_strategy
private

Definition at line 184 of file Panzer_BC.hpp.

◆ m_params

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

Definition at line 186 of file Panzer_BC.hpp.

◆ m_gd

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

Definition at line 188 of file Panzer_BC.hpp.


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