stepInterpolationWeights.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) 2023 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::stepInterpolationWeights
26 
27 Description
28  Generates the weight for step-wise interpolation and integration
29 
30  The step transitions are at the end of each interval.
31 
32 SourceFiles
33  stepInterpolationWeights.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef stepInterpolationWeights_H
38 #define stepInterpolationWeights_H
39 
40 #include "interpolationWeights.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class stepInterpolationWeights Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
54 {
55  // Private Data
56 
57  //- Cached index in samples from previous invocation
58  mutable label index_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("step");
65 
66 
67  // Constructors
68 
69  //- Construct from components
71  (
72  const scalarField& samples
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  scalar t1,
97  scalar t2,
98  labelList& indices,
99  scalarField& weights
100  ) const;
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
Abstract base class for interpolating in 1D.
Generates the weight for step-wise interpolation and integration.
stepInterpolationWeights(const scalarField &samples)
Construct from components.
virtual bool integrationWeights(scalar t1, scalar t2, labelList &indices, scalarField &weights) const
Calculate weights and indices to calculate integrand of t1..t2.
TypeName("step")
Runtime type information.
virtual ~stepInterpolationWeights()
Destructor.
virtual bool valueWeights(const scalar t, labelList &indices, scalarField &weights) const
Calculate weights and indices to calculate t from samples.
Namespace for OpenFOAM.
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
scalarField samples(nIntervals, 0)