subset_handler_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__SUBSET_HANDLER_GRID__
#define __H__LIBGRID__SUBSET_HANDLER_GRID__
 
#include <vector>
#include <cassert>
#include "lib_grid/grid/grid.h"
#include "common/util/section_container.h"
#include "subset_handler_interface.h"
 
namespace ug
{
 
//  GridSubsetHandler
 
class UG_API GridSubsetHandler : public ISubsetHandler
{
  public:
    using ISubsetHandler::assign_subset;
    
  public:
    GridSubsetHandler(uint supportedElements = SHE_ALL);
    GridSubsetHandler(Grid& grid, uint supportedElements = SHE_ALL);
    GridSubsetHandler(const GridSubsetHandler& sh);
    ~GridSubsetHandler();
    
    GridSubsetHandler& operator = (const GridSubsetHandler& sh);
    GridSubsetHandler& operator = (const ISubsetHandler& sh);
 
    void assign_grid(Grid* grid);
    void assign_grid(Grid& grid);
 
  //  implementation of public virtual methdos of ISubsetHandler.
 
    void assign_subset(Vertex* elem, int subsetIndex);
 
 
    void assign_subset(Edge* elem, int subsetIndex);
 
 
    void assign_subset(Face* elem, int subsetIndex);
 
 
    void assign_subset(Volume* elem, int subsetIndex);
 
  //  element-access
 
    template <class TElem>
    typename geometry_traits<TElem>::iterator
    begin(int subsetIndex);
 
 
    template <class TElem>
    typename geometry_traits<TElem>::iterator
    end(int subsetIndex);
 
 
    template <class TElem>
    typename geometry_traits<TElem>::const_iterator
    begin(int subsetIndex) const;
 
 
    template <class TElem>
    typename geometry_traits<TElem>::const_iterator
    end(int subsetIndex) const;
    
    template <class TElem>
    uint num_elements(int subsetIndex) const;
 
    template <class TElem>
    uint num() const;
 
    template <class TElem>
    uint num(int subsetIndex) const;
 
    template <class TElem> inline
    bool empty() const;
    
    inline bool empty() const;
 
    template <class TElem> inline
    bool empty(int subsetIndex) const;
    
    inline bool empty(int subsetIndex) const;
    
    template <class TElem>
    void clear_subset_elements(int subsetIndex);
 
  //  geometric-object-collection
    virtual GridObjectCollection
    get_grid_objects_in_subset(int subsetIndex) const;
    
  //  multi-level-geometric-object-collection
    GridObjectCollection
    get_grid_objects() const;
 
 
    //virtual size_t collect_subset_elements(std::vector<Vertex*>& vrtsOut, int subsetIndex) const;
 
 
    //virtual size_t collect_subset_elements(std::vector<Edge*>& edgesOut, int subsetIndex) const;
 
 
    //virtual size_t collect_subset_elements(std::vector<Face*>& facesOut, int subsetIndex) const;
 
 
    //virtual size_t collect_subset_elements(std::vector<Volume*>& volsOut, int subsetIndex) const;
 
    virtual bool contains_vertices(int subsetIndex) const {return num<Vertex>(subsetIndex) > 0;}
 
    virtual bool contains_edges(int subsetIndex) const    {return num<Edge>(subsetIndex) > 0;}
    
    virtual bool contains_faces(int subsetIndex) const    {return num<Face>(subsetIndex) > 0;}
    
    virtual bool contains_volumes(int subsetIndex) const  {return num<Volume>(subsetIndex) > 0;}
 
    template <class TElem>
    bool perform_self_tests();
    
  //  for compatibility with MGSubsetHandler
 
    uint num_levels() const           {return 1;}
    
 
    template <class TElem>
    typename geometry_traits<TElem>::const_iterator
    begin(int subsetIndex, size_t) const    {return begin<TElem>(subsetIndex);}
 
 
    template <class TElem>
    typename geometry_traits<TElem>::const_iterator
    end(int subsetIndex, size_t) const      {return end<TElem>(subsetIndex);}
 
 
    template <class TElem>
    uint num_elements(int subsetIndex, size_t) const  {return num_elements<TElem>();}
 
 
    template <class TElem>
    uint num(int subsetIndex, size_t) const       {return num<TElem>();}
    
 
    virtual void grid_to_be_destroyed(Grid* grid);
 
  protected:
    using ISubsetHandler::AttachedVertexList;
    using ISubsetHandler::AttachedEdgeList;
    using ISubsetHandler::AttachedFaceList;
    using ISubsetHandler::AttachedVolumeList;
 
    using ISubsetHandler::VertexSectionContainer;
    using ISubsetHandler::EdgeSectionContainer;
    using ISubsetHandler::FaceSectionContainer;
    using ISubsetHandler::VolumeSectionContainer;
 
    inline uint num_subsets_in_list() const {return (uint)m_subsets.size();}
    
    void detach_data();
 
  //  implementation of protected virtual methdos of ISubsetHandler.
    virtual void erase_subset_lists();
 
    void erase_subset_lists_impl();
    
    virtual void clear_subset_lists(int index);
 
 
    virtual void change_subset_indices(int indOld, int indNew);
 
    
    void add_required_subset_lists(int maxIndex);
    
    void erase_subset_lists(int index);
 
    void swap_subset_lists(int ind1, int ind2);
 
    void move_subset_lists(int indexFrom, int indexTo);
 
    void join_subset_lists(int target, int src1, int src2);
 
    //void register_subset_elements_at_pipe();
 
  //  protected helper methods
    template<class TElem> inline
    void assign_subset_impl(TElem* elem, int subsetIndex);
              
    template<class TElem>
    void change_elem_subset_indices(int indOld, int indNew);
 
    //template <class TElem>
    //size_t collect_subset_elements_impl(std::vector<TElem*>& elemsOut, int subsetIndex) const;
    
    void cleanup();
 
 
    inline VertexSectionContainer::iterator
    get_list_iterator(Vertex* o)
    {
      assert((get_subset_index(o) >= 0) && "invalid subset.");
      return section_container<Vertex>(get_subset_index(o)).
        get_container().get_iterator(o);
    }
 
    inline EdgeSectionContainer::iterator
    get_list_iterator(Edge* o)
    {
      assert((get_subset_index(o) >= 0) && "invalid subset.");
      return section_container<Edge>(get_subset_index(o)).
        get_container().get_iterator(o);
    }
 
    inline FaceSectionContainer::iterator
    get_list_iterator(Face* o)
    {
      assert((get_subset_index(o) >= 0) && "invalid subset.");
      return section_container<Face>(get_subset_index(o)).
        get_container().get_iterator(o);
    }
 
    inline VolumeSectionContainer::iterator
    get_list_iterator(Volume* o)
    {
      assert((get_subset_index(o) >= 0) && "invalid subset.");
      return section_container<Volume>(get_subset_index(o)).
        get_container().get_iterator(o);
    }
    template <class TElem> inline
    typename Grid::traits<TElem>::SectionContainer&
    section_container(int si);
 
    template <class TElem> inline
    const typename Grid::traits<TElem>::SectionContainer&
    section_container(int si) const;
 
  protected:
    struct Subset
    {
      VertexSectionContainer  m_vertices;
      EdgeSectionContainer  m_edges;
      FaceSectionContainer  m_faces;
      VolumeSectionContainer  m_volumes;
    };
 
    typedef std::vector<Subset*>  SubsetVec;
 
  protected:
    SubsetVec     m_subsets;
  //  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;
};
 
 
typedef GridSubsetHandler SubsetHandler;
 
}// end of namespace
 
//  include implementation
#include "subset_handler_grid_impl.hpp"
 
#endif