linear.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::linear
26 
27 Description
28  Centred interpolation interpolation scheme class
29 
30 SourceFiles
31  linear.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef linear_H
36 #define linear_H
37 
39 #include "volFields.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class linear Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
51 class linear
52 :
53  public surfaceInterpolationScheme<Type>
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName("linear");
60 
61 
62  // Constructors
63 
64  //- Construct from mesh
65  linear(const fvMesh& mesh)
66  :
68  {}
69 
70  //- Construct from Istream
71  linear(const fvMesh& mesh, Istream&)
72  :
74  {}
75 
76  //- Construct from faceFlux and Istream
77  linear
78  (
79  const fvMesh& mesh,
80  const surfaceScalarField&,
81  Istream&
82  )
83  :
85  {}
86 
87 
88  // Member Functions
89 
90  //- Return the interpolation weighting factors
92  (
93  const VolField<Type>&
94  ) const
95  {
96  return this->mesh().surfaceInterpolation::weights();
97  }
98 
99 
100  // Member Operators
101 
102  //- Disallow default bitwise assignment
103  void operator=(const linear&) = delete;
104 };
105 
106 
107 template<class Type>
110 {
112  (
113  vf,
114  vf.mesh().surfaceInterpolation::weights()
115  );
116 }
117 
118 
119 template<class Type>
122 {
123  tmp<SurfaceField<Type>> tinterp =
124  linearInterpolate(tvf());
125  tvf.clear();
126  return tinterp;
127 }
128 
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace Foam
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************************************************************* //
const Mesh & mesh() const
Return mesh.
Generic GeometricField class.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Centred interpolation interpolation scheme class.
Definition: linear.H:53
void operator=(const linear &)=delete
Disallow default bitwise assignment.
tmp< surfaceScalarField > weights(const VolField< Type > &) const
Return the interpolation weighting factors.
Definition: linear.H:91
linear(const fvMesh &mesh)
Construct from mesh.
Definition: linear.H:64
TypeName("linear")
Runtime type information.
Abstract base class for surface interpolation schemes.
const fvMesh & mesh() const
Return mesh reference.
static tmp< SurfaceField< Type > > interpolate(const VolField< Type > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
Return the face-interpolate of the given cell field.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
tmp< SurfaceField< Type > > linearInterpolate(const VolField< Type > &vf)
Definition: linear.H:108