Chaste Release::3.1
ChemotaxisPottsUpdateRule< DIM > Class Template Reference

#include <ChemotaxisPottsUpdateRule.hpp>

Inheritance diagram for ChemotaxisPottsUpdateRule< DIM >:
Collaboration diagram for ChemotaxisPottsUpdateRule< DIM >:

List of all members.

Public Member Functions

 ChemotaxisPottsUpdateRule ()
 ~ChemotaxisPottsUpdateRule ()
double EvaluateHamiltonianContribution (unsigned currentNodeIndex, unsigned targetNodeIndex, PottsBasedCellPopulation< DIM > &rCellPopulation)
void OutputUpdateRuleParameters (out_stream &rParamsFile)

Private Member Functions

template<class Archive >
void serialize (Archive &archive, const unsigned int version)

Friends

class TestPottsUpdateRules
class boost::serialization::access

Detailed Description

template<unsigned DIM>
class ChemotaxisPottsUpdateRule< DIM >

A simple update rule class to represent simple chemotaxis in the positive x y z direction for use in Potts based simulations.

Note this currently assumes cells don't grow, i.e the target volume is constant for each cell over time.

Definition at line 52 of file ChemotaxisPottsUpdateRule.hpp.


Constructor & Destructor Documentation

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

Constructor.

Definition at line 39 of file ChemotaxisPottsUpdateRule.cpp.

template<unsigned DIM>
ChemotaxisPottsUpdateRule< DIM >::~ChemotaxisPottsUpdateRule ( )

Destructor.

Definition at line 45 of file ChemotaxisPottsUpdateRule.cpp.


Member Function Documentation

template<unsigned DIM>
double ChemotaxisPottsUpdateRule< DIM >::EvaluateHamiltonianContribution ( unsigned  currentNodeIndex,
unsigned  targetNodeIndex,
PottsBasedCellPopulation< DIM > &  rCellPopulation 
) [virtual]

Overridden EvaluateHamiltonianContribution() method

Assigns a greater propensity for moving in an increasing x, y (and z) direction.

Parameters:
currentNodeIndexThe index of the current node/lattice site
targetNodeIndexThe index of the target node/lattice site
rCellPopulationThe cell population
Returns:
The difference in the Hamiltonian with the configuration of the target node having the same spin as the current node with the current configuration. i.e H_1-H_0

Implements AbstractPottsUpdateRule< DIM >.

Definition at line 50 of file ChemotaxisPottsUpdateRule.cpp.

References PottsBasedCellPopulation< DIM >::GetNode().

template<unsigned DIM>
void ChemotaxisPottsUpdateRule< DIM >::OutputUpdateRuleParameters ( out_stream &  rParamsFile) [virtual]

Overridden OutputUpdateRuleParameters() method.

Parameters:
rParamsFilethe file stream to which the parameters are output

Implements AbstractPottsUpdateRule< DIM >.

Definition at line 74 of file ChemotaxisPottsUpdateRule.cpp.

References AbstractPottsUpdateRule< DIM >::OutputUpdateRuleParameters().

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

Serialize the object.

Parameters:
archivethe archive
versionthe current version of this class

Reimplemented from AbstractPottsUpdateRule< DIM >.

Definition at line 60 of file ChemotaxisPottsUpdateRule.hpp.


Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractPottsUpdateRule< DIM >.

Definition at line 58 of file ChemotaxisPottsUpdateRule.hpp.


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