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

#include <dune/grid/yaspgrid.hh>

Inheritance diagram for Dune::YaspIntersectionIterator< GridImp >:
Dune::MakeableInterfaceObject< Dune::Intersection< const GridImp, Dune::YaspIntersection > > Dune::Intersection< const GridImp, Dune::YaspIntersection >

List of all members.

Public Types

typedef Dune::Intersection
< const GridImp,
Dune::YaspIntersection
Intersection
typedef
MakeableInterfaceObject
< Intersection
MakeableIntersection
typedef Dune::Intersection
< const GridImp,
Dune::YaspIntersection >
::Implementation 
ImplementationType
enum  
 Export codim of intersection (always 1) More...
enum  
 Export grid dimension. More...
enum  
 Export dimension of the intersection. More...
enum  
 Export dimension of world. More...
typedef const
GridImp::template Codim
< 0 >::Entity 
Entity
 Type of entity that this Intersection belongs to.
typedef const
GridImp::template Codim
< 0 >::EntityPointer 
EntityPointer
 Pointer to the type of entities that this Intersection belongs to.
typedef const
GridImp::template Codim
< 1 >::Geometry 
Geometry
 Codim 1 geometry returned by geometry()
typedef Geometry::LocalCoordinate LocalCoordinate
 local coordinate type used as parameter for the normals
typedef Geometry::GlobalCoordinate GlobalCoordinate
 global coordinate type used as parameter for the normals
typedef const
GridImp::template Codim
< 1 >::LocalGeometry 
LocalGeometry
 Codim 1 geometry returned by geometryInInside and geometryInOutside()
typedef remove_const< const
GridImp >::type 
mutableGridImp

Public Member Functions

void increment ()
 increment
bool equals (const YaspIntersectionIterator &other) const
 equality
const Intersectiondereference () const
 dereferencing
 YaspIntersectionIterator (const YaspEntity< 0, dim, GridImp > &myself, bool toend)
 make intersection iterator from entity
 YaspIntersectionIterator (const YaspIntersectionIterator &it)
 copy constructor
YaspIntersectionIteratoroperator= (const YaspIntersectionIterator &it)
 assignment
bool boundary () const
 return true if intersection is with interior or exterior boundary (see the cases above)
int boundaryId () const
 Identifier for boundary segment from macro grid.
size_t boundarySegmentIndex () const
 index of the boundary segment within the macro grid
bool neighbor () const
 return true if intersection is shared with another element.
EntityPointer inside () const
 return EntityPointer to the Entity on the inside of this intersection. That is the Entity where we started this .
EntityPointer outside () const
 return EntityPointer to the Entity on the outside of this intersection. That is the neighboring Entity.
bool conforming () const
 return true if intersection is conform.
LocalGeometry geometryInInside () const
 geometrical information about this intersection in local coordinates of the inside() entity.
LocalGeometry geometryInOutside () const
 geometrical information about this intersection in local coordinates of the outside() entity.
Geometry geometry () const
 geometrical information about the intersection in global coordinates.
GeometryType type () const
 obtain the type of reference element for this intersection
int indexInInside () const
 Local index of codim 1 entity in the inside() entity where intersection is contained in.
int indexInOutside () const
 Local index of codim 1 entity in outside() entity where intersection is contained in.
GlobalCoordinate outerNormal (const LocalCoordinate &local) const
 Return an outer normal (length not necessarily 1)
GlobalCoordinate integrationOuterNormal (const LocalCoordinate &local) const
 return outer normal scaled with the integration element
GlobalCoordinate unitOuterNormal (const LocalCoordinate &local) const
 Return unit outer normal (length == 1)
GlobalCoordinate centerUnitOuterNormal () const
 Return unit outer normal (length == 1)

Protected Types

enum  
enum  
typedef Dune::YaspIntersection
< const 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 real

Friends

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

Detailed Description

template<class GridImp>
class Dune::YaspIntersectionIterator< GridImp >

YaspIntersectionIterator enables iteration over intersection with neighboring codim 0 entities.


Member Typedef Documentation

typedef const GridImp ::template Codim<0>::Entity Dune::Intersection< const GridImp , Dune::YaspIntersection >::Entity [inherited]

Type of entity that this Intersection belongs to.

typedef const GridImp ::template Codim<0>::EntityPointer Dune::Intersection< const GridImp , Dune::YaspIntersection >::EntityPointer [inherited]

Pointer to the type of entities that this Intersection belongs to.

