BuskeElasticForce< DIM > Class Template Reference

#include <BuskeElasticForce.hpp>

Inherits AbstractTwoBodyInteractionForce< DIM >.

Collaboration diagram for BuskeElasticForce< DIM >:

[legend]

List of all members.

Public Member Functions
	BuskeElasticForce ()
double	GetDeformationEnergyParameter ()
void	SetDeformationEnergyParameter (double deformationEnergyParameter)
c_vector< double, DIM >	CalculateForceBetweenNodes (unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< DIM > &rCellPopulation)
double	GetMagnitudeOfForce (double distanceBetweenNodes, double radiusOfCellOne, double radiusOfCellTwo)
virtual void	OutputForceParameters (out_stream &rParamsFile)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
double	mDeformationEnergyParameter
Friends
class	TestForcesNotForRelease
class	boost::serialization::access

---

Detailed Description

template<unsigned DIM>
class BuskeElasticForce< DIM >

A force law employed by Buske et al (2011) in their overlapping spheres model of the intestinal crypt (doi:10.1371/journal.pcbi.1001045).

Length is scaled by natural length.

Todo:

does this mean natural radius of a cell? If so at what age? (#1764) Time is in hours.

Definition at line 45 of file BuskeElasticForce.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

BuskeElasticForce< DIM >::BuskeElasticForce

(

)

[inline]

Constructor.

Definition at line 32 of file BuskeElasticForce.cpp.

---

Member Function Documentation

template<unsigned DIM>

c_vector< double, DIM > BuskeElasticForce< DIM >::CalculateForceBetweenNodes	(	unsigned	nodeAGlobalIndex,
		unsigned	nodeBGlobalIndex,
		AbstractCellPopulation< DIM > &	rCellPopulation
	)			[inline, virtual]

Calculate the force between two nodes.

Note that this assumes they are connected and is called by rCalculateVelocitiesOfEachNode()

Parameters:

	nodeAGlobalIndex	index of one neighbouring node
	nodeBGlobalIndex	index of the other neighbouring node
	rCellPopulation	the cell population

Implements AbstractTwoBodyInteractionForce< DIM >.

Definition at line 51 of file BuskeElasticForce.cpp.

References NodesOnlyMesh< SPACE_DIM >::GetCellRadius(), AbstractTwoBodyInteractionForce< DIM >::GetCutOffLength(), BuskeElasticForce< DIM >::GetMagnitudeOfForce(), AbstractCellPopulation< DIM >::GetNode(), and AbstractTwoBodyInteractionForce< DIM >::mUseCutOffLength.

template<unsigned DIM>

double BuskeElasticForce< DIM >::GetDeformationEnergyParameter

(

)

[inline]

Get mDeformationEnergyParameter.

Definition at line 39 of file BuskeElasticForce.cpp.

References BuskeElasticForce< DIM >::mDeformationEnergyParameter.

template<unsigned DIM>

double BuskeElasticForce< DIM >::GetMagnitudeOfForce	(	double	distanceBetweenNodes,
		double	radiusOfCellOne,
		double	radiusOfCellTwo
	)			[inline]

Calculate the magnitude of the force between two nodes that are a given distance apart and are associated with given cell radii.

Parameters:

	distanceBetweenNodes	the distance between two nodes
	radiusOfCellOne	radius of a cell
	radiusOfCellTwo	radius of a cell

Definition at line 99 of file BuskeElasticForce.cpp.

References BuskeElasticForce< DIM >::mDeformationEnergyParameter.

Referenced by BuskeElasticForce< DIM >::CalculateForceBetweenNodes().

template<unsigned DIM>

void BuskeElasticForce< DIM >::OutputForceParameters

(

out_stream &

rParamsFile

)

[inline, virtual]

Overridden OutputForceParameters() method.

Parameters:

rParamsFile

the file stream to which the parameters are output

Reimplemented from AbstractTwoBodyInteractionForce< DIM >.

Definition at line 119 of file BuskeElasticForce.cpp.

References BuskeElasticForce< DIM >::mDeformationEnergyParameter.

template<unsigned DIM>

template<class Archive >

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

Archive the object and its member variables.

Parameters:

	archive	the archive
	version	the current version of this class

Reimplemented from AbstractTwoBodyInteractionForce< DIM >.

Definition at line 59 of file BuskeElasticForce.hpp.

References BuskeElasticForce< DIM >::mDeformationEnergyParameter.

template<unsigned DIM>

void BuskeElasticForce< DIM >::SetDeformationEnergyParameter

(

double

deformationEnergyParameter

)

[inline]

Set mDeformationEnergyParameter.

Parameters:

deformationEnergyParameter

the new value of mDeformationEnergyParameter

Definition at line 45 of file BuskeElasticForce.cpp.

References BuskeElasticForce< DIM >::mDeformationEnergyParameter.

---

Friends And Related Function Documentation

template<unsigned DIM>

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractTwoBodyInteractionForce< DIM >.

Definition at line 51 of file BuskeElasticForce.hpp.

---

Member Data Documentation

template<unsigned DIM>

double BuskeElasticForce< DIM >::mDeformationEnergyParameter [private]

Deformation energy parameter.

Represented by the parameter D in the model by Buske et al (2011) in their off-lattice model of the intestinal crypt (doi:10.1371/journal.pcbi.1001045).

Note: D=3/2(1-nu^2)/E

Where E is the Young Modulus and nu is the Poisson ratio of cells

Definition at line 76 of file BuskeElasticForce.hpp.

Referenced by BuskeElasticForce< DIM >::GetDeformationEnergyParameter(), BuskeElasticForce< DIM >::GetMagnitudeOfForce(), BuskeElasticForce< DIM >::OutputForceParameters(), BuskeElasticForce< DIM >::serialize(), and BuskeElasticForce< DIM >::SetDeformationEnergyParameter().

---

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

• cell_based/src/population/mechanics/BuskeElasticForce.hpp
• cell_based/src/population/mechanics/BuskeElasticForce.cpp