Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
NodeLocationWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <NodeLocationWriter.hpp>

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

Public Member Functions

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

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

The output file is called results.viznodes by default.

Definition at line 49 of file NodeLocationWriter.hpp.

Constructor & Destructor Documentation

◆ NodeLocationWriter()

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

Default constructor.

Definition at line 46 of file NodeLocationWriter.cpp.

Member Function Documentation

◆ serialize()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
template<class Archive >
void NodeLocationWriter< 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 61 of file NodeLocationWriter.hpp.

◆ Visit() [1/6]

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

Visit the population and write the location of each Node.

Outputs a line of space-separated values of the form: ... [node x-pos] [node y-pos] [node z-pos] ...

where z-pos is used in 3 dimensions. Here the indexing of nodes is as given by the NodeIterator.

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 90 of file NodeLocationWriter.cpp.

◆ Visit() [2/6]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void NodeLocationWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( ImmersedBoundaryCellPopulation< SPACE_DIM > *  pCellPopulation)
virtual

Visit the population and write the location of each Node.

Outputs a line of space-separated values of the form: ... [node x-pos] [node y-pos] [node z-pos] ...

where z-pos is used in 3 dimensions. Here the indexing of nodes is as given by the NodeIterator.

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 ImmersedBoundaryCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 114 of file NodeLocationWriter.cpp.

◆ Visit() [3/6]

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

Visit the population and write the location of each Node.

Outputs a line of space-separated values of the form: ... [node x-pos] [node y-pos] [node z-pos] ...

where z-pos is used in 3 dimensions. Here the indexing of nodes is as given by the NodeIterator.

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 71 of file NodeLocationWriter.cpp.

References MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetMesh().

◆ Visit() [4/6]

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

Visit the population and write the location of each Node.

Outputs a line of space-separated values of the form: ... [node x-pos] [node y-pos] [node z-pos] ...

where z-pos is used in 3 dimensions. Here the indexing of nodes is as given by the NodeIterator.

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 96 of file NodeLocationWriter.cpp.

◆ Visit() [5/6]

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

Visit the population and write the location of each Node.

Outputs a line of space-separated values of the form: ... [node x-pos] [node y-pos] [node z-pos] ...

where z-pos is used in 3 dimensions. Here the indexing of nodes is as given by the NodeIterator.

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 102 of file NodeLocationWriter.cpp.

◆ Visit() [6/6]

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

Visit the population and write the location of each Node.

Outputs a line of space-separated values of the form: ... [node x-pos] [node y-pos] [node z-pos] ...

where z-pos is used in 3 dimensions. Here the indexing of nodes is as given by the NodeIterator.

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 108 of file NodeLocationWriter.cpp.

◆ VisitAnyPopulation()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void NodeLocationWriter< 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
pCellPopulationa pointer to the population to visit.

Definition at line 52 of file NodeLocationWriter.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetMesh().

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 53 of file NodeLocationWriter.hpp.


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