RandomCaSwitchingUpdateRule< DIM > Class Template Reference

#include <RandomCaSwitchingUpdateRule.hpp>

Inheritance diagram for RandomCaSwitchingUpdateRule< DIM >:

Collaboration diagram for RandomCaSwitchingUpdateRule< DIM >:

Public Member Functions
	RandomCaSwitchingUpdateRule ()
	~RandomCaSwitchingUpdateRule ()
double	EvaluateSwitchingProbability (unsigned currentNodeIndex, unsigned neighbourNodeIndex, CaBasedCellPopulation< DIM > &rCellPopulation, double dt, double deltaX)
double	GetSwitchingParameter ()
void	SetSwitchingParameter (double switchingParameter)
void	OutputUpdateRuleParameters (out_stream &rParamsFile)
Public Member Functions inherited from AbstractCaSwitchingUpdateRule< DIM >
	AbstractCaSwitchingUpdateRule ()
virtual	~AbstractCaSwitchingUpdateRule ()
Public Member Functions inherited from AbstractUpdateRule< DIM >
	AbstractUpdateRule ()
virtual	~AbstractUpdateRule ()
void	OutputUpdateRuleInfo (out_stream &rParamsFile)
Public Member Functions inherited from Identifiable
virtual	~Identifiable ()
std::string	GetIdentifier () const

Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)

Private Attributes
double	mSwitchingParameter

Friends
class	TestCaUpdateRules
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class RandomCaSwitchingUpdateRule< DIM >

A random switching update rule for use in cell-based simulations using the cellular CA model.

The probability of performing a switch is

P* delta_t

Where P is the mSwitchingParameter. delta_t is the timestep.

Definition at line 57 of file RandomCaSwitchingUpdateRule.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

RandomCaSwitchingUpdateRule< DIM >::RandomCaSwitchingUpdateRule

(

)

Constructor.

Definition at line 39 of file RandomCaSwitchingUpdateRule.cpp.

Referenced by RandomCaSwitchingUpdateRule< DIM >::serialize().

template<unsigned DIM>

RandomCaSwitchingUpdateRule< DIM >::~RandomCaSwitchingUpdateRule

(

)

Destructor.

Definition at line 46 of file RandomCaSwitchingUpdateRule.cpp.

Referenced by RandomCaSwitchingUpdateRule< DIM >::serialize().

Member Function Documentation

template<unsigned DIM>

double RandomCaSwitchingUpdateRule< DIM >::EvaluateSwitchingProbability ( unsigned  currentNodeIndex, unsigned  neighbourNodeIndex, CaBasedCellPopulation< DIM > &  rCellPopulation, double  dt, double  deltaX  )

virtual

Calculate the probability of a given switch. Here this is hust

mSwitchingParameter * dt

Parameters

currentNodeIndex	The index of the current node/lattice site
neighbourNodeIndex	The index of the neighbour 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 cells associated to the current node and the target node switching.

Implements AbstractCaSwitchingUpdateRule< DIM >.

Definition at line 51 of file RandomCaSwitchingUpdateRule.cpp.

References RandomCaSwitchingUpdateRule< DIM >::mSwitchingParameter.

Referenced by RandomCaSwitchingUpdateRule< DIM >::serialize().

template<unsigned DIM>

double RandomCaSwitchingUpdateRule< DIM >::GetSwitchingParameter

(

)

Returns

mSwitchingParameter

Definition at line 61 of file RandomCaSwitchingUpdateRule.cpp.

References RandomCaSwitchingUpdateRule< DIM >::mSwitchingParameter.

Referenced by RandomCaSwitchingUpdateRule< DIM >::serialize().

template<unsigned DIM>

void RandomCaSwitchingUpdateRule< DIM >::OutputUpdateRuleParameters ( out_stream &  rParamsFile )

virtual

Overridden OutputUpdateRuleParameters() method.

Parameters

rParamsFile

the file stream to which the parameters are output

Reimplemented from AbstractCaSwitchingUpdateRule< DIM >.

Definition at line 73 of file RandomCaSwitchingUpdateRule.cpp.

References EXPORT_TEMPLATE_CLASS_SAME_DIMS, RandomCaSwitchingUpdateRule< DIM >::mSwitchingParameter, and AbstractCaSwitchingUpdateRule< DIM >::OutputUpdateRuleParameters().

Referenced by RandomCaSwitchingUpdateRule< DIM >::serialize().

template<unsigned DIM>

template<class Archive >

void RandomCaSwitchingUpdateRule< DIM >::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Boost Serialization method for archiving/checkpointing. Archives the object and its member variables.

Parameters

archive	The boost archive.
version	The current version of this class.

Definition at line 79 of file RandomCaSwitchingUpdateRule.hpp.

References RandomCaSwitchingUpdateRule< DIM >::EvaluateSwitchingProbability(), EXPORT_TEMPLATE_CLASS_SAME_DIMS, RandomCaSwitchingUpdateRule< DIM >::GetSwitchingParameter(), RandomCaSwitchingUpdateRule< DIM >::mSwitchingParameter, RandomCaSwitchingUpdateRule< DIM >::OutputUpdateRuleParameters(), RandomCaSwitchingUpdateRule< DIM >::RandomCaSwitchingUpdateRule(), RandomCaSwitchingUpdateRule< DIM >::SetSwitchingParameter(), and RandomCaSwitchingUpdateRule< DIM >::~RandomCaSwitchingUpdateRule().

template<unsigned DIM>

void RandomCaSwitchingUpdateRule< DIM >::SetSwitchingParameter

(

double

switchingParameter

)

Set mSwitchingParameter.

Parameters

switchingParameter

the new value of mSwitchingParameter

Definition at line 67 of file RandomCaSwitchingUpdateRule.cpp.

References RandomCaSwitchingUpdateRule< DIM >::mSwitchingParameter.

Referenced by RandomCaSwitchingUpdateRule< DIM >::serialize().

Member Data Documentation

template<unsigned DIM>

double RandomCaSwitchingUpdateRule< DIM >::mSwitchingParameter

private

Switching parameter for update rule. Set to the default value 0.5 in the constructor.

Todo:

provide units

Definition at line 68 of file RandomCaSwitchingUpdateRule.hpp.

Referenced by RandomCaSwitchingUpdateRule< DIM >::EvaluateSwitchingProbability(), RandomCaSwitchingUpdateRule< DIM >::GetSwitchingParameter(), RandomCaSwitchingUpdateRule< DIM >::OutputUpdateRuleParameters(), RandomCaSwitchingUpdateRule< DIM >::serialize(), and RandomCaSwitchingUpdateRule< DIM >::SetSwitchingParameter().

---

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

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