#include <CellIdWriter.hpp>

Inheritance diagram for CellIdWriter< ELEMENT_DIM, SPACE_DIM >:

Collaboration diagram for CellIdWriter< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions
	CellIdWriter ()

double	GetCellDataForVtkOutput (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)

virtual void	VisitCell (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)

Public Member Functions inherited from AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >
	AbstractCellWriter (const std::string &rFileName)

virtual c_vector< double, SPACE_DIM >	GetVectorCellDataForVtkOutput (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)

bool	GetOutputScalarData ()

bool	GetOutputVectorData ()

void	SetVtkCellDataName (std::string vtkCellDataName)

void	SetVtkVectorCellDataName (std::string vtkCellDataName)

std::string	GetVtkCellDataName ()

std::string	GetVtkVectorCellDataName ()

Public Member Functions inherited from AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >
	AbstractCellBasedWriter (const std::string &rFileName)

virtual	~AbstractCellBasedWriter ()

void	CloseFile ()

virtual void	OpenOutputFile (OutputFileHandler &rOutputFileHandler)

void	OpenOutputFileForAppend (OutputFileHandler &rOutputFileHandler)

virtual void	WriteTimeStamp ()

virtual void	WriteNewline ()

void	SetFileName (std::string fileName)

std::string	GetFileName ()

Public Member Functions inherited from Identifiable
virtual	~Identifiable ()

std::string	GetIdentifier () const

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

Friends
class	boost::serialization::access

Additional Inherited Members
Protected Attributes inherited from AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >
bool	mOutputScalarData

bool	mOutputVectorData

std::string	mVtkCellDataName

std::string	mVtkVectorCellDataName

Protected Attributes inherited from AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >
std::string	mFileName

out_stream	mpOutStream

Detailed Description

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

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

The output file is called loggedcell.dat by default. If VTK is switched on, then the writer also specifies the VTK output for each cell, which is stored in the VTK cell data "Cell IDs" by default.

Definition at line 51 of file CellIdWriter.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

CellIdWriter< ELEMENT_DIM, SPACE_DIM >::CellIdWriter ( )

Default constructor.

Definition at line 40 of file CellIdWriter.cpp.

References AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::mVtkCellDataName.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

double CellIdWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput	(	CellPtr	pCell,
		AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *	pCellPopulation
	)

virtual

Overridden GetCellDataForVtkOutput() method.

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

Reimplemented from AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 47 of file CellIdWriter.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<class Archive >

void CellIdWriter< ELEMENT_DIM, SPACE_DIM >::serialize	(	Archive &	archive,
		const unsigned int	version
	)

inlineprivate

Serialize the object and its member variables.

Parameters

archive	the archive
version	the current version of this class

Definition at line 63 of file CellIdWriter.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void CellIdWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell	(	CellPtr	pCell,
		AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *	pCellPopulation
	)

virtual

Overridden VisitCell() method.

Visit a cell and write its ID.

Outputs a line of space-separated values of the form: ...[cell id] [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 54 of file CellIdWriter.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationIndexUsingCell(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationOfCellCentre().

Friends And Related Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 55 of file CellIdWriter.hpp.

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

cell_based/src/writers/cell_writers/CellIdWriter.hpp
cell_based/src/writers/cell_writers/CellIdWriter.cpp

Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

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