alphatWallFunctionFvPatchScalarField.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) 2011-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::compressible::alphatWallFunctionFvPatchScalarField
26 
27 Description
28  This boundary condition provides a turbulent thermal diffusivity condition
29  when using wall functions
30  - replicates OpenFOAM v1.5 (and earlier) behaviour
31 
32  The turbulent thermal diffusivity calculated using:
33 
34  \f[
35  \alpha_t = \frac{\mu_t}{Pr_t}
36  \f]
37 
38  where
39 
40  \vartable
41  \alpha_t| turbulence thermal diffusivity
42  \mu_t | turbulence viscosity
43  Pr_t | turblent Prandtl number
44  \endvartable
45 
46 Usage
47  \table
48  Property | Description | Required | Default value
49  nut | turbulence viscosity field name | no | nut
50  Prt | turbulent Prandtl number | no | 0.85
51  \endtable
52 
53  Example of the boundary condition specification:
54  \verbatim
55  <patchName>
56  {
57  type alphatWallFunction;
58  nut nut;
59  Prt 0.85;
60  value uniform 0; // optional value entry
61  }
62  \endverbatim
63 
64 See also
65  Foam::fixedValueFvPatchField
66 
67 SourceFiles
68  alphatWallFunctionFvPatchScalarField.C
69 
70 \*---------------------------------------------------------------------------*/
71 
72 #ifndef alphatWallFunctionFvPatchScalarField_H
73 #define alphatWallFunctionFvPatchScalarField_H
74 
76 
77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78 
79 namespace Foam
80 {
81 namespace compressible
82 {
83 
84 /*---------------------------------------------------------------------------*\
85  Class alphatWallFunctionFvPatchScalarField Declaration
86 \*---------------------------------------------------------------------------*/
87 
88 class alphatWallFunctionFvPatchScalarField
89 :
90  public fixedValueFvPatchScalarField
91 {
92  // Private Data
93 
94  //- Turbulent Prandtl number (default = 0.85)
95  scalar Prt_;
96 
97 
98 public:
99 
100  //- Runtime type information
101  TypeName("compressible::alphatWallFunction");
102 
103 
104  // Constructors
105 
106  //- Construct from patch and internal field
108  (
109  const fvPatch&,
110  const DimensionedField<scalar, volMesh>&
111  );
112 
113  //- Construct from patch, internal field and dictionary
115  (
116  const fvPatch&,
118  const dictionary&
119  );
120 
121  //- Construct by mapping given
122  // alphatWallFunctionFvPatchScalarField
123  // onto a new patch
125  (
127  const fvPatch&,
129  const fvPatchFieldMapper&
130  );
131 
132  //- Disallow copy without setting internal field reference
134  (
136  ) = delete;
137 
138  //- Copy constructor setting internal field reference
140  (
143  );
144 
145  //- Construct and return a clone setting internal field reference
147  (
149  ) const
150  {
152  (
154  );
155  }
156 
157 
158  // Member Functions
159 
160  // Evaluation functions
161 
162  //- Update the coefficients associated with the patch field
163  virtual void updateCoeffs();
164 
165 
166  // I-O
167 
168  //- Write
169  virtual void write(Ostream&) const;
170 };
171 
172 
173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
174 
175 } // End namespace compressible
176 } // End namespace Foam
177 
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
179 
180 #endif
181 
182 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:63
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
alphatWallFunctionFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
This boundary condition provides a turbulent thermal diffusivity condition when using wall functions...
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
TypeName("compressible::alphatWallFunction")
Runtime type information.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.