00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::GAMGPreconditioner 00026 00027 Description 00028 Geometric agglomerated algebraic multigrid preconditioner. 00029 00030 See Also 00031 GAMGSolver for more details. 00032 00033 SourceFiles 00034 GAMGPreconditioner.C 00035 00036 \*---------------------------------------------------------------------------*/ 00037 00038 #ifndef GAMGPreconditioner_H 00039 #define GAMGPreconditioner_H 00040 00041 #include <OpenFOAM/GAMGSolver.H> 00042 00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00044 00045 namespace Foam 00046 { 00047 00048 /*---------------------------------------------------------------------------*\ 00049 Class GAMGPreconditioner Declaration 00050 \*---------------------------------------------------------------------------*/ 00051 00052 class GAMGPreconditioner 00053 : 00054 public GAMGSolver, 00055 public lduMatrix::preconditioner 00056 { 00057 protected: 00058 // Protected data 00059 00060 //- Number of V-cycles to perform 00061 label nVcycles_; 00062 00063 //- Read the control parameters from the controlDict_ 00064 virtual void readControls(); 00065 00066 public: 00067 00068 //- Runtime type information 00069 TypeName("GAMG"); 00070 00071 00072 // Constructors 00073 00074 //- Construct from matrix components and preconditioner solver controls 00075 GAMGPreconditioner 00076 ( 00077 const lduMatrix::solver&, 00078 const dictionary& solverControls 00079 ); 00080 00081 00082 // Destructor 00083 00084 virtual ~GAMGPreconditioner(); 00085 00086 00087 // Member Functions 00088 00089 //- Return wA the preconditioned form of residual rA 00090 virtual void precondition 00091 ( 00092 scalarField& wA, 00093 const scalarField& rA, 00094 const direction cmpt=0 00095 ) const; 00096 }; 00097 00098 00099 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00100 00101 } // End namespace Foam 00102 00103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00104 00105 #endif 00106 00107 // ************************ vim: set sw=4 sts=4 et: ************************ //
