autopas::ContainerSelector< Particle_T > Class Template Reference

Selector for a particle container. More...

#include <ContainerSelector.h>

Public Member Functions
	ContainerSelector (const std::array< double, 3 > &boxMin, const std::array< double, 3 > &boxMax, double cutoff)
	Constructor for the ContainerSelecor class.
void	selectContainer (ContainerOption containerOption, ContainerSelectorInfo containerInfo)
	Sets the container to the given option.
void	resizeBox (const std::array< double, 3 > &boxMin, const std::array< double, 3 > &boxMax)
	Set new boundaries, convert the container and reevaluate particle ownership.
autopas::ParticleContainerInterface< Particle_T > &	getCurrentContainer ()
	Getter for the optimal container.
const autopas::ParticleContainerInterface< Particle_T > &	getCurrentContainer () const
	Getter for the optimal container.

Detailed Description

template<class Particle_T>
class autopas::ContainerSelector< Particle_T >

Selector for a particle container.

The class is given a list of allowed container and traversal options to choose from. This class selects the optimal container and delegates the choice of the optimal traversal down to this container.

Template Parameters

Particle_T
ParticleCell

Constructor & Destructor Documentation

ContainerSelector()

template<class Particle_T >

autopas::ContainerSelector< Particle_T >::ContainerSelector ( const std::array< double, 3 > &  boxMin, const std::array< double, 3 > &  boxMax, double  cutoff  )

inline

Constructor for the ContainerSelecor class.

Parameters

boxMin	Lower corner of the container.
boxMax	Upper corner of the container.
cutoff	Cutoff radius to be used in this container.

Member Function Documentation

getCurrentContainer() [1/2]

template<class Particle_T >

autopas::ParticleContainerInterface< Particle_T > & autopas::ContainerSelector< Particle_T >::getCurrentContainer

inline

Getter for the optimal container.

If no container is chosen yet the first allowed is selected.

Returns

Reference to the optimal container.

getCurrentContainer() [2/2]

template<class Particle_T >

const autopas::ParticleContainerInterface< Particle_T > & autopas::ContainerSelector< Particle_T >::getCurrentContainer

inline

Getter for the optimal container.

If no container is chosen yet the first allowed is selected.

Returns

Reference to the optimal container.

resizeBox()

template<class Particle_T >

void autopas::ContainerSelector< Particle_T >::resizeBox ( const std::array< double, 3 > &  boxMin, const std::array< double, 3 > &  boxMax  )

inline

Set new boundaries, convert the container and reevaluate particle ownership.

Parameters

boxMin
boxMax

selectContainer()

template<class Particle_T >

void autopas::ContainerSelector< Particle_T >::selectContainer	(	ContainerOption	containerOption,
		ContainerSelectorInfo	containerInfo
	)

Sets the container to the given option.

Parameters

containerOption	container to generate
containerInfo	additional parameter for the container

---

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

• autopas/tuning/selectors/ContainerSelector.h