selector_multi_grid.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 */
 
//  ...
 
#ifndef __H__LIBGRID__SELECTOR_MULTI_GRID__
#define __H__LIBGRID__SELECTOR_MULTI_GRID__
 
#include <cassert>
#include "selector_interface.h"
#include "../multi_grid.h"
#include "../lib_grid_messages.h"
 
namespace ug
{
//  predeclarations
class MultiGrid;
 
//  MGSelector
 
class UG_API MGSelector : public ISelector
{
  public:
    typedef ISelector BaseClass;
    typedef MultiGrid grid_type;
    
    template <class TElem, class TMGSelector, class TLevelIterator>
    class MGSelectionIterator
    {
      public:
        typedef MGSelectionIterator                   this_type;
        typedef std::forward_iterator_tag iterator_category;
        typedef size_t            difference_type;
        typedef TElem**           pointer;
        typedef TElem*            value_type;
        typedef value_type&         reference;
 
        MGSelectionIterator() : m_sel(NULL), m_lvl(0) {}
 
        MGSelectionIterator(const MGSelectionIterator<TElem, MGSelector,
                  typename geometry_traits<TElem>::iterator>& iter)
        {
          m_sel = iter.m_sel;
          m_lvl = iter.m_lvl;
          m_iter = iter.m_iter;
        }
 
        this_type operator ++() {increment(); return *this;}
        this_type operator ++(int unused) {this_type i = *this; increment(); return i;}
 
        bool operator ==(const this_type& iter) const {return equal(iter);}
        bool operator !=(const this_type& iter) const {return !equal(iter);}
 
        value_type operator *()     {return dereference();}
        value_type operator *() const {return dereference();}
 
      private:
        friend class MGSelector;
    //    friend class MGSelectionIterator<TElem, const MGSelector,
    //                     typename MGSelector::traits<TElem>::const_level_iterator>;
        typedef TLevelIterator level_iterator;
 
        MGSelectionIterator(TMGSelector* sel, int lvl,
                  level_iterator iter)
        {
          m_sel = sel;
          m_lvl = lvl;
          m_iter = iter;
        }
 
        inline bool equal(const this_type& other) const
        {
          return m_iter == other.m_iter;
        }
 
        void increment()
        {
          ++m_iter;
          while((m_iter == m_sel->template end<TElem>(m_lvl))
              && (m_lvl + 1 < m_sel->num_levels()))
          {
            ++m_lvl;
            m_iter = m_sel->template begin<TElem>(m_lvl);
          }
        }
 
        inline value_type dereference() const
        {
          return *m_iter;
        }
 
      private:
        TMGSelector*  m_sel;
        size_t      m_lvl;
        level_iterator  m_iter;
    };
 
    template <class TElem>
    struct traits{
      typedef TElem*                      value_t;
      typedef typename geometry_traits<TElem>::iterator   level_iterator;
      typedef typename geometry_traits<TElem>::const_iterator const_level_iterator;
      typedef MGSelectionIterator<TElem, MGSelector,
                    level_iterator>       iterator;
      typedef MGSelectionIterator<TElem, const MGSelector,
                    const_level_iterator>   const_iterator;
    };
 
 
    MGSelector(uint supportedElements = SE_ALL);
    MGSelector(MultiGrid& grid, uint supportedElements = SE_ALL);
    virtual ~MGSelector();
 
    void assign_grid(MultiGrid& grid);
    void assign_grid(MultiGrid* grid);
    inline MultiGrid* multi_grid()  {return m_pMultiGrid;}
 
 
  //  forwards to protected ISelector method. This rather complicated setup
  //  is required to avoid virtual method calls during construction.
    inline void set_supported_elements(uint shElements);
 
 
  //  forwards to protected ISelector method. This rather complicated setup
  //  is required to avoid virtual method calls during construction.
    inline void enable_element_support(uint shElements);
 
 
  //  forwards to protected ISelector method. This rather complicated setup
  //  is required to avoid virtual method calls during construction.
    void disable_element_support(uint shElements);
 
    inline size_t num_levels() const  {return m_levels.size();}
    inline size_t top_level() const
    {
      size_t l = m_levels.size();
      if(l == 0)
        return 0;
      else
        return l - 1;
    }
 
    virtual void clear();
 
    template <class TElem>
    inline void clear();
 
    void clear(int level);
 
    template <class TElem>
    inline void clear(int level);
 
    template <class TElem>
    inline size_t num(int level) const;
    
    inline size_t num(int level) const;
 
    template <class TElem>
    inline size_t num() const;
    
    inline size_t num() const;
 
  //  empty
    inline bool empty(int level) const;
 
    template <class TElem>
    inline bool empty(int level) const;
 
    inline bool empty() const;
 
    template <class TElem>
    inline bool empty() const;
 
  //  begin
    template <class TElem>
    inline typename traits<TElem>::iterator
    begin();
 
    template <class TElem>
    inline typename traits<TElem>::const_iterator
    begin() const;
 
    template <class TElem>
    inline typename traits<TElem>::level_iterator
    begin(int level);
 
    template <class TElem>
    inline typename traits<TElem>::const_level_iterator
    begin(int level) const;
    
  //  end
    template <class TElem>
    inline typename traits<TElem>::iterator
    end();
 
    template <class TElem>
    inline typename traits<TElem>::const_iterator
    end() const;
 
