alphatFilmWallFunctionFvPatchScalarField.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-2018 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 Description
28  This boundary condition provides a turbulent thermal diffusivity condition
29  when using wall functions, for use with surface film models. This
30  condition varies from the standard wall function by taking into account any
31  mass released from the film model.
32 
33 Usage
34  \table
35  Property | Description | Required | Default value
36  B | model coefficient | no | 5.5
37  yPlusCrit | critical y+ for transition to turbulent flow | no|11.05
38  Cmu | model coefficient | no | 0.09
39  kappa | Von-Karman constant | no | 0.41
40  Prt | turbulent Prandtl number | no | 0.85
41  \endtable
42 
43  Example of the boundary condition specification:
44  \verbatim
45  <patchName>
46  {
47  type alphatFilmWallFunction;
48  B 5.5;
49  yPlusCrit 11.05;
50  Cmu 0.09;
51  kappa 0.41;
52  Prt 0.85;
53  value uniform 0;
54  }
55  \endverbatim
56 
57 See also
58  Foam::fixedValueFvPatchField
59 
60 SourceFiles
61  alphatFilmWallFunctionFvPatchScalarField.C
62 
63 \*---------------------------------------------------------------------------*/
64 
65 #ifndef alphatFilmWallFunctionFvPatchScalarField_H
66 #define alphatFilmWallFunctionFvPatchScalarField_H
67 
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 namespace Foam
73 {
74 namespace compressible
75 {
76 namespace RASModels
77 {
78 
79 /*---------------------------------------------------------------------------*\
80  Class alphatFilmWallFunctionFvPatchScalarField Declaration
81 \*---------------------------------------------------------------------------*/
82 
83 class alphatFilmWallFunctionFvPatchScalarField
84 :
85  public fixedValueFvPatchScalarField
86 {
87 protected:
88 
89  // Protected data
90 
91  //- B Coefficient (default = 5.5)
92  scalar B_;
93 
94  //- y+ value for laminar -> turbulent transition (default = 11.05)
95  scalar yPlusCrit_;
96 
97  //- Turbulent Cmu coefficient (default = 0.09)
98  scalar Cmu_;
99 
100  //- Von-Karman constant (default = 0.41)
101  scalar kappa_;
102 
103  //- Turbulent Prandtl number (default = 0.85)
104  scalar Prt_;
105 
106 
107 public:
108 
109  //- Runtime type information
110  TypeName("alphatFilmWallFunction");
111 
113  // Constructors
114 
115  //- Construct from patch and internal field
117  (
118  const fvPatch&,
120  );
122  //- Construct from patch, internal field and dictionary
124  (
125  const fvPatch&,
127  const dictionary&
128  );
129 
130  //- Construct by mapping given
131  // alphatFilmWallFunctionFvPatchScalarField
132  // onto a new patch
134  (
136  const fvPatch&,
138  const fvPatchFieldMapper&
139  );
140 
141  //- Construct as copy
143  (
145  );
146 
147  //- Construct and return a clone
148  virtual tmp<fvPatchScalarField> clone() const
149  {
151  (
153  );
154  }
155 
156  //- Construct as copy setting internal field reference
158  (
161  );
162 
163  //- Construct and return a clone setting internal field reference
165  (
167  ) const
168  {
170  (
172  );
173  }
174 
175 
176  // Member functions
178  // Evaluation functions
179 
180  //- Update the coefficients associated with the patch field
181  virtual void updateCoeffs();
182 
183 
184  // I-O
185 
186  //- Write
187  virtual void write(Ostream&) const;
188 };
189 
190 
191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
192 
193 } // End namespace RASModels
194 } // End namespace compressible
195 } // End namespace Foam
196 
197 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
198 
199 #endif
200 
201 // ************************************************************************* //
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.
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
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
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
Namespace for OpenFOAM.
This boundary condition provides a turbulent thermal diffusivity condition when using wall functions...