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

virtual void	Visit (ImmersedBoundaryCellPopulation< 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

◆ RadialCellDataDistributionWriter()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::RadialCellDataDistributionWriter ( )

Constructor.

Definition at line 45 of file RadialCellDataDistributionWriter.cpp.

Member Function Documentation

◆ GetNumRadialBins()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

unsigned RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::GetNumRadialBins ( ) const

Returns: mNumRadialBins (used in archiving)

Definition at line 214 of file RadialCellDataDistributionWriter.cpp.

◆ GetVariableName()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::string RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::GetVariableName ( ) const

Returns: mVariableName (used in archiving)

Definition at line 202 of file RadialCellDataDistributionWriter.cpp.

◆ serialize()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<class Archive >

void RadialCellDataDistributionWriter< 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 69 of file RadialCellDataDistributionWriter.hpp.

References RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::mNumRadialBins, and RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::mVariableName.

◆ SetNumRadialBins()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::SetNumRadialBins ( unsigned numRadialBins )

Set mNumRadialBins.

Parameters

numRadialBins the number of radial bins to use

Definition at line 208 of file RadialCellDataDistributionWriter.cpp.

◆ SetVariableName()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

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

Set mVariableName.

Parameters

variableName the name of the CellData item to write to file

Definition at line 196 of file RadialCellDataDistributionWriter.cpp.

◆ Visit() [1/6]

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

pCellPopulation a pointer to the CaBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 165 of file RadialCellDataDistributionWriter.cpp.

◆ Visit() [2/6]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( ImmersedBoundaryCellPopulation< 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

pCellPopulation a pointer to the ImmersedBoundaryCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 189 of file RadialCellDataDistributionWriter.cpp.

◆ Visit() [3/6]

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

pCellPopulation a pointer to the MeshBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 109 of file RadialCellDataDistributionWriter.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::End(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCentroidOfCellPopulation(), and AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationOfCellCentre().

◆ Visit() [4/6]

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

pCellPopulation a pointer to the NodeBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 171 of file RadialCellDataDistributionWriter.cpp.

◆ Visit() [5/6]

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

pCellPopulation a pointer to the PottsBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 177 of file RadialCellDataDistributionWriter.cpp.

◆ Visit() [6/6]

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

pCellPopulation a pointer to the VertexBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 183 of file RadialCellDataDistributionWriter.cpp.

◆ VisitAnyPopulation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation ( AbstractCellPopulation< SPACE_DIM, SPACE_DIM > * pCellPopulation )

Visit any population and write the data. This is the same structure for any population.

Parameters

pCellPopulation a pointer to the population to visit

Definition at line 53 of file RadialCellDataDistributionWriter.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Begin(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::End(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCentroidOfCellPopulation(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetLocationOfCellCentre().

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

Member Data Documentation

◆ mNumRadialBins

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

unsigned RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::mNumRadialBins

private

The number of radial bins to use.

Definition at line 58 of file RadialCellDataDistributionWriter.hpp.

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

◆ mVariableName

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

std::string RadialCellDataDistributionWriter< ELEMENT_DIM, SPACE_DIM >::mVariableName

private

The name of the CellData item to write to file.

Definition at line 55 of file RadialCellDataDistributionWriter.hpp.

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

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

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RadialCellDataDistributionWriter()

Member Function Documentation

◆ GetNumRadialBins()

◆ GetVariableName()

◆ serialize()

◆ SetNumRadialBins()

◆ SetVariableName()

◆ Visit() [1/6]

◆ Visit() [2/6]

◆ Visit() [3/6]

◆ Visit() [4/6]

◆ Visit() [5/6]

◆ Visit() [6/6]

◆ VisitAnyPopulation()

Friends And Related Symbol Documentation

◆ boost::serialization::access

Member Data Documentation

◆ mNumRadialBins

◆ mVariableName