kLowReWallFunctionFvPatchScalarField.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) 2012-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::kLowReWallFunctionFvPatchScalarField
26 
27 Description
28  This boundary condition provides a turbulence kinetic energy wall function
29  condition for low- and high-Reynolds number turbulent flow cases.
30 
31  The model operates in two modes, based on the computed laminar-to-turbulent
32  switch-over y+ value derived from kappa and E specified in the corresponding
33  nutWallFunction.
34 
35 Usage
36  \table
37  Property | Description | Required | Default value
38  Ceps2 | model coefficient | no | 1.9
39  \endtable
40 
41  Example of the boundary condition specification:
42  \verbatim
43  <patchName>
44  {
45  type kLowReWallFunction;
46  }
47  \endverbatim
48 
49 See also
50  Foam::fixedValueFvPatchField
51 
52 SourceFiles
53  kLowReWallFunctionFvPatchScalarField.C
54 
55 \*---------------------------------------------------------------------------*/
56 
57 #ifndef kLowReWallFunctionFvPatchScalarField_H
58 #define kLowReWallFunctionFvPatchScalarField_H
59 
60 #include "fixedValueFvPatchField.H"
61 
62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
63 
64 namespace Foam
65 {
66 
67 /*---------------------------------------------------------------------------*\
68  Class kLowReWallFunctionFvPatchScalarField Declaration
69 \*---------------------------------------------------------------------------*/
70 
71 class kLowReWallFunctionFvPatchScalarField
72 :
73  public fixedValueFvPatchField<scalar>
74 {
75 protected:
76 
77  // Protected data
78 
79  //- Ceps2 coefficient
80  scalar Ceps2_;
81 
82 
83 public:
84 
85  //- Runtime type information
86  TypeName("kLowReWallFunction");
87 
88 
89  // Constructors
90 
91  //- Construct from patch and internal field
93  (
94  const fvPatch&,
96  );
97 
98  //- Construct from patch, internal field and dictionary
100  (
101  const fvPatch&,
103  const dictionary&
104  );
105 
106  //- Construct by mapping given kLowReWallFunctionFvPatchScalarField
107  // onto a new patch
109  (
111  const fvPatch&,
113  const fvPatchFieldMapper&
114  );
115 
116  //- Disallow copy without setting internal field reference
118  (
120  ) = delete;
121 
122  //- Copy constructor setting internal field reference
124  (
127  );
128 
129  //- Construct and return a clone setting internal field reference
131  (
133  ) const
134  {
136  (
138  );
139  }
141 
142  // Member Functions
143 
144  // Evaluation functions
145 
146  //- Update the coefficients associated with the patch field
147  virtual void updateCoeffs();
148 
149 
150  // I-O
151 
152  //- Write
153  virtual void write(Ostream&) const;
154 };
155 
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 } // End namespace Foam
160 
161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
162 
163 #endif
164 
165 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
This boundary condition provides a turbulence kinetic energy wall function condition for low- and hig...
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
TypeName("kLowReWallFunction")
Runtime type information.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
A class for managing temporary objects.
Definition: PtrList.H:53
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:199
kLowReWallFunctionFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Namespace for OpenFOAM.