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