ESyS-Particle  2.3.4
BroadcastCommand Class Reference

base class for broadcast commands More...

#include <BroadCast_cmd.h>

Inheritance diagram for BroadcastCommand:
Collaboration diagram for BroadcastCommand:

Public Member Functions

 BroadcastCommand (const MpiRankAndComm &rankAndComm, int cmdId)
 
virtual ~BroadcastCommand ()
 
template<typename TmplData >
void appendTypeAndName (const TmplData &namedWithType)
 
template<typename TmplData >
void append (const TmplData &basicTypeData)
 
template<typename TmplPackable >
void packInto (const TmplPackable &)
 
const int & getCommandId () const
 
void broadcastCommand ()
 
void broadcastBuffer ()
 
void wait (const std::string &barrierName)
 
void broadcast ()
 

Private Attributes

int m_commandId
 
CVarMPIBuffer m_varBuffer
 
CMPIBarrier m_barrier
 
CMPILCmdBuffer m_cmdBuffer
 

Detailed Description

base class for broadcast commands

Constructor & Destructor Documentation

◆ BroadcastCommand()

BroadcastCommand::BroadcastCommand ( const MpiRankAndComm rankAndComm,
int  cmdId 
)

◆ ~BroadcastCommand()

virtual BroadcastCommand::~BroadcastCommand ( )
inlinevirtual

Member Function Documentation

◆ append()

◆ appendTypeAndName()

template<typename TmplData >
void BroadcastCommand::appendTypeAndName ( const TmplData &  namedWithType)

Appends namedWithType.getTypeString() and namedWithType.getName() strings to the data buffer.

References CVarMPIBuffer::append(), and m_varBuffer.

Referenced by CLatticeMaster::addMesh2DIG(), CLatticeMaster::addTriMeshIG(), IGPCommand::appendIGP(), RotIGPCommand::appendIGP(), and TaggedIGPCommand::appendIGP().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ broadcast()

◆ broadcastBuffer()

void BroadcastCommand::broadcastBuffer ( )

Broadcasts the data buffer.

References CVarMPIBuffer::broadcast(), and m_varBuffer.

Referenced by broadcast(), CLatticeMaster::visitMesh2dEdgeStress(), and CLatticeMaster::visitTriMeshFaceForce().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ broadcastCommand()

void BroadcastCommand::broadcastCommand ( )

Broadcasts the command (ie the command id).

References CMPILCmdBuffer::broadcast(), getCommandId(), and m_cmdBuffer.

Referenced by broadcast(), CLatticeMaster::getNumParticles(), CLatticeMaster::visitMesh2dEdgeStress(), CLatticeMaster::visitParticlesOfType(), and CLatticeMaster::visitTriMeshFaceForce().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getCommandId()

const int & BroadcastCommand::getCommandId ( ) const

Returns the command id of this broadcast-command.

References m_commandId.

Referenced by broadcastCommand().

Here is the caller graph for this function:

◆ packInto()

template<typename TmplPackable >
void BroadcastCommand::packInto ( const TmplPackable &  packable)

Packs the specified data into the data-buffer.

References m_varBuffer.

Referenced by CLatticeMaster::addDamping(), CLatticeMaster::addSphereBodyIG(), CLatticeMaster::addTaggedWallIG(), CLatticeMaster::addWallIG(), SIGCommand::appendBuoyancyIGP(), and SIGCommand::appendGravityIGP().

Here is the caller graph for this function:

◆ wait()

void BroadcastCommand::wait ( const std::string &  barrierName)

Barrier wait.

References m_barrier, and CMPIBarrier::wait().

Referenced by broadcast(), CLatticeMaster::getNumParticles(), CLatticeMaster::visitMesh2dEdgeStress(), CLatticeMaster::visitParticlesOfType(), and CLatticeMaster::visitTriMeshFaceForce().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_barrier

CMPIBarrier BroadcastCommand::m_barrier
private

Referenced by wait().

◆ m_cmdBuffer

CMPILCmdBuffer BroadcastCommand::m_cmdBuffer
private

Referenced by broadcastCommand().

◆ m_commandId

int BroadcastCommand::m_commandId
private

Referenced by getCommandId().

◆ m_varBuffer

CVarMPIBuffer BroadcastCommand::m_varBuffer
private

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