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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 InNamespace
27  Foam
28 
29 Description
30  Interpolates y values from one curve to another with a different x
31  distribution.
32 
33  Uses Catmull-Rom spline interpolation between points.
34 
35 SourceFiles
36  interpolateSplineXY.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef interpolateSplineXY_H
41 #define interpolateSplineXY_H
42 
43 #include "scalar.H"
44 #include "primitiveFieldsFwd.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 template<class Type>
54 Field<Type> interpolateSplineXY
55 (
56  const scalarField& xNew,
57  const scalarField& xOld,
58  const Field<Type>& yOld
59 );
60 
61 
62 template<class Type>
63 Type interpolateSplineXY
64 (
65  const scalar x,
66  const scalarField& xOld,
67  const Field<Type>& yOld
68 );
69 
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 } // End namespace Foam
74 
75 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
76 
77 #ifdef NoRepository
78  #include "interpolateSplineXY.C"
79 #endif
80 
81 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 
83 #endif
84 
85 // ************************************************************************* //
Foam::scalarField
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
Definition: primitiveFieldsFwd.H:52
primitiveFieldsFwd.H
Forward declarations of the specialisations of Field<T> for scalar, vector and tensor.
scalar.H
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
x
x
Definition: LISASMDCalcMethod2.H:52
interpolateSplineXY.C
Foam::interpolateSplineXY
Field< Type > interpolateSplineXY(const scalarField &xNew, const scalarField &xOld, const Field< Type > &yOld)