ug4
multi_grid_util.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__UG__MULTI_GRID_UTIL__
34 #define __H__UG__MULTI_GRID_UTIL__
35 
36 #include "lib_grid/lg_base.h"
37 
38 namespace ug
39 {
40 
42 template <class TElem>
43 void CollectSurfaceViewElements(ISubsetHandler& surfaceViewOut,
44  MultiGrid& mg,
45  MGSubsetHandler& mgsh,
46  bool clearContainer = true);
47 
52 template <class TElem, class TSurfaceView>
53 void CreateSurfaceView(TSurfaceView& surfaceViewOut,
54  MultiGrid& mg,
55  MGSubsetHandler& mgsh);
56 
58 
64 template <class TElem>
65 bool IsSubSurfaceElement(MultiGrid& mg, TElem* e, bool checkSides = false);
66 
67 
68 }// end of namespace
69 
71 // include implementation
72 #include "multi_grid_util_impl.hpp"
73 
74 #endif
the ug namespace
bool IsSubSurfaceElement(MultiGrid &mg, TElem *e, bool checkSides=false)
returns true, if the element lies one level below the surface
Definition: multi_grid_util_impl.hpp:111
MultiGridSubsetHandler MGSubsetHandler
Definition: subset_handler_multi_grid.h:377
void CreateSurfaceView(TSurfaceView &surfaceViewOut, MultiGrid &mg, MGSubsetHandler &mgsh)
Definition: multi_grid_util_impl.hpp:74
void CollectSurfaceViewElements(ISubsetHandler &surfaceViewOut, MultiGrid &mg, MGSubsetHandler &mgsh, bool clearContainer=true)
Definition: multi_grid_util_impl.hpp:42