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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2017 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::interpolationCell
28
29Description
30 Uses the cell value for any location within the cell
31
32\*---------------------------------------------------------------------------*/
33
34#ifndef Foam_interpolationCell_H
35#define Foam_interpolationCell_H
36
37#include "interpolation.H"
38
39// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40
41namespace Foam
42{
43
44class fvMesh;
45
46/*---------------------------------------------------------------------------*\
47 Class interpolationCell Declaration
48\*---------------------------------------------------------------------------*/
49
50template<class Type>
52:
53 public interpolation<Type>
54{
55public:
56
57 //- Runtime type information
58 TypeName("cell");
59
60
61 // Constructors
62
63 //- Construct from components
64 explicit interpolationCell
65 (
67 );
68
69
70 // Member Functions
71
72 //- Returns the cell value
73 inline Type interpolate
74 (
75 const vector& position, /* (unused) */
76 const label celli,
77 const label facei = -1 /* (unused) */
78 ) const
79 {
80 return this->psi_[celli];
81 }
82
83 //- Returns the cell value corresponding to the given tetrahedron
84 inline Type interpolate
85 (
86 const barycentric& coordinates, /* (unused) */
87 const tetIndices& tetIs,
88 const label facei = -1 /* (unused) */
89 ) const
90 {
91 return this->psi_[tetIs.cell()];
92 }
93};
94
95
96// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97
98} // End namespace Foam
99
100// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101
102#ifdef NoRepository
103 #include "interpolationCell.C"
104#endif
105
106// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107
108#endif
109
110// ************************************************************************* //
Generic GeometricField class.
Uses the cell value for any location within the cell.
Type interpolate(const barycentric &coordinates, const tetIndices &tetIs, const label facei=-1) const
Returns the cell value corresponding to the given tetrahedron.
TypeName("cell")
Runtime type information.
Type interpolate(const vector &position, const label celli, const label facei=-1) const
Returns the cell value.
Abstract base class for volume field interpolation.
Definition: interpolation.H:60
const GeometricField< Type, fvPatchField, volMesh > & psi_
Definition: interpolation.H:65
const GeometricField< Type, fvPatchField, volMesh > & psi() const noexcept
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:84
label cell() const noexcept
Return the cell index.
Definition: tetIndices.H:133
PtrList< coordinateSystem > coordinates(solidRegions.size())
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73