FreeFOAM The Cross-Platform CFD Toolkit
weighted.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) 1991-2010 OpenCFD Ltd.
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 <finiteVolume/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  // Private Member Functions
61 
62  //- Disallow default bitwise assignment
63  void operator=(const weighted&);
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("weighted");
70 
71 
72  // Constructors
73 
74  //- Construct from weights
76  :
77  surfaceInterpolationScheme<Type>(weights.mesh()),
78  weights_(weights)
79  {}
80 
81  //- Construct from Istream
82  weighted(const fvMesh& mesh, Istream& is)
83  :
84  surfaceInterpolationScheme<Type>(mesh),
85  weights_
86  (
87  this->mesh().objectRegistry::
88  lookupObject<const surfaceScalarField>(word(is))
89  )
90  {}
91 
92  //- Construct from faceFlux and Istream
93  weighted
94  (
95  const fvMesh& mesh,
96  const surfaceScalarField&,
97  Istream& is
98  )
99  :
101  weights_
102  (
103  this->mesh().objectRegistry:: lookupObject<const surfaceScalarField>
104  (
105  word(is)
106  )
107  )
108  {}
109 
110 
111  // Member Functions
112 
113  //- Return the interpolation weighting factors
115  (
117  ) const
118  {
119  return weights_;
120  }
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************ vim: set sw=4 sts=4 et: ************************ //
133