#include <LinearSpringWithVariableSpringConstantsForce.hpp>

Inheritance diagram for LinearSpringWithVariableSpringConstantsForce< DIM >:

Collaboration diagram for LinearSpringWithVariableSpringConstantsForce< DIM >:

Public Member Functions
	LinearSpringWithVariableSpringConstantsForce ()

virtual	~LinearSpringWithVariableSpringConstantsForce ()

void	SetEdgeBasedSpringConstant (bool useEdgeBasedSpringConstant)

void	SetMutantSprings (bool useMutantSprings, double mutantMutantMultiplier=2, double normalMutantMultiplier=1.5)

void	SetBetaCateninSprings (bool useBCatSprings)

void	SetApoptoticSprings (bool useApoptoticSprings)

double	VariableSpringConstantMultiplicationFactor (unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< DIM > &rCellPopulation, bool isCloserThanRestLength)

void	AddForceContribution (AbstractCellPopulation< DIM > &rCellPopulation)

double	GetBetaCatSpringScaler ()

void	SetBetaCatSpringScaler (double betaCatSpringScaler)

double	GetApoptoticSpringTensionStiffness ()

void	SetApoptoticSpringTensionStiffness (double apoptoticSpringTensionStiffness)

double	GetApoptoticSpringCompressionStiffness ()

void	SetApoptoticSpringCompressionStiffness (double apoptoticSpringCompressionStiffness)

virtual void	OutputForceParameters (out_stream &rParamsFile)

Public Member Functions inherited from GeneralisedLinearSpringForce< DIM >
	GeneralisedLinearSpringForce ()

virtual	~GeneralisedLinearSpringForce ()

virtual double	VariableSpringConstantMultiplicationFactor (unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< ELEMENT_DIM, ELEMENT_DIM > &rCellPopulation, bool isCloserThanRestLength)

c_vector< double, ELEMENT_DIM >	CalculateForceBetweenNodes (unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< ELEMENT_DIM, ELEMENT_DIM > &rCellPopulation)

double	GetMeinekeSpringStiffness ()

double	GetMeinekeDivisionRestingSpringLength ()

double	GetMeinekeSpringGrowthDuration ()

void	SetMeinekeSpringStiffness (double springStiffness)

void	SetMeinekeDivisionRestingSpringLength (double divisionRestingSpringLength)

void	SetMeinekeSpringGrowthDuration (double springGrowthDuration)

Public Member Functions inherited from AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >
	AbstractTwoBodyInteractionForce ()

bool	GetUseCutOffLength ()

void	SetCutOffLength (double cutOffLength)

double	GetCutOffLength ()

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

Protected Attributes
bool	mUseEdgeBasedSpringConstant

bool	mUseMutantSprings

double	mMutantMutantMultiplier

double	mNormalMutantMultiplier

bool	mUseBCatSprings

bool	mUseApoptoticSprings

double	mBetaCatSpringScaler

double	mApoptoticSpringTensionStiffness

double	mApoptoticSpringCompressionStiffness

Protected Attributes inherited from GeneralisedLinearSpringForce< DIM >
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	TestLinearSpringWithVariableSpringConstantsForce

class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class LinearSpringWithVariableSpringConstantsForce< DIM >

A subclass of GeneralisedLinearSpringForce with variable spring constants.

Definition at line 48 of file LinearSpringWithVariableSpringConstantsForce.hpp.

Constructor & Destructor Documentation

◆ LinearSpringWithVariableSpringConstantsForce()

template<unsigned DIM>

LinearSpringWithVariableSpringConstantsForce< DIM >::LinearSpringWithVariableSpringConstantsForce ( )

Constructor.

Definition at line 45 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ ~LinearSpringWithVariableSpringConstantsForce()

template<unsigned DIM>

LinearSpringWithVariableSpringConstantsForce< DIM >::~LinearSpringWithVariableSpringConstantsForce ( )

virtual

Destructor.

Definition at line 60 of file LinearSpringWithVariableSpringConstantsForce.cpp.

Member Function Documentation

◆ AddForceContribution()

template<unsigned DIM>

void LinearSpringWithVariableSpringConstantsForce< DIM >::AddForceContribution ( AbstractCellPopulation< DIM > & rCellPopulation )

Overridden AddForceContribution method.

Parameters

rCellPopulation reference to the cell population

Definition at line 223 of file LinearSpringWithVariableSpringConstantsForce.cpp.

References EXCEPTION, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringsBegin(), and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringsEnd().

◆ GetApoptoticSpringCompressionStiffness()

template<unsigned DIM>

double LinearSpringWithVariableSpringConstantsForce< DIM >::GetApoptoticSpringCompressionStiffness ( )

