Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
Public Member Functions | Private Member Functions | Friends | List of all members
AbstractCaSwitchingUpdateRule< DIM > Class Template Referenceabstract

#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
 
virtual void OutputUpdateRuleParameters (out_stream &rParamsFile)
 
- 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)
 

Friends

class boost::serialization::access
 

Detailed Description

template<unsigned DIM>
class AbstractCaSwitchingUpdateRule< DIM >

An abstract CA 'switching' update rule class, for use in CA simulations.

Definition at line 49 of file AbstractCaSwitchingUpdateRule.hpp.

Constructor & Destructor Documentation

◆ AbstractCaSwitchingUpdateRule()

template<unsigned DIM>
AbstractCaSwitchingUpdateRule< DIM >::AbstractCaSwitchingUpdateRule ( )

Default constructor.

Definition at line 39 of file AbstractCaSwitchingUpdateRule.cpp.

◆ ~AbstractCaSwitchingUpdateRule()

template<unsigned DIM>
AbstractCaSwitchingUpdateRule< DIM >::~AbstractCaSwitchingUpdateRule ( )
virtual

Destructor.

Definition at line 45 of file AbstractCaSwitchingUpdateRule.cpp.

Member Function Documentation

◆ EvaluateSwitchingProbability()

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
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.

Implemented in RandomCaSwitchingUpdateRule< DIM >.

◆ OutputUpdateRuleParameters()

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

Overridden OutputUpdateRuleParameters() method.

Parameters
rParamsFilea file stream

Implements AbstractUpdateRule< DIM >.

Reimplemented in RandomCaSwitchingUpdateRule< DIM >.

Definition at line 50 of file AbstractCaSwitchingUpdateRule.cpp.

References AbstractUpdateRule< DIM >::OutputUpdateRuleParameters().

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

◆ serialize()

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

Definition at line 61 of file AbstractCaSwitchingUpdateRule.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

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

Needed for serialization.

Definition at line 52 of file AbstractCaSwitchingUpdateRule.hpp.

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