#include <DifferentialAdhesionPottsUpdateRule.hpp>

Inheritance diagram for DifferentialAdhesionPottsUpdateRule< DIM >:

Collaboration diagram for DifferentialAdhesionPottsUpdateRule< DIM >:

Public Member Functions
	DifferentialAdhesionPottsUpdateRule ()
	~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 53 of file DifferentialAdhesionPottsUpdateRule.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

DifferentialAdhesionPottsUpdateRule< DIM >::DifferentialAdhesionPottsUpdateRule ( )

Constructor.

Definition at line 39 of file DifferentialAdhesionPottsUpdateRule.cpp.

template<unsigned DIM>

DifferentialAdhesionPottsUpdateRule< DIM >::~DifferentialAdhesionPottsUpdateRule ( )

Destructor.

Definition at line 48 of file DifferentialAdhesionPottsUpdateRule.cpp.

Member Function Documentation

template<unsigned DIM>

double DifferentialAdhesionPottsUpdateRule< DIM >::GetCellBoundaryAdhesionEnergy ( CellPtr pCell ) [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 71 of file DifferentialAdhesionPottsUpdateRule.cpp.

template<unsigned DIM>

double DifferentialAdhesionPottsUpdateRule< DIM >::GetCellCellAdhesionEnergy	(	CellPtr	pCellA,
		CellPtr	pCellB
	)		`[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 54 of file DifferentialAdhesionPottsUpdateRule.cpp.

template<unsigned DIM>

double DifferentialAdhesionPottsUpdateRule< DIM >::GetLabelledCellBoundaryAdhesionEnergyParameter ( )

Returns:: mLabelledCellBoundaryAdhesionEnergyParameter

Definition at line 97 of file DifferentialAdhesionPottsUpdateRule.cpp.

template<unsigned DIM>

double DifferentialAdhesionPottsUpdateRule< DIM >::GetLabelledCellCellAdhesionEnergyParameter ( )

Returns:: mLabelledCellCellAdhesionEnergyParameter

Definition at line 91 of file DifferentialAdhesionPottsUpdateRule.cpp.

template<unsigned DIM>

double DifferentialAdhesionPottsUpdateRule< DIM >::GetLabelledCellLabelledCellAdhesionEnergyParameter ( )

Returns:: mLabelledCellLabelledCellAdhesionEnergyParameter

Definition at line 85 of file DifferentialAdhesionPottsUpdateRule.cpp.

template<unsigned DIM>

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

Overridden OutputUpdateRuleParameters() method.

Parameters:

rParamsFile the file stream to which the parameters are output

Reimplemented from AdhesionPottsUpdateRule< DIM >.

Definition at line 122 of file DifferentialAdhesionPottsUpdateRule.cpp.

References AdhesionPottsUpdateRule< DIM >::OutputUpdateRuleParameters().

template<unsigned DIM>

template<class Archive >

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

Serialize the object.

Parameters:

archive	the archive
version	the current version of this class

Reimplemented from AdhesionPottsUpdateRule< DIM >.

Definition at line 82 of file DifferentialAdhesionPottsUpdateRule.hpp.

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

template<unsigned DIM>

void DifferentialAdhesionPottsUpdateRule< DIM >::SetLabelledCellBoundaryAdhesionEnergyParameter ( double labelledCellBoundaryAdhesionEnergyParameter )

Set mLabelledCellBoundaryAdhesionEnergyParameter.

Parameters:

labelledCellBoundaryAdhesionEnergyParameter the new value of mLabelledCellBoundaryAdhesionEnergyParameter

Definition at line 115 of file DifferentialAdhesionPottsUpdateRule.cpp.

template<unsigned DIM>

void DifferentialAdhesionPottsUpdateRule< DIM >::SetLabelledCellCellAdhesionEnergyParameter ( double labelledCellCellAdhesionEnergyParameter )

Set mLabelledCellCellAdhesionEnergyParameter.

Parameters:

labelledCellCellAdhesionEnergyParameter the new value of mLabelledCelldCellAdhesionEnergyParameter

Definition at line 109 of file DifferentialAdhesionPottsUpdateRule.cpp.

template<unsigned DIM>

void DifferentialAdhesionPottsUpdateRule< DIM >::SetLabelledCellLabelledCellAdhesionEnergyParameter ( double labelledCellLabelledCellAdhesionEnergyParameter )

Set mLabelledCellLabelledCellAdhesionEnergyParameter.

Parameters:

labelledCellLabelledCellAdhesionEnergyParameter the new value of mLabelledCellLabelledCellAdhesionEnergyParameter

Definition at line 103 of file DifferentialAdhesionPottsUpdateRule.cpp.