splineInterpolationWeights.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2012-2019 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 Class
25  Foam::splineInterpolationWeights
26 
27 Description
28  Catmull-Rom spline interpolation.
29 
30 SourceFiles
31  splineInterpolationWeights.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef splineInterpolationWeights_H
36 #define splineInterpolationWeights_H
37 
38 #include "interpolationWeights.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class splineInterpolationWeights Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
52 {
53  // Private Data
54 
55  //- Cached index in samples from previous invocation
56  mutable label index_;
57 
58 
59 public:
60 
61  //- Runtime type information
62  TypeName("spline");
63 
64 
65  // Constructors
66 
67  //- Construct from components. By default make sure samples are
68  // equidistant.
70  (
71  const scalarField& samples,
72  const bool checkEqualDistance = true
73  );
74 
75 
76  //- Destructor
78  {}
79 
80 
81  // Member Functions
82 
83  //- Calculate weights and indices to calculate t from samples.
84  // Returns true if indices changed.
85  virtual bool valueWeights
86  (
87  const scalar t,
88  labelList& indices,
89  scalarField& weights
90  ) const;
91 
92  //- Calculate weights and indices to calculate integrand of t1..t2
93  // from samples. Returns true if indices changed.
94  virtual bool integrationWeights
95  (
96  const scalar t1,
97  const scalar t2,
98  labelList& indices,
99  scalarField& weights
100  ) const
101  {
103  return false;
104  }
105 
106 };
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
virtual bool integrationWeights(const scalar t1, const scalar t2, labelList &indices, scalarField &weights) const
Calculate weights and indices to calculate integrand of t1..t2.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
splineInterpolationWeights(const scalarField &samples, const bool checkEqualDistance=true)
Construct from components. By default make sure samples are.
Abstract base class for interpolating in 1D.
TypeName("spline")
Runtime type information.
scalarField samples(nIntervals, 0)
Catmull-Rom spline interpolation.
virtual bool valueWeights(const scalar t, labelList &indices, scalarField &weights) const
Calculate weights and indices to calculate t from samples.
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:366
Namespace for OpenFOAM.