src/coupledMatrix/coupledLduPrecon/CholeskyPrecon/coupledCholeskyPrecon.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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     coupledCholeskyPrecon
  27
  28 Description
  29     Incomplete Cholesky preconditioning with no fill-in.
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  33
  34 SourceFiles
  35     coupledCholeskyPrecon.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef coupledCholeskyPrecon_H
  40 #define coupledCholeskyPrecon_H
  41
  42 #include "coupledLduPrecon.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                       Class coupledCholeskyPrecon Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class coupledCholeskyPrecon
  54 :
  55     public coupledLduPrecon
  56 {
  57     // Private Data
  58
  59         //- Preconditioned diagonal
  60         FieldField<Field, scalar> preconDiag_;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow default bitwise copy construct
  66         coupledCholeskyPrecon(const coupledCholeskyPrecon&);
  67
  68         //- Disallow default bitwise assignment
  69         void operator=(const coupledCholeskyPrecon&);
  70
  71         //- Precondition the diagonal
  72         void calcPreconDiag();
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("Cholesky");
  79
  80
  81     // Constructors
  82
  83         //- Construct from components
  84         coupledCholeskyPrecon
  85         (
  86             const coupledLduMatrix& matrix,
  87             const PtrList<FieldField<Field, scalar> >& bouCoeffs,
  88             const PtrList<FieldField<Field, scalar> >& intCoeffs,
  89             const lduInterfaceFieldPtrsListList& interfaces
  90         );
  91
  92         //- Construct from dictionary
  93         coupledCholeskyPrecon
  94         (
  95             const coupledLduMatrix& matrix,
  96             const PtrList<FieldField<Field, scalar> >& bouCoeffs,
  97             const PtrList<FieldField<Field, scalar> >& intCoeffs,
  98             const lduInterfaceFieldPtrsListList& interfaces,
  99             const dictionary& dict
 100         );
 101
 102
 103     // Destructor
 104
 105         virtual ~coupledCholeskyPrecon()
 106         {}
 107
 108
 109     // Member Functions
 110
 111         //- Execute preconditioning
 112         virtual void precondition
 113         (
 114             FieldField<Field, scalar>& x,
 115             const FieldField<Field, scalar>& b,
 116             const direction cmpt = 0
 117         ) const;
 118
 119         //- Execute preconditioning for the transpose matrix
 120         virtual void preconditionT
 121         (
 122             FieldField<Field, scalar>& x,
 123             const FieldField<Field, scalar>& b,
 124             const direction cmpt = 0
 125         ) const;
 126 };
 127
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 } // End namespace Foam
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #endif
 136
 137 // ************************************************************************* //