-
Notifications
You must be signed in to change notification settings - Fork 0
/
yPlusStats.H
162 lines (118 loc) · 4.35 KB
/
yPlusStats.H
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | www.openfoam.com
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2013-2016 OpenFOAM Foundation
Copyright (C) 2015-2020 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is NOT part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObjects::yPlusStats
Group
grpFieldFunctionObjects
Description
Computes the near wall \f$y_1^+\f$ for turbulence models.
Operands:
\table
Operand | Type | Location
input | - | -
output file | dat | $FOAM_CASE/postProcessing/\<FO\>/\<time\>/\<file\>
\endtable
Usage
Minimal example by using \c system/controlDict.functions:
\verbatim
yPlusStats1
{
// Mandatory entries (unmodifiable)
type yPlusStats;
libs (yPlusStatsFunctionObject);
// Optional (inherited) entries
...
}
\endverbatim
where the entries mean:
\table
Property | Description | Type | Req'd | Dflt
type | Type name: yPlusStats | word | yes | -
libs | Library name: yPlusStatsFunctionObjects | word | yes | -
\endtable
The inherited entries are elaborated in:
- \link functionObject.H \endlink
- \link writeFile.H \endlink
Minimal example by using the \c postProcess utility:
\verbatim
<solver> -postProcess -func yPlusStats
\endverbatim
See also
- Foam::functionObject
- Foam::functionObjects::fvMeshFunctionObject
- Foam::functionObjects::writeFile
SourceFiles
yPlusStats.C
\*---------------------------------------------------------------------------*/
#ifndef functionObjects_yPlusStats_H
#define functionObjects_yPlusStats_H
#include "fvMeshFunctionObject.H"
#include "writeFile.H"
#include "volFieldsFwd.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class yPlusStats Declaration
\*---------------------------------------------------------------------------*/
class yPlusStats
:
public fvMeshFunctionObject,
public writeFile
{
// Private Member Functions
//- File header information
virtual void writeFileHeader(Ostream& os) const;
public:
//- Runtime type information
TypeName("yPlusStats");
// Constructors
//- Construct from Time and dictionary
yPlusStats
(
const word& name,
const Time& runTime,
const dictionary& dict
);
//- No copy construct
yPlusStats(const yPlusStats&) = delete;
//- No copy assignment
void operator=(const yPlusStats&) = delete;
//- Destructor
virtual ~yPlusStats() = default;
// Member Functions
//- Read the yPlusStats data
virtual bool read(const dictionary&);
//- Calculate the yPlusStats field
virtual bool execute();
//- Write the yPlusStats field
virtual bool write();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //