Class representing the load estimator choices. More...

#include <LoadEstimatorOption.h>

Inheritance diagram for autopas::LoadEstimatorOption:

Collaboration diagram for autopas::LoadEstimatorOption:

Public Types
enum	Value { none , squaredParticlesPerCell , neighborListLength }
	Possible choices for the load estimation algorithm. More...

Public Member Functions
	LoadEstimatorOption ()=default
	Constructor.

constexpr	LoadEstimatorOption (Value option)
	Constructor from value.

constexpr	operator Value () const
	Cast to value.

Static Public Member Functions
static std::set< LoadEstimatorOption >	getDiscouragedOptions ()
	Set of options that are very unlikely to be interesting.

static std::map< LoadEstimatorOption, std::string >	getOptionNames ()
	Provides a way to iterate over the possible choices of LoadEstimatorOption.

Detailed Description

Class representing the load estimator choices.

Member Enumeration Documentation

◆ Value

enum autopas::LoadEstimatorOption::Value

Possible choices for the load estimation algorithm.

Enumerator

none

No load estimator.

If the Configuration supports load estimators, everything is assigned the same estimation.

squaredParticlesPerCell

Number of particles per cell squared.

neighborListLength

Sum of neighbor list lengths.

Constructor & Destructor Documentation

◆ LoadEstimatorOption()

constexpr autopas::LoadEstimatorOption::LoadEstimatorOption ( Value option )

inlineconstexpr

Constructor from value.

Parameters

option

Member Function Documentation

◆ getDiscouragedOptions()

static std::set< LoadEstimatorOption > autopas::LoadEstimatorOption::getDiscouragedOptions ( )

inlinestatic

Set of options that are very unlikely to be interesting.

Returns

◆ getOptionNames()

static std::map< LoadEstimatorOption, std::string > autopas::LoadEstimatorOption::getOptionNames ( )

inlinestatic

Provides a way to iterate over the possible choices of LoadEstimatorOption.

Returns: map option -> string representation

◆ operator Value()

constexpr autopas::LoadEstimatorOption::operator Value ( ) const

inlineconstexpr

Cast to value.

Returns

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

autopas/options/LoadEstimatorOption.h

Public Types

Public Member Functions

Static Public Member Functions