BuskeElasticForce< DIM > Class Template Reference

#include <BuskeElasticForce.hpp>

Inheritance diagram for BuskeElasticForce< DIM >:

Collaboration diagram for BuskeElasticForce< DIM >:

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)
Public Member Functions inherited from AbstractTwoBodyInteractionForce< DIM >
	AbstractTwoBodyInteractionForce ()
bool	GetUseCutOffLength ()
void	SetCutOffLength (double cutOffLength)
double	GetCutOffLength ()
virtual c_vector< double, SPACE_DIM >	CalculateForceBetweenNodes (unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)=0
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	mDeformationEnergyParameter

Friends
class	TestForcesNotForRelease
class	boost::serialization::access

Additional Inherited Members
Protected Attributes inherited from AbstractTwoBodyInteractionForce< DIM >
bool	mUseCutOffLength
double	mMechanicsCutOffLength

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 52 of file BuskeElasticForce.hpp.

Constructor & Destructor Documentation

BuskeElasticForce()

template<unsigned DIM>

BuskeElasticForce< DIM >::BuskeElasticForce

(

)

Constructor.

Definition at line 39 of file BuskeElasticForce.cpp.

Member Function Documentation

CalculateForceBetweenNodes()

template<unsigned DIM>

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

Returns

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

Definition at line 58 of file BuskeElasticForce.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode(), Node< SPACE_DIM >::GetRadius(), and Node< SPACE_DIM >::rGetLocation().

GetDeformationEnergyParameter()

template<unsigned DIM>

double BuskeElasticForce< DIM >::GetDeformationEnergyParameter

(

)

Returns

mDeformationEnergyParameter.

Definition at line 46 of file BuskeElasticForce.cpp.

GetMagnitudeOfForce()

template<unsigned DIM>

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

Returns

calculated 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 108 of file BuskeElasticForce.cpp.

OutputForceParameters()

template<unsigned DIM>

void BuskeElasticForce< DIM >::OutputForceParameters ( out_stream &  rParamsFile )

virtual

Overridden OutputForceParameters() method.

Parameters

rParamsFile

the file stream to which the parameters are output

Reimplemented from AbstractTwoBodyInteractionForce< DIM >.

Definition at line 128 of file BuskeElasticForce.cpp.

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

serialize()

template<unsigned DIM>

template<class Archive >

void BuskeElasticForce< 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 66 of file BuskeElasticForce.hpp.

References BuskeElasticForce< DIM >::mDeformationEnergyParameter.

SetDeformationEnergyParameter()

template<unsigned DIM>

void BuskeElasticForce< DIM >::SetDeformationEnergyParameter

(

double

deformationEnergyParameter

)

Set mDeformationEnergyParameter.

Parameters

deformationEnergyParameter

the new value of mDeformationEnergyParameter

Definition at line 52 of file BuskeElasticForce.cpp.

Friends And Related Symbol Documentation

boost::serialization::access

template<unsigned DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 58 of file BuskeElasticForce.hpp.

TestForcesNotForRelease

template<unsigned DIM>

friend class TestForcesNotForRelease

friend

Definition at line 54 of file BuskeElasticForce.hpp.

Member Data Documentation

mDeformationEnergyParameter

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 83 of file BuskeElasticForce.hpp.

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

---

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

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