grid.hh

// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_ALU3DGRIDGRID_HH
#define DUNE_ALU3DGRIDGRID_HH
 
//- System includes
#include <vector>
 
//- Dune includes
#include <dune/grid/utility/grapedataioformattypes.hh>
#include <dune/grid/common/capabilities.hh>
#include <dune/grid/alugrid/common/interfaces.hh>
#include <dune/common/bigunsignedint.hh>
#include <dune/common/deprecated.hh>
 
#include <dune/geometry/referenceelements.hh>
 
#include <dune/grid/common/grid.hh>
#include <dune/grid/alugrid/common/defaultindexsets.hh>
#include <dune/grid/common/sizecache.hh>
#include <dune/grid/alugrid/common/intersectioniteratorwrapper.hh>
#include <dune/grid/common/datahandleif.hh>
#include <dune/grid/common/defaultgridview.hh>
 
// bnd projection stuff
#include <dune/grid/common/boundaryprojection.hh>
#include <dune/grid/alugrid/common/bndprojection.hh>
#include <dune/grid/alugrid/common/objectfactory.hh>
#include <dune/grid/alugrid/common/backuprestore.hh>
 
//- Local includes
#include "alu3dinclude.hh"
#include "topology.hh"
#include "indexsets.hh"
#include "datahandle.hh"
 
#include <dune/grid/alugrid/3d/lbdatahandle.hh>
 
#include <dune/common/parallel/mpihelper.hh>
 
#if ALU3DGRID_PARALLEL
#include <dune/common/parallel/mpicollectivecommunication.hh>
#else
#include <dune/common/parallel/collectivecommunication.hh>
#endif
 
namespace Dune
{
 
  // Forward declarations
  template<int cd, int dim, class GridImp>
  class ALU3dGridEntity;
  template<int cd, PartitionIteratorType pitype, class GridImp >
  class ALU3dGridLevelIterator;
  template<int cd, class GridImp >
  class ALU3dGridEntityPointerBase;
  template<int cd, class GridImp >
  class ALU3dGridEntitySeed;
  template<int cd, class GridImp >
  class ALU3dGridEntityPointer;
  template<int mydim, int coorddim, class GridImp>
  class ALU3dGridGeometry;
  template<class GridImp>
  class ALU3dGridHierarchicIterator;
  template<class GridImp>
  class ALU3dGridIntersectionIterator;
  template<class GridImp>
  class ALU3dGridLevelIntersectionIterator;
  template<int codim, PartitionIteratorType pitype, class GridImp>
  class ALU3dGridLeafIterator;
  template <int mydim, int coorddim, class GridImp>
  class ALU3dGridMakeableEntity;
  template <class GridImp>
  class ALU3dGridFaceGeometryInfo;
  template< ALU3dGridElementType, class >
  class ALU3dGridGlobalIdSet;
  template< ALU3dGridElementType, class >
  class ALU3dGridLocalIdSet;
  template< ALU3dGridElementType, class >
  class ALU3dGridHierarchicIndexSet;
  template <class EntityImp>
  class ALUMemoryProvider;
  template< class >
  class ALU3dGridFactory;
  template <class GridImp, class GeometryImp, int nChild>
  class ALULocalGeometryStorage;
  template< ALU3dGridElementType elType, class Comm >
  struct ALU3dGridCommHelper;
 
 
 
  // Internal Forward Declarations
  // -----------------------------
 
#if ALU3DGRID_PARALLEL
  template< ALU3dGridElementType elType, class Comm = MPI_Comm >
  class ALU3dGrid;
#else // #if ALU3DGRID_PARALLEL
  template< ALU3dGridElementType elType, class Comm = No_Comm >
  class ALU3dGrid;
#endif // #else // #if ALU3DGRID_PARALLEL
 
  template < class Comm >
  struct ALUGridBaseGrid< 3, 3, cube, Comm >
  {
    typedef ALU3dGrid< hexa, Comm >  BaseGrid ;
  };
 
  template < class Comm>
  struct ALUGridBaseGrid< 3, 3, simplex, Comm >
  {
    typedef ALU3dGrid< tetra, Comm >  BaseGrid ;
  };
 
 
 
  // ALU3dGridCommunications
  // -----------------------
  struct ALU3dGridCommunicationsBase
  {
    template < class GitterImpl >
    void checkForConformingRefinement( GitterImpl* grid,
                                       const bool conformingRefinement )
    {
#ifdef ALUGRID_3D_CONFORMING_REFINEMENT
      if( grid && conformingRefinement )
      {
        grid->enableConformingClosure();
        grid->disableGhostCells();
      }
#endif
    }
  };
 
 
  template< ALU3dGridElementType elType, class Comm >
  struct ALU3dGridCommunications;
 
