src/foam/interpolations/interpolateXY/interpolateXY.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  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 SourceFiles
  32     interpolateXY.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef interpolateXY_H
  37 #define interpolateXY_H
  38
  39 #include "scalar.H"
  40 #include "primitiveFieldsFwd.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 template<class Type>
  50 Field<Type> interpolateXY
  51 (
  52     const scalarField& xNew,
  53     const scalarField& xOld,
  54     const Field<Type>& yOld
  55 );
  56
  57
  58 template<class Type>
  59 Type interpolateXY
  60 (
  61     const scalar x,
  62     const scalarField& xOld,
  63     const Field<Type>& yOld
  64 );
  65
  66
  67 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  68
  69 } // End namespace Foam
  70
  71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  72
  73 #ifdef NoRepository
  74 #   include "interpolateXY.C"
  75 #endif
  76
  77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  78
  79 #endif
  80
  81 // ************************************************************************* //