DOC: API documentation fixes
[freefoam.git] / src / OpenFOAM / interpolations / interpolatePointToCell / interpolatePointToCell.H
blob398b42d30214fe682658d41bff1a6a8deb94ca94
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2010 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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your 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, see <http://www.gnu.org/licenses/>.
24 Global
25     interpolatePointToCell
27 Description
28     Interpolates (averages) the vertex values to the cell center.
30 SourceFiles
31     interpolatePointToCell.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef interpolatePointToCell_H
36 #define interpolatePointToCell_H
38 #include <OpenFOAM/GeometricField.H>
39 #include <OpenFOAM/pointMesh.H>
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 //- Interpolate field to cell center.
50 template<class Type>
51 Type interpolatePointToCell
53     const GeometricField<Type, pointPatchField, pointMesh>& ptf,
54     const label celli
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 } // End namespace Foam
62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64 #ifdef NoRepository
65 #   include <OpenFOAM/interpolatePointToCell.C>
66 #endif
68 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 #endif
72 // ************************ vim: set sw=4 sts=4 et: ************************ //