selector_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_GRID__
#define __H__LIBGRID__SELECTOR_GRID__
 
#include <cassert>
#include "selector_interface.h"
 
namespace ug
{
 
//  Selector
 
class UG_API Selector : public ISelector
{
  public:
    typedef ISelector BaseClass;
    typedef Grid    grid_type;
 
    template <class TElem>
    struct traits{
      typedef typename geometry_traits<TElem>::iterator   iterator;
      typedef typename geometry_traits<TElem>::const_iterator const_iterator;
      typedef typename geometry_traits<TElem>::iterator   level_iterator;
      typedef typename geometry_traits<TElem>::const_iterator const_level_iterator;
    };
 
  public:
    Selector(uint supportedElements = SE_ALL);
    Selector(Grid& grid, uint supportedElements = SE_ALL);
    virtual ~Selector();
 
    void assign_grid(Grid& grid);
    void assign_grid(Grid* grid);
 
 
  //  forwards to protected ISelector method. This rather complicated setup
  //  is required to avoid virtual method calls during construction.
    void set_supported_elements(uint shElements);
 
 
  //  forwards to protected ISelector method. This rather complicated setup
  //  is required to avoid virtual method calls during construction.
    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);
 
    virtual void clear();
 
    template <class TElem>
    inline void clear();
 
    template <class TElem>
    inline size_t num() const;
    
    inline size_t num() const;
    
  //  empty
    inline bool empty() const;
 
    template <class TElem>
    inline bool empty() const;
 
  //  begin
    template <class TElem>
    inline typename geometry_traits<TElem>::iterator
    begin();
 
    template <class TElem>
    inline typename geometry_traits<TElem>::const_iterator
    begin() const;
    
  //  end
    template <class TElem>
    inline typename geometry_traits<TElem>::iterator
    end();
    
    template <class TElem>
    inline typename geometry_traits<TElem>::const_iterator
    end() const;
 
  //  convenience begin and end
    inline VertexIterator vertices_begin()  {return begin<Vertex>();}
    inline VertexIterator vertices_end()  {return end<Vertex>();}
    inline EdgeIterator edges_begin()   {return begin<Edge>();}
    inline EdgeIterator edges_end()     {return end<Edge>();}
    inline FaceIterator faces_begin()     {return begin<Face>();}
    inline FaceIterator faces_end()       {return end<Face>();}
    inline VolumeIterator volumes_begin()   {return begin<Volume>();}
    inline VolumeIterator volumes_end()     {return end<Volume>();}
 
 
    template <class TElem> TElem* front();
    
 
    template <class TElem> TElem* back();
 
  //  geometric-object-collection
    virtual GridObjectCollection get_grid_objects() const;
 
  //  callbacks that allows us to clean-up
  //  derived from GridObserver
    //virtual void unregistered_from_grid(Grid* grid);
    virtual void grid_to_be_destroyed(Grid* grid);
 
  //  for compatibility with MGSelector
    inline size_t num_levels() const;
    
    inline uint num(size_t) const;
    template <class TElem> inline size_t num(size_t) const;
    
  //  empty
    inline bool empty(size_t) const;
  //  calls empty<TElem>();
    template <class TElem>
    inline bool empty(size_t) const;
 
  //  begin
    template <class TElem>
    inline typename geometry_traits<TElem>::iterator
    begin(size_t);
 
  //  end
    template <class TElem>
    inline typename geometry_traits<TElem>::iterator
    end(size_t);
 
    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:
    using ISelector::AttachedVertexList;
    using ISelector::AttachedEdgeList;
    using ISelector::AttachedFaceList;
    using ISelector::AttachedVolumeList;
 
    using ISelector::VertexSectionContainer;
    using ISelector::EdgeSectionContainer;
    using ISelector::FaceSectionContainer;
    using ISelector::VolumeSectionContainer;
 
  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);
 
 
    inline VertexSectionContainer::iterator
    get_iterator(Vertex* o)
    {
      assert(is_selected(o) && "object not selected.");
      return section_container<Vertex>().get_container().get_iterator(o);
    }
 
    inline EdgeSectionContainer::iterator
    get_iterator(Edge* o)
    {
      assert(is_selected(o) && "object not selected");
      return section_container<Edge>().get_container().get_iterator(o);
    }
 
    inline FaceSectionContainer::iterator
    get_iterator(Face* o)
    {
      assert(is_selected(o) && "object not selected");
      return section_container<Face>().get_container().get_iterator(o);
    }
 
    inline VolumeSectionContainer::iterator
    get_iterator(Volume* o)
    {
      assert(is_selected(o) && "object not selected");
      return section_container<Volume>().get_container().get_iterator(o);
    }
    template <class TElem> inline
    typename Grid::traits<TElem>::SectionContainer&
    section_container();
 
    template <class TElem> inline
    const typename Grid::traits<TElem>::SectionContainer&
    section_container() const;
 
    template <class TElem>
    inline int get_section_index() const;
    
  private:
    Selector(const Selector& sel){};
 
  protected:
    VertexSectionContainer  m_vertices;
    EdgeSectionContainer  m_edges;
    FaceSectionContainer  m_faces;
    VolumeSectionContainer  m_volumes;
};
 
}// end of namespace
 
//  include implementation
#include "selector_grid_impl.hpp"
 
#endif