src/dbns/numericFlux/FASNumericFlux.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     FASNumericFlux
  26
  27 Description
  28     Full Approximation Storage Multigrid numeric flux
  29
  30 Author
  31     Aleksandar Jemcov
  32     Rewrite by Hrvoje Jasak
  33
  34 SourceFiles
  35     FASNumericFlux.H
  36     FASNumericFlux.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef FASNumericFlux_H
  41 #define FASNumericFlux_H
  42
  43 #include "numericFluxBase.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                          Class FASNumericFlux Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class Flux>
  55 class FASNumericFlux
  56 :
  57     public numericFluxBase<Flux>
  58 {
  59     // Private data
  60
  61         //- Reference to meshLevel
  62         const mgMeshLevel& meshLevel_;
  63
  64         //- Reference to fieldLevel
  65         const mgFieldLevel& fieldLevel_;
  66
  67         // Primitive fields
  68
  69             //- Static pressure
  70             const scalarField p_;
  71
  72             //- Velocity
  73             const vectorField U_;
  74
  75             //- static Temperature
  76             const scalarField T_;
  77
  78
  79         // References to fine fluxes
  80
  81             //- Density flux
  82             surfaceScalarField& fineRhoFlux_;
  83
  84             //- momentum flux
  85             surfaceVectorField& fineRhoUFlux_;
  86
  87             //- Energy flux
  88             surfaceScalarField& fineRhoEFlux_;
  89
  90
  91         // Coarse fluxes
  92
  93             //- Density flux
  94             scalarField rhoFlux_;
  95
  96             //- Momentum flux
  97             vectorField rhoUFlux_;
  98
  99             //- Energy flux
 100             scalarField rhoEFlux_;
 101
 102
 103     // Private Member Functions
 104
 105         //- Disallow default bitwise copy construct
 106         FASNumericFlux(const FASNumericFlux&);
 107
 108         //- Disallow default bitwise assignment
 109         void operator=(const FASNumericFlux&);
 110
 111
 112 public:
 113
 114     // Constructors
 115
 116         //- Construct from components
 117         FASNumericFlux
 118         (
 119             const mgMeshLevel& meshLevel,
 120             const mgFieldLevel& fieldLevel
 121         );
 122
 123     // Destructor
 124
 125        virtual ~FASNumericFlux() {}
 126
 127
 128     // Member Functions
 129
 130         //- Return reference to the mesh
 131         const fvMesh& mesh() const
 132         {
 133             return meshLevel_.mesh();
 134         }
 135
 136
 137         // Return fluxes
 138
 139             //- Return density equation flux
 140             virtual const surfaceScalarField& rhoFlux() const
 141             {
 142                 return fineRhoFlux_;
 143             }
 144
 145             //- Return momentum equation flux
 146             virtual const surfaceVectorField& rhoUFlux() const
 147             {
 148                 return fineRhoUFlux_;
 149             }
 150
 151             //- Return energy equation flux
 152             virtual const surfaceScalarField& rhoEFlux() const
 153             {
 154                 return fineRhoEFlux_;
 155             }
 156
 157
 158        // Return residuals
 159
 160             //- Return density residual
 161             virtual tmp<scalarField> rhoResidual() const;
 162
 163             //- Return momentum residual
 164             virtual tmp<vectorField> rhoUResidual() const;
 165
 166             //- Return energy residual
 167             virtual tmp<scalarField> rhoEResidual() const;
 168
 169
 170         //- Update fluxes based on current state
 171         virtual void computeFlux();
 172 };
 173
 174
 175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 176
 177 } // End namespace Foam
 178
 179 #ifdef NoRepository
 180 #   include "FASNumericFlux.C"
 181 #endif
 182
 183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 184
 185 #endif
 186
 187 // ************************************************************************* //