v2WallFunctionFvPatchScalarField.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::v2WallFunctionFvPatchScalarField
26 
27 Description
28  This boundary condition provides a turbulence stress normal to streamlines
29  wall function condition for low- and high-Reynolds number, turbulent flow
30  cases.
31 
32  The model operates in two modes, based on the computed laminar-to-turbulent
33  switch-over y+ value derived from kappa and E specified in the corresponding
34  nutWallFunction.
35 
36 
37 Usage
38  Example of the boundary condition specification:
39  \verbatim
40  <patchName>
41  {
42  type v2WallFunction;
43  }
44  \endverbatim
45 
46 See also
47  Foam::fixedValueFvPatchField
48 
49 SourceFiles
50  v2WallFunctionFvPatchScalarField.C
51 
52 \*---------------------------------------------------------------------------*/
53 
54 #ifndef v2WallFunctionFvPatchScalarField_H
55 #define v2WallFunctionFvPatchScalarField_H
56 
57 #include "fixedValueFvPatchField.H"
58 
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 
61 namespace Foam
62 {
63 namespace RASModels
64 {
65 
66 /*---------------------------------------------------------------------------*\
67  Class v2WallFunctionFvPatchScalarField Declaration
68 \*---------------------------------------------------------------------------*/
69 
71 :
72  public fixedValueFvPatchField<scalar>
73 {
74 
75 public:
76 
77  //- Runtime type information
78  TypeName("v2WallFunction");
79 
80 
81  // Constructors
82 
83  //- Construct from patch, internal field and dictionary
85  (
86  const fvPatch&,
88  const dictionary&
89  );
90 
91  //- Construct by mapping given v2WallFunctionFvPatchScalarField
92  // onto a new patch
94  (
96  const fvPatch&,
98  const fieldMapper&
99  );
100 
101  //- Disallow copy without setting internal field reference
103  (
105  ) = delete;
106 
107  //- Copy constructor setting internal field reference
109  (
112  );
113 
114  //- Construct and return a clone setting internal field reference
116  (
118  ) const
119  {
121  (
122  new v2WallFunctionFvPatchScalarField(*this, iF)
123  );
124  }
125 
126 
127  // Member Functions
128 
129  // Evaluation functions
130 
131  //- Update the coefficients associated with the patch field
132  virtual void updateCoeffs();
133 };
134 
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 } // End namespace RASModels
139 } // End namespace Foam
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 #endif
144 
145 // ************************************************************************* //
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
This boundary condition provides a turbulence stress normal to streamlines wall function condition fo...
TypeName("v2WallFunction")
Runtime type information.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
v2WallFunctionFvPatchScalarField(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.