meshReader::cellFaceIdentifier Class Reference

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

Inheritance diagram for meshReader::cellFaceIdentifier:
[legend]
Collaboration diagram for meshReader::cellFaceIdentifier:
[legend]

Public Member Functions

 cellFaceIdentifier ()
 Construct null, as invalid pair. More...
 
 cellFaceIdentifier (label c, label f)
 Construct from cell/face components. More...
 
const label & cellId () const
 The cell id (readonly) More...
 
const label & faceId () const
 The face id (readonly) More...
 
bool used () const
 Used if both cell or face are non-negative. More...
 
bool notUsed () const
 Unused if either cell or face are negative. More...
 
- Public Member Functions inherited from Pair< label >
 Pair ()=default
 Default construct. More...
 
 Pair (const label &f, const label &s)
 Copy construct from components. More...
 
 Pair (label &&f, label &&s)
 Move construct from components. More...
 
 Pair (const std::pair< label, label > &vals)
 Copy construct from std::pair. More...
 
 Pair (std::pair< label, label > &&vals)
 Move construct from std::pair. More...
 
 Pair (const FixedList< label, 2 > &list)
 Copy construct FixedList of two items. More...
 
 Pair (const label &f, const label &s, const bool doSort)
 Copy construct, optionally sorted with first less-than second. More...
 
 Pair (const FixedList< label, 2 > &list, const bool doSort)
 Copy construct, optionally sorted with first less-than second. More...
 
 Pair (Istream &is)
 Construct from Istream. More...
 
const label & second () const noexcept
 Return second element, which is also the last element. More...
 
label & second () noexcept
 Return second element, which is also the last element. More...
 
const label & other (const label &a) const
 Return other element. More...
 
bool sorted () const
 True if first() is less-than second() More...
 
void flip ()
 Flip the Pair in-place. More...
 
void sort ()
 Sort so that first() is less-than second() More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Pair< label >
static int compare (const Pair< label > &a, const Pair< label > &b)
 Compare Pairs. More...
 

Detailed Description

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

Definition at line 73 of file meshReader.H.

Constructor & Destructor Documentation

◆ cellFaceIdentifier() [1/2]

cellFaceIdentifier ( )
inline

Construct null, as invalid pair.

Definition at line 80 of file meshReader.H.

◆ cellFaceIdentifier() [2/2]

cellFaceIdentifier ( label  c,
label  f 
)
inline

Construct from cell/face components.

Definition at line 83 of file meshReader.H.

Member Function Documentation

◆ cellId()

const label& cellId ( ) const
inline

The cell id (readonly)

Definition at line 89 of file meshReader.H.

◆ faceId()

const label& faceId ( ) const
inline

The face id (readonly)

Definition at line 95 of file meshReader.H.

References Pair< label >::second().

Here is the call graph for this function:

◆ used()

bool used ( ) const
inline

Used if both cell or face are non-negative.

Definition at line 104 of file meshReader.H.

References Pair< label >::second().

Here is the call graph for this function:

◆ notUsed()

bool notUsed ( ) const
inline

Unused if either cell or face are negative.

Definition at line 110 of file meshReader.H.

References Pair< label >::second().

Here is the call graph for this function:

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