SloughingCellKiller< DIM > Class Template Reference
#include <SloughingCellKiller.hpp>
Public Member Functions | |
| SloughingCellKiller (AbstractCellPopulation< DIM > *pCrypt, double sloughHeight, bool sloughSides=false, double sloughWidth=10.0) | |
| bool | GetSloughSides () const |
| double | GetSloughHeight () const |
| double | GetSloughWidth () const |
| virtual void | TestAndLabelCellsForApoptosisOrDeath () |
| void | OutputCellKillerParameters (out_stream &rParamsFile) |
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 |
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 43 of file SloughingCellKiller.hpp.
Constructor & Destructor Documentation
| SloughingCellKiller< DIM >::SloughingCellKiller | ( | AbstractCellPopulation< DIM > * | pCrypt, | |
| double | sloughHeight, | |||
| bool | sloughSides = false, |
|||
| double | sloughWidth = 10.0 | |||
| ) | [inline] |
Default constructor.
- Parameters:
-
pCrypt pointer to a cell population sloughHeight the height at which to slogh from the domain sloughSides whether to slough cells at the side of the domain sloughWidth the width of the domain (note slogh on left and right)
Definition at line 33 of file SloughingCellKiller.cpp.
References SloughingCellKiller< DIM >::mSloughHeight, and SloughingCellKiller< DIM >::mSloughWidth.
Member Function Documentation
| void SloughingCellKiller< DIM >::serialize | ( | Archive & | archive, | |
| const unsigned int | version | |||
| ) | [inline, private] |
Archive the object and its member variables.
Serialization of singleton objects must be done with care. Before the object is serialized via a pointer, it *MUST* be serialized directly, or an assertion will trip when a second instance of the class is created on de-serialization.
- Parameters:
-
archive the archive version the current version of this class
Reimplemented from AbstractCellKiller< DIM >.
Definition at line 76 of file SloughingCellKiller.hpp.
| bool SloughingCellKiller< DIM >::GetSloughSides | ( | ) | const [inline] |
- Returns:
- mSloughSides.
Definition at line 45 of file SloughingCellKiller.cpp.
References SloughingCellKiller< DIM >::mSloughSides.
| double SloughingCellKiller< DIM >::GetSloughHeight | ( | ) | const [inline] |
- Returns:
- mSloughHeight.
Definition at line 51 of file SloughingCellKiller.cpp.
References SloughingCellKiller< DIM >::mSloughHeight.
| double SloughingCellKiller< DIM >::GetSloughWidth | ( | ) | const [inline] |
- Returns:
- mSloughWidth.
Definition at line 57 of file SloughingCellKiller.cpp.
References SloughingCellKiller< DIM >::mSloughWidth.
| void SloughingCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath | ( | ) | [inline, virtual] |
Loops over cells and kills cells outside boundary.
Implements AbstractCellKiller< DIM >.
Definition at line 64 of file SloughingCellKiller.cpp.
References AbstractCellPopulation< DIM >::Begin(), AbstractCellPopulation< DIM >::End(), EXCEPTION, AbstractCellPopulation< DIM >::GetLocationOfCellCentre(), AbstractCellKiller< DIM >::mpCellPopulation, SloughingCellKiller< DIM >::mSloughHeight, SloughingCellKiller< DIM >::mSloughSides, SloughingCellKiller< DIM >::mSloughWidth, and NEVER_REACHED.
| void SloughingCellKiller< DIM >::OutputCellKillerParameters | ( | out_stream & | rParamsFile | ) | [inline, virtual] |
Outputs cell killer 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
Implements AbstractCellKiller< DIM >.
Definition at line 112 of file SloughingCellKiller.cpp.
References SloughingCellKiller< DIM >::mSloughHeight, SloughingCellKiller< DIM >::mSloughSides, SloughingCellKiller< DIM >::mSloughWidth, and AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters().
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractCellKiller< DIM >.
Definition at line 63 of file SloughingCellKiller.hpp.
Member Data Documentation
bool SloughingCellKiller< DIM >::mSloughSides [private] |
Whether cells should be sloughed from the sides of the crypt.
Definition at line 48 of file SloughingCellKiller.hpp.
Referenced by SloughingCellKiller< DIM >::GetSloughSides(), SloughingCellKiller< DIM >::OutputCellKillerParameters(), and SloughingCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath().
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 54 of file SloughingCellKiller.hpp.
Referenced by SloughingCellKiller< DIM >::GetSloughHeight(), SloughingCellKiller< DIM >::OutputCellKillerParameters(), SloughingCellKiller< DIM >::SloughingCellKiller(), and SloughingCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath().
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 60 of file SloughingCellKiller.hpp.
Referenced by SloughingCellKiller< DIM >::GetSloughWidth(), SloughingCellKiller< DIM >::OutputCellKillerParameters(), SloughingCellKiller< DIM >::SloughingCellKiller(), and SloughingCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath().
The documentation for this class was generated from the following files:
- crypt/src/killers/SloughingCellKiller.hpp
- crypt/src/killers/SloughingCellKiller.cpp
