ug4
Loading...
Searching...
No Matches
matrix_operator_inverse.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_INVERSE__
34#define __H__LIB_ALGEBRA__OPERATOR__INTERFACE__MATRIX_OPERATOR_INVERSE__
35
37#include "matrix_operator.h"
38#include "common/error.h"
40
41namespace ug{
42
44// Inverse of a Matrix-based Linear Operator
46
48
61template <typename M, typename X, typename Y = X>
63 : public virtual ILinearOperatorInverse<X,Y>
64{
65 public:
68
71
73 typedef M matrix_type;
74
75 public:
77
84 virtual bool init(SmartPtr<MatrixOperator<M,Y,X> > A) = 0;
85
87
94 virtual bool apply(Y& u, const X& f) = 0;
95
97
105 virtual bool apply_return_defect(Y& u, X& f) = 0;
106
109
110 public:
112
122 virtual bool init(SmartPtr<ILinearOperator<Y,X> > A, const Y&u)
123 {
124 // forget about u and forward request.
125 return init(A);
126 }
127
129
139 {
140 // cast operator
142 A.template cast_dynamic<MatrixOperator<M,Y,X> >();
143
144 // check if correct types are present
145 if(op.invalid())
146 UG_THROW("IMatrixOperatorInverse::init:"
147 " Passed operator is not matrix-based.");
148
149 // forward request
150 return init(op);
151 }
152};
153
154}
155#endif /* __H__LIB_ALGEBRA__OPERATOR__INTERFACE__MATRIX_OPERATOR_INVERSE__ */
Definition smart_pointer.h:108
bool invalid() const
returns true if the pointer is invalid, false if not.
Definition smart_pointer.h:212
describes a linear mapping X->Y
Definition linear_operator.h:80
describes an inverse linear mapping X->Y
Definition linear_operator_inverse.h:80
describes an inverse linear mapping X->Y based on a matrix
Definition matrix_operator_inverse.h:64
X domain_function_type
Domain space.
Definition matrix_operator_inverse.h:67
virtual bool apply_return_defect(Y &u, X &f)=0
applies the inverse operator and updates the defect
virtual bool apply(Y &u, const X &f)=0
applies the inverse operator, i.e. returns u = A^{-1} * f
virtual bool init(SmartPtr< ILinearOperator< Y, X > > A)
initializes this inverse operator for a linear operator
Definition matrix_operator_inverse.h:138
virtual bool init(SmartPtr< ILinearOperator< Y, X > > A, const Y &u)
initializes this inverse operator for a linear operator
Definition matrix_operator_inverse.h:122
virtual ~IMatrixOperatorInverse()
virtual destructor
Definition matrix_operator_inverse.h:108
M matrix_type
Matrix type.
Definition matrix_operator_inverse.h:73
Y codomain_function_type
Range space.
Definition matrix_operator_inverse.h:70
virtual bool init(SmartPtr< MatrixOperator< M, Y, X > > A)=0
initializes this inverse operator for a matrix-based operator
Definition matrix_operator.h:49
virtual void init()
#define UG_THROW(msg)
Definition error.h:57
the ug namespace