CellLabelWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <CellLabelWriter.hpp>

Inherits AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.

Collaboration diagram for CellLabelWriter< ELEMENT_DIM, SPACE_DIM >:

[legend]

List of all members.

Public Member Functions
	CellLabelWriter ()
double	GetCellDataForVtkOutput (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
virtual void	VisitCell (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Friends
class	boost::serialization::access

---

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class CellLabelWriter< ELEMENT_DIM, SPACE_DIM >

A class written using the visitor pattern for writing cell labels to file.

Definition at line 45 of file CellLabelWriter.hpp.

---

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

CellLabelWriter< ELEMENT_DIM, SPACE_DIM >::CellLabelWriter

(

)

[inline]

Default constructor.

Definition at line 41 of file CellLabelWriter.cpp.

References AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::mVtkCellDataName.

---

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

double CellLabelWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput	(	CellPtr	pCell,
		AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *	pCellPopulation
	)			[inline, virtual]

Get a double associated with a cell. This method reduces duplication of code between the methods VisitCell() and AddVtkData().

Parameters:

	pCell	a cell
	pCellPopulation	a pointer to the cell population owning the cell.

Returns:

data associated with the cell

Implements AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 48 of file CellLabelWriter.cpp.

References CellPropertyCollection::GetProperty().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<class Archive >

void CellLabelWriter< ELEMENT_DIM, SPACE_DIM >::serialize	(	Archive &	archive,
		const unsigned int	version
	)			[inline, private]

Serialize the object and its member variables.

Parameters:

	archive	the archive
	version	the current version of this class

Reimplemented from AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 57 of file CellLabelWriter.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void CellLabelWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell	(	CellPtr	pCell,
		AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *	pCellPopulation
	)			[inline, virtual]

Overridden VisitCell() method.

Visit a cell and write its label.

Outputs a line of space-separated values of the form: ...[cell label] [location index] [x-pos] [y-pos] [z-pos] ... with [y-pos] and [z-pos] included for 2 and 3 dimensional simulations, respectively.

This is appended to the output written by AbstractCellBasedWriter, which is a single value [present simulation time], followed by a tab.

Parameters:

	pCell	a cell
	pCellPopulation	a pointer to the cell population owning the cell

Implements AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 61 of file CellLabelWriter.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationIndexUsingCell(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationOfCellCentre(), CellPropertyCollection::GetProperty(), and AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream.

---

Friends And Related Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

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

Needed for serialization.

Reimplemented from AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 49 of file CellLabelWriter.hpp.

---

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

• cell_based/src/population/writers/cell_writers/CellLabelWriter.hpp
• cell_based/src/population/writers/cell_writers/CellLabelWriter.cpp