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::smoothSolver 00026 00027 Description 00028 Iterative solver for symmetric and assymetric matrices which uses a 00029 run-time selected smoother e.g. GaussSeidel to converge the solution to 00030 the required tolerance. 00031 00032 To improve efficiency, the residual is evaluated after every nSweeps 00033 smoothing iterations. 00034 00035 SourceFiles 00036 smoothSolver.C 00037 00038 \*---------------------------------------------------------------------------*/ 00039 00040 #ifndef smoothSolver_H 00041 #define smoothSolver_H 00042 00043 #include <OpenFOAM/lduMatrix.H> 00044 00045 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00046 00047 namespace Foam 00048 { 00049 00050 /*---------------------------------------------------------------------------*\ 00051 Class smoothSolver Declaration 00052 \*---------------------------------------------------------------------------*/ 00053 00054 class smoothSolver 00055 : 00056 public lduMatrix::solver 00057 { 00058 protected: 00059 00060 // Protected data 00061 00062 //- Number of sweeps before the evaluation of residual 00063 label nSweeps_; 00064 00065 //- Read the control parameters from the controlDict_ 00066 virtual void readControls(); 00067 00068 public: 00069 00070 //- Runtime type information 00071 TypeName("smoothSolver"); 00072 00073 00074 // Constructors 00075 00076 //- Construct from matrix components and solver controls 00077 smoothSolver 00078 ( 00079 const word& fieldName, 00080 const lduMatrix& matrix, 00081 const FieldField<Field, scalar>& interfaceBouCoeffs, 00082 const FieldField<Field, scalar>& interfaceIntCoeffs, 00083 const lduInterfaceFieldPtrsList& interfaces, 00084 const dictionary& solverControls 00085 ); 00086 00087 00088 // Destructor 00089 00090 virtual ~smoothSolver() 00091 {} 00092 00093 // Member Functions 00094 00095 //- Solve the matrix with this solver 00096 virtual lduMatrix::solverPerformance solve 00097 ( 00098 scalarField& psi, 00099 const scalarField& source, 00100 const direction cmpt=0 00101 ) const; 00102 }; 00103 00104 00105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00106 00107 } // End namespace Foam 00108 00109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00110 00111 #endif 00112 00113 // ************************ vim: set sw=4 sts=4 et: ************************ //
