src/lduSolvers/amg/amgMatrix.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     amgMatrix
  26
  27 Description
  28     Matrix wrapper class containing ldu addressing, matrix, coupling interfaces
  29     coupling interface fields and coupling coefficients
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     amgMatrixI.H
  36     amgMatrix.C
  37     amgMatrixIO.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef amgMatrix_H
  42 #define amgMatrix_H
  43
  44 #include "lduPrimitiveMesh.H"
  45 #include "demandDrivenData.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                          Class amgMatrix Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class amgMatrix
  57 {
  58     // Private data
  59
  60         //- Matrix addressing object
  61         lduPrimitiveMesh* addrPtr_;
  62
  63         //- Coupling interfaces fields
  64         lduInterfacePtrsList* interfacesPtr_;
  65
  66          //- LDU matrix
  67         lduMatrix* matrixPtr_;
  68
  69         //- Coupling interface fields
  70         lduInterfaceFieldPtrsList* interfaceFieldsPtr_;
  71
  72         //- Coupling coefficients, upper
  73         FieldField<Field, scalar>* coupleBouCoeffsPtr_;
  74
  75         //- Coupling coefficients, lower
  76         FieldField<Field, scalar>* coupleIntCoeffsPtr_;
  77
  78
  79     // Private Member Functions
  80
  81         //- Disallow default bitwise copy construct
  82         amgMatrix(const amgMatrix&);
  83
  84         //- Disallow default bitwise assignment
  85         void operator=(const amgMatrix&);
  86
  87
  88 public:
  89
  90     // Static data members
  91
  92
  93     // Constructors
  94
  95         //- Construct from components
  96         amgMatrix
  97         (
  98             lduPrimitiveMesh* addrPtr,
  99             lduInterfacePtrsList* interfacesPtr,
 100             lduMatrix* matrixPtr,
 101             FieldField<Field, scalar>* coupleBouCoeffsPtr,
 102             FieldField<Field, scalar>* coupleIntCoeffsPtr,
 103             lduInterfaceFieldPtrsList* interfaceFieldsPtr
 104         )
 105         :
 106             addrPtr_(addrPtr),
 107             interfacesPtr_(interfacesPtr),
 108             matrixPtr_(matrixPtr),
 109             interfaceFieldsPtr_(interfaceFieldsPtr),
 110             coupleBouCoeffsPtr_(coupleBouCoeffsPtr),
 111             coupleIntCoeffsPtr_(coupleIntCoeffsPtr)
 112         {}
 113
 114
 115     // Destructor
 116
 117         ~amgMatrix()
 118         {
 119             deleteDemandDrivenData(addrPtr_);
 120
 121             // Clear the interface storage by hand.  It is a list of ptrs
 122             // not a PtrList for consistency of the interface
 123             if (interfacesPtr_)
 124             {
 125                 lduInterfacePtrsList& curLevel = *interfacesPtr_;
 126
 127                 forAll (curLevel, i)
 128                 {
 129                     if (curLevel.set(i))
 130                     {
 131                         delete curLevel(i);
 132                     }
 133                 }
 134             }
 135
 136             deleteDemandDrivenData(interfacesPtr_);
 137
 138             deleteDemandDrivenData(matrixPtr_);
 139
 140             // Clear the interface field storage by hand.  It is a list of ptrs
 141             // not a PtrList for consistency of the interface
 142             if (interfaceFieldsPtr_)
 143             {
 144                 lduInterfaceFieldPtrsList& curLevelField = *interfaceFieldsPtr_;
 145
 146                 forAll (curLevelField, i)
 147                 {
 148                     if (curLevelField.set(i))
 149                     {
 150                         delete curLevelField(i);
 151                     }
 152                 }
 153             }
 154
 155             deleteDemandDrivenData(interfaceFieldsPtr_);
 156             deleteDemandDrivenData(coupleBouCoeffsPtr_);
 157             deleteDemandDrivenData(coupleIntCoeffsPtr_);
 158         }
 159
 160
 161     // Member Functions
 162
 163         //- Return size
 164         label size() const
 165         {
 166             return addrPtr_->size();
 167         }
 168
 169         //- Return matrix
 170         const lduMatrix& matrix() const
 171         {
 172             return *matrixPtr_;
 173         }
 174
 175         //- Return coupling interfaces
 176         const lduInterfacePtrsList& interfaces() const
 177         {
 178             return *interfacesPtr_;
 179         }
 180
 181         //- Return coupling interfaceFields
 182         const lduInterfaceFieldPtrsList& interfaceFields() const
 183         {
 184             return *interfaceFieldsPtr_;
 185         }
 186
 187         //- Return boundary coefficients
 188         const FieldField<Field, scalar>& coupleBouCoeffs() const
 189         {
 190             return *coupleBouCoeffsPtr_;
 191         }
 192
 193         //- Return internal coefficients
 194         const FieldField<Field, scalar>& coupleIntCoeffs() const
 195         {
 196             return *coupleIntCoeffsPtr_;
 197         }
 198 };
 199
 200
 201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 202
 203 } // End namespace Foam
 204
 205 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 206
 207 #endif
 208
 209 // ************************************************************************* //