BuskeCompressionForce< DIM > Class Template Reference

#include <BuskeCompressionForce.hpp>

Inherits AbstractForce< DIM >.

Collaboration diagram for BuskeCompressionForce< DIM >:

[legend]

List of all members.

Public Member Functions
	BuskeCompressionForce ()
double	GetCompressionEnergyParameter ()
void	SetCompressionEnergyParameter (double compressionEnergyParameter)
void	AddForceContribution (std::vector< c_vector< double, DIM > > &rForces, AbstractCellPopulation< DIM > &rCellPopulation)
void	OutputForceParameters (out_stream &rParamsFile)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
double	mCompressionEnergyParameter
Friends
class	TestForcesNotForRelease
class	boost::serialization::access

---

Detailed Description

template<unsigned DIM>
class BuskeCompressionForce< 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.

This class specifically calculates the compression force which forms part of equation (A6) in the Buske paper.

Definition at line 48 of file BuskeCompressionForce.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

BuskeCompressionForce< DIM >::BuskeCompressionForce

(

)

[inline]

Constructor.

Definition at line 33 of file BuskeCompressionForce.cpp.

---

Member Function Documentation

template<unsigned DIM>

void BuskeCompressionForce< DIM >::AddForceContribution	(	std::vector< c_vector< double, DIM > > &	rForces,
		AbstractCellPopulation< DIM > &	rCellPopulation
	)			[inline, virtual]

Overridden AddForceContribution() method.

Parameters:

	rForces	a vector of forces on notes
	rCellPopulation	a cell population object

Target volume of the cell

Todo:

Doesn't say in the Buske paper how they calculate this, so we need to look at this to be sure it's what we want (#1764)

Implements AbstractForce< DIM >.

Definition at line 52 of file BuskeCompressionForce.cpp.

References AbstractCellPopulation< DIM >::Begin(), AbstractCellPopulation< DIM >::End(), AbstractCellPopulation< DIM >::GetLocationIndexUsingCell(), NodeBasedCellPopulation< DIM >::GetNeighbouringNodeIndices(), AbstractCellPopulation< DIM >::GetNode(), and BuskeCompressionForce< DIM >::mCompressionEnergyParameter.

template<unsigned DIM>

double BuskeCompressionForce< DIM >::GetCompressionEnergyParameter

(

)

[inline]

Get mCompressionEnergyParameter.

Definition at line 40 of file BuskeCompressionForce.cpp.

References BuskeCompressionForce< DIM >::mCompressionEnergyParameter.

template<unsigned DIM>

void BuskeCompressionForce< DIM >::OutputForceParameters

(

out_stream &

rParamsFile

)

[inline, virtual]

Overridden OutputForceParameters() method.

Parameters:

rParamsFile

the file stream to which the parameters are output

Implements AbstractForce< DIM >.

Definition at line 132 of file BuskeCompressionForce.cpp.

References BuskeCompressionForce< DIM >::mCompressionEnergyParameter.

template<unsigned DIM>

template<class Archive >

void BuskeCompressionForce< 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 AbstractForce< DIM >.

Definition at line 55 of file BuskeCompressionForce.hpp.

References BuskeCompressionForce< DIM >::mCompressionEnergyParameter.

template<unsigned DIM>

void BuskeCompressionForce< DIM >::SetCompressionEnergyParameter

(

double

compressionEnergyParameter

)

[inline]

Set mCompressionEnergyParameter.

Parameters:

compressionEnergyParameter

the new value of mCompressionEnergyParameter

Definition at line 46 of file BuskeCompressionForce.cpp.

References BuskeCompressionForce< DIM >::mCompressionEnergyParameter.

---

Friends And Related Function Documentation

template<unsigned DIM>

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

Needed for serialization.

Reimplemented from AbstractForce< DIM >.

Definition at line 53 of file BuskeCompressionForce.hpp.

---

Member Data Documentation

template<unsigned DIM>

double BuskeCompressionForce< DIM >::mCompressionEnergyParameter [private]

Compression energy parameter.

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

Note: K is the bulk modulus of the spheres.

Definition at line 70 of file BuskeCompressionForce.hpp.

Referenced by BuskeCompressionForce< DIM >::AddForceContribution(), BuskeCompressionForce< DIM >::GetCompressionEnergyParameter(), BuskeCompressionForce< DIM >::OutputForceParameters(), BuskeCompressionForce< DIM >::serialize(), and BuskeCompressionForce< DIM >::SetCompressionEnergyParameter().

---

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

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