src/lduSolvers/amg/amgLevel.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     amgLevel
  26
  27 Description
  28     Algebraic multigrid level virtual base class
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     amgLevel.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef amgLevel_H
  39 #define amgLevel_H
  40
  41 #include "lduMatrix.H"
  42 #include "amgPolicy.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class amgLevel Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class amgLevel
  54 {
  55 public:
  56
  57     // Destructor
  58
  59         virtual ~amgLevel()
  60         {}
  61
  62
  63     // Member Functions
  64
  65         //- Return reference to x
  66         virtual scalarField& x() = 0;
  67
  68         //- Return reference to b
  69         virtual scalarField& b() = 0;
  70
  71         //- Calculate residual
  72         virtual void residual
  73         (
  74             const scalarField& x,
  75             const scalarField& b,
  76             const direction cmpt,
  77             scalarField& res
  78         ) const = 0;
  79
  80         //- Restrict residual
  81         virtual void restrictResidual
  82         (
  83             const scalarField& x,
  84             const scalarField& b,
  85             const direction cmpt,
  86             scalarField& xBuffer,
  87             scalarField& coarseRes,
  88             bool preSweepsDone
  89         ) const = 0;
  90
  91         //- Prolongate correction
  92         virtual void prolongateCorrection
  93         (
  94             scalarField& x,
  95             const scalarField& coarseX
  96         ) const = 0;
  97
  98         //- Smooth level
  99         virtual void smooth
 100         (
 101             scalarField& x,
 102             const scalarField& b,
 103             const direction cmpt,
 104             const label nSweeps
 105         ) const = 0;
 106
 107         //- Solve level
 108         virtual void solve
 109         (
 110             scalarField& x,
 111             const scalarField& b,
 112             const direction cmpt,
 113             const scalar tolerance,
 114             const scalar relTol
 115         ) const = 0;
 116
 117         //- Scale x
 118         virtual void scaleX
 119         (
 120             scalarField& x,
 121             const scalarField& b,
 122             const direction cmpt,
 123             scalarField& xBuffer
 124         ) const = 0;
 125
 126         //- Create next level from current level
 127         virtual autoPtr<amgLevel> makeNextLevel() const = 0;
 128 };
 129
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 } // End namespace Foam
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 #endif
 138
 139 // ************************************************************************* //