AbstractTwoBodyInteractionForce< DIM > Class Template Reference

#include <AbstractTwoBodyInteractionForce.hpp>

Inheritance diagram for AbstractTwoBodyInteractionForce< DIM >:

[legend]

Collaboration diagram for AbstractTwoBodyInteractionForce< DIM >:

[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
Public Attributes
bool	mUseCutoffPoint
double	mCutoffPoint
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 37 of file AbstractTwoBodyInteractionForce.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

AbstractTwoBodyInteractionForce< DIM >::AbstractTwoBodyInteractionForce

(

)

[inline]

Constructor.

Definition at line 105 of file AbstractTwoBodyInteractionForce.hpp.

References AbstractTwoBodyInteractionForce< DIM >::mCutoffPoint, and AbstractTwoBodyInteractionForce< DIM >::mUseCutoffPoint.

---

Member Function Documentation

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
	version

Reimplemented from AbstractForce< DIM >.

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

Definition at line 51 of file AbstractTwoBodyInteractionForce.hpp.

References AbstractTwoBodyInteractionForce< DIM >::mCutoffPoint, and 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 114 of file AbstractTwoBodyInteractionForce.hpp.

References AbstractTwoBodyInteractionForce< DIM >::mCutoffPoint, and AbstractTwoBodyInteractionForce< DIM >::mUseCutoffPoint.

template<unsigned DIM>

double AbstractTwoBodyInteractionForce< DIM >::GetCutoffPoint

(

)

[inline]

Get the cutoff point.

Returns:

mCutoffPoint

Definition at line 122 of file AbstractTwoBodyInteractionForce.hpp.

References AbstractTwoBodyInteractionForce< DIM >::mCutoffPoint.

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

---

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 43 of file AbstractTwoBodyInteractionForce.hpp.

---

Member Data Documentation

template<unsigned DIM>

bool AbstractTwoBodyInteractionForce< DIM >::mUseCutoffPoint

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

Definition at line 68 of file AbstractTwoBodyInteractionForce.hpp.

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

template<unsigned DIM>

double AbstractTwoBodyInteractionForce< DIM >::mCutoffPoint

Have zero force if the cells are this distance apart (and mUseCutoffPoint==true)

Definition at line 71 of file AbstractTwoBodyInteractionForce.hpp.

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

---

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

• /tmp/release_1/cancer/src/tissue/mechanics/AbstractTwoBodyInteractionForce.hpp