Buffers for inter-processor communications streams (UOPstream, UIPstream). More...
Public Member Functions | |
PstreamBuffers (const UPstream::commsTypes commsType, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, IOstream::streamFormat format=IOstream::BINARY, IOstream::versionNumber version=IOstream::currentVersion) | |
Construct given comms type,. More... | |
~PstreamBuffers () | |
Destructor. More... | |
int | tag () const |
void | finishedSends (const bool block=true) |
Mark all sends as having been done. This will start receives. More... | |
void | finishedSends (labelList &recvSizes, const bool block=true) |
Mark all sends as having been done. Same as above but also returns. More... | |
void | clear () |
Clear storage and reset. More... | |
Static Public Attributes | |
static DynamicList< char > | nullBuf |
Friends | |
class | UOPstream |
class | UIPstream |
Buffers for inter-processor communications streams (UOPstream, UIPstream).
Use UOPstream to stream data into buffers, call finishedSends() to notify that data is in buffers and then use IUPstream to get data out of received buffers. Works with both blocking and nonBlocking. Does not make much sense with scheduled since there you would not need these explicit buffers.
Example usage:
PstreamBuffers pBuffers(Pstream::commsTypes::nonBlocking);
for (label proci = 0; proci < Pstream::nProcs(); proci++) { if (proci != Pstream::myProcNo()) { someObject vals;
UOPstream str(proci, pBuffers); str << vals; } }
pBuffers.finishedSends(); // no-op for blocking
for (label proci = 0; proci < Pstream::nProcs(); proci++) { if (proci != Pstream::myProcNo()) { UIPstream str(proci, pBuffers); someObject vals(str); } }
Definition at line 85 of file PstreamBuffers.H.
PstreamBuffers | ( | const UPstream::commsTypes | commsType, |
const int | tag = UPstream::msgType() , |
||
const label | comm = UPstream::worldComm , |
||
IOstream::streamFormat | format = IOstream::BINARY , |
||
IOstream::versionNumber | version = IOstream::currentVersion |
||
) |
Construct given comms type,.
write format and IO version
Definition at line 39 of file PstreamBuffers.C.
~PstreamBuffers | ( | ) |
Destructor.
Definition at line 62 of file PstreamBuffers.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and forAll.
|
inline |
Definition at line 140 of file PstreamBuffers.H.
void finishedSends | ( | const bool | block = true | ) |
Mark all sends as having been done. This will start receives.
in non-blocking mode. If block will wait for all transfers to finish (only relevant for nonBlocking mode)
Definition at line 82 of file PstreamBuffers.C.
References UPstream::nonBlocking.
Referenced by fvMeshDistribute::distribute(), distributionMapBase::distribute(), Foam::patchToPatchTools::distributeAddressing(), cellsToCells::distributeMesh(), patchToPatch::distributePatch(), FvFaceCellWave< Type, TrackingData >::handleProcPatches(), FaceCellWave< Type, TrackingData >::handleProcPatches(), nonConformalMappedFvPatchBase::map(), Cloud< ParticleType >::mapMesh(), MPPICCloud< CloudType >::motion(), pointBoundaryMesh::movePoints(), polyBoundaryMesh::movePoints(), masterUncollatedFileOperation::NewIFstream(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), masterUncollatedFileOperation::scatterList(), distributionMapBase::send(), syncTools::syncBoundaryFaceList(), syncTools::syncEdgeMap(), syncTools::syncFaceList(), syncTools::syncPointMap(), pointBoundaryMesh::topoChange(), polyBoundaryMesh::topoChange(), and masterOFstream::~masterOFstream().
void finishedSends | ( | labelList & | recvSizes, |
const bool | block = true |
||
) |
Mark all sends as having been done. Same as above but also returns.
sizes (bytes) received. Note:currently only valid for non-blocking.
Definition at line 100 of file PstreamBuffers.C.
References UPstream::commsTypeNames, Foam::endl(), Pstream::exchangeSizes(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and UPstream::nonBlocking.
void clear | ( | ) |
|
friend |
Definition at line 87 of file PstreamBuffers.H.
|
friend |
Definition at line 88 of file PstreamBuffers.H.
|
static |
Definition at line 118 of file PstreamBuffers.H.