AdhesionPottsUpdateRule< DIM > Class Template Reference

#include <AdhesionPottsUpdateRule.hpp>

Inherits AbstractPottsUpdateRule< DIM >.

Inherited by DifferentialAdhesionPottsUpdateRule< DIM >.

Collaboration diagram for AdhesionPottsUpdateRule< DIM >:

Public Member Functions
	AdhesionPottsUpdateRule ()
	~AdhesionPottsUpdateRule ()
double	EvaluateHamiltonianContribution (unsigned currentNodeIndex, unsigned targetNodeIndex, PottsBasedCellPopulation< DIM > &rCellPopulation)
virtual double	GetCellCellAdhesionEnergy (CellPtr pCellA, CellPtr pCellB)
virtual double	GetCellBoundaryAdhesionEnergy (CellPtr pCell)
double	GetCellCellAdhesionEnergyParameter ()
double	GetCellBoundaryAdhesionEnergyParameter ()
void	SetCellCellAdhesionEnergyParameter (double cellCellAdhesionEnergyEnergyParameter)
void	SetCellBoundaryAdhesionEnergyParameter (double cellBoundaryAdhesionEnergyParameter)
void	OutputUpdateRuleParameters (out_stream &rParamsFile)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
double	mCellCellAdhesionEnergyParameter
double	mCellBoundaryAdhesionEnergyParameter
Friends
class	TestPottsUpdateRules
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class AdhesionPottsUpdateRule< DIM >

An adhesion update rule for use in cell-based simulations using the cellular Potts model.

Definition at line 46 of file AdhesionPottsUpdateRule.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

AdhesionPottsUpdateRule< DIM >::AdhesionPottsUpdateRule ( ) [inline]

Constructor.

Definition at line 32 of file AdhesionPottsUpdateRule.cpp.

template<unsigned DIM>

AdhesionPottsUpdateRule< DIM >::~AdhesionPottsUpdateRule ( ) [inline]

Destructor.

Definition at line 40 of file AdhesionPottsUpdateRule.cpp.

Member Function Documentation

template<unsigned DIM>

double AdhesionPottsUpdateRule< DIM >::EvaluateHamiltonianContribution	(	unsigned	currentNodeIndex,
		unsigned	targetNodeIndex,
		PottsBasedCellPopulation< DIM > &	rCellPopulation
	)			`[inline, virtual]`

Overridden EvaluateHamiltonianContribution() method

Uses sum_adjacentsites (1-delta(spin(i),spin(j))) gamma(spin(i),spin(j))

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

Before the move, we have a negative contribution (H_0) to the Hamiltonian if: the target node and neighbouring node are NOT contained in the same Potts element; the neighbouring node is contained in a Potts element, but the target node is not; or the target node is contained in a Potts element, but the neighbouring node is not.

After the move, we have a positive contribution (H_1) to the Hamiltonian if: the current node and neighbouring node are contained in different Potts elements; the neighbouring node is contained in a Potts element, but the current node is not; or the current node is contained in a Potts element, but the neighbouring node is not.

Implements AbstractPottsUpdateRule< DIM >.

Definition at line 45 of file AdhesionPottsUpdateRule.cpp.

References EXCEPTION, AdhesionPottsUpdateRule< DIM >::GetCellBoundaryAdhesionEnergy(), AdhesionPottsUpdateRule< DIM >::GetCellCellAdhesionEnergy(), AbstractCellPopulation< DIM >::GetCellUsingLocationIndex(), PottsBasedCellPopulation< DIM >::GetNode(), and PottsBasedCellPopulation< DIM >::rGetMesh().

template<unsigned DIM>

double AdhesionPottsUpdateRule< DIM >::GetCellBoundaryAdhesionEnergy ( CellPtr pCell ) [inline, virtual]