NagaiHondaDifferentialAdhesionForce< DIM > Class Template Reference

#include <NagaiHondaDifferentialAdhesionForce.hpp>

Inherits NagaiHondaForce< DIM >.

Collaboration diagram for NagaiHondaDifferentialAdhesionForce< DIM >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 NagaiHondaDifferentialAdhesionForce ()
virtual ~NagaiHondaDifferentialAdhesionForce ()
virtual double GetAdhesionParameter (Node< DIM > *pNodeA, Node< DIM > *pNodeB, VertexBasedCellPopulation< DIM > &rVertexCellPopulation)
double GetNagaiHondaLabelledCellCellAdhesionEnergyParameter ()
double GetNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter ()
double GetNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter ()
void SetNagaiHondaLabelledCellCellAdhesionEnergyParameter (double labelledCellCellAdhesionEnergyParameter)
void SetNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter (double labelledCellLabelledCellAdhesionEnergyParameter)
void SetNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter (double labelledCellBoundaryAdhesionEnergyParameter)
void OutputForceParameters (out_stream &rParamsFile)

Private Member Functions

template<class Archive >
void serialize (Archive &archive, const unsigned int version)

Private Attributes

double mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter
double mNagaiHondaLabelledCellCellAdhesionEnergyParameter
double mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter

Friends

class boost::serialization::access

Detailed Description

template<unsigned DIM>
class NagaiHondaDifferentialAdhesionForce< DIM >

A force class for use in vertex-based simulations, based on a model model proposed by T. Nagai and H. Honda ("A dynamic cell model for the formation of epithelial tissues", Philosophical Magazine Part B 81:699-719) to include differential adhesion between normal and labelled cells. To include differential adhesion we override the GetAdhesionParameter() method.

Each of the model parameter member variables are rescaled such that mDampingConstantNormal takes the default value 1, whereas Nagai and Honda (who denote the parameter by nu) take the value 0.01.

Definition at line 59 of file NagaiHondaDifferentialAdhesionForce.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>
NagaiHondaDifferentialAdhesionForce< DIM >::NagaiHondaDifferentialAdhesionForce (  )  [inline]

Constructor.

Definition at line 40 of file NagaiHondaDifferentialAdhesionForce.cpp.

template<unsigned DIM>
NagaiHondaDifferentialAdhesionForce< DIM >::~NagaiHondaDifferentialAdhesionForce (  )  [inline, virtual]

Destructor.

Definition at line 49 of file NagaiHondaDifferentialAdhesionForce.cpp.

Member Function Documentation

template<unsigned DIM>
double NagaiHondaDifferentialAdhesionForce< DIM >::GetAdhesionParameter ( Node< DIM > *  pNodeA,
Node< DIM > *  pNodeB,
VertexBasedCellPopulation< DIM > &  rVertexCellPopulation 
) [inline, virtual]

Overridden GetAdhesionParameter() method.

Get the adhesion parameter for the edge between two given nodes. Depends on the type of cells attached to the elements.

Parameters:
pNodeA one node
pNodeB the other node
rVertexCellPopulation reference to the cell population
Returns:
the adhesion parameter for this edge.

Reimplemented from NagaiHondaForce< DIM >.

Definition at line 54 of file NagaiHondaDifferentialAdhesionForce.cpp.

References AbstractCellPopulation< ELEMENT_DIM, ELEMENT_DIM >::GetCellUsingLocationIndex(), NagaiHondaForce< DIM >::GetNagaiHondaCellBoundaryAdhesionEnergyParameter(), NagaiHondaForce< DIM >::GetNagaiHondaCellCellAdhesionEnergyParameter(), NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter(), NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellCellAdhesionEnergyParameter(), NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter(), and Node< SPACE_DIM >::rGetContainingElementIndices().

template<unsigned DIM>
double NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter (  )  [inline]
Returns:
mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter

Definition at line 143 of file NagaiHondaDifferentialAdhesionForce.cpp.

References NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter.

Referenced by NagaiHondaDifferentialAdhesionForce< DIM >::GetAdhesionParameter().

template<unsigned DIM>
double NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellCellAdhesionEnergyParameter (  )  [inline]
Returns:
mNagaiHondaLabelledCellCellAdhesionEnergyParameter

Definition at line 131 of file NagaiHondaDifferentialAdhesionForce.cpp.

References NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellCellAdhesionEnergyParameter.

Referenced by NagaiHondaDifferentialAdhesionForce< DIM >::GetAdhesionParameter().

template<unsigned DIM>
double NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter (  )  [inline]
Returns:
mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter

