PstreamBuffers Class Reference

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, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	~PstreamBuffers ()
int	tag () const noexcept
label	comm () const noexcept
void	finishedSends (const bool block=true)
void	finishedSends (labelList &recvSizes, const bool block=true)
void	clear ()

Friends
class	UOPstream
class	UIPstream

Detailed Description

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 pBufs(Pstream::commsTypes::nonBlocking);
 
for (const int proci : Pstream::allProcs())
{
    if (proci != Pstream::myProcNo())
    {
        someObject vals;
 
        UOPstream send(proci, pBufs);
        send << vals;
    }
}
 
pBufs.finishedSends();   // no-op for blocking
 
for (const int proci : Pstream::allProcs())
{
    if (proci != Pstream::myProcNo())
    {
        UIPstream recv(proci, pBufs);
        someObject vals(recv);
    }
}

Source files

• PstreamBuffers.H
• PstreamBuffers.C

Definition at line 84 of file PstreamBuffers.H.

Constructor & Destructor Documentation

PstreamBuffers()

PstreamBuffers ( const UPstream::commsTypes  commsType, const int  tag = UPstream::msgType(), const label  comm = UPstream::worldComm, IOstreamOption::streamFormat  fmt = IOstreamOption::BINARY  )

explicit

Definition at line 27 of file PstreamBuffers.C.

~PstreamBuffers()

~PstreamBuffers

(

)

Definition at line 47 of file PstreamBuffers.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, and Foam::nl.

Here is the call graph for this function:

Member Function Documentation

tag()

int tag ( ) const

inlinenoexcept

Definition at line 137 of file PstreamBuffers.H.

comm()

label comm ( ) const

inlinenoexcept

Definition at line 143 of file PstreamBuffers.H.

Referenced by processorPolyPatch::initGeometry(), processorPolyPatch::initUpdateMesh(), and syncObjects::sync().

Here is the caller graph for this function:

finishedSends() [1/2]

void finishedSends

(

const bool

block = true

)

Definition at line 66 of file PstreamBuffers.C.

References UPstream::nonBlocking.

Referenced by fvMeshDistribute::distribute(), mapDistributeBase::distribute(), distributedTriSurfaceMesh::distribute(), box::doRefineBoxes(), globalIndex::get(), zoneDistribute::getDatafromOtherProc(), FaceCellWave< Type, int >::handleProcPatches(), trackingInverseDistance::markDonors(), inverseDistance::markDonors(), trackingInverseDistance::markPatchesAsHoles(), inverseDistance::markPatchesAsHoles(), Cloud< passivePositionParticle >::move(), pointBoundaryMesh::movePoints(), polyBoundaryMesh::movePoints(), masterUncollatedFileOperation::NewIFstream(), RecycleInteraction< CloudType >::postEvolve(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), surfaceNoise::readSurfaceData(), masterUncollatedFileOperation::scatterList(), mapDistributeBase::send(), box::setRefineFlags(), zoneDistribute::setUpCommforZone(), surfaceNoise::surfaceAverage(), syncObjects::sync(), syncTools::syncBoundaryFaceList(), syncTools::syncEdgeMap(), syncTools::syncPointMap(), pointBoundaryMesh::updateMesh(), polyBoundaryMesh::updateMesh(), energySpectrum::write(), and surfaceNoise::writeSurfaceData().

Here is the caller graph for this function:

finishedSends() [2/2]

void finishedSends	(	labelList &	recvSizes,
		const bool	block = true
	)

Definition at line 85 of file PstreamBuffers.C.

References UPstream::commsTypeNames, Foam::endl(), Pstream::exchangeSizes(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and UPstream::nonBlocking.

Here is the call graph for this function:

clear()

void clear

(

)

Definition at line 118 of file PstreamBuffers.C.

Referenced by fvMeshDistribute::distribute(), trackingInverseDistance::markDonors(), inverseDistance::markDonors(), trackingInverseDistance::markPatchesAsHoles(), inverseDistance::markPatchesAsHoles(), Cloud< passivePositionParticle >::move(), RecycleInteraction< CloudType >::postEvolve(), and surfaceNoise::readSurfaceData().

Here is the caller graph for this function:

Friends And Related Function Documentation

UOPstream

friend class UOPstream

friend

Definition at line 86 of file PstreamBuffers.H.

UIPstream

friend class UIPstream

friend

Definition at line 87 of file PstreamBuffers.H.

---

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

• src/OpenFOAM/db/IOstreams/Pstreams/PstreamBuffers.H
• src/OpenFOAM/db/IOstreams/Pstreams/PstreamBuffers.C