typedef const GridImp ::template Codim<1>::Geometry Dune::Intersection< const GridImp , Dune::YaspIntersection >::Geometry [inherited]

Codim 1 geometry returned by geometry()

global coordinate type used as parameter for the normals

typedef Dune::YaspIntersection < const const GridImp > Dune::Intersection< const GridImp , Dune::YaspIntersection >::Implementation [protected, inherited]
template<class GridImp >
typedef Dune::Intersection<const GridImp, Dune::YaspIntersection> Dune::YaspIntersectionIterator< GridImp >::Intersection

local coordinate type used as parameter for the normals

typedef const GridImp ::template Codim<1>::LocalGeometry Dune::Intersection< const GridImp , Dune::YaspIntersection >::LocalGeometry [inherited]

Codim 1 geometry returned by geometryInInside and geometryInOutside()

typedef remove_const<const GridImp >::type Dune::Intersection< const GridImp , Dune::YaspIntersection >::mutableGridImp [inherited]

Member Enumeration Documentation

anonymous enum [protected, inherited]
anonymous enum [protected, inherited]
anonymous enum [inherited]

Export codim of intersection (always 1)

anonymous enum [inherited]

Export grid dimension.

anonymous enum [inherited]

Export dimension of the intersection.

anonymous enum [inherited]

Export dimension of world.


Constructor & Destructor Documentation

template<class GridImp >
Dune::YaspIntersectionIterator< GridImp >::YaspIntersectionIterator ( const YaspEntity< 0, dim, GridImp > &  myself,
bool  toend 
) [inline]

make intersection iterator from entity

template<class GridImp >
Dune::YaspIntersectionIterator< GridImp >::YaspIntersectionIterator ( const YaspIntersectionIterator< GridImp > &  it) [inline]

copy constructor


Member Function Documentation

bool Dune::Intersection< const GridImp , Dune::YaspIntersection >::boundary ( ) const [inline, inherited]

return true if intersection is with interior or exterior boundary (see the cases above)

int Dune::Intersection< const GridImp , Dune::YaspIntersection >::boundaryId ( ) const [inline, inherited]

Identifier for boundary segment from macro grid.

One can attach a boundary Id to a boundary segment on the macro grid. This Id will also be used for all fragments of these boundary segments.

The numbering is defined as:

  • Id==0 for all intersections without boundary()==false
  • Id>=0 for all intersections without boundary()==true

The way the Identifiers are attached to the grid may differ between the different grid implementations.

Deprecated:
size_t Dune::Intersection< const GridImp , Dune::YaspIntersection >::boundarySegmentIndex ( ) const [inline, inherited]

index of the boundary segment within the macro grid

In many applications, special data needs to be attached to the boundary segments of the macro grid (e.g., a function selecting the boundary condition). Usually, this data is inherited by the children of the boundary segment.

In the DUNE framework, data is stored in arrays, addressed by an index, in this case the boundarySegmentIndex. The size of these arrays can be obtained by the Grid::numBoundarySegments.

GlobalCoordinate Dune::Intersection< const GridImp , Dune::YaspIntersection >::centerUnitOuterNormal ( ) const [inline, inherited]

Return unit outer normal (length == 1)

The returned vector is the normal at the center() of the intersection's geometry. It is scaled to have unit length.

bool Dune::Intersection< const GridImp , Dune::YaspIntersection >::conforming ( ) const [inline, inherited]

return true if intersection is conform.

This method returns true, if

      inside()->entity<1>(numberInSelf()) == 
          outside()->entity<1>(numberInNeighbor()) ||
      boundary()

holds.

template<class GridImp >
const Intersection& Dune::YaspIntersectionIterator< GridImp >::dereference ( ) const [inline]

dereferencing

template<class GridImp >
bool Dune::YaspIntersectionIterator< GridImp >::equals ( const YaspIntersectionIterator< GridImp > &  other) const [inline]

equality

Geometry Dune::Intersection< const GridImp , Dune::YaspIntersection >::geometry ( ) const [inline, inherited]

geometrical information about the intersection in global coordinates.

This method returns a Geometry object that provides a mapping from local coordinates of the intersection to global (world) coordinates.

Note:
Previously, the geometry was encapsulated in the intersection object and a const reference was returned.
The returned geometry object is guaranteed to remain valid until the grid is modified (or deleted).
LocalGeometry Dune::Intersection< const GridImp , Dune::YaspIntersection >::geometryInInside ( ) const [inline, inherited]

geometrical information about this intersection in local coordinates of the inside() entity.

