turbulentMixingLengthFrequencyInletFvPatchScalarField.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-2020 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::turbulentMixingLengthFrequencyInletFvPatchScalarField
26 
27 Description
28  This boundary condition provides a turbulence specific dissipation,
29  \f$\omega\f$ (omega) inlet condition based on a specified mixing length.
30  The patch values are calculated using:
31 
32  \f[
33  \omega_p = \frac{k^{0.5}}{C_{\mu}^{0.25} L}
34  \f]
35 
36  where
37 
38  \vartable
39  \omega_p | patch omega values
40  C_{\mu} | Model coefficient, set to 0.09
41  k | turbulence kinetic energy
42  L | length scale
43  \endvartable
44 
45 Usage
46  \table
47  Property | Description | Required | Default value
48  mixingLength | Length scale [m] | yes |
49  phi | flux field name | no | phi
50  k | turbulence kinetic energy field name | no | k
51  \endtable
52 
53  Example of the boundary condition specification:
54  \verbatim
55  <patchName>
56  {
57  type turbulentMixingLengthFrequencyInlet;
58  mixingLength 0.005;
59  value uniform 200; // placeholder
60  }
61  \endverbatim
62 
63 Note
64  In the event of reverse flow, a zero-gradient condition is applied
65 
66 See also
67  Foam::inletOutletFvPatchField
68 
69 
70 SourceFiles
71  turbulentMixingLengthFrequencyInletFvPatchScalarField.C
72 
73 \*---------------------------------------------------------------------------*/
74 
75 #ifndef turbulentMixingLengthFrequencyInletFvPatchScalarField_H
76 #define turbulentMixingLengthFrequencyInletFvPatchScalarField_H
77 
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 namespace Foam
83 {
84 
85 /*---------------------------------------------------------------------------*\
86  Class turbulentMixingLengthFrequencyInletFvPatchScalarField Declaration
87 \*---------------------------------------------------------------------------*/
88 
89 class turbulentMixingLengthFrequencyInletFvPatchScalarField
90 :
91  public inletOutletFvPatchScalarField
92 {
93  // Private Data
94 
95  //- Turbulent length scale
96  scalar mixingLength_;
97 
98  //- Name of the turbulent kinetic energy field
99  word kName_;
100 
101 
102 public:
103 
104  //- Runtime type information
105  TypeName("turbulentMixingLengthFrequencyInlet");
106 
107 
108  // Constructors
109 
110  //- Construct from patch and internal field
112  (
113  const fvPatch&,
114  const DimensionedField<scalar, volMesh>&
115  );
116 
117  //- Construct from patch, internal field and dictionary
119  (
120  const fvPatch&,
121  const DimensionedField<scalar, volMesh>&,
122  const dictionary&
123  );
125  //- Construct by mapping given
126  // turbulentMixingLengthFrequencyInletFvPatchScalarField
127  // onto a new patch
129  (
131  const fvPatch&,
133  const fvPatchFieldMapper&
134  );
135 
136  //- Disallow copy without setting internal field reference
138  (
140  ) = delete;
141 
142  //- Copy constructor setting internal field reference
144  (
147  );
148 
149  //- Construct and return a clone setting internal field reference
151  (
153  ) const
154  {
156  (
158  (
159  *this,
160  iF
161  )
162  );
163  }
164 
165 
166  // Member Functions
167 
168  //- Update the coefficients associated with the patch field
169  virtual void updateCoeffs();
170 
171  //- Write
172  virtual void write(Ostream&) const;
173 };
174 
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 } // End namespace Foam
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 #endif
183 
184 // ************************************************************************* //
This boundary condition provides a turbulence specific dissipation, (omega) inlet condition based on...
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:62
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Foam::fvPatchFieldMapper.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
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
TypeName("turbulentMixingLengthFrequencyInlet")
Runtime type information.
turbulentMixingLengthFrequencyInletFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
Namespace for OpenFOAM.
virtual tmp< fvPatchScalarField > clone(const DimensionedField< scalar, volMesh > &iF) const
Construct and return a clone setting internal field reference.