src/foam/matrices/lduMatrix/smoothers/DIC/DICSmoother.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::DICSmoother
  26
  27 Description
  28     Simplified diagonal-based incomplete Cholesky smoother for symmetric
  29     matrices.
  30
  31     To improve efficiency, the residual is evaluated after every nSweeps
  32     sweeps.
  33
  34 SourceFiles
  35     DICSmoother.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef DICSmoother_H
  40 #define DICSmoother_H
  41
  42 #include "lduMatrix.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class DICSmoother Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class DICSmoother
  54 :
  55     public lduSmoother
  56 {
  57     // Private data
  58
  59         //- The reciprocal preconditioned diagonal
  60         scalarField rD_;
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("DIC");
  67
  68
  69     // Constructors
  70
  71         //- Construct from matrix components
  72         DICSmoother
  73         (
  74             const lduMatrix& matrix,
  75             const FieldField<Field, scalar>& coupleBouCoeffs,
  76             const FieldField<Field, scalar>& coupleIntCoeffs,
  77             const lduInterfaceFieldPtrsList& interfaces
  78         );
  79
  80
  81     // Member Functions
  82
  83         //- Execute smoothing
  84         void smooth
  85         (
  86             scalarField& x,
  87             const scalarField& b,
  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 // ************************************************************************* //