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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::GaussSeidelSmoother
  26
  27 Description
  28     A lduMatrix::smoother for Gauss-Seidel
  29
  30 SourceFiles
  31     GaussSeidelSmoother.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef GaussSeidelSmoother_H
  36 #define GaussSeidelSmoother_H
  37
  38 #include "lduMatrix.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                    Class GaussSeidelSmoother Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class GaussSeidelSmoother
  50 :
  51     public lduSmoother
  52 {
  53
  54 public:
  55
  56     //- Runtime type information
  57     TypeName("GaussSeidel");
  58
  59
  60     // Constructors
  61
  62         //- Construct from components
  63         GaussSeidelSmoother
  64         (
  65             const lduMatrix& matrix,
  66             const FieldField<Field, scalar>& coupleBouCoeffs,
  67             const FieldField<Field, scalar>& coupleIntCoeffs,
  68             const lduInterfaceFieldPtrsList& interfaces
  69         );
  70
  71
  72     // Member Functions
  73
  74         //- Smooth for the given number of sweeps
  75         static void smooth
  76         (
  77             scalarField& x,
  78             const lduMatrix& matrix,
  79             const scalarField& b,
  80             const FieldField<Field, scalar>& coupleBouCoeffs,
  81             const lduInterfaceFieldPtrsList& interfaces,
  82             const direction cmpt,
  83             const label nSweeps
  84         );
  85
  86
  87         //- Smooth the solution for a given number of sweeps
  88         virtual void smooth
  89         (
  90             scalarField& x,
  91             const scalarField& b,
  92             const direction cmpt,
  93             const label nSweeps
  94         ) const;
  95 };
  96
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 } // End namespace Foam
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 #endif
 105
 106 // ************************************************************************* //