turbulentMixingLengthDissipationRateFvScalarFieldSource.C
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) 2023-2024 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 \*---------------------------------------------------------------------------*/
25 
28 #include "fvCellSet.H"
29 #include "volFields.H"
30 #include "momentumTransportModel.H"
31 
32 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33 
36 (
38  const dictionary& dict
39 )
40 :
41  fvScalarFieldSource(iF, dict),
42  mixingLength_(dict.lookup<scalar>("mixingLength", dimLength)),
43  kName_(dict.lookupOrDefault<word>("k", "k"))
44 {}
45 
46 
49 (
52 )
53 :
54  fvScalarFieldSource(field, iF),
55  mixingLength_(field.mixingLength_),
56  kName_(field.kName_)
57 {}
58 
59 
60 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
61 
64 {}
65 
66 
67 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
68 
71 (
72  const fvSource& source
73 ) const
74 {
75  const scalarField ks(this->value<scalar>(kName_, source));
76 
77  const momentumTransportModel& turbModel =
78  db().lookupType<momentumTransportModel>(internalField().group());
79 
80  const scalar Cmu =
81  turbModel.coeffDict().lookupOrDefault<scalar>("Cmu", 0.09);
82 
83  const scalar Cmu75 = pow(Cmu, 0.75);
84 
85  return Cmu75*ks*sqrt(ks)/mixingLength_;
86 }
87 
88 
91 (
92  const fvSource& source
93 ) const
94 {
95  return
96  neg0(source.source(internalField().name()))
97  *scalarField(source.nCells(), scalar(1));
98 }
99 
100 
102 (
103  Ostream& os
104 ) const
105 {
107  writeEntry(os, "mixingLength", mixingLength_);
108  writeEntryIfDifferent<word>(os, "k", "k", kName_);
109 }
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 namespace Foam
115 {
117  (
118  fvScalarFieldSource,
120  );
121 }
122 
123 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
T lookupOrDefault(const word &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T, if not found return the given default.
Base class for finite volume sources.
Definition: fvSource.H:52
virtual tmp< scalarField > source(const word &fieldName) const =0
Return the source value.
virtual label nCells() const
Return the number of cells that the source applies to.
Definition: fvSource.C:66
Abstract base class for turbulence models (RAS, LES and laminar).
virtual const dictionary & coeffDict() const =0
Const access to the coefficients dictionary.
A class for managing temporary objects.
Definition: tmp.H:55
This source condition provides a turbulence dissipation, (epsilon), based on a specified mixing leng...
virtual tmp< scalarField > internalCoeff(const fvSource &) const
Return the internal coefficient.
virtual tmp< scalarField > sourceValue(const fvSource &) const
Return the source value.
turbulentMixingLengthDissipationRateFvScalarFieldSource(const DimensionedField< scalar, volMesh > &, const dictionary &dict)
Construct from internal field and dictionary.
A class for handling words, derived from string.
Definition: word.H:62
void write(std::ostream &os, const bool binary, List< floatScalar > &fField)
Write floats ascii or binary.
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
makeTypeFieldSource(fvScalarFieldSource, turbulentIntensityKineticEnergyFvScalarFieldSource)
const dimensionSet dimLength
Field< scalar > scalarField
Specialisation of Field<T> for scalar.
dimensionedScalar pow(const dimensionedScalar &ds, const dimensionedScalar &expt)
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
dimensionedScalar sqrt(const dimensionedScalar &ds)
dimensionedScalar neg0(const dimensionedScalar &ds)
dictionary dict