This traversal splits the domain into slices along the longer dimension among x and y. More...

#include <VCLSlicedBalancedTraversal.h>

Inheritance diagram for autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >:

[legend]

Collaboration diagram for autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >:

[legend]

Public Member Functions
	VCLSlicedBalancedTraversal (const std::array< unsigned long, 3 > &dims, PairwiseFunctor &pairwiseFunctor, double interactionLength, const std::array< double, 3 > &cellLength, size_t clusterSize, DataLayoutOption dataLayout, bool useNewton3)
	Constructor of the VCLSlicedBalancedTraversal.

TraversalOption	getTraversalType () const override
	Return a enum representing the name of the traversal class.

void	loadDataLayout () override
	Load Data Layouts required for this Traversal if cells have been set through setCellsToTraverse().

void	initTraversal () override
	Load Data Layouts and sets up slice thicknesses.

void	endTraversal () override
	Write Data to AoS if cells have been set through setCellsToTraverse().

void	traverseParticles () override
	Traverse the particles by pairs, triplets etc.

void	setAoSSortingThreshold (size_t aosSortingThreshold) override
	Set the aos-sorting-threshold for traversals that use the CellFunctor If the sum of the number of particles in two cells is greater or equal to that value, the CellFunctor creates a sorted view of the particles to avoid unnecessary distance checks.

void	setSoASortingThreshold (size_t soaSortingThreshold) override
	Set the SoA sorting-threshold for traversals that use the CellFunctor.

Public Member Functions inherited from autopas::SlicedBalancedBasedTraversal< ParticleCell, PairwiseFunctor >
	SlicedBalancedBasedTraversal (const std::array< unsigned long, 3 > &dims, PairwiseFunctor &functor, const double interactionLength, const std::array< double, 3 > &cellLength, DataLayoutOption dataLayout, bool useNewton3, bool spaciallyForward)
	Constructor of the balanced sliced traversal.

void	initSliceThickness (unsigned long minSliceThickness) override
	Calculates slice thickness according to estimates loads.

Public Member Functions inherited from autopas::SlicedLockBasedTraversal< ParticleCell, Functor >
	SlicedLockBasedTraversal (const std::array< unsigned long, 3 > &dims, Functor &functor, const double interactionLength, const std::array< double, 3 > &cellLength, DataLayoutOption dataLayout, bool useNewton3, bool spaciallyForward)
	Constructor of the sliced traversal.

Public Member Functions inherited from autopas::SlicedBasedTraversal< ParticleCell, Functor >
	SlicedBasedTraversal (const std::array< unsigned long, 3 > &dims, Functor &functor, const double interactionLength, const std::array< double, 3 > &cellLength, DataLayoutOption dataLayout, bool useNewton3, bool spaciallyForward)
	Constructor of the sliced traversal.

bool	isApplicableToDomain () const override
	Checks if the traversal is applicable to the current state of the domain.

virtual void	initSliceThickness (unsigned long minSliceThickness)
	Sets up the slice thicknesses to create as many slices as possible while respecting minSliceThickness.

void	initTraversal () override
	Load Data Layouts and sets up slice thicknesses.

void	endTraversal () override
	Write Data to AoS if cells have been set through setCellsToTraverse().

Public Member Functions inherited from autopas::CellTraversal< ParticleCell >
	CellTraversal (const std::array< unsigned long, 3 > &dims)
	Constructor of CellTraversal.

virtual	~CellTraversal ()=default
	Destructor of CellTraversal.

virtual void	setCellsToTraverse (std::vector< ParticleCell > &cells)
	Sets the cells to iterate over.

virtual void	setAoSSortingThreshold (size_t aosSortingThreshold)=0
	Set the aos-sorting-threshold for traversals that use the CellFunctor If the sum of the number of particles in two cells is greater or equal to that value, the CellFunctor creates a sorted view of the particles to avoid unnecessary distance checks.

virtual void	setSoASortingThreshold (size_t soaSortingThreshold)=0
	Set the SoA sorting-threshold for traversals that use the CellFunctor.

Public Member Functions inherited from autopas::TraversalInterface
virtual	~TraversalInterface ()=default
	Destructor of TraversalInterface.

	TraversalInterface (DataLayoutOption dataLayout, bool useNewton3)
	Constructor of the TraversalInterface.

