UPstream::commsStruct Class Reference

Structure for communicating between processors. More...

Collaboration diagram for UPstream::commsStruct:

Public Member Functions
	commsStruct ()
	Construct null. More...
	commsStruct (const label, const labelList &, const labelList &, const labelList &)
	Construct from components. More...
	commsStruct (const label nProcs, const label myProcID, const label, const labelList &, const labelList &)
	Construct from components; construct allNotBelow_. More...
label	above () const
const labelList &	below () const
const labelList &	allBelow () const
const labelList &	allNotBelow () const
bool	operator== (const commsStruct &) const
bool	operator!= (const commsStruct &) const

Private Attributes
label	above_
	procID of above processor More...
labelList	below_
	procIDs of processors directly below me More...
labelList	allBelow_
	procIDs of all processors below (so not just directly below) More...
labelList	allNotBelow_
	procIDs of all processors not below. (inverse set of More...

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

Detailed Description

Structure for communicating between processors.

Definition at line 76 of file UPstream.H.

Constructor & Destructor Documentation

commsStruct() [1/3]

commsStruct

(

)

Construct null.

Definition at line 31 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 41 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 56 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

inline

Definition at line 125 of file UPstream.H.

References UPstream::commsStruct::above_.

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

Here is the caller graph for this function:

below()

const labelList& below ( ) const

inline

Definition at line 130 of file UPstream.H.

References UPstream::commsStruct::below_.

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

Here is the caller graph for this function:

allBelow()

const labelList& allBelow ( ) const

inline

Definition at line 135 of file UPstream.H.

References UPstream::commsStruct::allBelow_.

Referenced by Pstream::gatherList().

Here is the caller graph for this function:

allNotBelow()

const labelList& allNotBelow ( ) const

inline

Definition at line 140 of file UPstream.H.

References UPstream::commsStruct::allNotBelow_.

Referenced by Pstream::scatterList().

Here is the caller graph for this function:

operator==()

bool operator==

(

const commsStruct &

comm

)

const

Definition at line 93 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 105 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

Field Documentation

above_

label above_

private

procID of above processor

Definition at line 81 of file UPstream.H.

Referenced by UPstream::commsStruct::above(), and Foam::operator<<().

below_

labelList below_

private

procIDs of processors directly below me

Definition at line 84 of file UPstream.H.

Referenced by UPstream::commsStruct::below(), and Foam::operator<<().

allBelow_

labelList allBelow_

private

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

Definition at line 87 of file UPstream.H.

Referenced by UPstream::commsStruct::allBelow(), and Foam::operator<<().

allNotBelow_

labelList allNotBelow_

private

procIDs of all processors not below. (inverse set of

allBelow_ and minus myProcNo)

Definition at line 91 of file UPstream.H.

Referenced by UPstream::commsStruct::allNotBelow(), and Foam::operator<<().

---

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

• src/OpenFOAM/db/IOstreams/Pstreams/UPstream.H
• src/OpenFOAM/db/IOstreams/Pstreams/UPstreamCommsStruct.C