Definition at line 137 of file NagaiHondaDifferentialAdhesionForce.cpp.

References NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter.

Referenced by NagaiHondaDifferentialAdhesionForce< DIM >::GetAdhesionParameter().

template<unsigned DIM>
void NagaiHondaDifferentialAdhesionForce< DIM >::OutputForceParameters ( out_stream &  rParamsFile  )  [inline, virtual]

Overridden OutputForceParameters() method.

Parameters:
rParamsFile the file stream to which the parameters are output

Reimplemented from NagaiHondaForce< DIM >.

Definition at line 167 of file NagaiHondaDifferentialAdhesionForce.cpp.

References NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter, NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellCellAdhesionEnergyParameter, and NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter.

template<unsigned DIM>
template<class Archive >
void NagaiHondaDifferentialAdhesionForce< 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 NagaiHondaForce< DIM >.

Definition at line 93 of file NagaiHondaDifferentialAdhesionForce.hpp.

References NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter, NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellCellAdhesionEnergyParameter, and NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter.

template<unsigned DIM>
void NagaiHondaDifferentialAdhesionForce< DIM >::SetNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter ( double  labelledCellBoundaryAdhesionEnergyParameter  )  [inline]

Set mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter.

Parameters:
labelledCellBoundaryAdhesionEnergyParameter the new value of mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter

Definition at line 161 of file NagaiHondaDifferentialAdhesionForce.cpp.

References NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter.

template<unsigned DIM>
void NagaiHondaDifferentialAdhesionForce< DIM >::SetNagaiHondaLabelledCellCellAdhesionEnergyParameter ( double  labelledCellCellAdhesionEnergyParameter  )  [inline]

Set mNagaiHondaLabelledCellCellAdhesionEnergyParameter.

Parameters:
labelledCellCellAdhesionEnergyParameter the new value of mNagaiHondaLabelledCellCellAdhesionEnergyParameter

Definition at line 149 of file NagaiHondaDifferentialAdhesionForce.cpp.

References NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellCellAdhesionEnergyParameter.

template<unsigned DIM>
void NagaiHondaDifferentialAdhesionForce< DIM >::SetNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter ( double  labelledCellLabelledCellAdhesionEnergyParameter  )  [inline]

Set mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter.

Parameters:
labelledCellLabelledCellAdhesionEnergyParameter the new value of mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter

Definition at line 155 of file NagaiHondaDifferentialAdhesionForce.cpp.

References NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter.

Friends And Related Function Documentation

template<unsigned DIM>
friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from NagaiHondaForce< DIM >.

Definition at line 84 of file NagaiHondaDifferentialAdhesionForce.hpp.

Member Data Documentation

template<unsigned DIM>
double NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter [private]

Cell-boundary adhesion energy parameter for labelled cells. Has units of kg (cell size at equilibrium rest length)^2 s^-2. Takes the default value 1.0.

Definition at line 82 of file NagaiHondaDifferentialAdhesionForce.hpp.

Referenced by NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter(), NagaiHondaDifferentialAdhesionForce< DIM >::OutputForceParameters(), NagaiHondaDifferentialAdhesionForce< DIM >::serialize(), and NagaiHondaDifferentialAdhesionForce< DIM >::SetNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter().

template<unsigned DIM>
double NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellCellAdhesionEnergyParameter [private]

Cell-cell adhesion energy parameter for labelled and non-labelled cells. Has has units of kg (cell size at equilibrium rest length)^2 s^-2. Takes the default value 1.0.

Definition at line 75 of file NagaiHondaDifferentialAdhesionForce.hpp.

Referenced by NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellCellAdhesionEnergyParameter(), NagaiHondaDifferentialAdhesionForce< DIM >::OutputForceParameters(), NagaiHondaDifferentialAdhesionForce< DIM >::serialize(), and NagaiHondaDifferentialAdhesionForce< DIM >::SetNagaiHondaLabelledCellCellAdhesionEnergyParameter().

template<unsigned DIM>
double NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter [private]

Cell-cell adhesion energy parameter for two labelled cells. Has units of kg (cell size at equilibrium rest length)^2 s^-2. Takes the default value 1.0.

Definition at line 68 of file NagaiHondaDifferentialAdhesionForce.hpp.

Referenced by NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter(), NagaiHondaDifferentialAdhesionForce< DIM >::OutputForceParameters(), NagaiHondaDifferentialAdhesionForce< DIM >::serialize(), and NagaiHondaDifferentialAdhesionForce< DIM >::SetNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter().

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2