Returns: mApoptoticSpringCompressionStiffness

Definition at line 275 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ GetApoptoticSpringTensionStiffness()

template<unsigned DIM>

double LinearSpringWithVariableSpringConstantsForce< DIM >::GetApoptoticSpringTensionStiffness ( )

Returns: mApoptoticSpringTensionStiffness

Definition at line 262 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ GetBetaCatSpringScaler()

template<unsigned DIM>

double LinearSpringWithVariableSpringConstantsForce< DIM >::GetBetaCatSpringScaler ( )

Returns: mBetaCatSpringScaler

Definition at line 249 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ OutputForceParameters()

template<unsigned DIM>

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

virtual

Overridden OutputForceParameters() method.

Parameters

rParamsFile the file stream to which the parameters are output

Reimplemented from GeneralisedLinearSpringForce< DIM >.

Definition at line 288 of file LinearSpringWithVariableSpringConstantsForce.cpp.

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

◆ serialize()

template<unsigned DIM>

template<class Archive >

void LinearSpringWithVariableSpringConstantsForce< 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 63 of file LinearSpringWithVariableSpringConstantsForce.hpp.

◆ SetApoptoticSpringCompressionStiffness()

template<unsigned DIM>

void LinearSpringWithVariableSpringConstantsForce< DIM >::SetApoptoticSpringCompressionStiffness ( double apoptoticSpringCompressionStiffness )

Set mApoptoticSpringCompressionStiffness.

Parameters

apoptoticSpringCompressionStiffness the new value of mApoptoticSpringCompressionStiffness

Definition at line 281 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ SetApoptoticSprings()

template<unsigned DIM>

void LinearSpringWithVariableSpringConstantsForce< DIM >::SetApoptoticSprings ( bool useApoptoticSprings )

Set spring stiffness to be dependent on whether cells are apoptotic

Parameters

useApoptoticSprings whether to have apoptosis-dependent spring stiffness

Definition at line 86 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ SetApoptoticSpringTensionStiffness()

template<unsigned DIM>

void LinearSpringWithVariableSpringConstantsForce< DIM >::SetApoptoticSpringTensionStiffness ( double apoptoticSpringTensionStiffness )

Set mApoptoticSpringTensionStiffness.

Parameters

apoptoticSpringTensionStiffness the new value of mApoptoticSpringTensionStiffness

Definition at line 268 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ SetBetaCateninSprings()

template<unsigned DIM>

void LinearSpringWithVariableSpringConstantsForce< DIM >::SetBetaCateninSprings ( bool useBCatSprings )

Use the amount of beta-catenin on an edge to find spring constant.

Parameters

useBCatSprings whether to use beta-catenin-dependent spring stiffness

Definition at line 80 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ SetBetaCatSpringScaler()

template<unsigned DIM>

void LinearSpringWithVariableSpringConstantsForce< DIM >::SetBetaCatSpringScaler ( double betaCatSpringScaler )

Set mBetaCatSpringScaler.

Parameters

betaCatSpringScaler the new value of mBetaCatSpringScaler

Definition at line 255 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ SetEdgeBasedSpringConstant()

template<unsigned DIM>

void LinearSpringWithVariableSpringConstantsForce< DIM >::SetEdgeBasedSpringConstant ( bool useEdgeBasedSpringConstant )

Set whether to use an edge-based spring constant.

Parameters

useEdgeBasedSpringConstant whether to use an edge-based spring constant

Definition at line 65 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ SetMutantSprings()

template<unsigned DIM>

void LinearSpringWithVariableSpringConstantsForce< DIM >::SetMutantSprings	(	bool	useMutantSprings,
		double	mutantMutantMultiplier = `2`,
		double	normalMutantMultiplier = `1.5`
	)

Use different spring strengths depending on two cells: Normal-normal, Normal-mutant, mutant-mutant

Parameters

useMutantSprings	whether to use mutant springs
mutantMutantMultiplier	the multiplier for springs connecting two mutant cells
normalMutantMultiplier	the multiplier for springs connecting a mutant cell with a normal cell

Definition at line 72 of file LinearSpringWithVariableSpringConstantsForce.cpp.

◆ VariableSpringConstantMultiplicationFactor()

template<unsigned DIM>

double LinearSpringWithVariableSpringConstantsForce< DIM >::VariableSpringConstantMultiplicationFactor	(	unsigned	nodeAGlobalIndex,
		unsigned	nodeBGlobalIndex,
		AbstractCellPopulation< DIM > &	rCellPopulation,
		bool	isCloserThanRestLength
	)

Return a multiplication factor for the spring constant, which may depend on whether the given pair of neighbouring cells are e.g. undergoing apoptosis, have mutations, or experience variable levels of beta catenin.

Parameters

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