AutoPas  3.0.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
autopas::internal::CellBorderAndFlagManager Class Referenceabstract

Interface class to handle cell borders and cell types of cells. More...

#include <CellBorderAndFlagManager.h>

Inheritance diagram for autopas::internal::CellBorderAndFlagManager:
Inheritance graph
[legend]

Public Types

using index_t = std::size_t
 The index type to access the particle cells.
 

Public Member Functions

virtual ~CellBorderAndFlagManager ()=default
 Cestructor.
 
virtual bool cellCanContainHaloParticles (index_t index1d) const =0
 Checks if the cell with the one-dimensional index index1d can contain halo particles.
 
virtual bool cellCanContainOwnedParticles (index_t index1d) const =0
 Checks if the cell with the one-dimensional index index1d can contain owned particles.
 
bool ignoreCellForIteration (index_t index1d, IteratorBehavior behavior) const
 Checks if cell with index1d can be ignored for iteration with currently selected behavior.
 

Detailed Description

Interface class to handle cell borders and cell types of cells.

Todo:
: add cell border handling

Member Function Documentation

◆ cellCanContainHaloParticles()

virtual bool autopas::internal::CellBorderAndFlagManager::cellCanContainHaloParticles ( index_t  index1d) const
pure virtual

Checks if the cell with the one-dimensional index index1d can contain halo particles.

Parameters
index1dthe one-dimensional index of the cell that should be checked
Returns
true if the cell can contain halo particles

Implemented in autopas::internal::CellBlock3D< ParticleCell >, autopas::internal::CellBlock3D< autopas::FullParticleCell >, autopas::internal::CellBlock3D< autopas::ReferenceParticleCell >, autopas::internal::UnknowingCellBorderAndFlagManager, autopas::internal::ClusterTowerBlock2D< Particle_T >, autopas::internal::ClusterTowerBlock2D< ParticleCell::ParticleType >, and autopas::Octree< Particle_T >.

◆ cellCanContainOwnedParticles()

virtual bool autopas::internal::CellBorderAndFlagManager::cellCanContainOwnedParticles ( index_t  index1d) const
pure virtual

Checks if the cell with the one-dimensional index index1d can contain owned particles.

Parameters
index1dthe one-dimensional index of the cell that should be checked
Returns
true if the cell can contain owned particles

Implemented in autopas::internal::CellBlock3D< ParticleCell >, autopas::internal::CellBlock3D< autopas::FullParticleCell >, autopas::internal::CellBlock3D< autopas::ReferenceParticleCell >, autopas::internal::UnknowingCellBorderAndFlagManager, autopas::internal::ClusterTowerBlock2D< Particle_T >, autopas::internal::ClusterTowerBlock2D< ParticleCell::ParticleType >, and autopas::Octree< Particle_T >.

◆ ignoreCellForIteration()

bool autopas::internal::CellBorderAndFlagManager::ignoreCellForIteration ( index_t  index1d,
IteratorBehavior  behavior 
) const
inline

Checks if cell with index1d can be ignored for iteration with currently selected behavior.

Parameters
index1d1d index of checked cell
behavior
See also
IteratorBehavior
Returns
false if this cell can contain particles that would be affected by current behavior

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