linear.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 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  Central-differencing 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  // Private Member Functions
56 
57  //- Disallow default bitwise assignment
58  void operator=(const linear&);
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("linear");
65 
66 
67  // Constructors
68 
69  //- Construct from mesh
70  linear(const fvMesh& mesh)
71  :
72  surfaceInterpolationScheme<Type>(mesh)
73  {}
74 
75  //- Construct from Istream
76  linear(const fvMesh& mesh, Istream&)
77  :
78  surfaceInterpolationScheme<Type>(mesh)
79  {}
80 
81  //- Construct from faceFlux and Istream
83  (
84  const fvMesh& mesh,
85  const surfaceScalarField&,
86  Istream&
87  )
88  :
89  surfaceInterpolationScheme<Type>(mesh)
90  {}
91 
92 
93  // Member Functions
94 
95  //- Return the interpolation weighting factors
97  (
99  ) const
100  {
101  return this->mesh().surfaceInterpolation::weights();
102  }
103 };
104 
105 
106 template<class Type>
109 {
111  (
112  vf,
113  vf.mesh().surfaceInterpolation::weights()
114  );
115 }
116 
117 
118 template<class Type>
121 {
123  linearInterpolate(tvf());
124  tvf.clear();
125  return tinterp;
126 }
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Central-differencing interpolation scheme class.
Definition: linear.H:50
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
tmp< surfaceScalarField > weights(const GeometricField< Type, fvPatchField, volMesh > &) const
Return the interpolation weighting factors.
Definition: linear.H:96
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate(const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
Return the face-interpolate of the given cell field.
const Mesh & mesh() const
Return mesh.
Namespace for OpenFOAM.
TypeName("linear")
Runtime type information.
linear(const fvMesh &mesh)
Construct from mesh.
Definition: linear.H:69
Abstract base class for surface interpolation schemes.
const fvMesh & mesh() const
Return mesh reference.
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > linearInterpolate(const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: linear.H:107
A class for managing temporary objects.
Definition: PtrList.H:118