#include <AdhesionPottsUpdateRule.hpp>

Inheritance diagram for AdhesionPottsUpdateRule< DIM >:

Collaboration diagram for AdhesionPottsUpdateRule< DIM >:

Public Member Functions
	AdhesionPottsUpdateRule ()

virtual	~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)

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)

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 50 of file AdhesionPottsUpdateRule.hpp.

Constructor & Destructor Documentation

◆ AdhesionPottsUpdateRule()

template<unsigned DIM>

AdhesionPottsUpdateRule< DIM >::AdhesionPottsUpdateRule ( )

Constructor.

Definition at line 39 of file AdhesionPottsUpdateRule.cpp.

◆ ~AdhesionPottsUpdateRule()

template<unsigned DIM>

AdhesionPottsUpdateRule< DIM >::~AdhesionPottsUpdateRule ( )

virtual

Destructor.

Definition at line 47 of file AdhesionPottsUpdateRule.cpp.

Member Function Documentation

◆ EvaluateHamiltonianContribution()

template<unsigned DIM>

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

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 52 of file AdhesionPottsUpdateRule.cpp.

References EXCEPTION, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellUsingLocationIndex(), PottsBasedCellPopulation< DIM >::GetNode(), Node< SPACE_DIM >::rGetContainingElementIndices(), and PottsBasedCellPopulation< DIM >::rGetMesh().