File size: 6,998 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2016-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::MatrixBlock
Description
A templated block of an (m x n) matrix of type \<MatrixType\>.
Foam::ConstMatrixBlock: block of a const matrix
Foam::MatrixBlock: block of a non-const matrix
The block may be assigned to a block of another matrix or to a VectorSpace
or MatrixSpace e.g. \c tensor. Conversion of a column block to a \c
Field<T> is also provide.
SourceFiles
MatrixBlock.C
MatrixBlockI.H
\*---------------------------------------------------------------------------*/
#ifndef MatrixBlock_H
#define MatrixBlock_H
#include "Matrix.H"
#include "MatrixSpace.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class ConstMatrixBlock Declaration
\*---------------------------------------------------------------------------*/
template<class MatrixType>
class ConstMatrixBlock
{
// Private Data
//- Const reference to the parent matrix
const MatrixType& matrix_;
// Block size
const label mRows_;
const label nCols_;
// Block location in parent matrix
const label rowStart_;
const label colStart_;
public:
typedef typename MatrixType::cmptType cmptType;
// Constructors
//- Construct block for matrix, size and location
inline ConstMatrixBlock
(
const MatrixType& matrix,
const label m,
const label n,
const label mStart,
const label nStart
);
// Member Functions
//- Return the number of rows in the block
inline label m() const;
//- Return the number of columns in the block
inline label n() const;
//- (i, j) const element access operator
inline const cmptType& operator()
(
const label i,
const label j
) const;
//- Convert a column of a matrix to a Field
operator Field<cmptType>() const;
};
/*---------------------------------------------------------------------------*\
Class MatrixBlock Declaration
\*---------------------------------------------------------------------------*/
template<class MatrixType>
class MatrixBlock
{
// Private Data
//- Reference to the parent matrix
MatrixType& matrix_;
// Block size
const label mRows_;
const label nCols_;
// Block location in parent matrix
const label rowStart_;
const label colStart_;
public:
typedef typename MatrixType::cmptType cmptType;
// Constructors
//- Construct block for matrix, size and location
inline MatrixBlock
(
MatrixType& matrix,
const label m,
const label n,
const label mStart,
const label nStart
);
MatrixBlock(const MatrixBlock<MatrixType>&) = default;
// Member Functions
//- Return the number of rows in the block
inline label m() const;
//- Return the number of columns in the block
inline label n() const;
//- (i, j) const element access operator
inline const cmptType& operator()
(
const label i,
const label j
) const;
//- (i, j) element access operator
inline cmptType& operator()(const label i, const label j);
//- Convert a column of a matrix to a Field
operator Field<cmptType>() const;
// Member Operators
//- Assignment to a compatible matrix
template<class Form>
void operator=(const Matrix<Form, cmptType>&);
//- Assignment to a compatible const block
void operator=(const ConstMatrixBlock<MatrixType>&);
//- Assignment to a compatible block
void operator=(const MatrixBlock<MatrixType>&);
//- Assignment to a compatible const block
template<class MatrixType2>
void operator=(const ConstMatrixBlock<MatrixType2>&);
//- Assignment to a compatible block
template<class MatrixType2>
void operator=(const MatrixBlock<MatrixType2>&);
//- Assignment to a compatible MatrixSpace
template<class MSForm, direction Nrows, direction Ncols>
void operator=(const MatrixSpace<MSForm, cmptType, Nrows, Ncols>&);
//- Assignment to a compatible MatrixSpace block
template
<
template<class, direction, direction> class Block,
class SubTensor,
direction BRowStart,
direction BColStart
>
void operator=(const Block<SubTensor, BRowStart, BColStart>&);
//- Assignment to a compatible VectorSpace (column-vector)
template<class VSForm, direction Ncmpts>
void operator=(const VectorSpace<VSForm, cmptType, Ncmpts>&);
//- Assignment to a compatible VectorSpace (column-vector) block
template
<
template<class, direction> class Block,
class SubVector,
direction BStart
>
void operator=(const Block<SubVector, BStart>&);
//- Assignment to a Field (column-vector)
void operator=(const Field<cmptType>&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "MatrixBlockI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "MatrixBlock.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|