src/finiteVolume/blockLduSystem/BlockLduSystem.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     Foam::BlockLduSystem
  26
  27 Description
  28     BlockLduSystem is a wrapper for BlockLduMatrix with source field. This is
  29     the return type of implicit div and grad operators needed for implicitly
  30     coupled systems (namely p-U coupling).
  31
  32 Author
  33     Vuko Vukcevic, FMENA Zagreb.
  34
  35 SourceFiles
  36     BlockLduSystem.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef BlockLduSystem_H
  41 #define BlockLduSystem_H
  42
  43 #include "blockVectorNMatrices.H"
  44 #include "VectorNFieldTypes.H"
  45 #include "volVectorNFields.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 // Forward declaration of friend functions and operators
  53
  54 template<class blockType, class sourceType>
  55 class BlockLduSystem;
  56
  57 template<class blockType, class sourceType>
  58 Ostream& operator<<(Ostream&, const BlockLduSystem<blockType, sourceType>&);
  59
  60
  61 /*---------------------------------------------------------------------------*\
  62                         Class BlockLduSystem Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 template<class blockType, class sourceType>
  66 class BlockLduSystem
  67 :
  68     public BlockLduMatrix<blockType>
  69 {
  70     // Private data
  71
  72         //- Source term
  73         Field<sourceType> source_;
  74
  75
  76 public:
  77
  78     // Constructors
  79
  80         //- Construct given addressing
  81         explicit BlockLduSystem(const lduMesh&);
  82
  83         //- Construct given addressing and source field
  84         BlockLduSystem(const lduMesh&, const Field<sourceType>&);
  85
  86         //- Construct from components
  87         BlockLduSystem
  88         (
  89             const BlockLduMatrix<blockType>&,
  90             const Field<sourceType>&
  91         );
  92
  93         //- Construct as copy
  94         BlockLduSystem(const BlockLduSystem<blockType, sourceType>&);
  95
  96
  97     // Destructor
  98
  99        virtual ~BlockLduSystem()
 100        {}
 101
 102
 103     // Member functions
 104
 105         //- Access
 106
 107             Field<sourceType>& source()
 108             {
 109                 return source_;
 110             }
 111
 112             const Field<sourceType>& source() const
 113             {
 114                 return source_;
 115             }
 116
 117
 118     // Member operators
 119
 120         void operator=(const BlockLduSystem<blockType, sourceType>&);
 121
 122         void negate();
 123
 124         void operator+=(const BlockLduSystem<blockType, sourceType>&);
 125         void operator-=(const BlockLduSystem<blockType, sourceType>&);
 126
 127         void operator*=(const scalarField&);
 128         void operator*=(const scalar);
 129
 130
 131     // Ostream operator
 132
 133         friend Ostream& operator<< <blockType, sourceType>
 134         (
 135             Ostream&,
 136             const BlockLduSystem<blockType, sourceType>&
 137         );
 138 };
 139
 140
 141 } // End namespace Foam
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 #ifdef NoRepository
 146 #   include "BlockLduSystem.C"
 147 #   include "BlockLduSystemOperations.C"
 148 #endif
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 #endif
 153
 154 // ************************************************************************* //