fWallFunctionFvPatchScalarField.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) 2012-2023 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::RASModels::fWallFunctionFvPatchScalarField
26 
27 Description
28  This boundary condition provides a turbulence damping function, f, wall
29  function condition for low- and high Reynolds number, turbulent flow cases
30 
31  The model operates in two modes, based on the computed laminar-to-turbulent
32  switch-over y+ value derived from kappa and E specified in the corresponding
33  nutWallFunction.
34 
35 Usage
36  Example of the boundary condition specification:
37  \verbatim
38  <patchName>
39  {
40  type fWallFunction;
41  }
42  \endverbatim
43 
44 See also
45  Foam::fixedValueFvPatchField
46 
47 SourceFiles
48  fWallFunctionFvPatchScalarField.C
49 
50 \*---------------------------------------------------------------------------*/
51 
52 #ifndef fWallFunctionFvPatchScalarField_H
53 #define fWallFunctionFvPatchScalarField_H
54 
55 #include "fixedValueFvPatchField.H"
56 
57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58 
59 namespace Foam
60 {
61 namespace RASModels
62 {
63 
64 /*---------------------------------------------------------------------------*\
65  Class fWallFunctionFvPatchScalarField Declaration
66 \*---------------------------------------------------------------------------*/
67 
69 :
70  public fixedValueFvPatchField<scalar>
71 {
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("fWallFunction");
77 
78 
79  // Constructors
80 
81  //- Construct from patch, internal field and dictionary
83  (
84  const fvPatch&,
86  const dictionary&
87  );
88 
89  //- Construct by mapping given fWallFunctionFvPatchScalarField
90  // onto a new patch
92  (
94  const fvPatch&,
96  const fieldMapper&
97  );
98 
99  //- Disallow copy without setting internal field reference
101  (
103  ) = delete;
104 
105  //- Copy constructor setting internal field reference
107  (
110  );
111 
112  //- Construct and return a clone setting internal field reference
114  (
116  ) const
117  {
119  (
120  new fWallFunctionFvPatchScalarField(*this, iF)
121  );
122  }
123 
124 
125  // Member Functions
126 
127  // Evaluation functions
128 
129  //- Update the coefficients associated with the patch field
130  virtual void updateCoeffs();
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace RASModels
137 } // End namespace Foam
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
This boundary condition provides a turbulence damping function, f, wall function condition for low- a...
TypeName("fWallFunction")
Runtime type information.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
fWallFunctionFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
Construct from patch, internal field and dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Abstract base class for field mapping.
Definition: fieldMapper.H:48
This boundary condition supplies a fixed value constraint, and is the base class for a number of othe...
tmp< fvPatchField< Type > > clone() const
Disallow clone without setting internal field reference.
Definition: fvPatchField.H:204
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:64
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.