dune-fem 2.8.0
Loading...
Searching...
No Matches
Protected Types | Protected Attributes | List of all members
Dune::Fem::IdEntityBasic< codim, dim, GridFamily > Class Template Reference

#include <dune/fem/gridpart/idgridpart/entity.hh>

Inheritance diagram for Dune::Fem::IdEntityBasic< codim, dim, GridFamily >:
Inheritance graph

Public Types

Types Required by DUNE
typedef std::remove_const< GridFamily >::type::ctype ctype
 coordinate type of the grid
 
typedef GridFamily::template Codim< codimension >::EntitySeed EntitySeedType
 type of corresponding entity seed
 
typedef Traits::template Codim< codimension >::Geometry Geometry
 type of corresponding geometry
 
Host Types
typedef HostGridPartType::template Codim< codimension >::EntityType HostEntityType
 type of corresponding host entity
 

Public Member Functions

Construction, Initialization and Destruction
 IdEntityBasic ()=default
 construct a null entity
 
 IdEntityBasic (ExtraData data, HostEntityType hostEntity)
 construct an initialized entity
 
Methods Shared by Entities of All Codimensions
GeometryType type () const
 obtain the name of the corresponding reference element
 
int level () const
 obtain the level of this entity
 
PartitionType partitionType () const
 obtain the partition type of this entity
 
Geometry geometry () const
 
EntitySeedType seed () const
 return EntitySeed of host grid entity
 
bool equals (const IdEntityBasic &rhs) const
 check for equality
 
Methods Supporting the GridPart Implementation
const HostEntityTypehostEntity () const
 
const ExtraDatadata () const
 

Static Public Attributes

Attributes
static const int codimension = codim
 codimensioon of the entity
 
static const int dimension = std::remove_const< GridFamily >::type::dimension
 dimension of the grid
 
static const int mydimension = dimension - codimension
 dimension of the entity
 
static const int dimensionworld = std::remove_const< GridFamily >::type::dimensionworld
 dimension of the world
 

Protected Types

typedef std::remove_const< GridFamily >::type::Traits Traits
 
typedef Traits::HostGridPartType HostGridPartType
 
typedef Traits::ExtraData ExtraData
 

Protected Attributes

ExtraData data_
 
HostEntityType hostEntity_
 

Member Typedef Documentation

◆ ctype

template<int codim, int dim, class GridFamily >
typedef std::remove_const<GridFamily>::type::ctype Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::ctype

coordinate type of the grid

◆ EntitySeedType

template<int codim, int dim, class GridFamily >
typedef GridFamily::template Codim<codimension>::EntitySeed Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::EntitySeedType

type of corresponding entity seed

◆ ExtraData

template<int codim, int dim, class GridFamily >
typedef Traits::ExtraData Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::ExtraData
protected

◆ Geometry

template<int codim, int dim, class GridFamily >
typedef Traits::template Codim<codimension>::Geometry Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::Geometry

type of corresponding geometry

◆ HostEntityType

template<int codim, int dim, class GridFamily >
typedef HostGridPartType::template Codim<codimension>::EntityType Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::HostEntityType

type of corresponding host entity

◆ HostGridPartType

template<int codim, int dim, class GridFamily >
typedef Traits::HostGridPartType Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::HostGridPartType
protected

◆ Traits

template<int codim, int dim, class GridFamily >
typedef std::remove_const<GridFamily>::type::Traits Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::Traits
protected

Constructor & Destructor Documentation

◆ IdEntityBasic() [1/2]

template<int codim, int dim, class GridFamily >
Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::IdEntityBasic ( )
default

construct a null entity

◆ IdEntityBasic() [2/2]

template<int codim, int dim, class GridFamily >
Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::IdEntityBasic ( ExtraData  data,
HostEntityType  hostEntity 
)
inline

construct an initialized entity

Parameters
[in]hostEntitycorresponding entity in the host grid

Member Function Documentation

◆ data()

template<int codim, int dim, class GridFamily >
const ExtraData & Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::data ( ) const
inline

◆ equals()

template<int codim, int dim, class GridFamily >
bool Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::equals ( const IdEntityBasic< codim, dim, GridFamily > &  rhs) const
inline

check for equality

◆ geometry()

template<int codim, int dim, class GridFamily >
Geometry Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::geometry ( ) const
inline

obtain the geometry of this entity

◆ hostEntity()

template<int codim, int dim, class GridFamily >
const HostEntityType & Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::hostEntity ( ) const
inline

◆ level()

template<int codim, int dim, class GridFamily >
int Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::level ( ) const
inline

obtain the level of this entity

◆ partitionType()

template<int codim, int dim, class GridFamily >
PartitionType Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::partitionType ( ) const
inline

obtain the partition type of this entity

◆ seed()

template<int codim, int dim, class GridFamily >
EntitySeedType Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::seed ( ) const
inline

return EntitySeed of host grid entity

◆ type()

template<int codim, int dim, class GridFamily >
GeometryType Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::type ( ) const
inline

obtain the name of the corresponding reference element

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

Member Data Documentation

◆ codimension

template<int codim, int dim, class GridFamily >
const int Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::codimension = codim
static

codimensioon of the entity

◆ data_

template<int codim, int dim, class GridFamily >
ExtraData Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::data_
protected

◆ dimension

template<int codim, int dim, class GridFamily >
const int Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::dimension = std::remove_const< GridFamily >::type::dimension
static

dimension of the grid

◆ dimensionworld

template<int codim, int dim, class GridFamily >
const int Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::dimensionworld = std::remove_const< GridFamily >::type::dimensionworld
static

dimension of the world

◆ hostEntity_

template<int codim, int dim, class GridFamily >
HostEntityType Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::hostEntity_
protected

◆ mydimension

template<int codim, int dim, class GridFamily >
const int Dune::Fem::IdEntityBasic< codim, dim, GridFamily >::mydimension = dimension - codimension
static

dimension of the entity


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