#include <DiffusionForce.hpp>
Inheritance diagram for DiffusionForce< DIM >:
Collaboration diagram for DiffusionForce< DIM >:
Public Member Functions | |
| DiffusionForce () | |
| ~DiffusionForce () | |
| void | SetDiffusionConstant (double diffusionConstant) |
| void | SetAbsoluteTemperature (double absoluteTemperature) |
| void | SetViscosity (double viscosity) |
| void | SetCutOffLength (double cutOffLength) |
| double | GetDiffusionConstant () |
| double | GetAbsoluteTemperature () |
| double | GetViscosity () |
| double | GetCutOffLength () |
| void | AddForceContribution (std::vector< c_vector< double, DIM > > &rForces, AbstractCellPopulation< DIM > &rCellPopulation) |
| void | OutputForceParameters (out_stream &rParamsFile) |
Private Member Functions | |
| template<class Archive > | |
| void | serialize (Archive &archive, const unsigned int version) |
Private Attributes | |
| double | mDiffusionConstant |
| double | mAbsoluteTemperature |
| double | mViscosity |
| double | mMechanicsCutOffLength |
Friends | |
| class | boost::serialization::access |
Detailed Description
template<unsigned DIM>
class DiffusionForce< DIM >
A force class to model diffusion.
Definition at line 50 of file DiffusionForce.hpp.
Constructor & Destructor Documentation
| DiffusionForce< DIM >::DiffusionForce | ( | ) |
Constructor.
Definition at line 40 of file DiffusionForce.cpp.
| DiffusionForce< DIM >::~DiffusionForce | ( | ) |
Destructor.
Definition at line 50 of file DiffusionForce.cpp.
Member Function Documentation
| void DiffusionForce< DIM >::AddForceContribution | ( | std::vector< c_vector< double, DIM > > & | rForces, |
| AbstractCellPopulation< DIM > & | rCellPopulation | ||
| ) |
Overridden AddForceContribution() method.
- Parameters:
-
rForces reference to vector of forces on nodes rCellPopulation reference to the tissue
Definition at line 108 of file DiffusionForce.cpp.
References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::End(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationIndexUsingCell(), SimulationTime::GetTimeStep(), RandomNumberGenerator::Instance(), SimulationTime::Instance(), and RandomNumberGenerator::StandardNormalRandomDeviate().
| double DiffusionForce< DIM >::GetAbsoluteTemperature | ( | ) |
Get the absolute temperature.
- Returns:
- mAbsoluteTemperature
Definition at line 89 of file DiffusionForce.cpp.
| double DiffusionForce< DIM >::GetCutOffLength | ( | ) |
| double DiffusionForce< DIM >::GetDiffusionConstant | ( | ) |
Get the diffusion coefficient.
- Returns:
- mDiffusionConstant
Definition at line 76 of file DiffusionForce.cpp.
| double DiffusionForce< DIM >::GetViscosity | ( | ) |
| void DiffusionForce< DIM >::OutputForceParameters | ( | out_stream & | rParamsFile | ) | [virtual] |
Overridden OutputForceParameters() method.
- Parameters:
-
rParamsFile the file stream to which the parameters are output
Implements AbstractForce< DIM >.
Definition at line 156 of file DiffusionForce.cpp.
References AbstractForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters().
| void DiffusionForce< DIM >::serialize | ( | Archive & | archive, |
| const unsigned int | version | ||
| ) | [inline, private] |
Serialize the object.
- Parameters:
-
archive the archive version the current version of this class
Reimplemented from AbstractForce< DIM >.
Definition at line 81 of file DiffusionForce.hpp.
References DiffusionForce< DIM >::mAbsoluteTemperature, DiffusionForce< DIM >::mDiffusionConstant, DiffusionForce< DIM >::mMechanicsCutOffLength, and DiffusionForce< DIM >::mViscosity.
| void DiffusionForce< DIM >::SetAbsoluteTemperature | ( | double | absoluteTemperature | ) |
Set the absolute temperature, which affects the diffusion constant.
- Parameters:
-
absoluteTemperature the temperature in Kelvin
Definition at line 82 of file DiffusionForce.cpp.
| void DiffusionForce< DIM >::SetCutOffLength | ( | double | cutOffLength | ) |
Use a cutoff point, i.e. specify zero force if two cells are greater than the cutoff distance apart.
- Parameters:
-
cutOffLength the cutoff to use
Definition at line 55 of file DiffusionForce.cpp.
| void DiffusionForce< DIM >::SetDiffusionConstant | ( | double | diffusionConstant | ) |
Set the diffusion constant for the cells.
- Parameters:
-
diffusionConstant the diffusion constant to use
Definition at line 69 of file DiffusionForce.cpp.
| void DiffusionForce< DIM >::SetViscosity | ( | double | viscosity | ) |
Set the media viscosity (dynamic), which affects the diffusion constant.
- Parameters:
-
viscosity the viscosity
Definition at line 95 of file DiffusionForce.cpp.
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Archiving.
Reimplemented from AbstractForce< DIM >.
Definition at line 79 of file DiffusionForce.hpp.
Member Data Documentation
double DiffusionForce< DIM >::mAbsoluteTemperature [private] |
Absolute temperature (in Kelvin).
Definition at line 62 of file DiffusionForce.hpp.
Referenced by DiffusionForce< DIM >::serialize().
double DiffusionForce< DIM >::mDiffusionConstant [private] |
Diffusion constant.
Definition at line 57 of file DiffusionForce.hpp.
Referenced by DiffusionForce< DIM >::serialize().
double DiffusionForce< DIM >::mMechanicsCutOffLength [private] |
Mechanics cut off length.
Definition at line 74 of file DiffusionForce.hpp.
Referenced by DiffusionForce< DIM >::serialize().
double DiffusionForce< DIM >::mViscosity [private] |
Viscosity of media. We assume that this is measured in units of kg microns^(-1) h^(-1), and that cell diameters are scaled with a characteristic length of 1 micron.
Definition at line 69 of file DiffusionForce.hpp.
Referenced by DiffusionForce< DIM >::serialize().
The documentation for this class was generated from the following files:
- cell_based/src/population/mechanics/DiffusionForce.hpp
- cell_based/src/population/mechanics/DiffusionForce.cpp
