ChemotacticForce< DIM > Class Template Reference

#include <ChemotacticForce.hpp>

Inherits AbstractForce< DIM >.

Collaboration diagram for ChemotacticForce< DIM >:

[legend]

List of all members.

Public Member Functions
	ChemotacticForce ()
	~ChemotacticForce ()
void	AddForceContribution (AbstractCellPopulation< DIM > &rCellPopulation)
void	OutputForceParameters (out_stream &rParamsFile)
Private Member Functions
double	GetChemotacticForceMagnitude (const double concentration, const double concentrationGradientMagnitude)
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Friends
class	TestForces
class	boost::serialization::access

---

Detailed Description

template<unsigned DIM>
class ChemotacticForce< DIM >

A chemotactic force class.

Definition at line 51 of file ChemotacticForce.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

ChemotacticForce< DIM >::ChemotacticForce

(

)

[inline]

Constructor.

Definition at line 40 of file ChemotacticForce.cpp.

template<unsigned DIM>

ChemotacticForce< DIM >::~ChemotacticForce

(

)

[inline]

Destructor.

Definition at line 46 of file ChemotacticForce.cpp.

---

Member Function Documentation

template<unsigned DIM>

void ChemotacticForce< DIM >::AddForceContribution

(

AbstractCellPopulation< DIM > &

rCellPopulation

)

[inline]

Overridden AddForceContribution() method.

Parameters:

rCellPopulation

reference to the cell population

Fc = chi(C,|gradC|) gradC/|gradC| (if |gradC|>0, else Fc = 0)

Definition at line 58 of file ChemotacticForce.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::End(), ChemotacticForce< DIM >::GetChemotacticForceMagnitude(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationIndexUsingCell(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode(), CellwiseDataGradient< DIM >::rGetGradient(), and CellwiseDataGradient< DIM >::SetupGradients().

template<unsigned DIM>

double ChemotacticForce< DIM >::GetChemotacticForceMagnitude	(	const double	concentration,
		const double	concentrationGradientMagnitude
	)			[inline, private]

Returns:

the magnitude of the chemotactic force.

Parameters:

	concentration	the local nutrient concentration
	concentrationGradientMagnitude	the magnitude of the local nutrient concentration gradient

Definition at line 51 of file ChemotacticForce.cpp.

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

template<unsigned DIM>

void ChemotacticForce< DIM >::OutputForceParameters

(

out_stream &

rParamsFile

)

[inline, virtual]

Overridden OutputForceParameters() method.

Parameters:

rParamsFile

the file stream to which the parameters are output

Implements AbstractForce< DIM >.

Definition at line 90 of file ChemotacticForce.cpp.

template<unsigned DIM>

template<class Archive >

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

Boost Serialization method for archiving/checkpointing. Archives the object and its member variables.

Parameters:

	archive	The boost archive.
	version	The current version of this class.

Reimplemented from AbstractForce< DIM >.

Definition at line 74 of file ChemotacticForce.hpp.

---

Friends And Related Function Documentation

template<unsigned DIM>

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

Needed for serialization.

Reimplemented from AbstractForce< DIM >.

Definition at line 65 of file ChemotacticForce.hpp.

---

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

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