linearFitPolynomial.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 | Copyright (C) 2011-2015 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::linearFitPolynomial
26 
27 Description
28  Linear polynomial for interpolation fitting.
29 
30  Can be used with the CentredFit scheme to create a linear surface
31  interpolation scheme
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef linearFitPolynomial_H
36 #define linearFitPolynomial_H
37 
38 #include "vector.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class linearFitPolynomial Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 {
51 public:
52 
53  // Member functions
54 
55  static label nTerms(const direction dim)
56  {
57  return
58  (
59  dim == 1 ? 2 :
60  dim == 2 ? 3 :
61  dim == 3 ? 4 : 0
62  );
63  }
64 
65  static void addCoeffs
66  (
67  scalar* coeffs,
68  const vector& d,
69  const scalar weight,
70  const direction dim
71  )
72  {
73  label curIdx = 0;
74 
75  coeffs[curIdx++] = weight;
76  coeffs[curIdx++] = weight*d.x();
77 
78  if (dim >= 2)
79  {
80  coeffs[curIdx++] = weight*d.y();
81  }
82  if (dim == 3)
83  {
84  coeffs[curIdx++] = weight*d.z();
85  }
86  }
87 };
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace Foam
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 #endif
97 
98 // ************************************************************************* //
unsigned char direction
Definition: direction.H:43
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
static void addCoeffs(scalar *coeffs, const vector &d, const scalar weight, const direction dim)
Namespace for OpenFOAM.
const Cmpt & y() const
Definition: VectorI.H:71
const Cmpt & x() const
Definition: VectorI.H:65
const Cmpt & z() const
Definition: VectorI.H:77
Linear polynomial for interpolation fitting.
static label nTerms(const direction dim)