dune-alugrid 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl > Class Template Reference

Class that wraps IntersectionIteratorImp of a grid and gets it's internal object from a object stack hold by the grid. More...

#include <dune/alugrid/common/intersectioniteratorwrapper.hh>

Inheritance diagram for Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >:
Inheritance graph

Public Types

enum  { dimension = dim }
 dimension More...
 
enum  { dimensionworld = dimworld }
 dimensionworld More...
 
typedef GridImp::ctype ctype
 define type used for coordinates in grid module
 
typedef GridImp::template Codim< 0 >::Entity Entity
 Entity type.
 
typedef GridImp::template Codim< 1 >::Geometry Geometry
 type of intersectionGlobal
 
typedef GridImp::template Codim< 1 >::LocalGeometry LocalGeometry
 type of intersection*Local
 
typedef FieldVector< ctype, dimworld > NormalType
 type of normal vector
 
typedef IntersectionIteratorImpl::Twists Twists
 
typedef Twists::Twist Twist
 

Public Member Functions

 IntersectionIteratorWrapper ()
 
template<class EntityImp >
 IntersectionIteratorWrapper (const GridImp &grid, const EntityImp &en, int wLevel, bool end)
 constructor called from the ibegin and iend method
 
 operator bool () const
 
bool equals (const ThisType &other) const
 the equality method
 
void increment ()
 increment iterator
 
Entity outside () const
 access neighbor
 
Entity inside () const
 access entity where iteration started
 
bool boundary () const
 
bool neighbor () const
 return true if across the intersection a neighbor on this level exists
 
int boundaryId () const
 return information about the Boundary
 
size_t boundarySegmentIndex () const
 return the boundary segment index
 
int segmentId () const
 return the segment index (non-consecutive)
 
LocalGeometry geometryInInside () const
 
Geometry geometry () const
 
GeometryType type () const
 obtain the type of reference element for this intersection
 
int indexInInside () const
 
LocalGeometry geometryInOutside () const
 
int indexInOutside () const
 
Twist twistInInside () const
 twist of the face seen from the inner element
 
Twist twistInOutside () const
 twist of the face seen from the outer element
 
const NormalType unitOuterNormal (const FieldVector< ctype, dim-1 > &local) const
 
const NormalType centerUnitOuterNormal () const
 
const NormalType outerNormal (const FieldVector< ctype, dim-1 > &local) const
 
const NormalType integrationOuterNormal (const FieldVector< ctype, dim-1 > &local) const
 
int level () const
 return level of iterator
 
bool conforming () const
 return true if intersection is conform (i.e. only one neighbor)
 
IntersectionIteratorImp & it ()
 returns reference to underlying intersection iterator implementation
 
const IntersectionIteratorImp & it () const
 
int weight () const
 return weight associated with graph edge between the neighboring elements
 

Detailed Description

template<class GridImp, class IntersectionIteratorImpl>
class Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >

Class that wraps IntersectionIteratorImp of a grid and gets it's internal object from a object stack hold by the grid.

Member Typedef Documentation

◆ ctype

template<class GridImp , class IntersectionIteratorImpl >
typedef GridImp::ctype Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::ctype

define type used for coordinates in grid module

◆ Entity

template<class GridImp , class IntersectionIteratorImpl >
typedef GridImp::template Codim<0>::Entity Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::Entity

Entity type.

◆ Geometry

template<class GridImp , class IntersectionIteratorImpl >
typedef GridImp::template Codim<1>::Geometry Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::Geometry

type of intersectionGlobal

◆ LocalGeometry

template<class GridImp , class IntersectionIteratorImpl >
typedef GridImp::template Codim<1>::LocalGeometry Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::LocalGeometry

type of intersection*Local

◆ NormalType

template<class GridImp , class IntersectionIteratorImpl >
typedef FieldVector<ctype , dimworld> Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::NormalType

type of normal vector

◆ Twist

template<class GridImp , class IntersectionIteratorImpl >
typedef Twists::Twist Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::Twist

◆ Twists

template<class GridImp , class IntersectionIteratorImpl >
typedef IntersectionIteratorImpl::Twists Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::Twists

Member Enumeration Documentation

◆ anonymous enum

template<class GridImp , class IntersectionIteratorImpl >
anonymous enum

dimension

Enumerator
dimension 

◆ anonymous enum

template<class GridImp , class IntersectionIteratorImpl >
anonymous enum

dimensionworld

Enumerator
dimensionworld 

Constructor & Destructor Documentation

◆ IntersectionIteratorWrapper() [1/2]

template<class GridImp , class IntersectionIteratorImpl >
Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::IntersectionIteratorWrapper ( )
inline

◆ IntersectionIteratorWrapper() [2/2]

template<class GridImp , class IntersectionIteratorImpl >
template<class EntityImp >
Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::IntersectionIteratorWrapper ( const GridImp &  grid,
const EntityImp &  en,
int  wLevel,
bool  end 
)
inline

constructor called from the ibegin and iend method

Member Function Documentation

◆ boundary()

