src/foam/matrices/scalarMatrices/scalarSquareMatrix.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::scalarSquareMatrix
  26
  27 Description
  28     Foam::scalarSquareMatrix
  29
  30 SourceFiles
  31     scalarSquareMatrix.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef scalarSquareMatrix_H
  36 #define scalarSquareMatrix_H
  37
  38 #include "SquareMatrix.H"
  39 #include "scalarField.H"
  40 #include "labelList.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class scalarSquareMatrix Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class scalarSquareMatrix
  52 :
  53     public SquareMatrix<scalar>
  54 {
  55
  56 public:
  57
  58     // Constructors
  59
  60         //- Construct null
  61         scalarSquareMatrix();
  62
  63         //- Construct given size
  64         scalarSquareMatrix(const label);
  65
  66         //- Construct given size and coefficient value
  67         scalarSquareMatrix(const label, const scalar v);
  68
  69         //- Construct as copy
  70         scalarSquareMatrix(const scalarSquareMatrix&);
  71
  72         //- Construct from Istream
  73         scalarSquareMatrix(Istream&);
  74
  75
  76     // Member Functions
  77
  78         //- Solve the matrix using Gaussian elimination with pivoting,
  79         //  returning the solution in the source.
  80         //  Matrix given as a reference is destroyed during solution
  81         template<class T>
  82         static void solve(scalarSquareMatrix& matrix, Field<T>& source);
  83
  84         //- Solve the matrix using Gaussian elimination with pivoting
  85         //  and return the solution
  86         template<class Type>
  87         void solve(Field<Type>& psi, const Field<Type>& source) const;
  88
  89
  90         //- LU decompose the matrix with pivoting
  91         static void LUDecompose
  92         (
  93             scalarSquareMatrix& matrix,
  94             labelList& pivotIndices
  95         );
  96
  97         //- LU back-substitution with given source, returning the solution
  98         //  in the source
  99         template<class Type>
 100         static void LUBacksubstitute
 101         (
 102             const scalarSquareMatrix& luMmatrix,
 103             const labelList& pivotIndices,
 104             Field<Type>& source
 105         );
 106
 107         //- Invert the matrix using LU decomposition with pivoting
 108         scalarSquareMatrix LUinvert() const;
 109
 110         //- Solve the matrix using LU decomposition with pivoting
 111         //  returning the LU form of the matrix and the solution in the source
 112         template<class Type>
 113         static void LUsolve(scalarSquareMatrix& matrix, Field<Type>& source);
 114 };
 115
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 } // End namespace Foam
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 #ifdef NoRepository
 124 #   include "scalarSquareMatrixTemplates.C"
 125 #endif
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #endif
 130
 131 // ************************************************************************* //