  template< ALU3dGridElementType elType >
  struct ALU3dGridCommunications< elType, No_Comm > : public ALU3dGridCommunicationsBase
  {
    using ALU3dGridCommunicationsBase :: checkForConformingRefinement ;
 
    typedef ALU3dGridLocalIdSet< elType, No_Comm > GlobalIdSet;
    typedef int GlobalId;
 
    typedef ALU3DSPACE GitterDuneImpl GitterImplType;
 
    typedef Dune::CollectiveCommunication< No_Comm > CollectiveCommunication;
 
    explicit ALU3dGridCommunications ( No_Comm comm ) {}
 
    int nlinks () const { return 0; }
 
    GitterImplType *createALUGrid ( const std::string &macroName, ALU3DSPACE ProjectVertex *projection,
                                    const bool conformingRefinement )
    {
      GitterImplType* grid = ( macroName.empty() ) ?
                             new GitterImplType() : new GitterImplType ( macroName.c_str(), projection );
      // check whether conforming refinement should be enabled
      checkForConformingRefinement( grid, conformingRefinement );
      return grid ;
    }
 
    GitterImplType *createALUGrid ( std::istream& stream, ALU3DSPACE ProjectVertex *projection,
                                    const bool conformingRefinement )
    {
#ifdef ALUGRID_CONSTRUCTION_WITH_STREAMS
      GitterImplType* grid = new GitterImplType ( stream, projection );
      // check whether conforming refinement should be enabled
      checkForConformingRefinement( grid, conformingRefinement );
      return grid ;
#else
      return 0;
#endif
    }
 
    static No_Comm defaultComm () { return No_Comm(); }
 
    static int getRank ( No_Comm comm ) { return 0; }
 
    static typename ALU3DSPACE Gitter::Geometric::BuilderIF &getBuilder ( GitterImplType &grid )
    {
      ALU3DSPACE Gitter::Geometric::BuilderIF* builder =
        dynamic_cast< ALU3DSPACE Gitter::Geometric::BuilderIF* >( &grid.container() );
      if( ! builder )
        DUNE_THROW(InvalidStateException,"dynamic_cast of ALUGrid builder failed");
      return *builder;
    }
 
    static void duneNotifyMacroGridChanges ( GitterImplType &grid ) {}
 
    CollectiveCommunication ccobj_;
  };
 
#if ALU3DGRID_PARALLEL
  template< ALU3dGridElementType elType >
  struct ALU3dGridCommunications< elType, MPI_Comm > : public ALU3dGridCommunicationsBase
  {
    using ALU3dGridCommunicationsBase :: checkForConformingRefinement ;
 
    typedef ALU3dGridGlobalIdSet< elType, MPI_Comm > GlobalIdSet;
    typedef ALUGridId< ALUMacroKey > GlobalId;
 
    typedef ALU3DSPACE GitterDunePll GitterImplType;
 
    typedef Dune::CollectiveCommunication< MPI_Comm > CollectiveCommunication;
 
    explicit ALU3dGridCommunications ( MPI_Comm comm )
      : ccobj_( comm ), mpAccess_( comm )
    {}
 
    int nlinks () const { return mpAccess_.nlinks(); }
 
    GitterImplType *createALUGrid ( const std::string &macroName, ALU3DSPACE ProjectVertex *projection,
                                    const bool conformingRefinement )
    {
      GitterImplType* grid = new GitterImplType( macroName.c_str(), mpAccess_, projection );
      // check whether conforming refinement should be enabled
      checkForConformingRefinement( grid, conformingRefinement );
      return grid;
    }
 
    GitterImplType *createALUGrid ( std::istream& stream, ALU3DSPACE ProjectVertex *projection,
                                    const bool conformingRefinement )
    {
#ifdef ALUGRID_CONSTRUCTION_WITH_STREAMS
      GitterImplType* grid = new GitterImplType ( stream, mpAccess_, projection );
      // check whether conforming refinement should be enabled
      checkForConformingRefinement( grid, conformingRefinement );
      return grid ;
#else
      return 0;
#endif
    }
 
    static MPI_Comm defaultComm () { return MPI_COMM_WORLD; }
 
    static int getRank ( MPI_Comm comm )
    {
      int rank = 0;
      MPI_Comm_rank( comm, &rank );
      return rank;
    }
 
    static typename ALU3DSPACE Gitter::Geometric::BuilderIF &getBuilder ( GitterImplType &grid )
    {
      ALU3DSPACE Gitter::Geometric::BuilderIF* builder =
        dynamic_cast< ALU3DSPACE Gitter::Geometric::BuilderIF* >( &grid.containerPll() );
      if( ! builder )
        DUNE_THROW(InvalidStateException,"dynamic_cast of ALUGrid builder failed");
      return *builder;
    }
 
