This class provides the lc_c18 traversal. More...

#include <LCC18Traversal.h>

Inheritance diagram for autopas::LCC18Traversal< ParticleCell, PairwiseFunctor >:

[legend]

Collaboration diagram for autopas::LCC18Traversal< ParticleCell, PairwiseFunctor >:

[legend]

Public Member Functions
	LCC18Traversal (const std::array< unsigned long, 3 > &dims, PairwiseFunctor *pairwiseFunctor, const double interactionLength, const std::array< double, 3 > &cellLength, DataLayoutOption dataLayout, bool useNewton3)
	Constructor of the lc_c18 traversal.

void	traverseParticles () override
	Traverse the particles by pairs, triplets etc.

void	processBaseCell (std::vector< ParticleCell > &cells, unsigned long x, unsigned long y, unsigned long z)
	Computes all interactions between the base cell and adjacent cells with greater a ID.

TraversalOption	getTraversalType () const override
	Return a enum representing the name of the traversal class.

bool	isApplicable () const override
	C18 traversal is always usable.

void	setSortingThreshold (size_t sortingThreshold) override
	Set the sorting-threshold for traversals that use the CellFunctor If the sum of the number of particles in two cells is greater or equal to that value, the CellFunctor creates a sorted view of the particles to avoid unnecessary distance checks.

Public Member Functions inherited from autopas::C18BasedTraversal< ParticleCell, PairwiseFunctor >
	C18BasedTraversal (const std::array< unsigned long, 3 > &dims, PairwiseFunctor *functor, const double interactionLength, const std::array< double, 3 > &cellLength, DataLayoutOption dataLayout, bool useNewton3)
	Constructor of the lc_c18 traversal.

Public Member Functions inherited from autopas::ColorBasedTraversal< ParticleCell, Functor, collapseDepth >
void	initTraversal () override
	load Data Layouts required for this Traversal if cells have been set through setCellsToTraverse().

void	endTraversal () override
	write Data to AoS if cells have been set through setCellsToTraverse().

Public Member Functions inherited from autopas::CellTraversal< ParticleCell >
	CellTraversal (const std::array< unsigned long, 3 > &dims)
	Constructor of CellTraversal.

virtual	~CellTraversal ()=default
	Destructor of CellTraversal.

virtual void	setCellsToTraverse (std::vector< ParticleCell > &cells)
	Sets the cells to iterate over.

virtual void	setSortingThreshold (size_t sortingThreshold)=0
	Set the sorting-threshold for traversals that use the CellFunctor If the sum of the number of particles in two cells is greater or equal to that value, the CellFunctor creates a sorted view of the particles to avoid unnecessary distance checks.

Public Member Functions inherited from autopas::TraversalInterface
virtual	~TraversalInterface ()=default
	Destructor of TraversalInterface.

	TraversalInterface (DataLayoutOption dataLayout, bool useNewton3)
	Constructor of the TraversalInterface.

virtual TraversalOption	getTraversalType () const =0
	Return a enum representing the name of the traversal class.

virtual bool	isApplicable () const =0
	Checks if the traversal is applicable to the current state of the domain.

virtual void	initTraversal ()=0
	Initializes the traversal.

virtual void	traverseParticles ()=0
	Traverse the particles by pairs, triplets etc.

virtual void	endTraversal ()=0
	Finalizes the traversal.

bool	getUseNewton3 () const
	Return whether the traversal uses newton 3.

DataLayoutOption	getDataLayout () const
	Return the data layout option.

Additional Inherited Members
Protected Member Functions inherited from autopas::C18BasedTraversal< ParticleCell, PairwiseFunctor >
void	c18Traversal (LoopBody &&loopBody)
	The main traversal of the C18Traversal.

Protected Member Functions inherited from autopas::ColorBasedTraversal< ParticleCell, Functor, collapseDepth >
	ColorBasedTraversal (const std::array< unsigned long, 3 > &dims, Functor *functor, const double interactionLength, const std::array< double, 3 > &cellLength, DataLayoutOption dataLayout, bool useNewton3)
	Constructor of the ColorBasedTraversal.

	~ColorBasedTraversal () override=default
	Destructor of ColorBasedTraversal.

template<typename LoopBody >
void	colorTraversal (LoopBody &&loopBody, const std::array< unsigned long, 3 > &end, const std::array< unsigned long, 3 > &stride, const std::array< unsigned long, 3 > &offset={0ul, 0ul, 0ul})
	The main traversal of the ColorBasedTraversal.

virtual void	notifyColorChange (unsigned long newColor)
	This method is called when the color during the traversal has changed.

Protected Attributes inherited from autopas::ColorBasedTraversal< ParticleCell, Functor, collapseDepth >
const double	_interactionLength
	Interaction length (cutoff + skin).

