AbstractPottsUpdateRule< DIM > Class Template Reference

#include <AbstractPottsUpdateRule.hpp>

Inheritance diagram for AbstractPottsUpdateRule< DIM >:

Collaboration diagram for AbstractPottsUpdateRule< DIM >:

Public Member Functions
	AbstractPottsUpdateRule ()
virtual	~AbstractPottsUpdateRule ()
virtual double	EvaluateHamiltonianContribution (unsigned currentNodeIndex, unsigned targetNodeIndex, PottsBasedCellPopulation< DIM > &rCellPopulation)=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 AbstractPottsUpdateRule< DIM >

An abstract Potts update rule class, for use in cellular Potts model simulations.

Definition at line 49 of file AbstractPottsUpdateRule.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

AbstractPottsUpdateRule< DIM >::AbstractPottsUpdateRule

(

)

Default constructor.

Definition at line 39 of file AbstractPottsUpdateRule.cpp.

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

template<unsigned DIM>

AbstractPottsUpdateRule< DIM >::~AbstractPottsUpdateRule ( )

virtual

Destructor.

Definition at line 45 of file AbstractPottsUpdateRule.cpp.

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

Member Function Documentation

template<unsigned DIM>

virtual double AbstractPottsUpdateRule< DIM >::EvaluateHamiltonianContribution ( unsigned  currentNodeIndex, unsigned  targetNodeIndex, PottsBasedCellPopulation< DIM > &  rCellPopulation  )

pure virtual

Calculate the contribution to the Hamiltonian.

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

Parameters

currentNodeIndex	The index of the current node/lattice site
targetNodeIndex	The index of the target node/lattice site
rCellPopulation	The 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

Implemented in SurfaceAreaConstraintPottsUpdateRule< DIM >, VolumeConstraintPottsUpdateRule< DIM >, AdhesionPottsUpdateRule< DIM >, and ChemotaxisPottsUpdateRule< DIM >.

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

template<unsigned DIM>

void AbstractPottsUpdateRule< DIM >::OutputUpdateRuleParameters ( out_stream &  rParamsFile )

virtual

Overridden OutputUpdateRuleParameters() method.

Parameters

rParamsFile

a file stream

Implements AbstractUpdateRule< DIM >.

Reimplemented in DifferentialAdhesionPottsUpdateRule< DIM >, AdhesionPottsUpdateRule< DIM >, SurfaceAreaConstraintPottsUpdateRule< DIM >, VolumeConstraintPottsUpdateRule< DIM >, and ChemotaxisPottsUpdateRule< DIM >.

Definition at line 50 of file AbstractPottsUpdateRule.cpp.

References AbstractUpdateRule< DIM >::OutputUpdateRuleParameters().

Referenced by ChemotaxisPottsUpdateRule< DIM >::OutputUpdateRuleParameters(), VolumeConstraintPottsUpdateRule< DIM >::OutputUpdateRuleParameters(), SurfaceAreaConstraintPottsUpdateRule< DIM >::OutputUpdateRuleParameters(), AdhesionPottsUpdateRule< DIM >::OutputUpdateRuleParameters(), and AbstractPottsUpdateRule< DIM >::serialize().

template<unsigned DIM>

template<class Archive >

void AbstractPottsUpdateRule< DIM >::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Boost Serialization method for archiving/checkpointing. Archives the object and its member variables.

Parameters

archive	The boost archive.
version	The current version of this class.

Definition at line 61 of file AbstractPottsUpdateRule.hpp.

References AbstractPottsUpdateRule< DIM >::AbstractPottsUpdateRule(), AbstractPottsUpdateRule< DIM >::EvaluateHamiltonianContribution(), AbstractPottsUpdateRule< DIM >::OutputUpdateRuleParameters(), and AbstractPottsUpdateRule< DIM >::~AbstractPottsUpdateRule().

Friends And Related Function Documentation

template<unsigned DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 52 of file AbstractPottsUpdateRule.hpp.

---

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

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