virtual TraversalOption	getTraversalType () const =0
	Return a enum representing the name of the traversal class.

virtual bool	isApplicableToDomain () const =0
	Checks if the traversal is applicable to the current state of the domain.

virtual void	initTraversal ()=0
	Initializes the traversal.

virtual void	traverseParticles ()=0
	Traverse the particles by pairs, triplets etc.

virtual void	endTraversal ()=0
	Finalizes the traversal.

bool	getUseNewton3 () const
	Return whether the traversal uses newton 3.

DataLayoutOption	getDataLayout () const
	Return the data layout option.

Public Member Functions inherited from autopas::BalancedTraversal
void	setLoadEstimator (EstimatorFunction loadEstimator)
	Setter for load estimation algorithm.

Public Member Functions inherited from autopas::VCLTraversalInterface< ParticleCell::ParticleType >
virtual	~VCLTraversalInterface ()=default
	virtual default destructor.

virtual void	setClusterLists (VerletClusterLists< ParticleCell::ParticleType > &verletClusterLists)
	Sets the cluster list for the traversal to iterate over.

virtual void	setTowers (std::vector< internal::ClusterTower< ParticleCell::ParticleType > > &towers)
	Sets the towers of the cluster list for the traversal to iterate over.

virtual bool	needsStaticClusterThreadPartition ()
	Returns whether this traversal needs the static cluster thread partition of the cluster list.

Additional Inherited Members
Public Types inherited from autopas::BalancedTraversal
using	EstimatorFunction = std::function< unsigned long(const std::array< unsigned long, 3 > &, const std::array< unsigned long, 3 > &, const std::array< unsigned long, 3 > &)>
	Type signature for load estimators.

Protected Member Functions inherited from autopas::SlicedLockBasedTraversal< ParticleCell, Functor >
template<typename LoopBody >
void	slicedTraversal (LoopBody &&loopBody)
	The main traversal of the sliced traversal.

Protected Member Functions inherited from autopas::SlicedBasedTraversal< ParticleCell, Functor >
void	init ()
	Resets the cell structure of the traversal.

virtual void	loadDataLayout ()
	Load Data Layouts required for this Traversal if cells have been set through setCellsToTraverse().

void	reinitForVCL (const VerletClusterLists< typename ParticleCell::ParticleType > *vcl)
	Update cell information based on VerletClusterLists.

Protected Attributes inherited from autopas::SlicedLockBasedTraversal< ParticleCell, Functor >
bool	_dynamic = true
	whether to use static or dynamic scheduling.

Protected Attributes inherited from autopas::SlicedBasedTraversal< ParticleCell, Functor >
std::array< unsigned long, 3 >	_overlap
	Overlap of interacting cells.

std::array< int, 3 >	_dimsSortedByLength
	Store ids of dimensions (0, 1, 2 = x, y, z) sorted by in decreasing order of number of cells in that dimension.

unsigned long	_overlapLongestAxis
	Overlap of interacting cells along the longest axis.

std::vector< unsigned long >	_sliceThickness
	The number of cells per slice in the dimension that was sliced.

bool	_spaciallyForward
	Whether the base step only covers neigboring cells tha are spacially forward (for example c08).

std::array< double, 3 >	_cellLength
	Cell length in CellBlock3D.

Protected Attributes inherited from autopas::CellTraversal< ParticleCell >
std::array< unsigned long, 3 >	_cellsPerDimension
	The dimensions of the cellblock.

std::vector< ParticleCell > *	_cells
	The cells to traverse.

Protected Attributes inherited from autopas::TraversalInterface
DataLayoutOption	_dataLayout
	The datalayout used by this traversal.

bool	_useNewton3
	If this traversal makes use of newton3.

Protected Attributes inherited from autopas::BalancedTraversal
EstimatorFunction	_loadEstimator
	Algorithm to use for estimating load.

Protected Attributes inherited from autopas::VCLTraversalInterface< ParticleCell::ParticleType >
VerletClusterLists< ParticleCell::ParticleType > *	_verletClusterLists
	The cluster list to iterate over.

std::vector< internal::ClusterTower< ParticleCell::ParticleType > > *	_towers
	The towers of the cluster list to iterate over.

Detailed Description

template<class ParticleCell, class PairwiseFunctor>
class autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >

This traversal splits the domain into slices along the longer dimension among x and y.

