MatrixI.H 9.6 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
6 7 8 9 10
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11 12 13 14
    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.
15 16 17 18 19 20 21

    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
22
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
23 24 25 26 27

\*---------------------------------------------------------------------------*/

// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

28 29
template<class Form, class Type>
inline Foam::Matrix<Form, Type>::Matrix()
30
:
31 32
    nRows_(0),
    nCols_(0),
33 34 35 36
    v_(NULL)
{}


37
template<class Form, class Type>
38
inline Foam::autoPtr<Foam::Matrix<Form, Type>> Foam::Matrix<Form, Type>::
39
clone() const
40
{
41
    return autoPtr<Matrix<Form, Type>>(new Matrix<Form, Type>(*this));
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
template<class Form, class Type>
Foam::Matrix<Form, Type>::ConstBlock::ConstBlock
(
    const mType& matrix,
    const label m,
    const label n,
    const label mStart,
    const label nStart
)
:
    matrix_(matrix),
    nRows_(m),
    nCols_(n),
    rowStart_(mStart),
    colStart_(nStart)
{
    #ifdef FULLDEBUG
    if
    (
        rowStart_ + nRows_ > matrix.m()
     || colStart_ + nCols_ > matrix.n()
    )
    {
        FatalErrorInFunction
            << "Block addresses outside matrix"
            << abort(FatalError);
    }
    #endif
}


template<class Form, class Type>
Foam::Matrix<Form, Type>::Block::Block
(
    mType& matrix,
    const label m,
    const label n,
    const label mStart,
    const label nStart
)
:
    matrix_(matrix),
    nRows_(m),
    nCols_(n),
    rowStart_(mStart),
    colStart_(nStart)
{
    #ifdef FULLDEBUG
    if
    (
        rowStart_ + nRows_ > matrix.m()
     || colStart_ + nCols_ > matrix.n()
    )
    {
        FatalErrorInFunction
            << "Block addresses outside matrix"
            << abort(FatalError);
    }
    #endif
}


107 108
// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

109 110 111
template<class Form, class Type>
inline const Foam::Matrix<Form, Type>& Foam::Matrix<Form, Type>::null()
{
112
    return NullObjectRef<Matrix<Form, Type>>();
113 114 115
}


116
template<class Form, class Type>
117
inline Foam::label Foam::Matrix<Form, Type>::m() const
118
{
119
    return nRows_;
120 121 122
}


123
template<class Form, class Type>
124
inline Foam::label Foam::Matrix<Form, Type>::n() const
125
{
126
    return nCols_;
127 128 129
}


130 131
template<class Form, class Type>
inline Foam::label Foam::Matrix<Form, Type>::size() const
132
{
133
    return nRows_*nCols_;
134 135 136
}


137 138
template<class Form, class Type>
inline void Foam::Matrix<Form, Type>::checki(const label i) const
139
{
140
    #ifdef FULLDEBUG
141
    if (!nRows_ || !nCols_)
142
    {
143
        FatalErrorInFunction
144
            << "Attempt to access element from empty matrix"
145 146
            << abort(FatalError);
    }
147
    else if (i<0 || i>=nRows_)
148
    {
149
        FatalErrorInFunction
150
            << "Index " << i << " out of range 0 ... " << nRows_-1
151 152
            << abort(FatalError);
    }
153
    #endif
154 155 156
}


157 158
template<class Form, class Type>
inline void Foam::Matrix<Form, Type>::checkj(const label j) const
159
{
160
    #ifdef FULLDEBUG
161
    if (!nRows_ || !nCols_)
162
    {
163
        FatalErrorInFunction
164
            << "Attempt to access element from empty matrix"
165 166
            << abort(FatalError);
    }
167
    else if (j<0 || j>=nCols_)
168
    {
169
        FatalErrorInFunction
170
            << "index " << j << " out of range 0 ... " << nCols_-1
171 172
            << abort(FatalError);
    }
173
    #endif
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
template<class Form, class Type>
inline Foam::label Foam::Matrix<Form, Type>::ConstBlock::m() const
{
    return nRows_;
}


template<class Form, class Type>
inline Foam::label Foam::Matrix<Form, Type>::ConstBlock::n() const
{
    return nCols_;
}


template<class Form, class Type>
inline Foam::label Foam::Matrix<Form, Type>::Block::m() const
{
    return nRows_;
}


template<class Form, class Type>
inline Foam::label Foam::Matrix<Form, Type>::Block::n() const
{
    return nCols_;
}

204

205
template<class Form, class Type>
206 207 208 209 210 211 212 213 214 215 216 217 218
inline const Type* Foam::Matrix<Form, Type>::v() const
{
    return v_;
}


template<class Form, class Type>
inline Type* Foam::Matrix<Form, Type>::v()
{
    return v_;
}


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 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
template<class Form, class Type>
inline typename Foam::Matrix<Form, Type>::ConstBlock
Foam::Matrix<Form, Type>::block
(
    const label m,
    const label n,
    const label mStart,
    const label nStart
) const
{
    return ConstBlock
    (
        *this,
        m,
        n,
        mStart,
        nStart
    );
}


template<class Form, class Type>
template<class VectorSpace>
inline typename Foam::Matrix<Form, Type>::ConstBlock
Foam::Matrix<Form, Type>::block
(
    const label mStart,
    const label nStart
) const
{
    return ConstBlock
    (
        *this,
        VectorSpace::nRows,
        VectorSpace::nCols,
        mStart,
        nStart
    );
}


template<class Form, class Type>
inline typename Foam::Matrix<Form, Type>::ConstBlock
Foam::Matrix<Form, Type>::col
(
    const label m,
    const label mStart
) const
{
    return ConstBlock
    (
        *this,
        m,
        1,
        mStart,
        0
    );
}


template<class Form, class Type>
inline typename Foam::Matrix<Form, Type>::ConstBlock
Foam::Matrix<Form, Type>::col
(
    const label m,
    const label mStart,
    const label nStart
) const
{
    return ConstBlock
    (
        *this,
        m,
        1,
        mStart,
        nStart
    );
}


template<class Form, class Type>
inline typename Foam::Matrix<Form, Type>::Block
Foam::Matrix<Form, Type>::block
(
    const label m,
    const label n,
    const label mStart,
    const label nStart
)
{
    return Block
    (
        *this,
        m,
        n,
        mStart,
        nStart
    );
}


template<class Form, class Type>
template<class VectorSpace>
inline typename Foam::Matrix<Form, Type>::Block
Foam::Matrix<Form, Type>::block(const label mStart, const label nStart)
{
    return Block
    (
        *this,
        VectorSpace::nRows,
        VectorSpace::nCols,
        mStart,
        nStart
    );
}


template<class Form, class Type>
inline typename Foam::Matrix<Form, Type>::Block
Foam::Matrix<Form, Type>::col(const label m, const label mStart)
{
    return Block
    (
        *this,
        m,
        1,
        mStart,
        0
    );
}


template<class Form, class Type>
inline typename Foam::Matrix<Form, Type>::Block
Foam::Matrix<Form, Type>::col
(
    const label m,
    const label mStart,
    const label nStart
)
{
    return Block
    (
        *this,
        m,
        1,
        mStart,
        nStart
    );
}


// * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //

template<class Form, class Type>
inline const Type& Foam::Matrix<Form, Type>::ConstBlock::operator()
(
    const label i,
    const label j
) const
{
    #ifdef FULLDEBUG
    if (i<0 || i>=nRows_)
    {
        FatalErrorInFunction
            << "Index " << i << " out of range 0 ... " << nRows_-1
            << abort(FatalError);
    }
    if (j<0 || j>=nCols_)
    {
        FatalErrorInFunction
            << "Index " << j << " out of range 0 ... " << nCols_-1
            << abort(FatalError);
    }
    #endif

    return matrix_(i + rowStart_, j + colStart_);
}


template<class Form, class Type>
inline const Type& Foam::Matrix<Form, Type>::Block::operator()
(
    const label i,
    const label j
) const
{
    #ifdef FULLDEBUG
    if (i<0 || i>=nRows_)
    {
        FatalErrorInFunction
            << "Index " << i << " out of range 0 ... " << nRows_-1
            << abort(FatalError);
    }
    if (j<0 || j>=nCols_)
    {
        FatalErrorInFunction
            << "Index " << j << " out of range 0 ... " << nCols_-1
            << abort(FatalError);
    }
    #endif

    return matrix_(i + rowStart_, j + colStart_);
}


template<class Form, class Type>
inline Type& Foam::Matrix<Form, Type>::Block::operator()
(
    const label i,
    const label j
)
{
    #ifdef FULLDEBUG
    if (i<0 || i>=nRows_)
    {
        FatalErrorInFunction
            << "Index " << i << " out of range 0 ... " << nRows_-1
            << abort(FatalError);
    }
    if (j<0 || j>=nCols_)
    {
        FatalErrorInFunction
            << "Index " << j << " out of range 0 ... " << nCols_-1
            << abort(FatalError);
    }
    #endif

    return matrix_(i + rowStart_, j + colStart_);
}


451 452 453 454 455 456
template<class Form, class Type>
inline const Type& Foam::Matrix<Form, Type>::operator()
(
    const label i,
    const label j
) const
457 458
{
    checki(i);
459
    checkj(j);
460 461 462 463 464 465 466 467 468 469 470 471
    return v_[i*nCols_ + j];
}


template<class Form, class Type>
inline Type& Foam::Matrix<Form, Type>::operator()
(
    const label i,
    const label j
)
{
    checki(i);
472
    checkj(j);
473
    return v_[i*nCols_ + j];
474 475 476
}


477 478
template<class Form, class Type>
inline const Type* Foam::Matrix<Form, Type>::operator[](const label i) const
479 480
{
    checki(i);
481 482 483 484 485 486 487 488 489
    return v_ + i*nCols_;
}


template<class Form, class Type>
inline Type* Foam::Matrix<Form, Type>::operator[](const label i)
{
    checki(i);
    return v_ + i*nCols_;
490 491 492 493
}


// ************************************************************************* //