Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
Public Member Functions | Private Member Functions | Friends | List of all members
ChemotaxisPottsUpdateRule< DIM > Class Template Reference

#include <ChemotaxisPottsUpdateRule.hpp>

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

Public Member Functions

 ChemotaxisPottsUpdateRule ()
 
 ~ChemotaxisPottsUpdateRule ()
 
double EvaluateHamiltonianContribution (unsigned currentNodeIndex, unsigned targetNodeIndex, PottsBasedCellPopulation< DIM > &rCellPopulation)
 
void OutputUpdateRuleParameters (out_stream &rParamsFile)
 
- Public Member Functions inherited from AbstractPottsUpdateRule< DIM >
 AbstractPottsUpdateRule ()
 
virtual ~AbstractPottsUpdateRule ()
 
- 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 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

◆ ChemotaxisPottsUpdateRule()

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

Constructor.

Definition at line 39 of file ChemotaxisPottsUpdateRule.cpp.

◆ ~ChemotaxisPottsUpdateRule()

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

Destructor.

Definition at line 45 of file ChemotaxisPottsUpdateRule.cpp.

Member Function Documentation

◆ EvaluateHamiltonianContribution()

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(), and Node< SPACE_DIM >::rGetLocation().

◆ OutputUpdateRuleParameters()

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

Overridden OutputUpdateRuleParameters() method.

Parameters
rParamsFilethe file stream to which the parameters are output

Reimplemented from AbstractPottsUpdateRule< DIM >.

Definition at line 75 of file ChemotaxisPottsUpdateRule.cpp.

References AbstractPottsUpdateRule< DIM >::OutputUpdateRuleParameters().

◆ serialize()

template<unsigned DIM>
template<class Archive >
void ChemotaxisPottsUpdateRule< 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 67 of file ChemotaxisPottsUpdateRule.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

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

Definition at line 58 of file ChemotaxisPottsUpdateRule.hpp.

◆ TestPottsUpdateRules

template<unsigned DIM>
friend class TestPottsUpdateRules
friend

Definition at line 54 of file ChemotaxisPottsUpdateRule.hpp.

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