This class provides base for locked- and colored sliced traversals. More...

#include <SlicedBasedTraversal.h>

Inheritance diagram for autopas::SlicedBasedTraversal< ParticleCell, Functor >:

[legend]

Collaboration diagram for autopas::SlicedBasedTraversal< ParticleCell, Functor >:

[legend]

Public Member Functions
	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	isApplicable () 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	setSortingThreshold (size_t sortingThreshold)=0
	Set the 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.

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	isApplicable () 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.

Protected Member Functions
void	init (const std::array< unsigned long, 3 > &dims)
	Resets the cell structure of the traversal.

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

Protected Attributes
std::array< unsigned long, 3 >	_overlap
	Overlap of interacting cells.

std::array< int, 3 >	_dimsPerLength
	Store ids of dimensions ordered by number of cells per dimensions.

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

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.

Detailed Description

template<class ParticleCell, class Functor>
class autopas::SlicedBasedTraversal< ParticleCell, Functor >

This class provides base for locked- and colored sliced traversals.

These traversals find the longest dimension of the simulation domain and cut the domain into multiple slices along this dimension. Slices are assigned to the threads in a round robin fashion.

Template Parameters

ParticleCell	The type of cells.
Functor	The functor that defines the interaction between particles.

Constructor & Destructor Documentation

◆ SlicedBasedTraversal()

template<class ParticleCell , class Functor >

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
	)

inlineexplicit

Constructor of the sliced traversal.

Parameters

dims	The dimensions of the cellblock, i.e. the number of cells in x, y and z direction.
functor	The functor that defines the interaction between particles.
interactionLength	Interaction length (cutoff + skin).
cellLength	cell length.
dataLayout	The data layout with which this traversal should be initialized.
useNewton3	Parameter to specify whether the traversal makes use of newton3 or not.
spaciallyForward	Whether the base step only covers neighboring cells that are spacially forward (for example c08).

Member Function Documentation

◆ endTraversal()

template<class ParticleCell , class Functor >

void autopas::SlicedBasedTraversal< ParticleCell, Functor >::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

Implements autopas::TraversalInterface.

Reimplemented in autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >, autopas::VCLSlicedC02Traversal< ParticleCell, PairwiseFunctor >, and autopas::VCLSlicedTraversal< ParticleCell, PairwiseFunctor >.

◆ init()

template<class ParticleCell , class Functor >

void autopas::SlicedBasedTraversal< ParticleCell, Functor >::init ( const std::array< unsigned long, 3 > & dims )

inlineprotected

Resets the cell structure of the traversal.

Parameters

dims

◆ initSliceThickness()

template<class ParticleCell , class Functor >

virtual void autopas::SlicedBasedTraversal< ParticleCell, Functor >::initSliceThickness ( unsigned long minSliceThickness )

inlinevirtual

Sets up the slice thicknesses to create as many slices as possible while respecting minSliceThickness.

Parameters

minSliceThickness

Reimplemented in autopas::SlicedBalancedBasedTraversal< ParticleCell, Functor >, and autopas::SlicedBalancedBasedTraversal< ParticleCell, PairwiseFunctor >.

◆ initTraversal()

template<class ParticleCell , class Functor >

void autopas::SlicedBasedTraversal< ParticleCell, Functor >::initTraversal ( )

inlineoverridevirtual

Load Data Layouts and sets up slice thicknesses.

Implements autopas::TraversalInterface.

Reimplemented in autopas::SlicedC02BasedTraversal< ParticleCell, Functor >, and autopas::SlicedC02BasedTraversal< ParticleCell, PairwiseFunctor >.

◆ isApplicable()

template<class ParticleCell , class Functor >

bool autopas::SlicedBasedTraversal< ParticleCell, Functor >::isApplicable ( ) const

inlineoverridevirtual

Checks if the traversal is applicable to the current state of the domain.

Returns: true iff the traversal can be applied.

Implements autopas::TraversalInterface.

Reimplemented in autopas::SlicedC02BasedTraversal< ParticleCell, Functor >, autopas::SlicedC02BasedTraversal< ParticleCell, PairwiseFunctor >, autopas::VLCSlicedBalancedTraversal< ParticleCell, PairwiseFunctor, NeighborList >, autopas::VLCSlicedC02Traversal< ParticleCell, PairwiseFunctor, NeighborList >, and autopas::VLCSlicedTraversal< ParticleCell, PairwiseFunctor, NeighborList >.

◆ loadDataLayout()

template<class ParticleCell , class Functor >

virtual void autopas::SlicedBasedTraversal< ParticleCell, Functor >::loadDataLayout ( )

inlineprotectedvirtual

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 in autopas::VCLSlicedBalancedTraversal< ParticleCell, PairwiseFunctor >, autopas::VCLSlicedC02Traversal< ParticleCell, PairwiseFunctor >, and autopas::VCLSlicedTraversal< ParticleCell, PairwiseFunctor >.

Member Data Documentation

◆ _overlap

template<class ParticleCell , class Functor >

std::array<unsigned long, 3> autopas::SlicedBasedTraversal< ParticleCell, Functor >::_overlap

protected

Overlap of interacting cells.

Array allows asymmetric cell sizes.

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

autopas/containers/cellTraversals/SlicedBasedTraversal.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SlicedBasedTraversal()

Member Function Documentation

◆ endTraversal()

◆ init()

◆ initSliceThickness()

◆ initTraversal()

◆ isApplicable()

◆ loadDataLayout()

Member Data Documentation

◆ _overlap