Chaste Commit::f2ff7ee04e70ac9d06c57344df8d017dbb12b97b
Public Member Functions | Private Member Functions | Friends | List of all members
CellAncestorWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <CellAncestorWriter.hpp>

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

Public Member Functions

 CellAncestorWriter ()
 
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 CellAncestorWriter< ELEMENT_DIM, SPACE_DIM >

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

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

Definition at line 51 of file CellAncestorWriter.hpp.

Constructor & Destructor Documentation

◆ CellAncestorWriter()

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

Default constructor.

Definition at line 40 of file CellAncestorWriter.cpp.

References AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::mVtkCellDataName.

Member Function Documentation

◆ GetCellDataForVtkOutput()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
double CellAncestorWriter< 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
pCella cell
pCellPopulationa 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 CellAncestorWriter.cpp.

References UNSIGNED_UNSET.

◆ serialize()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
template<class Archive >
void CellAncestorWriter< 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 CellAncestorWriter.hpp.

◆ VisitCell()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void CellAncestorWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell ( CellPtr  pCell,
AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *  pCellPopulation 
)
virtual

Overridden VisitCell() method.

Visit a cell and write its ancestor data.

Outputs a line of space-separated values of the form: [cell 0 ancestor] [cell 1 ancestor] [cell 2 ancestor]... where -1 is used to denote a cell whose ancestor is not set.

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 54 of file CellAncestorWriter.cpp.

References UNSIGNED_UNSET.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 55 of file CellAncestorWriter.hpp.

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