src/finiteVolume/interpolation/surfaceInterpolation/schemes/linear/linear.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::linear
  27
  28 Description
  29     Central-differencing interpolation scheme class
  30
  31 SourceFiles
  32     linear.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef linear_H
  37 #define linear_H
  38
  39 #include "surfaceInterpolationScheme.H"
  40 #include "volFields.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class linear Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class Type>
  52 class linear
  53 :
  54     public surfaceInterpolationScheme<Type>
  55 {
  56     // Private Member Functions
  57
  58         //- Disallow default bitwise assignment
  59         void operator=(const linear&);
  60
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("linear");
  66
  67
  68     // Constructors
  69
  70         //- Construct from mesh
  71         linear(const fvMesh& mesh)
  72         :
  73             surfaceInterpolationScheme<Type>(mesh)
  74         {}
  75
  76         //- Construct from Istream
  77         linear(const fvMesh& mesh, Istream&)
  78         :
  79             surfaceInterpolationScheme<Type>(mesh)
  80         {}
  81
  82         //- Construct from faceFlux and Istream
  83         linear
  84         (
  85             const fvMesh& mesh,
  86             const surfaceScalarField&,
  87             Istream&
  88         )
  89         :
  90             surfaceInterpolationScheme<Type>(mesh)
  91         {}
  92
  93
  94     // Member Functions
  95
  96         //- Return the interpolation weighting factors
  97         tmp<surfaceScalarField> weights
  98         (
  99             const GeometricField<Type, fvPatchField, volMesh>&
 100         ) const
 101         {
 102             return this->mesh().surfaceInterpolation::weights();
 103         }
 104 };
 105
 106
 107 template<class Type>
 108 tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 109 linearInterpolate(const GeometricField<Type, fvPatchField, volMesh>& vf)
 110 {
 111     return surfaceInterpolationScheme<Type>::interpolate
 112     (
 113         vf,
 114         vf.mesh().surfaceInterpolation::weights()
 115     );
 116 }
 117
 118
 119 template<class Type>
 120 tmp<GeometricField<Type, fvsPatchField, surfaceMesh> >
 121 linearInterpolate(const tmp<GeometricField<Type, fvPatchField, volMesh> >& tvf)
 122 {
 123     tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > tinterp =
 124         linearInterpolate(tvf());
 125     tvf.clear();
 126     return tinterp;
 127 }
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace Foam
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #endif
 137
 138 // ************************************************************************* //