Public Member Functions | Friends | List of all members
coupledFacePair Class Reference

Data associated with a pair of coupled faces. More...

Public Member Functions

 coupledFacePair (const label coupleNo, const label mC, const label mF, const label sC, const label sF, const label integral)
 Construct from components. More...
 
label coupleID () const
 Return STAR couple ID. More...
 
label masterCell () const
 Return master cell. More...
 
label masterFace () const
 Return master face. More...
 
label slaveCell () const
 Return slave cell. More...
 
label slaveFace () const
 Return slave face. More...
 
bool integralMatch () const
 Is this an integral match? More...
 

Friends

Ostream & operator<< (Ostream &, const coupledFacePair &)
 

Detailed Description

Data associated with a pair of coupled faces.

Source files

Definition at line 55 of file coupledFacePair.H.

Constructor & Destructor Documentation

◆ coupledFacePair()

coupledFacePair ( const label  coupleNo,
const label  mC,
const label  mF,
const label  sC,
const label  sF,
const label  integral 
)

Construct from components.

Member Function Documentation

◆ coupleID()

label coupleID ( ) const
inline

Return STAR couple ID.

Definition at line 96 of file coupledFacePair.H.

◆ masterCell()

label masterCell ( ) const
inline

Return master cell.

Definition at line 102 of file coupledFacePair.H.

◆ masterFace()

label masterFace ( ) const
inline

Return master face.

Definition at line 108 of file coupledFacePair.H.

◆ slaveCell()

label slaveCell ( ) const
inline

Return slave cell.

Definition at line 114 of file coupledFacePair.H.

◆ slaveFace()

label slaveFace ( ) const
inline

Return slave face.

Definition at line 120 of file coupledFacePair.H.

◆ integralMatch()

bool integralMatch ( ) const
inline

Is this an integral match?

Definition at line 126 of file coupledFacePair.H.

References coupledFacePair::operator<<.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  ,
const coupledFacePair &   
)
friend

Referenced by coupledFacePair::integralMatch().

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