dune-grid-dev-howto  2.2.0
Public Types | Public Member Functions | Protected Attributes | Friends
Dune::IdentityGrid< HostGrid > Class Template Reference

[ provides Dune::Grid ] More...

#include <dune/grid/identitygrid.hh>

List of all members.

Public Types

typedef HostGrid HostGridType
typedef IdentityGridFamily
< HostGrid::dimension,
HostGrid > 
GridFamily
 type of the used GridFamily for this grid
typedef IdentityGridFamily
< HostGrid::dimension,
HostGrid >::Traits 
Traits
 the Traits
typedef HostGrid::ctype ctype
 The type used to store coordinates, inherited from the HostGrid.

Public Member Functions

 IdentityGrid (HostGrid &hostgrid)
 Constructor.
 ~IdentityGrid ()
 Desctructor.
int maxLevel () const
template<int codim>
Traits::template Codim< codim >
::LevelIterator 
lbegin (int level) const
 Iterator to first entity of given codim on level.
template<int codim>
Traits::template Codim< codim >
::LevelIterator 
lend (int level) const
 one past the end on this level
template<int codim, PartitionIteratorType PiType>
Traits::template Codim< codim >
::template Partition< PiType >
::LevelIterator 
lbegin (int level) const
 Iterator to first entity of given codim on level.
template<int codim, PartitionIteratorType PiType>
Traits::template Codim< codim >
::template Partition< PiType >
::LevelIterator 
lend (int level) const
 one past the end on this level
template<int codim>
Traits::template Codim< codim >
::LeafIterator 
leafbegin () const
 Iterator to first leaf entity of given codim.
template<int codim>
Traits::template Codim< codim >
::LeafIterator 
leafend () const
 one past the end of the sequence of leaf entities
template<int codim, PartitionIteratorType PiType>
Traits::template Codim< codim >
::template Partition< PiType >
::LeafIterator 
leafbegin () const
 Iterator to first leaf entity of given codim.
template<int codim, PartitionIteratorType PiType>
Traits::template Codim< codim >
::template Partition< PiType >
::LeafIterator 
leafend () const
 one past the end of the sequence of leaf entities
int size (int level, int codim) const
 Number of grid entities per level and codim.
size_t numBoundarySegments () const
 returns the number of boundary segments within the macro grid
int size (int codim) const
 number of leaf entities per codim in this process
int size (int level, GeometryType type) const
 number of entities per level, codim and geometry type in this process
int size (GeometryType type) const
 number of leaf entities per codim and geometry type in this process
const Traits::GlobalIdSet & globalIdSet () const
 Access to the GlobalIdSet.
const Traits::LocalIdSet & localIdSet () const
 Access to the LocalIdSet.
const Traits::LevelIndexSet & levelIndexSet (int level) const
 Access to the LevelIndexSets.
const Traits::LeafIndexSet & leafIndexSet () const
 Access to the LeafIndexSet.
template<class EntitySeed >
Traits::template Codim
< EntitySeed::codimension >
::EntityPointer 
entityPointer (const EntitySeed &seed) const
 Create EntityPointer from EntitySeed.
unsigned int overlapSize (int codim) const
 Size of the overlap on the leaf level.
unsigned int ghostSize (int codim) const
 Size of the ghost cell layer on the leaf level.
unsigned int overlapSize (int level, int codim) const
 Size of the overlap on a given level.
unsigned int ghostSize (int level, int codim) const
 Size of the ghost cell layer on a given level.
const CollectiveCommunication
< IdentityGrid > & 
comm () const
HostGridTypegetHostGrid () const
 Returns the hostgrid this IdentityGrid lives in.
template<int codim>
HostGrid::Traits::template
Codim< codim >::EntityPointer 
getHostEntityPointer (const typename Traits::template Codim< codim >::Entity &e) const
 Returns the hostgrid entity encapsulated in given IdentityGrid entity.
Grid Refinement Methods
void globalRefine (int refCount)
bool mark (int refCount, const typename Traits::template Codim< 0 >::EntityPointer &e)
 Mark entity for refinement.
int getMark (const typename Traits::template Codim< 0 >::EntityPointer &e) const
 Return refinement mark for entity.
bool preAdapt ()
bool adapt ()
 Triggers the grid refinement process.
void postAdapt ()
 Clean up refinement markers.

Protected Attributes

HostGrid * hostgrid_
 The host grid which contains the actual grid hierarchy structure.

Friends

class IdentityGridLevelIndexSet< const IdentityGrid< HostGrid > >
class IdentityGridLeafIndexSet< const IdentityGrid< HostGrid > >
class IdentityGridGlobalIdSet< const IdentityGrid< HostGrid > >
class IdentityGridLocalIdSet< const IdentityGrid< HostGrid > >
class IdentityGridHierarchicIterator< const IdentityGrid< HostGrid > >
class IdentityGridLevelIntersectionIterator< const IdentityGrid< HostGrid > >
class IdentityGridLeafIntersectionIterator< const IdentityGrid< HostGrid > >
class IdentityGridLevelIterator
class IdentityGridLeafIterator
class IdentityGridEntity
class HostGridAccess< IdentityGrid< HostGrid > >

