grid_util_impl.hpp

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__GRID_UTIL_IMPL__
#define __H__LIB_GRID__GRID_UTIL_IMPL__
 
#include <vector>
#include "grid_util.h"
#include "common/assert.h"
#include "common/common.h"
 
namespace ug
{
//  EdgeContains
inline bool EdgeContains(EdgeVertices* e, Vertex* vrt)
{
  return e->vertex(0) == vrt || e->vertex(1) == vrt;
}
 
inline bool EdgeContains(EdgeVertices* e, Vertex* vrt1, Vertex* vrt2)
{
  return ((e->vertex(0) == vrt1 && e->vertex(1) == vrt2)
      || (e->vertex(1) == vrt1 && e->vertex(0) == vrt2));
}
 
//  new methods
 
template <class TVrtContainer1, class TVrtContainer2>
bool CompareVertexContainer(const TVrtContainer1& con1,
          const TVrtContainer2& con2)
{
  int con1Size = (int)con1.size();
 
  if(con1Size != con2.size())
    return false;
 
  for(int i = 0; i < con1Size; ++i)
  {
    int j;
    for(j = 0; j < con1Size; ++j)
    {
      if(con1[i] == con2[j])
        break;
    }
 
  //  check whether we found a matching vertex
    if(j == con1Size)
      return false;
  }
 
  return true;
}
 
 
inline bool CompareVertices(const EdgeVertices* ev1,
          const EdgeVertices* ev2)
{
  if((ev1->vertex(0) == ev2->vertex(0) && ev1->vertex(1) == ev2->vertex(1)) ||
    (ev1->vertex(0) == ev2->vertex(1) && ev1->vertex(1) == ev2->vertex(0)))
    return true;
  return false;
}
 
//  GetVertex
inline Vertex* GetVertex(Vertex* vrt, size_t i)
{
  UG_ASSERT(i < 1, "A Vertex has only one vertex");
  return vrt;
}
 
inline Vertex* GetVertex(Edge* edge, size_t i)
{
  UG_ASSERT(i < edge->num_vertices(), "Wrong number of vertex");
  return edge->vertex(i);
}
 
inline Vertex* GetVertex(Face* face, size_t i)
{
  UG_ASSERT(i < face->num_vertices(), "Wrong number of vertex");
  return face->vertex(i);
}
 
inline Vertex* GetVertex(Volume* vol, size_t i)
{
  UG_ASSERT(i < vol->num_vertices(), "Wrong number of vertex");
  return vol->vertex(i);
}
 
inline size_t NumVertices(Vertex* elem)
{
  return 1;
}
 
inline size_t NumVertices(Edge* elem)
{
  return elem->num_vertices();
}
 
inline size_t NumVertices(Face* elem)
{
  return elem->num_vertices();
}
 
inline size_t NumVertices(Volume* elem)
{
  return elem->num_vertices();
}
 
 
inline void CollectAssociated(std::vector<Vertex*>& vVertexOut,
            Grid& grid, Vertex* v, bool clearContainer)
{
  CollectVertices(vVertexOut, grid, v, clearContainer);
}
 
inline void CollectAssociated(std::vector<Vertex*>& vVertexOut,
             Grid& grid, Edge* e, bool clearContainer)
{
  CollectVertices(vVertexOut, grid, e, clearContainer);
}
 
inline void CollectAssociated(std::vector<Vertex*>& vVertexOut,
             Grid& grid, Face* f, bool clearContainer)
{
  CollectVertices(vVertexOut, grid, f, clearContainer);
}
 
inline void CollectAssociated(std::vector<Vertex*>& vVertexOut,
             Grid& grid, Volume* v, bool clearContainer)
{
  CollectVertices(vVertexOut, grid, v, clearContainer);
}
 
inline void CollectAssociated(std::vector<Vertex*>& vVertexOut,
                              Grid& grid, GridObject* obj, bool clearContainer)
{
  uint type = obj->base_object_id();
  switch(type)
  {
    case VERTEX:CollectAssociated(vVertexOut, grid, reinterpret_cast<Vertex*>(obj), clearContainer); return;
    case EDGE:  CollectAssociated(vVertexOut, grid, reinterpret_cast<Edge*>(obj), clearContainer); return;
    case FACE:  CollectAssociated(vVertexOut, grid, reinterpret_cast<Face*>(obj), clearContainer); return;
    case VOLUME:CollectAssociated(vVertexOut, grid, reinterpret_cast<Volume*>(obj), clearContainer); return;
  }
  throw(UGError("GeomObject type not known."));
}
 
 
inline void CollectAssociated(std::vector<Edge*>& vEdgesOut,
          Grid& grid, Vertex* vrt, bool clearContainer)
{
  CollectEdges(vEdgesOut, grid, vrt, clearContainer);
}
 
inline void CollectAssociated(std::vector<Edge*>& vEdgesOut,
          Grid& grid, Edge* e, bool clearContainer)
{
  CollectEdges(vEdgesOut, grid, e, clearContainer);
}
 
inline void CollectAssociated(std::vector<Edge*>& vEdgesOut,
          Grid& grid, Face* f, bool clearContainer)
{
  CollectEdges(vEdgesOut, grid, f, clearContainer);
}
 
inline void CollectAssociated(std::vector<Edge*>& vEdgesOut,
          Grid& grid, Volume* v, bool clearContainer)
{
  CollectEdges(vEdgesOut, grid, v, clearContainer);
}
 
inline void CollectAssociated(std::vector<Edge*>& vEdgesOut,
                              Grid& grid, GridObject* obj, bool clearContainer)
{
  uint type = obj->base_object_id();
  switch(type)
  {
    case VERTEX:CollectAssociated(vEdgesOut, grid, reinterpret_cast<Vertex*>(obj), clearContainer); return;
    case EDGE:  CollectAssociated(vEdgesOut, grid, reinterpret_cast<Edge*>(obj), clearContainer); return;
    case FACE:  CollectAssociated(vEdgesOut, grid, reinterpret_cast<Face*>(obj), clearContainer); return;
    case VOLUME:CollectAssociated(vEdgesOut, grid, reinterpret_cast<Volume*>(obj), clearContainer); return;
  }
  throw(UGError("GeomObject type not known."));
}
 
 
inline void CollectAssociated(std::vector<Face*>& vFacesOut,
          Grid& grid, Vertex* vrt, bool clearContainer)
{
  CollectFaces(vFacesOut, grid, vrt, clearContainer);
}
 
inline void CollectAssociated(std::vector<Face*>& vFacesOut,
          Grid& grid, Edge* e, bool clearContainer)
{
  CollectFaces(vFacesOut, grid, e, clearContainer);
}
 
inline void CollectAssociated(std::vector<Face*>& vFacesOut,
          Grid& grid, Face* f, bool clearContainer)
{
  CollectFaces(vFacesOut, grid, f, clearContainer);
}
 
inline void CollectAssociated(std::vector<Face*>& vFacesOut,
          Grid& grid, Volume* v, bool clearContainer)
{
  CollectFaces(vFacesOut, grid, v, clearContainer);
}
 
inline void CollectAssociated(std::vector<Face*>& vFacesOut,
                              Grid& grid, GridObject* obj, bool clearContainer)
{
  uint type = obj->base_object_id();
  switch(type)
  {
    case VERTEX:CollectAssociated(vFacesOut, grid, reinterpret_cast<Vertex*>(obj), clearContainer); return;
    case EDGE:  CollectAssociated(vFacesOut, grid, reinterpret_cast<Edge*>(obj), clearContainer); return;
    case FACE:  CollectAssociated(vFacesOut, grid, reinterpret_cast<Face*>(obj), clearContainer); return;
    case VOLUME:CollectAssociated(vFacesOut, grid, reinterpret_cast<Volume*>(obj), clearContainer); return;
  }
  throw(UGError("GeomObject type not known."));
}
 
 
inline void CollectAssociated(std::vector<Volume*>& vVolumesOut,
          Grid& grid, Vertex* vrt, bool clearContainer)
{
  CollectVolumes(vVolumesOut, grid, vrt, clearContainer);
}
 
inline void CollectAssociated(std::vector<Volume*>& vVolumesOut,
          Grid& grid, Edge* e, bool clearContainer)
{
  CollectVolumes(vVolumesOut, grid, e, clearContainer);
}
 
inline void CollectAssociated(std::vector<Volume*>& vVolumesOut,
          Grid& grid, Face* f, bool clearContainer,
          bool ignoreAssociatedVolumes)
{
  CollectVolumes(vVolumesOut, grid, f, clearContainer, ignoreAssociatedVolumes);
}
 
inline void CollectAssociated(std::vector<Volume*>& vVolumesOut,
          Grid& grid, Volume* vol, bool clearContainer)
{
  CollectVolumes(vVolumesOut, grid, vol, clearContainer);
}
 
inline void CollectAssociated(std::vector<Volume*>& vVolumesOut,
          Grid& grid, FaceDescriptor& fd, bool clearContainer)
{
  CollectVolumes(vVolumesOut, grid, fd, clearContainer);
}
 
inline void CollectAssociated(std::vector<Volume*>& vVolumesOut,
                              Grid& grid, GridObject* obj, bool clearContainer)
{
  uint type = obj->base_object_id();
  switch(type)
  {
    case VERTEX:CollectAssociated(vVolumesOut, grid, reinterpret_cast<Vertex*>(obj), clearContainer); return;
    case EDGE:  CollectAssociated(vVolumesOut, grid, reinterpret_cast<Edge*>(obj), clearContainer); return;
    case FACE:  CollectAssociated(vVolumesOut, grid, reinterpret_cast<Face*>(obj), clearContainer); return;
    case VOLUME:CollectAssociated(vVolumesOut, grid, reinterpret_cast<Volume*>(obj), clearContainer); return;
  }
  throw(UGError("GeomObject type not known."));
}
 
 
inline void CollectVertices(std::vector<Vertex*>& vVertexOut, Grid& grid,
                                    GridObject* obj, bool clearContainer)
{
  switch(obj->base_object_id())
  {
    case VERTEX:CollectVertices(vVertexOut, grid, static_cast<Vertex*>(obj), clearContainer); return;
    case EDGE:  CollectVertices(vVertexOut, grid, static_cast<Edge*>(obj), clearContainer); return;
    case FACE:  CollectVertices(vVertexOut, grid, static_cast<Face*>(obj), clearContainer); return;
    case VOLUME:CollectVertices(vVertexOut, grid, static_cast<Volume*>(obj), clearContainer); return;
  }
  throw(UGError("GeomObject type not known."));
}
 
inline void CollectEdgesSorted(std::vector<Edge*>& vEdgesOut, Grid& grid,
                                    GridObject* obj, bool clearContainer)
{
  switch(obj->base_object_id())
  {
    case VERTEX:CollectEdgesSorted(vEdgesOut, grid, static_cast<Vertex*>(obj), clearContainer); return;
    case EDGE:  CollectEdgesSorted(vEdgesOut, grid, static_cast<Edge*>(obj), clearContainer); return;
    case FACE:  CollectEdgesSorted(vEdgesOut, grid, static_cast<Face*>(obj), clearContainer); return;
    case VOLUME:CollectEdgesSorted(vEdgesOut, grid, static_cast<Volume*>(obj), clearContainer); return;
  }
  throw(UGError("GeomObject type not known."));
}
 
inline void CollectFacesSorted(std::vector<Face*>& vFacesOut, Grid& grid,
                                    GridObject* obj, bool clearContainer)
{
  switch(obj->base_object_id())
  {
    case VERTEX:CollectFacesSorted(vFacesOut, grid, static_cast<Vertex*>(obj), clearContainer); return;
    case EDGE:  CollectFacesSorted(vFacesOut, grid, static_cast<Edge*>(obj), clearContainer); return;
    case FACE:  CollectFacesSorted(vFacesOut, grid, static_cast<Face*>(obj), clearContainer); return;
    case VOLUME:CollectFacesSorted(vFacesOut, grid, static_cast<Volume*>(obj), clearContainer); return;
  }
  throw(UGError("GeomObject type not known."));
}
 
}// end of namespace libGrid
 
#endif