Chaste Release::3.1
RadialSloughingCellKiller Class Reference

#include <RadialSloughingCellKiller.hpp>

Inheritance diagram for RadialSloughingCellKiller:
Collaboration diagram for RadialSloughingCellKiller:

List of all members.

Public Member Functions

 RadialSloughingCellKiller (AbstractCellPopulation< 2 > *pCellPopulation, c_vector< double, 2 > centre, double radius)
c_vector< double, 2 > GetCentre () const
double GetRadius () const
virtual void CheckAndLabelCellsForApoptosisOrDeath ()
void OutputCellKillerParameters (out_stream &rParamsFile)

Private Member Functions

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

Private Attributes

c_vector< double, 2 > mCentre
double mRadius

Friends

class boost::serialization::access

Detailed Description

Radial sloughing cell killer for use with the crypt projection model.

Kills cells if they are outside a circle whose centre and radius can be passed in but are take default values.

Definition at line 50 of file RadialSloughingCellKiller.hpp.


Constructor & Destructor Documentation

RadialSloughingCellKiller::RadialSloughingCellKiller ( AbstractCellPopulation< 2 > *  pCellPopulation,
c_vector< double, 2 >  centre,
double  radius 
)

Constructor.

Parameters:
pCellPopulationpointer to the cell population.
centrethe centre of death.
radiusthe radius of death.

Definition at line 38 of file RadialSloughingCellKiller.cpp.


Member Function Documentation

void RadialSloughingCellKiller::CheckAndLabelCellsForApoptosisOrDeath ( ) [virtual]
c_vector< double, 2 > RadialSloughingCellKiller::GetCentre ( ) const
Returns:
mCentre.

Definition at line 45 of file RadialSloughingCellKiller.cpp.

References mCentre.

double RadialSloughingCellKiller::GetRadius ( ) const
Returns:
mRadius.

Definition at line 50 of file RadialSloughingCellKiller.cpp.

References mRadius.

void RadialSloughingCellKiller::OutputCellKillerParameters ( out_stream &  rParamsFile) [virtual]

Outputs cell killer parameters to file

As this method is pure virtual, it must be overridden in subclasses.

Parameters:
rParamsFilethe file stream to which the parameters are output

Implements AbstractCellKiller< 2 >.

Definition at line 71 of file RadialSloughingCellKiller.cpp.

References mCentre, and mRadius.

template<class Archive >
void RadialSloughingCellKiller::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Serialize the object and its member variables.

Parameters:
archivethe archive
versionthe current version of this class

Reimplemented from AbstractCellKiller< 2 >.

Definition at line 62 of file RadialSloughingCellKiller.hpp.


Friends And Related Function Documentation

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractCellKiller< 2 >.

Definition at line 60 of file RadialSloughingCellKiller.hpp.


Member Data Documentation


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