dune-alugrid 2.8.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Dune::ALU3dGridEntity< cd, dim, GridImp > Class Template Reference

#include <dune/alugrid/3d/entity.hh>

Inheritance diagram for Dune::ALU3dGridEntity< cd, dim, GridImp >:
Inheritance graph

Public Types

typedef ALU3dImplTraits< GridImp::elementType, Comm > ImplTraits
 
typedef ImplTraits::template Codim< dim, cd >::InterfaceType HItemType
 
typedef ImplTraits::template Codim< dim, cd >::ImplementationType ItemType
 
typedef ImplTraits::VertexType VertexType
 
typedef ImplTraits::HBndSegType HBndSegType
 
typedef GridImp::template Codim< cd >::Entity Entity
 
typedef GridImp::template Codim< cd >::Geometry Geometry
 
typedef GridImp::template Codim< cd >::EntitySeed EntitySeed
 typedef of my type
 

Public Member Functions

 ALU3dGridEntity ()
 Constructor.
 
 ALU3dGridEntity (const EntitySeed &seed)
 construct entity from seed
 
Geometry geometry () const
 geometry of this entity
 
GeometryType type () const
 type of geometry of this entity
 
void setElement (const HItemType &item)
 
void setElement (const HItemType &item, const GridImp &grid)
 
void setElement (const HItemType &item, const int level, int twist=0)
 
void setElement (const EntitySeed &seed)
 
void setGhost (const HBndSegType &ghost)
 setGhost is not valid for this codim
 
void removeElement ()
 reset item pointer to NULL
 
bool equals (const ALU3dGridEntity< cd, dim, GridImp > &org) const
 compare 2 elements by comparing the item pointers
 
void setEntity (const ALU3dGridEntity< cd, dim, GridImp > &org)
 set item from other entity, mainly for copy constructor of entity pointer
 
int subIndex (int i, unsigned int codim) const
 
const ItemType & getItem () const
 
EntitySeed seed () const
 return seed of entity
 
int level () const
 level of this element
 
PartitionType partitionType () const
 return partition type of this entity ( see grid.hh )
 

Protected Member Functions

int getIndex () const
 index is unique within the grid hierarchy and per codim
 
PartitionType convertBndId (const HItemType &item) const
 convert ALUGrid partition type to dune partition type
 

Protected Attributes

GeometryImpl geo_
 the current geometry
 
EntitySeed seed_
 the information necessary to make sense of this entity
 

Detailed Description

template<int cd, int dim, class GridImp>
class Dune::ALU3dGridEntity< cd, dim, GridImp >

A Grid is a container of grid entities. An entity is parametrized by the codimension. An entity of codimension c in dimension d is a d-c dimensional object.

Here: the general template

Member Typedef Documentation

◆ Entity

template<int cd, int dim, class GridImp >
typedef GridImp::template Codim<cd>::Entity Dune::ALU3dGridEntity< cd, dim, GridImp >::Entity

◆ EntitySeed

template<int cd, int dim, class GridImp >
typedef GridImp::template Codim<cd>::EntitySeed Dune::ALU3dGridEntity< cd, dim, GridImp >::EntitySeed

typedef of my type

◆ Geometry

template<int cd, int dim, class GridImp >
typedef GridImp::template Codim<cd>::Geometry Dune::ALU3dGridEntity< cd, dim, GridImp >::Geometry

◆ HBndSegType

template<int cd, int dim, class GridImp >
typedef ImplTraits::HBndSegType Dune::ALU3dGridEntity< cd, dim, GridImp >::HBndSegType

◆ HItemType

template<int cd, int dim, class GridImp >
typedef ImplTraits::template Codim<dim,cd>::InterfaceType Dune::ALU3dGridEntity< cd, dim, GridImp >::HItemType

◆ ImplTraits

template<int cd, int dim, class GridImp >
typedef ALU3dImplTraits< GridImp::elementType, Comm > Dune::ALU3dGridEntity< cd, dim, GridImp >::ImplTraits

◆ ItemType

template<int cd, int dim, class GridImp >
typedef ImplTraits::template Codim<dim,cd>::ImplementationType Dune::ALU3dGridEntity< cd, dim, GridImp >::ItemType

◆ VertexType

template<int cd, int dim, class GridImp >
typedef ImplTraits::VertexType Dune::ALU3dGridEntity< cd, dim, GridImp >::VertexType

Constructor & Destructor Documentation

◆ ALU3dGridEntity() [1/2]