const std::array< double, 3 >	_cellLength
	cell length in CellBlock3D.

std::array< unsigned long, 3 >	_overlap
	overlap of interacting cells.

Protected Attributes inherited from autopas::CellTraversal< ParticleCell >
std::array< unsigned long, 3 >	_cellsPerDimension
	The dimensions of the cellblock.

std::vector< ParticleCell > *	_cells
	The cells to traverse.

Protected Attributes inherited from autopas::TraversalInterface
DataLayoutOption	_dataLayout
	The datalayout used by this traversal.

bool	_useNewton3
	If this traversal makes use of newton3.

Detailed Description

template<class ParticleCell, class PairwiseFunctor>
class autopas::LCC18Traversal< ParticleCell, PairwiseFunctor >

This class provides the lc_c18 traversal.

The traversal uses the c18 base step performed on every single cell.

C18 base step in 2D. (dark blue cell = base cell)

Since these steps overlap a domain coloring with eighteen colors is applied.

C18 domain coloring in 2D. 6 colors are required.

Template Parameters

ParticleCell	the type of cells
PairwiseFunctor	The functor that defines the interaction of two particles.

Constructor & Destructor Documentation

◆ LCC18Traversal()

template<class ParticleCell , class PairwiseFunctor >

autopas::LCC18Traversal< ParticleCell, PairwiseFunctor >::LCC18Traversal	(	const std::array< unsigned long, 3 > &	dims,
		PairwiseFunctor *	pairwiseFunctor,
		const double	interactionLength,
		const std::array< double, 3 > &	cellLength,
		DataLayoutOption	dataLayout,
		bool	useNewton3
	)

inlineexplicit

Constructor of the lc_c18 traversal.

Parameters

dims	The dimensions of the cellblock, i.e. the number of cells in x, y and z direction.
pairwiseFunctor	The functor that defines the interaction of two particles.
interactionLength	Interaction length (cutoff + skin).
cellLength	cell length.
dataLayout	The data layout with which this traversal should be initialized.
useNewton3	Parameter to specify whether the traversal makes use of newton3 or not.

Todo:: Pass cutoff to _cellFunctor instead of interactionLength, unless this functor is used to build verlet-lists, in that case the interactionLength is needed!

Member Function Documentation

◆ getTraversalType()

template<class ParticleCell , class PairwiseFunctor >

TraversalOption autopas::LCC18Traversal< ParticleCell, PairwiseFunctor >::getTraversalType ( ) const

inlineoverridevirtual

Return a enum representing the name of the traversal class.

Returns: Enum representing traversal.

Implements autopas::TraversalInterface.

◆ isApplicable()

template<class ParticleCell , class PairwiseFunctor >

bool autopas::LCC18Traversal< ParticleCell, PairwiseFunctor >::isApplicable ( ) const

inlineoverridevirtual

C18 traversal is always usable.

Returns

Implements autopas::TraversalInterface.

◆ processBaseCell()

template<class ParticleCell , class PairwiseFunctor >

void autopas::LCC18Traversal< ParticleCell, PairwiseFunctor >::processBaseCell	(	std::vector< ParticleCell > &	cells,
		unsigned long	x,
		unsigned long	y,
		unsigned long	z
	)

Computes all interactions between the base cell and adjacent cells with greater a ID.

Parameters

cells	vector of all cells.
x	X-index of base cell.
y	Y-index of base cell.
z	Z-index of base cell.

◆ setSortingThreshold()

template<class ParticleCell , class PairwiseFunctor >

void autopas::LCC18Traversal< ParticleCell, PairwiseFunctor >::setSortingThreshold ( size_t sortingThreshold )

inlineoverridevirtual

Set the sorting-threshold for traversals that use the CellFunctor If the sum of the number of particles in two cells is greater or equal to that value, the CellFunctor creates a sorted view of the particles to avoid unnecessary distance checks.

Parameters

sortingThreshold Sum of the number of particles in two cells from which sorting should be enabled

Implements autopas::CellTraversal< ParticleCell >.

◆ traverseParticles()

template<class ParticleCell , class PairwiseFunctor >

void autopas::LCC18Traversal< ParticleCell, PairwiseFunctor >::traverseParticles ( )

inlineoverridevirtual

Traverse the particles by pairs, triplets etc.

as determined by the Functor type.

Implements autopas::TraversalInterface.

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

autopas/containers/linkedCells/traversals/LCC18Traversal.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LCC18Traversal()

Member Function Documentation

◆ getTraversalType()

◆ isApplicable()

◆ processBaseCell()

◆ setSortingThreshold()

◆ traverseParticles()