AbstractTwoBodyInteractionForce< DIM > Class Template Reference

#include <AbstractTwoBodyInteractionForce.hpp>

Inherits AbstractForce< DIM >.

Inherited by GeneralisedLinearSpringForce< DIM >.

Collaboration diagram for AbstractTwoBodyInteractionForce< DIM >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 AbstractTwoBodyInteractionForce ()
void UseCutoffPoint (double cutoffPoint)
double GetCutoffPoint ()
virtual c_vector< double, DIM > CalculateForceBetweenNodes (unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractTissue< DIM > &rTissue)=0
void AddForceContribution (std::vector< c_vector< double, DIM > > &rForces, AbstractTissue< DIM > &rTissue)

Protected Attributes

bool mUseCutoffPoint

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 AbstractTwoBodyInteractionForce< DIM >

An abstract class for two-body force laws.

Definition at line 38 of file AbstractTwoBodyInteractionForce.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>
AbstractTwoBodyInteractionForce< DIM >::AbstractTwoBodyInteractionForce (  )  [inline]

Constructor.

Definition at line 33 of file AbstractTwoBodyInteractionForce.cpp.

Member Function Documentation

template<unsigned DIM>
void AbstractTwoBodyInteractionForce< DIM >::AddForceContribution ( std::vector< c_vector< double, DIM > > &  rForces,
AbstractTissue< DIM > &  rTissue 
) [inline, virtual]

Overridden AddForceContribution() method.

Parameters:
rForces reference to vector of forces on nodes
rTissue reference to the tissue

Implements AbstractForce< DIM >.

Reimplemented in LinearSpringWithVariableSpringConstantsForce< DIM >.

Definition at line 57 of file AbstractTwoBodyInteractionForce.cpp.

References AbstractTwoBodyInteractionForce< DIM >::CalculateForceBetweenNodes(), AbstractTissue< DIM >::HasMesh(), MeshBasedTissue< DIM >::SpringsBegin(), and MeshBasedTissue< DIM >::SpringsEnd().

template<unsigned DIM>
virtual c_vector<double, DIM> AbstractTwoBodyInteractionForce< DIM >::CalculateForceBetweenNodes ( unsigned  nodeAGlobalIndex,
unsigned  nodeBGlobalIndex,
AbstractTissue< DIM > &  rTissue 
) [pure virtual]

Calculates the force between two nodes.

Note that this assumes they are connected and is called by rCalculateVelocitiesOfEachNode()

Parameters:
nodeAGlobalIndex index of one neighbouring node
nodeBGlobalIndex index of the other neighbouring node
rTissue the tissue
Returns:
The force exerted on Node A by Node B.

Implemented in GeneralisedLinearSpringForce< DIM >.

Referenced by AbstractTwoBodyInteractionForce< DIM >::AddForceContribution().

template<unsigned DIM>
double AbstractTwoBodyInteractionForce< DIM >::GetCutoffPoint (  )  [inline]

Get the cutoff point.

Returns:
CutoffPoint

Definition at line 50 of file AbstractTwoBodyInteractionForce.cpp.

References TissueConfig::GetMechanicsCutOffLength(), and TissueConfig::Instance().

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

Archive the object and its member variables.

Parameters:
archive the archive
version the current version of this class

Reimplemented from AbstractForce< DIM >.

Reimplemented in GeneralisedLinearSpringForce< DIM >, and LinearSpringWithVariableSpringConstantsForce< DIM >.

Definition at line 52 of file AbstractTwoBodyInteractionForce.hpp.

References AbstractTwoBodyInteractionForce< DIM >::mUseCutoffPoint.

template<unsigned DIM>
void AbstractTwoBodyInteractionForce< DIM >::UseCutoffPoint ( double  cutoffPoint  )  [inline]

Use a cutoff point, ie specify zero force if two cells are greater than the cutoff distance apart

Parameters:
cutoffPoint the cutoff to use

Definition at line 41 of file AbstractTwoBodyInteractionForce.cpp.

References TissueConfig::Instance(), AbstractTwoBodyInteractionForce< DIM >::mUseCutoffPoint, and TissueConfig::SetMechanicsCutOffLength().

Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractForce< DIM >.

Reimplemented in GeneralisedLinearSpringForce< DIM >, and LinearSpringWithVariableSpringConstantsForce< DIM >.

Definition at line 44 of file AbstractTwoBodyInteractionForce.hpp.

Member Data Documentation

template<unsigned DIM>
bool AbstractTwoBodyInteractionForce< DIM >::mUseCutoffPoint [protected]

Whether to have zero force if the cells are far enough apart

Definition at line 62 of file AbstractTwoBodyInteractionForce.hpp.

Referenced by GeneralisedLinearSpringForce< DIM >::CalculateForceBetweenNodes(), AbstractTwoBodyInteractionForce< DIM >::serialize(), and AbstractTwoBodyInteractionForce< DIM >::UseCutoffPoint().

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2