DiagonalMatrix.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-2024 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::DiagonalMatrix
26 
27 Description
28  DiagonalMatrix<Type> is a 2D diagonal matrix of objects
29  of type Type, size nxn
30 
31 SourceFiles
32  DiagonalMatrix.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef DiagonalMatrix_H
37 #define DiagonalMatrix_H
38 
39 #include "List.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // * * * * * * * * * * * * Class Forward declaration * * * * * * * * * * * //
47 
48 template<class Form, class Type> class Matrix;
49 
50 /*---------------------------------------------------------------------------*\
51  Class DiagonalMatrix Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class Type>
55 class DiagonalMatrix
56 :
57  public List<Type>
58 {
59 public:
60 
61  // Constructors
62 
63  //- Null constructor.
65 
66  //- Construct from diagonal component of a Matrix
67  template<class Form>
69 
70  //- Construct empty from size
71  DiagonalMatrix(const label size);
72 
73  //- Construct from size and a value
74  DiagonalMatrix(const label, const Type&);
75 
76  //- Construct from Istream.
78 
79 
80  // Member Functions
81 
82  //- Return the instantiated type name
83  static word typeName()
84  {
85  return word("DiagonalMatrix<") + pTraits<Type>::typeName + '>';
86  }
87 
88  //- Invert the diagonal matrix and return itself
90 };
91 
92 
93 // Global functions
94 
95 //- Return the diagonal Matrix inverse
96 template<class Type>
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #ifdef NoRepository
107  #include "DiagonalMatrix.C"
108 #endif
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
DiagonalMatrix<Type> is a 2D diagonal matrix of objects of type Type, size nxn.
static word typeName()
Return the instantiated type name.
DiagonalMatrix< Type > & invert()
Invert the diagonal matrix and return itself.
DiagonalMatrix()
Null constructor.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: List.H:91
label size() const
Return the number of elements in the UList.
Definition: ListI.H:171
A templated (m x n) matrix of objects of <T>.
Definition: Matrix.H:80
Traits class for primitives.
Definition: pTraits.H:53
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
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)