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

Traversal for VerletClusterLists. More...

#include <VCLClusterIterationTraversal.h>

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

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

Public Member Functions
	VCLClusterIterationTraversal (PairwiseFunctor *pairwiseFunctor, size_t clusterSize, DataLayoutOption dataLayout, bool useNewton3)
	Constructor of the VCLClusterIterationTraversal.
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::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 partiton of the cluster list.

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::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::VCLClusterIterationTraversal< ParticleCell, PairwiseFunctor >

Traversal for VerletClusterLists.

Does not support newton 3.

Template Parameters

ParticleCell
PairwiseFunctor	The type of the functor.

Constructor & Destructor Documentation

VCLClusterIterationTraversal()

template<class ParticleCell , class PairwiseFunctor >

autopas::VCLClusterIterationTraversal< ParticleCell, PairwiseFunctor >::VCLClusterIterationTraversal ( PairwiseFunctor *  pairwiseFunctor, size_t  clusterSize, DataLayoutOption  dataLayout, bool  useNewton3  )

inlineexplicit

Constructor of the VCLClusterIterationTraversal.

Parameters

pairwiseFunctor	The functor to use for the traversal.
clusterSize	Number of particles per cluster.
dataLayout	The data layout to use. Currently, only AoS is supported.
useNewton3	If newton 3 should be used. Currently, only false is supported.

Member Function Documentation

endTraversal()

template<class ParticleCell , class PairwiseFunctor >

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

inlineoverridevirtual

Finalizes the traversal.

Should be called after traverse().

Implements autopas::TraversalInterface.

getTraversalType()

template<class ParticleCell , class PairwiseFunctor >

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

inlineoverridevirtual

Initializes the traversal.

Should be called before traverse().

Implements autopas::TraversalInterface.

isApplicable()

template<class ParticleCell , class PairwiseFunctor >

bool autopas::VCLClusterIterationTraversal< 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::VCLClusterIterationTraversal< 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/VCLClusterIterationTraversal.h