1 /*---------------------------------------------------------------------------*\
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
5 \\ / A nd | Copyright (C) 1991-2008 OpenCFD Ltd.
7 -------------------------------------------------------------------------------
9 This file is part of OpenFOAM.
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.
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
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
26 Foam::GAMGPreconditioner
29 Geometric agglomerated algebraic multigrid preconditioner.
32 GAMGSolver for more details.
37 \*---------------------------------------------------------------------------*/
39 #ifndef GAMGPreconditioner_H
40 #define GAMGPreconditioner_H
42 #include "GAMGSolver.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 /*---------------------------------------------------------------------------*\
50 Class GAMGPreconditioner Declaration
51 \*---------------------------------------------------------------------------*/
53 class GAMGPreconditioner
56 public lduMatrix::preconditioner
60 //- Number of V-cycles to perform
64 // Private member functions
66 //- Read control parameters from the control dictionary
72 //- Runtime type information
78 //- Construct for given solver and preconditioner data stream
81 const lduMatrix::solver& sol,
82 Istream& preconditionerData
88 virtual ~GAMGPreconditioner();
93 //- Read and reset the preconditioner parameters from the given stream
94 virtual void read(Istream& preconditionerData);
96 //- Return wA the preconditioned form of residual rA
97 virtual void precondition
100 const scalarField& rA,
101 const direction cmpt=0
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 } // End namespace Foam
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 // ************************************************************************* //