UPstream::commsStruct Class Reference

Public Member Functions
	commsStruct ()
	commsStruct (const label above, const labelList &below, const labelList &allBelow, const labelList &allNotBelow)
	commsStruct (const label nProcs, const label myProcID, const label above, const labelList &below, const labelList &allBelow)
label	above () const noexcept
const labelList &	below () const noexcept
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

Definition at line 79 of file UPstream.H.

Constructor & Destructor Documentation

commsStruct() [1/3]

commsStruct

(

)

Definition at line 26 of file UPstreamCommsStruct.C.

commsStruct() [2/3]

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

Definition at line 36 of file UPstreamCommsStruct.C.

commsStruct() [3/3]

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

Definition at line 51 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

Definition at line 126 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==(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), lumpedPointState::readData(), Pstream::scatter(), and Pstream::scatterList().

Here is the caller graph for this function:

below()

const labelList& below ( ) const

inlinenoexcept

Definition at line 131 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==(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), lumpedPointState::readData(), Pstream::scatter(), and Pstream::scatterList().

Here is the caller graph for this function:

allBelow()

const labelList& allBelow ( ) const

inlinenoexcept

Definition at line 136 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 141 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 88 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 100 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:

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