AbstractCaSwitchingUpdateRule< DIM > Class Template Reference

#include <AbstractCaSwitchingUpdateRule.hpp>

Inheritance diagram for AbstractCaSwitchingUpdateRule< DIM >:

Collaboration diagram for AbstractCaSwitchingUpdateRule< DIM >:

Public Member Functions
	AbstractCaSwitchingUpdateRule ()
virtual	~AbstractCaSwitchingUpdateRule ()
virtual double	EvaluateSwitchingProbability (unsigned currentNodeIndex, unsigned neighbourNodeIndex, CaBasedCellPopulation< DIM > &rCellPopulation, double dt, double deltaX)=0
void	OutputUpdateRuleInfo (out_stream &rParamsFile)
virtual void	OutputSwitchingUpdateRuleParameters (out_stream &rParamsFile)=0
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)

Friends
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class AbstractCaSwitchingUpdateRule< DIM >

An abstract Ca Switching update rule class, for use in cell-based simulations using the cellular automata model.

Definition at line 52 of file AbstractCaSwitchingUpdateRule.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

AbstractCaSwitchingUpdateRule< DIM >::AbstractCaSwitchingUpdateRule

(

)

Default constructor.

Definition at line 39 of file AbstractCaSwitchingUpdateRule.cpp.

template<unsigned DIM>

AbstractCaSwitchingUpdateRule< DIM >::~AbstractCaSwitchingUpdateRule ( )

virtual

Destructor.

Definition at line 44 of file AbstractCaSwitchingUpdateRule.cpp.

Member Function Documentation

template<unsigned DIM>

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

pure virtual

Calculate the probability of a given switch.

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.

Implemented in RandomCaSwitchingUpdateRule< DIM >.

template<unsigned DIM>

void AbstractCaSwitchingUpdateRule< DIM >::OutputSwitchingUpdateRuleParameters ( out_stream &  rParamsFile )

pure virtual

Output switching update rule parameters to file.

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

Parameters

rParamsFile

a file stream

Implemented in RandomCaSwitchingUpdateRule< DIM >.

Definition at line 59 of file AbstractCaSwitchingUpdateRule.cpp.

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

template<unsigned DIM>

void AbstractCaSwitchingUpdateRule< 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 AbstractCaSwitchingUpdateRule.cpp.

template<unsigned DIM>

template<class Archive >

void AbstractCaSwitchingUpdateRule< 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 64 of file AbstractCaSwitchingUpdateRule.hpp.

Friends And Related Function Documentation

template<unsigned DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 55 of file AbstractCaSwitchingUpdateRule.hpp.

---

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

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