src/lduSolvers/crMatrix/crAddressing.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-6 H. Jasak All rights reserved
   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 Class
  26     crAddressing
  27
  28 Description
  29     Compressed row matrix addressing
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     crAddressing.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef crAddressing_H
  40 #define crAddressing_H
  41
  42 #include "labelList.H"
  43 #include "refCount.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                         Class crAddressing Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class crAddressing
  55 :
  56     public refCount
  57 {
  58     // Private data
  59
  60         //- Number of rows
  61         label nRows_;
  62
  63         //- Number of columns
  64         label nCols_;
  65
  66         //- Row array.
  67         //  Provides start index for each row, dimensioned to nRows + 1
  68         labelList row_;
  69
  70         //- Column array
  71         labelList col_;
  72
  73     // Private Member Functions
  74
  75         //- Set row count
  76         void setRowCount(const labelList& count);
  77
  78
  79 public:
  80
  81     // Constructors
  82
  83         //- Construct given size.  Column and coefficients set later
  84         crAddressing
  85         (
  86             const label nRows,
  87             const label nCols,
  88             const labelList& count
  89         );
  90
  91         //- Construct from components
  92         crAddressing
  93         (
  94             const label nRows,
  95             const label nCols,
  96             const labelList& row,
  97             const labelList& col
  98         );
  99
 100         //- Construct as copy
 101         crAddressing(const crAddressing&);
 102
 103         //- Construct from Istream
 104         crAddressing(Istream&);
 105
 106
 107     // Destructor - default
 108
 109
 110     // Member Functions
 111
 112         // Access
 113
 114             //- Return number of rows
 115             label nRows() const
 116             {
 117                 return nRows_;
 118             }
 119
 120             //- Return number of columns
 121             label nCols() const
 122             {
 123                 return nCols_;
 124             }
 125
 126             //- Return number of coefficients
 127             label nEntries() const
 128             {
 129                 return col_.size();
 130             }
 131
 132             //- Return row array
 133             const labelList& row() const
 134             {
 135                 return row_;
 136             }
 137
 138             //- Return column array
 139             const labelList& col() const
 140             {
 141                 return col_;
 142             }
 143
 144
 145         // Edit
 146
 147             //- Return column array
 148             labelList& col()
 149             {
 150                 return col_;
 151             }
 152
 153
 154         // Operations
 155
 156             //- Return transpose addressing
 157             tmp<crAddressing> T() const;
 158
 159
 160     // Member Operators
 161
 162         void operator=(const crAddressing&);
 163
 164     // IOstream Operators
 165
 166         friend Ostream& operator<<(Ostream&, const crAddressing&);
 167 };
 168
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 } // End namespace Foam
 173
 174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 175
 176 #endif
 177
 178 // ************************************************************************* //