#include <Panzer_STK_PeriodicBC_Parser.hpp>

Inherits Teuchos::ParameterListAcceptor.

Public Member Functions
	PeriodicBC_Parser ()
	Construct with no parameter list set; call setParameterList() to parse the periodic boundary conditions.

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

const bool &	useBoundingBoxSearch () const

void	setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &pl)
	Sets the parameter list, validates it, and parses it into the matcher vectors returned by getMatchers().

Teuchos::RCP< Teuchos::ParameterList >	getNonconstParameterList ()
	Returns the currently stored parameter list, retaining ownership.

Teuchos::RCP< Teuchos::ParameterList >	unsetParameterList ()
	Releases and returns the currently stored parameter list.

Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const
	Returns the valid parameters for a single periodic boundary condition entry (see the count overload below for multiple entries).

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

Teuchos::RCP< const PeriodicBC_MatcherBase >	buildMatcher (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::ParameterList >	storedPL_
	stored parameter list

std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > >	matchers_
	matchers constructed by "setParameterList"

std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > >	edgeMatchers_

std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > >	faceMatchers_

const std::string	countStr_

const std::string	condPrefix_

const std::string	searchStr_

bool	useBBoxSearch_

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 29 of file Panzer_STK_PeriodicBC_Parser.hpp.

Constructor & Destructor Documentation

◆ PeriodicBC_Parser()

panzer_stk::PeriodicBC_Parser::PeriodicBC_Parser ( )

Construct with no parameter list set; call setParameterList() to parse the periodic boundary conditions.

Definition at line 19 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 28 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ useBoundingBoxSearch()

const bool & panzer_stk::PeriodicBC_Parser::useBoundingBoxSearch ( ) const

Get the flag indicating if the bounding box search is used when matching periodic Ids.

Definition at line 33 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ setParameterList()

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

Sets the parameter list, validates it, and parses it into the matcher vectors returned by getMatchers().

Definition at line 38 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ getNonconstParameterList()

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

Returns the currently stored parameter list, retaining ownership.

Definition at line 88 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ unsetParameterList()

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

Releases and returns the currently stored parameter list.

Definition at line 93 of file Panzer_STK_PeriodicBC_Parser.cpp.

◆ getValidParameters() [1/2]

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

Returns the valid parameters for a single periodic boundary condition entry (see the count overload below for multiple entries).

Definition at line 100 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] count Number of periodic boundary conditions

Definition at line 121 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] buildStr String specifying the matcher to build. Format: "MatchCondition bndry1;bndry2"

Definition at line 272 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

Parameters

[in] buildStr the periodic BC specification string to parse (see buildMatcher()).

Definition at line 165 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

Parameters

[in]	buildStr	the periodic BC specification string containing "all" as its type.
[in]	matcherType	the concrete type ("coord", "edge", or "face") to substitute for "all".

Definition at line 195 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"

Parameters

[in]	buildStr	the periodic BC specification string to tokenize.
[out]	matcher	set to the match condition token.
[out]	bndry1	set to the first boundary (sideset) name token.
[out]	bndry2	set to the second boundary (sideset) name token.

Definition at line 205 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"

Parameters

[in]	buildStr	the periodic BC specification string to tokenize.
[out]	matcher	set to the match condition token.
[out]	params	set to the parsed parameter tokens (paramA, paramB, ...).
[out]	bndry1	set to the first boundary (sideset) name token.
[out]	bndry2	set to the second boundary (sideset) name token.

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

Definition at line 218 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 122 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 125 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ edgeMatchers_

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

private

Definition at line 126 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ faceMatchers_

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

private

Definition at line 127 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ countStr_

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

private

Definition at line 130 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ condPrefix_

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

private

Definition at line 131 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ searchStr_

const std::string panzer_stk::PeriodicBC_Parser::searchStr_

private

Definition at line 132 of file Panzer_STK_PeriodicBC_Parser.hpp.

◆ useBBoxSearch_

bool panzer_stk::PeriodicBC_Parser::useBBoxSearch_

private

Definition at line 135 of file Panzer_STK_PeriodicBC_Parser.hpp.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PeriodicBC_Parser()

Member Function Documentation

◆ getMatchers()

◆ useBoundingBoxSearch()

◆ setParameterList()

◆ getNonconstParameterList()

◆ unsetParameterList()

◆ getValidParameters() [1/2]

◆ getValidParameters() [2/2]

◆ buildMatcher()

◆ getMatcherTypeAndDim()

◆ replaceMatcherType()

◆ buildMatcher_Tokenize()

◆ buildMatcher_Tokenize_withParams()

Member Data Documentation

◆ storedPL_

◆ matchers_

◆ edgeMatchers_

◆ faceMatchers_

◆ countStr_

◆ condPrefix_

◆ searchStr_

◆ useBBoxSearch_