interpolationCell.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-2017 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::interpolationCell
26 
27 Description
28  Uses the cell value for any point in the cell
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef interpolationCell_H
33 #define interpolationCell_H
34 
35 #include "interpolation.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 class fvMesh;
43 
44 /*---------------------------------------------------------------------------*\
45  Class interpolationCell Declaration
46 \*---------------------------------------------------------------------------*/
47 
48 template<class Type>
50 :
51  public interpolation<Type>
52 {
53 
54 public:
55 
56  //- Runtime type information
57  TypeName("cell");
58 
59 
60  // Constructors
61 
62  //- Construct from components
64  (
66  );
67 
68 
69  // Member Functions
70 
71  //- Interpolate field to the given point in the given cell
72  Type interpolate
73  (
74  const vector& position,
75  const label celli,
76  const label facei = -1
77  ) const;
78 
79  //- Interpolate field to the given coordinates in the tetrahedron
80  // defined by the given indices. This is an optimisation which skips
81  // calculating the position, as cell interpolation doesn't need it.
82  inline Type interpolate
83  (
84  const barycentric& coordinates,
85  const tetIndices& tetIs,
86  const label facei = -1
87  ) const
88  {
89  return interpolate(vector::zero, tetIs.cell(), facei);
90  }
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #ifdef NoRepository
101  #include "interpolationCell.C"
102 #endif
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
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
Type interpolate(const vector &position, const label celli, const label facei=-1) const
Interpolate field to the given point in the given cell.
Generic GeometricField class.
const GeometricField< Type, fvPatchField, volMesh > & psi() const
Return the field to be interpolated.
label cell() const
Return the cell.
Definition: tetIndicesI.H:28
interpolationCell(const GeometricField< Type, fvPatchField, volMesh > &psi)
Construct from components.
TypeName("cell")
Runtime type information.
Storage and named access for the indices of a tet which is part of the decomposition of a cell...
Definition: tetIndices.H:81
PtrList< coordinateSystem > coordinates(solidRegions.size())
Abstract base class for interpolation.
Namespace for OpenFOAM.
Uses the cell value for any point in the cell.