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

#include <VertexT2SwapLocationsWriter.hpp>

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

Public Member Functions

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

A writer class to output the time and locations of T2 swaps to a file.

The output file is called T2SwapLocations.dat by default.

Definition at line 49 of file VertexT2SwapLocationsWriter.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 45 of file VertexT2SwapLocationsWriter.cpp.

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

Member Function Documentation

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

References EXPORT_TEMPLATE_CLASS_ALL_DIMS, VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >::VertexT2SwapLocationsWriter(), and VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >::Visit().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void VertexT2SwapLocationsWriter< 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 VertexT2SwapLocationsWriter.cpp.

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

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void VertexT2SwapLocationsWriter< 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 VertexT2SwapLocationsWriter.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void VertexT2SwapLocationsWriter< 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 VertexT2SwapLocationsWriter.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void VertexT2SwapLocationsWriter< 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 66 of file VertexT2SwapLocationsWriter.cpp.

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

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

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

where [num T2 swaps] denotes the number of T2 swaps at the present time, and [T2 swap 0 x-pos] denotes the x-coordinate of the T2 swap with index 0 in the MutableVertexMesh member mLocationsOfT2Swaps, 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 71 of file VertexT2SwapLocationsWriter.cpp.

References VertexBasedCellPopulation< DIM >::ClearLocationsAndCellIdsOfT2Swaps(), EXPORT_TEMPLATE_CLASS_ALL_DIMS, VertexBasedCellPopulation< DIM >::GetCellIdsOfT2Swaps(), VertexBasedCellPopulation< DIM >::GetLocationsOfT2Swaps(), and AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream.

Friends And Related Function Documentation

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

Needed for serialization.

Definition at line 53 of file VertexT2SwapLocationsWriter.hpp.


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