Chaste  Release::3.4
Public Member Functions | Private Member Functions | Friends | List of all members
CellLabelWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <CellLabelWriter.hpp>

+ Inheritance diagram for CellLabelWriter< ELEMENT_DIM, SPACE_DIM >:
+ Collaboration diagram for CellLabelWriter< ELEMENT_DIM, SPACE_DIM >:

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)
 
- Public Member Functions inherited from AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >
 AbstractCellWriter (const std::string &rFileName)
 
void SetVtkCellDataName (std::string vtkCellDataName)
 
std::string GetVtkCellDataName ()
 
- 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 >
std::string mVtkCellDataName
 
- 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 CellLabelWriter< ELEMENT_DIM, SPACE_DIM >

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

The output file is called results.vizlabels 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 labels" by default.

Definition at line 51 of file CellLabelWriter.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
CellLabelWriter< ELEMENT_DIM, SPACE_DIM >::CellLabelWriter ( )

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 
)
virtual

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

Parameters
pCella cell
pCellPopulationa 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::GetProperties(), and 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 
)
inlineprivate

Serialize the object and its member variables.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 63 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 
)
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
pCella cell
pCellPopulationa 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::GetProperties(), and CellPropertyCollection::GetProperty().

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 CellLabelWriter.hpp.

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