Pstream::commsStruct Class Reference

Structure for communicating between processors. More...

#include <src/OpenFOAM/db/IOstreams/Pstreams/Pstream.H>

---

Detailed Description

Structure for communicating between processors.

Definition at line 71 of file Pstream.H.

Collaboration diagram for Pstream::commsStruct:

List of all members.

Public Member Functions
	commsStruct ()
	Construct null.
	commsStruct (const label, const labelList &, const labelList &, const labelList &)
	Construct from components.
	commsStruct (const label nProcs, const label myProcID, const label, const labelList &, const labelList &)
	Construct from components; construct allNotBelow_.
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 &)

---

Constructor & Destructor Documentation

commsStruct

(

)

Construct null.

Definition at line 31 of file PstreamCommsStruct.C.

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

Construct from components.

Definition at line 41 of file PstreamCommsStruct.C.

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 PstreamCommsStruct.C.

References Pstream::abort(), Foam::FatalError, FatalErrorIn, and forAll.

---

Member Function Documentation

label above

(

)

const [inline]

Definition at line 120 of file Pstream.H.

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

const labelList& below

(

)

const [inline]

Definition at line 125 of file Pstream.H.

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

const labelList& allBelow

(

)

const [inline]

Definition at line 130 of file Pstream.H.

Referenced by Pstream::gatherList().

const labelList& allNotBelow

(

)

const [inline]

Definition at line 135 of file Pstream.H.

Referenced by Pstream::scatterList().

bool operator==

(

const commsStruct &

comm  )

const

Definition at line 93 of file PstreamCommsStruct.C.

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

bool operator!=

(

const commsStruct &

comm  )

const

Definition at line 105 of file PstreamCommsStruct.C.

References Foam::operator==().

---

Friends And Related Function Documentation

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

---

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

• src/OpenFOAM/db/IOstreams/Pstreams/Pstream.H
• src/OpenFOAM/db/IOstreams/Pstreams/PstreamCommsStruct.C