dune-foamgrid  2.8-git
Public Types | Public Member Functions | Public Attributes | List of all members
Dune::FoamGridEntity< codim, dimgrid, GridImp > Class Template Reference

The implementation of entities in a FoamGrid. More...

#include <dune/foamgrid/foamgrid/foamgridentity.hh>

Inheritance diagram for Dune::FoamGridEntity< codim, dimgrid, GridImp >:
Inheritance graph

Public Types

typedef GridImp::template Codim< codim >::Geometry Geometry
 
typedef GridImp::template Codim< codim >::EntitySeed EntitySeed
 The type of the EntitySeed interface class. More...
 

Public Member Functions

 FoamGridEntity (const FoamGridEntityImp< dimgrid-codim, dimgrid, dimworld, ctype > *target)
 Constructor for an entity in a given grid level. More...
 
 FoamGridEntity (const FoamGridEntity &original)
 Copy constructor. More...
 
 FoamGridEntity ()
 Default constructor. More...
 
FoamGridEntityoperator= (const FoamGridEntity &original)
 
int level () const
 level of this element More...
 
PartitionType partitionType () const
 The partition type for parallel computing. More...
 
template<int cc>
int count () const
 
Geometry geometry () const
 geometry of this entity More...
 
EntitySeed seed () const
 Create EntitySeed. More...
 
void setToTarget (const FoamGridEntityImp< dimgrid-codim, dimgrid, dimworld, ctype > *target)
 
bool equals (const Dune::FoamGridEntity< codim, dimgrid, GridImp > &other) const
 equality More...
 
GeometryType type () const
 return the entity's type More...
 

Public Attributes

const FoamGridEntityImp< dimgrid-codim, dimgrid, dimworld, ctype > * target_
 

Detailed Description

template<int codim, int dimgrid, class GridImp>
class Dune::FoamGridEntity< codim, dimgrid, GridImp >

The implementation of entities in a FoamGrid.

Member Typedef Documentation

◆ EntitySeed

template<int codim, int dimgrid, class GridImp >
typedef GridImp::template Codim<codim>::EntitySeed Dune::FoamGridEntity< codim, dimgrid, GridImp >::EntitySeed

The type of the EntitySeed interface class.

◆ Geometry

template<int codim, int dimgrid, class GridImp >
typedef GridImp::template Codim<codim>::Geometry Dune::FoamGridEntity< codim, dimgrid, GridImp >::Geometry

Constructor & Destructor Documentation

◆ FoamGridEntity() [1/3]

template<int codim, int dimgrid, class GridImp >
Dune::FoamGridEntity< codim, dimgrid, GridImp >::FoamGridEntity ( const FoamGridEntityImp< dimgrid-codim, dimgrid, dimworld, ctype > *  target)
inlineexplicit

Constructor for an entity in a given grid level.

◆ FoamGridEntity() [2/3]

template<int codim, int dimgrid, class GridImp >
Dune::FoamGridEntity< codim, dimgrid, GridImp >::FoamGridEntity ( const FoamGridEntity< codim, dimgrid, GridImp > &  original)
inline

Copy constructor.

◆ FoamGridEntity() [3/3]

template<int codim, int dimgrid, class GridImp >
Dune::FoamGridEntity< codim, dimgrid, GridImp >::FoamGridEntity ( )
inline

Default constructor.

Member Function Documentation

◆ count()

template<int codim, int dimgrid, class GridImp >
template<int cc>
int Dune::FoamGridEntity< codim, dimgrid, GridImp >::count ( ) const
inline

Intra-element access to entities of codimension cc > codim. Return number of entities with codimension cc.

◆ equals()

template<int codim, int dimgrid, class GridImp >
bool Dune::FoamGridEntity< codim, dimgrid, GridImp >::equals ( const Dune::FoamGridEntity< codim, dimgrid, GridImp > &  other) const
inline

equality

◆ geometry()

template<int codim, int dimgrid, class GridImp >
Geometry Dune::FoamGridEntity< codim, dimgrid, GridImp >::geometry ( ) const
inline

geometry of this entity

◆ level()

template<int codim, int dimgrid, class GridImp >
int Dune::FoamGridEntity< codim, dimgrid, GridImp >::level ( ) const
inline

level of this element

◆ operator=()

template<int codim, int dimgrid, class GridImp >
FoamGridEntity& Dune::FoamGridEntity< codim, dimgrid, GridImp >::operator= ( const FoamGridEntity< codim, dimgrid, GridImp > &  original)
inline
Todo:
Please doc me !

◆ partitionType()

template<int codim, int dimgrid, class GridImp >
PartitionType Dune::FoamGridEntity< codim, dimgrid, GridImp >::partitionType ( ) const
inline

The partition type for parallel computing.

◆ seed()

template<int codim, int dimgrid, class GridImp >
EntitySeed Dune::FoamGridEntity< codim, dimgrid, GridImp >::seed ( ) const
inline

Create EntitySeed.

◆ setToTarget()

template<int codim, int dimgrid, class GridImp >
void Dune::FoamGridEntity< codim, dimgrid, GridImp >::setToTarget ( const FoamGridEntityImp< dimgrid-codim, dimgrid, dimworld, ctype > *  target)
inline
Todo:
Please doc me !

◆ type()

template<int codim, int dimgrid, class GridImp >
GeometryType Dune::FoamGridEntity< codim, dimgrid, GridImp >::type ( ) const
inline

return the entity's type

Member Data Documentation

◆ target_

template<int codim, int dimgrid, class GridImp >
const FoamGridEntityImp<dimgrid-codim, dimgrid, dimworld, ctype>* Dune::FoamGridEntity< codim, dimgrid, GridImp >::target_

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