initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / OpenFOAM / interpolations / interpolatePointToCell / interpolatePointToCell.H
blob6f5b51de606b0f550e646e593cbc70e6dd041c31
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.
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.
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.
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
25 Global
26     interpolatePointToCell
28 Description
29     Interpolates (averages) the vertex values to the cell center.
31 SourceFiles
32     interpolatePointToCell.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef interpolatePointToCell_H
37 #define interpolatePointToCell_H
39 #include "GeometricField.H"
40 #include "pointMesh.H"
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 // Interpolate field to cell center.
51 template<class Type>
52 Type interpolatePointToCell
54     const GeometricField<Type, pointPatchField, pointMesh>& ptf,
55     const label celli
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 } // End namespace Foam
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
65 #ifdef NoRepository
66 #   include "interpolatePointToCell.C"
67 #endif
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 #endif
73 // ************************************************************************* //