VertexCryptBoundaryForce< DIM > Class Template Reference

#include <VertexCryptBoundaryForce.hpp>

Inheritance diagram for VertexCryptBoundaryForce< DIM >:

Collaboration diagram for VertexCryptBoundaryForce< DIM >:

Public Member Functions
	VertexCryptBoundaryForce (double forceStrength=1.0)
	~VertexCryptBoundaryForce ()
void	AddForceContribution (AbstractCellPopulation< DIM > &rCellPopulation)
double	GetForceStrength () const
void	OutputForceParameters (out_stream &rParamsFile)
Public Member Functions inherited from AbstractForce< DIM >
	AbstractForce ()
virtual	~AbstractForce ()
virtual void	AddForceContribution (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)=0
void	OutputForceInfo (out_stream &rParamsFile)
virtual void	WriteDataToVisualizerSetupFile (out_stream &pVizSetupFile)
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	mForceStrength

Friends
class	TestVertexCryptBoundaryForce
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class VertexCryptBoundaryForce< DIM >

A boundary force class for use in vertex-based crypt simulations to prevent cells moving below the bottom of the crypt (y=0).

The boundary force is taken to be zero for y>0, and proportional to y^2 for y<0 (hence is continuously differentiable at y=0). The constant of proportionality is given by the parameter mForceStrength, whose value is set in the constructor.

Definition at line 55 of file VertexCryptBoundaryForce.hpp.

Constructor & Destructor Documentation

VertexCryptBoundaryForce()

template<unsigned DIM>

VertexCryptBoundaryForce< DIM >::VertexCryptBoundaryForce

(

double

forceStrength = 1.0

)

Constructor.

Parameters

forceStrength

the force strength

Definition at line 40 of file VertexCryptBoundaryForce.cpp.

References VertexCryptBoundaryForce< DIM >::mForceStrength.

~VertexCryptBoundaryForce()

template<unsigned DIM>

VertexCryptBoundaryForce< DIM >::~VertexCryptBoundaryForce

(

)

Destructor.

Definition at line 49 of file VertexCryptBoundaryForce.cpp.

Member Function Documentation

AddForceContribution()

template<unsigned DIM>

void VertexCryptBoundaryForce< DIM >::AddForceContribution

(

AbstractCellPopulation< DIM > &

rCellPopulation

)

Overridden AddForceContribution() method.

Calculates the boundary force on each node in the vertex-based cell population.

Parameters

rCellPopulation

reference to the cell population

Definition at line 54 of file VertexCryptBoundaryForce.cpp.

References EXCEPTION, AbstractMesh< ELEMENT_DIM, SPACE_DIM >::GetNodeIteratorBegin(), AbstractMesh< ELEMENT_DIM, SPACE_DIM >::GetNodeIteratorEnd(), and VertexBasedCellPopulation< DIM >::rGetMesh().

GetForceStrength()

template<unsigned DIM>

double VertexCryptBoundaryForce< DIM >::GetForceStrength

(

)

const

Returns

mForceStrength

Definition at line 84 of file VertexCryptBoundaryForce.cpp.

OutputForceParameters()

template<unsigned DIM>

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

virtual

Overridden OutputForceParameters() method.

Parameters

rParamsFile

the file stream to which the parameters are output

Implements AbstractForce< DIM >.

Definition at line 90 of file VertexCryptBoundaryForce.cpp.

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

serialize()

template<unsigned DIM>

template<class Archive >

void VertexCryptBoundaryForce< DIM >::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Boost Serialization method for archiving/checkpointing. Archives the object and its member variables.

Parameters

archive	The boost archive.
version	The current version of this class.

Definition at line 73 of file VertexCryptBoundaryForce.hpp.

References VertexCryptBoundaryForce< DIM >::mForceStrength.

Friends And Related Symbol Documentation

boost::serialization::access

template<unsigned DIM>

friend class boost::serialization::access

friend

Definition at line 64 of file VertexCryptBoundaryForce.hpp.

TestVertexCryptBoundaryForce

template<unsigned DIM>

friend class TestVertexCryptBoundaryForce

friend

Definition at line 57 of file VertexCryptBoundaryForce.hpp.

Member Data Documentation

mForceStrength

template<unsigned DIM>

double VertexCryptBoundaryForce< DIM >::mForceStrength

private

Parameter determining the strength of the force acting on nodes below y=0.

Definition at line 62 of file VertexCryptBoundaryForce.hpp.

Referenced by VertexCryptBoundaryForce< DIM >::VertexCryptBoundaryForce(), and VertexCryptBoundaryForce< DIM >::serialize().

---

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

• crypt/src/forces/VertexCryptBoundaryForce.hpp
• crypt/src/forces/VertexCryptBoundaryForce.cpp