DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <DifferentialAdhesionLinearSpringForce.hpp>

Inheritance diagram for DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >:

Collaboration diagram for DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions
	DifferentialAdhesionLinearSpringForce ()
double	VariableSpringConstantMultiplicationFactor (unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation, bool isCloserThanRestLength)
double	GetHomotypicLabelledSpringConstantMultiplier ()
void	SetHomotypicLabelledSpringConstantMultiplier (double labelledSpringConstantMultiplier)
double	GetHeterotypicSpringConstantMultiplier ()
void	SetHeterotypicSpringConstantMultiplier (double heterotypicSpringConstantMultiplier)
void	OutputForceParameters (out_stream &rParamsFile)
Public Member Functions inherited from LinearSpringForce< ELEMENT_DIM, SPACE_DIM >
	LinearSpringForce ()
virtual	~LinearSpringForce ()
Public Member Functions inherited from AbstractVariableSizeTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >
	AbstractVariableSizeTwoBodyInteractionForce ()
virtual	~AbstractVariableSizeTwoBodyInteractionForce ()
c_vector< double, SPACE_DIM >	CalculateForceBetweenNodes (unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
double	GetSpringStiffness ()
double	GetDivisionRestingSpringLength ()
double	GetSpringGrowthDuration ()
void	SetSpringStiffness (double springStiffness)
void	SetDivisionRestingSpringLength (double divisionRestingSpringLength)
void	SetSpringGrowthDuration (double springGrowthDuration)
Public Member Functions inherited from AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >
	AbstractTwoBodyInteractionForce ()
bool	GetUseCutOffLength ()
void	SetCutOffLength (double cutOffLength)
double	GetCutOffLength ()
void	AddForceContribution (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
virtual void	WriteDataToVisualizerSetupFile (out_stream &pVizSetupFile)
Public Member Functions inherited from AbstractForce< ELEMENT_DIM, SPACE_DIM >
	AbstractForce ()
virtual	~AbstractForce ()
void	OutputForceInfo (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	mHomotypicLabelledSpringConstantMultiplier
double	mHeterotypicSpringConstantMultiplier

Friends
class	boost::serialization::access

Additional Inherited Members
Protected Member Functions inherited from LinearSpringForce< ELEMENT_DIM, SPACE_DIM >
c_vector< double, SPACE_DIM >	CalculateLinkInteraction (double overlap, double restLength, const c_vector< double, SPACE_DIM > &rUnitDifference, double multiplicationFactor)
Protected Attributes inherited from AbstractVariableSizeTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >
double	mSpringStiffness
double	mDivisionRestingSpringLength
double	mSpringGrowthDuration
Protected Attributes inherited from AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >
bool	mUseCutOffLength
double	mMechanicsCutOffLength

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
class DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >

A class for a two-body differential adhesion force law between labelled and unlabelled cells (as defined by the CellLabel cell property). Inherits from LinearSpringForce.

Designed for use in node and mesh-based simulations.

Todo:

#2266 - throw exceptions if using other cell population objects?

#2266 - override CalculateForceBetweenNodes() to use a default rest length of 1.0 for all springs?

Definition at line 55 of file DifferentialAdhesionLinearSpringForce.hpp.

Constructor & Destructor Documentation

DifferentialAdhesionLinearSpringForce()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::DifferentialAdhesionLinearSpringForce

(

)

Constructor.

Definition at line 40 of file DifferentialAdhesionLinearSpringForce.cpp.

Member Function Documentation

GetHeterotypicSpringConstantMultiplier()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

double DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::GetHeterotypicSpringConstantMultiplier

(

)

Returns

mHeterotypicSpringConstantMultiplier.

Definition at line 102 of file DifferentialAdhesionLinearSpringForce.cpp.

GetHomotypicLabelledSpringConstantMultiplier()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

double DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::GetHomotypicLabelledSpringConstantMultiplier

(

)

Returns

mHomotypicLabelledSpringConstantMultiplier.

Definition at line 89 of file DifferentialAdhesionLinearSpringForce.cpp.

OutputForceParameters()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters ( out_stream &  rParamsFile )

virtual

Overridden OutputForceParameters() method.

Parameters

rParamsFile

the file stream to which the parameters are output

Reimplemented from LinearSpringForce< ELEMENT_DIM, SPACE_DIM >.

Definition at line 115 of file DifferentialAdhesionLinearSpringForce.cpp.

References LinearSpringForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters().

serialize()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

template<class Archive >

void DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Archive the object and its member variables.

Parameters

archive	the archive
version	the current version of this class

Definition at line 91 of file DifferentialAdhesionLinearSpringForce.hpp.

References DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::mHeterotypicSpringConstantMultiplier, and DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::mHomotypicLabelledSpringConstantMultiplier.

SetHeterotypicSpringConstantMultiplier()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::SetHeterotypicSpringConstantMultiplier

(

double

heterotypicSpringConstantMultiplier

)

Set mHeterotypicSpringConstantMultiplier.

Parameters

heterotypicSpringConstantMultiplier

the new value of mHeterotypicSpringConstantMultiplier

Definition at line 108 of file DifferentialAdhesionLinearSpringForce.cpp.

SetHomotypicLabelledSpringConstantMultiplier()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::SetHomotypicLabelledSpringConstantMultiplier

(

double

labelledSpringConstantMultiplier

)

Set mHomotypicLabelledSpringConstantMultiplier.

Parameters

labelledSpringConstantMultiplier

the new value of mHomotypicLabelledSpringConstantMultiplier

Definition at line 95 of file DifferentialAdhesionLinearSpringForce.cpp.

VariableSpringConstantMultiplicationFactor()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

double DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::VariableSpringConstantMultiplicationFactor ( unsigned  nodeAGlobalIndex, unsigned  nodeBGlobalIndex, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &  rCellPopulation, bool  isCloserThanRestLength  )

virtual

Overridden VariableSpringConstantMultiplicationFactor() method.

This method takes account of the distinct spring constants present for homotypic (labelled-labelled and unlabelled-unlabelled) and heterotypic (labelled-unlabelled) interactions between neighbouring cells.

Parameters

nodeAGlobalIndex	index of one neighbouring node
nodeBGlobalIndex	index of the other neighbouring node
rCellPopulation	the cell population
isCloserThanRestLength	whether the neighbouring nodes lie closer than the rest length of their connecting spring

Returns

the multiplication factor.

Reimplemented from AbstractVariableSizeTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >.

Definition at line 48 of file DifferentialAdhesionLinearSpringForce.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellUsingLocationIndex().

Friends And Related Symbol Documentation

boost::serialization::access

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 83 of file DifferentialAdhesionLinearSpringForce.hpp.

Member Data Documentation

mHeterotypicSpringConstantMultiplier

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

double DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::mHeterotypicSpringConstantMultiplier

private

A scalar determining the relative spring constant for heterotypic (labelled-unlabelled) interactions between neighbouring cells, used in the overridden method VariableSpringConstantMultiplicationFactor().

Defaults to 1.0 in the constructor.

Definition at line 80 of file DifferentialAdhesionLinearSpringForce.hpp.

Referenced by DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::serialize().

mHomotypicLabelledSpringConstantMultiplier

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

double DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::mHomotypicLabelledSpringConstantMultiplier

private

A scalar determining the relative spring constant for homotypic interactions between neighbouring labelled cells, used in the overridden method VariableSpringConstantMultiplicationFactor().

Defaults to 1.0 in the constructor.

Note that for homotypic interactions between neighbouring unlabelled cells, we use the multiplier value 1.0 that is returned by the method VariableSpringConstantMultiplicationFactor() in the parent class LinearSpringForce.

Definition at line 71 of file DifferentialAdhesionLinearSpringForce.hpp.

Referenced by DifferentialAdhesionLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::serialize().

---

The documentation for this class was generated from the following files:

• cell_based/src/population/forces/DifferentialAdhesionLinearSpringForce.hpp
• cell_based/src/population/forces/DifferentialAdhesionLinearSpringForce.cpp