autopas::ContainerSelectorInfo Class Reference

Info to generate a container. More...

#include <ContainerSelectorInfo.h>

Collaboration diagram for autopas::ContainerSelectorInfo:

Public Member Functions
	ContainerSelectorInfo ()
	Default Constructor.
	ContainerSelectorInfo (const std::array< double, 3 > &boxMin, const std::array< double, 3 > &boxMax, double cutoff, double cellSizeFactor, double verletSkin, unsigned int verletClusterSize, size_t aosSortingThresholdFallback, size_t soaSortingThresholdFallback, LoadEstimatorOption loadEstimator)
	Constructor.
bool	operator== (const ContainerSelectorInfo &other) const
	Equality between ContainerSelectorInfo.
bool	operator!= (const ContainerSelectorInfo &other) const
	Inequality between ContainerSelectorInfo.
bool	operator< (const ContainerSelectorInfo &other)
	Comparison operator for ContainerSelectorInfo objects.

Public Attributes
std::array< double, 3 >	boxMin
	Lower corner of the container.
std::array< double, 3 >	boxMax
	Upper corner of the container.
double	cutoff
	Cutoff radius to be used in this container.
double	cellSizeFactor
	cellSizeFactor Cell size factor to be used in this container (only relevant for LinkedCells)
double	verletSkin
	Length added to the cutoff for the verlet lists' skin inbetween rebuilding lists.
unsigned int	verletClusterSize
	Size of Verlet Clusters.
size_t	aosSortingThresholdFallback
	Threshold beyond which, if the sum of the number of particles in two cells is greater, the cells are sorted; used to seed newly generated containers until they are overwritten with a benchmarked threshold.
size_t	soaSortingThresholdFallback
	Threshold beyond which, if the sum of the SoA buffer sizes of two cells is greater, SoA sorting is applied; used to seed newly generated containers until they are overwritten with a benchmarked threshold.
LoadEstimatorOption	loadEstimator
	Load estimator for balanced sliced traversals.

Detailed Description

Info to generate a container.

Constructor & Destructor Documentation

ContainerSelectorInfo()

autopas::ContainerSelectorInfo::ContainerSelectorInfo ( const std::array< double, 3 > &  boxMin, const std::array< double, 3 > &  boxMax, double  cutoff, double  cellSizeFactor, double  verletSkin, unsigned int  verletClusterSize, size_t  aosSortingThresholdFallback, size_t  soaSortingThresholdFallback, LoadEstimatorOption  loadEstimator  )

inlineexplicit

Constructor.

Parameters

boxMin	Lower corner of the container.
boxMax	Upper corner of the container.
cutoff	Cutoff radius to be used in this container.
cellSizeFactor	Cell size factor to be used in this container (only relevant for LinkedCells, VerletLists and VerletListsCells).
verletSkin	Length added to the cutoff for the verlet lists' skin per timestep inbetween rebuilding lists.
verletClusterSize	Size of verlet Clusters
aosSortingThresholdFallback	Number of particles in two cells from which sorting should be performed, used to seed newly generated containers until they are overwritten with a benchmarked threshold.
soaSortingThresholdFallback	Number of particles in two SoA buffers from which SoA sorting should be performed, used to seed newly generated containers until they are overwritten with a benchmarked threshold.
loadEstimator	load estimation algorithm for balanced traversals.

Member Function Documentation

operator!=()

bool autopas::ContainerSelectorInfo::operator!= ( const ContainerSelectorInfo &  other ) const

inline

Inequality between ContainerSelectorInfo.

Parameters

other

Returns

False iff all members equal

operator<()

bool autopas::ContainerSelectorInfo::operator< ( const ContainerSelectorInfo &  other )

inline

Comparison operator for ContainerSelectorInfo objects.

Configurations are compared member wise in the order: cellSizeFactor, verletSkin, verletClusterSize, aosSortingThresholdFallback, soaSortingThresholdFallback, loadEstimator

Parameters

other

Returns

operator==()

bool autopas::ContainerSelectorInfo::operator== ( const ContainerSelectorInfo &  other ) const

inline

Equality between ContainerSelectorInfo.

Parameters

other

Returns

True iff all members equal

---

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

• autopas/tuning/selectors/ContainerSelectorInfo.h