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