FixedCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <FixedCentreBasedDivisionRule.hpp>

Inheritance diagram for FixedCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >:

Collaboration diagram for FixedCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions
	FixedCentreBasedDivisionRule (c_vector< double, SPACE_DIM > &rDaughterLocation)
virtual	~FixedCentreBasedDivisionRule ()
const c_vector< double, SPACE_DIM > &	rGetDaughterLocation () const
virtual std::pair< c_vector< double, SPACE_DIM >, c_vector< double, SPACE_DIM > >	CalculateCellDivisionVector (CellPtr pParentCell, AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
Public Member Functions inherited from AbstractCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >
	AbstractCentreBasedDivisionRule ()
virtual	~AbstractCentreBasedDivisionRule ()
void	OutputCellCentreBasedDivisionRuleInfo (out_stream &rParamsFile)
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
c_vector< double, SPACE_DIM >	mDaughterLocation

Friends
class	boost::serialization::access

Additional Inherited Members
Protected Member Functions inherited from AbstractCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >
virtual void	OutputCellCentreBasedDivisionRuleParameters (out_stream &rParamsFile)

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
class FixedCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >

A class to generate two daughter cell positions, one given by the position of the dividing cell and the other specified in the class constructor.

This helper class is used in TestMeshBasedCellPopulation.hpp and TestNodeBasedCellPopulation.hpp.

Definition at line 59 of file FixedCentreBasedDivisionRule.hpp.

Constructor & Destructor Documentation

FixedCentreBasedDivisionRule()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

FixedCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >::FixedCentreBasedDivisionRule

(

c_vector< double, SPACE_DIM > &

rDaughterLocation

)

Default constructor.

Parameters

rDaughterLocation

the specified location of the daughter cell

Definition at line 39 of file FixedCentreBasedDivisionRule.cpp.

~FixedCentreBasedDivisionRule()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

virtual FixedCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >::~FixedCentreBasedDivisionRule ( )

inlinevirtual

Empty destructor.

Definition at line 94 of file FixedCentreBasedDivisionRule.hpp.

Member Function Documentation

CalculateCellDivisionVector()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::pair< c_vector< double, SPACE_DIM >, c_vector< double, SPACE_DIM > > FixedCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >::CalculateCellDivisionVector ( CellPtr  pParentCell, AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > &  rCellPopulation  )

virtual

Overridden CalculateCellDivisionVector() method.

Parameters

pParentCell	The cell to divide
rCellPopulation	The centre-based cell population

Returns

the two daughter cell positions.

Implements AbstractCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >.

Definition at line 51 of file FixedCentreBasedDivisionRule.cpp.

References AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationOfCellCentre().

rGetDaughterLocation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

const c_vector< double, SPACE_DIM > & FixedCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >::rGetDaughterLocation

(

)

const

Returns

mDaughterLocation.

Definition at line 45 of file FixedCentreBasedDivisionRule.cpp.

serialize()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

template<class Archive >

void FixedCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Serialize the object and its member variables.

Parameters

archive	the archive
version	the current version of this class

Definition at line 77 of file FixedCentreBasedDivisionRule.hpp.

Friends And Related Symbol Documentation

boost::serialization::access

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

friend class boost::serialization::access

friend

Definition at line 69 of file FixedCentreBasedDivisionRule.hpp.

Member Data Documentation

mDaughterLocation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

c_vector<double, SPACE_DIM> FixedCentreBasedDivisionRule< ELEMENT_DIM, SPACE_DIM >::mDaughterLocation

private

The specified location of the new daughter cell. Initialized in the constructor.

Definition at line 67 of file FixedCentreBasedDivisionRule.hpp.

---

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

• cell_based/src/population/division_rules/FixedCentreBasedDivisionRule.hpp
• cell_based/src/population/division_rules/FixedCentreBasedDivisionRule.cpp