dune-grid  2.2.0
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp > Class Template Reference

Mesh entities of codimension 0 ("elements") allow to visit all intersections with "neighboring" elements and with the domain boundary. More...

#include <dune/grid/common/intersectioniterator.hh>

List of all members.

Public Types

typedef Dune::Intersection
< const GridImp,
IntersectionImp > 
Intersection
 Type of Intersection this IntersectionIterator points to.
typedef remove_const< GridImp >
::type 
mutableGridImp

Public Member Functions

IntersectionIteratoroperator++ ()
 Preincrement operator. Proceed to next intersection.
Dereferencing
const Intersectionoperator* () const
 Dereferencing operator.
const Intersectionoperator-> () const
 Pointer operator.
Compare methods
bool operator== (const IntersectionIterator &rhs) const
 Checks for equality. Only Iterators pointing to the same intersection from the same Entity are equal. Pointing to the same intersection from neighbor is unequal as inside and outside are permuted.
bool operator!= (const IntersectionIterator &rhs) const
 Checks for inequality. Only Iterators pointing to the same intersection from the same Entity are equal. Pointing to the same intersection from neighbor is unequal as inside and outside are permuted.
Implementor interface
bool equals (const IntersectionIterator &rhs) const
 forward equality check to realIterator
 IntersectionIterator (const IntersectionIteratorImp< const GridImp > &i)
 IntersectionIterator (const IntersectionIterator &i)

Protected Types

typedef
IntersectionIteratorImp< const
GridImp > 
Implementation

Protected Member Functions

Implementationimpl ()
 return reference to the real implementation
const Implementationimpl () const
 return reference to the real implementation

Protected Attributes

Implementation realIterator

Friends

class GridDefaultImplementation< GridImp::dimension, GridImp::dimensionworld, typename GridImp::ctype, typename GridImp::GridFamily >

Detailed Description

template<class GridImp, template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
class Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >

Mesh entities of codimension 0 ("elements") allow to visit all intersections with "neighboring" elements and with the domain boundary.

Template parameters are:

Warning:
the IntersectionIterator used to be both, Intersection and IntersectionIterator, at the same time. The two concepts are now properly separated. The IntersectionIterator still offers the old methods, but these are forwarded to the Intersection. All these methods are now marked deprecated.
Deprecated:
All Intersection methods on the IntersectionIterator are deprecated, dereference IntersectionIterator to get the Intersection and call methods there.
Warning:
The number of neigbors may be different from the number of faces/edges of an element!

Overview

Intersections are codimension 1 objects. These intersections are accessed via an IntersectionIterator. This allows the implementation of non-matching grids, as one face can now consist of several intersections. In a conforming mesh such an intersection corresponds to an entity of codimension 1 but in the general non-conforming case there will be no entity in the mesh that directly corresponds to the intersection. Thus, the IntersectionIterator describes these intersections implicitly.

Engine Concept

The IntersectionIterator class template wraps an object of type IntersectionIteratorImp and forwards all member function calls to corresponding members of this class. In that sense IntersectionIterator defines the interface and IntersectionIteratorImp supplies the implementation.

Intersections, leaf grid and level grid

On an entity e of codimension zero there are two ways to create IntersectionIterators by either using ilevelbegin() / ilevelend() or ileafbegin()/ileafend(). In the first case intersections with neighboring entities having the same level as e are traversed; in the second case ileafbegin()==ileafend() if e is not a leaf otherwise all intersections with neighboring leaf entities are traversed.

Consider a situation where two elements a and b have a common intersection. Element b has been refined into an element c and d, while a has not been refined. In one space dimension this situation is depicted in the figure below.

islocalref.png
IntersectionIterator in a locally refined mesh.

Here the rule is the following: The LevelIntersectionIterator delivers all intersections with elements on the same level, the LeafIntersectionIterator delivers the intersections with all leaf elements if it has been started on a leaf element. Both iterators also stop at intersections with the grid boundary. According to this rule the level intersection iterator started at element a in the example above delivers an intersection with b and the left grid boundary, whereas the leaf intersection iterator returns c instead of b. Starting on entity c the level intersection iterator returns d and the intersection with the left boundary of the level 1 grid, but the leaf intersection iterator returns both d and a. Finally, starting on b the level intersection iterator returns a and the right boundary, but the leaf intersection iterator is empty since b is not a leaf entity of the grid. Starting on d both the level and the leaf intersection iterators will return the element c together with the right grid boundary.


Member Typedef Documentation

template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
typedef IntersectionIteratorImp< const GridImp > Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::Implementation
protected
template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
typedef Dune::Intersection< const GridImp, IntersectionImp > Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::Intersection

Type of Intersection this IntersectionIterator points to.

template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
typedef remove_const<GridImp>::type Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::mutableGridImp

Constructor & Destructor Documentation

template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::IntersectionIterator ( const IntersectionIteratorImp< const GridImp > &  i)
inline

Copy Constructor from IntersectionIteratorImp

template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::IntersectionIterator ( const IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp > &  i)
inline

Copy constructor


Member Function Documentation

template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
bool Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::equals ( const IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp > &  rhs) const
inline
template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
Implementation& Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::impl ( )
inlineprotected
template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
const Implementation& Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::impl ( ) const
inlineprotected
template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
bool Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::operator!= ( const IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp > &  rhs) const
inline

Checks for inequality. Only Iterators pointing to the same intersection from the same Entity are equal. Pointing to the same intersection from neighbor is unequal as inside and outside are permuted.

References Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::equals().

template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
const Intersection& Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::operator* ( ) const
inline
template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
IntersectionIterator& Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::operator++ ( )
inline

Preincrement operator. Proceed to next intersection.

References Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::realIterator.

template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
const Intersection* Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::operator-> ( ) const
inline
template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
bool Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::operator== ( const IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp > &  rhs) const
inline

Checks for equality. Only Iterators pointing to the same intersection from the same Entity are equal. Pointing to the same intersection from neighbor is unequal as inside and outside are permuted.

References Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::equals().


Friends And Related Function Documentation

template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
friend class GridDefaultImplementation< GridImp::dimension, GridImp::dimensionworld,typename GridImp::ctype,typename GridImp::GridFamily >
friend

Member Data Documentation

template<class GridImp , template< class > class IntersectionIteratorImp, template< class > class IntersectionImp>
Implementation Dune::IntersectionIterator< GridImp, IntersectionIteratorImp, IntersectionImp >::realIterator
protected

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