Chaste  Release::2017.1
Public Member Functions | Private Member Functions | Friends | List of all members
AbstractCaUpdateRule< DIM > Class Template Referenceabstract

#include <AbstractCaUpdateRule.hpp>

+ Inheritance diagram for AbstractCaUpdateRule< DIM >:
+ Collaboration diagram for AbstractCaUpdateRule< DIM >:

Public Member Functions

 AbstractCaUpdateRule ()
 
virtual ~AbstractCaUpdateRule ()
 
virtual double EvaluateProbability (unsigned currentNodeIndex, unsigned targetNodeIndex, CaBasedCellPopulation< DIM > &rCellPopulation, double dt, double deltaX, CellPtr cell)=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 AbstractCaUpdateRule< DIM >

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

Definition at line 49 of file AbstractCaUpdateRule.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 39 of file AbstractCaUpdateRule.cpp.

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

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

Destructor.

Definition at line 45 of file AbstractCaUpdateRule.cpp.

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

Member Function Documentation

template<unsigned DIM>
virtual double AbstractCaUpdateRule< DIM >::EvaluateProbability ( unsigned  currentNodeIndex,
unsigned  targetNodeIndex,
CaBasedCellPopulation< DIM > &  rCellPopulation,
double  dt,
double  deltaX,
CellPtr  cell 
)
pure virtual

Calculate the probability of a given move.

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

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

Parameters
currentNodeIndexThe index of the current node/lattice site
targetNodeIndexThe index of the target node/lattice site
rCellPopulationThe cell population
dtis the time interval
deltaXdefines the size of the lattice site
cella pointer to the cell (needed if more than one cell per lattice site
Returns
The probability of the cell moving from the current node to the target node

Implemented in DiffusionCaUpdateRule< DIM >.

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

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

Overridden OutputUpdateRuleParameters() method.

Parameters
rParamsFilea file stream

Implements AbstractUpdateRule< DIM >.

Reimplemented in DiffusionCaUpdateRule< DIM >.

Definition at line 50 of file AbstractCaUpdateRule.cpp.

References AbstractUpdateRule< DIM >::OutputUpdateRuleParameters().

Referenced by DiffusionCaUpdateRule< DIM >::OutputUpdateRuleParameters(), and AbstractCaUpdateRule< DIM >::serialize().

template<unsigned DIM>
template<class Archive >
void AbstractCaUpdateRule< 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 AbstractCaUpdateRule.hpp.

References AbstractCaUpdateRule< DIM >::AbstractCaUpdateRule(), AbstractCaUpdateRule< DIM >::EvaluateProbability(), AbstractCaUpdateRule< DIM >::OutputUpdateRuleParameters(), and AbstractCaUpdateRule< DIM >::~AbstractCaUpdateRule().

Friends And Related Function Documentation

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

Needed for serialization.

Definition at line 52 of file AbstractCaUpdateRule.hpp.

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