template<class GridImp , class IntersectionIteratorImpl >
bool Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::boundary ( ) const
inline

return true if intersection is with boundary.

Todo:
connection with boundary information, processor/outer boundary

◆ boundaryId()

template<class GridImp , class IntersectionIteratorImpl >
int Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::boundaryId ( ) const
inline

return information about the Boundary

◆ boundarySegmentIndex()

template<class GridImp , class IntersectionIteratorImpl >
size_t Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::boundarySegmentIndex ( ) const
inline

return the boundary segment index

◆ centerUnitOuterNormal()

template<class GridImp , class IntersectionIteratorImpl >
const NormalType Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::centerUnitOuterNormal ( ) const
inline

return unit outer normal, this should be dependent on local coordinates for higher order boundary

◆ conforming()

template<class GridImp , class IntersectionIteratorImpl >
bool Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::conforming ( ) const
inline

return true if intersection is conform (i.e. only one neighbor)

◆ equals()

template<class GridImp , class IntersectionIteratorImpl >
bool Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::equals ( const ThisType &  other) const
inline

the equality method

◆ geometry()

template<class GridImp , class IntersectionIteratorImpl >
Geometry Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::geometry ( ) const
inline

intersection of codimension 1 of this neighbor with element where iteration started. Here returned element is in GLOBAL coordinates of the element where iteration started.

◆ geometryInInside()

template<class GridImp , class IntersectionIteratorImpl >
LocalGeometry Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::geometryInInside ( ) const
inline

intersection of codimension 1 of this neighbor with element where iteration started. Here returned element is in LOCAL coordinates of the element where iteration started.

◆ geometryInOutside()

template<class GridImp , class IntersectionIteratorImpl >
LocalGeometry Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::geometryInOutside ( ) const
inline

intersection of codimension 1 of this neighbor with element where iteration started. Here returned element is in LOCAL coordinates of neighbor

◆ increment()

template<class GridImp , class IntersectionIteratorImpl >
void Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::increment ( )
inline

increment iterator

◆ indexInInside()

template<class GridImp , class IntersectionIteratorImpl >
int Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::indexInInside ( ) const
inline

local index of codim 1 entity in self where intersection is contained in

◆ indexInOutside()

template<class GridImp , class IntersectionIteratorImpl >
int Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::indexInOutside ( ) const
inline

local index of codim 1 entity in neighbor where intersection is contained

◆ inside()

template<class GridImp , class IntersectionIteratorImpl >
Entity Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::inside ( ) const
inline

access entity where iteration started

◆ integrationOuterNormal()

template<class GridImp , class IntersectionIteratorImpl >
const NormalType Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::integrationOuterNormal ( const FieldVector< ctype, dim-1 > &  local) const
inline

return outer normal, this should be dependent on local coordinates for higher order boundary

◆ it() [1/2]

template<class GridImp , class IntersectionIteratorImpl >
IntersectionIteratorImp & Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::it ( )
inline

returns reference to underlying intersection iterator implementation

◆ it() [2/2]

template<class GridImp , class IntersectionIteratorImpl >
const IntersectionIteratorImp & Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::it ( ) const
inline

◆ level()

template<class GridImp , class IntersectionIteratorImpl >
int Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::level ( ) const
inline

return level of iterator

◆ neighbor()

template<class GridImp , class IntersectionIteratorImpl >
bool Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::neighbor ( ) const
inline

return true if across the intersection a neighbor on this level exists

◆ operator bool()

template<class GridImp , class IntersectionIteratorImpl >
Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::operator bool ( ) const
inline

◆ outerNormal()

template<class GridImp , class IntersectionIteratorImpl >
const NormalType Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::outerNormal ( const FieldVector< ctype, dim-1 > &  local) const
inline

return outer normal, this should be dependent on local coordinates for higher order boundary

◆ outside()

template<class GridImp , class IntersectionIteratorImpl >
Entity Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::outside ( ) const
inline

access neighbor

◆ segmentId()

template<class GridImp , class IntersectionIteratorImpl >
int Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::segmentId ( ) const
inline

return the segment index (non-consecutive)

◆ twistInInside()

template<class GridImp , class IntersectionIteratorImpl >
Twist Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::twistInInside ( ) const
inline

twist of the face seen from the inner element

◆ twistInOutside()

template<class GridImp , class IntersectionIteratorImpl >
Twist Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::twistInOutside ( ) const
inline

twist of the face seen from the outer element

◆ type()

template<class GridImp , class IntersectionIteratorImpl >
GeometryType Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::type ( ) const
inline

obtain the type of reference element for this intersection

◆ unitOuterNormal()

template<class GridImp , class IntersectionIteratorImpl >
const NormalType Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::unitOuterNormal ( const FieldVector< ctype, dim-1 > &  local) const
inline

return unit outer normal, this should be dependent on local coordinates for higher order boundary

◆ weight()

template<class GridImp , class IntersectionIteratorImpl >
int Dune::IntersectionIteratorWrapper< GridImp, IntersectionIteratorImpl >::weight ( ) const
inline

return weight associated with graph edge between the neighboring elements

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.6