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