Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / foam / matrices / scalarMatrices / scalarMatrices.H
blob277973048071e80299638e5c7728554a27579342
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.
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.
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.
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/>.
24 Class
25     scalarMatrices
27 Description
28     Scalar matrices
30 SourceFiles
31     scalarMatrices.C
32     scalarMatricesTemplates.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef scalarMatrices_H
37 #define scalarMatrices_H
39 #include "RectangularMatrix.H"
40 #include "SquareMatrix.H"
41 #include "DiagonalMatrix.H"
43 #include "scalarSquareMatrix.H"
44 #include "scalarField.H"
45 #include "labelList.H"
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 namespace Foam
52 typedef RectangularMatrix<scalar> scalarRectangularMatrix;
53 typedef DiagonalMatrix<scalar> scalarDiagonalMatrix;
55 void multiply
57     scalarRectangularMatrix& answer,         // value changed in return
58     const scalarRectangularMatrix& A,
59     const scalarRectangularMatrix& B
62 void multiply
64     scalarRectangularMatrix& answer,         // value changed in return
65     const scalarRectangularMatrix& A,
66     const scalarRectangularMatrix& B,
67     const scalarRectangularMatrix& C
70 void multiply
72     scalarRectangularMatrix& answer,         // value changed in return
73     const scalarRectangularMatrix& A,
74     const scalarDiagonalMatrix& B,
75     const scalarRectangularMatrix& C
78 //- Return the inverse of matrix A using SVD
79 scalarRectangularMatrix SVDinv
81     const scalarRectangularMatrix& A,
82     scalar minCondition = 0
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 } // End namespace Foam
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 #endif
94 // ************************************************************************* //