Chaste Release::3.1
Public Member Functions | Private Member Functions | Private Attributes | Friends
BuskeAdhesiveForce< DIM > Class Template Reference

#include <BuskeAdhesiveForce.hpp>

Inheritance diagram for BuskeAdhesiveForce< DIM >:
Collaboration diagram for BuskeAdhesiveForce< DIM >:

List of all members.

Public Member Functions

 BuskeAdhesiveForce ()
double GetAdhesionEnergyParameter ()
void SetAdhesionEnergyParameter (double adhesionEnergyParameter)
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 mAdhesionEnergyParameter

Friends

class TestForcesNotForRelease
class boost::serialization::access

Detailed Description

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

Constructor & Destructor Documentation

template<unsigned DIM>
BuskeAdhesiveForce< DIM >::BuskeAdhesiveForce ( )

Constructor.

Definition at line 39 of file BuskeAdhesiveForce.cpp.

Member Function Documentation

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

Calculate the force between two nodes.

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

Parameters:
nodeAGlobalIndexindex of one neighbouring node
nodeBGlobalIndexindex of the other neighbouring node
rCellPopulationthe cell population

Definition at line 58 of file BuskeAdhesiveForce.cpp.

References NodesOnlyMesh< SPACE_DIM >::GetCellRadius(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode().

template<unsigned DIM>
double BuskeAdhesiveForce< DIM >::GetAdhesionEnergyParameter ( )

Get mAdhesionEnergyParameter.

Definition at line 46 of file BuskeAdhesiveForce.cpp.

template<unsigned DIM>
double BuskeAdhesiveForce< DIM >::GetMagnitudeOfForce ( double  distanceBetweenNodes,
double  radiusOfCellOne,
double  radiusOfCellTwo 
)

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

Parameters:
distanceBetweenNodesthe distance between two nodes
radiusOfCellOneradius of a cell
radiusOfCellTworadius of a cell

Definition at line 106 of file BuskeAdhesiveForce.cpp.

template<unsigned DIM>
void BuskeAdhesiveForce< DIM >::OutputForceParameters ( out_stream &  rParamsFile) [virtual]

Overridden OutputForceParameters() method.

Parameters:
rParamsFilethe file stream to which the parameters are output

Reimplemented from AbstractTwoBodyInteractionForce< DIM >.

Definition at line 123 of file BuskeAdhesiveForce.cpp.

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

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

Archive the object and its member variables.

Parameters:
archivethe archive
versionthe current version of this class

Reimplemented from AbstractTwoBodyInteractionForce< DIM >.

Definition at line 66 of file BuskeAdhesiveForce.hpp.

References BuskeAdhesiveForce< DIM >::mAdhesionEnergyParameter.

template<unsigned DIM>
void BuskeAdhesiveForce< DIM >::SetAdhesionEnergyParameter ( double  adhesionEnergyParameter)

Set mAdhesionEnergyParameter.

Parameters:
adhesionEnergyParameterthe new value of mAdhesionEnergyParameter

Definition at line 52 of file BuskeAdhesiveForce.cpp.

Friends And Related Function Documentation

template<unsigned DIM>
friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractTwoBodyInteractionForce< DIM >.

Definition at line 58 of file BuskeAdhesiveForce.hpp.

Member Data Documentation

template<unsigned DIM>
double BuskeAdhesiveForce< DIM >::mAdhesionEnergyParameter [private]

Adhesion energy parameter.

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

Definition at line 79 of file BuskeAdhesiveForce.hpp.

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

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