weighted.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::weighted
26 
27 Description
28  Interpolation scheme class using weights looked-up from the objectRegistry.
29 
30 SourceFiles
31  weighted.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef weighted_H
36 #define weighted_H
37 
39 #include "volFields.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class weighted Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
51 class weighted
52 :
53  public surfaceInterpolationScheme<Type>
54 {
55  // Private member data
56 
57  const surfaceScalarField& weights_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("weighted");
64 
65 
66  // Constructors
67 
68  //- Construct from weights
70  :
72  weights_(weights)
73  {}
74 
75  //- Construct from Istream
76  weighted(const fvMesh& mesh, Istream& is)
77  :
79  weights_
80  (
81  this->mesh().objectRegistry::template
82  lookupObject<const surfaceScalarField>
83  (
84  word(is)
85  )
86  )
87  {}
88 
89  //- Construct from faceFlux and Istream
90  weighted
91  (
92  const fvMesh& mesh,
93  const surfaceScalarField&,
94  Istream& is
95  )
96  :
98  weights_
99  (
100  this->mesh().objectRegistry::template
101  lookupObject<const surfaceScalarField>
102  (
103  word(is)
104  )
105  )
106  {}
107 
108 
109  // Member Functions
110 
111  //- Return the interpolation weighting factors
113  (
114  const VolField<Type>&
115  ) const
116  {
117  return weights_;
118  }
119 
120 
121  // Member Operators
122 
123  //- Disallow default bitwise assignment
124  void operator=(const weighted&) = delete;
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace Foam
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************************************************************* //
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
Registry of regIOobjects.
Abstract base class for surface interpolation schemes.
const fvMesh & mesh() const
Return mesh reference.
A class for managing temporary objects.
Definition: tmp.H:55
Interpolation scheme class using weights looked-up from the objectRegistry.
Definition: weighted.H:53
void operator=(const weighted &)=delete
Disallow default bitwise assignment.
TypeName("weighted")
Runtime type information.
tmp< surfaceScalarField > weights(const VolField< Type > &) const
Return the interpolation weighting factors.
Definition: weighted.H:112
weighted(const surfaceScalarField &weights)
Construct from weights.
Definition: weighted.H:68
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.