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

GaussSeidelSmoother.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::GaussSeidelSmoother
00026 
00027 Description
00028     A lduMatrix::smoother for Gauss-Seidel
00029 
00030 SourceFiles
00031     GaussSeidelSmoother.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef GaussSeidelSmoother_H
00036 #define GaussSeidelSmoother_H
00037 
00038 #include <OpenFOAM/lduMatrix.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                            Class GaussSeidelSmoother Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class GaussSeidelSmoother
00050 :
00051     public lduMatrix::smoother
00052 {
00053 
00054 public:
00055 
00056     //- Runtime type information
00057     TypeName("GaussSeidel");
00058 
00059 
00060     // Constructors
00061 
00062         //- Construct from components
00063         GaussSeidelSmoother
00064         (
00065             const word& fieldName,
00066             const lduMatrix& matrix,
00067             const FieldField<Field, scalar>& interfaceBouCoeffs,
00068             const FieldField<Field, scalar>& interfaceIntCoeffs,
00069             const lduInterfaceFieldPtrsList& interfaces
00070         );
00071 
00072 
00073     // Member Functions
00074 
00075         //- Smooth for the given number of sweeps
00076         static void smooth
00077         (
00078             const word& fieldName,
00079             scalarField& psi,
00080             const lduMatrix& matrix,
00081             const scalarField& source,
00082             const FieldField<Field, scalar>& interfaceBouCoeffs,
00083             const lduInterfaceFieldPtrsList& interfaces,
00084             const direction cmpt,
00085             const label nSweeps
00086         );
00087 
00088 
00089         //- Smooth the solution for a given number of sweeps
00090         virtual void smooth
00091         (
00092             scalarField& psi,
00093             const scalarField& Source,
00094             const direction cmpt,
00095             const label nSweeps
00096         ) const;
00097 };
00098 
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 } // End namespace Foam
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 #endif
00107 
00108 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines