UPstream::commsStruct Class Reference

Structure for communicating between processors. More...

Public Member Functions

 commsStruct ()
 Default construct. Above == -1. More...
 
 commsStruct (const label above, const labelList &below, const labelList &allBelow, const labelList &allNotBelow)
 Construct from components. More...
 
 commsStruct (const label nProcs, const label myProcID, const label above, const labelList &below, const labelList &allBelow)
 Construct from components; construct allNotBelow_. More...
 
label above () const noexcept
 
const labelListbelow () const noexcept
 
const labelListallBelow () const noexcept
 
const labelListallNotBelow () const noexcept
 
bool operator== (const commsStruct &) const
 
bool operator!= (const commsStruct &) const
 

Friends

Ostreamoperator<< (Ostream &, const commsStruct &)
 

Detailed Description

Structure for communicating between processors.

Definition at line 83 of file UPstream.H.

Constructor & Destructor Documentation

◆ commsStruct() [1/3]

Default construct. Above == -1.

Definition at line 33 of file UPstreamCommsStruct.C.

◆ commsStruct() [2/3]

commsStruct ( const label  above,
const labelList below,
const labelList allBelow,
const labelList allNotBelow 
)

Construct from components.

Definition at line 43 of file UPstreamCommsStruct.C.

◆ commsStruct() [3/3]

commsStruct ( const label  nProcs,
const label  myProcID,
const label  above,
const labelList below,
const labelList allBelow 
)

Construct from components; construct allNotBelow_.

Definition at line 58 of file UPstreamCommsStruct.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, and UPstream::nProcs().

Here is the call graph for this function:

Member Function Documentation

◆ above()

label above ( ) const
inlinenoexcept

◆ below()

◆ allBelow()

const labelList& allBelow ( ) const
inlinenoexcept

Definition at line 140 of file UPstream.H.

Referenced by Pstream::gatherList(), and UList< Foam::wordRe >::operator[]().

Here is the caller graph for this function:

◆ allNotBelow()

const labelList& allNotBelow ( ) const
inlinenoexcept

Definition at line 145 of file UPstream.H.

Referenced by UList< Foam::wordRe >::operator[](), and Pstream::scatterList().

Here is the caller graph for this function:

◆ operator==()

bool operator== ( const commsStruct comm) const

Definition at line 95 of file UPstreamCommsStruct.C.

References UPstream::commsStruct::above(), and UPstream::commsStruct::below().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const commsStruct comm) const

Definition at line 107 of file UPstreamCommsStruct.C.

References Foam::operator==().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

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