src/OpenFOAM/matrices/Matrix/MatrixI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 \*---------------------------------------------------------------------------*/
  26
  27 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  28
  29 template<class Form, class Type>
  30 inline Foam::Matrix<Form, Type>::Matrix()
  31 :
  32     v_(NULL),
  33     n_(0),
  34     m_(0)
  35 {}
  36
  37
  38 template<class Form, class Type>
  39 inline Foam::autoPtr<Foam::Matrix<Form, Type> >
  40 Foam::Matrix<Form, Type>::clone() const
  41 {
  42     return autoPtr<Matrix<Form, Type> >(new Matrix<Form, Type>(*this));
  43 }
  44
  45
  46 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  47
  48 template<class Form, class Type>
  49 inline const Foam::Matrix<Form, Type>& Foam::Matrix<Form, Type>::null()
  50 {
  51     return *reinterpret_cast< Matrix<Form, Type>* >(0);
  52 }
  53
  54
  55 //- Return the number of rows
  56 template<class Form, class Type>
  57 inline Foam::label Foam::Matrix<Form, Type>::n() const
  58 {
  59     return n_;
  60 }
  61
  62
  63 template<class Form, class Type>
  64 inline Foam::label Foam::Matrix<Form, Type>::m() const
  65 {
  66     return m_;
  67 }
  68
  69
  70 template<class Form, class Type>
  71 inline Foam::label Foam::Matrix<Form, Type>::size() const
  72 {
  73     return n_*m_;
  74 }
  75
  76
  77 template<class Form, class Type>
  78 inline void Foam::Matrix<Form, Type>::checki(const label i) const
  79 {
  80     if (!n_)
  81     {
  82         FatalErrorIn("Matrix<Form, Type>::checki(const label)")
  83             << "attempt to access element from zero sized row"
  84             << abort(FatalError);
  85     }
  86     else if (i<0 || i>=n_)
  87     {
  88         FatalErrorIn("Matrix<Form, Type>::checki(const label)")
  89             << "index " << i << " out of range 0 ... " << n_-1
  90             << abort(FatalError);
  91     }
  92 }
  93
  94
  95 template<class Form, class Type>
  96 inline void Foam::Matrix<Form, Type>::checkj(const label j) const
  97 {
  98     if (!m_)
  99     {
 100         FatalErrorIn("Matrix<Form, Type>::checkj(const label)")
 101             << "attempt to access element from zero sized column"
 102             << abort(FatalError);
 103     }
 104     else if (j<0 || j>=m_)
 105     {
 106         FatalErrorIn("Matrix<Form, Type>::checkj(const label)")
 107             << "index " << j << " out of range 0 ... " << m_-1
 108             << abort(FatalError);
 109     }
 110 }
 111
 112
 113 // * * * * * * * * * * * * * * * Member Operators  * * * * * * * * * * * * * //
 114
 115 template<class Form, class Type>
 116 inline Type* Foam::Matrix<Form, Type>::operator[](const label i)
 117 {
 118 #   ifdef FULLDEBUG
 119     checki(i);
 120 #   endif
 121     return v_[i];
 122 }
 123
 124
 125 template<class Form, class Type>
 126 inline const Type* Foam::Matrix<Form, Type>::operator[](const label i) const
 127 {
 128 #   ifdef FULLDEBUG
 129     checki(i);
 130 #   endif
 131     return v_[i];
 132 }
 133
 134
 135 // ************************************************************************* //