File size: 10,787 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::Matrix
Description
A templated (m x n) matrix of objects of \<T\>.
SourceFiles
Matrix.C
MatrixI.H
MatrixIO.C
\*---------------------------------------------------------------------------*/
#ifndef Matrix_H
#define Matrix_H
#include "bool.H"
#include "label.H"
#include "uLabel.H"
#include "Field.H"
#include "zero.H"
#include "autoPtr.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
template<class Form, class Type> class Matrix;
template<class Form, class Type> Istream& operator>>
(
Istream&,
Matrix<Form, Type>&
);
template<class Form, class Type> Ostream& operator<<
(
Ostream&,
const Matrix<Form, Type>&
);
template<class MatrixType>
class ConstMatrixBlock;
template<class MatrixType>
class MatrixBlock;
template<class Form, class Cmpt, direction Mrows, direction Ncols>
class MatrixSpace;
/*---------------------------------------------------------------------------*\
Class Matrix Declaration
\*---------------------------------------------------------------------------*/
template<class Form, class Type>
class Matrix
{
// Private Data
//- Number of rows and columns in Matrix.
label mRows_, nCols_;
//- Row pointers
Type* __restrict__ v_;
//- Allocate the storage for the element vector
void allocate();
public:
//- Matrix type
typedef Matrix<Form, Type> mType;
//- Component type
typedef Type cmptType;
// Static Member Functions
//- Return a null Matrix
inline static const mType& null();
// Constructors
//- Null constructor.
inline Matrix();
//- Construct given number of rows and columns.
Matrix(const label m, const label n);
//- Construct with given number of rows and columns
// initialising all elements to zero
Matrix(const label m, const label n, const zero);
//- Construct with given number of rows and columns
// initialising all elements to the given value
Matrix(const label m, const label n, const Type&);
//- Construct with given number of rows and columns
// and start and end iterators
template<class InputIterator>
Matrix
(
const label m,
const label n,
InputIterator first,
InputIterator last
);
//- Construct with given number of rows and columns and initialiser list
Matrix(const label m, const label n, std::initializer_list<Type>);
//- Construct from initialiser list list
Matrix(std::initializer_list<std::initializer_list<Type>>);
//- Copy constructor.
Matrix(const mType&);
//- Copy constructor from matrix of a different form
template<class Form2>
explicit Matrix(const Matrix<Form2, Type>&);
//- Construct from a block of another matrix
template<class MatrixType>
Matrix(const ConstMatrixBlock<MatrixType>&);
//- Construct from a block of another matrix
template<class MatrixType>
Matrix(const MatrixBlock<MatrixType>&);
template<class MSForm, direction Mrows, direction Ncols>
Matrix(const MatrixSpace<MSForm, Type, Mrows, Ncols>&);
//- Construct from Istream.
Matrix(Istream&);
//- Clone
inline autoPtr<mType> clone() const;
//- Destructor
~Matrix();
// Member Functions
// Access
//- Return the number of rows
inline label m() const;
//- Return the number of columns
inline label n() const;
//- Return the number of elements in matrix (m*n)
inline label size() const;
//- Return element vector of the constant Matrix
inline const Type* v() const;
//- Return element vector of the Matrix
inline Type* v();
// Block access
inline ConstMatrixBlock<mType> block
(
const label m,
const label n,
const label mStart,
const label nStart
) const;
template<class VectorSpace>
inline ConstMatrixBlock<mType> block
(
const label mStart,
const label nStart
) const;
inline ConstMatrixBlock<mType> col
(
const label m,
const label rowStart
) const;
inline ConstMatrixBlock<mType> col
(
const label m,
const label mStart,
const label nStart
) const;
inline MatrixBlock<mType> block
(
const label m,
const label n,
const label mStart,
const label nStart
);
template<class VectorSpace>
inline MatrixBlock<mType> block
(
const label mStart,
const label nStart
);
inline MatrixBlock<mType> col
(
const label m,
const label rowStart
);
inline MatrixBlock<mType> col
(
const label m,
const label mStart,
const label nStart
);
// Check
//- Check index i is within valid range (0 ... m-1).
inline void checki(const label i) const;
//- Check index j is within valid range (0 ... n-1).
inline void checkj(const label j) const;
// Edit
//- Clear the Matrix, i.e. set sizes to zero.
void clear();
//- Transfer the contents of the argument Matrix into this Matrix
// and annul the argument Matrix.
void transfer(mType&);
//- Resize the matrix preserving the elements
void setSize(const label m, const label n);
//- Resize the matrix without reallocating storage (unsafe)
inline void shallowResize(const label m, const label n);
//- Return the transpose of the matrix
Form T() const;
// Member Operators
//- Return subscript-checked row of Matrix.
inline Type* operator[](const label);
//- Return subscript-checked row of constant Matrix.
inline const Type* operator[](const label) const;
//- (i, j) const element access operator
inline const Type& operator()(const label i, const label j) const;
//- (i, j) element access operator
inline Type& operator()(const label i, const label j);
//- Assignment operator. Takes linear time.
void operator=(const mType&);
//- Assignment to a block of another matrix
template<class MatrixType>
void operator=(const ConstMatrixBlock<MatrixType>&);
//- Assignment to a block of another matrix
template<class MatrixType>
void operator=(const MatrixBlock<MatrixType>&);
//- Assignment of all elements to zero
void operator=(const zero);
//- Assignment of all elements to the given value
void operator=(const Type&);
// IOstream Operators
//- Read Matrix from Istream, discarding contents of existing Matrix.
friend Istream& operator>> <Form, Type>
(
Istream&,
mType&
);
//- Write Matrix to Ostream.
friend Ostream& operator<< <Form, Type>
(
Ostream&,
const mType&
);
};
namespace expression
{
template<class Form, class Type>
struct Expressionable<Matrix<Form, Type>>
:
public notExpressionable
{};
}
// Global functions and operators
template<class Form, class Type>
void writeEntry(Ostream&, const Matrix<Form, Type>&);
template<class Form, class Type>
const Type& max(const Matrix<Form, Type>&);
template<class Form, class Type>
const Type& min(const Matrix<Form, Type>&);
template<class Form, class Type>
Form operator-(const Matrix<Form, Type>&);
template<class Form, class Type>
Form operator+
(
const Matrix<Form, Type>&,
const Matrix<Form, Type>&
);
template<class Form, class Type>
Form operator-
(
const Matrix<Form, Type>&,
const Matrix<Form, Type>&
);
template<class Form, class Type>
Form operator*
(
const scalar,
const Matrix<Form, Type>&
);
template<class Form, class Type>
Form operator*
(
const Matrix<Form, Type>&,
const scalar
);
template<class Form, class Type>
Form operator/
(
const Matrix<Form, Type>&,
const scalar
);
template<class Form1, class Form2, class Type>
typename typeOfInnerProduct<Type, Form1, Form2>::type
operator*
(
const Matrix<Form1, Type>& a,
const Matrix<Form2, Type>& b
);
template<class Form, class Type>
tmp<Field<Type>> operator*
(
const Matrix<Form, Type>&,
const Field<Type>&
);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "MatrixI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "Matrix.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|