src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/upwind/upwind.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::upwind
  27
  28 Description
  29     Upwind differencing scheme class.
  30
  31 SourceFiles
  32     upwind.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef upwind_H
  37 #define upwind_H
  38
  39 #include "limitedSurfaceInterpolationScheme.H"
  40 #include "volFields.H"
  41 #include "surfaceFields.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class upwind Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 template<class Type>
  53 class upwind
  54 :
  55     public limitedSurfaceInterpolationScheme<Type>
  56 {
  57     // Private Member Functions
  58
  59         //- Disallow default bitwise assignment
  60         void operator=(const upwind&);
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("upwind");
  67
  68
  69     // Constructors
  70
  71         //- Construct from faceFlux
  72         upwind
  73         (
  74             const fvMesh& mesh,
  75             const surfaceScalarField& faceFlux
  76         )
  77         :
  78             limitedSurfaceInterpolationScheme<Type>(mesh, faceFlux)
  79         {}
  80
  81         //- Construct from Istream.
  82         //  The name of the flux field is read from the Istream and looked-up
  83         //  from the mesh objectRegistry
  84         upwind
  85         (
  86             const fvMesh& mesh,
  87             Istream& is
  88         )
  89         :
  90             limitedSurfaceInterpolationScheme<Type>(mesh, is)
  91         {}
  92
  93         //- Construct from faceFlux and Istream
  94         upwind
  95         (
  96             const fvMesh& mesh,
  97             const surfaceScalarField& faceFlux,
  98             Istream&
  99         )
 100         :
 101             limitedSurfaceInterpolationScheme<Type>(mesh, faceFlux)
 102         {}
 103
 104
 105     // Member Functions
 106
 107         //- Return the interpolation limiter
 108         virtual tmp<surfaceScalarField> limiter
 109         (
 110             const GeometricField<Type, fvPatchField, volMesh>&
 111         ) const
 112         {
 113             return tmp<surfaceScalarField>
 114             (
 115                 new surfaceScalarField
 116                 (
 117                     IOobject
 118                     (
 119                         "upwindLimiter",
 120                         this->mesh().time().timeName(),
 121                         this->mesh()
 122                     ),
 123                     this->mesh(),
 124                     dimensionedScalar("upwindLimiter", dimless, 0.0)
 125                 )
 126             );
 127         }
 128
 129         //- Return the interpolation weighting factors
 130         tmp<surfaceScalarField> weights() const
 131         {
 132             return pos(this->faceFlux_);
 133         }
 134
 135         //- Return the interpolation weighting factors
 136         virtual tmp<surfaceScalarField> weights
 137         (
 138             const GeometricField<Type, fvPatchField, volMesh>&
 139         ) const
 140         {
 141             return weights();
 142         }
 143 };
 144
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 } // End namespace Foam
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 #endif
 153
 154 // ************************************************************************* //