This functor can generate or check variable verlet lists using the typical pairwise traversal. More...

#include <AsBuildPairGeneratorFunctor.h>

Inheritance diagram for autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >:

[legend]

Collaboration diagram for autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >:

[legend]

Public Types
using	SoAArraysType = typename Particle_T::SoAArraysType
	The structure of the SoAs is defined by the particle.

Public Types inherited from autopas::PairwiseFunctor< Particle_T, CRTP_T >
using	SoAArraysType = typename Particle_T::SoAArraysType
	Structure of the SoAs defined by the particle.

Public Types inherited from autopas::Functor< Particle_T, CRTP_T >
using	SoAArraysType = typename Particle_T::SoAArraysType
	Structure of the SoAs defined by the particle.

using	Functor_T = CRTP_T
	Make the Implementation type template publicly available.

Public Member Functions
bool	allowsNewton3 () override
	Specifies whether the functor is capable of Newton3-like functors.

bool	allowsNonNewton3 () override
	Specifies whether the functor is capable of non-Newton3-like functors.

	AsBuildPairGeneratorFunctor (VerletNeighborListAsBuild< Particle_T > &neighborList, double cutoffskin)
	Constructor of the functor.

std::string	getName () override
	Returns name of functor.

bool	isRelevantForTuning () override
	Specifies whether the functor should be considered for the auto-tuning process.

void	AoSFunctor (Particle_T &i, Particle_T &j, bool newton3) override
	Adds the given pair to the neighbor list.

void	SoAFunctorSingle (SoAView< SoAArraysType > soa, bool newton3) override
	Adds all pairs of the SoA to the neighbor list.

void	SoAFunctorPair (SoAView< SoAArraysType > soa1, SoAView< SoAArraysType > soa2, bool) override
	Adds all pairs (p1, p2), p1 element soa1, p2 element soa2 to the neighbor list.

Public Member Functions inherited from autopas::PairwiseFunctor< Particle_T, CRTP_T >
	PairwiseFunctor (double cutoff)
	Constructor.

virtual void	AoSFunctor (Particle_T &i, Particle_T &j, bool newton3)
	PairwiseFunctor for arrays of structures (AoS).

virtual void	SoAFunctorSingle (SoAView< SoAArraysType > soa, bool newton3)
	PairwiseFunctor for structure of arrays (SoA)

virtual void	SoAFunctorVerlet (SoAView< SoAArraysType > soa, const size_t indexFirst, const std::vector< size_t, AlignedAllocator< size_t > > &neighborList, bool newton3)
	PairwiseFunctor for structure of arrays (SoA) for neighbor lists.

virtual void	SoAFunctorPair (SoAView< SoAArraysType > soa1, SoAView< SoAArraysType > soa2, bool newton3)
	PairwiseFunctor for structure of arrays (SoA)

Public Member Functions inherited from autopas::Functor< Particle_T, CRTP_T >
	Functor (double cutoff)
	Constructor.

virtual void	initTraversal ()
	This function is called at the start of each traversal.

virtual void	endTraversal (bool newton3)
	This function is called at the end of each traversal.

template<class ParticleCell >
void	SoALoader (ParticleCell &cell, SoA< SoAArraysType > &soa, size_t offset, bool skipSoAResize)
	Copies the AoS data of the given cell in the given soa.

template<typename ParticleCell >
void	SoAExtractor (ParticleCell &cell, SoA< SoAArraysType > &soa, size_t offset)
	Copies the data stored in the soa back into the cell.

virtual bool	allowsNewton3 ()=0
	Specifies whether the functor is capable of Newton3-like functors.

virtual bool	allowsNonNewton3 ()=0
	Specifies whether the functor is capable of non-Newton3-like functors.

virtual bool	isRelevantForTuning ()=0
	Specifies whether the functor should be considered for the auto-tuning process.

virtual std::string	getName ()=0
	Returns name of functor.

double	getCutoff () const
	Getter for the functor's cutoff.

virtual size_t	getNumFLOPs () const
	Get the number of FLOPs.

virtual double	getHitRate () const
	Get the hit rate.

Static Public Member Functions
static constexpr auto	getNeededAttr ()
	Get attributes needed for computation.

static constexpr auto	getNeededAttr (std::false_type)
	Get attributes needed for computation without N3 optimization.

static constexpr auto	getComputedAttr ()
	Get attributes computed by this functor.

Static Public Member Functions inherited from autopas::Functor< Particle_T, CRTP_T >
static constexpr std::array< typename Particle_T::AttributeNames, 0 >	getNeededAttr ()
	Get attributes needed for computation.

static constexpr std::array< typename Particle_T::AttributeNames, 0 >	getNeededAttr (std::false_type)
	Get attributes needed for computation without N3 optimization.

static constexpr std::array< typename Particle_T::AttributeNames, 0 >	getComputedAttr ()
	Get attributes computed by this functor.

Detailed Description

template<class Particle_T, bool callCheckInstead = false>
class autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >

This functor can generate or check variable verlet lists using the typical pairwise traversal.

Template Parameters

Particle_T	The particle class.
callCheckInstead	If false, generate a neighbor list. If true, check the current for validity. Checking validity only works with the AoSFunctor().

