flowType.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) 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::functionObjects::flowType
26 
27 Group
28  grpFieldFunctionObjects
29 
30 Description
31  Calculates and writes the flowType of a velocity field.
32 
33  The flow type parameter is obtained according to the following equation:
34  \verbatim
35  |D| - |Omega|
36  lambda = -------------
37  |D| + |Omega|
38 
39  -1 = rotational flow
40  0 = simple shear flow
41  1 = planar extensional flow
42  \endverbatim
43 
44 See also
45  Foam::functionObjects::fieldExpression
46  Foam::functionObjects::fvMeshFunctionObject
47 
48 SourceFiles
49  flowType.C
50 
51 \*---------------------------------------------------------------------------*/
52 
53 #ifndef functionObjects_flowType_H
54 #define functionObjects_flowType_H
55 
56 #include "fieldExpression.H"
57 
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59 
60 namespace Foam
61 {
62 namespace functionObjects
63 {
64 
65 /*---------------------------------------------------------------------------*\
66  Class flowType Declaration
67 \*---------------------------------------------------------------------------*/
68 
69 class flowType
70 :
71  public fieldExpression
72 {
73  // Private Member Functions
74 
75  //- Calculate the flowType field and return true if successful
76  virtual bool calc();
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("flowType");
83 
84 
85  // Constructors
86 
87  //- Construct from Time and dictionary
88  flowType
89  (
90  const word& name,
91  const Time& runTime,
92  const dictionary& dict
93  );
94 
95 
96  //- Destructor
97  virtual ~flowType();
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace functionObjects
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
virtual ~flowType()
Destructor.
Definition: flowType.C:98
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
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
A class for handling words, derived from string.
Definition: word.H:59
Calculates and writes the flowType of a velocity field.
Definition: flowType.H:68
flowType(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
Definition: flowType.C:84
TypeName("flowType")
Runtime type information.
Namespace for OpenFOAM.