ug4
operator.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__
34 #define __H__LIB_ALGEBRA__OPERATOR__INTERFACE__OPERATOR__
35 
36 
37 namespace ug{
38 
40 // (Nonlinear-) Operator
42 
44 
84 template <typename X, typename Y = X>
85 class IOperator
86 {
87  public:
90 
93 
94  public:
96 
102  virtual void init() = 0;
103 
105 
113  virtual void prepare(X& u) = 0;
114 
116 
126  virtual void apply(Y& d, const X& u) = 0;
127 
129  virtual ~IOperator() {};
130 };
131 
132 } // end namespace ug
133 
134 #endif /* __H__LIB_ALGEBRA__OPERATOR__INTERFACE__OPERATOR__ */
describes a mapping X->Y
Definition: operator.h:86
virtual void init()=0
initializes the operator
X domain_function_type
Domain space.
Definition: operator.h:89
virtual void apply(Y &d, const X &u)=0
computes the nonlinear mapping d := N(u)
virtual ~IOperator()
virtual destructor
Definition: operator.h:129
virtual void prepare(X &u)=0
prepares domain and codomain functions for application
Y codomain_function_type
Range space.
Definition: operator.h:92
the ug namespace