initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / finiteVolume / interpolation / interpolation / interpolationCellPoint / interpolationCellPoint.H
blobbbe76871ba730bcf70c86c057c5394a3644dd773
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 Class
26     Foam::interpolationCellPoint
28 Description
29     Foam::interpolationCellPoint
31 \*---------------------------------------------------------------------------*/
33 #ifndef interpolationCellPoint_H
34 #define interpolationCellPoint_H
36 #include "interpolation.H"
37 #include "cellPointWeight.H"
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 namespace Foam
44 /*---------------------------------------------------------------------------*\
45                    Class interpolationCellPoint Declaration
46 \*---------------------------------------------------------------------------*/
48 template<class Type>
49 class interpolationCellPoint
51     public interpolation<Type>
53 protected:
55     // Protected data
57         //- Interpolated volfield
58         const GeometricField<Type, pointPatchField, pointMesh> psip_;
61 public:
63     //- Runtime type information
64     TypeName("cellPoint");
67     // Constructors
69         //- Construct from components
70         interpolationCellPoint
71         (
72             const GeometricField<Type, fvPatchField, volMesh>& psi
73         );
76     // Member Functions
78         //- Interpolate field for the given cellPointWeight
79         inline Type interpolate(const cellPointWeight& cpw) const;
81         //- Interpolate field to the given point in the given cell
82         inline Type interpolate
83         (
84             const vector& position,
85             const label nCell,
86             const label facei = -1
87         ) const;
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 } // End namespace Foam
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 #include "interpolationCellPointI.H"
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 #ifdef NoRepository
102 #   include "interpolationCellPoint.C"
103 #endif
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 #endif
109 // ************************************************************************* //