This method returns a Geometry object that provides a mapping from local coordinates of the intersection to local coordinates of the inside() entity.

Note:
Previously, the geometry was encapsulated in the intersection object and a const reference was returned.
The returned geometry object is guaranteed to remain valid until the grid is modified (or deleted).
LocalGeometry Dune::Intersection< const GridImp , Dune::YaspIntersection >::geometryInOutside ( ) const [inline, inherited]

geometrical information about this intersection in local coordinates of the outside() entity.

This method returns a Geometry object that provides a mapping from local coordinates of the intersection to local coordinates of the outside() entity.

Note:
Previously, the geometry was encapsulated in the intersection object and a const reference was returned.
The returned geometry object is guaranteed to remain valid until the grid is modified (or deleted).
Implementation& Dune::Intersection< const GridImp , Dune::YaspIntersection >::impl ( ) [inline, protected, inherited]

return reference to the real implementation

const Implementation& Dune::Intersection< const GridImp , Dune::YaspIntersection >::impl ( ) const [inline, protected, inherited]

return reference to the real implementation

template<class GridImp >
void Dune::YaspIntersectionIterator< GridImp >::increment ( ) [inline]

increment

int Dune::Intersection< const GridImp , Dune::YaspIntersection >::indexInInside ( ) const [inline, inherited]

Local index of codim 1 entity in the inside() entity where intersection is contained in.

Note:
This method returns the face number with respect to the generic reference element.
Returns:
the index of the inside entity's face containing this intersection (with respect to the generic reference element)
int Dune::Intersection< const GridImp , Dune::YaspIntersection >::indexInOutside ( ) const [inline, inherited]

Local index of codim 1 entity in outside() entity where intersection is contained in.

Note:
This method returns the face number with respect to the generic reference element.
Returns:
the index of the outside entity's face containing this intersection (with respect to the generic reference element)
EntityPointer Dune::Intersection< const GridImp , Dune::YaspIntersection >::inside ( ) const [inline, inherited]

return EntityPointer to the Entity on the inside of this intersection. That is the Entity where we started this .

GlobalCoordinate Dune::Intersection< const GridImp , Dune::YaspIntersection >::integrationOuterNormal ( const LocalCoordinate local) const [inline, inherited]

return outer normal scaled with the integration element

Return an outer normal (length not necessarily 1)

The returned vector may depend on local position within the intersection.

The normal is scaled with the integration element of the intersection. This method is redundant but it may be more efficent to use this function rather than computing the integration element via intersectionGlobal().

bool Dune::Intersection< const GridImp , Dune::YaspIntersection >::neighbor ( ) const [inline, inherited]

return true if intersection is shared with another element.

template<class GridImp >
YaspIntersectionIterator& Dune::YaspIntersectionIterator< GridImp >::operator= ( const YaspIntersectionIterator< GridImp > &  it) [inline]

assignment

GlobalCoordinate Dune::Intersection< const GridImp , Dune::YaspIntersection >::outerNormal ( const LocalCoordinate local) const [inline, inherited]

Return an outer normal (length not necessarily 1)

The returned vector may depend on local position within the intersection.

EntityPointer Dune::Intersection< const GridImp , Dune::YaspIntersection >::outside ( ) const [inline, inherited]

return EntityPointer to the Entity on the outside of this intersection. That is the neighboring Entity.

Warning:
Don't call this method if there is no neighboring Entity (neighbor() returns false). In this case the result is undefined.
GeometryType Dune::Intersection< const GridImp , Dune::YaspIntersection >::type ( ) const [inline, inherited]

obtain the type of reference element for this intersection

GlobalCoordinate Dune::Intersection< const GridImp , Dune::YaspIntersection >::unitOuterNormal ( const LocalCoordinate local) const [inline, inherited]

Return unit outer normal (length == 1)

The returned vector may depend on the local position within the intersection. It is scaled to have unit length.


Friends And Related Function Documentation

friend class GridDefaultImplementation< const GridImp ::dimension, const GridImp ::dimensionworld,typename const GridImp ::ctype,typename const GridImp ::GridFamily > [friend, inherited]
friend class IntersectionIterator< const GridImp , Dune::YaspIntersection , Dune::YaspIntersection > [friend, inherited]

give the pseudo IntersectionIterator class access to the realImp

Todo:
cleanup this hack

Member Data Documentation

Implementation Dune::Intersection< const GridImp , Dune::YaspIntersection >::real [protected, inherited]

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