dune-pdelab  2.5-dev
Public Types | Public Member Functions | List of all members
Dune::PDELab::IntersectionGeometry< I > Class Template Reference

Wrap intersection. More...

#include <dune/pdelab/common/geometrywrapper.hh>

Public Types

enum  { mydimension =I::mydimension }
 Dimension of the domain space of the geometry. More...
 
enum  { coorddimension =Geometry::coorddimension }
 Dimension of the image space of the geometry. More...
 
typedef I::Geometry Geometry
 
typedef I::LocalGeometry LocalGeometry
 
typedef I::Entity Entity
 
typedef Geometry::ctype ctype
 

Public Member Functions

 IntersectionGeometry (const I &i_, unsigned int index_)
 
int insideDomainIndex () const
 
int outsideDomainIndex () const
 
bool boundary () const
 return true if intersection is with interior or exterior boundary (see the cases above) More...
 
bool neighbor () const
 return true if intersection is shared with another element. More...
 
LocalGeometry geometryInInside () const
 geometrical information about this intersection in local coordinates of the inside() entity. More...
 
LocalGeometry geometryInOutside () const
 geometrical information about this intersection in local coordinates of the outside() entity. More...
 
Geometry geometry () const
 geometrical information about this intersection in global coordinates. More...
 
int indexInInside () const
 Local number of codim 1 entity in the inside() Entity where intersection is contained in. More...
 
int indexInOutside () const
 Local number of codim 1 entity in outside() Entity where intersection is contained in. More...
 
Dune::FieldVector< ctype, coorddimensionouterNormal (const Dune::FieldVector< ctype, mydimension > &local) const
 Return an outer normal (length not necessarily 1) More...
 
Dune::FieldVector< ctype, coorddimensionintegrationOuterNormal (const Dune::FieldVector< ctype, mydimension > &local) const
 return outer normal scaled with the integration element More...
 
Dune::FieldVector< ctype, coorddimensionunitOuterNormal (const Dune::FieldVector< ctype, mydimension > &local) const
 Return unit outer normal (length == 1) More...
 
Dune::FieldVector< ctype, coorddimensioncenterUnitOuterNormal () const
 Return unit outer normal (length == 1) More...
 
Entity inside () const
 return Entity on the inside of this intersection. That is the Entity where we started this. More...
 
Entity insideHostEntity () const
 return Entity on the inside of this intersection. That is the Entity where we started this. More...
 
Entity outside () const
 return Entity on the outside of this intersection. That is the neighboring Entity. More...
 
const I & intersection () const
 
unsigned int intersectionIndex () const
 

Detailed Description

template<typename I>
class Dune::PDELab::IntersectionGeometry< I >

Wrap intersection.

Todo:
Please doc me!

Member Typedef Documentation

◆ ctype

template<typename I>
typedef Geometry::ctype Dune::PDELab::IntersectionGeometry< I >::ctype
Todo:
Please doc me!

◆ Entity

template<typename I>
typedef I::Entity Dune::PDELab::IntersectionGeometry< I >::Entity
Todo:
Please doc me!

◆ Geometry

template<typename I>
typedef I::Geometry Dune::PDELab::IntersectionGeometry< I >::Geometry
Todo:
Please doc me!

◆ LocalGeometry

template<typename I>
typedef I::LocalGeometry Dune::PDELab::IntersectionGeometry< I >::LocalGeometry
Todo:
Please doc me!

Member Enumeration Documentation

◆ anonymous enum

template<typename I>
anonymous enum

Dimension of the domain space of the geometry.

Enumerator
mydimension 

◆ anonymous enum

template<typename I>
anonymous enum

Dimension of the image space of the geometry.

Enumerator
coorddimension 

Constructor & Destructor Documentation

◆ IntersectionGeometry()

template<typename I>
Dune::PDELab::IntersectionGeometry< I >::IntersectionGeometry ( const I &  i_,
unsigned int  index_ 
)
inline
Todo:
Please doc me!

Member Function Documentation

◆ boundary()

template<typename I>
bool Dune::PDELab::IntersectionGeometry< I >::boundary ( ) const
inline

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

◆ centerUnitOuterNormal()

template<typename I>
Dune::FieldVector<ctype, coorddimension> Dune::PDELab::IntersectionGeometry< I >::centerUnitOuterNormal ( ) const
inline

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.

◆ geometry()

template<typename I>
Geometry Dune::PDELab::IntersectionGeometry< I >::geometry ( ) const
inline

geometrical information about this intersection in global coordinates.

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

◆ geometryInInside()

template<typename I>
LocalGeometry Dune::PDELab::IntersectionGeometry< I >::geometryInInside ( ) const
inline

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.

◆ geometryInOutside()

template<typename I>
LocalGeometry Dune::PDELab::IntersectionGeometry< I >::geometryInOutside ( ) const
inline

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.

◆ indexInInside()

template<typename I>
int Dune::PDELab::IntersectionGeometry< I >::indexInInside ( ) const
inline

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

◆ indexInOutside()

template<typename I>
int Dune::PDELab::IntersectionGeometry< I >::indexInOutside ( ) const
inline

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

◆ inside()

template<typename I>
Entity Dune::PDELab::IntersectionGeometry< I >::inside ( ) const
inline

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

◆ insideDomainIndex()

template<typename I>
int Dune::PDELab::IntersectionGeometry< I >::insideDomainIndex ( ) const
inline
Todo:
Please doc me!

◆ insideHostEntity()

template<typename I>
Entity Dune::PDELab::IntersectionGeometry< I >::insideHostEntity ( ) const
inline

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

◆ integrationOuterNormal()

template<typename I>
Dune::FieldVector<ctype, coorddimension> Dune::PDELab::IntersectionGeometry< I >::integrationOuterNormal ( const Dune::FieldVector< ctype, mydimension > &  local) const
inline

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().

◆ intersection()

template<typename I>
const I& Dune::PDELab::IntersectionGeometry< I >::intersection ( ) const
inline
Todo:
Please doc me!

◆ intersectionIndex()

template<typename I>
unsigned int Dune::PDELab::IntersectionGeometry< I >::intersectionIndex ( ) const
inline

◆ neighbor()

template<typename I>
bool Dune::PDELab::IntersectionGeometry< I >::neighbor ( ) const
inline

return true if intersection is shared with another element.

◆ outerNormal()

template<typename I>
Dune::FieldVector<ctype, coorddimension> Dune::PDELab::IntersectionGeometry< I >::outerNormal ( const Dune::FieldVector< ctype, mydimension > &  local) const
inline

Return an outer normal (length not necessarily 1)

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

◆ outside()

template<typename I>
Entity Dune::PDELab::IntersectionGeometry< I >::outside ( ) const
inline

return 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.

◆ outsideDomainIndex()

template<typename I>
int Dune::PDELab::IntersectionGeometry< I >::outsideDomainIndex ( ) const
inline
Todo:
Please doc me!

◆ unitOuterNormal()

template<typename I>
Dune::FieldVector<ctype, coorddimension> Dune::PDELab::IntersectionGeometry< I >::unitOuterNormal ( const Dune::FieldVector< ctype, mydimension > &  local) const
inline

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.


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