attachment_util.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__ATTACHMENT_UTIL__
#define __H__LIB_GRID__ATTACHMENT_UTIL__
 
#include <vector>
#include "lib_grid/grid/grid.h"
 
namespace ug
{
 
 
template <class TAttachment>
class MultiElementAttachmentAccessor
{
  public:
    typedef typename TAttachment::ValueType ValueType;
    typedef typename attachment_value_traits<ValueType>::reference RefType;
    typedef typename attachment_value_traits<ValueType>::const_reference ConstRefType;
 
    MultiElementAttachmentAccessor()  {}
    MultiElementAttachmentAccessor(Grid& g, TAttachment& a, bool vrts = true,
              bool edges = true, bool faces = true, bool vols = true)
    {
      access(g, a, vrts, edges, faces, vols);
    }
 
    bool access(Grid& g, TAttachment& a, bool vrts = true, bool edges = true,
          bool faces = true, bool vols = true)
    {
      m_aaVrt.invalidate(); m_aaEdge.invalidate();
      m_aaFace.invalidate(); m_aaVol.invalidate();
 
      bool ok = true;
      if(vrts)
        ok &= m_aaVrt.access(g, a);
      if(edges)
        ok &= m_aaEdge.access(g, a);
      if(faces)
        ok &= m_aaFace.access(g, a);
      if(vols)
        ok &= m_aaVol.access(g, a);
      return ok;
    }
 
    void invalidate()
    {
      m_aaVrt.invalidate();
      m_aaEdge.invalidate();
      m_aaFace.invalidate();
      m_aaVol.invalidate();
    }
 
    bool is_valid_vertex_accessor() const   {return m_aaVrt.valid();}
    bool is_valid_edge_accessor() const     {return m_aaEdge.valid();}
    bool is_valid_face_accessor() const     {return m_aaFace.valid();}
    bool is_valid_volume_accessor() const   {return m_aaVol.valid();}
 
    RefType operator[](Vertex* e) {return m_aaVrt[e];}
    RefType operator[](Edge* e)   {return m_aaEdge[e];}
    RefType operator[](Face* e)     {return m_aaFace[e];}
    RefType operator[](Volume* e)   {return m_aaVol[e];}
    RefType operator[](GridObject* e)
    {
      switch(e->base_object_id()){
        case VERTEX: return m_aaVrt[static_cast<Vertex*>(e)];
        case EDGE: return m_aaEdge[static_cast<Edge*>(e)];
        case FACE: return m_aaFace[static_cast<Face*>(e)];
        case VOLUME: return m_aaVol[static_cast<Volume*>(e)];
        default: UG_THROW("Unknown element type!");
      }
    }
 
    ConstRefType operator[](Vertex* e) const  {return m_aaVrt[e];}
    ConstRefType operator[](Edge* e) const    {return m_aaEdge[e];}
    ConstRefType operator[](Face* e) const      {return m_aaFace[e];}
    ConstRefType operator[](Volume* e) const    {return m_aaVol[e];}
    ConstRefType operator[](GridObject* e) const
    {
      switch(e->base_object_id()){
        case VERTEX: return m_aaVrt[static_cast<Vertex*>(e)];
        case EDGE: return m_aaEdge[static_cast<Edge*>(e)];
        case FACE: return m_aaFace[static_cast<Face*>(e)];
        case VOLUME: return m_aaVol[static_cast<Volume*>(e)];
        default: UG_THROW("Unknown element type!");
      }
    }
 
    Grid::AttachmentAccessor<Vertex, TAttachment>&  vertex_accessor() {return m_aaVrt;}
    Grid::AttachmentAccessor<Edge, TAttachment>&  edge_accessor()   {return m_aaEdge;}
    Grid::AttachmentAccessor<Face, TAttachment>&    face_accessor()   {return m_aaFace;}
    Grid::AttachmentAccessor<Volume, TAttachment>&    volume_accessor() {return m_aaVol;}
 
  private:
    Grid::AttachmentAccessor<Vertex, TAttachment> m_aaVrt;
    Grid::AttachmentAccessor<Edge, TAttachment>   m_aaEdge;
    Grid::AttachmentAccessor<Face, TAttachment>     m_aaFace;
    Grid::AttachmentAccessor<Volume, TAttachment>   m_aaVol;
};
 
 
 
template <class TElem, class TAttachment>
class CompareByAttachment
{
  public:
    CompareByAttachment(Grid& g, TAttachment& aGID)
    {
      UG_ASSERT(g.has_attachment<TElem>(aGID),
            "Can't compare unattached attachments!");
      m_aaGID.access(g, aGID);
    }
 
    bool operator()(TElem* e1, TElem* e2)
    {
      return m_aaGID[e1] < m_aaGID[e2];
    }
 
  private:
    Grid::AttachmentAccessor<TElem, TAttachment>  m_aaGID;
};
 
//  SetAttachmentValues
template <class TAttachmentAccessor, class TIter, class TVal>
void SetAttachmentValues(TAttachmentAccessor& aaVal,
            TIter elemsBegin, TIter elemsEnd,
            const TVal& val);
 
//  ConvertMathVectorAttachmentValues
 
template<class TElem, class TSrcAttachment, class TDestAttachment>
bool ConvertMathVectorAttachmentValues(Grid& grid,
              TSrcAttachment& srcAttachment,
              TDestAttachment& destAttachment);
 
 
 
template <class TElem, class TAttachment>
bool CopyAttachments(Grid& srcGrid, TAttachment& aSrc,
          Grid& destGrid, TAttachment& aDest);
 
 
template <class TElemIter, class TAttachment>
bool CopyAttachments(Grid& grid, TElemIter elemsBegin, TElemIter elemsEnd,
           TAttachment& aSrc, TAttachment& aDest);
 
 
template <class TIterator, class TAAInt>
void AssignIndices(TIterator begin, TIterator end,
          TAAInt& aaInt, int baseIndex = 0);
 
 
template <class TIterator, class TAttAcc>
TIterator FindElementByValue(TIterator begin, TIterator end,
               const typename TAttAcc::ValueType& val,
               TAttAcc& aa);
 // end of doxygen defgroup command
}// end of namespace
 
// include implementations of template methods.
#include "attachment_util_impl.hpp"
 
#endif