#include <RepulsionForce.hpp>
Inheritance diagram for RepulsionForce< DIM >:
Collaboration diagram for RepulsionForce< DIM >:
Public Member Functions | |
| RepulsionForce () | |
| void | AddForceContribution (std::vector< c_vector< double, DIM > > &rForces, AbstractCellPopulation< DIM > &rCellPopulation) |
| virtual void | OutputForceParameters (out_stream &rParamsFile) |
Private Member Functions | |
| template<class Archive > | |
| void | serialize (Archive &archive, const unsigned int version) |
Friends | |
| class | boost::serialization::access |
Detailed Description
template<unsigned DIM>
class RepulsionForce< DIM >
A class for a simple two-body repulsion force law. Designed for use in node-based simulations
The force just creates a linear repulsive force between cells with a nonlinear separation less than 2. This force does not take a cell's age or cell cycle phase into account.
Definition at line 51 of file RepulsionForce.hpp.
Constructor & Destructor Documentation
| RepulsionForce< DIM >::RepulsionForce | ( | ) |
Constructor.
Definition at line 39 of file RepulsionForce.cpp.
Member Function Documentation
| void RepulsionForce< 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 CellPopulation
Definition at line 45 of file RepulsionForce.cpp.
References EXCEPTION, Node< SPACE_DIM >::GetIndex(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode().
| void RepulsionForce< DIM >::OutputForceParameters | ( | out_stream & | rParamsFile | ) | [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
Reimplemented from GeneralisedLinearSpringForce< DIM >.
Definition at line 96 of file RepulsionForce.cpp.
References GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters().
| void RepulsionForce< DIM >::serialize | ( | Archive & | archive, |
| const unsigned int | version | ||
| ) | [inline, private] |
Archive the object and its member variables.
- Parameters:
-
archive the archive version the current version of this class
Reimplemented from GeneralisedLinearSpringForce< DIM >.
Definition at line 64 of file RepulsionForce.hpp.
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from GeneralisedLinearSpringForce< DIM >.
Definition at line 56 of file RepulsionForce.hpp.
The documentation for this class was generated from the following files:
- cell_based/src/population/mechanics/RepulsionForce.hpp
- cell_based/src/population/mechanics/RepulsionForce.cpp
