MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator Class Reference
#include <MeshBasedCellPopulation.hpp>
Public Member Functions | |
| Node< SPACE_DIM > * | GetNodeA () |
| Node< SPACE_DIM > * | GetNodeB () |
| CellPtr | GetCellA () |
| CellPtr | GetCellB () |
| bool | operator!= (const typename MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator &rOther) |
| SpringIterator & | operator++ () |
| SpringIterator (MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation, typename MutableMesh< ELEMENT_DIM, SPACE_DIM >::EdgeIterator edgeIter) | |
Private Attributes | |
| std::set< std::set< unsigned > > | mSpringsVisited |
| MeshBasedCellPopulation < ELEMENT_DIM, SPACE_DIM > & | mrCellPopulation |
| MutableMesh< ELEMENT_DIM, SPACE_DIM >::EdgeIterator | mEdgeIter |
Detailed Description
template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
class MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator
Iterator over edges in the mesh, which correspond to springs between cells.
This class takes care of the logic to make sure that you consider each edge exactly once.
Definition at line 425 of file MeshBasedCellPopulation.hpp.
Constructor & Destructor Documentation
| MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::SpringIterator | ( | MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > & | rCellPopulation, | |
| typename MutableMesh< ELEMENT_DIM, SPACE_DIM >::EdgeIterator | edgeIter | |||
| ) | [inline] |
Constructor for a new iterator.
- Parameters:
-
rCellPopulation the cell population edgeIter iterator over edges in the mesh
Definition at line 855 of file MeshBasedCellPopulation.cpp.
References MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mEdgeIter, and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mrCellPopulation.
Member Function Documentation
| CellPtr MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::GetCellA | ( | ) | [inline] |
- Returns:
- the cell at end A of the spring.
Definition at line 814 of file MeshBasedCellPopulation.cpp.
References MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mEdgeIter, and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mrCellPopulation.
| CellPtr MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::GetCellB | ( | ) | [inline] |
- Returns:
- the cell at end B of the spring.
Definition at line 821 of file MeshBasedCellPopulation.cpp.
References MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mEdgeIter, and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mrCellPopulation.
| Node< SPACE_DIM > * MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::GetNodeA | ( | ) | [inline] |
- Returns:
- a pointer to the node in the mesh at end A of the spring.
Definition at line 802 of file MeshBasedCellPopulation.cpp.
References MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mEdgeIter.
| Node< SPACE_DIM > * MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::GetNodeB | ( | ) | [inline] |
- Returns:
- a pointer to the node in the mesh at end B of the spring.
Definition at line 808 of file MeshBasedCellPopulation.cpp.
References MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mEdgeIter.
| bool MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::operator!= | ( | const typename MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator & | rOther | ) | [inline] |
Comparison not-equal-to.
- Parameters:
-
rOther SpringIterator with which comparison is made
- Returns:
- not-equal
Definition at line 828 of file MeshBasedCellPopulation.cpp.
References MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mEdgeIter.
| MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator & MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::operator++ | ( | ) | [inline] |
Prefix increment operator.
- Returns:
- incremented object
Definition at line 834 of file MeshBasedCellPopulation.cpp.
References MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mEdgeIter, and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mrCellPopulation.
Member Data Documentation
MutableMesh<ELEMENT_DIM, SPACE_DIM>::EdgeIterator MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mEdgeIter [private] |
The edge iterator member.
Definition at line 480 of file MeshBasedCellPopulation.hpp.
Referenced by MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::GetCellA(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::GetCellB(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::GetNodeA(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::GetNodeB(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::operator!=(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::operator++(), and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::SpringIterator().
MeshBasedCellPopulation<ELEMENT_DIM, SPACE_DIM>& MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mrCellPopulation [private] |
The cell population member.
Definition at line 477 of file MeshBasedCellPopulation.hpp.
Referenced by MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::GetCellA(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::GetCellB(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::operator++(), and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::SpringIterator().
std::set<std::set<unsigned> > MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::SpringIterator::mSpringsVisited [private] |
Keep track of what edges have been visited.
Definition at line 474 of file MeshBasedCellPopulation.hpp.
The documentation for this class was generated from the following files:
- cell_based/src/population/MeshBasedCellPopulation.hpp
- cell_based/src/population/MeshBasedCellPopulation.cpp
