bool_marker.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-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__UG__bool_marker__
#define __H__UG__bool_marker__
 
#include "lib_grid/grid/grid.h"
#include "lib_grid/common_attachments.h"
 
namespace ug
{
 
 
class BoolMarker : public GridObserver
{
  public:
    BoolMarker();
    BoolMarker(Grid& g);
 
    virtual ~BoolMarker();
 
 
    void assign_grid(Grid* g);
    void assign_grid(Grid& g)         {assign_grid(&g);}
 
    Grid* grid()                {return m_pGrid;}
 
 
    void set_default_mark(bool mark)      {m_defaultMark = mark;}
    bool default_mark()             {return m_defaultMark;}
 
 
    void enable_mark_inheritance(bool enable) {m_markInheritanceEnabled = enable;}
    bool mark_inheritance_enabeld()       {return m_markInheritanceEnabled;}
    void enable_strict_inheritance(bool enable) {m_strictInheritanceEnabled = enable;}
    bool strict_inheritance_enabled()     {return m_strictInheritanceEnabled;}
    bool is_marked(GridObject* e) const;
    bool is_marked(Vertex* e) const     {assert(m_pGrid); return m_aaMarkVRT[e];}
    bool is_marked(Edge* e) const     {assert(m_pGrid); return m_aaMarkEDGE[e];}
    bool is_marked(Face* e) const       {assert(m_pGrid); return m_aaMarkFACE[e];}
    bool is_marked(Volume* e) const       {assert(m_pGrid); return m_aaMarkVOL[e];}
 
    void mark(Vertex* e, bool mark = true)  {assert(m_pGrid); m_aaMarkVRT[e] = mark;}
    void mark(Edge* e, bool mark = true)  {assert(m_pGrid); m_aaMarkEDGE[e] = mark;}
    void mark(Face* e, bool mark = true)    {assert(m_pGrid); m_aaMarkFACE[e] = mark;}
    void mark(Volume* e, bool mark = true)    {assert(m_pGrid); m_aaMarkVOL[e] = mark;}
 
    template <class TIter>
    void mark(TIter begin, TIter end, bool mark = true)
    {
      for(TIter iter = begin; iter != end; ++iter) BoolMarker::mark(*iter, mark);
    }
 
    void unmark(Vertex* e)  {mark(e, false);}
    void unmark(Edge* e)  {mark(e, false);}
    void unmark(Face* e)    {mark(e, false);}
    void unmark(Volume* e)    {mark(e, false);}
 
    template <class TIter>
    void unmark(TIter begin, TIter end)     {mark(begin, end, false);}
 
    void clear();
 
    virtual void grid_to_be_destroyed(Grid* grid);
 
  //  element callbacks
    virtual void vertex_created(Grid* grid, Vertex* vrt,
                  GridObject* pParent = NULL,
                  bool replacesParent = false);
 
    virtual void edge_created(Grid* grid, Edge* e,
                  GridObject* pParent = NULL,
                  bool replacesParent = false);
 
    virtual void face_created(Grid* grid, Face* f,
                  GridObject* pParent = NULL,
                  bool replacesParent = false);
 
    virtual void volume_created(Grid* grid, Volume* vol,
                  GridObject* pParent = NULL,
                  bool replacesParent = false);
 
    virtual void vertices_to_be_merged(Grid* grid, Vertex* target,
                     Vertex* elem1, Vertex* elem2);
 
    virtual void edges_to_be_merged(Grid* grid, Edge* target,
                     Edge* elem1, Edge* elem2);
 
    virtual void faces_to_be_merged(Grid* grid, Face* target,
                     Face* elem1, Face* elem2);
 
    virtual void volumes_to_be_merged(Grid* grid, Volume* target,
                     Volume* elem1, Volume* elem2);
 
  protected:
    Grid* m_pGrid;
    ABool m_aBool;
    bool  m_defaultMark;
    bool  m_markInheritanceEnabled;
    bool  m_strictInheritanceEnabled;
    Grid::AttachmentAccessor<Vertex, ABool> m_aaMarkVRT;
    Grid::AttachmentAccessor<Edge, ABool> m_aaMarkEDGE;
    Grid::AttachmentAccessor<Face, ABool>   m_aaMarkFACE;
    Grid::AttachmentAccessor<Volume, ABool>   m_aaMarkVOL;
};
 
}// end of namespace
 
#endif