src/dbns/numericFlux/numericFluxBase.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     numericFluxBase
  26
  27 Description
  28     Base numeric flux class for density-based solvers
  29
  30 Author
  31     Aleksandar Jemcov
  32     Rewrite by Hrvoje Jasak
  33
  34 SourceFiles
  35     numericFluxBase.H
  36     numericFluxBase.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef numericFluxBase_H
  41 #define numericFluxBase_H
  42
  43 #include "volFieldsFwd.H"
  44 #include "surfaceFieldsFwd.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                         Class numericFluxBase Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class Flux>
  56 class numericFluxBase
  57 :
  58     public Flux
  59 {
  60 public:
  61
  62     // Constructors
  63
  64         //- Construct null
  65         numericFluxBase()
  66         {}
  67
  68
  69     //- Destructor
  70     virtual ~numericFluxBase()
  71     {}
  72
  73
  74     // Memeber functions
  75
  76         // Return fluxes
  77
  78             //- Return continuity equation flux
  79             virtual const surfaceScalarField& rhoFlux() const = 0;
  80
  81             //- Return momentum equation flux
  82             virtual const surfaceVectorField& rhoUFlux() const = 0;
  83
  84             //- Return energy equation flux
  85             virtual const surfaceScalarField& rhoEFlux() const = 0;
  86
  87
  88         // Return residuals
  89
  90             //- Return mass residual
  91             virtual tmp<scalarField> rhoResidual() const = 0;
  92
  93             //- Return momentum residual
  94             virtual tmp<vectorField> rhoUResidual() const = 0;
  95
  96             //- Return energy residual
  97             virtual tmp<scalarField> rhoEResidual() const = 0;
  98
  99
 100         //- Update fluxes based on current state
 101         virtual void computeFlux() = 0;
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace Foam
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //