Loading [MathJax]/extensions/tex2jax.js
ug4
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
operator_inverse.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2010-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__OPERATOR_INVERSE__
34#define __H__LIB_ALGEBRA__OPERATOR__INTERFACE__OPERATOR_INVERSE__
35
37#include "operator.h"
38#include <string>
39
40namespace ug{
41
43// Inverse of a (Nonlinear-) Operator
45
46// \todo: The prepare methods seems obsolet, since it could be handled in the
47// apply method. It depends on how expensive the prepare is, and how
48// often we would apply the operator to an already apply one (?)
50
77template <typename X, typename Y = X>
79{
80 public:
83
86
87 public:
89
97 virtual bool init(SmartPtr<IOperator<Y,X> > N) = 0;
98
100
107 virtual bool prepare(X& u) = 0;
108
110
116 virtual bool apply(X& u) = 0;
117
119 virtual ~IOperatorInverse() {};
120
122
128 virtual std::string config_string() const = 0;
129};
130
131
132
133
134} // end namespace ug
135
136#endif /* __H__LIB_ALGEBRA__OPERATOR__INTERFACE__OPERATOR_INVERSE__ */
Definition smart_pointer.h:108
describes a mapping X->Y
Definition operator.h:86
describes an inverse mapping X->Y
Definition operator_inverse.h:79
virtual bool apply(X &u)=0
apply the operator, i.e. u = N^{-1}(0)
virtual bool prepare(X &u)=0
prepares the function u for application
X domain_function_type
Domain space.
Definition operator_inverse.h:82
Y codomain_function_type
Range space.
Definition operator_inverse.h:85
virtual bool init(SmartPtr< IOperator< Y, X > > N)=0
initializes the operator for the inversion of the operator N: Y -> X
virtual std::string config_string() const =0
returns information about configuration parameters
virtual ~IOperatorInverse()
virtual destructor
Definition operator_inverse.h:119
the ug namespace