walberla::v8::sweep::SweepFactory Class Reference

Detailed Description

Factory for derived and wrapper sweeps.

Objects of this class can be used to construct derived sweeps from existing sweep objects. This inclused fusing sweeps, restricting them to certain cell intervals (TODO) or domain borders, or selectively activating them according to certain conditions (TODO).

#include <DomainSlices.hpp>

Public Member Functions
	SweepFactory (const shared_ptr< StructuredBlockForest > &blocks)
template<stencil::Direction Dir, CellIntervalSweep Sweep_T>
BorderSweep< Dir, Sweep_T >	atDomainBorder (const Sweep_T &sweep, cell_idx_t offset=0, uint_t thickness=1, cell_idx_t expand=0)
	Restrict a sweep to a slice at the simulation domain border.
auto	fuse (const Sweep auto &... sweeps)
	Fuse a sequence of sweeps.
template<CommHidingIntervall Intervall_T, CellIntervalSweep Sweep_T>
CommHidingSweep< Intervall_T, Sweep_T >	commHidingSweep (Sweep_T &sweep, Cell innerOuterSplit=Cell(1, 1, 1))
	INNER and OUTER sweep for communication hiding.

Private Attributes
std::shared_ptr< StructuredBlockForest >	blocks_

Constructor & Destructor Documentation

SweepFactory()

walberla::v8::sweep::SweepFactory::SweepFactory ( const shared_ptr< StructuredBlockForest > & blocks )

inline

Member Function Documentation

atDomainBorder()

template<stencil::Direction Dir, CellIntervalSweep Sweep_T>

BorderSweep< Dir, Sweep_T > walberla::v8::sweep::SweepFactory::atDomainBorder ( const Sweep_T & sweep, cell_idx_t offset = 0, uint_t thickness = 1, cell_idx_t expand = 0 )

inline

Restrict a sweep to a slice at the simulation domain border.

Return a wrapper sweep which executes the given sweep only on cells at the simulation domain border specified by the Dir template argument.

Parameters

sweep	The original sweep object
offset	Offset of the outermost cell layer of the border slice from the actual border. 0 means the outermost layer of valid cells, negative numbers shift the slice into the ghost layer, while positive numbers shift it into the domain.
thickness	Thickness of the iteration slice; must be a positive number.
expand	Number of cells by which to expand the slice into ghost layers along the border.

commHidingSweep()

template<CommHidingIntervall Intervall_T, CellIntervalSweep Sweep_T>

CommHidingSweep< Intervall_T, Sweep_T > walberla::v8::sweep::SweepFactory::commHidingSweep ( Sweep_T & sweep, Cell innerOuterSplit = Cell(1,1,1) )

inline

INNER and OUTER sweep for communication hiding.

Return a wrapper sweep which executes the given sweep only on cells in the inner or outer part of the simulation domain

Parameters

sweep	The original sweep object
innerOuterSplit	Thickness of the outer iteration slice in 3 dimensions

Note

Field swaps for AB streaming pattern are performed only after the OUTER sweep.

fuse()

auto walberla::v8::sweep::SweepFactory::fuse ( const Sweep auto &... sweeps )

inline

Fuse a sequence of sweeps.

Return a new wrapper sweep which, on each block, executes all of the given sweeps in the specified order.

Member Data Documentation

blocks_

std::shared_ptr< StructuredBlockForest > walberla::v8::sweep::SweepFactory::blocks_

private

---

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

• /builds/administration/walberla-website/walberla/include/walberla/v8/sweep/DomainSlices.hpp