UPstream::commsStruct Class Reference | OpenFOAM Source Code Guide

The OpenFOAM Foundation

Structure for communicating between processors. More...

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

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.

Referenced by UPstream::commsStruct::commsStruct().

Here is the caller graph for this function:

◆ 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.

References UPstream::commsStruct::commsStruct().

Here is the call graph for this function:

◆ 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 List< T >::size().

Here is the call graph for this function:

Member Function Documentation

◆ above()

label above ( ) const

inline

Definition at line 125 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(), 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.

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(), 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.

Referenced by Pstream::gatherList(), and UPstream::commsStruct::operator==().

Here is the caller graph for this function:

◆ allNotBelow()

const labelList& allNotBelow ( ) const

inline

Definition at line 140 of file UPstream.H.

References Foam::operator!=(), Foam::operator<<(), and Foam::operator==().

Referenced by UPstream::commsStruct::operator==(), and Pstream::scatterList().

Here is the call graph for this function:

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(), UPstream::commsStruct::allBelow(), UPstream::commsStruct::allNotBelow(), and UPstream::commsStruct::below().

Referenced by UPstream::commsStruct::operator!=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const commsStruct & comm ) const

Definition at line 105 of file UPstreamCommsStruct.C.

References UPstream::commsStruct::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