autopas::VCLTraversalInterface< Particle_T > Class Template Reference

Interface for traversals of the VerletClusterLists container. More...

#include <VCLTraversalInterface.h>

Inheritance diagram for autopas::VCLTraversalInterface< Particle_T >:

Public Member Functions
virtual	~VCLTraversalInterface ()=default
	virtual default destructor.
virtual void	setClusterLists (VerletClusterLists< Particle_T > &verletClusterLists)
	Sets the cluster list for the traversal to iterate over.
virtual void	setTowers (std::vector< internal::ClusterTower< Particle_T > > &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.

Protected Attributes
VerletClusterLists< Particle_T > *	_verletClusterLists
	The cluster list to iterate over.
std::vector< internal::ClusterTower< Particle_T > > *	_towers
	The towers of the cluster list to iterate over.

Detailed Description

template<class Particle_T>
class autopas::VCLTraversalInterface< Particle_T >

Interface for traversals of the VerletClusterLists container.

Member Function Documentation

needsStaticClusterThreadPartition()

template<class Particle_T >

virtual bool autopas::VCLTraversalInterface< Particle_T >::needsStaticClusterThreadPartition ( )

inlinevirtual

Returns whether this traversal needs the static cluster thread partiton of the cluster list.

Returns

whether this traversal needs the static cluster thread partiton of the cluster list.

Reimplemented in autopas::VCLC01BalancedTraversal< Particle_T, PairwiseFunctor >.

setClusterLists()

template<class Particle_T >

virtual void autopas::VCLTraversalInterface< Particle_T >::setClusterLists ( VerletClusterLists< Particle_T > &  verletClusterLists )

inlinevirtual

Sets the cluster list for the traversal to iterate over.

Parameters

verletClusterLists

the cluster list to iterate over.

setTowers()

template<class Particle_T >

virtual void autopas::VCLTraversalInterface< Particle_T >::setTowers ( std::vector< internal::ClusterTower< Particle_T > > &  towers )

inlinevirtual

Sets the towers of the cluster list for the traversal to iterate over.

Parameters

towers

towers of the cluster list for the traversal to iterate over.

Member Data Documentation

_towers

template<class Particle_T >

std::vector<internal::ClusterTower<Particle_T> >* autopas::VCLTraversalInterface< Particle_T >::_towers

protected

The towers of the cluster list to iterate over.

These directly contain the particles to be modified by the traversal.

_verletClusterLists

template<class Particle_T >

VerletClusterLists<Particle_T>* autopas::VCLTraversalInterface< Particle_T >::_verletClusterLists

protected

The cluster list to iterate over.

It provides methods to iterate over the clusters. If more control over the iteration is needed, traversals can also iterate over the towers directly. They are accessible through _towers.

---

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

• autopas/containers/verletClusterLists/traversals/VCLTraversalInterface.h