AbstractCaUpdateRule< DIM > Class Template Reference

#include <AbstractCaUpdateRule.hpp>

Inherits Identifiable.

Inherited by AdvectionCaUpdateRule< DIM >, and DiffusionCaUpdateRule< DIM >.

Collaboration diagram for AbstractCaUpdateRule< DIM >:

[legend]

List of all members.

Public Member Functions
	AbstractCaUpdateRule ()
virtual	~AbstractCaUpdateRule ()
virtual unsigned	GetNewLocationOfCell (unsigned currentLocationIndex, CaBasedCellPopulation< DIM > &rCellPopulation, double dt)=0
void	OutputUpdateRuleInfo (out_stream &rParamsFile)
virtual void	OutputUpdateRuleParameters (out_stream &rParamsFile)=0
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.

Definition at line 44 of file AbstractCaUpdateRule.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

AbstractCaUpdateRule< DIM >::AbstractCaUpdateRule

(

)

[inline]

Default constructor.

Definition at line 32 of file AbstractCaUpdateRule.cpp.

template<unsigned DIM>

AbstractCaUpdateRule< DIM >::~AbstractCaUpdateRule

(

)

[inline, virtual]

Destructor.

Definition at line 37 of file AbstractCaUpdateRule.cpp.

---

Member Function Documentation

template<unsigned DIM>

virtual unsigned AbstractCaUpdateRule< DIM >::GetNewLocationOfCell	(	unsigned	currentLocationIndex,
		CaBasedCellPopulation< DIM > &	rCellPopulation,
		double	dt
	)			[pure virtual]

Calculates the new location for a particular cell.

This method must be overridden in concrete classes.

Parameters:

	currentLocationIndex	the current location index of a cell
	rCellPopulation	reference to the cell population
	dt	timestep of the simulation to calculate probability of movement in current timestep

Implemented in AdvectionCaUpdateRule< DIM >, and DiffusionCaUpdateRule< DIM >.

template<unsigned DIM>

void AbstractCaUpdateRule< DIM >::OutputUpdateRuleInfo

(

out_stream &

rParamsFile

)

[inline]

Output update rule to file. Call OutputUpdateRuleParameters() to output all member variables to file.

Parameters:

rParamsFile

a file stream

Definition at line 42 of file AbstractCaUpdateRule.cpp.

References Identifiable::GetIdentifier(), and AbstractCaUpdateRule< DIM >::OutputUpdateRuleParameters().

template<unsigned DIM>

void AbstractCaUpdateRule< DIM >::OutputUpdateRuleParameters

(

out_stream &

rParamsFile

)

[inline, pure virtual]

Output update rule parameters to file.

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

Parameters:

rParamsFile

a file stream

Implemented in AdvectionCaUpdateRule< DIM >, and DiffusionCaUpdateRule< DIM >.

Definition at line 52 of file AbstractCaUpdateRule.cpp.

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

template<unsigned DIM>

template<class Archive >

void AbstractCaUpdateRule< DIM >::serialize	(	Archive &	archive,
		const unsigned int	version
	)			[inline, private]

Serialize the object and its member variables.

Parameters:

	archive	the archive
	version	the current version of this class

Reimplemented in AdvectionCaUpdateRule< DIM >, and DiffusionCaUpdateRule< DIM >.

Definition at line 55 of file AbstractCaUpdateRule.hpp.

---

Friends And Related Function Documentation

template<unsigned DIM>

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented in AdvectionCaUpdateRule< DIM >, and DiffusionCaUpdateRule< DIM >.

Definition at line 47 of file AbstractCaUpdateRule.hpp.

---

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

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