The slices are processed in parallel by multiple threads. Race conditions are prevented, by placing locks on the starting layers of each slice.

Template Parameters

ParticleCell
PairwiseFunctor

Constructor & Destructor Documentation

◆ VCLSlicedBalancedTraversal()

template<class ParticleCell , class PairwiseFunctor >

autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >::VCLSlicedBalancedTraversal	(	const std::array< unsigned long, 3 > &	dims,
		PairwiseFunctor &	pairwiseFunctor,
		double	interactionLength,
		const std::array< double, 3 > &	cellLength,
		size_t	clusterSize,
		DataLayoutOption	dataLayout,
		bool	useNewton3
	)

inlineexplicit

Constructor of the VCLSlicedBalancedTraversal.

Parameters

dims	The dimensions of the cellblock, i.e. the number of cells in x, y and z direction.
pairwiseFunctor	The functor to use for the traveral.
interactionLength	Interaction length (cutoff + skin).
cellLength	cell length.
clusterSize	the number of particles per cluster.
dataLayout
useNewton3

Member Function Documentation

◆ endTraversal()

template<class ParticleCell , class PairwiseFunctor >

void autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >::endTraversal ( )

inlineoverridevirtual

Write Data to AoS if cells have been set through setCellsToTraverse().

Todo:: find a condition on when to use omp or when it is just overhead

Reimplemented from autopas::SlicedBasedTraversal< ParticleCell, Functor >.

◆ getTraversalType()

template<class ParticleCell , class PairwiseFunctor >

TraversalOption autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >::getTraversalType ( ) const

inlineoverridevirtual

Return a enum representing the name of the traversal class.

Returns: Enum representing traversal.

Implements autopas::TraversalInterface.

◆ initTraversal()

template<class ParticleCell , class PairwiseFunctor >

void autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >::initTraversal ( )

inlineoverridevirtual

Load Data Layouts and sets up slice thicknesses.

Reimplemented from autopas::SlicedBasedTraversal< ParticleCell, Functor >.

◆ loadDataLayout()

template<class ParticleCell , class PairwiseFunctor >

void autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >::loadDataLayout ( )

inlineoverridevirtual

Load Data Layouts required for this Traversal if cells have been set through setCellsToTraverse().

Todo:: find a condition on when to use omp or when it is just overhead

Reimplemented from autopas::SlicedBasedTraversal< ParticleCell, Functor >.

◆ setAoSSortingThreshold()

template<class ParticleCell , class PairwiseFunctor >

void autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >::setAoSSortingThreshold ( size_t aosSortingThreshold )

inlineoverridevirtual

Set the aos-sorting-threshold for traversals that use the CellFunctor If the sum of the number of particles in two cells is greater or equal to that value, the CellFunctor creates a sorted view of the particles to avoid unnecessary distance checks.

Parameters

aosSortingThreshold Sum of the number of particles in two cells from which sorting should be enabled This traversal does not use the CellFunctor, so the function has no effect here

Implements autopas::CellTraversal< ParticleCell >.

◆ setSoASortingThreshold()

template<class ParticleCell , class PairwiseFunctor >

void autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >::setSoASortingThreshold ( size_t soaSortingThreshold )

inlineoverridevirtual

Set the SoA sorting-threshold for traversals that use the CellFunctor.

If the sum of the SoA buffer sizes of two cells exceeds this value, the SoA path uses SoAFunctorPairSorted. Traversals that hold a CellFunctor should forward to it; others should explicitly override with an empty body.

Parameters

soaSortingThreshold Sum of the SoA buffer sizes from which SoA sorting should be enabled.

Implements autopas::CellTraversal< ParticleCell >.

◆ traverseParticles()

template<class ParticleCell , class PairwiseFunctor >

void autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >::traverseParticles ( )

inlineoverridevirtual

Traverse the particles by pairs, triplets etc.

as determined by the Functor type.

Implements autopas::TraversalInterface.

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

autopas/containers/verletClusterLists/traversals/VCLSlicedBalancedTraversal.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VCLSlicedBalancedTraversal()

Member Function Documentation

◆ endTraversal()

◆ getTraversalType()

◆ initTraversal()

◆ loadDataLayout()

◆ setAoSSortingThreshold()

◆ setSoASortingThreshold()

◆ traverseParticles()