SymmetricSquareMatrix.H
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) 2011-2023 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::SymmetricSquareMatrix
26 
27 Description
28  A templated 2D square symmetric matrix of objects of <T>, where the
29  n x n matrix dimension is known and used for subscript bounds checking, etc.
30 
31 SourceFiles
32  SymmetricSquareMatrixI.H
33  SymmetricSquareMatrix.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef SymmetricSquareMatrix_H
38 #define SymmetricSquareMatrix_H
39 
40 #include "SquareMatrix.H"
41 #include "Identity.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class SymmetricSquareMatrix Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class Type>
54 :
55  public Matrix<SymmetricSquareMatrix<Type>, Type>
56 {
57 
58 public:
59 
60  // Constructors
61 
62  //- Null constructor.
63  inline SymmetricSquareMatrix();
64 
65  //- Construct given number of rows/columns.
66  inline SymmetricSquareMatrix(const label n);
67 
68  //- Construct given number of rows/columns, initialising to zero
69  inline SymmetricSquareMatrix(const label n, const zero);
70 
71  //- Construct given number of rows/columns,
72  inline SymmetricSquareMatrix(const label n, const Identity<Type>);
73 
74  //- Construct with given number of rows/columns
75  // initialising all elements to the given value
76  inline SymmetricSquareMatrix(const label n, const Type&);
77 
78  //- Construct from Istream.
80 
81  //- Clone
83 
84 
85  // Member Functions
86 
87  //- Return the instantiated type name
88  static word typeName()
89  {
90  return
91  word("SymmetricSquareMatrix<") + pTraits<Type>::typeName + '>';
92  }
93 
94 
95  // Member Operators
96 
98 };
99 
100 
101 // Global functions
102 
103 //- Return the LU decomposed SymmetricSquareMatrix inverse
104 template<class Type>
106 
107 //- Return the SymmetricSquareMatrix inverse
108 template<class Type>
110 
111 //- Return the LU decomposed SymmetricSquareMatrix det
112 template<class Type>
114 
115 //- Return the SymmetricSquareMatrix det
116 template<class Type>
117 Type det(const SymmetricSquareMatrix<Type>&);
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #include "SymmetricSquareMatrixI.H"
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #ifdef NoRepository
131  #include "SymmetricSquareMatrix.C"
132 #endif
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************************************************************* //
Templated identity and dual space identity tensors derived from SphericalTensor.
Definition: Identity.H:50
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
A templated (m x n) matrix of objects of <T>.
Definition: Matrix.H:80
label n() const
Return the number of columns.
Definition: MatrixI.H:64
friend Ostream & operator(Ostream &, const mType &)
Write Matrix to Ostream.
A templated 2D square symmetric matrix of objects of <T>, where the n x n matrix dimension is known a...
static word typeName()
Return the instantiated type name.
autoPtr< SymmetricSquareMatrix< Type > > clone() const
Clone.
SymmetricSquareMatrix()
Null constructor.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
Traits class for primitives.
Definition: pTraits.H:53
A class for handling words, derived from string.
Definition: word.H:62
A class representing the concept of 0 used to avoid unnecessary manipulations for objects that are kn...
Definition: zero.H:50
Namespace for OpenFOAM.
dimensionedScalar det(const dimensionedSphericalTensor &dt)
SymmetricSquareMatrix< Type > invDecomposed(const SymmetricSquareMatrix< Type > &)
Return the LU decomposed SymmetricSquareMatrix inverse.
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
dimensionedSphericalTensor inv(const dimensionedSphericalTensor &dt)
scalar detDecomposed(const SquareMatrix< Type > &, const label sign)
Return the LU decomposed SquareMatrix det.