CellwiseData< DIM > Class Template Reference

#include <CellwiseData.hpp>

Inherits SerializableSingleton< CellwiseData< DIM > >.

Collaboration diagram for CellwiseData< DIM >:

Public Member Functions
virtual	~CellwiseData ()
double	GetValue (CellPtr pCell, unsigned variableNumber=0)
void	SetValue (double value, unsigned locationIndex, unsigned variableNumber=0)
void	SetCellPopulation (AbstractCellPopulation< DIM > *pCellPopulation)
AbstractCellPopulation< DIM > &	rGetCellPopulation ()
void	SetNumCellsAndVars (unsigned numCells, unsigned numVars)
void	SetConstantDataForTesting (std::vector< double > &rValues)
bool	IsSetUp ()
void	ReallocateMemory ()
unsigned	GetNumVariables ()
Static Public Member Functions
static CellwiseData *	Instance ()
static void	Destroy ()
Protected Member Functions
	CellwiseData ()
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
AbstractCellPopulation< DIM > *	mpCellPopulation
bool	mAllocatedMemory
unsigned	mNumberOfVariables
std::vector< double >	mData
std::vector< double >	mConstantDataForTesting
bool	mUseConstantDataForTesting
Static Private Attributes
static CellwiseData *	mpInstance = NULL
Friends
class	TestCellwiseData
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class CellwiseData< DIM >

A singleton object for storing data that certain cell-cycle models need to know about, e.g. nutrient concentrations computed via some PDE for use in nutrient-based cell-cycle models.

Definition at line 44 of file CellwiseData.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

CellwiseData< DIM >::CellwiseData ( ) [inline, protected]

Protected constuctor. Not to be called, use Instance() instead.

Definition at line 46 of file CellwiseData.cpp.

References CellwiseData< DIM >::mpInstance.

template<unsigned DIM>

CellwiseData< DIM >::~CellwiseData ( ) [inline, virtual]

Destructor.

Definition at line 57 of file CellwiseData.cpp.

Member Function Documentation

template<unsigned DIM>

void CellwiseData< DIM >::Destroy ( ) [inline, static]

Destroy the current instance. Should be called at the end of a simulation.

Definition at line 62 of file CellwiseData.cpp.

References CellwiseData< DIM >::mpInstance.

template<unsigned DIM>

unsigned CellwiseData< DIM >::GetNumVariables ( ) [inline]

Returns:: mNumberOfVariables

Definition at line 178 of file CellwiseData.cpp.

References CellwiseData< DIM >::mNumberOfVariables.

Referenced by VertexBasedCellPopulation< DIM >::WriteVtkResultsToFile(), NodeBasedCellPopulation< DIM >::WriteVtkResultsToFile(), and MeshBasedCellPopulation< DIM >::WriteVtkResultsToFile().

template<unsigned DIM>

double CellwiseData< DIM >::GetValue	(	CellPtr	pCell,
		unsigned	variableNumber = `0`
	)			`[inline]`

Get the value of CellwiseData for a given cell and variable number.

Parameters:

	pCell	the cell
	variableNumber	the index of CellwiseData whose value is required (defaults to zero)

Returns:: the value of CellwiseData.

Definition at line 72 of file CellwiseData.cpp.

References EXCEPTION, CellwiseData< DIM >::IsSetUp(), CellwiseData< DIM >::mAllocatedMemory, CellwiseData< DIM >::mConstantDataForTesting, CellwiseData< DIM >::mData, CellwiseData< DIM >::mNumberOfVariables, CellwiseData< DIM >::mpCellPopulation, and CellwiseData< DIM >::mUseConstantDataForTesting.

Referenced by VertexBasedCellPopulation< DIM >::WriteVtkResultsToFile(), NodeBasedCellPopulation< DIM >::WriteVtkResultsToFile(), and MeshBasedCellPopulation< DIM >::WriteVtkResultsToFile().

template<unsigned DIM>

CellwiseData< DIM > * CellwiseData< DIM >::Instance ( ) [inline, static]

Get an instance of the object

Definition at line 36 of file CellwiseData.cpp.

References CellwiseData< DIM >::mpInstance.

template<unsigned DIM>

bool CellwiseData< DIM >::IsSetUp ( ) [inline]

Is the instance in existence and fully set up

Definition at line 149 of file CellwiseData.cpp.

References CellwiseData< DIM >::mAllocatedMemory, CellwiseData< DIM >::mpCellPopulation, and CellwiseData< DIM >::mpInstance.

Referenced by CellwiseData< DIM >::GetValue(), CellwiseData< DIM >::serialize(), and CellwiseData< DIM >::SetValue().

template<unsigned DIM>

void CellwiseData< DIM >::ReallocateMemory ( ) [inline]

Reallocate size of mData. Needed because of growth/death. Reallocates according to the number of nodes in the mesh in the CellPopulation member variable

Definition at line 155 of file CellwiseData.cpp.

References CellwiseData< DIM >::mAllocatedMemory, CellwiseData< DIM >::mData, CellwiseData< DIM >::mNumberOfVariables, and CellwiseData< DIM >::mpCellPopulation.

template<unsigned DIM>

AbstractCellPopulation< DIM > & CellwiseData< DIM >::rGetCellPopulation ( ) [inline]

Returns:: reference to the CellPopulation.

Definition at line 125 of file CellwiseData.cpp.

References CellwiseData< DIM >::mpCellPopulation.

template<unsigned DIM>

template<class Archive >

void CellwiseData< DIM >::serialize	(	Archive &	archive,
		const unsigned int	version
	)			`[inline, private]`

Archive the object and its member variables.

Parameters:

	archive	the archive
	version	the current version of this class

Definition at line 80 of file CellwiseData.hpp.

References CellwiseData< DIM >::IsSetUp(), CellwiseData< DIM >::mAllocatedMemory, CellwiseData< DIM >::mConstantDataForTesting, CellwiseData< DIM >::mData, CellwiseData< DIM >::mNumberOfVariables, CellwiseData< DIM >::mpCellPopulation, and CellwiseData< DIM >::mUseConstantDataForTesting.

template<unsigned DIM>

void CellwiseData< DIM >::SetCellPopulation ( AbstractCellPopulation< DIM > * pCellPopulation ) [inline]

Set the CellPopulation. Must be called before GetValue().

Parameters:

pCellPopulation

pointer to the CellPopulation

Definition at line 109 of file CellwiseData.cpp.

References EXCEPTION, CellwiseData< DIM >::mAllocatedMemory, and CellwiseData< DIM >::mpCellPopulation.

template<unsigned DIM>

void CellwiseData< DIM >::SetConstantDataForTesting ( std::vector< double > & rValues ) [inline]

Force the data to return given values for all cells (only for testing).

Parameters:

rValues

vector of CellwiseData values

Definition at line 170 of file CellwiseData.cpp.

References CellwiseData< DIM >::mConstantDataForTesting, CellwiseData< DIM >::mNumberOfVariables, and CellwiseData< DIM >::mUseConstantDataForTesting.

template<unsigned DIM>

void CellwiseData< DIM >::SetNumCellsAndVars	(	unsigned	numCells,
		unsigned	numVars
	)			`[inline]`

Set the number of cells and number of variables to be stored per cell. The constructor assumes 1 variable so this method only really needs to be called if numVars > 1.

Parameters: