PlaneBasedCellKiller< DIM > Class Template Reference

#include <PlaneBasedCellKiller.hpp>

Inheritance diagram for PlaneBasedCellKiller< DIM >:

[legend]

Collaboration diagram for PlaneBasedCellKiller< DIM >:

[legend]

List of all members.

Public Member Functions
	PlaneBasedCellKiller (AbstractCellPopulation< DIM > *pCellPopulation, c_vector< double, DIM > point, c_vector< double, DIM > normal)
const c_vector< double, DIM > &	rGetPointOnPlane () const
const c_vector< double, DIM > &	rGetNormalToPlane () 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
c_vector< double, DIM >	mPointOnPlane
c_vector< double, DIM >	mNormalToPlane
Friends
class	boost::serialization::access

---

Detailed Description

template<unsigned DIM>
class PlaneBasedCellKiller< DIM >

A cell killer that kills cells if they are outside the domain. defined by a point, mPointOnPlane, and an outward pointing normal, mNormalToPlane. Works for all CellPopulations.

Definition at line 43 of file PlaneBasedCellKiller.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

PlaneBasedCellKiller< DIM >::PlaneBasedCellKiller	(	AbstractCellPopulation< DIM > *	pCellPopulation,
		c_vector< double, DIM >	point,
		c_vector< double, DIM >	normal
	)			[inline]

Default constructor.

Parameters:

	pCellPopulation	pointer to a cell population
	point	point on the plane which nodes cannot cross
	normal	the outward pointing unit normal to the boundary plane

Definition at line 32 of file PlaneBasedCellKiller.cpp.

References PlaneBasedCellKiller< DIM >::mNormalToPlane.

---

Member Function Documentation

template<unsigned DIM>

template<class Archive>

void PlaneBasedCellKiller< 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 71 of file PlaneBasedCellKiller.hpp.

template<unsigned DIM>

const c_vector< double, DIM > & PlaneBasedCellKiller< DIM >::rGetPointOnPlane

(

)

const [inline]

Returns:

mPointOnPlane.

Definition at line 43 of file PlaneBasedCellKiller.cpp.

References PlaneBasedCellKiller< DIM >::mPointOnPlane.

template<unsigned DIM>

const c_vector< double, DIM > & PlaneBasedCellKiller< DIM >::rGetNormalToPlane

(

)

const [inline]

Returns:

mNormalToPlane.

Definition at line 49 of file PlaneBasedCellKiller.cpp.

References PlaneBasedCellKiller< DIM >::mNormalToPlane.

template<unsigned DIM>

void PlaneBasedCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath

(

)

[inline, virtual]

Loops over cells and kills cells outside boundary.

Implements AbstractCellKiller< DIM >.

Definition at line 55 of file PlaneBasedCellKiller.cpp.

References AbstractCellPopulation< DIM >::Begin(), AbstractCellPopulation< DIM >::End(), AbstractCellPopulation< DIM >::GetLocationOfCellCentre(), PlaneBasedCellKiller< DIM >::mNormalToPlane, AbstractCellKiller< DIM >::mpCellPopulation, and PlaneBasedCellKiller< DIM >::mPointOnPlane.

template<unsigned DIM>

void PlaneBasedCellKiller< 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 71 of file PlaneBasedCellKiller.cpp.

References PlaneBasedCellKiller< DIM >::mNormalToPlane, PlaneBasedCellKiller< DIM >::mPointOnPlane, and AbstractCellKiller< SPACE_DIM >::OutputCellKillerParameters().

---

Friends And Related Function Documentation

template<unsigned DIM>

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

Needed for serialization.

Reimplemented from AbstractCellKiller< DIM >.

Definition at line 58 of file PlaneBasedCellKiller.hpp.

---

Member Data Documentation

template<unsigned DIM>

c_vector<double, DIM> PlaneBasedCellKiller< DIM >::mPointOnPlane [private]

A point on the plane which nodes cannot cross.

Definition at line 50 of file PlaneBasedCellKiller.hpp.

Referenced by PlaneBasedCellKiller< DIM >::OutputCellKillerParameters(), PlaneBasedCellKiller< DIM >::rGetPointOnPlane(), and PlaneBasedCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath().

template<unsigned DIM>

c_vector<double, DIM> PlaneBasedCellKiller< DIM >::mNormalToPlane [private]

The outward pointing unit normal to the boundary plane.

Definition at line 55 of file PlaneBasedCellKiller.hpp.

Referenced by PlaneBasedCellKiller< DIM >::OutputCellKillerParameters(), PlaneBasedCellKiller< DIM >::PlaneBasedCellKiller(), PlaneBasedCellKiller< DIM >::rGetNormalToPlane(), and PlaneBasedCellKiller< DIM >::TestAndLabelCellsForApoptosisOrDeath().

---

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

• cell_based/src/population/killers/PlaneBasedCellKiller.hpp
• cell_based/src/population/killers/PlaneBasedCellKiller.cpp