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