Chaste Release::3.1
Public Member Functions | Private Member Functions | Friends
RepulsionForce< DIM > Class Template Reference

#include <RepulsionForce.hpp>

Inheritance diagram for RepulsionForce< DIM >:
Collaboration diagram for RepulsionForce< DIM >:

List of all members.

Public Member Functions

 RepulsionForce ()
void AddForceContribution (std::vector< c_vector< double, DIM > > &rForces, AbstractCellPopulation< DIM > &rCellPopulation)
virtual void OutputForceParameters (out_stream &rParamsFile)

Private Member Functions

template<class Archive >
void serialize (Archive &archive, const unsigned int version)

Friends

class boost::serialization::access

Detailed Description

template<unsigned DIM>
class RepulsionForce< DIM >

A class for a simple two-body repulsion force law. Designed for use in node-based simulations

The force just creates a linear repulsive force between cells with a nonlinear separation less than 2. This force does not take a cell's age or cell cycle phase into account.

Definition at line 51 of file RepulsionForce.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 39 of file RepulsionForce.cpp.

Member Function Documentation

template<unsigned DIM>
void RepulsionForce< DIM >::AddForceContribution ( std::vector< c_vector< double, DIM > > &  rForces,
AbstractCellPopulation< DIM > &  rCellPopulation 
)

Overridden AddForceContribution() method.

Parameters:
rForcesreference to vector of forces on nodes
rCellPopulationreference to the CellPopulation

Definition at line 45 of file RepulsionForce.cpp.

References EXCEPTION, Node< SPACE_DIM >::GetIndex(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode().

template<unsigned DIM>
void RepulsionForce< DIM >::OutputForceParameters ( out_stream &  rParamsFile) [virtual]

Outputs force Parameters to file

As this method is pure virtual, it must be overridden in subclasses.

Parameters:
rParamsFilethe file stream to which the parameters are output

Reimplemented from GeneralisedLinearSpringForce< DIM >.

Definition at line 96 of file RepulsionForce.cpp.

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

template<unsigned DIM>
template<class Archive >
void RepulsionForce< DIM >::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Archive the object and its member variables.

Parameters:
archivethe archive
versionthe current version of this class

Reimplemented from GeneralisedLinearSpringForce< DIM >.

Definition at line 64 of file RepulsionForce.hpp.

Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from GeneralisedLinearSpringForce< DIM >.

Definition at line 56 of file RepulsionForce.hpp.

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