Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
|
#include <GeneralisedLinearSpringForce.hpp>
Protected Attributes | |
double | mMeinekeSpringStiffness |
double | mMeinekeDivisionRestingSpringLength |
double | mMeinekeSpringGrowthDuration |
Protected Attributes inherited from AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM > | |
bool | mUseCutOffLength |
double | mMechanicsCutOffLength |
Private Member Functions | |
template<class Archive > | |
void | serialize (Archive &archive, const unsigned int version) |
Friends | |
class | TestForces |
class | boost::serialization::access |
A force law employed by Meineke et al (2001) in their off-lattice model of the intestinal crypt (doi:10.1046/j.0960-7722.2001.00216.x).
Each pair of neighbouring nodes are assumed to be connected by a linear spring. The force of node is given by
Here is the spring constant for the spring between nodes and , is its natural length at time , is their relative displacement and a hat ( ) denotes a unit vector.
Length is scaled by natural length. Time is in hours.
Definition at line 65 of file GeneralisedLinearSpringForce.hpp.
GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::GeneralisedLinearSpringForce | ( | ) |
Constructor.
Definition at line 39 of file GeneralisedLinearSpringForce.cpp.
References GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::mMeinekeSpringStiffness.
|
virtual |
Destructor.
Definition at line 61 of file GeneralisedLinearSpringForce.cpp.
|
virtual |
Overridden CalculateForceBetweenNodes() method.
Calculates the force between two nodes.
Note that this assumes they are connected and is called by AddForceContribution()
nodeAGlobalIndex | index of one neighbouring node |
nodeBGlobalIndex | index of the other neighbouring node |
rCellPopulation | the cell population |
Implements AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >.
Definition at line 66 of file GeneralisedLinearSpringForce.cpp.
References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode(), Node< SPACE_DIM >::GetRadius(), Node< SPACE_DIM >::rGetLocation(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetMesh().
double GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::GetMeinekeDivisionRestingSpringLength | ( | ) |
Definition at line 237 of file GeneralisedLinearSpringForce.cpp.
double GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::GetMeinekeSpringGrowthDuration | ( | ) |
Definition at line 243 of file GeneralisedLinearSpringForce.cpp.
double GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::GetMeinekeSpringStiffness | ( | ) |
Definition at line 231 of file GeneralisedLinearSpringForce.cpp.
|
virtual |
Overridden OutputForceParameters() method.
rParamsFile | the file stream to which the parameters are output |
Reimplemented from AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >.
Reimplemented in DifferentialAdhesionGeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >, RepulsionForce< DIM >, CryptProjectionForce, and LinearSpringWithVariableSpringConstantsForce< DIM >.
Definition at line 273 of file GeneralisedLinearSpringForce.cpp.
References AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters().
Referenced by DifferentialAdhesionGeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters(), RepulsionForce< DIM >::OutputForceParameters(), CryptProjectionForce::OutputForceParameters(), and LinearSpringWithVariableSpringConstantsForce< DIM >::OutputForceParameters().
|
inlineprivate |
Archive the object and its member variables.
archive | the archive |
version | the current version of this class |
Definition at line 80 of file GeneralisedLinearSpringForce.hpp.
References GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::mMeinekeDivisionRestingSpringLength, GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::mMeinekeSpringGrowthDuration, and GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::mMeinekeSpringStiffness.
void GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::SetMeinekeDivisionRestingSpringLength | ( | double | divisionRestingSpringLength | ) |
Set mMeinekeDivisionRestingSpringLength.
divisionRestingSpringLength | the new value of mMeinekeDivisionRestingSpringLength |
Definition at line 256 of file GeneralisedLinearSpringForce.cpp.
void GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::SetMeinekeSpringGrowthDuration | ( | double | springGrowthDuration | ) |
Set mMeinekeSpringGrowthDuration.
springGrowthDuration | the new value of mMeinekeSpringGrowthDuration |
Definition at line 265 of file GeneralisedLinearSpringForce.cpp.
void GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::SetMeinekeSpringStiffness | ( | double | springStiffness | ) |
Set mMeinekeSpringStiffness.
springStiffness | the new value of mMeinekeSpringStiffness |
Definition at line 249 of file GeneralisedLinearSpringForce.cpp.
|
virtual |
Return a multiplication factor for the spring constant, which returns a default value of 1.
This method may be overridden in subclasses.
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 |
Reimplemented in DifferentialAdhesionGeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >.
Definition at line 52 of file GeneralisedLinearSpringForce.cpp.
Referenced by LinearSpringWithVariableSpringConstantsForce< DIM >::VariableSpringConstantMultiplicationFactor().
|
friend |
Needed for serialization.
Definition at line 72 of file GeneralisedLinearSpringForce.hpp.
Definition at line 67 of file GeneralisedLinearSpringForce.hpp.
|
protected |
Initial resting spring length after cell division. Has units of cell size at equilibrium rest length
The value of this parameter should be larger than mDivisionSeparation, because of pressure from neighbouring springs.
Definition at line 106 of file GeneralisedLinearSpringForce.hpp.
Referenced by GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::serialize().
|
protected |
The time it takes for the springs rest length to increase from mMeinekeDivisionRestingSpringLength to its natural length.
The value of this parameter is usually the same as the M Phase of the cell cycle and defaults to 1.
Definition at line 114 of file GeneralisedLinearSpringForce.hpp.
Referenced by GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::serialize().
|
protected |
Spring stiffness.
Represented by the parameter mu in the model by Meineke et al (2001) in their off-lattice model of the intestinal crypt (doi:10.1046/j.0960-7722.2001.00216.x).
Definition at line 97 of file GeneralisedLinearSpringForce.hpp.
Referenced by GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::GeneralisedLinearSpringForce(), and GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::serialize().