src/finiteVolume/interpolation/interpolation/interpolationCell/interpolationCell.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::interpolationCell
  27
  28 Description
  29     Foam::interpolationCell
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef interpolationCell_H
  34 #define interpolationCell_H
  35
  36 #include "interpolation.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 class fvMesh;
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class interpolationCell Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class Type>
  50 class interpolationCell
  51 :
  52     public interpolation<Type>
  53 {
  54
  55 public:
  56
  57     //- Runtime type information
  58     TypeName("cell");
  59
  60
  61     // Constructors
  62
  63         //- Construct from components
  64         interpolationCell
  65         (
  66             const GeometricField<Type, fvPatchField, volMesh>& psi
  67         );
  68
  69
  70     // Member Functions
  71
  72         //- Interpolate field to the given point in the given cell
  73         Type interpolate
  74         (
  75             const vector& position,
  76             const label nCell,
  77             const label facei = -1
  78         ) const;
  79 };
  80
  81
  82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  83
  84 } // End namespace Foam
  85
  86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  87
  88 #ifdef NoRepository
  89 #   include "interpolationCell.C"
  90 #endif
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 #endif
  95
  96 // ************************************************************************* //