src/OpenFOAM/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM 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 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::GAMGPreconditioner
  27
  28 Description
  29     Geometric agglomerated algebraic multigrid preconditioner.
  30
  31 See Also
  32     GAMGSolver for more details.
  33
  34 SourceFiles
  35     GAMGPreconditioner.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef GAMGPreconditioner_H
  40 #define GAMGPreconditioner_H
  41
  42 #include "GAMGSolver.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class GAMGPreconditioner Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class GAMGPreconditioner
  54 :
  55     public GAMGSolver,
  56     public lduMatrix::preconditioner
  57 {
  58 protected:
  59     // Protected data
  60
  61         //- Number of V-cycles to perform
  62         label nVcycles_;
  63
  64         //- Read the control parameters from the controlDict_
  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::solver&,
  79             const dictionary& solverControls
  80         );
  81
  82
  83     // Destructor
  84
  85         virtual ~GAMGPreconditioner();
  86
  87
  88     // Member Functions
  89
  90         //- Return wA the preconditioned form of residual rA
  91         virtual void precondition
  92         (
  93             scalarField& wA,
  94             const scalarField& rA,
  95             const direction cmpt=0
  96         ) const;
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #endif
 107
 108 // ************************************************************************* //