panzer_stk::PeriodicBC_MatcherBase Class Reference

#include <Panzer_STK_PeriodicBC_Matcher.hpp>

Inheritance diagram for panzer_stk::PeriodicBC_MatcherBase:

Public Member Functions
virtual	~PeriodicBC_MatcherBase ()
virtual Teuchos::RCP < std::vector< std::pair < std::size_t, std::size_t > > >	getMatchedPair (const STK_Interface &mesh, const Teuchos::RCP< const std::vector< std::pair< std::size_t, std::size_t > > > &currentState=Teuchos::null) const =0
virtual std::string	getString () const =0
virtual std::string	getType () const =0
virtual std::string	getLeftSidesetName () const =0
	Returns the sideset name for the left side. More...
virtual std::string	getRightSidesetName () const =0
	Returns the sideset name for the right side. More...
template<typename T >
const T *	getAs () const
	Attempts to cast the underlying matcher to type T. Returns nullptr if cast fails. More...

Detailed Description

Simply returns a vector of pairs that match the IDs owned by this processor to their matching IDs on the periodic boundary.

Notice that the matched boundaries are not specified by this object. This is done in the inherited class.

Definition at line 207 of file Panzer_STK_PeriodicBC_Matcher.hpp.

Constructor & Destructor Documentation

virtual panzer_stk::PeriodicBC_MatcherBase::~PeriodicBC_MatcherBase ( )

inlinevirtual

Definition at line 209 of file Panzer_STK_PeriodicBC_Matcher.hpp.

Member Function Documentation

virtual Teuchos::RCP<std::vector<std::pair<std::size_t,std::size_t> > > panzer_stk::PeriodicBC_MatcherBase::getMatchedPair ( const STK_Interface &  mesh, const Teuchos::RCP< const std::vector< std::pair< std::size_t, std::size_t > > > &  currentState = Teuchos::null  ) const

pure virtual

Simply returns a vector of pairs that match the IDs owned by this processor to their matching IDs on the periodic boundary.

Returns

A vector of pairs. The first entry in the pair is the global node ID of a node used on this processor. The second is the global node ID (not necessarily on this processor) that replaces it.

Implemented in panzer_stk::PeriodicBC_Matcher< Matcher >.

virtual std::string panzer_stk::PeriodicBC_MatcherBase::getString ( ) const

pure virtual

Return a one line string that describes this periodic boundary condition.

Implemented in panzer_stk::PeriodicBC_Matcher< Matcher >.

virtual std::string panzer_stk::PeriodicBC_MatcherBase::getType ( ) const

pure virtual

Return a one line string that describes the type of periodic boundary condition.

Implemented in panzer_stk::PeriodicBC_Matcher< Matcher >.

virtual std::string panzer_stk::PeriodicBC_MatcherBase::getLeftSidesetName ( ) const

pure virtual

Returns the sideset name for the left side.

Implemented in panzer_stk::PeriodicBC_Matcher< Matcher >.

virtual std::string panzer_stk::PeriodicBC_MatcherBase::getRightSidesetName ( ) const

pure virtual

Returns the sideset name for the right side.

Implemented in panzer_stk::PeriodicBC_Matcher< Matcher >.

template<typename T >

const T* panzer_stk::PeriodicBC_MatcherBase::getAs ( ) const

inline

Attempts to cast the underlying matcher to type T. Returns nullptr if cast fails.

Definition at line 269 of file Panzer_STK_PeriodicBC_Matcher.hpp.

---

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

• Panzer_STK_PeriodicBC_Matcher.hpp