Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
panzer_stk::PeriodicBC_Matcher< Matcher > Class Template Reference

#include <Panzer_STK_PeriodicBC_Matcher.hpp>

Inheritance diagram for panzer_stk::PeriodicBC_Matcher< Matcher >:
Inheritance graph
[legend]

Public Member Functions

 PeriodicBC_Matcher (const std::string &left, const std::string &right, const Matcher &matcher, const std::string type="coord")
 
 PeriodicBC_Matcher (const PeriodicBC_Matcher &src)
 
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
 
std::string getString () const
 
std::string getType () const
 
std::string getLeftSidesetName () const
 Returns the sideset name for the left side. More...
 
std::string getRightSidesetName () const
 Returns the sideset name for the right side. More...
 
const Matcher & getMatcher () const
 
- Public Member Functions inherited from panzer_stk::PeriodicBC_MatcherBase
virtual ~PeriodicBC_MatcherBase ()
 
template<typename T >
const T * getAs () const
 Attempts to cast the underlying matcher to type T. Returns nullptr if cast fails. More...
 

Private Member Functions

 PeriodicBC_Matcher ()
 

Private Attributes

std::string left_
 
std::string right_
 
Matcher matcher_
 
std::string type_
 

Detailed Description

template<typename Matcher>
class panzer_stk::PeriodicBC_Matcher< Matcher >

Default implementation class for the periodic boundary conditions. This simply takes a Matcher object as the coordinate matching operation. For details on the Matcher see the CoordMatcher struct.

Definition at line 183 of file Panzer_STK_PeriodicBC_Matcher.hpp.

Constructor & Destructor Documentation

template<typename Matcher >
panzer_stk::PeriodicBC_Matcher< Matcher >::PeriodicBC_Matcher ( const std::string &  left,
const std::string &  right,
const Matcher &  matcher,
const std::string  type = "coord" 
)
inline

Definition at line 185 of file Panzer_STK_PeriodicBC_Matcher.hpp.

template<typename Matcher >
panzer_stk::PeriodicBC_Matcher< Matcher >::PeriodicBC_Matcher ( const PeriodicBC_Matcher< Matcher > &  src)
inline

Definition at line 187 of file Panzer_STK_PeriodicBC_Matcher.hpp.

template<typename Matcher >
panzer_stk::PeriodicBC_Matcher< Matcher >::PeriodicBC_Matcher ( )
private

Member Function Documentation

template<typename Matcher >
Teuchos::RCP<std::vector<std::pair<std::size_t,std::size_t> > > panzer_stk::PeriodicBC_Matcher< Matcher >::getMatchedPair ( const STK_Interface mesh,
const Teuchos::RCP< const std::vector< std::pair< std::size_t, std::size_t > > > &  currentState = Teuchos::null 
) const
inlinevirtual

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.

Implements panzer_stk::PeriodicBC_MatcherBase.

Definition at line 201 of file Panzer_STK_PeriodicBC_Matcher.hpp.

template<typename Matcher >
std::string panzer_stk::PeriodicBC_Matcher< Matcher >::getString ( ) const
inlinevirtual

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

Implements panzer_stk::PeriodicBC_MatcherBase.

Definition at line 211 of file Panzer_STK_PeriodicBC_Matcher.hpp.

template<typename Matcher >
std::string panzer_stk::PeriodicBC_Matcher< Matcher >::getType ( ) const
inlinevirtual

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

Implements panzer_stk::PeriodicBC_MatcherBase.

Definition at line 220 of file Panzer_STK_PeriodicBC_Matcher.hpp.

template<typename Matcher >
std::string panzer_stk::PeriodicBC_Matcher< Matcher >::getLeftSidesetName ( ) const
inlinevirtual

Returns the sideset name for the left side.

Implements panzer_stk::PeriodicBC_MatcherBase.

Definition at line 223 of file Panzer_STK_PeriodicBC_Matcher.hpp.

template<typename Matcher >
std::string panzer_stk::PeriodicBC_Matcher< Matcher >::getRightSidesetName ( ) const
inlinevirtual

Returns the sideset name for the right side.

Implements panzer_stk::PeriodicBC_MatcherBase.

Definition at line 226 of file Panzer_STK_PeriodicBC_Matcher.hpp.

template<typename Matcher >
const Matcher& panzer_stk::PeriodicBC_Matcher< Matcher >::getMatcher ( ) const
inline

Definition at line 229 of file Panzer_STK_PeriodicBC_Matcher.hpp.

Member Data Documentation

template<typename Matcher >
std::string panzer_stk::PeriodicBC_Matcher< Matcher >::left_
private

Definition at line 235 of file Panzer_STK_PeriodicBC_Matcher.hpp.

template<typename Matcher >
std::string panzer_stk::PeriodicBC_Matcher< Matcher >::right_
private

Definition at line 236 of file Panzer_STK_PeriodicBC_Matcher.hpp.

template<typename Matcher >
Matcher panzer_stk::PeriodicBC_Matcher< Matcher >::matcher_
private

Definition at line 238 of file Panzer_STK_PeriodicBC_Matcher.hpp.

template<typename Matcher >
std::string panzer_stk::PeriodicBC_Matcher< Matcher >::type_
private

Definition at line 240 of file Panzer_STK_PeriodicBC_Matcher.hpp.


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