ug4
util.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012-2015: G-CSC, Goethe University Frankfurt
3  * Author: Andreas Vogel
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_BRIDGE__UTIL__
34 #define __H__UG_BRIDGE__UTIL__
35 
36 #include "registry/registry.h"
37 #include "suffix_tag.h"
38 
39 namespace ug{
40 namespace bridge{
41 
44 
45 template <typename Functionality>
46 void RegisterCommon(Registry& reg, std::string grp)
47 {
48  Functionality::Common(reg,grp);
49 }
50 
51 template <typename Functionality>
52 void RegisterDimensionDependent(Registry& reg, std::string grp)
53 {
54 #ifdef UG_DIM_1
55  Functionality::template Dimension<1>(reg,grp);
56 #endif
57 #ifdef UG_DIM_2
58  Functionality::template Dimension<2>(reg,grp);
59 #endif
60 #ifdef UG_DIM_3
61  Functionality::template Dimension<3>(reg,grp);
62 #endif
63 }
64 
65 template <typename Functionality>
66 void RegisterDimension1dDependent(Registry& reg, std::string grp)
67 {
68 #ifdef UG_DIM_1
69  Functionality::template Dimension<1>(reg,grp);
70 #endif
71 }
72 
73 template <typename Functionality>
74 void RegisterDimension2dDependent(Registry& reg, std::string grp)
75 {
76 #ifdef UG_DIM_2
77  Functionality::template Dimension<2>(reg,grp);
78 #endif
79 }
80 
81 template <typename Functionality>
82 void RegisterDimension3dDependent(Registry& reg, std::string grp)
83 {
84 #ifdef UG_DIM_3
85  Functionality::template Dimension<3>(reg,grp);
86 #endif
87 }
88 
89 template <typename Functionality>
90 void RegisterDimension2d3dDependent(Registry& reg, std::string grp)
91 {
92  RegisterDimension2dDependent<Functionality>(reg, grp);
93  RegisterDimension3dDependent<Functionality>(reg, grp);
94 }
95 
96 // end group bridge
98 
99 } // end namespace bridge
100 } // end namespace ug
101 
102 #define UG_REGISTRY_CATCH_THROW(grp) \
103  catch(ug::bridge::UGRegistryError& ex) {\
104  UG_ERR_LOG("### ERROR while registering functionality at '"<<(grp)<<"'. "\
105  "Registration failed (using name " << ex.name << ").\n");\
106  throw(ex);}
107 
108 #endif /* __H__UG_BRIDGE__UTIL__ */
Registry for functions and classes that are exported to scripts and visualizations.
Definition: registry.h:138
void RegisterDimension2dDependent(Registry &reg, std::string grp)
Definition: util.h:74
void RegisterDimension1dDependent(Registry &reg, std::string grp)
Definition: util.h:66
void RegisterCommon(Registry &reg, std::string grp)
Definition: util.h:46
void RegisterDimension3dDependent(Registry &reg, std::string grp)
Definition: util.h:82
void RegisterDimensionDependent(Registry &reg, std::string grp)
Definition: util.h:52
void RegisterDimension2d3dDependent(Registry &reg, std::string grp)
Definition: util.h:90
the ug namespace