src/foam/matrices/blockLduMatrix/BlockAmg/BlockAmgLevel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     BlockAmgLevel
  26
  27 Description
  28     Algebraic multigrid level virtual base class for BlockLduMatrix
  29
  30 Author
  31     Klas Jareteg, 2012-12-13
  32
  33 SourceFiles
  34     BlockAmgLevel.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef BlockAmgLevel_H
  39 #define BlockAmgLevel_H
  40
  41 #include "BlockLduMatrix.H"
  42 #include "BlockMatrixCoarsening.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // * * * * * * Forward declaration of template friend fuctions * * * * * * * //
  50
  51 template<class Type>
  52 class fineBlockAmgLevel;
  53
  54 template<class Type>
  55 class coarseBlockAmgLevel;
  56
  57 template<class Type>
  58 class BlockAmgCycle;
  59
  60 template<class Type>
  61 class BlockMatrixCoarsening;
  62
  63 template<class Type>
  64 class BlockAmgSolver;
  65
  66 template<class Type>
  67 class BlockAmgPrecon;
  68
  69 /*---------------------------------------------------------------------------*\
  70                            Class BlockAmgLevel Declaration
  71 \*---------------------------------------------------------------------------*/
  72
  73 template<class Type>
  74 class BlockAmgLevel
  75 {
  76 public:
  77     //- Runtime type information
  78         TypeName("BlockAmgLevel");
  79
  80
  81     // Destructor
  82
  83         virtual ~BlockAmgLevel()
  84         {}
  85
  86
  87     // Member Functions
  88
  89         //- Return reference to x
  90         virtual Field<Type>& x() = 0;
  91
  92         //- Return reference to b
  93         virtual Field<Type>& b() = 0;
  94
  95         //- Calculate residual
  96         virtual void residual
  97         (
  98             const Field<Type>& x,
  99             const Field<Type>& b,
 100             Field<Type>& res
 101         ) const = 0;
 102
 103         //- Restrict residual
 104         virtual void restrictResidual
 105         (
 106             const Field<Type>& x,
 107             const Field<Type>& b,
 108             Field<Type>& xBuffer,
 109             Field<Type>& coarseRes,
 110             bool preSweepsDone
 111         ) const = 0;
 112
 113         //- Prolongate correction
 114         virtual void prolongateCorrection
 115         (
 116             Field<Type>& x,
 117             const Field<Type>& coarseX
 118         ) const = 0;
 119
 120         //- Smooth level
 121         virtual void smooth
 122         (
 123             Field<Type>& x,
 124             const Field<Type>& b,
 125             const label nSweeps
 126         ) const = 0;
 127
 128         //- Solve level
 129         virtual void solve
 130         (
 131             Field<Type>& x,
 132             const Field<Type>& b,
 133             const scalar tolerance,
 134             const scalar relTol
 135         ) const = 0;
 136
 137         //- Scale x
 138         virtual void scaleX
 139         (
 140             Field<Type>& x,
 141             const Field<Type>& b,
 142             Field<Type>& xBuffer
 143         ) const = 0;
 144
 145         //- Create next level from current level
 146         virtual autoPtr<BlockAmgLevel> makeNextLevel() const = 0;
 147 };
 148
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 } // End namespace Foam
 153
 154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 155
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 #endif
 160
 161 // ************************************************************************* //