    template <class TElem>
    inline typename traits<TElem>::level_iterator
    end(int level);
    
    template <class TElem>
    inline typename traits<TElem>::const_level_iterator
    end(int level) const;
 
  //  convenience begin and end
    inline traits<Vertex>::level_iterator vertices_begin(int level) {return begin<Vertex>(level);}
    inline traits<Vertex>::level_iterator vertices_end(int level)   {return end<Vertex>(level);}
    inline traits<Edge>::level_iterator   edges_begin(int level)    {return begin<Edge>(level);}
    inline traits<Edge>::level_iterator   edges_end(int level)    {return end<Edge>(level);}
    inline traits<Face>::level_iterator     faces_begin(int level)    {return begin<Face>(level);}
    inline traits<Face>::level_iterator     faces_end(int level)    {return end<Face>(level);}
    inline traits<Volume>::level_iterator   volumes_begin(int level)  {return begin<Volume>(level);}
    inline traits<Volume>::level_iterator   volumes_end(int level)    {return end<Volume>(level);}
 
 
    template <class TElem> TElem* front(int level);
    
 
    template <class TElem> TElem* back(int level);
    
  //  geometric-object-collection
    virtual GridObjectCollection get_grid_objects() const;
 
  //  callbacks that allows us to clean-up
  //  derived from GridObserver
  /*
    virtual void registered_at_grid(Grid* grid);
    virtual void unregistered_from_grid(Grid* grid);
  */
    virtual void grid_to_be_destroyed(Grid* grid);
    
    virtual bool contains_vertices() const  {return num<Vertex>() > 0;}
 
    virtual bool contains_edges() const   {return num<Edge>() > 0;}
 
    virtual bool contains_faces() const   {return num<Face>() > 0;}
 
    virtual bool contains_volumes() const {return num<Volume>() > 0;}
 
  protected:
    void clear_lists();
 
    virtual void add_to_list(Vertex* elem);
    virtual void add_to_list(Edge* elem);
    virtual void add_to_list(Face* elem);
    virtual void add_to_list(Volume* elem);
 
    virtual void erase_from_list(Vertex* elem);
    virtual void erase_from_list(Edge* elem);
    virtual void erase_from_list(Face* elem);
    virtual void erase_from_list(Volume* elem);
 
  protected:
    using ISelector::AttachedVertexList;
    using ISelector::AttachedEdgeList;
    using ISelector::AttachedFaceList;
    using ISelector::AttachedVolumeList;
 
    using ISelector::VertexSectionContainer;
    using ISelector::EdgeSectionContainer;
    using ISelector::FaceSectionContainer;
    using ISelector::VolumeSectionContainer;
 
    struct Level{
      VertexSectionContainer  m_vertices;
      EdgeSectionContainer  m_edges;
      FaceSectionContainer  m_faces;
      VolumeSectionContainer  m_volumes;
    };
    typedef std::vector<Level*> LevelVec;
 
  protected:
    template <class TElem> inline
    typename Grid::traits<TElem>::SectionContainer&
    section_container(int level);
 
    template <class TElem> inline
    const typename Grid::traits<TElem>::SectionContainer&
    section_container(int level) const;
    
    template <class TElem>
    inline int get_section_index() const;
 
    inline void level_required(int newSize);
    void add_level();
 
    void cleanup();
 
 
    inline VertexSectionContainer::iterator
    get_level_iterator(Vertex* o)
    {
      assert(is_selected(o) && "object not selected.");
      return section_container<Vertex>(m_pMultiGrid->get_level(o)).
        get_container().get_iterator(o);
    }
 
    inline EdgeSectionContainer::iterator
    get_level_iterator(Edge* o)
    {
      assert(is_selected(o) && "object not selected");
      return section_container<Edge>(m_pMultiGrid->get_level(o)).
        get_container().get_iterator(o);
    }
 
    inline FaceSectionContainer::iterator
    get_level_iterator(Face* o)
    {
      assert(is_selected(o) && "object not selected");
      return section_container<Face>(m_pMultiGrid->get_level(o)).
        get_container().get_iterator(o);
    }
 
    inline VolumeSectionContainer::iterator
    get_level_iterator(Volume* o)
    {
      assert(is_selected(o) && "object not selected");
      return section_container<Volume>(m_pMultiGrid->get_level(o)).
        get_container().get_iterator(o);
    }
    void multigrid_changed(const GridMessage_MultiGridChanged& gm);
 
  private:
    MGSelector(const MGSelector& sel){};
 
  protected:
    MultiGrid*  m_pMultiGrid;
    LevelVec  m_levels;
    VertexIterator m_tmpVBegin;
    VertexIterator m_tmpVEnd;
 
  //  callback-id (automatically unregisters callback, when the selector is deleted).
    MessageHub::SPCallbackId  m_callbackId;
 
  //  we use a shared attachment for the entry-lists of all section containers
    AttachedVertexList::AEntry  m_aSharedEntryVRT;
    AttachedEdgeList::AEntry  m_aSharedEntryEDGE;
    AttachedFaceList::AEntry  m_aSharedEntryFACE;
    AttachedVolumeList::AEntry  m_aSharedEntryVOL;
};
 
}// end of namespace
 
//  include implementation
#include "selector_multi_grid_impl.hpp"
 
#endif