grid_object_collection.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-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__LIB_GRID__GEOMETRIC_OBJECT_COLLECTION__
#define __H__LIB_GRID__GEOMETRIC_OBJECT_COLLECTION__
 
#include <list>
#include "grid_base_objects.h"
#include "common/util/section_container.h"
#include "element_storage.h"
#include "grid_base_object_traits.h"
 
namespace ug
{
 
 
//  GridObjectCollection
 
class UG_API GridObjectCollection
{
  public:
    template <class TElem>
    struct traits{
      typedef typename geometry_traits<TElem>::iterator   iterator;
      typedef typename geometry_traits<TElem>::const_iterator const_iterator;
    };
 
 
    GridObjectCollection(size_t levelEstimate = 1);
    
    GridObjectCollection(ElementStorage<Vertex>::SectionContainer* vrtCon,
                ElementStorage<Edge>::SectionContainer* edgeCon,
                ElementStorage<Face>::SectionContainer* faceCon,
                ElementStorage<Volume>::SectionContainer* volCon);
 
  //  copy constructor.
    GridObjectCollection(const GridObjectCollection& mgoc);
    
    GridObjectCollection& operator =(const GridObjectCollection& mgoc);
    
    void add_level(ElementStorage<Vertex>::SectionContainer* vrtCon,
            ElementStorage<Edge>::SectionContainer* edgeCon,
            ElementStorage<Face>::SectionContainer* faceCon,
            ElementStorage<Volume>::SectionContainer* volCon);
 
    inline size_t num_levels() const    {return m_levels.size();}
    
  //  Iterators
  //  begin
    template <class TGeomObj>
    inline
    typename geometry_traits<TGeomObj>::iterator
    begin(size_t level = 0);
 
  //  end
    template <class TGeomObj>
    inline
    typename geometry_traits<TGeomObj>::iterator
    end(size_t level = 0);
 
    inline VertexIterator vertices_begin(size_t level = 0)  {return begin<Vertex>(level);}
    inline VertexIterator vertices_end(size_t level = 0)    {return end<Vertex>(level);}
    inline EdgeIterator   edges_begin(size_t level = 0)   {return begin<Edge>(level);}
    inline EdgeIterator   edges_end(size_t level = 0)     {return end<Edge>(level);}
    inline FaceIterator     faces_begin(size_t level = 0)   {return begin<Face>(level);}
    inline FaceIterator     faces_end(size_t level = 0)     {return end<Face>(level);}
    inline VolumeIterator   volumes_begin(size_t level = 0)   {return begin<Volume>(level);}
    inline VolumeIterator   volumes_end(size_t level = 0)   {return end<Volume>(level);}
 
  //  const iterators
  //  begin
    template <class TGeomObj>
    inline
    typename geometry_traits<TGeomObj>::const_iterator
    begin(size_t level = 0) const;
 
  //  end
    template <class TGeomObj>
    inline
    typename geometry_traits<TGeomObj>::const_iterator
    end(size_t level = 0) const;
 
    inline ConstVertexIterator  vertices_begin(size_t level = 0) const  {return begin<Vertex>(level);}
    inline ConstVertexIterator  vertices_end(size_t level = 0) const  {return end<Vertex>(level);}
    inline ConstEdgeIterator  edges_begin(size_t level = 0) const   {return begin<Edge>(level);}
    inline ConstEdgeIterator  edges_end(size_t level = 0) const   {return end<Edge>(level);}
    inline ConstFaceIterator    faces_begin(size_t level = 0) const   {return begin<Face>(level);}
    inline ConstFaceIterator    faces_end(size_t level = 0) const   {return end<Face>(level);}
    inline ConstVolumeIterator    volumes_begin(size_t level = 0) const {return begin<Volume>(level);}
    inline ConstVolumeIterator    volumes_end(size_t level = 0) const   {return end<Volume>(level);}
    
  //  element numbers
    template <class TGeomObj>
    size_t num() const;
    
    inline size_t num_vertices() const  {return num<Vertex>();}
    inline size_t num_edges() const   {return num<Edge>();}
    inline size_t num_faces() const   {return num<Face>();}
    inline size_t num_volumes() const {return num<Volume>();}
    
    template <class TGeomObj>
    inline
    size_t num(size_t level) const;
    
    inline size_t num_vertices(size_t level) const  {return num<Vertex>(level);}
    inline size_t num_edges(size_t level) const   {return num<Edge>(level);}
    inline size_t num_faces(size_t level) const   {return num<Face>(level);}
    inline size_t num_volumes(size_t level) const {return num<Volume>(level);}
    
  protected:
    void assign(const GridObjectCollection& goc);
 
    template <class TGeomObj> inline
    const typename ElementStorage<typename geometry_traits<TGeomObj>::grid_base_object>::
    SectionContainer* get_container(size_t level) const;
    
    template <class TGeomObj> inline
    typename ElementStorage<typename geometry_traits<TGeomObj>::grid_base_object>::
    SectionContainer* get_container(size_t level);
        
  protected:
    struct ContainerCollection{
      ContainerCollection() {}
      ContainerCollection(ElementStorage<Vertex>::SectionContainer* vrtCon,
                ElementStorage<Edge>::SectionContainer* edgeCon,
                ElementStorage<Face>::SectionContainer* faceCon,
                ElementStorage<Volume>::SectionContainer* volCon);
 
      ElementStorage<Vertex>::SectionContainer* vrtContainer;
      ElementStorage<Edge>::SectionContainer*   edgeContainer;
      ElementStorage<Face>::SectionContainer*     faceContainer;
      ElementStorage<Volume>::SectionContainer*   volContainer;
    };
    
    typedef std::vector<ContainerCollection> ContainerVec;
    //typedef std::vector<GridObjectCollection> GOCVec;
 
  protected:
    ContainerVec  m_levels;
};
 
}// end of namespace
 
//  include implementation
#include "grid_object_collection_impl.hpp"
 
#endif