linearInterpolationWeights.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::linearInterpolationWeights
26 
27 Description
28 
29 SourceFiles
30  linearInterpolationWeights.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef linearInterpolationWeights_H
35 #define linearInterpolationWeights_H
36 
37 #include "interpolationWeights.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class linearInterpolationWeights Declaration
46 \*---------------------------------------------------------------------------*/
47 
49 :
51 {
52  // Private Data
53 
54  //- Cached index in samples from previous invocation
55  mutable label index_;
56 
57  // Private Member Functions
58 
59  //- Get weights of i and i+1 to calculate integration from t to
60  // samples_[i+1]
61  Pair<scalar> integrationWeights
62  (
63  const label i,
64  const scalar t
65  ) const;
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("linear");
71 
72  // Constructors
73 
74  //- Construct from components
76  (
77  const scalarField& samples
78  );
79 
80 
81  //- Destructor
83  {}
84 
85 
86  // Member Functions
87 
88  //- Calculate weights and indices to calculate t from samples.
89  // Returns true if indices changed.
90  virtual bool valueWeights
91  (
92  const scalar t,
93  labelList& indices,
94  scalarField& weights
95  ) const;
96 
97  //- Calculate weights and indices to calculate integrand of t1..t2
98  // from samples. Returns true if indices changed.
99  virtual bool integrationWeights
100  (
101  const scalar t1,
102  const scalar t2,
103  labelList& indices,
104  scalarField& weights
105  ) const;
106 };
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
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
Abstract base class for interpolating in 1D.
TypeName("linear")
Runtime type information.
scalarField samples(nIntervals, 0)
virtual bool valueWeights(const scalar t, labelList &indices, scalarField &weights) const
Calculate weights and indices to calculate t from samples.
An ordered pair of two objects of type <T> with first() and second() elements.
Definition: contiguous.H:49
linearInterpolationWeights(const scalarField &samples)
Construct from components.
Namespace for OpenFOAM.