FreeFOAM The Cross-Platform CFD Toolkit
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.

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 labelListbelow () const
const labelListallBelow () const
const labelListallNotBelow () const
bool operator== (const commsStruct &) const
bool operator!= (const commsStruct &) const

Friends

Ostreamoperator<< (Ostream &, const commsStruct &)

Constructor & Destructor Documentation

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

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
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: