src/OpenFOAM/matrices/lduMatrix/preconditioners/diagonalPreconditioner/diagonalPreconditioner.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::diagonalPreconditioner
  27
  28 Description
  29     Diagonal preconditioner for both symmetric and asymmetric matrices.
  30
  31     The reciprocal of the diagonal is calculated and stored for reuse
  32     because on most systems '*' is faster than '/'.
  33
  34 SourceFiles
  35     diagonalPreconditioner.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef diagonalPreconditioner_H
  40 #define diagonalPreconditioner_H
  41
  42 #include "lduMatrix.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class diagonalPreconditioner Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class diagonalPreconditioner
  54 :
  55     public lduMatrix::preconditioner
  56 {
  57     // Private data
  58
  59         //- The reciprocal diagonal
  60         scalarField rD;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow default bitwise copy construct
  66         diagonalPreconditioner(const diagonalPreconditioner&);
  67
  68         //- Disallow default bitwise assignment
  69         void operator=(const diagonalPreconditioner&);
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("diagonal");
  76
  77
  78     // Constructors
  79
  80         //- Construct from matrix components and preconditioner solver controls
  81         diagonalPreconditioner
  82         (
  83             const lduMatrix::solver&,
  84             const dictionary& solverControlsUnused
  85         );
  86
  87
  88     // Destructor
  89
  90         virtual ~diagonalPreconditioner()
  91         {}
  92
  93
  94     // Member Functions
  95
  96         //- Return wA the preconditioned form of residual rA
  97         virtual void precondition
  98         (
  99             scalarField& wA,
 100             const scalarField& rA,
 101             const direction cmpt=0
 102         ) const;
 103
 104         //- Return wT the transpose-matrix preconditioned form of residual rT.
 105         virtual void preconditionT
 106         (
 107             scalarField& wT,
 108             const scalarField& rT,
 109             const direction cmpt=0
 110         ) const
 111         {
 112             return precondition(wT, rT, cmpt);
 113         }
 114 };
 115
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 } // End namespace Foam
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 #endif
 124
 125 // ************************************************************************* //