FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

DILUPreconditioner.H

Go to the documentation of this file.
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::DILUPreconditioner
00026 
00027 Description
00028     Simplified diagonal-based incomplete LU preconditioner for asymmetric
00029     matrices.  The reciprocal of the preconditioned diagonal is calculated
00030     and stored.
00031 
00032 SourceFiles
00033     DILUPreconditioner.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef DILUPreconditioner_H
00038 #define DILUPreconditioner_H
00039 
00040 #include <OpenFOAM/lduMatrix.H>
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class DILUPreconditioner Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class DILUPreconditioner
00052 :
00053     public lduMatrix::preconditioner
00054 {
00055     // Private data
00056 
00057         //- The reciprocal preconditioned diagonal
00058         scalarField rD_;
00059 
00060 
00061 public:
00062 
00063     //- Runtime type information
00064     TypeName("DILU");
00065 
00066 
00067     // Constructors
00068 
00069         //- Construct from matrix components and preconditioner solver controls
00070         DILUPreconditioner
00071         (
00072             const lduMatrix::solver&,
00073             const dictionary& solverControlsUnused
00074         );
00075 
00076 
00077     // Destructor
00078 
00079         virtual ~DILUPreconditioner()
00080         {}
00081 
00082 
00083     // Member Functions
00084 
00085         //- Calculate the reciprocal of the preconditioned diagonal
00086         static void calcReciprocalD(scalarField& rD, const lduMatrix& matrix);
00087 
00088         //- Return wA the preconditioned form of residual rA
00089         virtual void precondition
00090         (
00091             scalarField& wA,
00092             const scalarField& rA,
00093             const direction cmpt=0
00094         ) const;
00095 
00096         //- Return wT the transpose-matrix preconditioned form of residual rT.
00097         virtual void preconditionT
00098         (
00099             scalarField& wT,
00100             const scalarField& rT,
00101             const direction cmpt=0
00102         ) const;
00103 };
00104 
00105 
00106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00107 
00108 } // End namespace Foam
00109 
00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00111 
00112 #endif
00113 
00114 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines