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