Parallel::Neighbours Class Reference

#include <neighbours.h>

Public Member Functions
	Neighbours ()
	~Neighbours ()

Static Public Member Functions
static void	initialize (int processRank, int numproc, int *processorsPerDim)
	Parallel::Neighbours::initialize initializes. More...
static int	get (int iProcDir)
	get returns the neighbourlist for the the calling processor/rank and the direction given py iProcDir. More...
static NeighbourList *	getNeighbours (int Np)
	Parallel::Neighbours::getNeighbours returns a reference to the neighbour list of given process rank. More...
static int	getListLength ()
static long	getProcessorDimensionPosition (int dim)

Constructor & Destructor Documentation

Neighbours()

Neighbours::Neighbours

(

)

~Neighbours()

Neighbours::~Neighbours

(

)

Member Function Documentation

get()

static int Parallel::Neighbours::get ( int  iProcDir )

inlinestatic

get returns the neighbourlist for the the calling processor/rank and the direction given py iProcDir.

Parameters

iProcDir

the direction in which to look up its neighbour.

Returns

the rank of its neighbour.

Here is the caller graph for this function:

getListLength()

static int Parallel::Neighbours::getListLength ( )

inlinestatic

getNeighbours()

NeighbourList * Neighbours::getNeighbours ( int  Np )

static

Parallel::Neighbours::getNeighbours returns a reference to the neighbour list of given process rank.

Parameters

Np	process rank to find NeighbourList for.

Returns

reference to NeighbourList.

Here is the caller graph for this function:

getProcessorDimensionPosition()

static long Parallel::Neighbours::getProcessorDimensionPosition ( int  dim )

inlinestatic

Here is the caller graph for this function:

initialize()

void Neighbours::initialize ( int  processRank, int  numproc, int *  processorsPerDim  )

static

Parallel::Neighbours::initialize initializes.

Parameters

processRank	the rank of the processor calling.
numproc	total number of active processors.
processorsPerDim	a int array of length four containing the total number of processors per dimension.

Here is the caller graph for this function:

---

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

• GLAC/parallelization/neighbours.h
• GLAC/parallelization/neighbours.cpp