uggrid.hh

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:

#ifndef DUNE_UGGRID_HH
#define DUNE_UGGRID_HH

#include <memory>

#include <dune/common/classname.hh>
#include <dune/common/parallel/communication.hh>
#include <dune/common/exceptions.hh>
#include <dune/common/parallel/mpihelper.hh>

#include <dune-grid-config.hh> // HAVE_DUNE_UGGRID
#include <dune/grid/common/boundarysegment.hh>
#include <dune/grid/common/capabilities.hh>
#include <dune/grid/common/grid.hh>

#if HAVE_DUNE_UGGRID || DOXYGEN

#ifdef ModelP
#include <dune/common/parallel/mpicommunication.hh>
#endif

/* [Before reading the following: the macros UG_DIM_2 and UG_DIM_3 where named
 *  _2 and _3, respectively, up until ug-3.12.0.]
 *
 * The following lines including the necessary UG headers are somewhat
   tricky.  Here's what's happening:
   UG can support two- and three-dimensional grids.  You choose by setting
   either UG_DIM_2 or UG_DIM_3 while compiling.  This changes all sorts of stuff, in
   particular data structures in the headers.
   UG was never supposed to provide 2d and 3d grids at the same time.
   However, when compiling it as c++, the dimension-dependent parts are
   wrapped up cleanly in the namespaces UG::D2 and UG::D3, respectively.  That
   way it is possible to link together the UG lib for 2d and the one for 3d.
   But we also need the headers twice!  Once with UG_DIM_2 set and once with UG_DIM_3!
   So here we go:*/

// Set UG's space-dimension flag to 2d
#define UG_DIM_2
// And include all necessary UG headers
#include "uggrid/ugincludes.hh"
#undef DUNE_UGINCLUDES_HH

// Wrap a few large UG macros by functions before they get undef'ed away.
// Here: The 2d-version of the macros
#define UG_DIM 2
#include "uggrid/ugwrapper.hh"
#undef UG_DIM

// UG defines a whole load of preprocessor macros.  ug_undefs.hh undefines
// them all, so we don't get name clashes.
#include "uggrid/ug_undefs.hh"
#undef UG_DIM_2

/* Now we're done with 2d, and we can do the whole thing over again for 3d */

/* All macros set by UG have been unset.  This includes the macros that ensure
   single inclusion of headers.  We can thus include them again.  However, we
   only want to include those headers again that contain dimension-dependent stuff.
   Therefore, we set a few single-inclusion defines manually before including
   ugincludes.hh again.
 */
#define UGTYPES_H
#define __HEAPS__
#define __UGENV__
#define __DEVICESH__
#ifdef ModelP
#define __PPIF__
#endif

#define UG_DIM_3
#include "uggrid/ugincludes.hh"
#undef DUNE_UGINCLUDES_HH

// Wrap a few large UG macros by functions before they get undef'ed away.
// This time it's the 3d-versions.
#define UG_DIM 3
#include "uggrid/ugwrapper.hh"
#undef UG_DIM

// undef all macros defined by UG
#include "uggrid/ug_undefs.hh"

#undef UG_DIM_3

// The components of the UGGrid interface
#include "uggrid/uggridgeometry.hh"
#include "uggrid/uggridlocalgeometry.hh"
#include "uggrid/uggridentity.hh"
#include "uggrid/uggridentityseed.hh"
#include "uggrid/uggridintersections.hh"
#include "uggrid/uggridintersectioniterators.hh"
#include "uggrid/uggridleveliterator.hh"
#include "uggrid/uggridleafiterator.hh"
#include "uggrid/uggridhieriterator.hh"
#include "uggrid/uggridindexsets.hh"
#include <dune/grid/uggrid/uggridviews.hh>
#ifdef ModelP
#include "uggrid/ugmessagebuffer.hh"
#include "uggrid/uglbgatherscatter.hh"
#endif

// Not needed here, but included for user convenience
#include "uggrid/uggridfactory.hh"

#ifdef ModelP
template <class DataHandle, int GridDim, int codim>
const Dune::UGGrid<GridDim>* Dune::UGMessageBuffer<DataHandle, GridDim, codim>::grid_;

template <class DataHandle, int GridDim, int codim>
DataHandle *Dune::UGMessageBuffer<DataHandle,GridDim,codim>::duneDataHandle_ = nullptr;

