Line data    Source code

       1              : /*
       2              :  * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
       3              :  * Author: Markus Breit
       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_DISC__OPERATOR__LINEAR_OPERATOR__LEVEL_PRECONDITIONER_INTERFACE_H__
      34              : #define __H__LIB_DISC__OPERATOR__LINEAR_OPERATOR__LEVEL_PRECONDITIONER_INTERFACE_H__
      35              : 
      36              : 
      37              : #include "lib_algebra/operator/interface/preconditioner.h"
      38              : #include "lib_grid/tools/grid_level.h"
      39              : 
      40              : 
      41              : namespace ug {
      42              : 
      43              : 
      44              : /// A preconditioner for the multi-grid context which is aware of the grid level it operates on.
      45              : template <typename TAlgebra>
      46              : class ILevelPreconditioner : public IPreconditioner<TAlgebra>
      47              : {
      48              :         public:
      49              :                 /// constructor
      50              :                 ILevelPreconditioner()
      51              :                 : IPreconditioner<TAlgebra>(), m_gl() {}
      52              : 
      53              :                 /// constructor with grid level
      54              :                 ILevelPreconditioner(const GridLevel& gl)
      55              :                 : IPreconditioner<TAlgebra>(), m_gl(gl) {}
      56              : 
      57              :                 /// clone constructor
      58              :                 ILevelPreconditioner(const ILevelPreconditioner<TAlgebra>& parent)
      59              :                 : IPreconditioner<TAlgebra>(parent), m_gl(parent.m_gl) {}
      60              : 
      61              :                 /// set the grid level
      62              :                 void set_grid_level(const GridLevel& gl)
      63              :                 {
      64              :                         if (gl != m_gl)
      65              :                         {
      66            0 :                                 m_gl = gl;
      67            0 :                                 grid_level_has_changed();
      68              :                         }
      69              :                 }
      70              : 
      71              :                 /// response to change in grid level
      72            0 :                 virtual void grid_level_has_changed() {};
      73              : 
      74              :         protected:
      75              :                 GridLevel m_gl;
      76              : };
      77              : 
      78              : } // end namespace ug
      79              : 
      80              : 
      81              : #endif // __H__LIB_DISC__OPERATOR__LINEAR_OPERATOR__LEVEL_PRECONDITIONER_INTERFACE_H__