VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator Class Reference
#include <VertexMesh.hpp>
Public Member Functions | |
| VertexElement< ELEMENT_DIM, SPACE_DIM > & | operator* () |
| VertexElement< ELEMENT_DIM, SPACE_DIM > * | operator-> () |
| bool | operator!= (const VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator &rOther) |
| VertexElementIterator & | operator++ () |
| VertexElementIterator (VertexMesh< ELEMENT_DIM, SPACE_DIM > &rMesh, typename std::vector< VertexElement< ELEMENT_DIM, SPACE_DIM > * >::iterator elementIter, bool skipDeletedElements=true) | |
Private Member Functions | |
| bool | IsAtEnd () |
| bool | IsAllowedElement () |
Private Attributes | |
| VertexMesh & | mrMesh |
| std::vector< VertexElement < ELEMENT_DIM, SPACE_DIM > * >::iterator | mElementIter |
| bool | mSkipDeletedElements |
Detailed Description
template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator
A smart iterator over the elements in the mesh.
- Todo:
- This is the same as in AbstractTetrahedralMesh and PottsMesh - merge? (#1379)
Definition at line 526 of file VertexMesh.hpp.
Constructor & Destructor Documentation
| VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::VertexElementIterator | ( | VertexMesh< ELEMENT_DIM, SPACE_DIM > & | rMesh, | |
| typename std::vector< VertexElement< ELEMENT_DIM, SPACE_DIM > * >::iterator | elementIter, | |||
| bool | skipDeletedElements = true | |||
| ) | [inline] |
Constructor for a new iterator.
This should not be called directly by user code; use the mesh methods VertexMesh::GetElementIteratorBegin and VertexMesh::GetElementIteratorEnd instead.
- Parameters:
-
rMesh the mesh to iterator over elementIter where to start iterating skipDeletedElements whether to include deleted elements
Definition at line 643 of file VertexMesh.hpp.
References VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::IsAllowedElement(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mElementIter, VertexMesh< ELEMENT_DIM, SPACE_DIM >::mElements, and VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mrMesh.
Member Function Documentation
| bool VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::IsAllowedElement | ( | ) | [inline, private] |
Helper method to say if we're allowed to point at this element.
Definition at line 673 of file VertexMesh.hpp.
References VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mSkipDeletedElements.
Referenced by VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator++(), and VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::VertexElementIterator().
| bool VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::IsAtEnd | ( | ) | [inline, private] |
Helper method to say when we're at the end.
Definition at line 667 of file VertexMesh.hpp.
References VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mElementIter, VertexMesh< ELEMENT_DIM, SPACE_DIM >::mElements, and VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mrMesh.
Referenced by VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator*(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator++(), and VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator->().
| bool VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator!= | ( | const VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator & | rOther | ) | [inline] |
Comparison not-equal-to.
- Parameters:
-
rOther iterator with which comparison is made
Definition at line 625 of file VertexMesh.hpp.
References VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mElementIter.
| VertexElement< ELEMENT_DIM, SPACE_DIM > & VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator* | ( | ) | [inline] |
Dereference the iterator giving you a *reference* to the current element.
Make sure to use a reference for the result to avoid copying elements unnecessarily.
Definition at line 611 of file VertexMesh.hpp.
References VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::IsAtEnd(), and VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mElementIter.
| VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator & VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator++ | ( | ) | [inline] |
Prefix increment operator.
Definition at line 631 of file VertexMesh.hpp.
References VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::IsAllowedElement(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::IsAtEnd(), and VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mElementIter.
| VertexElement< ELEMENT_DIM, SPACE_DIM > * VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator-> | ( | ) | [inline] |
Member access from a pointer.
Definition at line 618 of file VertexMesh.hpp.
References VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::IsAtEnd(), and VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mElementIter.
Member Data Documentation
std::vector<VertexElement<ELEMENT_DIM, SPACE_DIM> *>::iterator VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mElementIter [private] |
The actual element iterator.
Definition at line 572 of file VertexMesh.hpp.
Referenced by VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::IsAtEnd(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator!=(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator*(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator++(), VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::operator->(), and VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::VertexElementIterator().
VertexMesh& VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mrMesh [private] |
The mesh we're iterating over.
Definition at line 569 of file VertexMesh.hpp.
Referenced by VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::IsAtEnd(), and VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::VertexElementIterator().
bool VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::mSkipDeletedElements [private] |
Whether to skip deleted elements.
Definition at line 575 of file VertexMesh.hpp.
Referenced by VertexMesh< ELEMENT_DIM, SPACE_DIM >::VertexElementIterator::IsAllowedElement().
The documentation for this class was generated from the following file:
- mesh/src/vertex/VertexMesh.hpp
