src/OpenFOAM/matrices/lduMatrix/smoothers/DIC/DICSmoother.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::DICSmoother
  27
  28 Description
  29     Simplified diagonal-based incomplete Cholesky smoother for symmetric
  30     matrices.
  31
  32     To improve efficiency, the residual is evaluated after every nSweeps
  33     sweeps.
  34
  35 SourceFiles
  36     DICSmoother.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef DICSmoother_H
  41 #define DICSmoother_H
  42
  43 #include "lduMatrix.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class DICSmoother Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class DICSmoother
  55 :
  56     public lduMatrix::smoother
  57 {
  58     // Private data
  59
  60         //- The reciprocal preconditioned diagonal
  61         scalarField rD_;
  62
  63
  64 public:
  65
  66     //- Runtime type information
  67     TypeName("DIC");
  68
  69
  70     // Constructors
  71
  72         //- Construct from matrix components
  73         DICSmoother
  74         (
  75             const word& fieldName,
  76             const lduMatrix& matrix,
  77             const FieldField<Field, scalar>& interfaceBouCoeffs,
  78             const FieldField<Field, scalar>& interfaceIntCoeffs,
  79             const lduInterfaceFieldPtrsList& interfaces
  80         );
  81
  82
  83     // Member Functions
  84
  85         //- Smooth the solution for a given number of sweeps
  86         void smooth
  87         (
  88             scalarField& psi,
  89             const scalarField& source,
  90             const direction cmpt,
  91             const label nSweeps
  92         ) const;
  93 };
  94
  95
  96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  97
  98 } // End namespace Foam
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 #endif
 103
 104 // ************************************************************************* //