interpolationCellPoint.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) 2011-2022 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::interpolationCellPoint
26 
27 Description
28  Given cell centre values and point (vertex) values decompose into
29  tetrahedra and linear interpolate within them.
30 
31 \*---------------------------------------------------------------------------*/
32 
33 #ifndef interpolationCellPoint_H
34 #define interpolationCellPoint_H
35 
37 #include "cellPointWeight.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class interpolationCellPoint Declaration
46 \*---------------------------------------------------------------------------*/
47 
48 template<class Type>
50 :
51  public fieldInterpolation<Type, interpolationCellPoint<Type>>,
53 {
54 public:
55 
56  //- Runtime type information
57  TypeName("cellPoint");
58 
59 
60  // Constructors
61 
62  //- Construct from components
64  (
65  const VolField<Type>& psi
66  );
67 
68  //- Copy construct
70  (
72  );
73 
74  //- Construct from components
76  (
77  const VolField<Type>& psi,
79  );
80 
81  //- Clone
82  virtual autoPtr<interpolation<Type>> clone() const
83  {
85  (
87  );
88  }
89 
90 
91  // Member Functions
92 
93  //- Inherit interpolate from interpolation
95 
96  //- Interpolate field for the given cellPointWeight
97  inline Type interpolate(const cellPointWeight& cpw) const;
98 
99  //- Interpolate field to the given point in the given cell
100  inline Type interpolate
101  (
102  const vector& position,
103  const label celli,
104  const label facei = -1
105  ) const;
106 
107  //- Interpolate field to the given coordinates in the tetrahedron
108  // defined by the given indices.
109  inline Type interpolate
110  (
111  const barycentric& coordinates,
112  const tetIndices& tetIs,
113  const label facei = -1
114  ) const;
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #include "interpolationCellPointI.H"
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 #ifdef NoRepository
129  #include "interpolationCellPoint.C"
130 #endif
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************************************************************* //
Generic GeometricField class.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
Foam::cellPointWeight.
Given cell centre values and point (vertex) values decompose into tetrahedra and linear interpolate w...
Type interpolate(const cellPointWeight &cpw) const
Interpolate field for the given cellPointWeight.
interpolationCellPoint(const VolField< Type > &psi)
Construct from components.
virtual autoPtr< interpolation< Type > > clone() const
Clone.
TypeName("cellPoint")
Runtime type information.
Base class for interpolations that require a vol-point interpolated field.
const PointField< Type > & psip() const
Access the point field.
Abstract base class for interpolation.
Definition: interpolation.H:55
const VolField< Type > & psi() const
Return the field to be interpolated.
Storage and named access for the indices of a tet which is part of the decomposition of a cell.
Definition: tetIndices.H:82
A class for managing temporary objects.
Definition: tmp.H:55
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