Detailed Description

template<class HostGrid>
class Dune::IdentityGrid< HostGrid >

[ provides Dune::Grid ]


Member Typedef Documentation

template<class HostGrid >
typedef HostGrid::ctype Dune::IdentityGrid< HostGrid >::ctype

The type used to store coordinates, inherited from the HostGrid.

template<class HostGrid >
typedef IdentityGridFamily<HostGrid::dimension,HostGrid> Dune::IdentityGrid< HostGrid >::GridFamily

type of the used GridFamily for this grid

template<class HostGrid >
typedef HostGrid Dune::IdentityGrid< HostGrid >::HostGridType
Todo:
Should not be public
template<class HostGrid >
typedef IdentityGridFamily<HostGrid::dimension,HostGrid>::Traits Dune::IdentityGrid< HostGrid >::Traits

the Traits


Constructor & Destructor Documentation

template<class HostGrid >
Dune::IdentityGrid< HostGrid >::IdentityGrid ( HostGrid &  hostgrid)
inlineexplicit

Constructor.

template<class HostGrid >
Dune::IdentityGrid< HostGrid >::~IdentityGrid ( )
inline

Desctructor.


Member Function Documentation

template<class HostGrid >
bool Dune::IdentityGrid< HostGrid >::adapt ( )
inline

Triggers the grid refinement process.

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
const CollectiveCommunication<IdentityGrid>& Dune::IdentityGrid< HostGrid >::comm ( ) const
inline

dummy collective communication

template<class HostGrid >
template<class EntitySeed >
Traits::template Codim<EntitySeed::codimension>::EntityPointer Dune::IdentityGrid< HostGrid >::entityPointer ( const EntitySeed &  seed) const
inline

Create EntityPointer from EntitySeed.

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
template<int codim>
HostGrid::Traits::template Codim<codim>::EntityPointer Dune::IdentityGrid< HostGrid >::getHostEntityPointer ( const typename Traits::template Codim< codim >::Entity &  e) const
inline

Returns the hostgrid entity encapsulated in given IdentityGrid entity.

template<class HostGrid >
HostGridType& Dune::IdentityGrid< HostGrid >::getHostGrid ( ) const
inline

Returns the hostgrid this IdentityGrid lives in.

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
int Dune::IdentityGrid< HostGrid >::getMark ( const typename Traits::template Codim< 0 >::EntityPointer &  e) const
inline

Return refinement mark for entity.

Returns:
refinement mark (1,0,-1)

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
unsigned int Dune::IdentityGrid< HostGrid >::ghostSize ( int  codim) const
inline

Size of the ghost cell layer on the leaf level.

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
unsigned int Dune::IdentityGrid< HostGrid >::ghostSize ( int  level,
int  codim 
) const
inline

Size of the ghost cell layer on a given level.

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
const Traits::GlobalIdSet& Dune::IdentityGrid< HostGrid >::globalIdSet ( ) const
inline

Access to the GlobalIdSet.

template<class HostGrid >
void Dune::IdentityGrid< HostGrid >::globalRefine ( int  refCount)
inline

global refinement

Todo:
optimize implementation

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
template<int codim>
Traits::template Codim<codim>::LevelIterator Dune::IdentityGrid< HostGrid >::lbegin ( int  level) const
inline

Iterator to first entity of given codim on level.

template<class HostGrid >
template<int codim, PartitionIteratorType PiType>
Traits::template Codim<codim>::template Partition<PiType>::LevelIterator Dune::IdentityGrid< HostGrid >::lbegin ( int  level) const
inline

Iterator to first entity of given codim on level.

template<class HostGrid >
template<int codim>
Traits::template Codim<codim>::LeafIterator Dune::IdentityGrid< HostGrid >::leafbegin ( ) const
inline

Iterator to first leaf entity of given codim.

template<class HostGrid >
template<int codim, PartitionIteratorType PiType>
Traits::template Codim<codim>::template Partition<PiType>::LeafIterator Dune::IdentityGrid< HostGrid >::leafbegin ( ) const
inline

Iterator to first leaf entity of given codim.

template<class HostGrid >
template<int codim>
Traits::template Codim<codim>::LeafIterator Dune::IdentityGrid< HostGrid >::leafend ( ) const
inline

one past the end of the sequence of leaf entities

template<class HostGrid >
template<int codim, PartitionIteratorType PiType>
Traits::template Codim<codim>::template Partition<PiType>::LeafIterator Dune::IdentityGrid< HostGrid >::leafend ( ) const
inline

