ThunderEgg  1.0.0
Smoother.h
Go to the documentation of this file.
1 /***************************************************************************
2  * ThunderEgg, a library for solvers on adaptively refined block-structured
3  * Cartesian grids.
4  *
5  * Copyright (c) 2018-2021 Scott Aiton
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <https://www.gnu.org/licenses/>.
19  ***************************************************************************/
20 
21 #ifndef THUNDEREGG_GMG_SMOOTHER_H
22 #define THUNDEREGG_GMG_SMOOTHER_H
23 
28 #include <ThunderEgg/Vector.h>
29 namespace ThunderEgg::GMG {
33 template<int D>
34 class Smoother
35 {
36 public:
40  virtual ~Smoother() {}
46  virtual Smoother<D>* clone() const = 0;
53  virtual void smooth(const Vector<D>& f, Vector<D>& u) const = 0;
54 };
55 } // namespace ThunderEgg::GMG
56 #endif
ThunderEgg::GMG::Smoother::smooth
virtual void smooth(const Vector< D > &f, Vector< D > &u) const =0
Virtual function that derived classes have to implement.
Vector.h
Vector class.
ThunderEgg::GMG::Smoother::clone
virtual Smoother< D > * clone() const =0
Clone this smoother.
ThunderEgg::GMG::Smoother::~Smoother
virtual ~Smoother()
Destroy the Smoother object.
Definition: Smoother.h:40
ThunderEgg::Vector
Vector class for use in thunderegg.
Definition: Vector.h:42
ThunderEgg::GMG::Smoother
Abstract class for smoothing operators.
Definition: Smoother.h:34
ThunderEgg::GMG
Geometric-Multigrid classes.
Definition: Cycle.h:33