RectangularMatrix.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-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 Class
25  Foam::RectangularMatrix
26 
27 Description
28  A templated 2D rectangular m x n matrix of objects of <Type>.
29 
30  The matrix dimensions are used for subscript bounds checking etc.
31 
32 SourceFiles
33  RectangularMatrixI.H
34  RectangularMatrix.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef RectangularMatrix_H
39 #define RectangularMatrix_H
40 
41 #include "Matrix.H"
42 #include "SquareMatrix.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class Matrix Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class Type>
55 :
56  public Matrix<RectangularMatrix<Type>, Type>
57 {
58 
59 public:
60 
61  // Constructors
62 
63  //- Null constructor.
64  inline RectangularMatrix();
65 
66  //- Construct given number of rows and columns,
67  inline RectangularMatrix(const label m, const label n);
68 
69  //- Construct from a block of another matrix
70  template<class MatrixType>
72 
73  //- Construct from a block of another matrix
74  template<class MatrixType>
76 
77  //- Construct with given number of rows and columns
78  // initializing all elements to zero
79  inline RectangularMatrix(const label m, const label n, const zero);
80 
81  //- Construct with given number of rows and columns
82  // and value for all elements.
83  inline RectangularMatrix(const label m, const label n, const Type&);
84 
85  //- Construct as copy of a square matrix
87 
88  //- Construct from Istream.
89  inline RectangularMatrix(Istream&);
90 
91  //- Clone
92  inline autoPtr<RectangularMatrix<Type>> clone() const;
93 
94 
95  // Member operators
96 
97  //- Assignment of all elements to zero
98  void operator=(const zero);
99 };
100 
101 
102 // Global functions and operators
103 
104 template<class Type>
106 {
107 public:
110 };
111 
112 template<class Type>
113 class typeOfInnerProduct<Type, RectangularMatrix<Type>, SquareMatrix<Type>>
114 {
115 public:
118 };
119 
120 template<class Type>
121 class typeOfInnerProduct<Type, SquareMatrix<Type>, RectangularMatrix<Type>>
122 {
123 public:
126 };
127 
128 
129 template<class Type>
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 } // End namespace Foam
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #include "RectangularMatrixI.H"
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 #endif
144 
145 // ************************************************************************* //
label n() const
Return the number of columns.
Definition: MatrixI.H:64
Abstract template class to provide the form resulting from.
Definition: products.H:47
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
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A templated block of an (m x n) matrix of type <MatrixType>.
Definition: Matrix.H:71
scalar f1
Definition: createFields.H:28
void outer(FieldField< Field1, typename outerProduct< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
Pre-declare SubField and related Field type.
Definition: Field.H:57
A templated 2D rectangular m x n matrix of objects of <Type>.
void operator=(const zero)
Assignment of all elements to zero.
A templated (m x n) matrix of objects of <T>.
autoPtr< RectangularMatrix< Type > > clone() const
Clone.
fileName::Type type(const fileName &, const bool followLink=true)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:481
label m() const
Return the number of rows.
Definition: MatrixI.H:57
A class representing the concept of 0 used to avoid unnecessary manipulations for objects that are kn...
Definition: zero.H:49
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
RectangularMatrix()
Null constructor.
A templated 2D square matrix of objects of <T>, where the n x n matrix dimension is known and used fo...
Definition: SquareMatrix.H:58
Namespace for OpenFOAM.