SquareMatrix.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2013-2018 OpenFOAM Foundation
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 \*---------------------------------------------------------------------------*/
25 
26 #include "SquareMatrix.H"
27 #include "labelList.H"
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 template<class Type>
32 Foam::scalar Foam::detDecomposed
33 (
34  const SquareMatrix<Type>& matrix,
35  const label sign
36 )
37 {
38  Type diagProduct = pTraits<Type>::one;
39 
40  for (label i=0; i<matrix.m(); i++)
41  {
42  diagProduct *= matrix(i, i);
43  }
44 
45  return sign*diagProduct;
46 }
47 
48 
49 template<class Type>
50 Foam::scalar Foam::det(const SquareMatrix<Type>& matrix)
51 {
52  SquareMatrix<Type> matrixTmp = matrix;
53 
54  labelList pivotIndices(matrix.m());
55  label sign;
56  LUDecompose(matrixTmp, pivotIndices, sign);
57 
58  return detDecomposed(matrixTmp, sign);
59 }
60 
61 
62 template<class Type>
63 Foam::scalar Foam::det(SquareMatrix<Type>& matrix)
64 {
65  labelList pivotIndices(matrix.m());
66  label sign;
67  LUDecompose(matrix, pivotIndices, sign);
68 
69  return detDecomposed(matrix, sign);
70 }
71 
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
dimensionedScalar sign(const dimensionedScalar &ds)
scalar detDecomposed(const SquareMatrix< Type > &, const label sign)
Return the LU decomposed SquareMatrix det.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
void LUDecompose(scalarSquareMatrix &matrix, labelList &pivotIndices)
LU decompose the matrix with pivoting.
dimensionedScalar det(const dimensionedSphericalTensor &dt)
List< label > labelList
A List of labels.
Definition: labelList.H:56