src/OpenFOAM/matrices/lduMatrix/smoothers/DILU/DILUSmoother.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::DILUSmoother
  26
  27 Description
  28     Simplified diagonal-based incomplete LU smoother for asymmetric matrices.
  29
  30     To improve efficiency, the residual is evaluated after every nSweeps
  31     sweeps.
  32
  33 SourceFiles
  34     DILUSmoother.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef DILUSmoother_H
  39 #define DILUSmoother_H
  40
  41 #include "lduMatrix.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                         Class DILUSmoother Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class DILUSmoother
  53 :
  54     public lduMatrix::smoother
  55 {
  56     // Private data
  57
  58         //- The reciprocal preconditioned diagonal
  59         scalarField rD_;
  60
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("DILU");
  66
  67
  68     // Constructors
  69
  70         //- Construct from matrix components
  71         DILUSmoother
  72         (
  73             const word& fieldName,
  74             const lduMatrix& matrix,
  75             const FieldField<Field, scalar>& interfaceBouCoeffs,
  76             const FieldField<Field, scalar>& interfaceIntCoeffs,
  77             const lduInterfaceFieldPtrsList& interfaces
  78         );
  79
  80
  81     // Member Functions
  82
  83         //- Smooth the solution for a given number of sweeps
  84         void smooth
  85         (
  86             scalarField& psi,
  87             const scalarField& source,
  88             const direction cmpt,
  89             const label nSweeps
  90         ) const;
  91 };
  92
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 } // End namespace Foam
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #endif
 101
 102 // ************************************************************************* //