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

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