src/lduSolvers/crMatrix/crMatrix.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     crMatrix
  26
  27 Description
  28     Sparse matrix in compressed row format
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     crMatrix.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef crMatrix_H
  39 #define crMatrix_H
  40
  41 #include "crAddressing.H"
  42 #include "primitiveFields.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class crMatrix Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class crMatrix
  54 :
  55     public refCount
  56 {
  57     // Private data
  58
  59         //- Addressing
  60         crAddressing crAddr_;
  61
  62         //- Coefficients
  63         scalarField coeffs_;
  64
  65
  66 public:
  67
  68     // Constructors
  69
  70         //- Construct from addressing
  71         crMatrix(const crAddressing& addr);
  72
  73         //- Construct from row and column size and row count
  74         crMatrix
  75         (
  76             const label nRows,
  77             const label nCols,
  78             const labelList& count
  79         );
  80
  81         //- Construct from components of addressing
  82         crMatrix
  83         (
  84             const label nRows,
  85             const label nCols,
  86             const labelList& row,
  87             const labelList& col
  88         );
  89
  90         //- Construct as copy
  91         crMatrix(const crMatrix& m);
  92
  93         //- Construct as copy of tmp<crMatrix> deleting argument
  94         crMatrix(const tmp<crMatrix>& tm);
  95
  96         //- Construct from Istream
  97         crMatrix(Istream&);
  98
  99
 100     // Destructor - default
 101
 102
 103     // Member Functions
 104
 105         // Access
 106
 107             //- Return addressing
 108             const crAddressing& crAddr() const
 109             {
 110                 return crAddr_;
 111             }
 112
 113             //- Return coefficients
 114             const scalarField& coeffs() const
 115             {
 116                 return coeffs_;
 117             }
 118
 119             //- Return coefficients to be set
 120             scalarField& coeffs()
 121             {
 122                 return coeffs_;
 123             }
 124
 125             //- Return column array to be set
 126             labelList& col()
 127             {
 128                 return crAddr_.col();
 129             }
 130
 131
 132         // Matrix operations
 133
 134             //- Return transpose matrix
 135             tmp<crMatrix> T() const;
 136
 137         // Matrix-vector operations
 138
 139             //- Calculate b += A*x
 140             void dotPlus(scalarField& b, const scalarField& x) const;
 141
 142
 143     // Member operators
 144
 145         void operator=(const crMatrix&);
 146         void operator=(const tmp<crMatrix>&);
 147
 148
 149     // IOstream Operators
 150
 151         friend Ostream& operator<<(Ostream&, const crMatrix&);
 152 };
 153
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157 } // End namespace Foam
 158
 159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 160
 161 #endif
 162
 163 // ************************************************************************* //