    static void duneNotifyMacroGridChanges ( GitterImplType &grid )
    {
      grid.duneNotifyMacroGridChanges();
    }
 
    CollectiveCommunication ccobj_;
    ALU3DSPACE MpAccessMPI mpAccess_;
  };
#endif // #if ALU3DGRID_PARALLEL
 
 
 
  // ALU3dGridFamily
  // ---------------
 
  template< ALU3dGridElementType elType, class Comm >
  struct ALU3dGridFamily
  {
    typedef ALU3dGrid< elType, Comm > GridImp;
    typedef ALU3dGridFamily< elType, Comm > GridFamily;
 
    static const int dim = 3;
    static const int dimworld = 3;
 
    typedef ALU3dGridLocalIdSet< elType, Comm > LocalIdSetImp;
 
    typedef typename ALU3dGridCommunications< elType, Comm >::GlobalIdSet GlobalIdSetImp;
 
    typedef typename ALU3dGridCommunications< elType, Comm >::GlobalId GlobalIdType;
 
    typedef int LocalIdType;
 
    struct Traits
    {
      typedef typename GridFamily::LocalIdType LocalIdType;
 
      typedef typename GridFamily::GlobalIdType GlobalIdType;
 
      typedef typename GridFamily::GridImp Grid;
 
      typedef Dune::Intersection< const Grid, LeafIntersectionWrapper< const Grid > > LeafIntersection;
      typedef Dune::Intersection< const Grid, LevelIntersectionWrapper< const Grid > > LevelIntersection;
 
      typedef Dune::IntersectionIterator< const Grid, LeafIntersectionIteratorWrapper< const Grid >, LeafIntersectionWrapper< const Grid > > IntersectionIterator;
 
      typedef Dune::IntersectionIterator< const Grid, LeafIntersectionIteratorWrapper< const Grid >, LeafIntersectionWrapper< const Grid > > LeafIntersectionIterator;
      typedef Dune::IntersectionIterator< const Grid, LevelIntersectionIteratorWrapper< const Grid >, LevelIntersectionWrapper< const Grid > > LevelIntersectionIterator;
 
      typedef Dune::EntityIterator< 0, const Grid, ALU3dGridHierarchicIterator< const Grid > > HierarchicIterator;
 
      typedef DuneBoundaryProjection< dimworld > DuneBoundaryProjectionType;
      typedef std::vector< const DuneBoundaryProjectionType * > DuneBoundaryProjectionVector;
 
      template< int cd >
      struct Codim
      {
        // IMPORTANT: Codim<codim>::Geometry == Geometry<dim-codim,dimw>
        typedef ALU3dGridGeometry< dim-cd, dimworld, const Grid > GeometryImpl;
        typedef ALU3dGridGeometry< dim-cd, dim, const Grid > LocalGeometryImpl;
        typedef Dune::Geometry< dim-cd, dimworld, const Grid, ALU3dGridGeometry > Geometry;
        typedef Dune::Geometry< dim-cd, dim, const Grid, ALU3dGridGeometry > LocalGeometry;
 
        typedef Dune::Entity< cd, dim, const Grid, ALU3dGridEntity > Entity;
 
        // minimal information to generate entities
        typedef ALU3dGridEntitySeed< cd , const Grid> EntitySeed ;
 
        typedef ALU3dGridEntityPointer< cd, const Grid > EntityPointerImpl;
        typedef Dune::EntityPointer< const Grid, EntityPointerImpl > EntityPointer;
 
        template< PartitionIteratorType pitype >
        struct Partition
        {
          typedef Dune::EntityIterator< cd, const Grid, ALU3dGridLevelIterator< cd, pitype, const Grid > > LevelIterator;
          typedef Dune::EntityIterator< cd, const Grid, ALU3dGridLeafIterator< cd, pitype, const Grid > > LeafIterator;
        }; // struct Partition
 
        typedef typename Partition< All_Partition >::LevelIterator LevelIterator;
        typedef typename Partition< All_Partition >::LeafIterator LeafIterator;
      }; // struct Codim
 
      template< PartitionIteratorType pitype >
      struct Partition
      {
        typedef Dune::GridView<DefaultLevelGridViewTraits< const Grid, pitype > > LevelGridView;
        typedef Dune::GridView<DefaultLeafGridViewTraits< const Grid, pitype > > LeafGridView;
      }; // struct Partition
 
