Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
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, 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 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

◆ WelikyOsterForce()

template<unsigned DIM>
WelikyOsterForce< DIM >::WelikyOsterForce ( )

Constructor.

Definition at line 39 of file WelikyOsterForce.cpp.

◆ ~WelikyOsterForce()

template<unsigned DIM>
WelikyOsterForce< DIM >::~WelikyOsterForce ( )

Destructor.

Definition at line 47 of file WelikyOsterForce.cpp.

Member Function Documentation

◆ AddForceContribution()

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
rCellPopulationreference to the cell population

Definition at line 52 of file WelikyOsterForce.cpp.

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

◆ GetWelikyOsterAreaParameter()

template<unsigned DIM>
double WelikyOsterForce< DIM >::GetWelikyOsterAreaParameter ( )
Returns
mWelikyOsterAreaParameter.

Definition at line 132 of file WelikyOsterForce.cpp.

◆ GetWelikyOsterPerimeterParameter()

template<unsigned DIM>
double WelikyOsterForce< DIM >::GetWelikyOsterPerimeterParameter ( )
Returns
mWelikyOsterPerimeterParameter.

Definition at line 138 of file WelikyOsterForce.cpp.

◆ OutputForceParameters()

template<unsigned DIM>
void WelikyOsterForce< DIM >::OutputForceParameters ( out_stream &  rParamsFile)
virtual

Overridden OutputForceParameters() method.

Parameters
rParamsFilethe file stream to which the parameters are output

Implements AbstractForce< DIM >.

Definition at line 156 of file WelikyOsterForce.cpp.

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

◆ serialize()

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
archiveThe boost archive.
versionThe current version of this class.

Definition at line 79 of file WelikyOsterForce.hpp.

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

◆ SetWelikyOsterAreaParameter()

template<unsigned DIM>
void WelikyOsterForce< DIM >::SetWelikyOsterAreaParameter ( double  welikyOsterAreaParameter)

Set mWelikyOsterAreaParameter.

Parameters
welikyOsterAreaParameterthe new value of mWelikyOsterAreaParameter

Definition at line 144 of file WelikyOsterForce.cpp.

◆ SetWelikyOsterPerimeterParameter()

template<unsigned DIM>
void WelikyOsterForce< DIM >::SetWelikyOsterPerimeterParameter ( double  welikyOsterPerimeterParameter)

Set mWelikyOsterPerimeterParameter.

Parameters
welikyOsterPerimeterParameterthe new value of mWlikyOsterPerimeterParameter

Definition at line 150 of file WelikyOsterForce.cpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned DIM>
friend class boost::serialization::access
friend

Definition at line 70 of file WelikyOsterForce.hpp.

◆ TestForces

template<unsigned DIM>
friend class TestForces
friend

Definition at line 56 of file WelikyOsterForce.hpp.

Member Data Documentation

◆ mWelikyOsterAreaParameter

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().

◆ mWelikyOsterPerimeterParameter

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: