#include <HandlingPackInfo.h>

Inheritance diagram for walberla::boundary::HandlingPackInfo< Handling_T >:

Public Member Functions
	HandlingPackInfo (const BlockDataID &bdId, const bool assumeIdenticalFlagMapping=true, const uint_t numberOfLayers=0)

	~HandlingPackInfo () override=default

bool	constantDataExchange () const override
	Should return true if the amount of data that is packed for a given block in direction "dir" is guaranteed to remain constant over time.

bool	threadsafeReceiving () const override
	Must return false if calling unpackData and/or communicateLocal is not thread-safe.

void	unpackData (IBlock *receiver, stencil::Direction dir, mpi::RecvBuffer &buffer) override
	Unpack received Data.

void	communicateLocal (const IBlock sender, IBlock receiver, stencil::Direction dir) override
	Copy data from one local block to another local block.

Public Member Functions inherited from walberla::communication::UniformPackInfo
	UniformPackInfo ()=default

virtual	~UniformPackInfo ()=default

void	packData (const IBlock *sender, stencil::Direction dir, mpi::SendBuffer &buffer) const
	Pack data from a block into a send buffer.

virtual void	beforeStartCommunication ()
	This function is called once before the communication is started by the UniformBufferedScheme.

virtual void	afterStartCommunication ()
	This function is called once after the communication has been started by the UniformBufferedScheme.

virtual void	beforeWait ()
	This function is called once before the UniformBufferedScheme waits for the communication to finish.

virtual void	afterWait ()
	This function is called once after the communication has been finished by the UniformBufferedScheme.

Protected Member Functions
void	packDataImpl (const IBlock *sender, stencil::Direction dir, mpi::SendBuffer &buffer) const override
	Pack data from a block into a send buffer.

Protected Member Functions inherited from walberla::communication::UniformPackInfo

Protected Attributes
const BlockDataID	bdId_

const uint_t	numberOfLayers_

const bool	assumeIdenticalFlagMapping_

Protected Attributes inherited from walberla::communication::UniformPackInfo
std::map< const IBlock *, std::map< stencil::Direction, size_t > >	bufferSize_

Constructor & Destructor Documentation

◆ HandlingPackInfo()

template<typename Handling_T >

walberla::boundary::HandlingPackInfo< Handling_T >::HandlingPackInfo	(	const BlockDataID &	bdId,
		const bool	assumeIdenticalFlagMapping = true,
		const uint_t	numberOfLayers = 0 )

inline

◆ ~HandlingPackInfo()

template<typename Handling_T >

walberla::boundary::HandlingPackInfo< Handling_T >::~HandlingPackInfo ( )

overridedefault

Member Function Documentation

◆ communicateLocal()

template<typename Handling_T >

void walberla::boundary::HandlingPackInfo< Handling_T >::communicateLocal	(	const IBlock *	sender,
		IBlock *	receiver,
		stencil::Direction	dir )

overridevirtual

Copy data from one local block to another local block.

Both blocks are allocated on the current process. If NOT thread-safe, threadsafeReceiving must return false!

Parameters

sender	id of block where the data should be copied from
receiver	id of block where the data should be copied to
dir	the direction of the communication ( from sender to receiver )

Implements walberla::communication::UniformPackInfo.

◆ constantDataExchange()

template<typename Handling_T >

bool walberla::boundary::HandlingPackInfo< Handling_T >::constantDataExchange ( ) const

inlineoverridevirtual

Should return true if the amount of data that is packed for a given block in direction "dir" is guaranteed to remain constant over time.

False otherwise. If you are not sure what to return, return false! Returning false is always safe. Falsely returning true will lead to errors! However, if the data can be guaranteed to remain constant over time, returning true enables performance optimizations during the communication.

Implements walberla::communication::UniformPackInfo.

◆ packDataImpl()

template<typename Handling_T >

void walberla::boundary::HandlingPackInfo< Handling_T >::packDataImpl	(	const IBlock *	sender,
		stencil::Direction	dir,
		mpi::SendBuffer &	buffer ) const

overrideprotectedvirtual

Pack data from a block into a send buffer.

Must be thread-safe!

Implementations must reserve extra space and advance the send buffer pointer according to the alignment of the ghost layer data type! The buffer is char-aligned.

Parameters

sender	the block whose data should be packed into a buffer
dir	pack data for neighbor in this direction
buffer	buffer for writing the data into

Implements walberla::communication::UniformPackInfo.

◆ threadsafeReceiving()

template<typename Handling_T >

bool walberla::boundary::HandlingPackInfo< Handling_T >::threadsafeReceiving ( ) const

inlineoverridevirtual

Must return false if calling unpackData and/or communicateLocal is not thread-safe.

True otherwise. If you are not sure what to return, return false! Returning false is always safe. Falsely returning true will most likely lead to errors! However, if both unpackData AND communicateLocal are thread-safe, returning true can lead to performance improvements.

Implements walberla::communication::UniformPackInfo.

◆ unpackData()

template<typename Handling_T >

void walberla::boundary::HandlingPackInfo< Handling_T >::unpackData	(	IBlock *	receiver,
		stencil::Direction	dir,
		mpi::RecvBuffer &	buffer )

overridevirtual

Unpack received Data.

If NOT thread-safe, threadsafeReceiving must return false!

Implementations must reserve extra space and advance the send buffer pointer according to the alignment of the ghost layer data type! The buffer is char-aligned.

Parameters

receiver	the block where the unpacked data should be stored into
dir	receive data from neighbor in this direction
buffer	buffer for reading the data from

Implements walberla::communication::UniformPackInfo.

Member Data Documentation

◆ assumeIdenticalFlagMapping_

template<typename Handling_T >

const bool walberla::boundary::HandlingPackInfo< Handling_T >::assumeIdenticalFlagMapping_

protected

◆ bdId_

template<typename Handling_T >

const BlockDataID walberla::boundary::HandlingPackInfo< Handling_T >::bdId_

protected

◆ numberOfLayers_

template<typename Handling_T >

const uint_t walberla::boundary::HandlingPackInfo< Handling_T >::numberOfLayers_

protected

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

/builds/administration/walberla-website/walberla/src/boundary/communication/HandlingPackInfo.h

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ HandlingPackInfo()

◆ ~HandlingPackInfo()

Member Function Documentation

◆ communicateLocal()

◆ constantDataExchange()

◆ packDataImpl()

◆ threadsafeReceiving()

◆ unpackData()

Member Data Documentation

◆ assumeIdenticalFlagMapping_

◆ bdId_

◆ numberOfLayers_