VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference
#include <VertexT2SwapLocationsWriter.hpp>
Inherits AbstractCellPopulationWriter< 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) |
Private Member Functions | |
| template<class Archive > | |
| void | serialize (Archive &archive, const unsigned int version) |
Friends | |
| class | boost::serialization::access |
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.
Definition at line 47 of file VertexT2SwapLocationsWriter.hpp.
Constructor & Destructor Documentation
| VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >::VertexT2SwapLocationsWriter | ( | ) | [inline] |
Default constructor.
Definition at line 46 of file VertexT2SwapLocationsWriter.cpp.
Member Function Documentation
| void VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >::serialize | ( | Archive & | archive, | |
| const unsigned int | version | |||
| ) | [inline, private] |
Serialize the object and its member variables.
- Parameters:
-
archive the archive version the current version of this class
Reimplemented from AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 59 of file VertexT2SwapLocationsWriter.hpp.
| void VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | VertexBasedCellPopulation< SPACE_DIM > * | pCellPopulation | ) | [inline, 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:
-
pCellPopulation a pointer to the VertexBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 72 of file VertexT2SwapLocationsWriter.cpp.
References VertexBasedCellPopulation< DIM >::ClearLocationsAndCellIdsOfT2Swaps(), VertexBasedCellPopulation< DIM >::GetCellIdsOfT2Swaps(), VertexBasedCellPopulation< DIM >::GetLocationsOfT2Swaps(), and AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream.
| void VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | PottsBasedCellPopulation< SPACE_DIM > * | pCellPopulation | ) | [inline, 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:
-
pCellPopulation a pointer to the PottsBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 67 of file VertexT2SwapLocationsWriter.cpp.
| void VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | NodeBasedCellPopulation< SPACE_DIM > * | pCellPopulation | ) | [inline, 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:
-
pCellPopulation a pointer to the NodeBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 62 of file VertexT2SwapLocationsWriter.cpp.
| void VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | CaBasedCellPopulation< SPACE_DIM > * | pCellPopulation | ) | [inline, 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:
-
pCellPopulation a pointer to the CaBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 57 of file VertexT2SwapLocationsWriter.cpp.
| void VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > * | pCellPopulation | ) | [inline, 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:
-
pCellPopulation a pointer to the MeshBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 52 of file VertexT2SwapLocationsWriter.cpp.
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 51 of file VertexT2SwapLocationsWriter.hpp.
The documentation for this class was generated from the following files:
- cell_based/src/population/writers/population_writers/VertexT2SwapLocationsWriter.hpp
- cell_based/src/population/writers/population_writers/VertexT2SwapLocationsWriter.cpp
