File size: 9,530 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-2023 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::MatrixSpace
Description
Templated matrix space.
Template arguments are the Form the matrix space will be used to create,
the type of the elements and the number of rows and columns of the matrix.
SourceFiles
MatrixSpaceI.H
See also
Foam::VectorSpace
\*---------------------------------------------------------------------------*/
#ifndef MatrixSpace_H
#define MatrixSpace_H
#include "VectorSpace.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class MatrixSpace Declaration
\*---------------------------------------------------------------------------*/
template<class Form, class Cmpt, direction Mrows, direction Ncols>
class MatrixSpace
:
public VectorSpace<Form, Cmpt, Mrows*Ncols>
{
public:
//- MatrixSpace type
typedef MatrixSpace<Form, Cmpt, Mrows, Ncols> msType;
// Member constants
static const direction mRows = Mrows;
static const direction nCols = Ncols;
// Static member functions
//- Return the number of rows
static direction m()
{
return Mrows;
}
//- Return the number of columns
static direction n()
{
return Ncols;
}
//- Return the identity matrix for square matrix spaces
inline static msType identityMap();
// Sub-Block Classes
//- Const sub-block type
template<class SubTensor, direction BRowStart, direction BColStart>
class ConstBlock
{
//- Reference to parent matrix
const msType& matrix_;
public:
static const direction mRows = SubTensor::mRows;
static const direction nCols = SubTensor::nCols;
//- Return the number of rows in the block
static direction m()
{
return mRows;
}
//- Return the number of columns in the block
static direction n()
{
return nCols;
}
//- Construct for the given matrix
inline ConstBlock(const msType& matrix);
//- Construct and return the sub-ensor corresponding to this block
inline SubTensor operator()() const;
//- (i, j) const element access operator
inline const Cmpt& operator()
(
const direction i,
const direction j
) const;
};
//- Sub-block type
template
<
class SubTensor,
direction BRowStart,
direction BColStart
>
class Block
{
//- Reference to parent matrix
msType& matrix_;
public:
static const direction mRows = SubTensor::mRows;
static const direction nCols = SubTensor::nCols;
//- Return the number of rows in the block
static direction m()
{
return mRows;
}
//- Return the number of columns in the block
static direction n()
{
return nCols;
}
//- Construct for the given matrix
inline Block(msType& matrix);
//- Assignment to a matrix
template<class Form2>
inline void operator=
(
const MatrixSpace
<
Form2,
Cmpt,
SubTensor::mRows,
SubTensor::nCols
>& matrix
);
//- Assignment to a column vector
template<class VSForm>
inline void operator=
(
const VectorSpace<VSForm, Cmpt, SubTensor::mRows>& v
);
//- Construct and return the sub-tensor corresponding to this block
inline SubTensor operator()() const;
//- (i, j) const element access operator
inline const Cmpt& operator()
(
const direction i,
const direction j
) const;
//- (i, j) element access operator
inline Cmpt& operator()(const direction i, const direction j);
};
// Constructors
//- Construct null
inline MatrixSpace();
//- Construct initialised to zero
inline MatrixSpace(const Foam::zero);
//- Construct as copy of a VectorSpace with the same size
template<class Form2, class Cmpt2>
inline explicit MatrixSpace
(
const VectorSpace<Form2, Cmpt2, Mrows*Ncols>&
);
//- Construct from a block of another matrix space
template
<
template<class, direction, direction> class Block2,
direction BRowStart,
direction BColStart
>
inline MatrixSpace
(
const Block2<Form, BRowStart, BColStart>& block
);
//- Construct from Istream
MatrixSpace(Istream&);
// Member Functions
//- Fast const element access using compile-time addressing
template<direction Row, direction Col>
inline const Cmpt& elmt() const;
//- Fast element access using compile-time addressing
template<direction Row, direction Col>
inline Cmpt& elmt();
// Const element access functions for a 3x3
// Compile-time errors are generated for inappropriate use
inline const Cmpt& xx() const;
inline const Cmpt& xy() const;
inline const Cmpt& xz() const;
inline const Cmpt& yx() const;
inline const Cmpt& yy() const;
inline const Cmpt& yz() const;
inline const Cmpt& zx() const;
inline const Cmpt& zy() const;
inline const Cmpt& zz() const;
// Element access functions for a 3x3
// Compile-time errors are generated for inappropriate use
inline Cmpt& xx();
inline Cmpt& xy();
inline Cmpt& xz();
inline Cmpt& yx();
inline Cmpt& yy();
inline Cmpt& yz();
inline Cmpt& zx();
inline Cmpt& zy();
inline Cmpt& zz();
//- Return the transpose of the matrix
inline typename typeOfTranspose<Cmpt, Form>::type T() const;
//- Return a const sub-block corresponding to the specified type
// starting at the specified row and column
template<class SubTensor, direction BRowStart, direction BColStart>
inline ConstBlock<SubTensor, BRowStart, BColStart> block() const;
//- Return a sub-block corresponding to the specified type
// starting at the specified row and column
template<class SubTensor, direction BRowStart, direction BColStart>
inline Block<SubTensor, BRowStart, BColStart> block();
//- (i, j) const element access operator
inline const Cmpt& operator()
(
const direction& i,
const direction& j
) const;
//- (i, j) element access operator
inline Cmpt& operator()(const direction& i, const direction& j);
// Member Operators
//- Assignment to zero
inline void operator=(const Foam::zero);
//- Assignment to a block of another matrix space
template
<
template<class, direction, direction> class Block2,
direction BRowStart,
direction BColStart
>
inline void operator=
(
const Block2<Form, BRowStart, BColStart>& block
);
//- Inner product with a compatible square matrix
template<class Form2>
inline void operator&=
(
const MatrixSpace<Form, Cmpt, Ncols, Ncols>& matrix
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "MatrixSpaceI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|