fvcDdt.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 InNamespace
25  Foam::fvc
26 
27 Description
28  Calculate the first temporal derivative.
29 
30 SourceFiles
31  fvcDdt.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 
36 #ifndef fvcDdt_H
37 #define fvcDdt_H
38 
39 #include "volFieldsFwd.H"
40 #include "surfaceFieldsFwd.H"
41 #include "dimensionedTypes.H"
42 #include "one.H"
43 #include "geometricZeroField.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Namespace fvc functions Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 namespace fvc
55 {
56  template<class Type>
57  tmp<GeometricField<Type, fvPatchField, volMesh>> ddt
58  (
59  const dimensioned<Type>,
60  const fvMesh&
61  );
62 
63  template<class Type>
64  tmp<GeometricField<Type, fvPatchField, volMesh>> ddt
65  (
66  const GeometricField<Type, fvPatchField, volMesh>&
67  );
68 
69  template<class Type>
70  tmp<GeometricField<Type, fvPatchField, volMesh>> ddt
71  (
72  const dimensionedScalar&,
73  const GeometricField<Type, fvPatchField, volMesh>&
74  );
75 
76  template<class Type>
77  tmp<GeometricField<Type, fvPatchField, volMesh>> ddt
78  (
79  const volScalarField&,
80  const GeometricField<Type, fvPatchField, volMesh>&
81  );
82 
83  template<class Type>
84  tmp<GeometricField<Type, fvPatchField, volMesh>> ddt
85  (
86  const volScalarField&,
87  const volScalarField&,
88  const GeometricField<Type, fvPatchField, volMesh>&
89  );
90 
91  template<class Type>
92  tmp<GeometricField<Type, fvsPatchField, surfaceMesh>> ddt
93  (
94  const GeometricField<Type, fvsPatchField, surfaceMesh>&
95  );
96 
97  template<class Type>
98  tmp<GeometricField<Type, fvPatchField, volMesh>> ddt
99  (
100  const one&,
101  const GeometricField<Type, fvPatchField, volMesh>&
102  );
103 
104  template<class Type>
105  tmp<GeometricField<Type, fvPatchField, volMesh>> ddt
106  (
107  const GeometricField<Type, fvPatchField, volMesh>&,
108  const one&
109  );
110 
111  inline geometricZeroField ddt
112  (
113  const one&,
114  const one&
115  )
116  {
117  return geometricZeroField();
118  }
119 
120  template<class Type>
121  tmp
122  <
124  <
125  typename Foam::flux<Type>::type,
128  >
129  >
130  ddtCorr
131  (
134  );
135 
136  template<class Type>
137  tmp
138  <
140  <
141  typename Foam::flux<Type>::type,
142  fvsPatchField,
144  >
145  >
146  ddtCorr
147  (
149  const GeometricField
150  <
151  typename Foam::flux<Type>::type,
152  fvsPatchField,
154  >& phi
155  );
156 
157  template<class Type>
158  tmp
159  <
161  <
162  typename Foam::flux<Type>::type,
163  fvsPatchField,
165  >
166  >
167  ddtCorr
168  (
170  const GeometricField
171  <
172  typename Foam::flux<Type>::type,
173  fvsPatchField,
175  >& phi,
177  );
178 
179  template<class Type>
180  tmp
181  <
183  <
184  typename Foam::flux<Type>::type,
185  fvsPatchField,
187  >
188  >
189  ddtCorr
190  (
191  const volScalarField& rho,
194  );
195 
196  template<class Type>
197  tmp
198  <
200  <
201  typename Foam::flux<Type>::type,
202  fvsPatchField,
204  >
205  >
206  ddtCorr
207  (
208  const volScalarField& rho,
210  const GeometricField
211  <
212  typename Foam::flux<Type>::type,
213  fvsPatchField,
215  >& phi
216  );
217 
218  template<class Type>
219  tmp
220  <
222  <
223  typename Foam::flux<Type>::type,
224  fvsPatchField,
226  >
227  >
228  ddtCorr
229  (
230  const volScalarField& rho,
232  const GeometricField
233  <
234  typename Foam::flux<Type>::type,
235  fvsPatchField,
237  >& phi,
239  );
240 }
241 
242 
243 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
244 
245 } // End namespace Foam
246 
247 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
248 
249 #ifdef NoRepository
250  #include "fvcDdt.C"
251 #endif
252 
253 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
254 
255 #endif
256 
257 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: surfaceMesh.H:47
tmp< GeometricField< typename flux< Type >::type, fvsPatchField, surfaceMesh > > ddtCorr(const GeometricField< Type, fvPatchField, volMesh > &U, const GeometricField< Type, fvsPatchField, surfaceMesh > &Uf)
Definition: fvcDdt.C:170
Generic GeometricField class.
tmp< GeometricField< Type, fvPatchField, volMesh > > ddt(const dimensioned< Type > dt, const fvMesh &mesh)
Definition: fvcDdt.C:45
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:57
phi
Definition: correctPhi.H:3
autoPtr< surfaceVectorField > Uf
U
Definition: pEqn.H:72
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
A class representing the concept of a GeometricField of 1 used to avoid unnecessary manipulations for...
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.
A class representing the concept of 1 (scalar(1)) used to avoid unnecessary manipulations for objects...
Definition: one.H:50