faunus
Public Types | Public Member Functions | List of all members
Faunus::CellList::Grid::FixedBoundaryGrid< TGridType > Class Template Reference

Fixed boundary conditions. More...

#include <celllistimpl.h>

Inheritance diagram for Faunus::CellList::Grid::FixedBoundaryGrid< TGridType >:
Inheritance graph
[legend]
Collaboration diagram for Faunus::CellList::Grid::FixedBoundaryGrid< TGridType >:
Collaboration graph
[legend]

Public Types

using CellCoord = Eigen::Array< CellIndex, Dimension, 1 >
 VDimensional cell coordinates.
 
- Public Types inherited from Faunus::CellList::Grid::GridBase< TGridType >
using GridType = typename AbstractGrid< TGridType >::GridType
 
- Public Types inherited from Faunus::CellList::Grid::AbstractGrid< TGridType >
using GridType = TGridType
 
- Public Types inherited from Faunus::CellList::Grid::AbstractNeighborGrid< TGridType >
using GridType = TGridType
 

Public Member Functions

bool isNeighborCell (const CellCoord &coordinates, const CellCoord &offset) const
 Verifies if offseted coordinates are valid. More...
 
- Public Member Functions inherited from Faunus::CellList::Grid::GridBase< TGridType >
CellCoord coordinates (const CellIndex index) const override
 Compute the cell coordinates from the cell index. More...
 
CellIndex index (const CellCoord &coordinates) const override
 Compute the cell index from the cell coordinates. More...
 
CellCoord coordinatesAt (const Point &position) const override
 Compute cell coordinates from a spatial position. More...
 
CellIndex indexAt (const Point &position) const override
 Compute the cell index from the spatial position. More...
 
bool isCell (const CellCoord &coordinates) const override
 Verifies if coordinates are valid in the grid. More...
 
bool isCellAt (const Point &point) const override
 Verifies if spatial coordinates are in the box. More...
 
CellIndex size () const override
 
 GridBase (const Point &box, SpaceAxis minimal_cell_dimension)
 
- Public Member Functions inherited from Faunus::CellList::Grid::AbstractNeighborGrid< TGridType >
virtual bool isNeighborCell (const CellCoord &coordinates, const CellCoord &offset) const =0
 

Additional Inherited Members

- Protected Member Functions inherited from Faunus::CellList::Grid::GridBase< TGridType >
const CellCoord & getCellListEnd () const
 
const PointgetBox () const
 
const PointgetCell () const
 

Detailed Description

template<typename TGridType>
class Faunus::CellList::Grid::FixedBoundaryGrid< TGridType >

Fixed boundary conditions.

Template Parameters
TGridTypea cell grid type declaration

Member Function Documentation

◆ isNeighborCell()

template<typename TGridType >
bool Faunus::CellList::Grid::FixedBoundaryGrid< TGridType >::isNeighborCell ( const CellCoord coordinates,
const CellCoord offset 
) const
inline

Verifies if offseted coordinates are valid.

Coordinates must be within [0, cell_list_end).

Parameters
coordinates
offset
Returns
true if cell coordinates are valid, false otherwise

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