Loading [MathJax]/extensions/tex2jax.js
ug4
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
bridge.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
34#ifndef __H__UG_BRIDGE__UG_BRIDGE__
35#define __H__UG_BRIDGE__UG_BRIDGE__
36
37#include <string>
38#include <sstream>
39#include "registry/registry.h"
41#include "common/ug_config.h"
42
43namespace ug{
44namespace bridge{
45
53extern const char* UG4_GRP;
54
56UG_API Registry & GetUGRegistry();
57
59UG_API void InitUG(int dim, const AlgebraType& algebraType);
60
61
63UG_API void InitBridge();
64
66
67UG_API int GetUGDim();
68
70
73UG_API void RegisterStandardBridges(Registry& reg, std::string grp = UG4_GRP);
74
75// end group bridge
77
78}// end bridge
79}// end ug
80
81#include "suffix_tag.h"
82
83#endif /* __H__UG_BRIDGE__UG_BRIDGE__ */
Registry for functions and classes that are exported to scripts and visualizations.
Definition registry.h:138
int GetUGDim()
returns the dimension to which UG was initialized through InitUG
Definition bridge.cpp:205
void InitBridge()
calls RegisterStandardInterfaces
Definition bridge.cpp:65
const char * UG4_GRP
string for ug4 group
Definition bridge.cpp:52
Registry & GetUGRegistry()
returns the default registry used in ug
Definition bridge.cpp:58
#define UG_API
Definition ug_config.h:65
void RegisterStandardBridges(Registry &reg, string parentGroup)
Definition bridge.cpp:210
void InitUG(int dim, const AlgebraType &algType, bool verbose)
Sets the default classes of class-groups based on a tags.
Definition bridge.cpp:77
the ug namespace