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

DICSmoother.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::DICSmoother
00026 
00027 Description
00028     Simplified diagonal-based incomplete Cholesky smoother for symmetric
00029     matrices.
00030 
00031     To improve efficiency, the residual is evaluated after every nSweeps
00032     sweeps.
00033 
00034 SourceFiles
00035     DICSmoother.C
00036 
00037 \*---------------------------------------------------------------------------*/
00038 
00039 #ifndef DICSmoother_H
00040 #define DICSmoother_H
00041 
00042 #include <OpenFOAM/lduMatrix.H>
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 /*---------------------------------------------------------------------------*\
00050                            Class DICSmoother Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 class DICSmoother
00054 :
00055     public lduMatrix::smoother
00056 {
00057     // Private data
00058 
00059         //- The reciprocal preconditioned diagonal
00060         scalarField rD_;
00061 
00062 
00063 public:
00064 
00065     //- Runtime type information
00066     TypeName("DIC");
00067 
00068 
00069     // Constructors
00070 
00071         //- Construct from matrix components
00072         DICSmoother
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         );
00080 
00081 
00082     // Member Functions
00083 
00084         //- Smooth the solution for a given number of sweeps
00085         void smooth
00086         (
00087             scalarField& psi,
00088             const scalarField& source,
00089             const direction cmpt,
00090             const label nSweeps
00091         ) const;
00092 };
00093 
00094 
00095 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00096 
00097 } // End namespace Foam
00098 
00099 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00100 
00101 #endif
00102 
00103 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines