interpolationVolPointInterpolation.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) 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::interpolationVolPointInterpolation
26 
27 Description
28  Base class for interpolations that require a vol-point interpolated field
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef interpolationVolPointInterpolation_H
33 #define interpolationVolPointInterpolation_H
34 
35 #include "interpolation.H"
36 #include "cellPointWeight.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 /*---------------------------------------------------------------------------*\
44  Class interpolationVolPointInterpolation Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 template<class Type>
49 {
50 protected:
51 
52  // Protected data
53 
54  //- Interpolated volfield
55  const PointField<Type> psip_;
56 
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("interpolationVolPointInterpolation");
62 
63 
64 
65  // Constructors
66 
67  //- Construct from components
69  (
70  const VolField<Type>& psi
71  );
72 
73  //- Copy construct
75  (
77  );
78 
79  //- Construct from components
81  (
82  const VolField<Type>& psi,
84  );
85 
86 
87  // Destructor
89  {}
90 
91 
92  // Member Functions
93 
94  //- Access the point field
95  inline const PointField<Type>&
96  psip() const
97  {
98  return psip_;
99  }
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #ifdef NoRepository
111 #endif
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
Base class for interpolations that require a vol-point interpolated field.
TypeName("interpolationVolPointInterpolation")
Runtime type information.
interpolationVolPointInterpolation(const VolField< Type > &psi)
Construct from components.
const PointField< Type > psip_
Interpolated volfield.
const PointField< Type > & psip() const
Access the point field.
A class for managing temporary objects.
Definition: tmp.H:55
const volScalarField & psi
Namespace for OpenFOAM.