Dune::CpGrid::CentroidIterator< codim > Class Template Reference

An iterator over the centroids of the geometry of the entities. More...

#include <CpGrid.hpp>

Inheritance diagram for Dune::CpGrid::CentroidIterator< codim >:
Inheritance graph

Public Types

typedef std::vector< cpgrid::Geometry< 3-codim, 3 > >::const_iterator GeometryIterator
 The type of the iterator over the codim geometries. More...
 

Public Member Functions

 CentroidIterator (GeometryIterator iter)
 Constructs a new iterator from an iterator over the geometries. More...
 
const FieldVector< double, 3 > & dereference () const
 
void increment ()
 
const FieldVector< double, 3 > & elementAt (int n)
 
void advance (int n)
 
void decrement ()
 
int distanceTo (const CentroidIterator &o)
 
bool equals (const CentroidIterator &o) const
 

Detailed Description

template<int codim>
class Dune::CpGrid::CentroidIterator< codim >

An iterator over the centroids of the geometry of the entities.

Template Parameters
codimThe co-dimension of the entities.

Member Typedef Documentation

◆ GeometryIterator

template<int codim>
typedef std::vector<cpgrid::Geometry<3-codim,3>>::const_iterator Dune::CpGrid::CentroidIterator< codim >::GeometryIterator

The type of the iterator over the codim geometries.

Constructor & Destructor Documentation

◆ CentroidIterator()

template<int codim>
Dune::CpGrid::CentroidIterator< codim >::CentroidIterator ( GeometryIterator  iter)
inline

Constructs a new iterator from an iterator over the geometries.

Parameters
iterThe iterator of the geometry objects.

Member Function Documentation

◆ advance()

template<int codim>
void Dune::CpGrid::CentroidIterator< codim >::advance ( int  n)
inline

◆ decrement()

template<int codim>
void Dune::CpGrid::CentroidIterator< codim >::decrement ( )
inline

◆ dereference()

template<int codim>
const FieldVector< double, 3 > & Dune::CpGrid::CentroidIterator< codim >::dereference ( ) const
inline

◆ distanceTo()

template<int codim>
int Dune::CpGrid::CentroidIterator< codim >::distanceTo ( const CentroidIterator< codim > &  o)
inline

◆ elementAt()

template<int codim>
const FieldVector< double, 3 > & Dune::CpGrid::CentroidIterator< codim >::elementAt ( int  n)
inline

◆ equals()

template<int codim>
bool Dune::CpGrid::CentroidIterator< codim >::equals ( const CentroidIterator< codim > &  o) const
inline

◆ increment()

template<int codim>
void Dune::CpGrid::CentroidIterator< codim >::increment ( )
inline

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