src/foam/interpolations/interpolatePointToCell/interpolatePointToCell.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Global
  25     interpolatePointToCell
  26
  27 Description
  28     Interpolates (averages) the vertex values to the cell centre.
  29
  30 SourceFiles
  31     interpolatePointToCell.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef interpolatePointToCell_H
  36 #define interpolatePointToCell_H
  37
  38 #include "GeometricField.H"
  39 #include "pointMesh.H"
  40
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 // Interpolate field to cell centre
  50 template<class Type>
  51 Type interpolatePointToCell
  52 (
  53     const GeometricField<Type, pointPatchField, pointMesh>& ptf,
  54     const label celli
  55 );
  56
  57
  58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  59
  60 } // End namespace Foam
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 #ifdef NoRepository
  65 #   include "interpolatePointToCell.C"
  66 #endif
  67
  68 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  69
  70 #endif
  71
  72 // ************************************************************************* //