autopas::DSSequentialTraversal< ParticleCell, Functor > Class Template Reference

This sum defines the traversal typically used by the DirectSum container. More...

#include <DSSequentialTraversal.h>

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

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

Public Member Functions
	DSSequentialTraversal (Functor &functor, double cutoff, DataLayoutOption dataLayout, bool useNewton3)
	Constructor for the DirectSum traversal.
TraversalOption	getTraversalType () const override
	Return a enum representing the name of the traversal class.
bool	isApplicableToDomain () const override
	Checks if the traversal is applicable to the current state of the domain.
void	initTraversal () override
	Initializes the traversal.
void	endTraversal () override
	Finalizes the traversal.
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::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.

Additional Inherited Members
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::DSSequentialTraversal< ParticleCell, Functor >

This sum defines the traversal typically used by the DirectSum container.

Template Parameters

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

Constructor & Destructor Documentation

DSSequentialTraversal()

template<class ParticleCell , class Functor >

autopas::DSSequentialTraversal< ParticleCell, Functor >::DSSequentialTraversal ( Functor &  functor, double  cutoff, DataLayoutOption  dataLayout, bool  useNewton3  )

inlineexplicit

Constructor for the DirectSum traversal.

Parameters

functor	The functor that defines the interaction of particles.
cutoff	cutoff (this is enough for the directsum traversal, please don't use the interaction length here.)
dataLayout	The data layout with which this traversal should be initialized.
useNewton3	Parameter to specify whether the traversal makes use of newton3 or not.

Member Function Documentation

endTraversal()

template<class ParticleCell , class Functor >

void autopas::DSSequentialTraversal< ParticleCell, Functor >::endTraversal ( )

inlineoverridevirtual

Finalizes the traversal.

Should be called after traverse().

Implements autopas::TraversalInterface.

getTraversalType()

template<class ParticleCell , class Functor >

TraversalOption autopas::DSSequentialTraversal< ParticleCell, Functor >::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 Functor >

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

inlineoverridevirtual

Initializes the traversal.

Should be called before traverse().

Implements autopas::TraversalInterface.

isApplicableToDomain()

template<class ParticleCell , class Functor >

bool autopas::DSSequentialTraversal< ParticleCell, Functor >::isApplicableToDomain ( ) const

inlineoverridevirtual

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

This is designed to only return false if the traversal is inapplicable for domain-related issues. Domain-independent factors in a traversal being inapplicable should be handled by Configuration::hasCompatibleValues.

Returns

true iff the traversal is applicable to the domain.

Implements autopas::TraversalInterface.

setAoSSortingThreshold()

template<class ParticleCell , class Functor >

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

Implements autopas::CellTraversal< ParticleCell >.

setSoASortingThreshold()

template<class ParticleCell , class Functor >

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

void autopas::DSSequentialTraversal< ParticleCell, Functor >::traverseParticles

overridevirtual

Traverse the particles by pairs, triplets etc.

as determined by the Functor type.

Note

This function expects a vector of exactly two cells. First cell is the main region, second is halo.

Implements autopas::TraversalInterface.

---

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

• autopas/containers/directSum/traversals/DSSequentialTraversal.h