AbstractForce< DIM > Class Template Reference

#include <AbstractForce.hpp>

Inheritance diagram for AbstractForce< DIM >:

[legend]

Collaboration diagram for AbstractForce< DIM >:

[legend]

List of all members.

Public Member Functions
	AbstractForce ()
virtual	~AbstractForce ()
virtual void	AddForceContribution (std::vector< c_vector< double, DIM > > &rForces, AbstractCellPopulation< DIM > &rCellPopulation)=0
void	OutputForceInfo (out_stream &rParamsFile)
virtual void	OutputForceParameters (out_stream &rParamsFile)=0
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 AbstractForce< DIM >

An abstract force class, for use in cell-based simulations.

Definition at line 41 of file AbstractForce.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

AbstractForce< DIM >::AbstractForce

(

)

[inline]

Default constructor.

Definition at line 32 of file AbstractForce.cpp.

template<unsigned DIM>

AbstractForce< DIM >::~AbstractForce

(

)

[inline, virtual]

Destructor.

Definition at line 37 of file AbstractForce.cpp.

---

Member Function Documentation

template<unsigned DIM>

template<class Archive>

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

Serialize the object and its member variables.

Serialization of singleton objects must be done with care. Before the object is serialized via a pointer, it *MUST* be serialized directly, or an assertion will trip when a second instance of the class is created on de-serialization.

Parameters:

	archive	the archive
	version	the current version of this class

Reimplemented in AbstractTwoBodyInteractionForce< DIM >, ChemotacticForce< DIM >, GeneralisedLinearSpringForce< DIM >, NagaiHondaForce< DIM >, WelikyOsterForce< DIM >, CryptProjectionForce, LinearSpringWithVariableSpringConstantsForce< DIM >, VertexCryptBoundaryForce< DIM >, and GeneralisedLinearSpringForce< 2 >.

Definition at line 57 of file AbstractForce.hpp.

template<unsigned DIM>

virtual void AbstractForce< DIM >::AddForceContribution	(	std::vector< c_vector< double, DIM > > &	rForces,
		AbstractCellPopulation< DIM > &	rCellPopulation
	)			[pure virtual]

Calculates the force on each node.

This method must be overridden in concrete classes.

Parameters:

	rForces	reference to vector of forces on nodes
	rCellPopulation	reference to the cell population

Implemented in AbstractTwoBodyInteractionForce< DIM >, ChemotacticForce< DIM >, NagaiHondaForce< DIM >, WelikyOsterForce< DIM >, LinearSpringWithVariableSpringConstantsForce< DIM >, and VertexCryptBoundaryForce< DIM >.

template<unsigned DIM>

void AbstractForce< DIM >::OutputForceInfo

(

out_stream &

rParamsFile

)

[inline]

Outputs force used in the simulation to file and then calls OutputForceParameters to output all relevant parameters.

Parameters:

rParamsFile

the file stream to which the parameters are output

Definition at line 42 of file AbstractForce.cpp.

References Identifiable::GetIdentifier(), and AbstractForce< DIM >::OutputForceParameters().

template<unsigned DIM>

void AbstractForce< DIM >::OutputForceParameters

(

out_stream &

rParamsFile

)

[inline, pure virtual]

Outputs force parameters to file

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

Parameters:

rParamsFile

the file stream to which the parameters are output

Implemented in AbstractTwoBodyInteractionForce< DIM >, ChemotacticForce< DIM >, GeneralisedLinearSpringForce< DIM >, NagaiHondaForce< DIM >, WelikyOsterForce< DIM >, CryptProjectionForce, LinearSpringWithVariableSpringConstantsForce< DIM >, VertexCryptBoundaryForce< DIM >, and GeneralisedLinearSpringForce< 2 >.

Definition at line 52 of file AbstractForce.cpp.

Referenced by AbstractForce< DIM >::OutputForceInfo(), VertexCryptBoundaryForce< DIM >::OutputForceParameters(), WelikyOsterForce< DIM >::OutputForceParameters(), NagaiHondaForce< DIM >::OutputForceParameters(), ChemotacticForce< DIM >::OutputForceParameters(), and AbstractTwoBodyInteractionForce< DIM >::OutputForceParameters().

---

Friends And Related Function Documentation

template<unsigned DIM>

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented in AbstractTwoBodyInteractionForce< DIM >, ChemotacticForce< DIM >, GeneralisedLinearSpringForce< DIM >, NagaiHondaForce< DIM >, WelikyOsterForce< DIM >, CryptProjectionForce, LinearSpringWithVariableSpringConstantsForce< DIM >, VertexCryptBoundaryForce< DIM >, and GeneralisedLinearSpringForce< 2 >.

Definition at line 44 of file AbstractForce.hpp.

---

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

• cell_based/src/population/mechanics/AbstractForce.hpp
• cell_based/src/population/mechanics/AbstractForce.cpp