Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
SloughingCellKiller< DIM > Class Template Reference

#include <SloughingCellKiller.hpp>

+ Inheritance diagram for SloughingCellKiller< DIM >:
+ Collaboration diagram for SloughingCellKiller< DIM >:

Public Member Functions

 SloughingCellKiller (AbstractCellPopulation< DIM > *pCrypt, double sloughHeight, bool sloughSides=false, double sloughWidth=10.0)
 
virtual ~SloughingCellKiller ()
 
bool GetSloughSides () const
 
double GetSloughHeight () const
 
double GetSloughWidth () const
 
virtual void CheckAndLabelCellsForApoptosisOrDeath ()
 
void OutputCellKillerParameters (out_stream &rParamsFile)
 
- Public Member Functions inherited from AbstractCellKiller< DIM >
 AbstractCellKiller (AbstractCellPopulation< SPACE_DIM > *pCellPopulation)
 
virtual ~AbstractCellKiller ()
 
const AbstractCellPopulation< SPACE_DIM > * GetCellPopulation () const
 
void OutputCellKillerInfo (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

bool mSloughSides
 
double mSloughHeight
 
double mSloughWidth
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Attributes inherited from AbstractCellKiller< DIM >
AbstractCellPopulation< SPACE_DIM > * mpCellPopulation
 

Detailed Description

template<unsigned DIM>
class SloughingCellKiller< DIM >

A cell killer that kills cells if they are outside the domain. The domain is assumed to start at x=0 and y=0. By default only cells are sloughed if y>mSloughLength. To slough the sides call the constructor with the appropriate parameter.

Definition at line 51 of file SloughingCellKiller.hpp.

Constructor & Destructor Documentation

◆ SloughingCellKiller()

template<unsigned DIM>
SloughingCellKiller< DIM >::SloughingCellKiller ( AbstractCellPopulation< DIM > *  pCrypt,
double  sloughHeight,
bool  sloughSides = false,
double  sloughWidth = 10.0 
)

Default constructor.

Parameters
pCryptpointer to a cell population
sloughHeightthe height at which to slough from the domain
sloughSideswhether to slough cells at the side of the domain
sloughWidththe width of the domain (note slough on left and right)

Definition at line 40 of file SloughingCellKiller.cpp.

References SloughingCellKiller< DIM >::mSloughHeight, and SloughingCellKiller< DIM >::mSloughWidth.

◆ ~SloughingCellKiller()

template<unsigned DIM>
virtual SloughingCellKiller< DIM >::~SloughingCellKiller ( )
inlinevirtual

Destructor

Definition at line 102 of file SloughingCellKiller.hpp.

Member Function Documentation

◆ CheckAndLabelCellsForApoptosisOrDeath()

template<unsigned DIM>
void SloughingCellKiller< DIM >::CheckAndLabelCellsForApoptosisOrDeath ( )
virtual

Loops over cells and kills cells outside boundary.

Implements AbstractCellKiller< DIM >.

Definition at line 70 of file SloughingCellKiller.cpp.

References EXCEPTION, and NEVER_REACHED.

◆ GetSloughHeight()

template<unsigned DIM>
double SloughingCellKiller< DIM >::GetSloughHeight ( ) const
Returns
mSloughHeight.

Definition at line 58 of file SloughingCellKiller.cpp.

◆ GetSloughSides()

template<unsigned DIM>
bool SloughingCellKiller< DIM >::GetSloughSides ( ) const
Returns
mSloughSides.

Definition at line 52 of file SloughingCellKiller.cpp.

◆ GetSloughWidth()

template<unsigned DIM>
double SloughingCellKiller< DIM >::GetSloughWidth ( ) const
Returns
mSloughWidth.

Definition at line 64 of file SloughingCellKiller.cpp.

◆ OutputCellKillerParameters()

template<unsigned DIM>
void SloughingCellKiller< DIM >::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< DIM >.

Definition at line 121 of file SloughingCellKiller.cpp.

References AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters().

◆ serialize()

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

Archive the object.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 79 of file SloughingCellKiller.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned DIM>
friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 71 of file SloughingCellKiller.hpp.

Member Data Documentation

◆ mSloughHeight

template<unsigned DIM>
double SloughingCellKiller< DIM >::mSloughHeight
private

The height of the domain, non-dimensionalised with cell length. This parameter determines when cells are sloughed from the domain.

Definition at line 62 of file SloughingCellKiller.hpp.

Referenced by SloughingCellKiller< DIM >::SloughingCellKiller().

◆ mSloughSides

template<unsigned DIM>
bool SloughingCellKiller< DIM >::mSloughSides
private

Whether cells should be sloughed from the sides of the crypt.

Definition at line 56 of file SloughingCellKiller.hpp.

◆ mSloughWidth

template<unsigned DIM>
double SloughingCellKiller< DIM >::mSloughWidth
private

The width of the domain, non-dimensionalised with cell length. This determines when cells are sloughed from sides of the domain in 2D.

Definition at line 68 of file SloughingCellKiller.hpp.

Referenced by SloughingCellKiller< DIM >::SloughingCellKiller().


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