All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ddtScheme.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-2020 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::fv::ddtScheme
26 
27 Description
28  Abstract base class for ddt schemes.
29 
30 SourceFiles
31  ddtScheme.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef ddtScheme_H
36 #define ddtScheme_H
37 
38 #include "tmp.H"
39 #include "dimensionedType.H"
40 #include "volFieldsFwd.H"
41 #include "surfaceFieldsFwd.H"
42 #include "typeInfo.H"
43 #include "runTimeSelectionTables.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 template<class Type>
51 class fvMatrix;
52 
53 class fvMesh;
54 
55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
56 
57 namespace fv
58 {
59 
60 /*---------------------------------------------------------------------------*\
61  Class ddtScheme Declaration
62 \*---------------------------------------------------------------------------*/
63 
64 template<class Type>
65 class ddtScheme
66 :
67  public tmp<ddtScheme<Type>>::refCount
68 {
69 
70 protected:
71 
72  // Protected data
73 
74  const fvMesh& mesh_;
75 
76 
77 public:
78 
79  //- Runtime type information
80  virtual const word& type() const = 0;
81 
82 
83  // Declare run-time constructor selection tables
84 
86  (
87  tmp,
88  ddtScheme,
89  Istream,
90  (const fvMesh& mesh, Istream& schemeData),
91  (mesh, schemeData)
92  );
93 
94 
95  // Constructors
96 
97  //- Construct from mesh
98  ddtScheme(const fvMesh& mesh)
99  :
100  mesh_(mesh)
101  {}
102 
103  //- Construct from mesh and Istream
104  ddtScheme(const fvMesh& mesh, Istream&)
105  :
106  mesh_(mesh)
107  {}
108 
109  //- Disallow default bitwise copy construction
110  ddtScheme(const ddtScheme&);
111 
112 
113  // Selectors
114 
115  //- Return a pointer to a new ddtScheme created on freestore
116  static tmp<ddtScheme<Type>> New
117  (
118  const fvMesh& mesh,
119  Istream& schemeData
120  );
121 
122 
123  //- Destructor
124  virtual ~ddtScheme();
125 
126 
127  // Member Functions
128 
129  //- Return mesh reference
130  const fvMesh& mesh() const
131  {
132  return mesh_;
133  }
134 
136  (
137  const dimensioned<Type>&
138  ) = 0;
139 
141  (
143  ) = 0;
144 
146  (
147  const dimensionedScalar&,
149  ) = 0;
150 
152  (
153  const volScalarField&,
155  ) = 0;
156 
158  (
159  const volScalarField& alpha,
160  const volScalarField& rho,
162  ) = 0;
163 
165  (
167  );
168 
169  virtual tmp<fvMatrix<Type>> fvmDdt
170  (
172  ) = 0;
173 
174  virtual tmp<fvMatrix<Type>> fvmDdt
175  (
176  const dimensionedScalar&,
178  ) = 0;
179 
180  virtual tmp<fvMatrix<Type>> fvmDdt
181  (
182  const volScalarField&,
184  ) = 0;
185 
186  virtual tmp<fvMatrix<Type>> fvmDdt
187  (
188  const volScalarField& alpha,
189  const volScalarField& rho,
191  ) = 0;
192 
193  typedef GeometricField
194  <
195  typename flux<Type>::type,
198  > fluxFieldType;
199 
201  (
203  const fluxFieldType& phi,
204  const fluxFieldType& phiCorr
205  );
206 
208  (
210  const fluxFieldType& phi,
211  const fluxFieldType& phiCorr,
212  const volScalarField& rho
213  );
214 
216  (
218  const fluxFieldType& phi
219  );
220 
222  (
224  const fluxFieldType& phi,
225  const volScalarField& rho
226  );
227 
229  (
232  ) = 0;
233 
235  (
237  const fluxFieldType& phi
238  ) = 0;
239 
241  (
242  const volScalarField& rho,
245  ) = 0;
246 
248  (
249  const volScalarField& rho,
251  const fluxFieldType& phi
252  ) = 0;
253 
255  (
257  ) = 0;
258 
259 
260  // Member Operators
261 
262  //- Disallow default bitwise assignment
263  void operator=(const ddtScheme&) = delete;
264 };
265 
266 
267 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
268 
269 } // End namespace fv
270 
271 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
272 
273 } // End namespace Foam
274 
275 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
276 
277 // Add the patch constructor functions to the hash tables
279 #define makeFvDdtTypeScheme(SS, Type) \
280  defineNamedTemplateTypeNameAndDebug(Foam::fv::SS<Foam::Type>, 0); \
281  \
282  namespace Foam \
283  { \
284  namespace fv \
285  { \
286  ddtScheme<Type>::addIstreamConstructorToTable<SS<Type>> \
287  add##SS##Type##IstreamConstructorToTable_; \
288  } \
289  }
291 #define makeFvDdtScheme(SS) \
292  \
293 makeFvDdtTypeScheme(SS, scalar) \
294 makeFvDdtTypeScheme(SS, vector) \
295 makeFvDdtTypeScheme(SS, sphericalTensor) \
296 makeFvDdtTypeScheme(SS, symmTensor) \
297 makeFvDdtTypeScheme(SS, tensor) \
298  \
299 namespace Foam \
300 { \
301 namespace fv \
302 { \
303  \
304 template<> \
305 tmp<surfaceScalarField> SS<scalar>::fvcDdtUfCorr \
306 ( \
307  const volScalarField& U, \
308  const surfaceScalarField& Uf \
309 ) \
310 { \
311  NotImplemented; \
312  return surfaceScalarField::null(); \
313 } \
314  \
315 template<> \
316 tmp<surfaceScalarField> SS<scalar>::fvcDdtPhiCorr \
317 ( \
318  const volScalarField& U, \
319  const surfaceScalarField& phi \
320 ) \
321 { \
322  NotImplemented; \
323  return surfaceScalarField::null(); \
324 } \
325  \
326 template<> \
327 tmp<surfaceScalarField> SS<scalar>::fvcDdtUfCorr \
328 ( \
329  const volScalarField& rho, \
330  const volScalarField& U, \
331  const surfaceScalarField& Uf \
332 ) \
333 { \
334  NotImplemented; \
335  return surfaceScalarField::null(); \
336 } \
337  \
338 template<> \
339 tmp<surfaceScalarField> SS<scalar>::fvcDdtPhiCorr \
340 ( \
341  const volScalarField& rho, \
342  const volScalarField& U, \
343  const surfaceScalarField& phi \
344 ) \
345 { \
346  NotImplemented; \
347  return surfaceScalarField::null(); \
348 } \
349  \
350 } \
351 }
352 
353 
354 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
355 
356 #ifdef NoRepository
357  #include "ddtScheme.C"
358 #endif
359 
360 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
361 
362 #endif
363 
364 // ************************************************************************* //
virtual tmp< GeometricField< Type, fvPatchField, volMesh > > fvcDdt(const dimensioned< Type > &)=0
void operator=(const ddtScheme &)=delete
Disallow default bitwise assignment.
Mesh data needed to do the Finite Volume discretisation.
Definition: surfaceMesh.H:47
virtual tmp< fluxFieldType > fvcDdtUfCorr(const GeometricField< Type, fvPatchField, volMesh > &U, const GeometricField< Type, fvsPatchField, surfaceMesh > &Uf)=0
Reference counter for various OpenFOAM components.
Definition: refCount.H:49
virtual tmp< fvMatrix< Type > > fvmDdt(const GeometricField< Type, fvPatchField, volMesh > &)=0
ddtScheme(const fvMesh &mesh)
Construct from mesh.
Definition: ddtScheme.H:97
declareRunTimeSelectionTable(tmp, ddtScheme, Istream,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
GeometricField< typename flux< Type >::type, fvsPatchField, surfaceMesh > fluxFieldType
Definition: ddtScheme.H:197
volScalarField alpha(IOobject("alpha", runTime.timeName(), mesh, IOobject::READ_IF_PRESENT, IOobject::AUTO_WRITE), lambda *max(Ua &U, zeroSensitivity))
Generic GeometricField class.
Generic dimensioned Type class.
Abstract base class for ddt schemes.
Definition: ddtScheme.H:64
virtual tmp< fluxFieldType > fvcDdtPhiCorr(const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi)=0
const fvMesh & mesh() const
Return mesh reference.
Definition: ddtScheme.H:129
virtual ~ddtScheme()
Destructor.
Definition: ddtScheme.C:90
A class for handling words, derived from string.
Definition: word.H:59
labelList fv(nPoints)
phi
Definition: correctPhi.H:3
autoPtr< surfaceVectorField > Uf
virtual tmp< surfaceScalarField > meshPhi(const GeometricField< Type, fvPatchField, volMesh > &)=0
virtual const word & type() const =0
Runtime type information.
virtual tmp< surfaceScalarField > fvcDdtPhiCoeff(const GeometricField< Type, fvPatchField, volMesh > &U, const fluxFieldType &phi, const fluxFieldType &phiCorr)
Definition: ddtScheme.C:153
U
Definition: pEqn.H:72
static tmp< ddtScheme< Type > > New(const fvMesh &mesh, Istream &schemeData)
Return a pointer to a new ddtScheme created on freestore.
Definition: ddtScheme.C:46
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Macros to ease declaration of run-time selection tables.
A class for managing temporary objects.
Definition: PtrList.H:53
const fvMesh & mesh_
Definition: ddtScheme.H:73
typeOfRank< typename pTraits< vector >::cmptType, direction(pTraits< vector >::rank)+direction(pTraits< Type >::rank) - 2 >::type type
Definition: products.H:115
An abstract base class with a fat-interface to all derived classes covering all possible ways in whic...
Definition: fvsPatchField.H:65
Namespace for OpenFOAM.