src/lduSolvers/crMatrix/crAddressing.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     crAddressing
  26
  27 Description
  28     Compressed row matrix addressing
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     crAddressing.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef crAddressing_H
  39 #define crAddressing_H
  40
  41 #include "labelList.H"
  42 #include "refCount.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                         Class crAddressing Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class crAddressing
  54 :
  55     public refCount
  56 {
  57     // Private data
  58
  59         //- Number of rows
  60         label nRows_;
  61
  62         //- Number of columns
  63         label nCols_;
  64
  65         //- Row array.
  66         //  Provides start index for each row, dimensioned to nRows + 1
  67         labelList row_;
  68
  69         //- Column array
  70         labelList col_;
  71
  72     // Private Member Functions
  73
  74         //- Set row count
  75         void setRowCount(const labelList& count);
  76
  77
  78 public:
  79
  80     // Constructors
  81
  82         //- Construct given size.  Column and coefficients set later
  83         crAddressing
  84         (
  85             const label nRows,
  86             const label nCols,
  87             const labelList& count
  88         );
  89
  90         //- Construct from components
  91         crAddressing
  92         (
  93             const label nRows,
  94             const label nCols,
  95             const labelList& row,
  96             const labelList& col
  97         );
  98
  99         //- Construct as copy
 100         crAddressing(const crAddressing&);
 101
 102         //- Construct from Istream
 103         crAddressing(Istream&);
 104
 105
 106     // Destructor - default
 107
 108
 109     // Member Functions
 110
 111         // Access
 112
 113             //- Return number of rows
 114             label nRows() const
 115             {
 116                 return nRows_;
 117             }
 118
 119             //- Return number of columns
 120             label nCols() const
 121             {
 122                 return nCols_;
 123             }
 124
 125             //- Return number of coefficients
 126             label nEntries() const
 127             {
 128                 return col_.size();
 129             }
 130
 131             //- Return row array
 132             const labelList& row() const
 133             {
 134                 return row_;
 135             }
 136
 137             //- Return column array
 138             const labelList& col() const
 139             {
 140                 return col_;
 141             }
 142
 143
 144         // Edit
 145
 146             //- Return column array
 147             labelList& col()
 148             {
 149                 return col_;
 150             }
 151
 152
 153         // Operations
 154
 155             //- Return transpose addressing
 156             tmp<crAddressing> T() const;
 157
 158
 159     // Member Operators
 160
 161         void operator=(const crAddressing&);
 162
 163     // IOstream Operators
 164
 165         friend Ostream& operator<<(Ostream&, const crAddressing&);
 166 };
 167
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 } // End namespace Foam
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #endif
 176
 177 // ************************************************************************* //