Panzer  Version of the Day
Public Member Functions | Private Attributes | List of all members
panzer_stk::PeriodicBC_Parser Class Reference

#include <Panzer_STK_PeriodicBC_Parser.hpp>

Inheritance diagram for panzer_stk::PeriodicBC_Parser:
Inheritance graph
[legend]

Public Member Functions

 PeriodicBC_Parser ()
 
const std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > & getMatchers () const
 
void setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &pl)
 
Teuchos::RCP< Teuchos::ParameterListgetNonconstParameterList ()
 
Teuchos::RCP< Teuchos::ParameterListunsetParameterList ()
 
Teuchos::RCP< const Teuchos::ParameterListgetValidParameters () const
 
Teuchos::RCP< Teuchos::ParameterListgetValidParameters (int count) const
 
Teuchos::RCP< const PeriodicBC_MatcherBasebuildMatcher (const std::string &buildStr) const
 
std::pair< std::string, unsigned int > getMatcherTypeAndDim (const std::string &buildStr) const
 
std::string replaceMatcherType (const std::string &buildStr, const std::string &matcherType) const
 
void buildMatcher_Tokenize (const std::string &buildStr, std::string &matcher, std::string &bndry1, std::string &bndry2) const
 
bool buildMatcher_Tokenize_withParams (const std::string &buildStr, std::string &matcher, std::vector< std::string > &params, std::string &bndry1, std::string &bndry2) const
 

Private Attributes

Teuchos::RCP< Teuchos::ParameterListstoredPL_
 stored parameter list More...
 
std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > matchers_
 matchers constructed by "setParameterList" More...
 
std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > edgeMatchers_
 
std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > faceMatchers_
 
const std::string countStr_
 
const std::string condPrefix_
 

Additional Inherited Members

- Private Member Functions inherited from Teuchos::ParameterListAcceptor
virtual ~ParameterListAcceptor ()
 
virtual RCP< const ParameterListgetParameterList () const
 
virtual RCP< const DependencySheetgetDependencies () const
 
virtual RCP< const ParameterListgetParameterList () const
 
virtual RCP< const DependencySheetgetDependencies () const
 

Detailed Description

Read a parameter list to describe the periodic boundary conditions. This object then provides a vector of the PeriodicBC_Matcher objects.

Definition at line 61 of file Panzer_STK_PeriodicBC_Parser.hpp.

Constructor & Destructor Documentation

◆ PeriodicBC_Parser()

panzer_stk::PeriodicBC_Parser::PeriodicBC_Parser ( )

Definition at line 51 of file Panzer_STK_PeriodicBC_Parser.cpp.

Member Function Documentation

◆ getMatchers()

const std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > & panzer_stk::PeriodicBC_Parser::getMatchers ( ) const

Return a vector containing all the periodic boundary conditions.

Definition at line 58 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ setParameterList()

void panzer_stk::PeriodicBC_Parser::setParameterList ( const Teuchos::RCP< Teuchos::ParameterList > &  pl)
virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 63 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ getNonconstParameterList()

Teuchos::RCP< Teuchos::ParameterList > panzer_stk::PeriodicBC_Parser::getNonconstParameterList ( )
virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 112 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ unsetParameterList()

Teuchos::RCP< Teuchos::ParameterList > panzer_stk::PeriodicBC_Parser::unsetParameterList ( )
virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 117 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ getValidParameters() [1/2]

Teuchos::RCP< const Teuchos::ParameterList > panzer_stk::PeriodicBC_Parser::getValidParameters ( ) const
virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 124 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ getValidParameters() [2/2]

Teuchos::RCP< Teuchos::ParameterList > panzer_stk::PeriodicBC_Parser::getValidParameters ( int  count) const

Get valid parameters given a count parameter for total number of boundary conditions.

Parameters
[in]countNumber of periodic boundary conditions

Definition at line 143 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ buildMatcher()

Teuchos::RCP< const PeriodicBC_MatcherBase > panzer_stk::PeriodicBC_Parser::buildMatcher ( const std::string &  buildStr) const

Build a periodic matcher object given a string

Parameters
[in]buildStrString specifying the matcher to build. Format: "MatchCondition bndry1;bndry2"

Definition at line 292 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ getMatcherTypeAndDim()

std::pair< std::string, unsigned int > panzer_stk::PeriodicBC_Parser::getMatcherTypeAndDim ( const std::string &  buildStr) const

Return the string for the type of matcher: coord, edge, face, or all and the dimension: 2 or 3

Definition at line 185 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ replaceMatcherType()

std::string panzer_stk::PeriodicBC_Parser::replaceMatcherType ( const std::string &  buildStr,
const std::string &  matcherType 
) const

Replace "all" with specific type in matcher string: coord, edge, or face

Definition at line 215 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ buildMatcher_Tokenize()

void panzer_stk::PeriodicBC_Parser::buildMatcher_Tokenize ( const std::string &  buildStr,
std::string &  matcher,
std::string &  bndry1,
std::string &  bndry2 
) const

Parse a string describing the periodic boundary condition Format: "MatchCondition bndry1;bndry2"

Definition at line 225 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ buildMatcher_Tokenize_withParams()

bool panzer_stk::PeriodicBC_Parser::buildMatcher_Tokenize_withParams ( const std::string &  buildStr,
std::string &  matcher,
std::vector< std::string > &  params,
std::string &  bndry1,
std::string &  bndry2 
) const

Parse a string describing the periodic boundary condition Format: "MatchCondition paramA, paramB, paraC, ... : bndry1;bndry2"

Returns
False if no parameters are found (defaults to old style of periodic BC input)

Definition at line 238 of file Panzer_STK_PeriodicBC_Parser.cpp.

Member Data Documentation

◆ storedPL_

Teuchos::RCP<Teuchos::ParameterList> panzer_stk::PeriodicBC_Parser::storedPL_
private

stored parameter list

Definition at line 130 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ matchers_

std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > panzer_stk::PeriodicBC_Parser::matchers_
private

matchers constructed by "setParameterList"

Definition at line 133 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ edgeMatchers_

std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > panzer_stk::PeriodicBC_Parser::edgeMatchers_
private

Definition at line 134 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ faceMatchers_

std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > panzer_stk::PeriodicBC_Parser::faceMatchers_
private

Definition at line 135 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ countStr_

const std::string panzer_stk::PeriodicBC_Parser::countStr_
private

Definition at line 138 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ condPrefix_

const std::string panzer_stk::PeriodicBC_Parser::condPrefix_
private

Definition at line 139 of file Panzer_STK_PeriodicBC_Parser.hpp.


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