src/lduSolvers/lduSolver/mpeAmgSolver/mpeAmgSolver.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     mpeAmgSolver
  26
  27 Description
  28     Minimal Polynomial Extrapolation Algebraic Multigrid solver with run-time
  29     selection of policy and cycle
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     mpeAmgSolver.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef mpeAmgSolver_H
  40 #define mpeAmgSolver_H
  41
  42 #include "lduMatrix.H"
  43 #include "amgPrecon.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                          Class mpeAmgSolver Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class mpeAmgSolver
  55 :
  56     public lduSolver
  57 {
  58 private:
  59
  60     // Private data
  61
  62         //- AMG preconditioner
  63         amgPrecon amg_;
  64
  65         //- Number of smoothing steps before projection
  66         label nSmoothingSteps_;
  67
  68         //- Krylov space dimension
  69         label kDimension_;
  70
  71
  72     // Private Member Functions
  73
  74         //- Disallow default bitwise copy construct
  75         mpeAmgSolver(const mpeAmgSolver&);
  76
  77         //- Disallow default bitwise assignment
  78         void operator=(const mpeAmgSolver&);
  79
  80
  81 public:
  82
  83     //- Runtime type information
  84     TypeName("MPEAMG");
  85
  86
  87     // Constructors
  88
  89         //- Construct from matrix components and solver data stream
  90         mpeAmgSolver
  91         (
  92             const word& fieldName,
  93             const lduMatrix& matrix,
  94             const FieldField<Field, scalar>& coupleBouCoeffs,
  95             const FieldField<Field, scalar>& coupleIntCoeffs,
  96             const lduInterfaceFieldPtrsList& interfaces,
  97             const dictionary& dict
  98         );
  99
 100
 101     // Destructor
 102
 103         virtual ~mpeAmgSolver()
 104         {}
 105
 106
 107     // Member Functions
 108
 109         //- Solve the matrix with this solver
 110         virtual lduSolverPerformance solve
 111         (
 112             scalarField& x,
 113             const scalarField& b,
 114             const direction cmpt = 0
 115         ) const;
 116 };
 117
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 } // End namespace Foam
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 #endif
 126
 127 // ************************************************************************* //