WelikyOsterForce< DIM > Class Template Reference

#include <WelikyOsterForce.hpp>

Inheritance diagram for WelikyOsterForce< DIM >:

Collaboration diagram for WelikyOsterForce< DIM >:

Public Member Functions
	WelikyOsterForce ()
	~WelikyOsterForce ()
void	AddForceContribution (AbstractCellPopulation< DIM > &rCellPopulation)
double	GetWelikyOsterAreaParameter ()
double	GetWelikyOsterPerimeterParameter ()
void	SetWelikyOsterAreaParameter (double welikyOsterAreaParameter)
void	SetWelikyOsterPerimeterParameter (double welikyOsterPerimeterParameter)
void	OutputForceParameters (out_stream &rParamsFile)
Public Member Functions inherited from AbstractForce< DIM >
	AbstractForce ()
virtual	~AbstractForce ()
virtual void	AddForceContribution (AbstractCellPopulation< ELEMENT_DIM, ELEMENT_DIM > &rCellPopulation)=0
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)

Private Attributes
double	mWelikyOsterAreaParameter
double	mWelikyOsterPerimeterParameter

Friends
class	TestForces
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class WelikyOsterForce< DIM >

A force class for use in vertex-based simulations, based on a mechanical model proposed by M. Weliky and G. Oster ("The mechanical basis of cell rearrangement. I. Epithelial morphogenesis during Fundulus epiboly", Development 109:373-386).

The default values for the two model parameter member variables are our own best estimates, since they are not given in the Weliky & Oster paper.

Definition at line 54 of file WelikyOsterForce.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

WelikyOsterForce< DIM >::WelikyOsterForce

(

)

Constructor.

Definition at line 39 of file WelikyOsterForce.cpp.

template<unsigned DIM>

WelikyOsterForce< DIM >::~WelikyOsterForce

(

)

Destructor.

Definition at line 47 of file WelikyOsterForce.cpp.

Member Function Documentation

template<unsigned DIM>

void WelikyOsterForce< DIM >::AddForceContribution

(

AbstractCellPopulation< DIM > &

rCellPopulation

)

Overridden AddForceContribution() method.

Calculates the force on each node in the vertex-based cell population based on the Weliky Oster model.

Parameters

rCellPopulation

reference to the cell population

Definition at line 52 of file WelikyOsterForce.cpp.

References EXCEPTION, VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetElementIteratorBegin(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetElementIteratorEnd(), VertexBasedCellPopulation< SPACE_DIM >::GetNode(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetSurfaceAreaOfElement(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetVectorFromAtoB(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetVolumeOfElement(), and VertexBasedCellPopulation< SPACE_DIM >::rGetMesh().

template<unsigned DIM>

double WelikyOsterForce< DIM >::GetWelikyOsterAreaParameter

(

)

Returns

mWelikyOsterAreaParameter.

Definition at line 127 of file WelikyOsterForce.cpp.

template<unsigned DIM>

double WelikyOsterForce< DIM >::GetWelikyOsterPerimeterParameter

(

)

Returns

mWelikyOsterPerimeterParameter.

Definition at line 133 of file WelikyOsterForce.cpp.

template<unsigned DIM>

void WelikyOsterForce< 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 151 of file WelikyOsterForce.cpp.

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

template<unsigned DIM>

template<class Archive >

void WelikyOsterForce< 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 79 of file WelikyOsterForce.hpp.

References WelikyOsterForce< DIM >::mWelikyOsterAreaParameter, and WelikyOsterForce< DIM >::mWelikyOsterPerimeterParameter.

template<unsigned DIM>

void WelikyOsterForce< DIM >::SetWelikyOsterAreaParameter

(

double

welikyOsterAreaParameter

)

Set mWelikyOsterAreaParameter.

Parameters

welikyOsterAreaParameter

the new value of mWelikyOsterAreaParameter

Definition at line 139 of file WelikyOsterForce.cpp.

template<unsigned DIM>

void WelikyOsterForce< DIM >::SetWelikyOsterPerimeterParameter

(

double

welikyOsterPerimeterParameter

)

Set mWelikyOsterPerimeterParameter.

Parameters

welikyOsterPerimeterParameter

the new value of mWlikyOsterPerimeterParameter

Definition at line 145 of file WelikyOsterForce.cpp.

Member Data Documentation

template<unsigned DIM>

double WelikyOsterForce< DIM >::mWelikyOsterAreaParameter

private

Area parameter. Has units of kg (cell size at equilibrium rest length)^2 s^-2.

Definition at line 63 of file WelikyOsterForce.hpp.

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

template<unsigned DIM>

double WelikyOsterForce< DIM >::mWelikyOsterPerimeterParameter

private

Perimeter parameter. Has units of kg s^-2 (cell size at equilibrium rest length)^-1.

Definition at line 68 of file WelikyOsterForce.hpp.

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

---

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

• cell_based/src/population/forces/WelikyOsterForce.hpp
• cell_based/src/population/forces/WelikyOsterForce.cpp