T2SwapCellKiller< DIM > Class Template Reference

#include <T2SwapCellKiller.hpp>

Inherits AbstractCellKiller< DIM >.

Collaboration diagram for T2SwapCellKiller< DIM >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 T2SwapCellKiller (AbstractCellPopulation< DIM > *pCellPopulation)
void CheckAndLabelCellsForApoptosisOrDeath ()
void OutputCellKillerParameters (out_stream &rParamsFile)

Private Member Functions

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

Friends

class TestT2SwapCellKiller
class boost::serialization::access

Detailed Description

template<unsigned DIM>
class T2SwapCellKiller< DIM >

This killer performs T2Swaps and kills the corresponding cells. In contrast to other cell killers it carries out vertex rearrangements. The killer is automatically added to OffLatticeSimulations that use a VertexBasedCellPopulation. To inhibit T2 swaps from happening in a simulation the user needs to set the threshold for T2 swaps in the MutableVertexMesh to 0, using the method SetT2Threshold().

Definition at line 54 of file T2SwapCellKiller.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>
T2SwapCellKiller< DIM >::T2SwapCellKiller ( AbstractCellPopulation< DIM > *  pCellPopulation  )  [inline]

Default constructor.

Parameters:
pCellPopulation pointer to the cell population

Definition at line 39 of file T2SwapCellKiller.cpp.

References EXCEPTION, and AbstractCellKiller< DIM >::mpCellPopulation.

Member Function Documentation

template<unsigned DIM>
void T2SwapCellKiller< DIM >::CheckAndLabelCellsForApoptosisOrDeath (  )  [inline, virtual]

Overridden CheckAndLabelCellsForApoptosisOrDeath() method.

Loop over cells and kill them if they are ready for a T2 swap.

Implements AbstractCellKiller< DIM >.

Definition at line 50 of file T2SwapCellKiller.cpp.

References MutableVertexMesh< ELEMENT_DIM, SPACE_DIM >::CheckForT2Swaps(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellUsingLocationIndex(), MutableVertexMesh< ELEMENT_DIM, SPACE_DIM >::GetLastT2SwapLocation(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetNumAllElements(), AbstractCellKiller< DIM >::mpCellPopulation, and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetMesh().

template<unsigned DIM>
void T2SwapCellKiller< DIM >::OutputCellKillerParameters ( out_stream &  rParamsFile  )  [inline, virtual]

Overridden OutputCellKillerParameters() method.

Parameters:
rParamsFile the file stream to which the parameters are output

Implements AbstractCellKiller< DIM >.

Definition at line 92 of file T2SwapCellKiller.cpp.

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

Archive the object.

Parameters:
archive the archive
version the current version of this class

Reimplemented from AbstractCellKiller< DIM >.

Definition at line 70 of file T2SwapCellKiller.hpp.

Friends And Related Function Documentation

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

Needed for serialization.

Reimplemented from AbstractCellKiller< DIM >.

Definition at line 62 of file T2SwapCellKiller.hpp.

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2