ChemotacticForce< DIM > Class Template Reference

#include <ChemotacticForce.hpp>

Inheritance diagram for ChemotacticForce< DIM >:

[legend]

Collaboration diagram for ChemotacticForce< DIM >:

[legend]

List of all members.

Public Member Functions
	ChemotacticForce ()
	~ChemotacticForce ()
void	AddForceContribution (std::vector< c_vector< double, DIM > > &rForces, 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 43 of file ChemotacticForce.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

ChemotacticForce< DIM >::ChemotacticForce

(

)

[inline]

Constructor.

Definition at line 34 of file ChemotacticForce.cpp.

template<unsigned DIM>

ChemotacticForce< DIM >::~ChemotacticForce

(

)

[inline]

Destructor.

Definition at line 40 of file ChemotacticForce.cpp.

---

Member Function Documentation

template<unsigned DIM>

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

Get the magnitude of the chemotactic force.

Parameters:

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

Definition at line 45 of file ChemotacticForce.cpp.

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

template<unsigned DIM>

template<class Archive>

void ChemotacticForce< 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 from AbstractForce< DIM >.

Definition at line 59 of file ChemotacticForce.hpp.

template<unsigned DIM>

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

Overridden AddForceContribution() method.

Parameters:

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

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

Implements AbstractForce< DIM >.

Definition at line 52 of file ChemotacticForce.cpp.

References AbstractCellPopulation< DIM >::Begin(), AbstractCellPopulation< DIM >::End(), ChemotacticForce< DIM >::GetChemotacticForceMagnitude(), AbstractCellPopulation< DIM >::GetLocationIndexUsingCell(), CellwiseData< DIM >::GetValue(), CellwiseData< DIM >::Instance(), CellwiseDataGradient< DIM >::rGetGradient(), and CellwiseDataGradient< DIM >::SetupGradients().

template<unsigned DIM>

void ChemotacticForce< DIM >::OutputForceParameters

(

out_stream &

rParamsFile

)

[inline, 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

Implements AbstractForce< DIM >.

Definition at line 84 of file ChemotacticForce.cpp.

References AbstractForce< DIM >::OutputForceParameters().

---

Friends And Related Function Documentation

template<unsigned DIM>

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

Needed for serialization.

Reimplemented from AbstractForce< DIM >.

Definition at line 57 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