Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
ChemotacticForce< DIM > Class Template Reference

#include <ChemotacticForce.hpp>

+ Inheritance diagram for ChemotacticForce< DIM >:
+ Collaboration diagram for ChemotacticForce< DIM >:

Public Member Functions

 ChemotacticForce ()
 
 ~ChemotacticForce ()
 
void AddForceContribution (AbstractCellPopulation< DIM > &rCellPopulation)
 
void OutputForceParameters (out_stream &rParamsFile)
 
- Public Member Functions inherited from AbstractForce< DIM >
 AbstractForce ()
 
virtual ~AbstractForce ()
 
virtual void AddForceContribution (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)=0
 
void OutputForceInfo (out_stream &rParamsFile)
 
virtual void WriteDataToVisualizerSetupFile (out_stream &pVizSetupFile)
 
- Public Member Functions inherited from Identifiable
virtual ~Identifiable ()
 
std::string GetIdentifier () const
 

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 48 of file ChemotacticForce.hpp.

Constructor & Destructor Documentation

◆ ChemotacticForce()

template<unsigned DIM>
ChemotacticForce< DIM >::ChemotacticForce ( )

Constructor.

Definition at line 42 of file ChemotacticForce.cpp.

◆ ~ChemotacticForce()

template<unsigned DIM>
ChemotacticForce< DIM >::~ChemotacticForce ( )

Destructor.

Definition at line 48 of file ChemotacticForce.cpp.

Member Function Documentation

◆ AddForceContribution()

◆ GetChemotacticForceMagnitude()

template<unsigned DIM>
double ChemotacticForce< DIM >::GetChemotacticForceMagnitude ( const double  concentration,
const double  concentrationGradientMagnitude 
)
private
Returns
the magnitude of the chemotactic force.
Parameters
concentrationthe local nutrient concentration
concentrationGradientMagnitudethe magnitude of the local nutrient concentration gradient

Definition at line 53 of file ChemotacticForce.cpp.

◆ OutputForceParameters()

template<unsigned DIM>
void ChemotacticForce< DIM >::OutputForceParameters ( out_stream &  rParamsFile)
virtual

Overridden OutputForceParameters() method.

Parameters
rParamsFilethe file stream to which the parameters are output

Implements AbstractForce< DIM >.

Definition at line 92 of file ChemotacticForce.cpp.

References AbstractForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters().

◆ serialize()

template<unsigned DIM>
template<class Archive >
void ChemotacticForce< DIM >::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

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

Parameters
archiveThe boost archive.
versionThe current version of this class.

Definition at line 71 of file ChemotacticForce.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned DIM>
friend class boost::serialization::access
friend

Definition at line 62 of file ChemotacticForce.hpp.

◆ TestForces

template<unsigned DIM>
friend class TestForces
friend

Definition at line 50 of file ChemotacticForce.hpp.


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