ug4
algebra_type.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2015: G-CSC, Goethe University Frankfurt
3  * Author: Martin Rupp
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__LIB_ALGEBRA__ALGEBRA_TYPE__
34 #define __H__UG__LIB_ALGEBRA__ALGEBRA_TYPE__
35 
36 #include <ostream>
37 
38 namespace ug{
39 
42 
44 // Algebra Types
46 
49 {
50  public:
52  enum Type
53  {
54  CPU = 0,
55  GPU = 1
56  };
57 
59  enum {VariableBlockSize = -1};
60 
61  public:
63  AlgebraType();
64 
66  AlgebraType(Type type, int blockSize);
67 
69  AlgebraType(const char* type, int blockSize);
70 
72  AlgebraType(const char* type);
73 
75  int type() const {return m_type;}
76 
78  int blocksize() const {return m_blockSize;}
79 
80  protected:
81  int m_type;
83 };
84 
86 std::ostream& operator<<(std::ostream& out, const AlgebraType& v);
87 
88 
91 {
92  public:
93  static AlgebraType get() {return m_default;}
94  static void set(const AlgebraType& defaultType) {m_default = defaultType;}
95 
96  protected:
98 };
99 
100 // end group lib_algebra
102 
103 } // end namespace ug
104 
105 #endif /* __H__UG__LIB_ALGEBRA__ALGEBRA_TYPE__ */
class describing the type of an algebra
Definition: algebra_type.h:49
AlgebraType()
empty constructor
Definition: algebra_type.cpp:38
@ VariableBlockSize
Definition: algebra_type.h:59
int blocksize() const
returns the blocksize
Definition: algebra_type.h:78
int m_type
Definition: algebra_type.h:81
int m_blockSize
Definition: algebra_type.h:82
Type
types of algebra
Definition: algebra_type.h:53
@ CPU
Definition: algebra_type.h:54
@ GPU
Definition: algebra_type.h:55
int type() const
returns the type
Definition: algebra_type.h:75
Singleton, providing the current default algebra.
Definition: algebra_type.h:91
static AlgebraType get()
Definition: algebra_type.h:93
static void set(const AlgebraType &defaultType)
Definition: algebra_type.h:94
static AlgebraType m_default
Definition: algebra_type.h:97
std::ostream & operator<<(std::ostream &outStream, const ug::MathMatrix< 2, 2 > &m)
Definition: math_matrix.cpp:38
the ug namespace