ug4
parallel_callbacks.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-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__parallel_callbacks__
34 #define __H__UG__parallel_callbacks__
35 
36 #include "../distributed_grid.h"
37 #include "common/assert.h"
38 
39 namespace ug
40 {
41 
43 
48 {
49  public:
51  m_dgm(dgm), m_mg(dgm.get_assigned_grid())
52  {
53  UG_ASSERT(m_mg, "A grid has to be assigned to the distributed grid manager.");
54  }
55 
56  bool operator() (Vertex* v) {return is_ok(v);}
57  bool operator() (Edge* e) {return is_ok(e);}
58  bool operator() (Face* f) {return is_ok(f);}
59  bool operator() (Volume* v) {return is_ok(v);}
60 
61  private:
62  template <class TElem>
63  inline bool is_ok(TElem* e)
64  {
65  return !(m_mg->has_children(e) || m_dgm.is_ghost(e));
66  }
67 
69  const MultiGrid* m_mg;
70 };
71 
72 }// end of namespace
73 
74 #endif
manages the layouts and interfaces which are associated with a distributed grid.
Definition: distributed_grid.h:88
bool is_ghost(TElem *elem) const
returns true if the element is a ghost
Definition: distributed_grid_impl.hpp:67
Base-class for edges.
Definition: grid_base_objects.h:397
Faces are 2-dimensional objects.
Definition: grid_base_objects.h:510
Returns true if an element is a regular surface element.
Definition: parallel_callbacks.h:48
IsRegularSurfaceElem(const DistributedGridManager &dgm)
Definition: parallel_callbacks.h:50
bool is_ok(TElem *e)
Definition: parallel_callbacks.h:63
const MultiGrid * m_mg
Definition: parallel_callbacks.h:69
bool operator()(Vertex *v)
Definition: parallel_callbacks.h:56
const DistributedGridManager & m_dgm
Definition: parallel_callbacks.h:68
Definition: multi_grid.h:72
bool has_children(TElem *elem) const
Definition: multi_grid.h:217
Base-class for all vertex-types.
Definition: grid_base_objects.h:231
Volumes are 3-dimensional objects.
Definition: grid_base_objects.h:754
#define UG_ASSERT(expr, msg)
Definition: assert.h:70
the ug namespace