multivariateScheme.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-2016 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::multivariateScheme
26 
27 Description
28  Generic multi-variate discretisation scheme class which may be instantiated
29  for any of the NVD, CNVD or NVDV schemes.
30 
31 SourceFiles
32  multivariateScheme.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef multivariateScheme_H
37 #define multivariateScheme_H
38 
40 #include "surfaceFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class multivariateScheme Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class Type, class Scheme>
53 :
55  public Scheme::LimiterType
56 {
57  // Private data
58 
59  const surfaceScalarField& faceFlux_;
60  surfaceScalarField weights_;
61 
62 
63  // Private Member Functions
64 
65  //- Disallow default bitwise copy construct
67 
68  //- Disallow default bitwise assignment
69  void operator=(const multivariateScheme&);
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("multivariateScheme");
76 
77 
78  // Constructors
79 
80  //- Construct for field, faceFlux and Istream
82  (
83  const fvMesh& mesh,
86  const surfaceScalarField& faceFlux,
87  Istream& schemeData
88  );
89 
90 
91  // Member Operators
92 
93  //- surfaceInterpolationScheme sub-class returned by operator(field)
94  // which is used as the interpolation scheme for the field
95  class fieldScheme
96  :
99  {
100  // Private data
101 
102  const surfaceScalarField& weights_;
103 
104  public:
105 
106  // Constructors
107 
109  (
112  )
113  :
115  fieldScheme(field),
116  weights_(weights)
117  {}
118 
119 
120  // Member Functions
121 
122  //- Return the interpolation weighting factors
124  (
126  ) const
127  {
128  return weights_;
129  }
130  };
131 
133  (
135  ) const
136  {
138  (
139  new fieldScheme(field, weights_)
140  );
141  }
142 };
143 
144 
145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 
147 } // End namespace Foam
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 // Add the patch constructor functions to the hash tables
153 #define makeLimitedMultivariateSurfaceInterpolationScheme(SS, LIMITER) \
154 typedef multivariateScheme \
155 < \
156  scalar, \
157  LimitedScheme<scalar, LIMITER<NVDTVD>, limitFuncs::magSqr> \
158 > \
159  multivariateScheme##LIMITER##_; \
160  defineTemplateTypeNameAndDebugWithName \
161  ( \
162  multivariateScheme##LIMITER##_, \
163  #SS, \
164  0 \
165  ); \
166  \
167 multivariateSurfaceInterpolationScheme<scalar>::addIstreamConstructorToTable \
168 < \
169  multivariateScheme \
170  < \
171  scalar, \
172  LimitedScheme<scalar, LIMITER<NVDTVD>, limitFuncs::magSqr> \
173  > \
174 > \
175  addMultivariate##SS##ConstructorToTable_;
176 
178 #define makeLLimitedMultivariateSurfaceInterpolationScheme\
179 ( \
180  SS, \
181  LLIMITER, \
182  LIMITER, \
183  NVDTVD, \
184  LIMFUNC \
185 ) \
186 typedef multivariateScheme \
187 < \
188  scalar, \
189  LimitedScheme<scalar, LLIMITER<LIMITER<NVDTVD>>, limitFuncs::LIMFUNC> \
190 > \
191  multivariateScheme##LLIMITER##LIMITER##NVDTVD##LIMFUNC##_; \
192  defineTemplateTypeNameAndDebugWithName \
193  ( \
194  multivariateScheme##LLIMITER##LIMITER##NVDTVD##LIMFUNC##_, \
195  #SS, \
196  0 \
197  ); \
198  \
199 multivariateSurfaceInterpolationScheme<scalar>::addIstreamConstructorToTable \
200 < \
201  multivariateScheme \
202  < \
203  scalar, \
204  LimitedScheme<scalar, LLIMITER<LIMITER<NVDTVD>>, limitFuncs::LIMFUNC> \
205  > \
206 > \
207  addMultivariate##SS##ConstructorToTable_;
208 
209 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
210 
211 #ifdef NoRepository
212  #include "multivariateScheme.C"
213 #endif
214 
215 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
216 
217 #endif
218 
219 // ************************************************************************* //
Foam::surfaceFields.
surfaceInterpolationScheme sub-class returned by operator(field)
Generic multi-variate discretisation scheme class which may be instantiated for any of the NVD...
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
const fieldTable & fields() const
Return fields to be interpolated.
tmp< surfaceScalarField > weights(const GeometricField< Type, fvPatchField, volMesh > &) const
Return the interpolation weighting factors.
TypeName("multivariateScheme")
Runtime type information.
fieldScheme(const GeometricField< Type, fvPatchField, volMesh > &field, const surfaceScalarField &weights)
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Abstract base class for multi-variate surface interpolation schemes.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.