#include <CryptProjectionForce.hpp>

Inheritance diagram for CryptProjectionForce:

Collaboration diagram for CryptProjectionForce:

Public Member Functions
	CryptProjectionForce ()

	~CryptProjectionForce ()

double	GetA () const

double	GetB () const

double	GetWntChemotaxisStrength ()

void	SetWntChemotaxisStrength (double wntChemotaxisStrength)

void	SetWntChemotaxis (bool includeWntChemotaxis)

double	CalculateCryptSurfaceHeightAtPoint (const c_vector< double, 2 > &rNodeLocation)

double	CalculateCryptSurfaceDerivativeAtPoint (const c_vector< double, 2 > &rNodeLocation)

void	AddForceContribution (AbstractCellPopulation< 2 > &rCellPopulation)

void	OutputForceParameters (out_stream &rParamsFile)

Public Member Functions inherited from GeneralisedLinearSpringForce< 2 >
	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, ELEMENT_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)

void	UpdateNode3dLocationMap (AbstractCellPopulation< 2 > &rCellPopulation)

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

Private Attributes
double	mA

double	mB

bool	mIncludeWntChemotaxis

double	mWntChemotaxisStrength

std::map< unsigned, c_vector < double, 3 > >	mNode3dLocationMap

Friends
class	TestCryptProjectionForce

class	boost::serialization::access

Additional Inherited Members
Protected Attributes inherited from GeneralisedLinearSpringForce< 2 >
double	mMeinekeSpringStiffness

double	mMeinekeDivisionRestingSpringLength

double	mMeinekeSpringGrowthDuration

Protected Attributes inherited from AbstractTwoBodyInteractionForce< ELEMENT_DIM, ELEMENT_DIM >
bool	mUseCutOffLength

double	mMechanicsCutOffLength

Detailed Description

A force law for use in crypt projection simulations.

Definition at line 47 of file CryptProjectionForce.hpp.

Constructor & Destructor Documentation

CryptProjectionForce::CryptProjectionForce ( )

Constructor.

Definition at line 42 of file CryptProjectionForce.cpp.

References WntConcentration< DIM >::GetCryptProjectionParameterA(), WntConcentration< DIM >::GetCryptProjectionParameterB(), WntConcentration< DIM >::Instance(), mA, and mB.

CryptProjectionForce::~CryptProjectionForce ( )

Destructor.

Definition at line 51 of file CryptProjectionForce.cpp.

Member Function Documentation

void CryptProjectionForce::AddForceContribution ( AbstractCellPopulation< 2 > & rCellPopulation )

Overridden AddForceContribution method.

Parameters

rCellPopulation reference to the cell population

Definition at line 252 of file CryptProjectionForce.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin(), CalculateForceBetweenNodes(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::End(), EXCEPTION, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationIndexUsingCell(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode(), WntConcentration< DIM >::GetWntGradient(), WntConcentration< DIM >::Instance(), mIncludeWntChemotaxis, mWntChemotaxisStrength, MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringsBegin(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringsEnd(), and UpdateNode3dLocationMap().

double CryptProjectionForce::CalculateCryptSurfaceDerivativeAtPoint ( const c_vector< double, 2 > & rNodeLocation )

Calculates the derivative df/dr of the crypt surface function z=f(r) at a point whose 2D position is a distance r from the centre of the cell_population, which we assume to be at (0,0).

Parameters

rNodeLocation the 2D location of a node

Returns: the gradient

Definition at line 112 of file CryptProjectionForce.cpp.

References mA, and mB.

Referenced by CalculateForceBetweenNodes().

double CryptProjectionForce::CalculateCryptSurfaceHeightAtPoint ( const c_vector< double, 2 > & rNodeLocation )

Calculates the height of the crypt surface given by z = f(r) = a*r^b at a point whose 2D position is a distance r from the centre of the cell population. This assumes that the cell population is centred at the origin.

Parameters

rNodeLocation

Returns: the z component corresponding to rNodeLocation

Definition at line 107 of file CryptProjectionForce.cpp.

References mA, and mB.

Referenced by UpdateNode3dLocationMap().

c_vector< double, 2 > CryptProjectionForce::CalculateForceBetweenNodes	(	unsigned	nodeAGlobalIndex,
		unsigned	nodeBGlobalIndex,
		AbstractCellPopulation< 2 > &	rCellPopulation
	)