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...

Private Attributes
label	coupleID_
	STAR couple ID. More...
label	masterCellID_
	Master cell (lower cell label) More...
label	masterFaceID_
	Master face (lower cell label) More...
label	slaveCellID_
	Slave cell (higher cell label) More...
label	slaveFaceID_
	Slave face (higher cell label) More...
bool	integralMatch_
	Integral or arbitrary flag. More...

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

Detailed Description

Data associated with a pair of coupled faces.

Source files

• coupledFacePair.H
• coupledFacePair.C

Definition at line 48 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 89 of file coupledFacePair.H.

References coupledFacePair::coupleID_.

masterCell()

label masterCell ( ) const

inline

Return master cell.

Definition at line 95 of file coupledFacePair.H.

References coupledFacePair::masterCellID_.

masterFace()

label masterFace ( ) const

inline

Return master face.

Definition at line 101 of file coupledFacePair.H.

References coupledFacePair::masterFaceID_.

slaveCell()

label slaveCell ( ) const

inline

Return slave cell.

Definition at line 107 of file coupledFacePair.H.

References coupledFacePair::slaveCellID_.

slaveFace()

label slaveFace ( ) const

inline

Return slave face.

Definition at line 113 of file coupledFacePair.H.

References coupledFacePair::slaveFaceID_.

integralMatch()

bool integralMatch ( ) const

inline

Is this an integral match?

Definition at line 119 of file coupledFacePair.H.

References coupledFacePair::integralMatch_.

Friends And Related Function Documentation

operator<<

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

friend

Field Documentation

coupleID_

label coupleID_

private

STAR couple ID.

Definition at line 53 of file coupledFacePair.H.

Referenced by coupledFacePair::coupleID().

masterCellID_

label masterCellID_

private

Master cell (lower cell label)

Definition at line 56 of file coupledFacePair.H.

Referenced by coupledFacePair::masterCell().

masterFaceID_

label masterFaceID_

private

Master face (lower cell label)

Definition at line 59 of file coupledFacePair.H.

Referenced by coupledFacePair::masterFace().

slaveCellID_

label slaveCellID_

private

Slave cell (higher cell label)

Definition at line 62 of file coupledFacePair.H.

Referenced by coupledFacePair::slaveCell().

slaveFaceID_

label slaveFaceID_

private

Slave face (higher cell label)

Definition at line 65 of file coupledFacePair.H.

Referenced by coupledFacePair::slaveFace().

integralMatch_

bool integralMatch_

private

Integral or arbitrary flag.

Definition at line 68 of file coupledFacePair.H.

Referenced by coupledFacePair::integralMatch().

---

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

• applications/utilities/mesh/conversion/star3ToFoam/coupledFacePair.H