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::PCG 00026 00027 Description 00028 Preconditioned conjugate gradient solver for symmetric lduMatrices 00029 using a run-time selectable preconditioner. 00030 00031 SourceFiles 00032 PCG.C 00033 00034 \*---------------------------------------------------------------------------*/ 00035 00036 #ifndef PCG_H 00037 #define PCG_H 00038 00039 #include <OpenFOAM/lduMatrix.H> 00040 00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00042 00043 namespace Foam 00044 { 00045 00046 /*---------------------------------------------------------------------------*\ 00047 Class PCG Declaration 00048 \*---------------------------------------------------------------------------*/ 00049 00050 class PCG 00051 : 00052 public lduMatrix::solver 00053 { 00054 // Private Member Functions 00055 00056 //- Disallow default bitwise copy construct 00057 PCG(const PCG&); 00058 00059 //- Disallow default bitwise assignment 00060 void operator=(const PCG&); 00061 00062 00063 public: 00064 00065 //- Runtime type information 00066 TypeName("PCG"); 00067 00068 00069 // Constructors 00070 00071 //- Construct from matrix components and solver controls 00072 PCG 00073 ( 00074 const word& fieldName, 00075 const lduMatrix& matrix, 00076 const FieldField<Field, scalar>& interfaceBouCoeffs, 00077 const FieldField<Field, scalar>& interfaceIntCoeffs, 00078 const lduInterfaceFieldPtrsList& interfaces, 00079 const dictionary& solverControls 00080 ); 00081 00082 00083 // Destructor 00084 00085 virtual ~PCG() 00086 {} 00087 00088 00089 // Member Functions 00090 00091 //- Solve the matrix with this solver 00092 virtual lduMatrix::solverPerformance solve 00093 ( 00094 scalarField& psi, 00095 const scalarField& source, 00096 const direction cmpt=0 00097 ) const; 00098 }; 00099 00100 00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00102 00103 } // End namespace Foam 00104 00105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00106 00107 #endif 00108 00109 // ************************ vim: set sw=4 sts=4 et: ************************ //