      typedef DefaultIndexSet< GridImp, typename Codim< 0 > :: LevelIterator > LevelIndexSetImp;
 
      typedef DefaultIndexSet< GridImp, typename Codim< 0 > :: LeafIterator > LeafIndexSetImp;
 
      typedef IndexSet< Grid, LevelIndexSetImp > LevelIndexSet;
      typedef IndexSet< Grid, LeafIndexSetImp > LeafIndexSet;
      typedef IdSet< Grid, LocalIdSetImp, LocalIdType > LocalIdSet;
      typedef IdSet< Grid, GlobalIdSetImp, GlobalIdType > GlobalIdSet;
 
      typedef Dune::CollectiveCommunication< Comm > CollectiveCommunication;
    }; // struct Traits
 
    typedef typename Traits :: LevelIndexSetImp LevelIndexSetImp;
 
    typedef typename Traits :: LeafIndexSetImp LeafIndexSetImp;
 
  }; // struct ALU3dGridFamily
 
 
 
  //**********************************************************************
  //
  // --ALU3dGrid
  // --Grid
  //
  //**********************************************************************
 
  template< ALU3dGridElementType elType, class Comm >
  class ALU3dGrid
    : public GridDefaultImplementation< 3, 3, alu3d_ctype,
          ALU3dGridFamily< elType, Comm > >,
      public HasObjectStream,
      public HasHierarchicIndexSet
  {
    typedef ALU3dGrid< elType, Comm > ThisType;
    typedef GridDefaultImplementation< 3, 3, alu3d_ctype, ALU3dGridFamily< elType, Comm > > BaseType;
 
    // for compatibility: MyType := ThisType
    typedef ThisType MyType;
 
    // friend declarations
    friend class ALU3dGridEntity< 0, 3, const ThisType>;
    friend class ALU3dGridEntity< 1, 3, const ThisType>;
    friend class ALU3dGridEntity< 2, 3, const ThisType>;
    friend class ALU3dGridEntity< 3, 3, const ThisType>;
 
    friend class ALU3dGridIntersectionIterator< ThisType >;
 
    friend class ALU3dGridEntityPointerBase< 0, const ThisType >;
    friend class ALU3dGridEntityPointerBase< 1, const ThisType >;
    friend class ALU3dGridEntityPointerBase< 2, const ThisType >;
    friend class ALU3dGridEntityPointerBase< 3, const ThisType >;
 
    friend class ALU3dGridEntityPointer< 0, const ThisType >;
    friend class ALU3dGridEntityPointer< 1, const ThisType >;
    friend class ALU3dGridEntityPointer< 2, const ThisType >;
    friend class ALU3dGridEntityPointer< 3, const ThisType >;
 
    friend class ALU3dGridIntersectionIterator< const ThisType >;
    friend class ALU3dGridHierarchicIterator< const ThisType >;
 
    friend class ALU3dGridHierarchicIndexSet< elType, Comm >;
    friend class ALU3dGridGlobalIdSet< elType, Comm >;
    friend class ALU3dGridLocalIdSet< elType, Comm >;
 
    friend class Conversion< ThisType, HasObjectStream >;
    friend class Conversion< const ThisType, HasObjectStream >;
 
    friend class Conversion< ThisType, HasHierarchicIndexSet >;
    friend class Conversion< const ThisType, HasHierarchicIndexSet >;
 
    friend struct ALU3dGridCommHelper< elType, Comm >;
 
    // new intersection iterator is a wrapper which get itersectioniteratoimp as pointers
  public:
    typedef ALU3dGridIntersectionIterator<const ThisType>
    IntersectionIteratorImp;
    typedef ALU3dGridIntersectionIterator<const ThisType>
    LeafIntersectionIteratorImp;
    typedef ALU3dGridLevelIntersectionIterator<const ThisType>
    LevelIntersectionIteratorImp;
 
    friend class IntersectionIteratorWrapper < const ThisType, LeafIntersectionIteratorImp > ;
    friend class IntersectionIteratorWrapper < const ThisType, LevelIntersectionIteratorImp > ;
    friend class LeafIntersectionIteratorWrapper < const ThisType > ;
    friend class LevelIntersectionIteratorWrapper< const ThisType > ;
 
    //**********************************************************
    // The Interface Methods
    //**********************************************************
  public:
    enum { refineStepsForHalf = 1 };
 
    static const ALU3dGridElementType elementType = elType;
    typedef typename ALU3DSPACE GatherScatterType::ObjectStreamType ObjectStreamType;
    typedef ObjectStreamType InStreamType ;
    typedef ObjectStreamType OutStreamType ;
 
    typedef ALU3dGridFamily< elType, Comm > GridFamily;
    typedef typename GridFamily::Traits Traits;
 
    static const int dimension = BaseType::dimension;
    static const int dimensionworld = BaseType::dimensionworld;
 
  protected:
    typedef MakeableInterfaceObject< typename Traits::template Codim< 0 >::Geometry > GeometryObject;
    friend class ALULocalGeometryStorage< const ThisType, GeometryObject, 8 >;
 
  public:
    typedef ALU3dGridHierarchicIndexSet< elType, Comm > HierarchicIndexSet;
 
    typedef typename GridFamily::LevelIndexSetImp LevelIndexSetImp;
    typedef typename GridFamily::LeafIndexSetImp LeafIndexSetImp;
 
    typedef ReferenceElement< alu3d_ctype, dimension > ReferenceElementType;
 
    typedef typename Traits::DuneBoundaryProjectionType DuneBoundaryProjectionType;
    typedef typename Traits::DuneBoundaryProjectionVector DuneBoundaryProjectionVector;
 
    typedef ALU3DSPACE ProjectVertex ALUGridVertexProjectionType;
 
    typedef typename Traits::CollectiveCommunication CollectiveCommunication;
 
  public:
    typedef MakeableInterfaceObject<typename Traits::template Codim<0>::Entity> EntityObject;
    typedef MakeableInterfaceObject<typename Traits::template Codim<1>::Entity> FaceObject;
    typedef MakeableInterfaceObject<typename Traits::template Codim<2>::Entity> EdgeObject;
    typedef MakeableInterfaceObject<typename Traits::template Codim<3>::Entity> VertexObject;
 
    typedef ALUGridObjectFactory< ThisType >  GridObjectFactoryType;
 
  protected:
    friend class ALUGridBoundaryProjection< ThisType, alu3d_ctype >;
    // type of ALUGrid boundary projection wrapper
    typedef ALUGridBoundaryProjection< ThisType, alu3d_ctype > ALUGridBoundaryProjectionType;
 
    typedef typename GridFamily::LocalIdSetImp LocalIdSetImp;
 
    typedef typename GridFamily::GlobalIdSetImp GlobalIdSetImp;
 
  public:
    typedef typename Traits::GlobalIdSet GlobalIdSet;
 
    typedef typename Traits::LocalIdSet LocalIdSet;
 
  protected:
    typedef ALU3dGridLeafIterator< 0, All_Partition, const ThisType > LeafIteratorImp;
    typedef typename Traits::template Codim< 0 >::LeafIterator LeafIteratorType;
    typedef typename Traits::template Codim< 0 >::LeafIterator LeafIterator;
 
    typedef ALU3dGridHierarchicIterator< const ThisType > HierarchicIteratorImp;
 
    typedef typename ALU3dImplTraits< elType, Comm >::GitterImplType GitterImplType;
 
    enum {
      MAXL = 32
    };
 
    enum {
      newElementsChunk_ = 128
    };
 
    enum {
      refineEstimate_ = 8
    };
 
  public:
    typedef Comm MPICommunicatorType;
 
    typedef ALU3dGridCommunications< elType, Comm > Communications;
 
  protected:
    typedef ALU3dGridVertexList< Comm > VertexListType;
    typedef ALU3dGridLeafVertexList< Comm > LeafVertexListType;
 
    ALU3dGrid ( const std::string &macroTriangFilename,
                const MPICommunicatorType mpiComm,
                const DuneBoundaryProjectionType *bndPrj,
                const DuneBoundaryProjectionVector *bndVec,
                const ALUGridRefinementType refinementType ) DUNE_DEPRECATED_MSG("ALUGrid is deprecated, please use the new module DUNE-ALUGrid.");
 
  public:
    virtual ~ALU3dGrid();
 
    static inline std::string name ();
 
    int maxLevel() const;
 
    template<int cd, PartitionIteratorType pitype>
    typename Traits::template Codim<cd>::template Partition<pitype>::LevelIterator
    lbegin (int level) const;
 
    template<int cd, PartitionIteratorType pitype>
    typename Traits::template Codim<cd>::template Partition<pitype>::LevelIterator
    lend (int level) const;
 
    template<int cd>
    typename Traits::template Codim<cd>::
    template Partition<All_Partition>::LevelIterator
    lbegin (int level) const;
 
    template<int cd>
    typename Traits::template Codim<cd>::
    template Partition<All_Partition>::LevelIterator
    lend (int level) const;
 
  private:
    template <int codim, PartitionIteratorType pitype>
    typename Traits::template Codim<codim>::template Partition<pitype>::LeafIterator
    leafbegin(int level) const;
 
    template <int codim, PartitionIteratorType pitype>
    typename Traits::template Codim<codim>::template Partition<pitype>::LeafIterator
    leafend(int level) const;
 
    template <int codim>
    typename Traits::template Codim<codim>::LeafIterator
    leafbegin(int level) const;
 
    template <int codim>
    typename Traits::template Codim<codim>::LeafIterator
    leafend(int level) const;
 
    LeafIteratorType leafbegin (int level) const;
 
    LeafIteratorType leafend (int level) const;
 
    LeafIteratorType leafbegin () const;
 
    LeafIteratorType leafend () const;
 
  public:
    template <int codim, PartitionIteratorType pitype>
    typename Traits::template Codim<codim>::template Partition<pitype>::LeafIterator
    leafbegin() const;
 
    template <int codim, PartitionIteratorType pitype>
    typename Traits::template Codim<codim>::template Partition<pitype>::LeafIterator
    leafend() const;
 
    template <int codim>
    typename Traits::template Codim<codim>::LeafIterator
    leafbegin() const;
 
    template <int codim>
    typename Traits::template Codim<codim>::LeafIterator
    leafend() const;
 
  private:
    template <int codim, PartitionIteratorType pitype>
    typename Traits::template Codim<codim>::template Partition<pitype>::LeafIterator
    createLeafIteratorBegin (int level) const;
 
    template <int codim, PartitionIteratorType pitype>
    typename Traits::template Codim<codim>::template Partition<pitype>::LeafIterator
    createLeafIteratorEnd(int level) const;
 
  public:
    int size (int level, int cd) const;
 
    int size (int codim) const;
 
    int size (int level, GeometryType type) const;
 
    size_t numBoundarySegments() const;
 
    int size (GeometryType type) const;
 
    int global_size (int cd) const ;
 
    // (no interface method) number of grid entities in the entire grid for given codim
    int hierSetSize (int cd) const;
 
    const GlobalIdSet &globalIdSet () const
    {
      if( !globalIdSet_ )
        globalIdSet_ = new GlobalIdSetImp( *this );
      return *globalIdSet_;
    }
 
    const LocalIdSet & localIdSet () const { return localIdSet_; }
 
    const typename Traits :: LeafIndexSet & leafIndexSet () const;
 
    const typename Traits :: LevelIndexSet & levelIndexSet (int level) const;
 
    bool loadBalance ();
 
    template <class DataHandle>
    bool loadBalance (DataHandle & data);
 
    template< class DataHandleImpl, class Data >
    bool loadBalance ( CommDataHandleIF< DataHandleImpl, Data > &dataHandle )
    {
      typedef ALUGridLoadBalanceDataHandle< ThisType, DataHandleImpl, Data > LBHandle;
      LBHandle lbHandle( *this, dataHandle );
      return loadBalance( lbHandle );
    }
 
    int ghostSize (int level, int codim) const;
 
    int overlapSize (int level, int codim) const { return 0; }
 
    int ghostSize (int codim) const;
 
    int overlapSize (int codim) const { return 0; }
 
    template<class DataHandleImp,class DataTypeImp>
    void communicate (CommDataHandleIF<DataHandleImp,DataTypeImp> & data,
                      InterfaceType iftype, CommunicationDirection dir, int level) const;
 
    template<class DataHandleImp,class DataTypeImp>
    void communicate (CommDataHandleIF<DataHandleImp,DataTypeImp> & data,
                      InterfaceType iftype, CommunicationDirection dir) const;
 
  private:
    typedef ALU3DSPACE GatherScatter GatherScatterType;
 
  public:
    const CollectiveCommunication &comm () const { return communications().ccobj_; }
 
    bool preAdapt ( );
 
    void postAdapt ( );
 
    bool adapt ();
 
    template< class GridImp, class DataHandle >
    bool adapt ( AdaptDataHandleInterface< GridImp, DataHandle > &handle );
 
    void globalRefine ( int refCount );
 
    template< class GridImp, class DataHandle >
    void globalRefine ( int refCount, AdaptDataHandleInterface< GridImp, DataHandle > &handle );
 
    //**********************************************************
    // End of Interface Methods
    //**********************************************************
    template <GrapeIOFileFormatType ftype>
    bool writeGrid( const std::string filename, alu3d_ctype time ) const ;
 
    bool writeGrid_Xdr( const std::string filename, alu3d_ctype time ) const ;
    bool writeGrid_Ascii( const std::string filename, alu3d_ctype time, bool scientific = false ) const ;
 
    bool writeMacroGrid( const std::string path, const std::string filename ) const ;
 
    template <GrapeIOFileFormatType ftype>
    bool readGrid( const std::string filename, alu3d_ctype & time );
 
    void backup( std::ostream& ) const ;
 
    void restore( std::istream& ) ;
 
    // (no interface method) get hierarchic index set of the grid
    const HierarchicIndexSet & hierarchicIndexSet () const { return hIndexSet_; }
 
    // set max of given mxl and actual maxLevel
    // for loadBalance
    void setMaxLevel (int mxl);
 
    // no interface method, but has to be public
    void updateStatus ();
 
    bool mark( int refCount , const typename Traits::template Codim<0>::Entity & e);
 
    int getMark( const typename Traits::template Codim<0>::Entity & e) const;
 
  public:
    static MPICommunicatorType defaultCommunicator ()
    {
      return Communications::defaultComm();
    }
 
    using BaseType :: getRealImplementation ;
 
    template< class IntersectionType >
    static const typename BaseType
    :: template ReturnImplementationType< IntersectionType >
    :: ImplementationType &
    getRealIntersection ( const IntersectionType &intersection )
    {
      return getRealImplementation( intersection );
    }
 
    const std::vector<GeometryType>& geomTypes (int codim) const { return geomTypes_[codim]; }
 
    // return reference to org ALU3dGrid
    // private method, but otherwise we have to friend class all possible
    // types of LevelIterator ==> later
    GitterImplType &myGrid () const;
 
    virtual GitterImplType *createALUGrid ( const std::string &macroName )
    {
      assert( communications_ );
      return communications_->createALUGrid( macroName, vertexProjection(), conformingRefinement() );
    }
 
    virtual GitterImplType *createALUGrid ( std::istream& stream )
    {
      assert( communications_ );
      return communications_->createALUGrid( stream, vertexProjection(), conformingRefinement() );
    }
 
    ALUGridVertexProjectionType* vertexProjection() { return (ALUGridVertexProjectionType *) vertexProjection_; }
 
    // return appropriate ALUGrid builder
    virtual typename ALU3DSPACE Gitter::Geometric::BuilderIF &getBuilder () const
    {
      return Communications::getBuilder( myGrid() );
    }
 
    // helper function for factory
    virtual void duneNotifyMacroGridChanges ()
    {
      Communications::duneNotifyMacroGridChanges( myGrid() );
    }
 
    const ReferenceElementType & referenceElement() const { return referenceElement_; }
 
    template < class EntitySeed >
    typename Traits :: template Codim< EntitySeed :: codimension > :: EntityPointer
    entityPointer( const EntitySeed& seed ) const
    {
      enum { codim = EntitySeed :: codimension };
      typedef ALU3dGridEntityPointer < codim, const ThisType > ALUPointer ;
      return ALUPointer( factory(), seed ) ;
    }
 
    // number of links to other processors, for internal use only
    int nlinks () const { return communications().nlinks(); }
 
    LeafVertexListType & getLeafVertexList() const
    {
      if( !leafVertexList_.up2Date() ) leafVertexList_.setupVxList(*this);
      return leafVertexList_;
    }
 
    int getLevelOfLeafVertex ( const typename ALU3dImplTraits< elType, Comm >::VertexType &vertex ) const
    {
      assert( leafVertexList_.up2Date() );
      return leafVertexList_.getLevel(vertex);
    }
 
    VertexListType & getVertexList(int level) const
    {
      assert( level >= 0 );
      assert( level <= maxLevel() );
      VertexListType & vxList = vertexList_[level];
      if(!vxList.up2Date()) vxList.setupVxList(*this,level);
      return vxList;
    }
 
    ALU3dGridItemListType & getGhostLeafList(int codim) const
    {
      assert( codim >= 1 );
      assert( codim <= 3 );
      return ghostLeafList_[codim-1];
    }
 
    ALU3dGridItemListType & getGhostLevelList(int codim, int level) const
    {
      assert( codim >= 1 );
      assert( codim <= 3 );
 
      assert( level >= 0 );
      assert( level <= maxLevel() );
      return ghostLevelList_[codim-1][level];
    }
 
    ALU3dGridItemListType & getEdgeList(int level) const
    {
      assert( level >= 0 );
      assert( level <= maxLevel() );
      return levelEdgeList_[level];
    }
 
  protected:
    ALU3dGrid( const ThisType & );
 
    const ThisType &operator= ( const ThisType & );
 
    void calcExtras();
 
    void calcMaxLevel();
 
    void recalcGlobalSize();
 
    void checkMacroGridFile (const std::string filename);
 
    void checkMacroGrid ();
 
    const DuneBoundaryProjectionType* boundaryProjection(const int segmentIndex) const
    {
      if( bndPrj_ )
      {
        return bndPrj_;
      }
      else
      {
        // pointer can be zero (which is emulates the identity mapping then)
        assert( bndVec_ );
        assert( segmentIndex < (int) bndVec_->size() );
        return (*bndVec_)[ segmentIndex ];
      }
    }
 
    const Communications &communications () const
    {
      assert( communications_ );
      return *communications_;
    }
 
    const GridObjectFactoryType& factory() const {
#ifdef USE_SMP_PARALLEL
      assert( (int) factoryVec_.size() > GridObjectFactoryType :: threadNumber() );
      return factoryVec_[ GridObjectFactoryType :: threadNumber() ];
#else
      return factory_;
#endif
    }
 
  public:
    // return true if conforming refinement is enabled
    bool conformingRefinement() const
    {
      return (refinementType_ == conforming) ;
    }
 
    // return true if ghost cells are available
    bool ghostCellsEnabled () const
    {
#ifdef ALUGRID_3D_CONFORMING_REFINEMENT
      return myGrid().ghostCellsEnabled();
#else
      return true ;
#endif
    }
  protected:
    //
    // Internal variables
    //
 
    // the real ALU grid
    mutable GitterImplType *mygrid_;
 
    // max level of grid
    int maxlevel_;
 
    // count how much elements where marked
    mutable int coarsenMarked_;
    mutable int refineMarked_;
 
    // at the moment the number of different geom types is 1
    enum { numberOfGeomTypes = 1 };
    std::vector< std::vector<GeometryType> > geomTypes_;
 
    // our hierarchic index set
    HierarchicIndexSet hIndexSet_;
 
    // out global id set
    mutable GlobalIdSetImp *globalIdSet_;
 
    // out global id set
    LocalIdSetImp localIdSet_;
 
    // the level index set ( default type )
    mutable std::vector < LevelIndexSetImp * > levelIndexVec_;
 
    // the leaf index set
    mutable LeafIndexSetImp * leafIndexSet_;
 
    // the reference element
    const ReferenceElementType& referenceElement_;
 
    mutable VertexListType vertexList_[MAXL];
 
    mutable ALU3dGridItemListType ghostLeafList_[ dimension ];
    mutable ALU3dGridItemListType ghostLevelList_[ dimension ][MAXL];
 
    mutable ALU3dGridItemListType levelEdgeList_[MAXL];
 
    mutable LeafVertexListType leafVertexList_;
 
    // the type of our size cache
    typedef SizeCache<MyType> SizeCacheType;
    SizeCacheType * sizeCache_;
 
#ifdef USE_SMP_PARALLEL
    std::vector< GridObjectFactoryType > factoryVec_;
#else
    GridObjectFactoryType factory_;
#endif
 
    // variable to ensure that postAdapt ist called after adapt
    bool lockPostAdapt_;
 
    // pointer to Dune boundary projection
    const DuneBoundaryProjectionType* bndPrj_;
 
    // pointer to Dune boundary projection
    const DuneBoundaryProjectionVector* bndVec_;
 
    // boundary projection for vertices
    ALUGridBoundaryProjectionType* vertexProjection_ ;
 
    // pointer to communications object
    Communications *communications_;
 
    // refinement type (nonconforming or conforming)
    const ALUGridRefinementType refinementType_ ;
  }; // end class ALU3dGrid
 
 
  bool checkMacroGrid ( ALU3dGridElementType elType ,
                        const std::string filename );
  const char* elType2Name( ALU3dGridElementType elType );
 
  namespace Capabilities
  {
 
    template< ALU3dGridElementType elType, class Comm, int cdim >
    struct hasEntity< Dune::ALU3dGrid< elType, Comm >, cdim >
    {
      static const bool v = true;
    };
 
    template< ALU3dGridElementType elType, class Comm >
    struct DUNE_DEPRECATED_MSG("Capabilities::isParallel will be removed after dune-grid-2.4.") isParallel< ALU3dGrid< elType, Comm > >
    {
      static const bool DUNE_DEPRECATED_MSG("Capabilities::isParallel will be removed after dune-grid-2.4.") v = true;
    };
 
    template< ALU3dGridElementType elType, class Comm >
    struct isLevelwiseConforming< ALU3dGrid< elType, Comm > >
    {
      static const bool v = true;
    };
 
    template< ALU3dGridElementType elType, class Comm >
    struct hasBackupRestoreFacilities< ALU3dGrid< elType, Comm > >
    {
      static const bool v = true;
    };
 
  } // end namespace Capabilities
 
} // end namespace Dune
 
#include "grid_inline.hh"
#if COMPILE_ALUGRID_INLINE
  #include "grid_imp.cc"
#endif
#endif