Line data    Source code

       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              : 
      40              : /// \addtogroup lib_algebra lib_algebra
      41              : /// \{
      42              : 
      43              : ////////////////////////////////////////////////////////////////////////////////
      44              : //   Algebra Types
      45              : ////////////////////////////////////////////////////////////////////////////////
      46              : 
      47              : /// class describing the type of an algebra
      48              : class AlgebraType
      49              : {
      50              :         public:
      51              :         ///     types of algebra
      52              :                 enum Type
      53              :                 {
      54              :                         CPU = 0,
      55              :                         GPU = 1
      56              :                 };
      57              : 
      58              :         ///     indicating variable block size
      59              :                 enum {VariableBlockSize = -1};
      60              : 
      61              :         public:
      62              :         ///     empty constructor
      63              :                 AlgebraType();
      64              : 
      65              :         ///     constructor for fix blocksize
      66              :                 AlgebraType(Type type, int blockSize);
      67              : 
      68              :         ///     constructor for fix blocksize
      69              :                 AlgebraType(const char* type, int blockSize);
      70              : 
      71              :         ///     constructor for variable block size
      72              :                 AlgebraType(const char* type);
      73              : 
      74              :         ///     returns the type
      75          384 :                 int type() const {return m_type;}
      76              : 
      77              :         ///     returns the blocksize
      78          384 :                 int blocksize() const {return m_blockSize;}
      79              : 
      80              :         protected:
      81              :                 int m_type;
      82              :                 int m_blockSize;
      83              : };
      84              : 
      85              : /// writes the Identifier to the output stream
      86              : std::ostream& operator<<(std::ostream& out,       const AlgebraType& v);
      87              : 
      88              : 
      89              : /// Singleton, providing the current default algebra.
      90              : class DefaultAlgebra
      91              : {
      92              :         public:
      93            0 :                 static AlgebraType get() {return m_default;}
      94            0 :                 static void set(const AlgebraType& defaultType) {m_default = defaultType;}
      95              : 
      96              :         protected:
      97              :                 static AlgebraType m_default;
      98              : };
      99              : 
     100              : // end group lib_algebra
     101              : /// \}
     102              : 
     103              : } // end namespace ug
     104              : 
     105              : #endif /* __H__UG__LIB_ALGEBRA__ALGEBRA_TYPE__ */