autopas::VLListIterationTraversal< ParticleCell, PairwiseFunctor > Class Template Reference

This class provides a Traversal for the verlet lists container. More...

#include <VLListIterationTraversal.h>

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

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

Public Member Functions
	VLListIterationTraversal (PairwiseFunctor *pairwiseFunctor, DataLayoutOption dataLayout, bool useNewton3)
	Constructor for Verlet Traversal.
TraversalOption	getTraversalType () const override
	Return a enum representing the name of the traversal class.
bool	isApplicable () 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.
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.
Public Member Functions inherited from autopas::VLTraversalInterface< ParticleCell >
virtual	~VLTraversalInterface ()=default
	Destructor.
virtual void	setCellsAndNeighborLists (std::vector< ParticleCell > &cells, typename VerletListHelpers< typename LinkedParticleCell::ParticleType >::NeighborListAoSType &aosNeighborLists, std::vector< std::vector< size_t, autopas::AlignedAllocator< size_t > > > &soaNeighborLists)
	Sets the information the traversal needs for the iteration.

Additional Inherited Members
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::VLTraversalInterface< ParticleCell >
std::vector< ParticleCell > *	_cells
	The cells of the underlying linked cells container of the verlet lists container.
VerletListHelpers< typenameLinkedParticleCell::ParticleType >::NeighborListAoSType *	_aosNeighborLists
	The AoS neighbor list of the verlet lists container.
std::vector< std::vector< size_t, autopas::AlignedAllocator< size_t > > > *	_soaNeighborLists
	The SoA neighbor list of the verlet lists container.

Detailed Description

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

This class provides a Traversal for the verlet lists container.

Template Parameters

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

Constructor & Destructor Documentation

VLListIterationTraversal()

template<class ParticleCell , class PairwiseFunctor >

autopas::VLListIterationTraversal< ParticleCell, PairwiseFunctor >::VLListIterationTraversal ( PairwiseFunctor *  pairwiseFunctor, DataLayoutOption  dataLayout, bool  useNewton3  )

inlineexplicit

Constructor for Verlet Traversal.

Parameters

pairwiseFunctor	Functor to be used with this Traversal
dataLayout
useNewton3

Member Function Documentation

endTraversal()

template<class ParticleCell , class PairwiseFunctor >

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

inlineoverridevirtual

Finalizes the traversal.

Should be called after traverse().

Implements autopas::TraversalInterface.

getTraversalType()

template<class ParticleCell , class PairwiseFunctor >

TraversalOption autopas::VLListIterationTraversal< 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::VLListIterationTraversal< ParticleCell, PairwiseFunctor >::initTraversal ( )

inlineoverridevirtual

Initializes the traversal.

Should be called before traverse().

Implements autopas::TraversalInterface.

isApplicable()

template<class ParticleCell , class PairwiseFunctor >

bool autopas::VLListIterationTraversal< ParticleCell, PairwiseFunctor >::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.

traverseParticles()

template<class ParticleCell , class PairwiseFunctor >

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

inlineoverridevirtual

Traverse the particles by pairs, triplets etc.

as determined by the Functor type.

Todo:

find a sensible chunk size

Todo:

find a sensible chunk size

Implements autopas::TraversalInterface.

---

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

• autopas/containers/verletListsCellBased/verletLists/traversals/VLListIterationTraversal.h