SquareMatrix.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2013 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 Class
25  Foam::SquareMatrix
26 
27 Description
28  A templated 2D square matrix of objects of <T>, where the n x n matrix
29  dimension is known and used for subscript bounds checking, etc.
30 
31 SourceFiles
32  SquareMatrixI.H
33  SquareMatrix.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef SquareMatrix_H
38 #define SquareMatrix_H
39 
40 #include "Matrix.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class Matrix Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class Type>
52 class SquareMatrix
53 :
54  public Matrix<SquareMatrix<Type>, Type>
55 {
56 
57 public:
58 
59  // Constructors
60 
61  //- Null constructor.
62  inline SquareMatrix();
63 
64  //- Construct given number of rows/columns.
65  inline SquareMatrix(const label n);
66 
67  //- Construct given number of rows and columns,
68  // It checks that m == n.
69  inline SquareMatrix(const label m, const label n);
70 
71  //- Construct with given number of rows and rows
72  // and value for all elements.
73  // It checks that m == n.
74  inline SquareMatrix(const label m, const label n, const Type&);
75 
76  //- Construct from Istream.
77  inline SquareMatrix(Istream&);
78 
79  //- Clone
80  inline autoPtr<SquareMatrix<Type> > clone() const;
81 };
82 
83 
84 // Global functions
85 
86 //- Return the LU decomposed SquareMatrix det
87 template<class Type>
88 scalar detDecomposed(const SquareMatrix<Type>&, const label sign);
89 
90 //- Return the SquareMatrix det
91 template<class Type>
92 scalar det(const SquareMatrix<Type>&);
93 
94 //- Return the SquareMatrix det and the LU decomposition in the original matrix
95 template<class Type>
96 scalar det(SquareMatrix<Type>&);
97 
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 # include "SquareMatrixI.H"
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #ifdef NoRepository
110 # include "SquareMatrix.C"
111 #endif
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
A templated 2D matrix of objects of <T>, where the n x m matrix dimensions are known and used for sub...
label n() const
Return the number of rows.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
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
scalar detDecomposed(const SquareMatrix< Type > &, const label sign)
Return the LU decomposed SquareMatrix det.
dimensionedScalar sign(const dimensionedScalar &ds)
Namespace for OpenFOAM.
dimensionedScalar det(const dimensionedSphericalTensor &dt)
autoPtr< SquareMatrix< Type > > clone() const
Clone.
Definition: SquareMatrixI.H:82
SquareMatrix()
Null constructor.
Definition: SquareMatrixI.H:29
A templated 2D square matrix of objects of <T>, where the n x n matrix dimension is known and used fo...
Definition: SquareMatrix.H:51
label m() const
Return the number of columns.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117