#include <CellPopulationElementWriter.hpp>

Inheritance diagram for CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >:

Collaboration diagram for CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions
	CellPopulationElementWriter ()

virtual void	Visit (MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)

virtual void	Visit (CaBasedCellPopulation< SPACE_DIM > *pCellPopulation)

virtual void	Visit (NodeBasedCellPopulation< SPACE_DIM > *pCellPopulation)

virtual void	Visit (PottsBasedCellPopulation< SPACE_DIM > *pCellPopulation)

virtual void	Visit (VertexBasedCellPopulation< SPACE_DIM > *pCellPopulation)

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

virtual void	WriteHeader (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)

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 AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >
std::string	mFileName

out_stream	mpOutStream

Detailed Description

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

A class written using the visitor pattern for writing population elements from a cell population to file.

The output file is called results.vizelements by default.

Definition at line 49 of file CellPopulationElementWriter.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::CellPopulationElementWriter ( )

Default constructor.

Definition at line 45 of file CellPopulationElementWriter.cpp.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<class Archive >

void CellPopulationElementWriter< 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 61 of file CellPopulationElementWriter.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > * pCellPopulation )

virtual

Visit the MeshBasedCellPopulation and write the index of each Element.

Outputs a line of space-separated values of the form: ...[element index]...

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

Parameters

pCellPopulation a pointer to the MeshBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 51 of file CellPopulationElementWriter.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellUsingLocationIndex(), AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::GetElementIteratorBegin(), AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::GetElementIteratorEnd(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::IsCellAttachedToLocationIndex(), and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetMesh().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( CaBasedCellPopulation< SPACE_DIM > * pCellPopulation )

virtual

Visit the population and write the data.

This is an empty dummy function, since this class is not defined for use with a CaBasedCellPopulation.

Parameters

pCellPopulation a pointer to the CaBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 89 of file CellPopulationElementWriter.cpp.

References EXCEPTION.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( NodeBasedCellPopulation< SPACE_DIM > * pCellPopulation )

virtual

Visit the population and write the data.

This is an empty dummy function, since this class is not defined for use with a NodeBasedCellPopulation.

Parameters

pCellPopulation a pointer to the NodeBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 95 of file CellPopulationElementWriter.cpp.

References EXCEPTION.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( PottsBasedCellPopulation< SPACE_DIM > * pCellPopulation )

virtual

Visit the PottsBasedCellPopulation and write data for each Element.

Outputs a line of space-separated values of the form: ...[num nodes in element] [node 0 index] [node 1 index] [node 2 index]...

where [node 0 index] denotes the global index of the Node that is contained in the Element with local index 0, and so on.

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

Parameters

pCellPopulation a pointer to the PottsBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 101 of file CellPopulationElementWriter.cpp.

References AbstractCellPopulation< DIM >::Begin(), AbstractCellPopulation< DIM >::End(), AbstractCellPopulation< DIM >::GetCellUsingLocationIndex(), PottsBasedCellPopulation< DIM >::GetElement(), AbstractCellPopulation< DIM >::GetLocationIndexUsingCell(), AbstractElement< ELEMENT_DIM, SPACE_DIM >::GetNodeGlobalIndex(), AbstractElement< ELEMENT_DIM, SPACE_DIM >::GetNumNodes(), AbstractCellPopulation< DIM >::IsCellAttachedToLocationIndex(), and PottsBasedCellPopulation< DIM >::rGetMesh().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( VertexBasedCellPopulation< SPACE_DIM > * pCellPopulation )

virtual

Visit the VertexBasedCellPopulation and write data for each Element.

Outputs a line of space-separated values of the form: ...[num nodes in element] [node 0 index] [node 1 index] [node 2 index]...

where [node 0 index] denotes the global index of the Node that is contained in the Element with local index 0, and so on.

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

Parameters

pCellPopulation a pointer to the VertexBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 137 of file CellPopulationElementWriter.cpp.

References AbstractCellPopulation< ELEMENT_DIM, ELEMENT_DIM >::Begin(), AbstractCellPopulation< ELEMENT_DIM, ELEMENT_DIM >::End(), AbstractCellPopulation< ELEMENT_DIM, ELEMENT_DIM >::GetCellUsingLocationIndex(), VertexBasedCellPopulation< SPACE_DIM >::GetElement(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::GetElement(), AbstractCellPopulation< ELEMENT_DIM, ELEMENT_DIM >::GetLocationIndexUsingCell(), AbstractElement< ELEMENT_DIM, SPACE_DIM >::GetNodeGlobalIndex(), AbstractElement< ELEMENT_DIM, SPACE_DIM >::GetNumNodes(), AbstractCellPopulation< ELEMENT_DIM, ELEMENT_DIM >::IsCellAttachedToLocationIndex(), and VertexBasedCellPopulation< SPACE_DIM >::rGetMesh().

Friends And Related Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 53 of file CellPopulationElementWriter.hpp.

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

cell_based/src/writers/population_writers/CellPopulationElementWriter.hpp
cell_based/src/writers/population_writers/CellPopulationElementWriter.cpp

Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

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