Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
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

◆ RandomCaSwitchingUpdateRule()

Constructor.

Definition at line 39 of file RandomCaSwitchingUpdateRule.cpp.

◆ ~RandomCaSwitchingUpdateRule()

Destructor.

Definition at line 46 of file RandomCaSwitchingUpdateRule.cpp.

Member Function Documentation

◆ EvaluateSwitchingProbability()

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
currentNodeIndexThe index of the current node/lattice site
neighbourNodeIndexThe index of the neighbour node/lattice site
rCellPopulationThe cell population
dtis the time interval
deltaXdefines 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.

◆ GetSwitchingParameter()

template<unsigned DIM>
double RandomCaSwitchingUpdateRule< DIM >::GetSwitchingParameter ( )
Returns
mSwitchingParameter

Definition at line 61 of file RandomCaSwitchingUpdateRule.cpp.

◆ OutputUpdateRuleParameters()

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

Overridden OutputUpdateRuleParameters() method.

Parameters
rParamsFilethe file stream to which the parameters are output

Reimplemented from AbstractCaSwitchingUpdateRule< DIM >.

Definition at line 73 of file RandomCaSwitchingUpdateRule.cpp.

References AbstractCaSwitchingUpdateRule< DIM >::OutputUpdateRuleParameters().

◆ 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
archiveThe boost archive.
versionThe current version of this class.

Definition at line 79 of file RandomCaSwitchingUpdateRule.hpp.

References RandomCaSwitchingUpdateRule< DIM >::mSwitchingParameter.

◆ SetSwitchingParameter()

template<unsigned DIM>
void RandomCaSwitchingUpdateRule< DIM >::SetSwitchingParameter ( double  switchingParameter)

Set mSwitchingParameter.

Parameters
switchingParameterthe new value of mSwitchingParameter

Definition at line 67 of file RandomCaSwitchingUpdateRule.cpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

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

Definition at line 70 of file RandomCaSwitchingUpdateRule.hpp.

◆ TestCaUpdateRules

template<unsigned DIM>
friend class TestCaUpdateRules
friend

Definition at line 59 of file RandomCaSwitchingUpdateRule.hpp.

Member Data Documentation

◆ mSwitchingParameter

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 >::serialize().


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