MeshBasedCellPopulation< DIM >::SpringIterator Class Reference

#include <MeshBasedCellPopulation.hpp>

Collaboration diagram for MeshBasedCellPopulation< DIM >::SpringIterator:

[legend]

List of all members.

Public Member Functions
Node< DIM > *	GetNodeA ()
Node< DIM > *	GetNodeB ()
CellPtr	GetCellA ()
CellPtr	GetCellB ()
bool	operator!= (const MeshBasedCellPopulation< DIM >::SpringIterator &rOther)
SpringIterator &	operator++ ()
	SpringIterator (MeshBasedCellPopulation< DIM > &rCellPopulation, typename MutableMesh< DIM, DIM >::EdgeIterator edgeIter)
Private Attributes
std::set< std::set< unsigned > >	mSpringsVisited
MeshBasedCellPopulation< DIM > &	mrCellPopulation
MutableMesh< DIM, DIM > ::EdgeIterator	mEdgeIter

---

Detailed Description

template<unsigned DIM>
class MeshBasedCellPopulation< 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 418 of file MeshBasedCellPopulation.hpp.

---

Constructor & Destructor Documentation

template<unsigned DIM>

MeshBasedCellPopulation< DIM >::SpringIterator::SpringIterator	(	MeshBasedCellPopulation< DIM > &	rCellPopulation,
		typename MutableMesh< DIM, DIM >::EdgeIterator	edgeIter
	)			[inline]

Constructor for a new iterator.

Parameters:

	rCellPopulation	the cell population
	edgeIter	iterator over edges in the mesh

Definition at line 798 of file MeshBasedCellPopulation.cpp.

References MeshBasedCellPopulation< DIM >::SpringIterator::mEdgeIter, and MeshBasedCellPopulation< DIM >::SpringIterator::mrCellPopulation.

---

Member Function Documentation

template<unsigned DIM>

Node< DIM > * MeshBasedCellPopulation< DIM >::SpringIterator::GetNodeA

(

)

[inline]

Get a pointer to the node in the mesh at end A of the spring.

Definition at line 745 of file MeshBasedCellPopulation.cpp.

References MeshBasedCellPopulation< DIM >::SpringIterator::mEdgeIter.

template<unsigned DIM>

Node< DIM > * MeshBasedCellPopulation< DIM >::SpringIterator::GetNodeB

(

)

[inline]

Get a pointer to the node in the mesh at end B of the spring.

Definition at line 751 of file MeshBasedCellPopulation.cpp.

References MeshBasedCellPopulation< DIM >::SpringIterator::mEdgeIter.

template<unsigned DIM>

CellPtr MeshBasedCellPopulation< DIM >::SpringIterator::GetCellA

(

)

[inline]

Get the cell at end A of the spring.

Definition at line 757 of file MeshBasedCellPopulation.cpp.

References MeshBasedCellPopulation< DIM >::SpringIterator::mEdgeIter, and MeshBasedCellPopulation< DIM >::SpringIterator::mrCellPopulation.

template<unsigned DIM>

CellPtr MeshBasedCellPopulation< DIM >::SpringIterator::GetCellB

(

)

[inline]

Get the cell at end B of the spring.

Definition at line 764 of file MeshBasedCellPopulation.cpp.

References MeshBasedCellPopulation< DIM >::SpringIterator::mEdgeIter, and MeshBasedCellPopulation< DIM >::SpringIterator::mrCellPopulation.

template<unsigned DIM>

bool MeshBasedCellPopulation< DIM >::SpringIterator::operator!=

(

const MeshBasedCellPopulation< DIM >::SpringIterator &

rOther

)

[inline]

Comparison not-equal-to.

Parameters:

rOther

SpringIterator with which comparison is made

Definition at line 771 of file MeshBasedCellPopulation.cpp.

References MeshBasedCellPopulation< DIM >::SpringIterator::mEdgeIter.

template<unsigned DIM>

MeshBasedCellPopulation< DIM >::SpringIterator & MeshBasedCellPopulation< DIM >::SpringIterator::operator++

(

)

[inline]

Prefix increment operator.

Definition at line 777 of file MeshBasedCellPopulation.cpp.

References MeshBasedCellPopulation< DIM >::SpringIterator::mEdgeIter, and MeshBasedCellPopulation< DIM >::SpringIterator::mrCellPopulation.

---

Member Data Documentation

template<unsigned DIM>

std::set<std::set<unsigned> > MeshBasedCellPopulation< DIM >::SpringIterator::mSpringsVisited [private]

Keep track of what edges have been visited.

Definition at line 465 of file MeshBasedCellPopulation.hpp.

template<unsigned DIM>

MeshBasedCellPopulation<DIM>& MeshBasedCellPopulation< DIM >::SpringIterator::mrCellPopulation [private]

The cell population member.

Definition at line 468 of file MeshBasedCellPopulation.hpp.

Referenced by MeshBasedCellPopulation< DIM >::SpringIterator::GetCellA(), MeshBasedCellPopulation< DIM >::SpringIterator::GetCellB(), MeshBasedCellPopulation< DIM >::SpringIterator::operator++(), and MeshBasedCellPopulation< DIM >::SpringIterator::SpringIterator().

template<unsigned DIM>

MutableMesh<DIM, DIM>::EdgeIterator MeshBasedCellPopulation< DIM >::SpringIterator::mEdgeIter [private]

The edge iterator member.

Definition at line 471 of file MeshBasedCellPopulation.hpp.

Referenced by MeshBasedCellPopulation< DIM >::SpringIterator::GetCellA(), MeshBasedCellPopulation< DIM >::SpringIterator::GetCellB(), MeshBasedCellPopulation< DIM >::SpringIterator::GetNodeA(), MeshBasedCellPopulation< DIM >::SpringIterator::GetNodeB(), MeshBasedCellPopulation< DIM >::SpringIterator::operator!=(), MeshBasedCellPopulation< DIM >::SpringIterator::operator++(), and MeshBasedCellPopulation< DIM >::SpringIterator::SpringIterator().

---

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

• cell_based/src/population/MeshBasedCellPopulation.hpp
• cell_based/src/population/MeshBasedCellPopulation.cpp