Chaste  Release::2017.1
RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <RadialCellDataDistributionWriter.hpp>

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

Public Member Functions

 RadialCellDataDistributionWriter ()
 
void VisitAnyPopulation (AbstractCellPopulation< SPACE_DIM, SPACE_DIM > *pCellPopulation)
 
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)
 
void SetVariableName (std::string variableName)
 
std::string GetVariableName () const
 
void SetNumRadialBins (unsigned numRadialBins)
 
unsigned GetNumRadialBins () const
 
- 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)
 

Private Attributes

std::string mVariableName
 
unsigned mNumRadialBins
 

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 RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >

A class written using the visitor pattern for writing the average radial distribution of a given CellData item, from the centroid of the cell population outward, to file.

The output file is called radial_dist.dat by default.

Definition at line 50 of file RadialCellDataDistributionWriter.hpp.

Constructor & Destructor Documentation

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

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
unsigned RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::GetNumRadialBins ( ) const
template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
std::string RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::GetVariableName ( ) const
template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::SetNumRadialBins ( unsigned  numRadialBins)

Set mNumRadialBins.

Parameters
numRadialBinsthe number of radial bins to use

Definition at line 200 of file RadialCellDataDistributionWriter.cpp.

References RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::mNumRadialBins.

Referenced by RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::serialize().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::SetVariableName ( std::string  variableName)

Set mVariableName.

Parameters
variableNamethe name of the CellData item to write to file

Definition at line 188 of file RadialCellDataDistributionWriter.cpp.

References RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::mVariableName.

Referenced by RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::serialize().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > *  pCellPopulation)
virtual

Visit the population and write the average radial distribution of the CellData item, from the centroid of the cell population outward, in the prescribed number of bins.

Outputs a line of space-separated values of the form: [smaller radius of interval i] [average value]

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

Parameters
pCellPopulationa pointer to the MeshBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 108 of file RadialCellDataDistributionWriter.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::End(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCentroidOfCellPopulation(), AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationOfCellCentre(), RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::mNumRadialBins, AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream, and RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::mVariableName.

Referenced by RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::serialize().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( CaBasedCellPopulation< SPACE_DIM > *  pCellPopulation)
virtual

Visit the population and write the average radial distribution of the CellData item, from the centroid of the cell population outward, in the prescribed number of bins.

Outputs a line of space-separated values of the form: [smaller radius of interval i] [average value]

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

Parameters
pCellPopulationa pointer to the CaBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 164 of file RadialCellDataDistributionWriter.cpp.

References RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( NodeBasedCellPopulation< SPACE_DIM > *  pCellPopulation)
virtual

Visit the population and write the average radial distribution of the CellData item, from the centroid of the cell population outward, in the prescribed number of bins.

Outputs a line of space-separated values of the form: [smaller radius of interval i] [average value]

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

Parameters
pCellPopulationa pointer to the NodeBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 170 of file RadialCellDataDistributionWriter.cpp.

References RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( PottsBasedCellPopulation< SPACE_DIM > *  pCellPopulation)
virtual

Visit the population and write the average radial distribution of the CellData item, from the centroid of the cell population outward, in the prescribed number of bins.

Outputs a line of space-separated values of the form: [smaller radius of interval i] [average value]

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

Parameters
pCellPopulationa pointer to the PottsBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 176 of file RadialCellDataDistributionWriter.cpp.

References RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( VertexBasedCellPopulation< SPACE_DIM > *  pCellPopulation)
virtual

Visit the population and write the average radial distribution of the CellData item, from the centroid of the cell population outward, in the prescribed number of bins.

Outputs a line of space-separated values of the form: [smaller radius of interval i] [average value]

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

Parameters
pCellPopulationa pointer to the VertexBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 182 of file RadialCellDataDistributionWriter.cpp.

References RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

Friends And Related Function Documentation

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

Needed for serialization.

Definition at line 61 of file RadialCellDataDistributionWriter.hpp.

Member Data Documentation


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