CellwiseData< DIM > Class Template Reference

#include <CellwiseData.hpp>

Collaboration diagram for CellwiseData< DIM >:

Collaboration graph
[legend]

List of all members.

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 CellwiseDataInstance ()
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 CellwiseDatampInstance = 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 43 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 48 of file CellwiseData.cpp.

References CellwiseData< DIM >::mpInstance.

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

Destructor.

Definition at line 60 of file CellwiseData.cpp.


Member Function Documentation

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 79 of file CellwiseData.hpp.

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

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

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 66 of file CellwiseData.cpp.

References CellwiseData< DIM >::mpInstance.

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

template<unsigned DIM>
void CellwiseData< DIM >::SetValue ( double  value,
unsigned  locationIndex,
unsigned  variableNumber = 0 
) [inline]

Set the value for a given location index and variable number.

Parameters:
value the value to set
locationIndex the location index
variableNumber the index of CellwiseData whose value is set (defaults to zero)

Definition at line 101 of file CellwiseData.cpp.

References EXCEPTION, CellwiseData< DIM >::IsSetUp(), CellwiseData< DIM >::mData, and CellwiseData< DIM >::mNumberOfVariables.

Referenced by CellBasedSimulationWithPdes< DIM >::SolvePde(), and CellBasedSimulationWithPdes< DIM >::SolvePdeUsingCoarseMesh().

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 115 of file CellwiseData.cpp.

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

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

Returns:
reference to the CellPopulation.

Definition at line 127 of file CellwiseData.cpp.

References CellwiseData< DIM >::mpCellPopulation.

Referenced by CellwiseDataGradient< DIM >::SetupGradients().

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:
numCells number of cells in the cell population
numVars number of variables

Definition at line 134 of file CellwiseData.cpp.

References EXCEPTION, CellwiseData< DIM >::mAllocatedMemory, CellwiseData< DIM >::mData, CellwiseData< DIM >::mNumberOfVariables, 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 175 of file CellwiseData.cpp.

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

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

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 160 of file CellwiseData.cpp.

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

Referenced by CellBasedSimulationWithPdes< DIM >::SolvePde(), and CellBasedSimulationWithPdes< DIM >::SolvePdeUsingCoarseMesh().

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


Friends And Related Function Documentation

template<unsigned DIM>
friend class boost::serialization::access [friend]

Needed for serialization.

Definition at line 71 of file CellwiseData.hpp.


Member Data Documentation

template<unsigned DIM>
CellwiseData< DIM > * CellwiseData< DIM >::mpInstance = NULL [inline, static, private]

The single instance of the singleton object

Definition at line 50 of file CellwiseData.hpp.

Referenced by CellwiseData< DIM >::CellwiseData(), CellwiseData< DIM >::Destroy(), CellwiseData< DIM >::Instance(), and CellwiseData< DIM >::IsSetUp().

template<unsigned DIM>
AbstractCellPopulation<DIM>* CellwiseData< DIM >::mpCellPopulation [private]

template<unsigned DIM>
bool CellwiseData< DIM >::mAllocatedMemory [private]

template<unsigned DIM>
unsigned CellwiseData< DIM >::mNumberOfVariables [private]

template<unsigned DIM>
std::vector<double> CellwiseData< DIM >::mData [private]

template<unsigned DIM>
std::vector<double> CellwiseData< DIM >::mConstantDataForTesting [private]

Helper member storing constant data. Used in tests.

Definition at line 65 of file CellwiseData.hpp.

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

template<unsigned DIM>
bool CellwiseData< DIM >::mUseConstantDataForTesting [private]

Helper member storing whether mConstantDataForTesting is used.

Definition at line 68 of file CellwiseData.hpp.

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


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

Generated on Mon Nov 1 12:36:22 2010 for Chaste by  doxygen 1.5.5