dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp > Class Template Reference

interface for DoF iterators of discrete functions More...

#include <dune/fem/function/common/dofiterator.hh>

Inheritance diagram for Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >:
Inheritance graph

Public Types

typedef DofImp DofType
 type of the DoFs
 
typedef DofIteratorImp DofIteratorType
 type of the implementation (Barton-Nackman)
 

Public Member Functions

DofIteratorTypeoperator= (const DofIteratorType &other)
 assign another DoF iterator to this one
 
DofTypeoperator* ()
 obtain reference to current DoF
 
const DofTypeoperator* () const
 obtain reference to current DoF
 
const DofImp & operator[] (const int n) const
 
DofImp & operator[] (const int n)
 
DofIteratorTypeoperator++ ()
 increment the iterator
 
bool operator== (const DofIteratorType &other) const
 check for equality
 
bool operator!= (const DofIteratorType &other) const
 check for inequality
 
int index () const
 get the global number of the current DoF
 
void reset ()
 reset iterator to the first position
 

Protected Member Functions

const DofIteratorImp & asImp () const
 
DofIteratorImp & asImp ()
 

Static Protected Member Functions

static const DofIteratorImp & asImp (const ThisType &other)
 
static DofIteratorImp & asImp (ThisType &other)
 

Detailed Description

template<class DofImp, class DofIteratorImp>
class Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >

interface for DoF iterators of discrete functions

The DoF iterator is an efficient way of walking through the DoFs of a discrete function.

Member Typedef Documentation

◆ DofIteratorType

template<class DofImp , class DofIteratorImp >
typedef DofIteratorImp Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::DofIteratorType

type of the implementation (Barton-Nackman)

◆ DofType

template<class DofImp , class DofIteratorImp >
typedef DofImp Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::DofType

type of the DoFs

Member Function Documentation

◆ asImp() [1/4]

DofIteratorImp & Dune::Fem::BartonNackmanInterface< DofIteratorInterface< DofImp, DofIteratorImp > , DofIteratorImp >::asImp ( )
inlineprotectedinherited

◆ asImp() [2/4]

const DofIteratorImp & Dune::Fem::BartonNackmanInterface< DofIteratorInterface< DofImp, DofIteratorImp > , DofIteratorImp >::asImp ( ) const
inlineprotectedinherited

◆ asImp() [3/4]

static const DofIteratorImp & Dune::Fem::BartonNackmanInterface< DofIteratorInterface< DofImp, DofIteratorImp > , DofIteratorImp >::asImp ( const ThisType other)
inlinestaticprotectedinherited

◆ asImp() [4/4]

static DofIteratorImp & Dune::Fem::BartonNackmanInterface< DofIteratorInterface< DofImp, DofIteratorImp > , DofIteratorImp >::asImp ( ThisType other)
inlinestaticprotectedinherited

◆ index()

template<class DofImp , class DofIteratorImp >
int Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::index ( ) const
inline

get the global number of the current DoF

Returns
global number of the current DoF

◆ operator!=()

template<class DofImp , class DofIteratorImp >
bool Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator!= ( const DofIteratorType other) const
inline

check for inequality

Parameters
[in]otherDoF iterator to compare this one to
Returns
true if the iterators are the different, false otherewise

◆ operator*() [1/2]

template<class DofImp , class DofIteratorImp >
DofType & Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator* ( )
inline

obtain reference to current DoF

Returns
a reference to the current DoF

◆ operator*() [2/2]

template<class DofImp , class DofIteratorImp >
const DofType & Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator* ( ) const
inline

obtain reference to current DoF

Returns
a constant reference to the current DoF

◆ operator++()

template<class DofImp , class DofIteratorImp >
DofIteratorType & Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator++ ( )
inline

increment the iterator

Lets the iterator point to the next DoF.

Returns
reference the the incremented iterator (i.e., *this)

◆ operator=()

template<class DofImp , class DofIteratorImp >
DofIteratorType & Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator= ( const DofIteratorType other)
inline

assign another DoF iterator to this one

Parameters
[in]otherDoF iterator to copy

◆ operator==()

template<class DofImp , class DofIteratorImp >
bool Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator== ( const DofIteratorType other) const
inline

check for equality

Parameters
[in]otherDoF iterator to compare this one to
Returns
true if the iterators are the same, false otherewise

◆ operator[]() [1/2]

template<class DofImp , class DofIteratorImp >
DofImp & Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator[] ( const int  n)
inline

◆ operator[]() [2/2]

template<class DofImp , class DofIteratorImp >
const DofImp & Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::operator[] ( const int  n) const
inline

◆ reset()

template<class DofImp , class DofIteratorImp >
void Dune::Fem::DofIteratorInterface< DofImp, DofIteratorImp >::reset ( )
inline

reset iterator to the first position


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