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

#include <VertexIntersectionSwapLocationsWriter.hpp>

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

Public Member Functions

 VertexIntersectionSwapLocationsWriter ()
 
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 (ImmersedBoundaryCellPopulation< SPACE_DIM > *pCellPopulation)
 
virtual void Visit (PottsBasedCellPopulation< SPACE_DIM > *pCellPopulation)
 
virtual void Visit (VertexBasedCellPopulation< 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 VertexIntersectionSwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >

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

The output file is called IntersectionSwapLocations.dat by default.

Definition at line 49 of file VertexIntersectionSwapLocationsWriter.hpp.

Constructor & Destructor Documentation

◆ VertexIntersectionSwapLocationsWriter()

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

Default constructor.

Definition at line 45 of file VertexIntersectionSwapLocationsWriter.cpp.

Member Function Documentation

◆ serialize()

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

◆ Visit() [1/6]

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

Visit the population and write the data.

This is an empty dummy function, since this class is defined for use with a VertexBasedCellPopulation only.

Parameters
pCellPopulationa pointer to the CaBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 56 of file VertexIntersectionSwapLocationsWriter.cpp.

◆ Visit() [2/6]

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

Visit the population and write the data.

This is an empty dummy function, since this class is defined for use with a VertexBasedCellPopulation only.

Parameters
pCellPopulationa pointer to the ImmersedBoundaryCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 66 of file VertexIntersectionSwapLocationsWriter.cpp.

◆ Visit() [3/6]

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

Visit the population and write the data.

This is an empty dummy function, since this class is defined for use with a VertexBasedCellPopulation only.

Parameters
pCellPopulationa pointer to the MeshBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 51 of file VertexIntersectionSwapLocationsWriter.cpp.

◆ Visit() [4/6]

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

Visit the population and write the data.

This is an empty dummy function, since this class is defined for use with a VertexBasedCellPopulation only.

Parameters
pCellPopulationa pointer to the NodeBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 61 of file VertexIntersectionSwapLocationsWriter.cpp.

◆ Visit() [5/6]

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

Visit the population and write the data.

This is an empty dummy function, since this class is defined for use with a VertexBasedCellPopulation only.

Parameters
pCellPopulationa pointer to the PottsBasedCellPopulation to visit.

Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 71 of file VertexIntersectionSwapLocationsWriter.cpp.

◆ Visit() [6/6]

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

Visit the VertexBasedCellPopulation and write the location of any intersection swaps at the present simulation time.

Outputs a line of tab-separated values of the form: [num T2 swaps] [intersection swap 0 x-pos] [intersection swap 0 y-pos] [intersection swap 0 z-pos] [intersection swap 1 x-pos] [intersection swap 1 y-pos] [intersection swap 1 z-pos] ...

where [num intersection swaps] denotes the number of intersection swaps at the present time, and [intersection swap 0 x-pos] denotes the x-coordinate of the intersection swap with index 0 in the MutableVertexMesh member mLocationsOfIntersectionSwaps, and so on, with [z-pos] included for 3-dimensional simulations.

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 76 of file VertexIntersectionSwapLocationsWriter.cpp.

References MutableVertexMesh< ELEMENT_DIM, SPACE_DIM >::ClearLocationsOfIntersectionSwaps(), MutableVertexMesh< ELEMENT_DIM, SPACE_DIM >::GetLocationsOfIntersectionSwaps(), and VertexBasedCellPopulation< 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 VertexIntersectionSwapLocationsWriter.hpp.

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