NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference
#include <NodeVelocityWriter.hpp>
Inherits AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Public Member Functions | |
| NodeVelocityWriter () | |
| 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 NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >
A class written using the visitor pattern for writing the velocities of the nodes associated with a cell population to file.
- Todo:
- some code duplication in methods; potential for refactoring (#2404)
Definition at line 50 of file NodeVelocityWriter.hpp.
Constructor & Destructor Documentation
| NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >::NodeVelocityWriter | ( | ) | [inline] |
Default constructor.
Definition at line 45 of file NodeVelocityWriter.cpp.
Member Function Documentation
| void NodeVelocityWriter< 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 62 of file NodeVelocityWriter.hpp.
| void NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | VertexBasedCellPopulation< SPACE_DIM > * | pCellPopulation | ) | [inline, virtual] |
Visit the population and write the location of each Node.
Outputs a line of space-separated values of the form: ... [node index] [node x-pos] [node y-pos] [node z-pos] [node x-vel] [node y-vel] [node z-vel]...
where z-pos and z-vel are 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:
-
pCellPopulation a pointer to the VertexBasedCellPopulation to visit.
- Todo:
- correct time step? (#2404)
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 151 of file NodeVelocityWriter.cpp.
References VertexBasedCellPopulation< DIM >::GetDampingConstant(), AbstractMesh< ELEMENT_DIM, SPACE_DIM >::GetNodeIteratorBegin(), AbstractMesh< ELEMENT_DIM, SPACE_DIM >::GetNodeIteratorEnd(), SimulationTime::GetTimeStep(), SimulationTime::Instance(), AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream, and VertexBasedCellPopulation< DIM >::rGetMesh().
| void NodeVelocityWriter< 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 not defined for use with a PottsBasedCellPopulation.
- Parameters:
-
pCellPopulation a pointer to the PottsBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 146 of file NodeVelocityWriter.cpp.
| void NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | NodeBasedCellPopulation< SPACE_DIM > * | pCellPopulation | ) | [inline, virtual] |
Visit the population and write the location of each Node.
Outputs a line of space-separated values of the form: ... [node index] [node x-pos] [node y-pos] [node z-pos] [node x-vel] [node y-vel] [node z-vel]...
where z-pos and z-vel are 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:
-
pCellPopulation a pointer to the NodeBasedCellPopulation to visit.
- Todo:
- correct time step? (#2404)
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 101 of file NodeVelocityWriter.cpp.
References NodeBasedCellPopulation< DIM >::GetCellUsingLocationIndex(), AbstractCentreBasedCellPopulation< DIM >::GetDampingConstant(), AbstractMesh< ELEMENT_DIM, SPACE_DIM >::GetNodeIteratorBegin(), AbstractMesh< ELEMENT_DIM, SPACE_DIM >::GetNodeIteratorEnd(), SimulationTime::GetTimeStep(), SimulationTime::Instance(), AbstractCentreBasedCellPopulation< DIM >::IsGhostNode(), AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream, and NodeBasedCellPopulation< DIM >::rGetMesh().
| void NodeVelocityWriter< 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 not defined for use with a CaBasedCellPopulation.
- Parameters:
-
pCellPopulation a pointer to the CaBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 96 of file NodeVelocityWriter.cpp.
| void NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > * | pCellPopulation | ) | [inline, virtual] |
Visit the population and write the location of each Node.
Outputs a line of space-separated values of the form: ... [node index] [node x-pos] [node y-pos] [node z-pos] [node x-vel] [node y-vel] [node z-vel]...
where z-pos and z-vel are 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:
-
pCellPopulation a pointer to the MeshBasedCellPopulation to visit.
- Todo:
- correct time step? (#2404)
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 51 of file NodeVelocityWriter.cpp.
References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellUsingLocationIndex(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetDampingConstant(), SimulationTime::GetTimeStep(), SimulationTime::Instance(), AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::IsGhostNode(), AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream, and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetMesh().
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 54 of file NodeVelocityWriter.hpp.
The documentation for this class was generated from the following files:
- cell_based/src/population/writers/population_writers/NodeVelocityWriter.hpp
- cell_based/src/population/writers/population_writers/NodeVelocityWriter.cpp
