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