src/foam/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.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     Foam::GAMGPreconditioner
  26
  27 Description
  28     Geometric agglomerated algebraic multigrid preconditioner.
  29
  30 See Also
  31     GAMGSolver for more details.
  32
  33 SourceFiles
  34     GAMGPreconditioner.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef GAMGPreconditioner_H
  39 #define GAMGPreconditioner_H
  40
  41 #include "GAMGSolver.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                         Class GAMGPreconditioner Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class GAMGPreconditioner
  53 :
  54     public lduPreconditioner
  55 {
  56     // Private data
  57
  58         //- Solver
  59         GAMGSolver GAMG_;
  60
  61         //- Number of V-cycles to perform
  62         label nVcycles_;
  63
  64         //- Read the control parameters from the dictionary
  65         virtual void readControls();
  66
  67 public:
  68
  69     //- Runtime type information
  70     TypeName("GAMG");
  71
  72
  73     // Constructors
  74
  75         //- Construct from matrix components and preconditioner solver controls
  76         GAMGPreconditioner
  77         (
  78             const lduMatrix& matrix,
  79             const FieldField<Field, scalar>& coupleBouCoeffs,
  80             const FieldField<Field, scalar>& coupleIntCoeffs,
  81             const lduInterfaceFieldPtrsList& interfaces,
  82             const dictionary& dict
  83         );
  84
  85
  86     // Destructor
  87
  88         virtual ~GAMGPreconditioner();
  89
  90
  91     // Member Functions
  92
  93         //- Execute preconditioning
  94         virtual void precondition
  95         (
  96             scalarField& wA,
  97             const scalarField& rA,
  98             const direction cmpt = 0
  99         ) const;
 100 };
 101
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 } // End namespace Foam
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 #endif
 110
 111 // ************************************************************************* //