yPlus.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) 2013-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::yPlus
26 
27 Group
28  grpFieldFunctionObjects
29 
30 Description
31  Evaluates and outputs turbulence y+ for models. Values written to
32  time directories as field 'yPlus'
33 
34 See also
35  Foam::functionObject
36  Foam::functionObjects::writeFiles
37  Foam::functionObjects::timeControl
38 
39 SourceFiles
40  yPlus.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef functionObjects_yPlus_H
45 #define functionObjects_yPlus_H
46 
47 #include "writeFiles.H"
48 #include "volFieldsFwd.H"
49 
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 
52 namespace Foam
53 {
54 
55 // Forward declaration of classes
56 class fvMesh;
57 class turbulenceModel;
58 
59 namespace functionObjects
60 {
61 
62 /*---------------------------------------------------------------------------*\
63  Class yPlus Declaration
64 \*---------------------------------------------------------------------------*/
65 
66 class yPlus
67 :
68  public writeFiles
69 {
70  // Private Member Functions
71 
72  //- File header information
73  virtual void writeFileHeader(const label i);
74 
75  //- Calculate y+
76  void calcYPlus
77  (
78  const turbulenceModel& turbModel,
79  const fvMesh& mesh,
81  );
82 
83  //- Disallow default bitwise copy construct
84  yPlus(const yPlus&);
85 
86  //- Disallow default bitwise assignment
87  void operator=(const yPlus&);
88 
89 
90 public:
91 
92  //- Runtime type information
93  TypeName("yPlus");
94 
95 
96  // Constructors
97 
98  //- Construct from Time and dictionary
99  yPlus
100  (
101  const word& name,
102  const Time& runTime,
103  const dictionary& dict
104  );
105 
106 
107  //- Destructor
108  virtual ~yPlus();
109 
110 
111  // Member Functions
112 
113  //- Read the yPlus data
114  virtual bool read(const dictionary&);
115 
116  //- Calculate the yPlus field
117  virtual bool execute();
118 
119  //- Write the yPlus field
120  virtual bool write();
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace functionObjects
127 } // End namespace Foam
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
virtual bool read(const dictionary &)
Read the yPlus data.
Definition: yPlus.C:165
dictionary dict
virtual bool write()
Write the yPlus field.
Definition: yPlus.C:201
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual bool execute()
Calculate the yPlus field.
Definition: yPlus.C:173
functionObject base class for writing files
Definition: writeFiles.H:56
ThermalDiffusivity< CompressibleTurbulenceModel< fluidThermo > > turbulenceModel
Abstract base class for turbulence models (RAS, LES and laminar).
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
dynamicFvMesh & mesh
const word & name() const
Return the name of this functionObject.
A class for handling words, derived from string.
Definition: word.H:59
virtual ~yPlus()
Destructor.
Definition: yPlus.C:159
TypeName("yPlus")
Runtime type information.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Evaluates and outputs turbulence y+ for models. Values written to time directories as field &#39;yPlus&#39;...
Definition: yPlus.H:65
Namespace for OpenFOAM.