src/coupledMatrix/coupledLduMatrix/coupledLduMatrix.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     coupledLduMatrix
  26
  27 Description
  28     Collection of lduMatrices solved together as a block system
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     coupledLduMatrix.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef coupledLduMatrix_H
  39 #define coupledLduMatrix_H
  40
  41 #include "lduMatrix.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                        Class coupledLduMatrix Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class coupledLduMatrix
  53 :
  54     public PtrList<lduMatrix>
  55 {
  56     // Private data
  57
  58     // Private Member Functions
  59
  60         //- Disallow default bitwise copy construct
  61         coupledLduMatrix(const coupledLduMatrix&);
  62
  63         //- Disallow default bitwise assignment
  64         void operator=(const coupledLduMatrix&);
  65
  66
  67 public:
  68
  69     // Static data members
  70
  71         // Declare name of the class and it's debug switch
  72         ClassName("coupledLduMatrix");
  73
  74
  75     // Constructors
  76
  77         //- Construct given size
  78         coupledLduMatrix(const label size);
  79
  80
  81     // Destructor
  82
  83         ~coupledLduMatrix();
  84
  85
  86     // Member Functions
  87
  88         // Matrix structure
  89
  90             //- Is the matrix diagonal-only?
  91             bool diagonal() const;
  92
  93             //- Is the matrix symmetric?
  94             bool symmetric() const;
  95
  96             //- Is the matrix asymmetric?
  97             bool asymmetric() const;
  98
  99
 100         // Matrix-vector multiplication
 101
 102             //- Matrix multiplication with updated coupled interfaces.
 103             void Amul
 104             (
 105                 FieldField<Field, scalar>& result,
 106                 const FieldField<Field, scalar>& x,
 107                 const PtrList<FieldField<Field, scalar> >& bouCoeffs,
 108                 const lduInterfaceFieldPtrsListList& interfaces,
 109                 const direction cmpt
 110             ) const;
 111
 112             //- Matrix transpose multiplication with updated coupled interfaces
 113             void Tmul
 114             (
 115                 FieldField<Field, scalar>& result,
 116                 const FieldField<Field, scalar>& x,
 117                 const PtrList<FieldField<Field, scalar> >& intCoeffs,
 118                 const lduInterfaceFieldPtrsListList& interfaces,
 119                 const direction cmpt
 120             ) const;
 121
 122
 123             //- Initialise the update of coupled interfaces
 124             //  for matrix operations
 125             void initMatrixInterfaces
 126             (
 127                 const PtrList<FieldField<Field, scalar> >& coupleCoeffs,
 128                 const lduInterfaceFieldPtrsListList& interfaces,
 129                 const FieldField<Field, scalar>& x,
 130                 FieldField<Field, scalar>& result,
 131                 const direction cmpt,
 132                 const bool switchToLhs = false
 133             ) const;
 134
 135             //- Update coupled interfaces for matrix operations
 136             void updateMatrixInterfaces
 137             (
 138                 const PtrList<FieldField<Field, scalar> >& coupleCoeffs,
 139                 const lduInterfaceFieldPtrsListList& interfaces,
 140                 const FieldField<Field, scalar>& x,
 141                 FieldField<Field, scalar>& result,
 142                 const direction cmpt,
 143                 const bool switchToLhs = false
 144             ) const;
 145
 146 };
 147
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 } // End namespace Foam
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 #endif
 156
 157 // ************************************************************************* //