Loading [MathJax]/extensions/tex2jax.js
ug4
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
neighborhood.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2010-2015: G-CSC, Goethe University Frankfurt
3 * Author: Sebastian Reiter
4 *
5 * This file is part of UG4.
6 *
7 * UG4 is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License version 3 (as published by the
9 * Free Software Foundation) with the following additional attribution
10 * requirements (according to LGPL/GPL v3 §7):
11 *
12 * (1) The following notice must be displayed in the Appropriate Legal Notices
13 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
14 *
15 * (2) The following notice must be displayed at a prominent place in the
16 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
17 *
18 * (3) The following bibliography is recommended for citation and must be
19 * preserved in all covered files:
20 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
21 * parallel geometric multigrid solver on hierarchically distributed grids.
22 * Computing and visualization in science 16, 4 (2013), 151-164"
23 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
24 * flexible software system for simulating pde based models on high performance
25 * computers. Computing and visualization in science 16, 4 (2013), 165-179"
26 *
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU Lesser General Public License for more details.
31 */
32
33#ifndef __H__LIB_GRID__NEIGHBORHOOD__
34#define __H__LIB_GRID__NEIGHBORHOOD__
35
36#include <vector>
37#include "grid.h"
39
40namespace ug
41{
42
51
64
67
85void CollectNeighbors(std::vector<Vertex*>& vNeighborsOut,
86 Grid& grid, Vertex* vrt, uint nbhType = NHT_EDGE_NEIGHBORS,
87 Grid::edge_traits::callback considerEdge = ConsiderAll(),
88 Grid::face_traits::callback considerFace = ConsiderAll(),
89 Grid::volume_traits::callback considerVol = ConsiderAll());
90
92// CollectNeighbors
94
101void CollectNeighbors(std::vector<Edge*>& vNeighborsOut, Edge* e,
102 Grid& grid, NeighborhoodType nbhType = NHT_VERTEX_NEIGHBORS);
103
104
106// CollectNeighbors
108
115void CollectNeighbors(std::vector<Face*>& vNeighborsOut, Face* f,
116 Grid& grid, NeighborhoodType nbhType = NHT_EDGE_NEIGHBORS);
117
119// CollectNeighbors
121
129void CollectNeighbors(std::vector<Volume*>& vNeighboursOut, Volume* v,
130 Grid& grid, NeighborhoodType nbhType = NHT_FACE_NEIGHBORS);
131
134
136void CollectNeighborhood(std::vector<Face*>& facesOut, Grid& grid,
137 Vertex* vrt, size_t range,
138 bool clearContainer = true);
139
// end of doxygen defgroup command
141
142}// end of namespace
143
144#endif
NeighborhoodType
Constants to specify a neighborhood.
Definition neighborhood.h:53
void CollectNeighborhood(std::vector< Face * > &facesOut, Grid &grid, Vertex *vrt, size_t range, bool clearContainer)
Collects all neighbors in a given neighborhood of a vertex.
Definition neighborhood.cpp:415
void CollectNeighbors(std::vector< Vertex * > &vNeighborsOut, Grid &grid, Vertex *vrt, uint nbhType, Grid::edge_traits::callback considerEdge, Grid::face_traits::callback considerFace, Grid::volume_traits::callback considerVol)
Collects all vertices that are connected by elements of the specified type.
Definition neighborhood.cpp:43
@ NHT_VOLUME_NEIGHBORS
Definition neighborhood.h:58
@ NHT_DEFAULT
Definition neighborhood.h:54
@ NHT_VERTEX_NEIGHBORS
Definition neighborhood.h:55
@ NHT_FACE_NEIGHBORS
Definition neighborhood.h:57
@ NHT_EDGE_NEIGHBORS
Definition neighborhood.h:56
@ NHT_ALL
Definition neighborhood.h:59
unsigned int uint
Definition types.h:114
the ug namespace
boost::function< bool(base_object *)> callback
callback type for the elements base type.
Definition grid.h:150