Public Member Functions | Friends | List of all members
UPstream::commsStruct Class Reference

Structure for communicating between processors. More...

Public Member Functions

 commsStruct () noexcept
 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
 The procID of the processor directly above. More...
 
const labelList & below () const noexcept
 The procIDs of all processors directly below. More...
 
const labelList & allBelow () const noexcept
 
const labelList & allNotBelow () const noexcept
 
bool operator== (const commsStruct &) const
 
bool operator!= (const commsStruct &) const
 

Friends

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

Detailed Description

Structure for communicating between processors.

Definition at line 80 of file UPstream.H.

Constructor & Destructor Documentation

◆ commsStruct() [1/3]

commsStruct ( )
noexcept

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 42 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 57 of file UPstreamCommsStruct.C.

References Foam::abort(), UPstream::commsStruct::allBelow(), Foam::FatalError, FatalErrorInFunction, forAll, UPstream::nProcs(), and UList< T >::size().

Here is the call graph for this function:

Member Function Documentation

◆ above()

label above ( ) const
inlinenoexcept

The procID of the processor directly above.

Definition at line 128 of file UPstream.H.

Referenced by Pstream::combineGather(), Pstream::combineScatter(), Pstream::gather(), Pstream::gatherList(), Pstream::listCombineGather(), Pstream::listCombineScatter(), Pstream::mapCombineGather(), Pstream::mapCombineScatter(), UPstream::commsStruct::operator==(), Pstream::scatter(), and Pstream::scatterList().

Here is the caller graph for this function:

◆ below()

const labelList & below ( ) const
inlinenoexcept

The procIDs of all processors directly below.

Definition at line 134 of file UPstream.H.

Referenced by Pstream::combineGather(), Pstream::combineScatter(), Pstream::gather(), Pstream::gatherList(), Pstream::listCombineGather(), Pstream::listCombineScatter(), Pstream::mapCombineGather(), Pstream::mapCombineScatter(), UPstream::commsStruct::operator==(), Pstream::scatter(), and Pstream::scatterList().

Here is the caller graph for this function:

◆ allBelow()

const labelList & allBelow ( ) const
inlinenoexcept

The procIDs of all processors below (so not just directly below)

Definition at line 141 of file UPstream.H.

Referenced by UPstream::commsStruct::commsStruct(), Pstream::gatherList(), and UList< T >::operator[]().

Here is the caller graph for this function:

◆ allNotBelow()

const labelList & allNotBelow ( ) const
inlinenoexcept

The procIDs of all processors that are above. The inverse set of allBelow without myProcNo.

Definition at line 148 of file UPstream.H.

Referenced by UList< T >::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: