Public Member Functions | Protected Types | Protected Attributes | List of all members
Dune::PolyhedralGridEntityBasic< codim, dim, Grid > Class Template Reference

More...

#include <entity.hh>

Inheritance diagram for Dune::PolyhedralGridEntityBasic< codim, dim, Grid >:
Inheritance graph

Public Member Functions

bool equals (const PolyhedralGridEntityBasic &other) const
 

Protected Types

typedef std::remove_const< Grid >::type::Traits Traits
 
typedef Traits::ExtraData ExtraData
 

Protected Attributes

ExtraData data_
 
EntitySeed seed_
 

Types Required by DUNE

typedef Traits::ctype ctype
 coordinate type of the grid More...
 
typedef Traits::Index Index
 
typedef Grid::template Codim< codimension >::Entity Entity
 type of entity More...
 
typedef Grid::template Codim< codimension >::EntitySeed EntitySeed
 type of corresponding entity seed More...
 
typedef Traits::template Codim< codimension >::Geometry Geometry
 type of corresponding geometry More...
 
typedef Traits::template Codim< codimension >::GeometryImpl GeometryImpl
 

Attributes

static const int codimension = codim
 codimensioon of the entity More...
 
static const int dimension = Traits::dimension
 dimension of the grid More...
 
static const int mydimension = dimension - codimension
 dimension of the entity More...
 
static const int dimensionworld = Traits::dimensionworld
 dimension of the world More...
 

Construction, Initialization and Destruction

 PolyhedralGridEntityBasic ()
 construct a null entity More...
 
 PolyhedralGridEntityBasic (ExtraData data)
 construct a null entity with data pointer More...
 
 PolyhedralGridEntityBasic (ExtraData data, const EntitySeed &seed)
 construct an initialized entity More...
 

Methods Shared by Entities of All Codimensions

GeometryType type () const
 obtain the name of the corresponding reference element More...
 
int level () const
 obtain the level of this entity More...
 
PartitionType partitionType () const
 obtain the partition type of this entity More...
 
Geometry geometry () const
 
EntitySeed seed () const
 return EntitySeed More...
 

Methods Supporting the Grid Implementation

ExtraData data () const
 
Index index () const
 

Detailed Description

template<int codim, int dim, class Grid>
class Dune::PolyhedralGridEntityBasic< codim, dim, Grid >

Member Typedef Documentation

◆ ctype

template<int codim, int dim, class Grid >
typedef Traits::ctype Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::ctype

coordinate type of the grid

◆ Entity

template<int codim, int dim, class Grid >
typedef Grid::template Codim<codimension>::Entity Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::Entity

type of entity

◆ EntitySeed

template<int codim, int dim, class Grid >
typedef Grid::template Codim<codimension>::EntitySeed Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::EntitySeed

type of corresponding entity seed

◆ ExtraData

template<int codim, int dim, class Grid >
typedef Traits::ExtraData Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::ExtraData
protected

◆ Geometry

template<int codim, int dim, class Grid >
typedef Traits::template Codim<codimension>::Geometry Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::Geometry

type of corresponding geometry

◆ GeometryImpl

template<int codim, int dim, class Grid >
typedef Traits::template Codim<codimension>::GeometryImpl Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::GeometryImpl

◆ Index

template<int codim, int dim, class Grid >
typedef Traits::Index Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::Index

◆ Traits

template<int codim, int dim, class Grid >
typedef std::remove_const<Grid>::type::Traits Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::Traits
protected

Constructor & Destructor Documentation

◆ PolyhedralGridEntityBasic() [1/3]

template<int codim, int dim, class Grid >
Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::PolyhedralGridEntityBasic ( )
inline

construct a null entity

◆ PolyhedralGridEntityBasic() [2/3]

template<int codim, int dim, class Grid >
Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::PolyhedralGridEntityBasic ( ExtraData  data)
inlineexplicit

construct a null entity with data pointer

◆ PolyhedralGridEntityBasic() [3/3]

template<int codim, int dim, class Grid >
Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::PolyhedralGridEntityBasic ( ExtraData  data,
const EntitySeed &  seed 
)
inline

construct an initialized entity

Member Function Documentation

◆ data()

template<int codim, int dim, class Grid >
ExtraData Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::data ( ) const
inline

References Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::data_.

Referenced by Dune::PolyhedralGridEntity< 0, dim, Grid >::father(), Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::geometry(), Dune::PolyhedralGridEntity< 0, dim, Grid >::geometryInFather(), Dune::PolyhedralGridEntity< 0, dim, Grid >::hasBoundaryIntersections(), Dune::PolyhedralGridEntity< 0, dim, Grid >::hend(), Dune::PolyhedralGridEntity< 0, dim, Grid >::ibegin(), Dune::PolyhedralGridEntity< 0, dim, Grid >::iend(), Dune::PolyhedralGridEntity< codim, dim, Grid >::subEntities(), Dune::PolyhedralGridEntity< 0, dim, Grid >::subEntities(), Dune::PolyhedralGridEntity< codim, dim, Grid >::subEntity(), Dune::PolyhedralGridEntity< 0, dim, Grid >::subEntity(), and Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::type().

◆ equals()

template<int codim, int dim, class Grid >
bool Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::equals ( const PolyhedralGridEntityBasic< codim, dim, Grid > &  other) const
inline

References Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::seed_.

◆ geometry()

template<int codim, int dim, class Grid >
Geometry Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::geometry ( ) const
inline

obtain the geometry of this entity

References Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::data(), and Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::seed_.

◆ index()

template<int codim, int dim, class Grid >
Index Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::index ( ) const
inline

References Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::seed_.

◆ level()

template<int codim, int dim, class Grid >
int Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::level ( ) const
inline

obtain the level of this entity

◆ partitionType()

template<int codim, int dim, class Grid >
PartitionType Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::partitionType ( ) const
inline

obtain the partition type of this entity

◆ seed()

template<int codim, int dim, class Grid >
EntitySeed Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::seed ( ) const
inline

return EntitySeed

References Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::seed_.

Referenced by Dune::PolyhedralGridEntity< 0, dim, Grid >::hasBoundaryIntersections().

◆ type()

template<int codim, int dim, class Grid >
GeometryType Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::type ( ) const
inline

obtain the name of the corresponding reference element

This type can be used to access the DUNE reference element.

References Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::data(), and Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::seed_.

Member Data Documentation

◆ codimension

template<int codim, int dim, class Grid >
const int Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::codimension = codim
static

codimensioon of the entity

Referenced by Dune::PolyhedralGridEntity< codim, dim, Grid >::subEntities().

◆ data_

template<int codim, int dim, class Grid >
ExtraData Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::data_
protected

Referenced by Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::data().

◆ dimension

template<int codim, int dim, class Grid >
const int Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::dimension = Traits::dimension
static

dimension of the grid

◆ dimensionworld

template<int codim, int dim, class Grid >
const int Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::dimensionworld = Traits::dimensionworld
static

dimension of the world

◆ mydimension

template<int codim, int dim, class Grid >
const int Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::mydimension = dimension - codimension
static

dimension of the entity

◆ seed_

template<int codim, int dim, class Grid >
EntitySeed Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::seed_
protected

Referenced by Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::equals(), Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::geometry(), Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::index(), Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::seed(), and Dune::PolyhedralGridEntityBasic< codim, dim, Grid >::type().

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