src/OpenFOAM/matrices/scalarMatrices/scalarMatrices.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     scalarMatrices
  27
  28 Description
  29     Scalar matrices
  30
  31 SourceFiles
  32     scalarMatrices.C
  33     scalarMatricesTemplates.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef scalarMatrices_H
  38 #define scalarMatrices_H
  39
  40 #include "RectangularMatrix.H"
  41 #include "SquareMatrix.H"
  42 #include "DiagonalMatrix.H"
  43
  44 #include "scalarSquareMatrix.H"
  45 #include "scalarField.H"
  46 #include "labelList.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 typedef RectangularMatrix<scalar> scalarRectangularMatrix;
  54 typedef DiagonalMatrix<scalar> scalarDiagonalMatrix;
  55
  56 void multiply
  57 (
  58     scalarRectangularMatrix& answer,         // value changed in return
  59     const scalarRectangularMatrix& A,
  60     const scalarRectangularMatrix& B
  61 );
  62
  63 void multiply
  64 (
  65     scalarRectangularMatrix& answer,         // value changed in return
  66     const scalarRectangularMatrix& A,
  67     const scalarRectangularMatrix& B,
  68     const scalarRectangularMatrix& C
  69 );
  70
  71 void multiply
  72 (
  73     scalarRectangularMatrix& answer,         // value changed in return
  74     const scalarRectangularMatrix& A,
  75     const scalarDiagonalMatrix& B,
  76     const scalarRectangularMatrix& C
  77 );
  78
  79 //- Return the inverse of matrix A using SVD
  80 scalarRectangularMatrix SVDinv
  81 (
  82     const scalarRectangularMatrix& A,
  83     scalar minCondition = 0
  84 );
  85
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 } // End namespace Foam
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 #endif
  94
  95 // ************************************************************************* //