AutoPas  3.0.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
autopas::ContainerSelectorInfo Class Reference

Info to generate a container. More...

#include <ContainerSelectorInfo.h>

Collaboration diagram for autopas::ContainerSelectorInfo:
Collaboration graph
[legend]

Public Member Functions

 ContainerSelectorInfo ()
 Default Constructor.
 
 ContainerSelectorInfo (double cellSizeFactor, double verletSkin, unsigned int verletRebuildFrequency, unsigned int verletClusterSize, autopas::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

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 verletRebuildFrequency
 The rebuild frequency.
 
unsigned int verletClusterSize
 Size of Verlet Clusters.
 
autopas::LoadEstimatorOption loadEstimator
 Load estimator for balanced sliced traversals.
 

Detailed Description

Info to generate a container.

Constructor & Destructor Documentation

◆ ContainerSelectorInfo()

autopas::ContainerSelectorInfo::ContainerSelectorInfo ( double  cellSizeFactor,
double  verletSkin,
unsigned int  verletRebuildFrequency,
unsigned int  verletClusterSize,
autopas::LoadEstimatorOption  loadEstimator 
)
inlineexplicit

Constructor.

Parameters
cellSizeFactorCell size factor to be used in this container (only relevant for LinkedCells, VerletLists and VerletListsCells).
verletSkinLength added to the cutoff for the verlet lists' skin per timestep inbetween rebuilding lists.
verletRebuildFrequencyrebuild frequency.
verletClusterSizeSize of verlet Clusters
loadEstimatorload 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 member euqal

◆ operator<()

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

Comparison operator for ContainerSelectorInfo objects.

Configurations are compared member wise in the order: _cellSizeFactor, _verletSkin, _verlerRebuildFrequency, loadEstimator

Parameters
other
Returns

◆ operator==()

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

Equality between ContainerSelectorInfo.

Parameters
other
Returns
True iff all member equal

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