Detailed Description

template<typename PdfField_T>
class walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >

Pack Info class template for lattice Boltzmann PDF fields.

Relies on a code-generated class providing kernel implementations for packing, unpacking and local copying of data.

This template relies on a PackingKernels implementation generated by lbmpy_walberla.packing_kernels. The code generated part provides the kernels for transferring data between communication buffers and fields. The iteration slices are constructed by this class.

The code-generated substructure enables the usage of arbitrary, in particular in-place streaming patterns.

Template Parameters

PackingKernels_T Type of a PackingKernels implementation generated using lbmpy_walberla.generate_packing_kernels.

#include <UniformGeneratedPdfPackInfo.h>

Inheritance diagram for walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >:

Public Types
using	LatticeStorageSpecification_T = typename PdfField_T::LatticeStorageSpecification

using	PackingKernels_T = typename LatticeStorageSpecification_T::PackKernels

using	Stencil = typename LatticeStorageSpecification_T::Stencil

Public Member Functions
	UniformGeneratedPdfPackInfo (const BlockDataID pdfFieldID, cell_idx_t cellLayersToSend=1, bool sendAll=false)
	Constructor. More...

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. More...

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

void	unpackData (IBlock *receiver, Direction dir, mpi::RecvBuffer &buffer) override

void	communicateLocal (const IBlock sender, IBlock receiver, Direction dir) override

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
	Packs data from a block into a send buffer. More...

virtual void	unpackData (IBlock *receiver, stencil::Direction dir, mpi::RecvBuffer &buffer)=0
	Unpacks received Data. More...

virtual void	communicateLocal (const IBlock sender, IBlock receiver, stencil::Direction dir)=0
	Function to copy data from one local block to another local block. More...

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

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

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

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

Protected Member Functions
void	packDataImpl (const IBlock *sender, Direction dir, mpi::SendBuffer &buffer) const override

Protected Member Functions inherited from walberla::communication::UniformPackInfo
virtual void	packDataImpl (const IBlock *sender, stencil::Direction dir, mpi::SendBuffer &buffer) const =0
	Packs data from a block into a send buffer. More...

Private Attributes
const BlockDataID	pdfFieldID_

internal::UniformPackingKernelsWrapper< PdfField_T, LatticeStorageSpecification_T::inplace >	kernels_

cell_idx_t	ghostLayersToSend_

bool	sendAll_

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

Member Typedef Documentation

◆ LatticeStorageSpecification_T

template<typename PdfField_T >

using walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::LatticeStorageSpecification_T = typename PdfField_T::LatticeStorageSpecification

◆ PackingKernels_T

template<typename PdfField_T >

using walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::PackingKernels_T = typename LatticeStorageSpecification_T::PackKernels

◆ Stencil

template<typename PdfField_T >

using walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::Stencil = typename LatticeStorageSpecification_T::Stencil

Constructor & Destructor Documentation

◆ UniformGeneratedPdfPackInfo()

template<typename PdfField_T >

walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::UniformGeneratedPdfPackInfo	(	const BlockDataID	pdfFieldID,
		cell_idx_t	cellLayersToSend = `1`,
		bool	sendAll = `false`
	)

inline

Constructor.

Parameters

pdfFieldID	ID of the associated walberla::lbm::PdfField
cellLayersToSend	The amount of cell layers that should be communicated
sendAll	If true, instead of only those populations streaming in subdirections of the communication direction, all populations will always be communicated.

Warning: Be careful when using this option with any streaming pattern other than the pull pattern. Other patterns store at least some of their post-collision populations in neighbouring cells. This might lead to out-of-bounds errors when copying to the outermost ghost layer! Solve this by adding an additional ghost layer as a safety margin.

Member Function Documentation

◆ communicateLocal()

template<typename PdfField_T >

void walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::communicateLocal	(	const IBlock *	sender,
		IBlock *	receiver,
		Direction	dir
	)

override

◆ constantDataExchange()

template<typename PdfField_T >

bool walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_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 save. Falsely return 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 PdfField_T >

void walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::packDataImpl	(	const IBlock *	sender,
		Direction	dir,
		mpi::SendBuffer &	buffer
	)		const

overrideprotected

◆ threadsafeReceiving()

template<typename PdfField_T >

bool walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_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 save. Falsely return 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 PdfField_T >

void walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::unpackData	(	IBlock *	receiver,
		Direction	dir,
		mpi::RecvBuffer &	buffer
	)

override

Member Data Documentation

◆ ghostLayersToSend_

template<typename PdfField_T >

cell_idx_t walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::ghostLayersToSend_

private

◆ kernels_

template<typename PdfField_T >

internal::UniformPackingKernelsWrapper< PdfField_T, LatticeStorageSpecification_T::inplace > walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::kernels_

private

◆ pdfFieldID_

template<typename PdfField_T >

const BlockDataID walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::pdfFieldID_

private

◆ sendAll_

template<typename PdfField_T >

bool walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >::sendAll_

private

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

/builds/administration/walberla-website/walberla/src/lbm_generated/communication/UniformGeneratedPdfPackInfo.h

Detailed Description

template<typename PdfField_T> class walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ LatticeStorageSpecification_T

◆ PackingKernels_T

◆ Stencil

Constructor & Destructor Documentation

◆ UniformGeneratedPdfPackInfo()

Member Function Documentation

◆ communicateLocal()

◆ constantDataExchange()

◆ packDataImpl()

◆ threadsafeReceiving()

◆ unpackData()

Member Data Documentation

◆ ghostLayersToSend_

◆ kernels_

◆ pdfFieldID_

◆ sendAll_

template<typename PdfField_T>
class walberla::lbm_generated::UniformGeneratedPdfPackInfo< PdfField_T >