panzer_stk::WedgeMatcher Class Reference

#include <Panzer_STK_PeriodicBC_MatchConditions.hpp>

Public Types
enum	MirrorPlane : int { MirrorPlane::XZ_PLANE =0, MirrorPlane::YZ_PLANE =1 }

Public Member Functions
	WedgeMatcher (MirrorPlane mp, const std::vector< std::string > &params)
	WedgeMatcher (const WedgeMatcher &cm)=default
bool	operator() (const Teuchos::Tuple< double, 3 > &a, const Teuchos::Tuple< double, 3 > &b) const
std::string	getString () const
int	getIndex () const
WedgeMatcher::MirrorPlane	getMirrorPlane () const
bool	isThreeD () const

Private Attributes
double	error_
int	index0_
	index to compare - 0 for wy (mirrored over yz), 1 for wx (mirrored over xz) More...
bool	is_three_d_
	Set to true if a 3D problem, set to false if 2D. More...

Detailed Description

Match coordinates for a 3D wedge. The wedge must be meshed such that it is mirrored/split over the xz or yz plane. The index is the coordinate index that is compared . If the mirror plane is xz, then index0=1. If the mirror plane is yz, then index0=0. A mirror plane of xz is specified as "wx" in the string parser. A mirror pland of yz is specified as "wy" in the string parser.

Definition at line 270 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

Member Enumeration Documentation

MirrorPlane

enum panzer_stk::WedgeMatcher::MirrorPlane : int

strong

Enumerator
XZ_PLANE
YZ_PLANE

Definition at line 277 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

Constructor & Destructor Documentation

WedgeMatcher() [1/2]

panzer_stk::WedgeMatcher::WedgeMatcher ( MirrorPlane  mp, const std::vector< std::string > &  params  )

inline

Definition at line 281 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

WedgeMatcher() [2/2]

panzer_stk::WedgeMatcher::WedgeMatcher ( const WedgeMatcher &  cm )

default

Member Function Documentation

operator()()

bool panzer_stk::WedgeMatcher::operator() ( const Teuchos::Tuple< double, 3 > &  a, const Teuchos::Tuple< double, 3 > &  b  ) const

inline

Definition at line 307 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

getString()

std::string panzer_stk::WedgeMatcher::getString ( ) const

inline

Definition at line 321 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

getIndex()

int panzer_stk::WedgeMatcher::getIndex ( ) const

inline

Definition at line 331 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

getMirrorPlane()

WedgeMatcher::MirrorPlane panzer_stk::WedgeMatcher::getMirrorPlane ( ) const

inline

Definition at line 333 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

isThreeD()

bool panzer_stk::WedgeMatcher::isThreeD ( ) const

inline

Definition at line 340 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

Member Data Documentation

error_

double panzer_stk::WedgeMatcher::error_

private

Definition at line 271 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

index0_

int panzer_stk::WedgeMatcher::index0_

private

index to compare - 0 for wy (mirrored over yz), 1 for wx (mirrored over xz)

Definition at line 273 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

is_three_d_

bool panzer_stk::WedgeMatcher::is_three_d_

private

Set to true if a 3D problem, set to false if 2D.

Definition at line 275 of file Panzer_STK_PeriodicBC_MatchConditions.hpp.

---

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

• Panzer_STK_PeriodicBC_MatchConditions.hpp