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-2012 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  \heading Patch usage
37 
38  \table
39  Property | Description | Required | Default value
40  B | model coefficient | no | 5.5
41  yPlusCrit | critical y+ for transition to turbulent flow | no|11.05
42  Cmu | model coefficient | no | 0.09
43  kappa | Von-Karman constant | no | 0.41
44  Prt | turbulent Prandtl number | no | 0.85
45  \endtable
46 
47  Example of the boundary condition specification:
48  \verbatim
49  myPatch
50  {
51  type alphatFilmWallFunction;
52  B 5.5;
53  yPlusCrit 11.05;
54  Cmu 0.09;
55  kappa 0.41;
56  Prt 0.85;
57  value uniform 0;
58  }
59  \endverbatim
60 
61 SeeAlso
62  Foam::fixedValueFvPatchField
63 
64 SourceFiles
65  alphatFilmWallFunctionFvPatchScalarField.C
66 
67 \*---------------------------------------------------------------------------*/
68 
69 #ifndef compressibleMutRoughWallFunctionFvPatchScalarField_H
70 #define compressibleMutRoughWallFunctionFvPatchScalarField_H
71 
73 
74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
75 
76 namespace Foam
77 {
78 namespace compressible
79 {
80 namespace RASModels
81 {
82 
83 /*---------------------------------------------------------------------------*\
84  Class alphatFilmWallFunctionFvPatchScalarField Declaration
85 \*---------------------------------------------------------------------------*/
86 
87 class alphatFilmWallFunctionFvPatchScalarField
88 :
89  public fixedValueFvPatchScalarField
90 {
91 protected:
92 
93  // Protected data
94 
95  //- B Coefficient (default = 5.5)
96  scalar B_;
97 
98  //- y+ value for laminar -> turbulent transition (default = 11.05)
99  scalar yPlusCrit_;
100 
101  //- Turbulent Cmu coefficient (default = 0.09)
102  scalar Cmu_;
103 
104  //- Von-Karman constant (default = 0.41)
105  scalar kappa_;
106 
107  //- Turbulent Prandtl number (default = 0.85)
108  scalar Prt_;
109 
110 
111 public:
112 
113  //- Runtime type information
114  TypeName("alphatFilmWallFunction");
115 
117  // Constructors
118 
119  //- Construct from patch and internal field
121  (
122  const fvPatch&,
124  );
126  //- Construct from patch, internal field and dictionary
128  (
129  const fvPatch&,
131  const dictionary&
132  );
133 
134  //- Construct by mapping given
135  // alphatFilmWallFunctionFvPatchScalarField
136  // onto a new patch
138  (
140  const fvPatch&,
142  const fvPatchFieldMapper&
143  );
144 
145  //- Construct as copy
147  (
149  );
150 
151  //- Construct and return a clone
152  virtual tmp<fvPatchScalarField> clone() const
153  {
155  (
157  );
158  }
159 
160  //- Construct as copy setting internal field reference
162  (
165  );
166 
167  //- Construct and return a clone setting internal field reference
169  (
171  ) const
172  {
174  (
176  );
177  }
178 
179 
180  // Member functions
182  // Evaluation functions
183 
184  //- Update the coefficients associated with the patch field
185  virtual void updateCoeffs();
186 
187 
188  // I-O
189 
190  //- Write
191  virtual void write(Ostream&) const;
192 };
193 
194 
195 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
196 
197 } // End namespace RASModels
198 } // End namespace compressible
199 } // End namespace Foam
200 
201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
202 
203 #endif
204 
205 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Foam::fvPatchFieldMapper.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
alphatFilmWallFunctionFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Namespace for OpenFOAM.
This boundary condition provides a turbulent thermal diffusivity condition when using wall functions...
bool compressible
Definition: pEqn.H:40
scalar yPlusCrit_
y+ value for laminar -> turbulent transition (default = 11.05)
TypeName("alphatFilmWallFunction")
Runtime type information.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
virtual tmp< fvPatchScalarField > clone() const
Construct and return a clone.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
A class for managing temporary objects.
Definition: PtrList.H:118