AbstractForce< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <AbstractForce.hpp>

Inheritance diagram for AbstractForce< ELEMENT_DIM, SPACE_DIM >:

Collaboration diagram for AbstractForce< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions
	AbstractForce ()
virtual	~AbstractForce ()
virtual void	AddForceContribution (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)=0
void	OutputForceInfo (out_stream &rParamsFile)
virtual void	OutputForceParameters (out_stream &rParamsFile)=0
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)

Friends
class	boost::serialization::access

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
class AbstractForce< ELEMENT_DIM, SPACE_DIM >

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

Definition at line 48 of file AbstractForce.hpp.

Constructor & Destructor Documentation

AbstractForce()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractForce< ELEMENT_DIM, SPACE_DIM >::AbstractForce

(

)

Default constructor.

Definition at line 39 of file AbstractForce.cpp.

Referenced by AbstractForce< DIM >::serialize().

~AbstractForce()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractForce< ELEMENT_DIM, SPACE_DIM >::~AbstractForce ( )

virtual

Destructor.

Definition at line 44 of file AbstractForce.cpp.

Referenced by AbstractForce< DIM >::serialize().

Member Function Documentation

AddForceContribution()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

virtual void AbstractForce< ELEMENT_DIM, SPACE_DIM >::AddForceContribution ( AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &  rCellPopulation )

pure virtual

Calculates the force on each node.

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

Parameters

rCellPopulation

reference to the cell population

Implemented in AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >, AbstractTwoBodyInteractionForce< ELEMENT_DIM, ELEMENT_DIM >, and PopulationTestingForce< ELEMENT_DIM, SPACE_DIM >.

Referenced by AbstractForce< DIM >::serialize().

OutputForceInfo()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractForce< ELEMENT_DIM, SPACE_DIM >::OutputForceInfo

(

out_stream &

rParamsFile

)

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 49 of file AbstractForce.cpp.

Referenced by AbstractForce< DIM >::serialize().

OutputForceParameters()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters ( out_stream &  rParamsFile )

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 LinearSpringWithVariableSpringConstantsForce< DIM >, GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >, GeneralisedLinearSpringForce< DIM >, GeneralisedLinearSpringForce< 2 >, NagaiHondaForce< DIM >, CryptProjectionForce, FarhadifarForce< DIM >, PopulationTestingForce< ELEMENT_DIM, SPACE_DIM >, NagaiHondaDifferentialAdhesionForce< DIM >, DiffusionForce< DIM >, DifferentialAdhesionGeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >, WelikyOsterForce< DIM >, AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >, AbstractTwoBodyInteractionForce< DIM >, AbstractTwoBodyInteractionForce< ELEMENT_DIM, ELEMENT_DIM >, BuskeElasticForce< DIM >, BuskeAdhesiveForce< DIM >, BuskeCompressionForce< DIM >, VertexCryptBoundaryForce< DIM >, ChemotacticForce< DIM >, and RepulsionForce< DIM >.

Definition at line 59 of file AbstractForce.cpp.

Referenced by ChemotacticForce< DIM >::OutputForceParameters(), VertexCryptBoundaryForce< DIM >::OutputForceParameters(), BuskeCompressionForce< DIM >::OutputForceParameters(), AbstractTwoBodyInteractionForce< ELEMENT_DIM, ELEMENT_DIM >::OutputForceParameters(), WelikyOsterForce< DIM >::OutputForceParameters(), DiffusionForce< DIM >::OutputForceParameters(), FarhadifarForce< DIM >::OutputForceParameters(), NagaiHondaForce< DIM >::OutputForceParameters(), and AbstractForce< DIM >::serialize().

serialize()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

template<class Archive >

void AbstractForce< ELEMENT_DIM, SPACE_DIM >::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Serialize the object.

Parameters

archive	the archive
version	the current version of this class

Definition at line 59 of file AbstractForce.hpp.

WriteDataToVisualizerSetupFile()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractForce< ELEMENT_DIM, SPACE_DIM >::WriteDataToVisualizerSetupFile ( out_stream &  pVizSetupFile )

virtual

Write any data necessary to a visualization setup file. Used by AbstractCellBasedSimulation::WriteVisualizerSetupFile().

Parameters

pVizSetupFile

a visualization setup file

Reimplemented in AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >, AbstractTwoBodyInteractionForce< DIM >, and AbstractTwoBodyInteractionForce< ELEMENT_DIM, ELEMENT_DIM >.

Definition at line 65 of file AbstractForce.cpp.

Referenced by AbstractForce< DIM >::serialize().

Friends And Related Function Documentation

boost::serialization::access

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 51 of file AbstractForce.hpp.

---

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

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