grid_observer.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__LIBGRID__GRID_OBSERVERS__
#define __H__LIBGRID__GRID_OBSERVERS__
 
#include "common/types.h"
 
namespace ug
{
//  predeclarations
class Grid;
class Vertex;
class Edge;
class Face;
class Volume;
 
 
//  Observer types
enum ObserverType
{
  OT_NONE = 0,
  OT_GRID_OBSERVER = 1,
  OT_VERTEX_OBSERVER = 2,
  OT_EDGE_OBSERVER = 4,
  OT_FACE_OBSERVER = 8,
  OT_VOLUME_OBSERVER = 16,
  OT_FULL_OBSERVER = OT_GRID_OBSERVER | OT_VERTEX_OBSERVER | OT_EDGE_OBSERVER |
            OT_FACE_OBSERVER | OT_VOLUME_OBSERVER
};
 
//  GridObserver
class UG_API GridObserver
{
  public:
    virtual ~GridObserver() {}
 
  //  grid callbacks
    virtual void grid_to_be_destroyed(Grid* grid)   {}
    virtual void elements_to_be_cleared(Grid* grid)   {}
 
  //  creation 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)      {}
 
 
  //  erase callbacks
 
    virtual void vertex_to_be_erased(Grid* grid, Vertex* vrt,
                     Vertex* replacedBy = NULL) {}
 
    virtual void edge_to_be_erased(Grid* grid, Edge* e,
                     Edge* replacedBy = NULL) {}
 
    virtual void face_to_be_erased(Grid* grid, Face* f,
                     Face* replacedBy = NULL) {}
 
    virtual void volume_to_be_erased(Grid* grid, Volume* vol,
                     Volume* replacedBy = NULL) {}
 
  //  merge callbacks
 
    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)  {}
 
};
 
}// end of namespace
 
#endif