src/OpenFOAM/matrices/LUscalarMatrix/LUscalarMatrix.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::LUscalarMatrix
  26
  27 Description
  28     Foam::LUscalarMatrix
  29
  30 SourceFiles
  31     LUscalarMatrix.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef LUscalarMatrix_H
  36 #define LUscalarMatrix_H
  37
  38 #include "scalarMatrices.H"
  39 #include "labelList.H"
  40 #include "FieldField.H"
  41 #include "lduInterfaceFieldPtrsList.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 class lduMatrix;
  49 class procLduMatrix;
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class LUscalarMatrix Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class LUscalarMatrix
  56 :
  57     public scalarSquareMatrix
  58 {
  59     // Private data
  60
  61         //- Processor matrix offsets
  62         labelList procOffsets_;
  63
  64         //- The pivot indices used in the LU decomposition
  65         labelList pivotIndices_;
  66
  67         //- Convert the given lduMatrix into this LUscalarMatrix
  68         void convert
  69         (
  70             const lduMatrix& ldum,
  71             const FieldField<Field, scalar>& interfaceCoeffs,
  72             const lduInterfaceFieldPtrsList& interfaces
  73         );
  74
  75         //- Convert the given list of procLduMatrix into this LUscalarMatrix
  76         //  on the master processor
  77         void convert(const PtrList<procLduMatrix>& lduMatrices);
  78
  79
  80         //- Print the ratio of the mag-sum of the off-diagonal coefficients
  81         //  to the mag-diagonal
  82         void printDiagonalDominance() const;
  83
  84
  85 public:
  86
  87     // Constructors
  88
  89         //- Construct from scalarSquareMatrix and perform LU decomposition
  90         LUscalarMatrix(const scalarSquareMatrix&);
  91
  92         //- Construct from lduMatrix and perform LU decomposition
  93         LUscalarMatrix
  94         (
  95             const lduMatrix&,
  96             const FieldField<Field, scalar>& interfaceCoeffs,
  97             const lduInterfaceFieldPtrsList& interfaces
  98         );
  99
 100
 101     // Member Functions
 102
 103         //- Solve the matrix using the LU decomposition with pivoting
 104         //  returning the solution in the source
 105         template<class T>
 106         void solve(Field<T>& source) const;
 107 };
 108
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 } // End namespace Foam
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #ifdef NoRepository
 117 #   include "LUscalarMatrixTemplates.C"
 118 #endif
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //