A Diffusor is a custom class that performs diffusion. More...

Public Member Functions
	Diffusor ()
	Empty constructor.

virtual	~Diffusor ()
	No-Op Destructor.

virtual int	getRadius ()
	Implementing classes must return the value that is the number of concentric layers that are used in diffusion calculations. More...

virtual T	getNewValue (T *values)=0
	Given a list of values that represent the values in adjacent cells, return the value that should be placed in the central cell. More...

Detailed Description

A Diffusor is a custom class that performs diffusion.

Member Function Documentation

template<typename T >

virtual T repast::Diffusor< T >::getNewValue ( T * values )

pure virtual

Given a list of values that represent the values in adjacent cells, return the value that should be placed in the central cell.

The list of values should be in the order defined by a RelativeLocation object of the specified radius with the central cell being at (0, 0, 0, ...)

Parameters

values An array of values found in the adjacent cells from which the diffusion into this cell can be calculated

Returns: the value that should be placed in the central cell based on diffusion from adjacent cells

template<typename T >

int repast::Diffusor< T >::getRadius

virtual

Implementing classes must return the value that is the number of concentric layers that are used in diffusion calculations.

Tefault radius is one.

Typically this will be 1, meaning that only immediately adjacent grid cells are considered.

Returns: the radius of the (rectilinear) volume that encompasses all cells that will diffuse into the central cell

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