DifferentialAdhesionPottsUpdateRule< DIM > Class Template Reference

#include <DifferentialAdhesionPottsUpdateRule.hpp>

Inherits AdhesionPottsUpdateRule< DIM >.

Collaboration diagram for DifferentialAdhesionPottsUpdateRule< DIM >:

Public Member Functions
	DifferentialAdhesionPottsUpdateRule ()
virtual	~DifferentialAdhesionPottsUpdateRule ()
virtual double	GetCellCellAdhesionEnergy (CellPtr pCellA, CellPtr pCellB)
virtual double	GetCellBoundaryAdhesionEnergy (CellPtr pCell)
double	GetLabelledCellLabelledCellAdhesionEnergyParameter ()
double	GetLabelledCellCellAdhesionEnergyParameter ()
double	GetLabelledCellBoundaryAdhesionEnergyParameter ()
void	SetLabelledCellLabelledCellAdhesionEnergyParameter (double labelledCellLabelledCellAdhesionEnergyParameter)
void	SetLabelledCellCellAdhesionEnergyParameter (double labelledCellCellAdhesionEnergyParameter)
void	SetLabelledCellBoundaryAdhesionEnergyParameter (double labelledCellBoundaryAdhesionEnergyParameter)
void	OutputUpdateRuleParameters (out_stream &rParamsFile)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
double	mLabelledCellLabelledCellAdhesionEnergyParameter
double	mLabelledCellCellAdhesionEnergyParameter
double	mLabelledCellBoundaryAdhesionEnergyParameter
Friends
class	TestPottsUpdateRules
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class DifferentialAdhesionPottsUpdateRule< DIM >

An adhesion update rule for use in cell-based simulations using the cellular Potts model. This rule implements differential adhesion between unlabelled and labelled cells

Definition at line 50 of file DifferentialAdhesionPottsUpdateRule.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

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

Constructor.

Definition at line 39 of file DifferentialAdhesionPottsUpdateRule.cpp.

template<unsigned DIM>

DifferentialAdhesionPottsUpdateRule< DIM >::~DifferentialAdhesionPottsUpdateRule ( ) [inline, virtual]

Destructor.

Definition at line 48 of file DifferentialAdhesionPottsUpdateRule.cpp.

Member Function Documentation

template<unsigned DIM>

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

Overridden GetCellBoundaryAdhesionEnergy method to implement differential adhesion.

Parameters:

pCell

pointer to the cell

Returns:: Cell boundary interaction adhesion energy for the cell

Reimplemented from AdhesionPottsUpdateRule< DIM >.

Definition at line 70 of file DifferentialAdhesionPottsUpdateRule.cpp.

References AdhesionPottsUpdateRule< DIM >::GetCellBoundaryAdhesionEnergyParameter(), and DifferentialAdhesionPottsUpdateRule< DIM >::GetLabelledCellBoundaryAdhesionEnergyParameter().

template<unsigned DIM>

double DifferentialAdhesionPottsUpdateRule< DIM >::GetCellCellAdhesionEnergy	(	CellPtr	pCellA,
		CellPtr	pCellB
	)			`[inline, virtual]`

Overridden GetCellCellAdhesionEnergy method to implement differential adhesion.

Parameters:

	pCellA	pointer to the 1st cell
	pCellB	pointer to the 2nd cell

Returns:: The cell cell interaction adhesion energy between the two cells

Reimplemented from AdhesionPottsUpdateRule< DIM >.

Definition at line 53 of file DifferentialAdhesionPottsUpdateRule.cpp.

References AdhesionPottsUpdateRule< DIM >::GetCellCellAdhesionEnergyParameter(), DifferentialAdhesionPottsUpdateRule< DIM >::GetLabelledCellCellAdhesionEnergyParameter(), and DifferentialAdhesionPottsUpdateRule< DIM >::GetLabelledCellLabelledCellAdhesionEnergyParameter().

template<unsigned DIM>