Constructor & Destructor Documentation

◆ AsBuildPairGeneratorFunctor()

template<class Particle_T , bool callCheckInstead = false>

autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::AsBuildPairGeneratorFunctor	(	VerletNeighborListAsBuild< Particle_T > &	neighborList,
		double	cutoffskin
	)

inline

Constructor of the functor.

Parameters

neighborList	The neighbor list to fill.
cutoffskin	The cutoff skin to use.

Member Function Documentation

◆ allowsNewton3()

template<class Particle_T , bool callCheckInstead = false>

bool autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::allowsNewton3 ( )

inlineoverridevirtual

Specifies whether the functor is capable of Newton3-like functors.

If the functor provides an interface to soa or aos functions that utilize Newton's third law of motion (actio = reactio) to reduce the computational complexity this function should return true. If this is not the case this function should return false.

Returns: true if and only if this functor provides an interface to Newton3-like functions.

Implements autopas::Functor< Particle_T, CRTP_T >.

◆ allowsNonNewton3()

template<class Particle_T , bool callCheckInstead = false>

bool autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::allowsNonNewton3 ( )

inlineoverridevirtual

Specifies whether the functor is capable of non-Newton3-like functors.

If the functor provides an interface to soa or aos functions that do not utilize Newton's third law of motion (actio = reactio) this function should return true. If this is not the case this function should return false.

Returns: true if and only if this functor provides an interface to functions that do not utilize Newton3.

Implements autopas::Functor< Particle_T, CRTP_T >.

◆ AoSFunctor()

template<class Particle_T , bool callCheckInstead = false>

void autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::AoSFunctor	(	Particle_T &	i,
		Particle_T &	j,
		bool	newton3
	)

inlineoverridevirtual

Adds the given pair to the neighbor list.

Parameters

i	The first particle of the pair.
j	The second particle of the pair.
newton3	Not used!

Reimplemented from autopas::PairwiseFunctor< Particle_T, CRTP_T >.

◆ getComputedAttr()

template<class Particle_T , bool callCheckInstead = false>

static constexpr auto autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::getComputedAttr ( )

inlinestaticconstexpr

Get attributes computed by this functor.

Returns: Attributes computed by this functor.

Todo:: C++20: make this function virtual

◆ getName()

template<class Particle_T , bool callCheckInstead = false>

std::string autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::getName ( )

inlineoverridevirtual

Returns name of functor.

Intended for use with the iteration logger, to differentiate between calls to computeInteractions using different functors in the logs.

Returns: name of functor.

Implements autopas::Functor< Particle_T, CRTP_T >.

◆ getNeededAttr() [1/2]

template<class Particle_T , bool callCheckInstead = false>

static constexpr auto autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::getNeededAttr ( )

inlinestaticconstexpr

Get attributes needed for computation.

Returns: Attributes needed for computation.

Todo:: C++20: make this function virtual

◆ getNeededAttr() [2/2]

template<class Particle_T , bool callCheckInstead = false>

static constexpr auto autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::getNeededAttr ( std::false_type )

inlinestaticconstexpr

Get attributes needed for computation without N3 optimization.

Returns: Attributes needed for computation.

Todo:: C++20: make this function virtual

◆ isRelevantForTuning()

template<class Particle_T , bool callCheckInstead = false>

bool autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::isRelevantForTuning ( )

inlineoverridevirtual

Specifies whether the functor should be considered for the auto-tuning process.

Returns: true if and only if this functor is relevant for auto-tuning.

Implements autopas::Functor< Particle_T, CRTP_T >.

◆ SoAFunctorPair()

template<class Particle_T , bool callCheckInstead = false>

void autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::SoAFunctorPair	(	SoAView< SoAArraysType >	soa1,
		SoAView< SoAArraysType >	soa2,
		bool
	)

inlineoverridevirtual

Adds all pairs (p1, p2), p1 element soa1, p2 element soa2 to the neighbor list.

Parameters

soa1
soa2

Reimplemented from autopas::PairwiseFunctor< Particle_T, CRTP_T >.

◆ SoAFunctorSingle()

template<class Particle_T , bool callCheckInstead = false>

void autopas::internal::AsBuildPairGeneratorFunctor< Particle_T, callCheckInstead >::SoAFunctorSingle	(	SoAView< SoAArraysType >	soa,
		bool	newton3
	)

inlineoverridevirtual

Adds all pairs of the SoA to the neighbor list.

Parameters

soa	The SoA to add.
newton3	Whether to use newton 3 or not.

Reimplemented from autopas::PairwiseFunctor< Particle_T, CRTP_T >.

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

autopas/containers/verletListsCellBased/varVerletLists/neighborLists/asBuild/AsBuildPairGeneratorFunctor.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AsBuildPairGeneratorFunctor()

Member Function Documentation

◆ allowsNewton3()

◆ allowsNonNewton3()

◆ AoSFunctor()

◆ getComputedAttr()

◆ getName()

◆ getNeededAttr() [1/2]

◆ getNeededAttr() [2/2]

◆ isRelevantForTuning()

◆ SoAFunctorPair()

◆ SoAFunctorSingle()