#include <AbstractVertexBasedDivisionRule.hpp>
Inheritance diagram for AbstractVertexBasedDivisionRule< SPACE_DIM >: Collaboration diagram for AbstractVertexBasedDivisionRule< SPACE_DIM >:Public Member Functions | |
| AbstractVertexBasedDivisionRule () | |
| virtual | ~AbstractVertexBasedDivisionRule () |
| virtual c_vector< double, SPACE_DIM > | CalculateCellDivisionVector (CellPtr pParentCell, VertexBasedCellPopulation< SPACE_DIM > &rCellPopulation)=0 |
| void | OutputCellVertexBasedDivisionRuleInfo (out_stream &rParamsFile) |
| Public Member Functions inherited from Identifiable | |
| virtual | ~Identifiable () |
| std::string | GetIdentifier () const |
Protected Member Functions | |
| virtual void | OutputCellVertexBasedDivisionRuleParameters (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 SPACE_DIM>
class AbstractVertexBasedDivisionRule< SPACE_DIM >
An abstract cell division rule for use in vertex-based simulations.
The purpose of this class is to return a vector parallel to the new boundary between the daughter cells.
NOTE: When this is used in 3D we will want to return the vector perpendicular to the new boundary plane. This will be the opposite to the current behaviour in 2D.
Definition at line 55 of file AbstractVertexBasedDivisionRule.hpp.
Constructor & Destructor Documentation
| AbstractVertexBasedDivisionRule< SPACE_DIM >::AbstractVertexBasedDivisionRule | ( | ) |
Default constructor.
Definition at line 39 of file AbstractVertexBasedDivisionRule.cpp.
|
virtual |
Empty destructor.
Definition at line 44 of file AbstractVertexBasedDivisionRule.cpp.
Member Function Documentation
|
pure virtual |
Return the vector that will divide the two halves of the existing cell to form the boundary between parent and daughter cell.
As this method is pure virtual, it must be overridden in subclasses.
- Parameters
-
pParentCell The cell to divide rCellPopulation The vertex-based cell population
- Returns
- the division vector.
Implemented in FixedVertexBasedDivisionRule< SPACE_DIM >, ShortAxisVertexBasedDivisionRule< SPACE_DIM >, CryptVertexBasedDivisionRule< SPACE_DIM >, and RandomDirectionVertexBasedDivisionRule< SPACE_DIM >.
| void AbstractVertexBasedDivisionRule< SPACE_DIM >::OutputCellVertexBasedDivisionRuleInfo | ( | out_stream & | rParamsFile | ) |
Output the name of the concrete class and call OutputCellVertexBasedDivisionRuleParameters().
- Parameters
-
rParamsFile The stream of the parameter file
Definition at line 49 of file AbstractVertexBasedDivisionRule.cpp.
|
protectedvirtual |
Output any parameters associated with the division rule. Currently empty since this class has no member variables. Should be overridden by any child classes that have parameters.
- Parameters
-
rParamsFile The stream of the parameter file
Definition at line 59 of file AbstractVertexBasedDivisionRule.cpp.
|
inlineprivate |
Serialize the object and its member variables.
- Parameters
-
archive the archive version the current version of this class
Definition at line 67 of file AbstractVertexBasedDivisionRule.hpp.
The documentation for this class was generated from the following files:
- cell_based/src/population/division_rules/AbstractVertexBasedDivisionRule.hpp
- cell_based/src/population/division_rules/AbstractVertexBasedDivisionRule.cpp