double DifferentialAdhesionPottsUpdateRule< DIM >::GetLabelledCellBoundaryAdhesionEnergyParameter ( ) [inline]

Returns:: mLabelledCellBoundaryAdhesionEnergyParameter

Definition at line 95 of file DifferentialAdhesionPottsUpdateRule.cpp.

References DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellBoundaryAdhesionEnergyParameter.

Referenced by DifferentialAdhesionPottsUpdateRule< DIM >::GetCellBoundaryAdhesionEnergy().

template<unsigned DIM>

double DifferentialAdhesionPottsUpdateRule< DIM >::GetLabelledCellCellAdhesionEnergyParameter ( ) [inline]

Returns:: mLabelledCellCellAdhesionEnergyParameter

Definition at line 89 of file DifferentialAdhesionPottsUpdateRule.cpp.

References DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellCellAdhesionEnergyParameter.

Referenced by DifferentialAdhesionPottsUpdateRule< DIM >::GetCellCellAdhesionEnergy().

template<unsigned DIM>

double DifferentialAdhesionPottsUpdateRule< DIM >::GetLabelledCellLabelledCellAdhesionEnergyParameter ( ) [inline]

Returns:: mLabelledCellLabelledCellAdhesionEnergyParameter

Definition at line 83 of file DifferentialAdhesionPottsUpdateRule.cpp.

References DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellLabelledCellAdhesionEnergyParameter.

Referenced by DifferentialAdhesionPottsUpdateRule< DIM >::GetCellCellAdhesionEnergy().

template<unsigned DIM>

void DifferentialAdhesionPottsUpdateRule< DIM >::OutputUpdateRuleParameters ( out_stream & rParamsFile ) [inline, virtual]

Overridden OutputUpdateRuleParameters() method.

Parameters:

rParamsFile

the file stream to which the parameters are output

Reimplemented from AdhesionPottsUpdateRule< DIM >.

Definition at line 119 of file DifferentialAdhesionPottsUpdateRule.cpp.

References DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellBoundaryAdhesionEnergyParameter, DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellCellAdhesionEnergyParameter, and DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellLabelledCellAdhesionEnergyParameter.

template<unsigned DIM>

template<class Archive >

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

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.

Reimplemented from AdhesionPottsUpdateRule< DIM >.

Definition at line 86 of file DifferentialAdhesionPottsUpdateRule.hpp.

References DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellBoundaryAdhesionEnergyParameter, DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellCellAdhesionEnergyParameter, and DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellLabelledCellAdhesionEnergyParameter.

template<unsigned DIM>

void DifferentialAdhesionPottsUpdateRule< DIM >::SetLabelledCellBoundaryAdhesionEnergyParameter ( double labelledCellBoundaryAdhesionEnergyParameter ) [inline]

Set mLabelledCellBoundaryAdhesionEnergyParameter.

Parameters:

labelledCellBoundaryAdhesionEnergyParameter

the new value of mLabelledCellBoundaryAdhesionEnergyParameter

Definition at line 113 of file DifferentialAdhesionPottsUpdateRule.cpp.

References DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellBoundaryAdhesionEnergyParameter.

template<unsigned DIM>

void DifferentialAdhesionPottsUpdateRule< DIM >::SetLabelledCellCellAdhesionEnergyParameter ( double labelledCellCellAdhesionEnergyParameter ) [inline]

Set mLabelledCellCellAdhesionEnergyParameter.

Parameters:

labelledCellCellAdhesionEnergyParameter

the new value of mLabelledCelldCellAdhesionEnergyParameter

Definition at line 107 of file DifferentialAdhesionPottsUpdateRule.cpp.

References DifferentialAdhesionPottsUpdateRule< DIM >::mLabelledCellCellAdhesionEnergyParameter.

template<unsigned DIM>

void DifferentialAdhesionPottsUpdateRule< DIM >::SetLabelledCellLabelledCellAdhesionEnergyParameter ( double labelledCellLabelledCellAdhesionEnergyParameter ) [inline]