src/lduSolvers/amg/coarseAmgLevel.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     coarseAmgLevel
  26
  27 Description
  28     Coarse AMG level stores matrix, x and b locally
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     coarseAmgLevel.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef coarseAmgLevel_H
  39 #define coarseAmgLevel_H
  40
  41 #include "amgLevel.H"
  42 #include "amgMatrix.H"
  43 #include "lduPrimitiveMesh.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                         Class coarseAmgLevel Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class coarseAmgLevel
  55 :
  56     public amgLevel
  57 {
  58     // Private data
  59
  60         //- Matrix
  61         autoPtr<amgMatrix> matrixPtr_;
  62
  63         //- Solution field
  64         scalarField x_;
  65
  66         //- RHS field
  67         scalarField b_;
  68
  69         //- Dictionary
  70         const dictionary& dict_;
  71
  72         //- AMG policy
  73         autoPtr<amgPolicy> policyPtr_;
  74
  75         //- Smoother
  76         autoPtr<lduSmoother> smootherPtr_;
  77
  78
  79     // Private Member Functions
  80
  81         //- Disallow default bitwise copy construct
  82         coarseAmgLevel(const coarseAmgLevel&);
  83
  84         //- Disallow default bitwise assignment
  85         void operator=(const coarseAmgLevel&);
  86
  87
  88 public:
  89
  90         //- Construct from components
  91         coarseAmgLevel
  92         (
  93             autoPtr<amgMatrix> matrixPtr,
  94             const dictionary& dict,
  95             const word& policyType,
  96             const label groupSize,
  97             const label minCoarseEqns,
  98             const word& smootherType
  99         );
 100
 101
 102     // Destructor
 103
 104         virtual ~coarseAmgLevel();
 105
 106
 107     // Member Functions
 108
 109         //- Return reference to x
 110         virtual scalarField& x();
 111
 112         //- Return reference to b
 113         virtual scalarField& b();
 114
 115         //- Return reference to dictionary
 116         const dictionary& dict() const
 117         {
 118             return dict_;
 119         }
 120
 121         //- Calculate residual
 122         virtual void residual
 123         (
 124             const scalarField& x,
 125             const scalarField& b,
 126             const direction cmpt,
 127             scalarField& res
 128         ) const;
 129
 130         //- Restrict residual
 131         virtual void restrictResidual
 132         (
 133             const scalarField& x,
 134             const scalarField& b,
 135             const direction cmpt,
 136             scalarField& xBuffer,
 137             scalarField& coarseRes,
 138             bool preSweepsDone
 139         ) const;
 140
 141         //- Prolongate correction
 142         virtual void prolongateCorrection
 143         (
 144             scalarField& x,
 145             const scalarField& coarseX
 146         ) const;
 147
 148         //- Smooth level
 149         virtual void smooth
 150         (
 151             scalarField& x,
 152             const scalarField& b,
 153             const direction cmpt,
 154             const label nSweeps
 155         ) const;
 156
 157         //- Solve level
 158         virtual void solve
 159         (
 160             scalarField& x,
 161             const scalarField& b,
 162             const direction cmpt,
 163             const scalar tolerance,
 164             const scalar relTol
 165         ) const;
 166
 167         //- Scale x
 168         virtual void scaleX
 169         (
 170             scalarField& x,
 171             const scalarField& b,
 172             const direction cmpt,
 173             scalarField& xBuffer
 174         ) const;
 175
 176
 177         //- Create next level from current level
 178         virtual autoPtr<amgLevel> makeNextLevel() const;
 179 };
 180
 181
 182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 183
 184 } // End namespace Foam
 185
 186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 187
 188 #endif
 189
 190 // ************************************************************************* //