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::ICCG 00026 00027 Description 00028 Incomplete Cholesky preconditioned CG solver derived from the general 00029 preconditioned CG solver PCG but with the choice of preconditioner 00030 pre-selected. 00031 00032 Deprecated 00033 This solver is present for backward-compatibility and the PCG solver 00034 should be used for preference. 00035 00036 SourceFiles 00037 ICCG.C 00038 00039 \*---------------------------------------------------------------------------*/ 00040 00041 #ifndef ICCG_H 00042 #define ICCG_H 00043 00044 #include <OpenFOAM/PCG.H> 00045 00046 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00047 00048 namespace Foam 00049 { 00050 00051 /*---------------------------------------------------------------------------*\ 00052 Class ICCG Declaration 00053 \*---------------------------------------------------------------------------*/ 00054 00055 class ICCG 00056 : 00057 public PCG 00058 { 00059 // Private Member Functions 00060 00061 //- Disallow default bitwise copy construct 00062 ICCG(const ICCG&); 00063 00064 //- Disallow default bitwise assignment 00065 void operator=(const ICCG&); 00066 00067 public: 00068 00069 //- Return the dictionary constructed from the components. 00070 // Needed for backward compatibility 00071 static dictionary solverDict 00072 ( 00073 const scalar tol, 00074 const scalar relTol 00075 ); 00076 00077 //- Return the dictionary constructed from the old-style data-stream. 00078 // Needed for backward compatibility 00079 static dictionary solverDict(Istream&); 00080 00081 00082 //- Runtime type information 00083 TypeName("ICCG"); 00084 00085 00086 // Constructors 00087 00088 //- Construct from matrix components and solver data stream 00089 ICCG 00090 ( 00091 const word& fieldName, 00092 const lduMatrix& matrix, 00093 const FieldField<Field, scalar>& interfaceBouCoeffs, 00094 const FieldField<Field, scalar>& interfaceIntCoeffs, 00095 const lduInterfaceFieldPtrsList& interfaces, 00096 const dictionary& solverControls 00097 ); 00098 00099 //- Construct from matrix components and tolerances 00100 ICCG 00101 ( 00102 const word& fieldName, 00103 const lduMatrix& matrix, 00104 const FieldField<Field, scalar>& interfaceBouCoeffs, 00105 const FieldField<Field, scalar>& interfaceIntCoeffs, 00106 const lduInterfaceFieldPtrsList& interfaces, 00107 const scalar tolerance, 00108 const scalar relTol = 0.0 00109 ); 00110 00111 // Destructor 00112 00113 virtual ~ICCG() 00114 {} 00115 00116 }; 00117 00118 00119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00120 00121 } // End namespace Foam 00122 00123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00124 00125 #endif 00126 00127 // ************************ vim: set sw=4 sts=4 et: ************************ //
