Advanced Multi-Physics (AMP)
On-Line Documentation
Public Types | Public Member Functions | Protected Attributes | List of all members
AMP::Mesh::MeshElementVectorIterator Class Reference

A class used to iterate over a set of mesh elements. More...

#include <MeshElementVector.h>

Public Types

using difference_type = ptrdiff_t
 
typedef MeshElementVectorIterator Iterator
 
using iterator_category = std::random_access_iterator_tag
 
using pointer = const AMP::Mesh::MeshElement *
 
using reference = const AMP::Mesh::MeshElement &
 
using value_type = AMP::Mesh::MeshElement
 

Public Member Functions

Iterator begin () const
 Check if two iterators are not equal.
 
Iterator end () const
 Return an iterator to the begining.
 
 MeshElementVectorIterator (const MeshElementVectorBase *ptr, size_t pos=0)
 
bool operator!= (const Iterator &rhs) const
 Check if two iterators are equal.
 
const MeshElementoperator* () const
 Return the size of the iterator.
 
Iteratoroperator++ ()
 Destructor.
 
Iteratoroperator+= (int N)
 Decrement.
 
Iteratoroperator-- ()
 Increment.
 
bool operator== (const Iterator &rhs) const
 
size_t size () const
 Return an iterator to the begining.
 
virtual ~MeshElementVectorIterator ()=default
 Default constructor.
 

Protected Attributes

const MeshElementVectorBased_data
 
size_t d_pos = 0
 Dereference the iterator.
 
size_t d_size = 0
 

Detailed Description

A class used to iterate over a set of mesh elements.

This class provides routines for iterating over a set of mesh elments that are in a std::vector.

Definition at line 106 of file MeshElementVector.h.

Member Typedef Documentation

◆ difference_type

Definition at line 112 of file MeshElementVector.h.

◆ Iterator

Definition at line 109 of file MeshElementVector.h.

◆ iterator_category

using AMP::Mesh::MeshElementVectorIterator::iterator_category = std::random_access_iterator_tag

Definition at line 110 of file MeshElementVector.h.

◆ pointer

Definition at line 113 of file MeshElementVector.h.

◆ reference

Definition at line 114 of file MeshElementVector.h.

◆ value_type

Definition at line 111 of file MeshElementVector.h.

Constructor & Destructor Documentation

◆ MeshElementVectorIterator()

AMP::Mesh::MeshElementVectorIterator::MeshElementVectorIterator ( const MeshElementVectorBase ptr,
size_t  pos = 0 
)
explicit

◆ ~MeshElementVectorIterator()

virtual AMP::Mesh::MeshElementVectorIterator::~MeshElementVectorIterator ( )
virtualdefault

Default constructor.

Member Function Documentation

◆ begin()

Iterator AMP::Mesh::MeshElementVectorIterator::begin ( ) const

Check if two iterators are not equal.

◆ end()

Iterator AMP::Mesh::MeshElementVectorIterator::end ( ) const

Return an iterator to the begining.

◆ operator!=()

bool AMP::Mesh::MeshElementVectorIterator::operator!= ( const Iterator rhs) const

Check if two iterators are equal.

◆ operator*()

const MeshElement & AMP::Mesh::MeshElementVectorIterator::operator* ( ) const

Return the size of the iterator.

◆ operator++()

Iterator & AMP::Mesh::MeshElementVectorIterator::operator++ ( )

Destructor.

◆ operator+=()

Iterator & AMP::Mesh::MeshElementVectorIterator::operator+= ( int  N)

Decrement.

◆ operator--()

Iterator & AMP::Mesh::MeshElementVectorIterator::operator-- ( )

Increment.

◆ operator==()

bool AMP::Mesh::MeshElementVectorIterator::operator== ( const Iterator rhs) const

◆ size()

size_t AMP::Mesh::MeshElementVectorIterator::size ( ) const
inline

Return an iterator to the begining.

Definition at line 127 of file MeshElementVector.h.

References d_data, and AMP::Mesh::MeshElementVectorBase::size().

Member Data Documentation

◆ d_data

const MeshElementVectorBase* AMP::Mesh::MeshElementVectorIterator::d_data
protected

Definition at line 133 of file MeshElementVector.h.

Referenced by size().

◆ d_pos

size_t AMP::Mesh::MeshElementVectorIterator::d_pos = 0
protected

Dereference the iterator.

Definition at line 131 of file MeshElementVector.h.

◆ d_size

size_t AMP::Mesh::MeshElementVectorIterator::d_size = 0
protected

Definition at line 132 of file MeshElementVector.h.


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



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:43.
Comments on this page