template <class DataHandle, int GridDim, int codim>
int Dune::UGMessageBuffer<DataHandle,GridDim,codim>::level = -1;
#endif // ModelP

namespace Dune {

#ifdef ModelP
    using UGCommunication = Communication<MPI_Comm>;
#else
    using UGCommunication = Communication<No_Comm>;
#endif

  template<int dim>
  struct UGGridFamily
  {
    typedef GridTraits<dim,dim,Dune::UGGrid<dim>,
        UGGridGeometry,
        UGGridEntity,
        UGGridLevelIterator,
        UGGridLeafIntersection,
        UGGridLevelIntersection,
        UGGridLeafIntersectionIterator,
        UGGridLevelIntersectionIterator,
        UGGridHierarchicIterator,
        UGGridLeafIterator,
        UGGridLevelIndexSet< const UGGrid<dim> >,
        UGGridLeafIndexSet< const UGGrid<dim> >,
        UGGridIdSet< const UGGrid<dim> >,
        typename UG_NS<dim>::UG_ID_TYPE,
        UGGridIdSet< const UGGrid<dim> >,
        typename UG_NS<dim>::UG_ID_TYPE,
        UGCommunication,
        UGGridLevelGridViewTraits,
        UGGridLeafGridViewTraits,
        UGGridEntitySeed,
        UGGridLocalGeometry>
    Traits;
  };


  //**********************************************************************
  //
  // --UGGrid
  //
  //**********************************************************************

  template <int dim>
  class UGGrid : public GridDefaultImplementation  <dim, dim, double, UGGridFamily<dim> >
  {
    typedef GridDefaultImplementation <dim, dim, double, UGGridFamily<dim> > Base;

    friend class UGGridGeometry<0,dim,const UGGrid<dim> >;
    friend class UGGridGeometry<dim,dim,const UGGrid<dim> >;
    friend class UGGridGeometry<1,2,const UGGrid<dim> >;
    friend class UGGridGeometry<2,3,const UGGrid<dim> >;

    friend class UGGridEntity <0,dim,const UGGrid<dim> >;
    friend class UGGridEntity <1,dim,const UGGrid<dim> >;
    friend class UGGridEntity <2,dim,const UGGrid<dim> >;
    friend class UGGridEntity <dim,dim,const UGGrid<dim> >;
    friend class UGGridHierarchicIterator<const UGGrid<dim> >;
    friend class UGGridLeafIntersection<const UGGrid<dim> >;
    friend class UGGridLevelIntersection<const UGGrid<dim> >;
    friend class UGGridLeafIntersectionIterator<const UGGrid<dim> >;
    friend class UGGridLevelIntersectionIterator<const UGGrid<dim> >;

    friend class UGGridLevelIndexSet<const UGGrid<dim> >;
    friend class UGGridLeafIndexSet<const UGGrid<dim> >;
    friend class UGGridIdSet<const UGGrid<dim> >;
    template <class GridImp_>
    friend class UGGridLeafGridView;
    template <class GridImp_>
    friend class UGGridLevelGridView;

    friend class GridFactory<UGGrid<dim> >;

#ifdef ModelP
    friend class UGLBGatherScatter;
#endif

    template <int codim_, PartitionIteratorType PiType_, class GridImp_>
    friend class UGGridLeafIterator;
    template <int codim_, PartitionIteratorType PiType_, class GridImp_>
    friend class UGGridLevelIterator;

    static_assert(dim==2 || dim==3, "Use UGGrid only for 2d and 3d!");

    // The different instantiations are mutual friends so they can access
    // each others numOfUGGrids field
    friend class UGGrid<2>;
    friend class UGGrid<3>;

    //**********************************************************
    // The Interface Methods
    //**********************************************************
  public:
    typedef UGGridFamily<dim>  GridFamily;

    // the Traits
    typedef typename UGGridFamily<dim>::Traits Traits;

    typedef UG::DOUBLE ctype;

    typedef unsigned int Rank;

    UGGrid(UGCommunication comm = {});

    ~UGGrid()  noexcept(false);

    int maxLevel() const;

    template <typename Seed>
    typename Traits::template Codim<Seed::codimension>::Entity
    entity(const Seed& seed) const
    {
      const int codim = Seed::codimension;
      return typename Traits::template Codim<codim>::Entity(UGGridEntity<codim,dim,const UGGrid<dim> >(seed.impl().target(),this));
    }

