Line data    Source code

       1              : /*
       2              :  * Copyright (c) 2013-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__LIB_ALGEBRA__OPERATOR__INTERFACE__MATRIX_OPERATOR__
      34              : #define __H__LIB_ALGEBRA__OPERATOR__INTERFACE__MATRIX_OPERATOR__
      35              : 
      36              : #include "linear_operator.h"
      37              : #include "lib_algebra/common/operations_mat/matrix_algebra_types.h"
      38              : 
      39              : namespace ug{
      40              : 
      41              : 
      42              : ///////////////////////////////////////////////////////////////////////////////
      43              : // Matrix based linear operator
      44              : ///////////////////////////////////////////////////////////////////////////////
      45              : 
      46              : template <typename M, typename X, typename Y = X>
      47           26 : class MatrixOperator :  public virtual ILinearOperator<X,Y>,
      48              :                                                 public M
      49              : {
      50              :         public:
      51              :         //      Domain space
      52              :                 typedef X domain_function_type;
      53              : 
      54              :         //      Range space
      55              :                 typedef Y codomain_function_type;
      56              : 
      57              :         //      Matrix type
      58              :                 typedef M matrix_type;
      59              : 
      60              :         public:
      61              :         //      Init Operator J(u)
      62            0 :                 virtual void init(const X& u) {}
      63              : 
      64              :         //      Init Operator L
      65            0 :                 virtual void init() {}
      66              : 
      67              :         //      Apply Operator f = L*u (e.g. d = J(u)*c in iterative scheme)
      68            0 :                 virtual void apply(Y& f, const X& u) {matrix_type::apply(f,u);}
      69              : 
      70              :         //      Apply Operator, i.e. f = f - L*u;
      71            0 :                 virtual void apply_sub(Y& f, const X& u) {matrix_type::matmul_minus(f,u);}
      72              : 
      73              :         //      Access to matrix
      74            0 :                 virtual M& get_matrix() {return *this;};
      75              : };
      76              : 
      77              : template<typename M, typename X, typename Y>
      78              : struct matrix_algebra_type_traits<MatrixOperator<M, X, Y> >
      79              : {
      80              :         enum
      81              :         {
      82              :                 type = matrix_algebra_type_traits<M>::type
      83              :         };
      84              : };
      85              : 
      86              : } // end namespace ug
      87              : #endif /* __H__LIB_ALGEBRA__OPERATOR__INTERFACE__MATRIX_OPERATOR__ */