SimpleTargetAreaModifier< DIM > Class Template Reference

#include <SimpleTargetAreaModifier.hpp>

Inherits AbstractTargetAreaModifier< DIM >.

Collaboration diagram for SimpleTargetAreaModifier< DIM >:

Public Member Functions
	SimpleTargetAreaModifier ()
virtual	~SimpleTargetAreaModifier ()
virtual void	UpdateTargetAreaOfCell (const CellPtr pCell)
void	OutputSimulationModifierParameters (out_stream &rParamsFile)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Friends
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class SimpleTargetAreaModifier< DIM >

A modifier class in which the target area property of each cell is updated. It is used to implement growth in vertex-based simulations.

Todo:: Improve class documentation by describing precisely how the target area depends on the cell's status

Definition at line 50 of file SimpleTargetAreaModifier.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

SimpleTargetAreaModifier< DIM >::SimpleTargetAreaModifier ( ) [inline]

Default constructor.

Definition at line 39 of file SimpleTargetAreaModifier.cpp.

template<unsigned DIM>

SimpleTargetAreaModifier< DIM >::~SimpleTargetAreaModifier ( ) [inline, virtual]

Destructor.

Definition at line 45 of file SimpleTargetAreaModifier.cpp.

Member Function Documentation

template<unsigned DIM>

void SimpleTargetAreaModifier< DIM >::OutputSimulationModifierParameters ( out_stream & rParamsFile ) [inline, virtual]

Overridden OutputSimulationModifierParameters() method. Output any simulation modifier parameters to file.

Parameters:

rParamsFile

the file stream to which the parameters are output

Reimplemented from AbstractTargetAreaModifier< DIM >.

Definition at line 111 of file SimpleTargetAreaModifier.cpp.

template<unsigned DIM>

template<class Archive >

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

Boost Serialization method for archiving/checkpointing. Archives the object and its member variables.

Parameters:

	archive	The boost archive.
	version	The current version of this class.

Reimplemented from AbstractTargetAreaModifier< DIM >.

Definition at line 62 of file SimpleTargetAreaModifier.hpp.

template<unsigned DIM>

void SimpleTargetAreaModifier< DIM >::UpdateTargetAreaOfCell ( const CellPtr pCell ) [inline, virtual]

Overridden UpdateTargetAreaOfCell() method.

Parameters:

pCell

pointer to the cell

At division, daughter cells inherit the cell data array from the mother cell. Here, we assign the target area that we want daughter cells to have to cells that we know to divide in this time step.