src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/linearUpwind/linearUpwind.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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     Foam::linearUpwind
  27
  28 Description
  29     linearUpwind interpolation scheme class derived from upwind and returns
  30     upwind weighting factors but also applies an explicit correction.
  31
  32 SourceFiles
  33     linearUpwind.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef linearUpwind_H
  38 #define linearUpwind_H
  39
  40 #include "upwind.H"
  41 #include "gaussGrad.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class linearUpwind Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 template<class Type>
  53 class linearUpwind
  54 :
  55     public upwind<Type>
  56 {
  57     // Private Data
  58
  59         tmp<fv::gradScheme<Type> > gradScheme_;
  60
  61
  62     // Private Member Functions
  63
  64         //- Disallow default bitwise copy construct
  65         linearUpwind(const linearUpwind&);
  66
  67         //- Disallow default bitwise assignment
  68         void operator=(const linearUpwind&);
  69
  70
  71 public:
  72
  73     //- Runtime type information
  74     TypeName("linearUpwind");
  75
  76
  77     // Constructors
  78
  79         //- Construct from faceFlux
  80         linearUpwind
  81         (
  82             const fvMesh& mesh,
  83             const surfaceScalarField& faceFlux
  84         )
  85         :
  86             upwind<Type>(mesh, faceFlux),
  87             gradScheme_
  88             (
  89                 new fv::gaussGrad<Type>(mesh)
  90             )
  91         {}
  92
  93         //- Construct from Istream.
  94         //  The name of the flux field is read from the Istream and looked-up
  95         //  from the mesh objectRegistry
  96         linearUpwind
  97         (
  98             const fvMesh& mesh,
  99             Istream& schemeData
 100         )
 101         :
 102             upwind<Type>(mesh, schemeData),
 103             gradScheme_
 104             (
 105                 fv::gradScheme<Type>::New
 106                 (
 107                     mesh,
 108                     schemeData
 109                 )
 110             )
 111         {}
 112
 113         //- Construct from faceFlux and Istream
 114         linearUpwind
 115         (
 116             const fvMesh& mesh,
 117             const surfaceScalarField& faceFlux,
 118             Istream& schemeData
 119         )
 120         :
 121             upwind<Type>(mesh, faceFlux, schemeData),
 122             gradScheme_
 123             (
 124                 fv::gradScheme<Type>::New
 125                 (
 126                     mesh,
 127                     schemeData
 128                 )
 129             )
 130         {}
 131
 132
 133     // Member Functions
 134
 135         //- Return true if this scheme uses an explicit correction
 136         virtual bool corrected() const
 137         {
 138             return true;
 139         }
 140
 141         //- Return the explicit correction to the face-interpolate
 142         virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 143         correction
 144         (
 145             const GeometricField<Type, fvPatchField, volMesh>&
 146         ) const;
 147 };
 148
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 } // End namespace Foam
 153
 154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 155
 156 #endif
 157
 158 // ************************************************************************* //