neighborhood.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-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__NEIGHBORHOOD__
#define __H__LIB_GRID__NEIGHBORHOOD__
 
#include <vector>
#include "grid.h"
#include "lib_grid/callbacks/basic_callbacks.h"
 
namespace ug
{
 
 
enum NeighborhoodType
{
  NHT_DEFAULT = 0,
  NHT_VERTEX_NEIGHBORS = 1,
  NHT_EDGE_NEIGHBORS = 1<<1,
  NHT_FACE_NEIGHBORS = 1<<2,
  NHT_VOLUME_NEIGHBORS = 1<<3,
  NHT_ALL = NHT_VERTEX_NEIGHBORS
      | NHT_EDGE_NEIGHBORS
      | NHT_FACE_NEIGHBORS
      | NHT_VOLUME_NEIGHBORS
};
 
 
void CollectNeighbors(std::vector<Vertex*>& vNeighborsOut,
            Grid& grid, Vertex* vrt, uint nbhType = NHT_EDGE_NEIGHBORS,
            Grid::edge_traits::callback considerEdge  = ConsiderAll(),
            Grid::face_traits::callback considerFace  = ConsiderAll(),
            Grid::volume_traits::callback considerVol = ConsiderAll());
 
//  CollectNeighbors
 
void CollectNeighbors(std::vector<Edge*>& vNeighborsOut, Edge* e,
             Grid& grid, NeighborhoodType nbhType = NHT_VERTEX_NEIGHBORS);
 
 
//  CollectNeighbors
 
void CollectNeighbors(std::vector<Face*>& vNeighborsOut, Face* f,
             Grid& grid, NeighborhoodType nbhType = NHT_EDGE_NEIGHBORS);
 
//  CollectNeighbors
 
void CollectNeighbors(std::vector<Volume*>& vNeighboursOut, Volume* v,
             Grid& grid, NeighborhoodType nbhType = NHT_FACE_NEIGHBORS);
 
 
void CollectNeighborhood(std::vector<Face*>& facesOut, Grid& grid,
              Vertex* vrt, size_t range,
              bool clearContainer = true);
 // end of doxygen defgroup command
 
}// end of namespace
 
#endif