template<int cd, int dim, class GridImp >
Dune::ALU3dGridEntity< cd, dim, GridImp >::ALU3dGridEntity

Constructor.

◆ ALU3dGridEntity() [2/2]

template<int cd, int dim, class GridImp >
Dune::ALU3dGridEntity< cd, dim, GridImp >::ALU3dGridEntity ( const EntitySeed &  seed)

construct entity from seed

Member Function Documentation

◆ convertBndId()

template<int cd, int dim, class GridImp >
alu_inline PartitionType Dune::ALU3dGridEntity< cd, dim, GridImp >::convertBndId ( const HItemType &  item) const
protected

convert ALUGrid partition type to dune partition type

◆ equals()

template<int cd, int dim, class GridImp >
bool Dune::ALU3dGridEntity< cd, dim, GridImp >::equals ( const ALU3dGridEntity< cd, dim, GridImp > &  org) const
inline

compare 2 elements by comparing the item pointers

◆ geometry()

template<int cd, int dim, class GridImp >
alu_inline ALU3dGridEntity< cd, dim, GridImp >::Geometry Dune::ALU3dGridEntity< cd, dim, GridImp >::geometry

geometry of this entity

◆ getIndex()

template<int cd, int dim, class GridImp >
int Dune::ALU3dGridEntity< cd, dim, GridImp >::getIndex ( ) const
inlineprotected

index is unique within the grid hierarchy and per codim

◆ getItem()

template<int cd, int dim, class GridImp >
const ItemType & Dune::ALU3dGridEntity< cd, dim, GridImp >::getItem ( ) const
inline

◆ level()

template<int cd, int dim, class GridImp >
int Dune::ALU3dGridEntity< cd, dim, GridImp >::level ( ) const
inline

level of this element

◆ partitionType()

template<int cd, int dim, class GridImp >
PartitionType Dune::ALU3dGridEntity< cd, dim, GridImp >::partitionType ( ) const
inline

return partition type of this entity ( see grid.hh )

◆ removeElement()

template<int cd, int dim, class GridImp >
void Dune::ALU3dGridEntity< cd, dim, GridImp >::removeElement ( )
inline

reset item pointer to NULL

◆ seed()

template<int cd, int dim, class GridImp >
EntitySeed Dune::ALU3dGridEntity< cd, dim, GridImp >::seed ( ) const
inline

return seed of entity

◆ setElement() [1/4]

template<int cd, int dim, class GridImp >
alu_inline void Dune::ALU3dGridEntity< cd, dim, GridImp >::setElement ( const EntitySeed &  seed)

◆ setElement() [2/4]

template<int cd, int dim, class GridImp >
alu_inline void Dune::ALU3dGridEntity< cd, dim, GridImp >::setElement ( const HItemType &  item)

◆ setElement() [3/4]

template<int cd, int dim, class GridImp >
alu_inline void Dune::ALU3dGridEntity< cd, dim, GridImp >::setElement ( const HItemType &  item,
const GridImp &  grid 
)

◆ setElement() [4/4]

template<int cd, int dim, class GridImp >
alu_inline void Dune::ALU3dGridEntity< cd, dim, GridImp >::setElement ( const HItemType &  item,
const int  level,
int  twist = 0 
)

◆ setEntity()

template<int cd, int dim, class GridImp >
alu_inline void Dune::ALU3dGridEntity< cd, dim, GridImp >::setEntity ( const ALU3dGridEntity< cd, dim, GridImp > &  org)

set item from other entity, mainly for copy constructor of entity pointer

◆ setGhost()

template<int cd, int dim, class GridImp >
alu_inline void Dune::ALU3dGridEntity< cd, dim, GridImp >::setGhost ( const HBndSegType &  ghost)

setGhost is not valid for this codim

◆ subIndex()

template<int cd, int dim, class GridImp >
int Dune::ALU3dGridEntity< cd, dim, GridImp >::subIndex ( int  i,
unsigned int  codim 
) const
inline

◆ type()

template<int cd, int dim, class GridImp >
GeometryType Dune::ALU3dGridEntity< cd, dim, GridImp >::type ( ) const
inline

type of geometry of this entity

Member Data Documentation

◆ geo_

template<int cd, int dim, class GridImp >
GeometryImpl Dune::ALU3dGridEntity< cd, dim, GridImp >::geo_
mutableprotected

the current geometry

◆ seed_

template<int cd, int dim, class GridImp >
EntitySeed Dune::ALU3dGridEntity< cd, dim, GridImp >::seed_
protected

the information necessary to make sense of this entity

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