AbstractMultipleCaUpdateRule< DIM > Class Template Reference

#include <AbstractMultipleCaUpdateRule.hpp>

Inheritance diagram for AbstractMultipleCaUpdateRule< DIM >:

Collaboration diagram for AbstractMultipleCaUpdateRule< DIM >:

List of all members.

Public Member Functions
	AbstractMultipleCaUpdateRule ()
virtual	~AbstractMultipleCaUpdateRule ()
virtual double	EvaluateProbability (unsigned currentNodeIndex, unsigned targetNodeIndex, MultipleCaBasedCellPopulation< DIM > &rCellPopulation, double dt, double deltaX)=0
void	OutputUpdateRuleInfo (out_stream &rParamsFile)
virtual void	OutputUpdateRuleParameters (out_stream &rParamsFile)=0
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Friends
class	boost::serialization::access

---

Detailed Description

template<unsigned DIM>
class AbstractMultipleCaUpdateRule< DIM >

An abstract CA update rule class, for use in cell-based simulations using the cellular automota model.

Definition at line 52 of file AbstractMultipleCaUpdateRule.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

AbstractMultipleCaUpdateRule< DIM >::AbstractMultipleCaUpdateRule

(

)

Default constructor.

Definition at line 39 of file AbstractMultipleCaUpdateRule.cpp.

template<unsigned DIM>

AbstractMultipleCaUpdateRule< DIM >::~AbstractMultipleCaUpdateRule

(

)

[virtual]

Destructor.

Definition at line 44 of file AbstractMultipleCaUpdateRule.cpp.

---

Member Function Documentation

template<unsigned DIM>

virtual double AbstractMultipleCaUpdateRule< DIM >::EvaluateProbability	(	unsigned	currentNodeIndex,
		unsigned	targetNodeIndex,
		MultipleCaBasedCellPopulation< DIM > &	rCellPopulation,
		double	dt,
		double	deltaX
	)		[pure virtual]

Calculate the probability of a given move.

Uses random diffusion to each neighbouring node, scaled according to distance.

Parameters:

currentNodeIndex	The index of the current node/lattice site
targetNodeIndex	The index of the target node/lattice site
rCellPopulation	The cell population
dt	is the time interval
deltaX	defines the size of the lattice site

Returns:

The probability of the cell moving from the current node to the target node

Implemented in DiffusionMultipleCaUpdateRule< DIM >.

template<unsigned DIM>

void AbstractMultipleCaUpdateRule< DIM >::OutputUpdateRuleInfo

(

out_stream &

rParamsFile

)

Output update rule to file. Call OutputUpdateRuleParameters() to output all member variables to file.

Parameters:

rParamsFile

a file stream

Definition at line 49 of file AbstractMultipleCaUpdateRule.cpp.

template<unsigned DIM>

void AbstractMultipleCaUpdateRule< DIM >::OutputUpdateRuleParameters

(

out_stream &

rParamsFile

)

[pure virtual]

Output update rule parameters to file.

As this method is pure virtual, it must be overridden in subclasses.

Parameters:

rParamsFile

a file stream

Implemented in DiffusionMultipleCaUpdateRule< DIM >.

Definition at line 59 of file AbstractMultipleCaUpdateRule.cpp.

Referenced by DiffusionMultipleCaUpdateRule< DIM >::OutputUpdateRuleParameters().

template<unsigned DIM>

template<class Archive >

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

Serialize the object.

Parameters:

archive	the archive
version	the current version of this class

Reimplemented in DiffusionMultipleCaUpdateRule< DIM >.

Definition at line 63 of file AbstractMultipleCaUpdateRule.hpp.

---

Friends And Related Function Documentation

template<unsigned DIM>

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented in DiffusionMultipleCaUpdateRule< DIM >.

Definition at line 55 of file AbstractMultipleCaUpdateRule.hpp.

---

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

• cell_based/src/population/update_rules/AbstractMultipleCaUpdateRule.hpp
• cell_based/src/population/update_rules/AbstractMultipleCaUpdateRule.cpp