Dune::IdentityGrid< HostGrid > Class Template Reference

#include <identitygrid.hh>

List of all members.


Detailed Description

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

[ provides Dune::Grid ]


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.
std::string name () const
 return grid name
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.
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.
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 
getHostEntity (const typename Traits::template Codim< codim >::Entity &e) const
 Returns the hostgrid entity encapsulated in given subgrid 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.

Member Typedef Documentation

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

Todo:
Should not be public


Member Function Documentation

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>
void Dune::IdentityGrid< HostGrid >::globalRefine ( int  refCount  )  [inline]

global refinement

Todo:
optimize implementation

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

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 >::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>
bool Dune::IdentityGrid< HostGrid >::preAdapt (  )  [inline]

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

dummy collective communication


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

Generated on 2 Apr 2009 with Doxygen (ver 1.5.6)