Public Member Functions | Public Attributes | Friends | List of all members
meshReader::cellFaceIdentifier Class Reference

Identify cell faces in terms of cell Id and face Id. More...

Public Member Functions

 cellFaceIdentifier ()
 Construct null. More...
 
 cellFaceIdentifier (label c, label f)
 Construct from cell/face components. More...
 
bool used () const
 Used if cell or face are non-negative. More...
 
bool unused () const
 Unused if cell or face are negative. More...
 
bool operator!= (const cellFaceIdentifier &cf) const
 
bool operator== (const cellFaceIdentifier &cf) const
 

Public Attributes

label cell
 Cell Id. More...
 
label face
 Face Id. More...
 

Friends

Ostream & operator<< (Ostream &os, const cellFaceIdentifier &cf)
 

Detailed Description

Identify cell faces in terms of cell Id and face Id.

Definition at line 78 of file meshReader.H.

Constructor & Destructor Documentation

◆ cellFaceIdentifier() [1/2]

cellFaceIdentifier ( )
inline

Construct null.

Definition at line 93 of file meshReader.H.

◆ cellFaceIdentifier() [2/2]

cellFaceIdentifier ( label  c,
label  f 
)
inline

Construct from cell/face components.

Definition at line 96 of file meshReader.H.

Member Function Documentation

◆ used()

bool used ( ) const
inline

Used if cell or face are non-negative.

Definition at line 102 of file meshReader.H.

◆ unused()

bool unused ( ) const
inline

Unused if cell or face are negative.

Definition at line 108 of file meshReader.H.

◆ operator!=()

bool operator!= ( const cellFaceIdentifier &  cf) const
inline

Definition at line 116 of file meshReader.H.

References meshReader::cellFaceIdentifier::cell, and meshReader::cellFaceIdentifier::face.

◆ operator==()

bool operator== ( const cellFaceIdentifier &  cf) const
inline

Definition at line 121 of file meshReader.H.

References meshReader::cellFaceIdentifier::cell, and meshReader::cellFaceIdentifier::face.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream &  os,
const cellFaceIdentifier &  cf 
)
friend

Definition at line 129 of file meshReader.H.

Member Data Documentation

◆ cell

label cell

Cell Id.

Definition at line 84 of file meshReader.H.

Referenced by meshReader::cellFaceIdentifier::operator!=(), and meshReader::cellFaceIdentifier::operator==().

◆ face

label face

Face Id.

Definition at line 87 of file meshReader.H.

Referenced by meshReader::cellFaceIdentifier::operator!=(), and meshReader::cellFaceIdentifier::operator==().

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