interpolateSplineXY.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 InNamespace
25  Foam
26 
27 Description
28  Interpolates y values from one curve to another with a different x
29  distribution.
30 
31  Uses Catmull-Rom spline interpolation between points.
32 
33 SourceFiles
34  interpolateSplineXY.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef interpolateSplineXY_H
39 #define interpolateSplineXY_H
40 
41 #include "scalar.H"
42 #include "primitiveFieldsFwd.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 template<class Type>
52 Field<Type> interpolateSplineXY
53 (
54  const scalarField& xNew,
55  const scalarField& xOld,
56  const Field<Type>& yOld
57 );
58 
59 
60 template<class Type>
62 (
63  const scalar x,
64  const scalarField& xOld,
65  const Field<Type>& yOld
66 );
67 
68 
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
70 
71 } // End namespace Foam
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 #ifdef NoRepository
76 # include "interpolateSplineXY.C"
77 #endif
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 #endif
82 
83 // ************************************************************************* //
Namespace for OpenFOAM.
Field< Type > interpolateSplineXY(const scalarField &xNew, const scalarField &xOld, const Field< Type > &yOld)
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.