Q.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) 2013-2018 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::Q
26 
27 Description
28  Calculates and outputs the second invariant of the velocity gradient tensor
29  [1/s^2].
30 
31  \f[
32  Q = 0.5(sqr(tr(\nabla U)) - tr(((\nabla U) \cdot (\nabla U))))
33  \f]
34 
35 See also
36  Foam::functionObjects::fieldExpression
37  Foam::functionObjects::fvMeshFunctionObject
38 
39 SourceFiles
40  Q.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef functionObjects_Q_H
45 #define functionObjects_Q_H
46 
47 #include "fieldExpression.H"
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 namespace Foam
52 {
53 namespace functionObjects
54 {
55 
56 /*---------------------------------------------------------------------------*\
57  Class Q Declaration
58 \*---------------------------------------------------------------------------*/
59 
60 class Q
61 :
62  public fieldExpression
63 {
64  // Private Member Functions
65 
66  //- Calculate the Q field and return true if successful
67  virtual bool calc();
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("Q");
74 
75 
76  // Constructors
77 
78  //- Construct from Time and dictionary
79  Q
80  (
81  const word& name,
82  const Time& runTime,
83  const dictionary& dict
84  );
85 
86 
87  //- Destructor
88  virtual ~Q();
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace functionObjects
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
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:137
engineTime & runTime
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
Q(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Definition: Q.C:74
TypeName("Q")
Runtime type information.
A class for handling words, derived from string.
Definition: word.H:59
Calculates and outputs the second invariant of the velocity gradient tensor [1/s^2].
Definition: Q.H:59
virtual ~Q()
Destructor.
Definition: Q.C:88
Namespace for OpenFOAM.