    int size (int level, int codim) const;

    int size (int codim) const
    {
      return leafIndexSet().size(codim);
    }

    int size (int level, GeometryType type) const
    {
      return this->levelIndexSet(level).size(type);
    }

    int size (GeometryType type) const
    {
      return this->leafIndexSet().size(type);
    }

    size_t numBoundarySegments() const {
      // The number is stored as a member of UGGrid upon grid creation.
      // The corresponding data structure is not exported by UG.  (It is in ug/dom/std/std_internal.h)
      return numBoundarySegments_;
    }

    const typename Traits::GlobalIdSet& globalIdSet() const
    {
      return idSet_;
    }

    const typename Traits::LocalIdSet& localIdSet() const
    {
      return idSet_;
    }

    const typename Traits::LevelIndexSet& levelIndexSet(int level) const
    {
      if (level<0 || level>maxLevel())
        DUNE_THROW(GridError, "levelIndexSet of nonexisting level " << level << " requested!");
      return *levelIndexSets_[level];
    }

    const typename Traits::LeafIndexSet& leafIndexSet() const
    {
      return leafIndexSet_;
    }


    bool mark(int refCount, const typename Traits::template Codim<0>::Entity & e );

    bool mark(const typename Traits::template Codim<0>::Entity & e,
              typename UG_NS<dim>::RefinementRule rule,
              int side=0);

    int getMark(const typename Traits::template Codim<0>::Entity& e) const;

    bool preAdapt();

    bool adapt();

    void postAdapt();
    template<class DataHandle>
    bool loadBalance (DataHandle& dataHandle)
    {
#ifdef ModelP
      // gather element data
      if (dataHandle.contains(dim, 0))
        UGLBGatherScatter::template gather<0>(this->leafGridView(), dataHandle);

      // gather node data
      if (dataHandle.contains(dim,dim))
        UGLBGatherScatter::template gather<dim>(this->leafGridView(), dataHandle);
#endif

      // the load balancing step now also attaches
      // the data to the entities and distributes it
      loadBalance();

#ifdef ModelP
      // scatter element data
      if (dataHandle.contains(dim, 0))
        UGLBGatherScatter::template scatter<0>(this->leafGridView(), dataHandle);

      // scatter node data
      if (dataHandle.contains(dim,dim))
        UGLBGatherScatter::template scatter<dim>(this->leafGridView(), dataHandle);
#endif

      return true;
    }

    bool loadBalance(int minlevel=0);

    bool loadBalance(const std::vector<Rank>& targetProcessors, unsigned int fromLevel);

    template<class DataHandle>
    bool loadBalance (const std::vector<Rank>& targetProcessors, unsigned int fromLevel, DataHandle& dataHandle)
    {
#ifdef ModelP
      // gather element data
      if (dataHandle.contains(dim, 0))
        UGLBGatherScatter::template gather<0>(this->leafGridView(), dataHandle);

      // gather node data
      if (dataHandle.contains(dim,dim))
        UGLBGatherScatter::template gather<dim>(this->leafGridView(), dataHandle);
#endif

      // the load balancing step now also attaches
      // the data to the entities and distributes it
      loadBalance(targetProcessors,fromLevel);

#ifdef ModelP
      // scatter element data
      if (dataHandle.contains(dim, 0))
        UGLBGatherScatter::template scatter<0>(this->leafGridView(), dataHandle);

      // scatter node data
      if (dataHandle.contains(dim,dim))
        UGLBGatherScatter::template scatter<dim>(this->leafGridView(), dataHandle);
#endif

      return true;
    }

    const UGCommunication& comm () const
    {
      return ccobj_;
    }