one past the end of the sequence of leaf entities

template<class HostGrid >
const Traits::LeafIndexSet& Dune::IdentityGrid< HostGrid >::leafIndexSet ( ) const
inline

Access to the LeafIndexSet.

Referenced by Dune::IdentityGrid< HostGrid >::size().

template<class HostGrid >
template<int codim>
Traits::template Codim<codim>::LevelIterator Dune::IdentityGrid< HostGrid >::lend ( int  level) const
inline

one past the end on this level

template<class HostGrid >
template<int codim, PartitionIteratorType PiType>
Traits::template Codim<codim>::template Partition<PiType>::LevelIterator Dune::IdentityGrid< HostGrid >::lend ( int  level) const
inline

one past the end on this level

template<class HostGrid >
const Traits::LevelIndexSet& Dune::IdentityGrid< HostGrid >::levelIndexSet ( int  level) const
inline

Access to the LevelIndexSets.

References Dune::IdentityGrid< HostGrid >::maxLevel().

template<class HostGrid >
const Traits::LocalIdSet& Dune::IdentityGrid< HostGrid >::localIdSet ( ) const
inline

Access to the LocalIdSet.

template<class HostGrid >
bool Dune::IdentityGrid< HostGrid >::mark ( int  refCount,
const typename Traits::template Codim< 0 >::EntityPointer &  e 
)
inline

Mark entity for refinement.

This only works for entities of codim 0. The parameter is currently ignored

Returns:
  • true, if marking was succesfull
  • false, if marking was not possible

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
int Dune::IdentityGrid< HostGrid >::maxLevel ( ) const
inline

Return maximum level defined in this grid. Levels are numbered 0 ... maxlevel with 0 the coarsest level.

References Dune::IdentityGrid< HostGrid >::hostgrid_.

Referenced by Dune::IdentityGrid< HostGrid >::levelIndexSet().

template<class HostGrid >
size_t Dune::IdentityGrid< HostGrid >::numBoundarySegments ( ) const
inline

returns the number of boundary segments within the macro grid

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
unsigned int Dune::IdentityGrid< HostGrid >::overlapSize ( int  codim) const
inline

Size of the overlap on the leaf level.

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
unsigned int Dune::IdentityGrid< HostGrid >::overlapSize ( int  level,
int  codim 
) const
inline

Size of the overlap on a given level.

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
void Dune::IdentityGrid< HostGrid >::postAdapt ( )
inline

Clean up refinement markers.

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
bool Dune::IdentityGrid< HostGrid >::preAdapt ( )
inline
template<class HostGrid >
int Dune::IdentityGrid< HostGrid >::size ( int  level,
int  codim 
) const
inline

Number of grid entities per level and codim.

References Dune::IdentityGrid< HostGrid >::hostgrid_.

template<class HostGrid >
int Dune::IdentityGrid< HostGrid >::size ( int  codim) const
inline

number of leaf entities per codim in this process

References Dune::IdentityGrid< HostGrid >::leafIndexSet().

template<class HostGrid >
int Dune::IdentityGrid< HostGrid >::size ( int  level,
GeometryType  type 
) const
inline

number of entities per level, codim and geometry type in this process

template<class HostGrid >
int Dune::IdentityGrid< HostGrid >::size ( GeometryType  type) const
inline

number of leaf entities per codim and geometry type in this process

References Dune::IdentityGrid< HostGrid >::leafIndexSet().


Friends And Related Function Documentation

template<class HostGrid >
friend class HostGridAccess< IdentityGrid< HostGrid > >
friend
template<class HostGrid >
friend class IdentityGridEntity
friend
template<class HostGrid >
friend class IdentityGridGlobalIdSet< const IdentityGrid< HostGrid > >
friend
template<class HostGrid >
friend class IdentityGridHierarchicIterator< const IdentityGrid< HostGrid > >
friend
template<class HostGrid >
friend class IdentityGridLeafIndexSet< const IdentityGrid< HostGrid > >
friend
template<class HostGrid >
friend class IdentityGridLeafIntersectionIterator< const IdentityGrid< HostGrid > >
friend
template<class HostGrid >
friend class IdentityGridLeafIterator
friend
template<class HostGrid >
friend class IdentityGridLevelIndexSet< const IdentityGrid< HostGrid > >
friend
template<class HostGrid >
friend class IdentityGridLevelIntersectionIterator< const IdentityGrid< HostGrid > >
friend
template<class HostGrid >
friend class IdentityGridLevelIterator
friend
template<class HostGrid >
friend class IdentityGridLocalIdSet< const IdentityGrid< HostGrid > >
friend

Member Data Documentation

template<class HostGrid >
HostGrid* Dune::IdentityGrid< HostGrid >::hostgrid_
protected

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