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

#include <DiffusionForce.hpp>

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

Public Member Functions

 DiffusionForce ()
 
 ~DiffusionForce ()
 
void SetAbsoluteTemperature (double absoluteTemperature)
 
void SetViscosity (double viscosity)
 
double GetAbsoluteTemperature ()
 
double GetViscosity ()
 
double GetDiffusionScalingConstant ()
 
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

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

Private Attributes

double mAbsoluteTemperature
 
double mViscosity
 

Static Private Attributes

static const double msBoltzmannConstant = 4.97033568e-7
 

Friends

class boost::serialization::access
 

Detailed Description

template<unsigned DIM>
class DiffusionForce< DIM >

A 'diffusion force' class to model the random movement of nodes.

This class works with all off-lattice cell populations.

Definition at line 52 of file DiffusionForce.hpp.

Constructor & Destructor Documentation

◆ DiffusionForce()

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

Constructor.

Definition at line 44 of file DiffusionForce.cpp.

◆ ~DiffusionForce()

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

Destructor.

Definition at line 52 of file DiffusionForce.cpp.

Member Function Documentation

◆ AddForceContribution()

template<unsigned DIM>
void DiffusionForce< DIM >::AddForceContribution ( AbstractCellPopulation< DIM > &  rCellPopulation)

Overridden AddForceContribution() method. Note that this method requires cell/node radii to be set.

Parameters
rCellPopulationreference to the tissue

Definition at line 89 of file DiffusionForce.cpp.

References EXCEPTION, SimulationTime::GetTimeStep(), SimulationTime::Instance(), RandomNumberGenerator::Instance(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetMesh(), and RandomNumberGenerator::StandardNormalRandomDeviate().

◆ GetAbsoluteTemperature()

template<unsigned DIM>
double DiffusionForce< DIM >::GetAbsoluteTemperature ( )

Get the absolute temperature.

Returns
mAbsoluteTemperature

Definition at line 64 of file DiffusionForce.cpp.

◆ GetDiffusionScalingConstant()

template<unsigned DIM>
double DiffusionForce< DIM >::GetDiffusionScalingConstant ( )

Calculate the scaling of the diffusion constant

Returns
the scaled diffusion constant.

Definition at line 83 of file DiffusionForce.cpp.

◆ GetViscosity()

template<unsigned DIM>
double DiffusionForce< DIM >::GetViscosity ( )

Get the viscosity.

Returns
mViscosity

Definition at line 77 of file DiffusionForce.cpp.

◆ OutputForceParameters()

template<unsigned DIM>
void DiffusionForce< 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 143 of file DiffusionForce.cpp.

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

◆ serialize()

template<unsigned DIM>
template<class Archive >
void DiffusionForce< 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 86 of file DiffusionForce.hpp.

References DiffusionForce< DIM >::mAbsoluteTemperature, and DiffusionForce< DIM >::mViscosity.

◆ SetAbsoluteTemperature()

template<unsigned DIM>
void DiffusionForce< DIM >::SetAbsoluteTemperature ( double  absoluteTemperature)

Set the absolute temperature, which affects the diffusion constant.

Parameters
absoluteTemperaturethe temperature in Kelvin

Definition at line 57 of file DiffusionForce.cpp.

◆ SetViscosity()

template<unsigned DIM>
void DiffusionForce< DIM >::SetViscosity ( double  viscosity)

Set the media viscosity (dynamic), which affects the diffusion constant.

Parameters
viscositythe viscosity

Definition at line 70 of file DiffusionForce.cpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

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

Archiving.

Definition at line 77 of file DiffusionForce.hpp.

Member Data Documentation

◆ mAbsoluteTemperature

template<unsigned DIM>
double DiffusionForce< DIM >::mAbsoluteTemperature
private

Absolute temperature (in Kelvin).

Definition at line 59 of file DiffusionForce.hpp.

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

◆ msBoltzmannConstant

template<unsigned DIM>
const double DiffusionForce< DIM >::msBoltzmannConstant = 4.97033568e-7
staticprivate

The Boltzmann constant, which takes the value 4.97033568e-7 (10 microns)^2 kg h^(-2) K^(-1).

Definition at line 72 of file DiffusionForce.hpp.

◆ mViscosity

template<unsigned DIM>
double DiffusionForce< DIM >::mViscosity
private

Viscosity of media. We assume that this is measured in units of kg (10 microns)^(-1) h^(-1), and that cell diameters are scaled with a characteristic length of 10 microns.

Definition at line 66 of file DiffusionForce.hpp.

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


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