  protected:
#ifdef ModelP
    template <int codim, class GridView, class DataHandle>
    void communicateUG_(const GridView& gv, int level,
                        DataHandle &dataHandle,
                        InterfaceType iftype,
                        CommunicationDirection dir) const
    {
      // Translate the communication direction from Dune-Speak to UG-Speak
      const auto ugIfDir = (dir==ForwardCommunication) ? UG_NS<dim>::IF_FORWARD() : UG_NS<dim>::IF_BACKWARD();

      // Set up the message buffer
      // No actual object is constructed, because the DDD_IFOneway method called below
      // needs *static* methods. Therefore, everything is currently routed
      // via static data members of the UGMessageBuffer class.
      using UGMsgBuf = UGMessageBuffer<DataHandle,dim,codim>;
      UGMsgBuf::duneDataHandle_ = &dataHandle;
      UGMsgBuf::level = level;
      UGMsgBuf::grid_ = this;

      const std::vector<typename UG_NS<dim>::DDD_IF> ugIfs = findDDDInterfaces(iftype, codim);

      const auto bufSize = UGMsgBuf::ugBufferSize(gv);
      if (!bufSize)
        return;     // we don't need to communicate if we don't have any data!
      for (auto&& dddInterface : ugIfs)
        UG_NS<dim>::DDD_IFOneway(multigrid_->dddContext(),
                                 dddInterface,
                                 ugIfDir,
                                 bufSize,
                                 &UGMsgBuf::ugGather_,
                                 &UGMsgBuf::ugScatter_);
    }

    std::vector<typename UG_NS<dim>::DDD_IF> findDDDInterfaces(InterfaceType iftype,
                                                               int codim) const;
#endif
  public:
    // **********************************************************
    // End of Interface Methods
    // **********************************************************

    void getChildrenOfSubface(const typename Traits::template Codim<0>::Entity & e,
                              int elementSide,
                              int maxl,
                              std::vector<typename Traits::template Codim<0>::Entity>& childElements,
                              std::vector<unsigned char>& childElementSides) const;

    enum RefinementType {
      LOCAL,
      COPY
    };

    enum ClosureType {
      GREEN,
      NONE
    };

    void setRefinementType(RefinementType type) {
      refinementType_ = type;
    }

    void setClosureType(ClosureType type) {
      closureType_ = type;
    }

    void setPosition(const typename Traits::template Codim<dim>::Entity& e,
                     const FieldVector<double, dim>& pos);

    void globalRefine(int n);

    void saveState(const std::string& filename) const;

    void loadState(const std::string& filename);

  private:
    typename UG_NS<dim>::MultiGrid* multigrid_;

    typename UG_NS<dim>::STD_BVP* bvp_;

    UGCommunication ccobj_;

    void setIndices(bool setLevelZero,
                    std::vector<unsigned int>* nodePermutation);

    // Each UGGrid object has a unique name to identify it in the
    // UG environment structure
    std::string name_;

    // Our set of level indices
    std::vector<std::shared_ptr<UGGridLevelIndexSet<const UGGrid<dim> > > > levelIndexSets_;

    UGGridLeafIndexSet<const UGGrid<dim> > leafIndexSet_;

    // One id set implementation
    // Used for both the local and the global UGGrid id sets
    UGGridIdSet<const UGGrid<dim> > idSet_;

    RefinementType refinementType_;

    ClosureType closureType_;

    static int numOfUGGrids;

    bool someElementHasBeenMarkedForRefinement_;

    bool someElementHasBeenMarkedForCoarsening_;

    std::vector<std::shared_ptr<BoundarySegment<dim> > > boundarySegments_;

    unsigned int numBoundarySegments_;

  }; // end Class UGGrid

  namespace Capabilities
  {
    template<int dim, int codim>
    struct hasEntity< UGGrid<dim>, codim>
    {
      static const bool v = true;
    };

    template<int dim, int codim>
    struct hasEntityIterator<UGGrid<dim>, codim>
    {
      static const bool v = false;
    };

    template<int dim>
    struct hasEntityIterator<UGGrid<dim>, 0>
    {
      static const bool v = true;
    };

    template<int dim>
    struct hasEntityIterator<UGGrid<dim>, dim>
    {
      static const bool v = true;
    };

    template<int dim, int codim>
    struct canCommunicate<UGGrid<dim>, codim>
    {
      static const bool v = (codim>=0 && codim<=dim);
    };

    template<int dim>
    struct isLevelwiseConforming< UGGrid<dim> >
    {
      static const bool v = true;
    };

    template<int dim>
    struct isLeafwiseConforming< UGGrid<dim> >
    {
      static const bool v = false;
    };

    template<int dim>
    struct viewThreadSafe< UGGrid<dim> > {
      static const bool v = true;
    };

  }

} // namespace Dune

#endif   // HAVE_DUNE_UGGRID || DOXYGEN
#endif   // DUNE_UGGRID_HH