Class TempLat::MPICartesianNeighbours

ClassList > TempLat > MPICartesianNeighbours

A class which fetches and stores the neighbours in all dimensions. Internally just contructs a std::vector<MPICartesianNeighboursSingleDimension> with each entry corresponding to its associated dimension. More...

• #include <mpicartesianneighbours.h>

Public Functions

Type	Name
	MPICartesianNeighbours (MPICartesianGroup group)
const int &	getLowerNeighbour (ptrdiff_t dimension)
const int &	getUpperNeighbour (ptrdiff_t dimension)

Detailed Description

Unit test: ctest -R test-mpicartesianneighbours

Public Functions Documentation

function MPICartesianNeighbours

inline TempLat::MPICartesianNeighbours::MPICartesianNeighbours (
    MPICartesianGroup group
) 

---

function getLowerNeighbour

inline const int & TempLat::MPICartesianNeighbours::getLowerNeighbour (
    ptrdiff_t dimension
) 

---

function getUpperNeighbour

inline const int & TempLat::MPICartesianNeighbours::getUpperNeighbour (
    ptrdiff_t dimension
) 

---

---

The documentation for this class was generated from the following file cosmolatticeweb/tmp/code_source/templat/include/TempLat/parallel/mpi/cartesian/mpicartesianneighbours.h