#include <NagaiHondaDifferentialAdhesionForce.hpp>
Inheritance diagram for NagaiHondaDifferentialAdhesionForce< DIM >:
Collaboration diagram for NagaiHondaDifferentialAdhesionForce< DIM >:
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 differntial 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
| NagaiHondaDifferentialAdhesionForce< DIM >::NagaiHondaDifferentialAdhesionForce | ( | ) |
Constructor.
Definition at line 40 of file NagaiHondaDifferentialAdhesionForce.cpp.
| NagaiHondaDifferentialAdhesionForce< DIM >::~NagaiHondaDifferentialAdhesionForce | ( | ) |
Destructor.
Definition at line 49 of file NagaiHondaDifferentialAdhesionForce.cpp.
Member Function Documentation
| double NagaiHondaDifferentialAdhesionForce< DIM >::GetAdhesionParameter | ( | Node< DIM > * | pNodeA, |
| Node< DIM > * | pNodeB, | ||
| VertexBasedCellPopulation< DIM > & | rVertexCellPopulation | ||
| ) | [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(), and Node< SPACE_DIM >::rGetContainingElementIndices().
| double NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter | ( | ) |
- Returns:
- mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter
Definition at line 143 of file NagaiHondaDifferentialAdhesionForce.cpp.
| double NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellCellAdhesionEnergyParameter | ( | ) |
- Returns:
- mNagaiHondaLabelledCellCellAdhesionEnergyParameter
Definition at line 131 of file NagaiHondaDifferentialAdhesionForce.cpp.
| double NagaiHondaDifferentialAdhesionForce< DIM >::GetNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter | ( | ) |
- Returns:
- mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter
Definition at line 137 of file NagaiHondaDifferentialAdhesionForce.cpp.
| void NagaiHondaDifferentialAdhesionForce< DIM >::OutputForceParameters | ( | out_stream & | rParamsFile | ) | [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 NagaiHondaForce< DIM >::OutputForceParameters().
| void NagaiHondaDifferentialAdhesionForce< 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 NagaiHondaForce< DIM >.
Definition at line 86 of file NagaiHondaDifferentialAdhesionForce.hpp.
References NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter, NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellCellAdhesionEnergyParameter, and NagaiHondaDifferentialAdhesionForce< DIM >::mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter.
| void NagaiHondaDifferentialAdhesionForce< DIM >::SetNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter | ( | double | labelledCellBoundaryAdhesionEnergyParameter | ) |
Set mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter.
- Parameters:
-
labelledCellBoundaryAdhesionEnergyParameter the new value of mNagaiHondaLabelledCellBoundaryAdhesionEnergyParameter
Definition at line 161 of file NagaiHondaDifferentialAdhesionForce.cpp.
| void NagaiHondaDifferentialAdhesionForce< DIM >::SetNagaiHondaLabelledCellCellAdhesionEnergyParameter | ( | double | labelledCellCellAdhesionEnergyParameter | ) |
Set mNagaiHondaLabelledCellCellAdhesionEnergyParameter.
- Parameters:
-
labelledCellCellAdhesionEnergyParameter the new value of mNagaiHondaLabelledCellCellAdhesionEnergyParameter
Definition at line 149 of file NagaiHondaDifferentialAdhesionForce.cpp.
| void NagaiHondaDifferentialAdhesionForce< DIM >::SetNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter | ( | double | labelledCellLabelledCellAdhesionEnergyParameter | ) |
Set mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter.
- Parameters:
-
labelledCellLabelledCellAdhesionEnergyParameter the new value of mNagaiHondaLabelledCellLabelledCellAdhesionEnergyParameter
Definition at line 155 of file NagaiHondaDifferentialAdhesionForce.cpp.
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from NagaiHondaForce< DIM >.
Definition at line 84 of file NagaiHondaDifferentialAdhesionForce.hpp.
Member Data Documentation
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 >::serialize().
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 >::serialize().
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 >::serialize().
The documentation for this class was generated from the following files:
- cell_based/src/population/mechanics/NagaiHondaDifferentialAdhesionForce.hpp
- cell_based/src/population/mechanics/NagaiHondaDifferentialAdhesionForce.cpp
