src/finiteVolume/interpolation/surfaceInterpolation/multivariateSchemes/upwind/multivariateUpwind.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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::multivariateUpwind
  27
  28 Description
  29     Upwind-difference form of the multivariate surfaceInterpolationScheme.
  30
  31 SourceFiles
  32     multivariateUpwindmake.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef multivariateUpwind_H
  37 #define multivariateUpwind_H
  38
  39 #include "multivariateSurfaceInterpolationScheme.H"
  40 #include "surfaceFields.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class multivariateUpwind Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class multivariateUpwind
  53 :
  54     public multivariateSurfaceInterpolationScheme<Type>
  55 {
  56     // Private data
  57
  58         const surfaceScalarField& faceFlux_;
  59
  60
  61     // Private Member Functions
  62
  63         //- Disallow default bitwise copy construct
  64         multivariateUpwind(const multivariateUpwind&);
  65
  66         //- Disallow default bitwise assignment
  67         void operator=(const multivariateUpwind&);
  68
  69
  70 public:
  71
  72     //- Runtime type information
  73     TypeName("upwind");
  74
  75
  76     // Constructors
  77
  78         //- Construct for field, faceFlux and Istream
  79         multivariateUpwind
  80         (
  81             const fvMesh& mesh,
  82             const typename multivariateSurfaceInterpolationScheme<Type>::
  83                 fieldTable& fields,
  84             const surfaceScalarField& faceFlux,
  85             Istream& schemeData
  86         )
  87         :
  88             multivariateSurfaceInterpolationScheme<Type>
  89             (
  90                 mesh,
  91                 fields,
  92                 faceFlux,
  93                 schemeData
  94             ),
  95             faceFlux_(faceFlux)
  96         {}
  97
  98
  99     // Member Operators
 100
 101         //- surfaceInterpolationScheme sub-class returned by operator(field)
 102         //  which is used as the interpolation scheme for the field
 103         class fieldScheme
 104         :
 105             public multivariateSurfaceInterpolationScheme<Type>::fieldScheme
 106         {
 107             // Private data
 108
 109                 const surfaceScalarField& faceFlux_;
 110
 111         public:
 112
 113             // Constructors
 114
 115                 fieldScheme
 116                 (
 117                     const GeometricField<Type, fvPatchField, volMesh>& field,
 118                     const surfaceScalarField& faceFlux
 119                 )
 120                 :
 121                     multivariateSurfaceInterpolationScheme<Type>::
 122                         fieldScheme(field),
 123                     faceFlux_(faceFlux)
 124                 {}
 125
 126
 127             // Member Functions
 128
 129                 //- Return the interpolation weighting factors
 130                 tmp<surfaceScalarField> weights
 131                 (
 132                     const GeometricField<Type, fvPatchField, volMesh>&
 133                 ) const
 134                 {
 135                     return pos(faceFlux_);
 136                 }
 137         };
 138
 139         tmp<surfaceInterpolationScheme<Type> > operator()
 140         (
 141             const GeometricField<Type, fvPatchField, volMesh>& field
 142         ) const
 143         {
 144             return tmp<surfaceInterpolationScheme<Type> >
 145             (
 146                 new fieldScheme(field, faceFlux_)
 147             );
 148         }
 149 };
 150
 151
 152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 153
 154 } // End namespace Foam
 155
 156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 157
 158 #endif
 159
 160 // ************************************************************************* //