src/OpenFOAM/matrices/lduMatrix/smoothers/GaussSeidel/GaussSeidelSmoother.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::GaussSeidelSmoother
  27
  28 Description
  29     A lduMatrix::smoother for Gauss-Seidel
  30
  31 SourceFiles
  32     GaussSeidelSmoother.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef GaussSeidelSmoother_H
  37 #define GaussSeidelSmoother_H
  38
  39 #include "lduMatrix.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class GaussSeidelSmoother Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class GaussSeidelSmoother
  51 :
  52     public lduMatrix::smoother
  53 {
  54
  55 public:
  56
  57     //- Runtime type information
  58     TypeName("GaussSeidel");
  59
  60
  61     // Constructors
  62
  63         //- Construct from components
  64         GaussSeidelSmoother
  65         (
  66             const word& fieldName,
  67             const lduMatrix& matrix,
  68             const FieldField<Field, scalar>& interfaceBouCoeffs,
  69             const FieldField<Field, scalar>& interfaceIntCoeffs,
  70             const lduInterfaceFieldPtrsList& interfaces
  71         );
  72
  73
  74     // Member Functions
  75
  76         //- Smooth for the given number of sweeps
  77         static void smooth
  78         (
  79             const word& fieldName,
  80             scalarField& psi,
  81             const lduMatrix& matrix,
  82             const scalarField& source,
  83             const FieldField<Field, scalar>& interfaceBouCoeffs,
  84             const lduInterfaceFieldPtrsList& interfaces,
  85             const direction cmpt,
  86             const label nSweeps
  87         );
  88
  89
  90         //- Smooth the solution for a given number of sweeps
  91         virtual void smooth
  92         (
  93             scalarField& psi,
  94             const scalarField& Source,
  95             const direction cmpt,
  96             const label nSweeps
  97         ) const;
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //