alphatFilmWallFunctionFvPatchScalarField.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::RASModels::alphatFilmWallFunctionFvPatchScalarField
26 
27 Group
28  grpSurfaceFilmBoundaryConditions grpCmpWallFunctions
29 
30 Description
31  This boundary condition provides a turbulent thermal diffusivity condition
32  when using wall functions, for use with surface film models. This
33  condition varies from the standard wall function by taking into account any
34  mass released from the film model.
35 
36 Usage
37  \table
38  Property | Description | Required | Default value
39  B | model coefficient | no | 5.5
40  yPlusCrit | critical y+ for transition to turbulent flow | no|11.05
41  Cmu | model coefficient | no | 0.09
42  kappa | Von-Karman constant | no | 0.41
43  Prt | turbulent Prandtl number | no | 0.85
44  \endtable
45 
46  Example of the boundary condition specification:
47  \verbatim
48  <patchName>
49  {
50  type alphatFilmWallFunction;
51  B 5.5;
52  yPlusCrit 11.05;
53  Cmu 0.09;
54  kappa 0.41;
55  Prt 0.85;
56  value uniform 0;
57  }
58  \endverbatim
59 
60 See also
61  Foam::fixedValueFvPatchField
62 
63 SourceFiles
64  alphatFilmWallFunctionFvPatchScalarField.C
65 
66 \*---------------------------------------------------------------------------*/
67 
68 #ifndef compressibleMutRoughWallFunctionFvPatchScalarField_H
69 #define compressibleMutRoughWallFunctionFvPatchScalarField_H
70 
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 namespace Foam
76 {
77 namespace compressible
78 {
79 namespace RASModels
80 {
81 
82 /*---------------------------------------------------------------------------*\
83  Class alphatFilmWallFunctionFvPatchScalarField Declaration
84 \*---------------------------------------------------------------------------*/
85 
86 class alphatFilmWallFunctionFvPatchScalarField
87 :
88  public fixedValueFvPatchScalarField
89 {
90 protected:
91 
92  // Protected data
93 
94  //- B Coefficient (default = 5.5)
95  scalar B_;
96 
97  //- y+ value for laminar -> turbulent transition (default = 11.05)
98  scalar yPlusCrit_;
99 
100  //- Turbulent Cmu coefficient (default = 0.09)
101  scalar Cmu_;
102 
103  //- Von-Karman constant (default = 0.41)
104  scalar kappa_;
105 
106  //- Turbulent Prandtl number (default = 0.85)
107  scalar Prt_;
108 
109 
110 public:
111 
112  //- Runtime type information
113  TypeName("alphatFilmWallFunction");
114 
116  // Constructors
117 
118  //- Construct from patch and internal field
120  (
121  const fvPatch&,
123  );
125  //- Construct from patch, internal field and dictionary
127  (
128  const fvPatch&,
130  const dictionary&
131  );
132 
133  //- Construct by mapping given
134  // alphatFilmWallFunctionFvPatchScalarField
135  // onto a new patch
137  (
139  const fvPatch&,
141  const fvPatchFieldMapper&
142  );
143 
144  //- Construct as copy
146  (
148  );
149 
150  //- Construct and return a clone
151  virtual tmp<fvPatchScalarField> clone() const
152  {
154  (
156  );
157  }
158 
159  //- Construct as copy setting internal field reference
161  (
164  );
165 
166  //- Construct and return a clone setting internal field reference
168  (
170  ) const
171  {
173  (
175  );
176  }
177 
178 
179  // Member functions
181  // Evaluation functions
182 
183  //- Update the coefficients associated with the patch field
184  virtual void updateCoeffs();
185 
186 
187  // I-O
188 
189  //- Write
190  virtual void write(Ostream&) const;
191 };
192 
193 
194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
195 
196 } // End namespace RASModels
197 } // End namespace compressible
198 } // End namespace Foam
199 
200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
201 
202 #endif
203 
204 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
scalar yPlusCrit_
y+ value for laminar -> turbulent transition (default = 11.05)
TypeName("alphatFilmWallFunction")
Runtime type information.
alphatFilmWallFunctionFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
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...
A class for managing temporary objects.
Definition: PtrList.H:54
Namespace for OpenFOAM.
This boundary condition provides a turbulent thermal diffusivity condition when using wall functions...
bool compressible
Definition: pEqn.H:30