src/OpenFOAM/matrices/lduMatrix/preconditioners/DICPreconditioner/DICPreconditioner.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::DICPreconditioner
  27
  28 Description
  29     Simplified diagonal-based incomplete Cholesky preconditioner for symmetric
  30     matrices (symmetric equivalent of DILU).  The reciprocal of the
  31     preconditioned diagonal is calculated and stored.
  32
  33 SourceFiles
  34     DICPreconditioner.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef DICPreconditioner_H
  39 #define DICPreconditioner_H
  40
  41 #include "lduMatrix.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class DICPreconditioner Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class DICPreconditioner
  53 :
  54     public lduMatrix::preconditioner
  55 {
  56     // Private data
  57
  58         //- The reciprocal preconditioned diagonal
  59         scalarField rD_;
  60
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("DIC");
  66
  67
  68     // Constructors
  69
  70         //- Construct from matrix components and preconditioner data stream
  71         DICPreconditioner
  72         (
  73             const lduMatrix::solver& sol,
  74             Istream& preconditionerData
  75         );
  76
  77
  78     // Destructor
  79
  80         virtual ~DICPreconditioner()
  81         {}
  82
  83
  84     // Member Functions
  85
  86         //- Calculate the reciprocal of the preconditioned diagonal
  87         static void calcReciprocalD(scalarField& rD, const lduMatrix& matrix);
  88
  89         //- Return wA the preconditioned form of residual rA
  90         virtual void precondition
  91         (
  92             scalarField& wA,
  93             const scalarField& rA,
  94             const direction cmpt=0
  95         ) const;
  96 };
  97
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************************************************************* //