ddt.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) 2017-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::functionObjects::ddt
26 
27 Description
28  Calculates the Eulerian time derivative of a field.
29 
30  The operation can be applied to any volume field generating a field of the
31  same type.
32 
33 See also
34  Foam::functionObjects::fvMeshFunctionObject
35 
36 SourceFiles
37  ddt.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef functionObjects_ddt_H
42 #define functionObjects_ddt_H
43 
44 #include "fieldExpression.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 namespace functionObjects
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class ddt Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 class ddt
58 :
59  public fieldExpression
60 {
61  // Private Member Functions
62 
63  //- Calculate the magnitude of the field and register the result
64  template<class Type>
65  bool calcDdt();
66 
67  //- Calculate the time derivative of the field and return
68  // true if successful
69  virtual bool calc();
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("ddt");
76 
77 
78  // Constructors
79 
80  //- Construct from Time and dictionary
81  ddt
82  (
83  const word& name,
84  const Time& runTime,
85  const dictionary& dict
86  );
87 
88 
89  //- Destructor
90  virtual ~ddt();
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace functionObjects
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #ifdef NoRepository
102  #include "ddtTemplates.C"
103 #endif
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
dictionary dict
const word & name() const
Return the name of this functionObject.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
TypeName("ddt")
Runtime type information.
Calculates the Eulerian time derivative of a field.
Definition: ddt.H:56
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:69
ddt(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Definition: ddt.C:72
A class for handling words, derived from string.
Definition: word.H:59
virtual ~ddt()
Destructor.
Definition: ddt.C:84
Namespace for OpenFOAM.