nutLowReWallFunctionFvPatchScalarField.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) 2011-2015 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::nutLowReWallFunctionFvPatchScalarField
26 
27 Group
28  grpWallFunctions
29 
30 Description
31  This boundary condition provides a turbulent kinematic viscosity condition
32  for use with low Reynolds number models. It sets \c nut to zero, and
33  provides an access function to calculate y+.
34 
35  \heading Patch usage
36 
37  Example of the boundary condition specification:
38  \verbatim
39  myPatch
40  {
41  type nutLowReWallFunction;
42  }
43  \endverbatim
44 
45 SeeAlso
46  Foam::nutWallFunctionFvPatchScalarField
47 
48 SourceFiles
49  nutLowReWallFunctionFvPatchScalarField.C
50 
51 \*---------------------------------------------------------------------------*/
52 
53 #ifndef nutLowReWallFunctionFvPatchScalarField_H
54 #define nutLowReWallFunctionFvPatchScalarField_H
55 
57 
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59 
60 namespace Foam
61 {
62 
63 /*---------------------------------------------------------------------------*\
64  Class nutLowReWallFunctionFvPatchScalarField Declaration
65 \*---------------------------------------------------------------------------*/
66 
68 :
70 {
71 protected:
72 
73  // Protected Member Functions
74 
75  //- Calculate the turbulence viscosity
76  virtual tmp<scalarField> calcNut() const;
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("nutLowReWallFunction");
83 
84 
85  // Constructors
86 
87  //- Construct from patch and internal field
89  (
90  const fvPatch&,
92  );
93 
94  //- Construct from patch, internal field and dictionary
96  (
97  const fvPatch&,
99  const dictionary&
100  );
101 
102  //- Construct by mapping given
103  // nutLowReWallFunctionFvPatchScalarField
104  // onto a new patch
106  (
108  const fvPatch&,
110  const fvPatchFieldMapper&
111  );
112 
113  //- Construct as copy
115  (
117  );
118 
119  //- Construct and return a clone
120  virtual tmp<fvPatchScalarField> clone() const
121  {
123  (
125  );
126  }
127 
128  //- Construct as copy setting internal field reference
130  (
133  );
134 
135  //- Construct and return a clone setting internal field reference
137  (
139  ) const
140  {
142  (
144  );
145  }
146 
147 
148  // Member functions
149 
150  //- Calculate and return the yPlus at the boundary
151  virtual tmp<scalarField> yPlus() const;
152 };
153 
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 } // End namespace Foam
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 #endif
162 
163 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
This boundary condition provides a turbulent kinematic viscosity condition when using wall functions...
virtual tmp< scalarField > calcNut() const
Calculate the turbulence viscosity.
This boundary condition provides a turbulent kinematic viscosity condition for use with low Reynolds ...
Foam::fvPatchFieldMapper.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
nutLowReWallFunctionFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
virtual tmp< scalarField > yPlus() const
Calculate and return the yPlus at the boundary.
TypeName("nutLowReWallFunction")
Runtime type information.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
A class for managing temporary objects.
Definition: PtrList.H:118