ug4
Loading...
Searching...
No Matches
matrix_operator.h
Go to the documentation of this file.
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"
38
39namespace ug{
40
41
43// Matrix based linear operator
45
46template <typename M, typename X, typename Y = X>
47class MatrixOperator : public virtual ILinearOperator<X,Y>,
48 public M
49{
50 public:
51 // Domain space
53
54 // Range space
56
57 // Matrix type
58 typedef M matrix_type;
59
60 public:
61 // Init Operator J(u)
62 virtual void init(const X& u) {}
63
64 // Init Operator L
65 virtual void init() {}
66
67 // Apply Operator f = L*u (e.g. d = J(u)*c in iterative scheme)
68 virtual void apply(Y& f, const X& u) {matrix_type::apply(f,u);}
69
70 // Apply Operator, i.e. f = f - L*u;
71 virtual void apply_sub(Y& f, const X& u) {matrix_type::matmul_minus(f,u);}
72
73 // Access to matrix
74 virtual M& get_matrix() {return *this;};
75};
76
77template<typename M, typename X, typename Y>
85
86} // end namespace ug
87#endif /* __H__LIB_ALGEBRA__OPERATOR__INTERFACE__MATRIX_OPERATOR__ */
describes a linear mapping X->Y
Definition linear_operator.h:80
Definition matrix_operator.h:49
virtual void init(const X &u)
init operator depending on a function u
Definition matrix_operator.h:62
virtual M & get_matrix()
Definition matrix_operator.h:74
virtual void init()
init operator
Definition matrix_operator.h:65
M matrix_type
Definition matrix_operator.h:58
virtual void apply(Y &f, const X &u)
Definition matrix_operator.h:68
X domain_function_type
Definition matrix_operator.h:52
Y codomain_function_type
Definition matrix_operator.h:55
virtual void apply_sub(Y &f, const X &u)
Definition matrix_operator.h:71
the ug namespace
Definition matrix_algebra_types.h:79
static const int type
Definition matrix_algebra_types.h:80