sub_grid.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016:  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__UG_sub_grid
#define __H__UG_sub_grid
 
namespace ug{
 
 
class ISubGrid {
public:
  virtual ~ISubGrid() {}
 
  virtual const GridObjectCollection& goc () const = 0;
  virtual bool is_contained(Vertex*) const = 0;
  virtual bool is_contained(Edge*) const = 0;
  virtual bool is_contained(Face*) const = 0;
  virtual bool is_contained(Volume*) const = 0;
};
 
 
 
template <class TCallbackCls>
class SubGrid : public ISubGrid{
public:
  SubGrid(GridObjectCollection goc, const TCallbackCls& cb) :
    m_goc (goc),
    m_callbacks (cb)
  {
  }
 
  virtual const GridObjectCollection& goc () const  {return m_goc;}
  virtual bool is_contained (Vertex* e) const     {return m_callbacks(e);}
  virtual bool is_contained (Edge* e) const     {return m_callbacks(e);}
  virtual bool is_contained (Face* e) const     {return m_callbacks(e);}
  virtual bool is_contained (Volume* e) const     {return m_callbacks(e);}
 
private:
  GridObjectCollection  m_goc;
  TCallbackCls      m_callbacks;
};
 
 
 
class IsInSubGrid
{
  public:
    IsInSubGrid(const ISubGrid& subGrid) :
      m_subGrid(subGrid)  {}
 
    bool operator() (Vertex* v) {return callback(v);}
    bool operator() (Edge* e) {return callback(e);}
    bool operator() (Face* f) {return callback(f);}
    bool operator() (Volume* v) {return callback(v);}
 
  private:
    template <class TElem>
    bool callback(TElem* e)   {return m_subGrid.is_contained(e);}
 
  private:
    const ISubGrid& m_subGrid;
};
 
 
 
class IsNotInSubGrid
{
  public:
    IsNotInSubGrid(const ISubGrid& subGrid) :
      m_subGrid(subGrid)  {}
 
    bool operator() (Vertex* v) {return callback(v);}
    bool operator() (Edge* e) {return callback(e);}
    bool operator() (Face* f) {return callback(f);}
    bool operator() (Volume* v) {return callback(v);}
 
  private:
    template <class TElem>
    bool callback(TElem* e)   {return !m_subGrid.is_contained(e);}
 
  private:
    const ISubGrid& m_subGrid;
};
 
}// end of namespace
 
#endif  //__H__UG_sub_grid