v2WallFunctionFvPatchScalarField.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) 2012-2018 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 
27 #include "turbulenceModel.H"
28 #include "fvPatchFieldMapper.H"
29 #include "volFields.H"
31 #include "wallFvPatch.H"
32 
33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37 namespace RASModels
38 {
39 
40 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
41 
43 {
44  if (!isA<wallFvPatch>(patch()))
45  {
47  << "Invalid wall function specification" << nl
48  << " Patch type for patch " << patch().name()
49  << " must be wall" << nl
50  << " Current patch type is " << patch().type() << nl << endl
51  << abort(FatalError);
52  }
53 }
54 
55 
57 {
58  os.writeKeyword("Cmu") << Cmu_ << token::END_STATEMENT << nl;
59  os.writeKeyword("kappa") << kappa_ << token::END_STATEMENT << nl;
60  os.writeKeyword("E") << E_ << token::END_STATEMENT << nl;
61 }
62 
63 
65 (
66  const scalar kappa,
67  const scalar E
68 )
69 {
70  scalar ypl = 11.0;
71 
72  for (int i=0; i<10; i++)
73  {
74  ypl = log(max(E*ypl, 1))/kappa;
75  }
76 
77  return ypl;
78 }
79 
80 
81 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
82 
84 (
85  const fvPatch& p,
87 )
88 :
90  Cmu_(0.09),
91  kappa_(0.41),
92  E_(9.8),
94 {
95  checkType();
96 }
97 
98 
100 (
102  const fvPatch& p,
104  const fvPatchFieldMapper& mapper
105 )
106 :
107  fixedValueFvPatchField<scalar>(ptf, p, iF, mapper),
108  Cmu_(ptf.Cmu_),
109  kappa_(ptf.kappa_),
110  E_(ptf.E_),
111  yPlusLam_(ptf.yPlusLam_)
112 {
113  checkType();
114 }
115 
116 
118 (
119  const fvPatch& p,
121  const dictionary& dict
122 )
123 :
125  Cmu_(dict.lookupOrDefault<scalar>("Cmu", 0.09)),
126  kappa_(dict.lookupOrDefault<scalar>("kappa", 0.41)),
127  E_(dict.lookupOrDefault<scalar>("E", 9.8)),
129 {
130  checkType();
131 }
132 
133 
135 (
136  const v2WallFunctionFvPatchScalarField& v2wfpsf
137 )
138 :
140  Cmu_(v2wfpsf.Cmu_),
141  kappa_(v2wfpsf.kappa_),
142  E_(v2wfpsf.E_),
143  yPlusLam_(v2wfpsf.yPlusLam_)
144 {
145  checkType();
146 }
147 
148 
150 (
151  const v2WallFunctionFvPatchScalarField& v2wfpsf,
153 )
154 :
155  fixedValueFvPatchField<scalar>(v2wfpsf, iF),
156  Cmu_(v2wfpsf.Cmu_),
157  kappa_(v2wfpsf.kappa_),
158  E_(v2wfpsf.E_),
159  yPlusLam_(v2wfpsf.yPlusLam_)
160 {
161  checkType();
162 }
163 
164 
165 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
166 
168 {
169  if (updated())
170  {
171  return;
172  }
173 
174  const label patchi = patch().index();
175 
176  const turbulenceModel& turbModel = db().lookupObject<turbulenceModel>
177  (
179  (
181  internalField().group()
182  )
183  );
184  const scalarField& y = turbModel.y()[patchi];
185 
186  const tmp<volScalarField> tk = turbModel.k();
187  const volScalarField& k = tk();
188 
189  const tmp<scalarField> tnuw = turbModel.nu(patchi);
190  const scalarField& nuw = tnuw();
191 
192  const scalar Cmu25 = pow025(Cmu_);
193 
194  scalarField& v2 = *this;
195 
196  // Set v2 wall values
197  forAll(v2, facei)
198  {
199  label celli = patch().faceCells()[facei];
200 
201  scalar uTau = Cmu25*sqrt(k[celli]);
202 
203  scalar yPlus = uTau*y[facei]/nuw[facei];
204 
205  if (yPlus > yPlusLam_)
206  {
207  scalar Cv2 = 0.193;
208  scalar Bv2 = -0.94;
209  v2[facei] = Cv2/kappa_*log(yPlus) + Bv2;
210  }
211  else
212  {
213  scalar Cv2 = 0.193;
214  v2[facei] = Cv2*pow4(yPlus);
215  }
216 
217  v2[facei] *= sqr(uTau);
218  }
219 
221 
222  // TODO: perform averaging for cells sharing more than one boundary face
223 }
224 
225 
227 (
228  const Pstream::commsTypes commsType
229 )
230 {
232 }
233 
234 
236 {
237  writeLocalEntries(os);
239 }
240 
241 
242 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
243 
245 (
248 );
249 
250 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
251 
252 } // End namespace RASModels
253 } // End namespace Foam
254 
255 // ************************************************************************* //
const char *const group
Group name for atomic constants.
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
dictionary dict
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:428
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
virtual void write(Ostream &) const
Write.
dimensionedScalar log(const dimensionedScalar &ds)
label index() const
Return the index of this patch in the fvBoundaryMesh.
Definition: fvPatch.H:179
error FatalError
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
dimensioned< Type > max(const dimensioned< Type > &, const dimensioned< Type > &)
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:319
bool updated() const
Return true if the boundary condition has already been updated.
Definition: fvPatchField.H:371
This boundary condition provides a turbulence stress normal to streamlines wall function condition fo...
commsTypes
Types of communications.
Definition: UPstream.H:64
dimensionedSymmTensor sqr(const dimensionedVector &dv)
virtual void writeLocalEntries(Ostream &) const
Write local wall function variables.
scalar yPlusLam_
Y+ at the edge of the laminar sublayer.
virtual tmp< volScalarField > nu() const =0
Return the laminar viscosity.
dimensionedScalar sqrt(const dimensionedScalar &ds)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:256
A finiteVolume patch using a polyPatch and a fvBoundaryMesh.
Definition: fvPatch.H:61
dimensionedScalar pow025(const dimensionedScalar &ds)
Abstract base class with a fat-interface to all derived classes covering all possible ways in which t...
Definition: fvPatchField.H:66
label k
Boltzmann constant.
scalar yPlusLam(const scalar kappa, const scalar E)
Calculate the Y+ at the edge of the laminar sublayer.
virtual void evaluate(const Pstream::commsTypes)
Evaluate the patchField.
const Type & lookupObject(const word &name) const
Lookup and return the object of the given Type.
const dimensionedScalar kappa
Coulomb constant: default SI units: [N.m2/C2].
Abstract base class for turbulence models (RAS, LES and laminar).
const word & name() const
Return name.
Definition: fvPatch.H:149
Macros for easy insertion into run-time selection tables.
virtual tmp< volScalarField > k() const =0
Return the turbulence kinetic energy.
scalar uTau
scalar y
static const word propertiesName
Default name of the turbulence properties dictionary.
virtual const labelUList & faceCells() const
Return faceCells.
Definition: fvPatch.C:93
static word groupName(Name name, const word &group)
Foam::fvPatchFieldMapper.
const nearWallDist & y() const
Return the near wall distances.
v2WallFunctionFvPatchScalarField(const fvPatch &, const DimensionedField< scalar, volMesh > &)
Construct from patch and internal field.
errorManip< error > abort(error &err)
Definition: errorManip.H:131
const fvPatch & patch() const
Return patch.
Definition: fvPatchField.H:340
makePatchTypeField(fvPatchScalarField, fWallFunctionFvPatchScalarField)
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
static const char nl
Definition: Ostream.H:265
Ostream & writeKeyword(const keyType &)
Write the keyword followed by an appropriate indentation.
Definition: Ostream.C:54
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field, sets Updated to false.
Definition: fvPatchField.C:331
label patchi
T lookupOrDefault(const word &, const T &, bool recursive=false, bool patternMatch=true) const
Find and return a T,.
scalar yPlus
virtual void updateCoeffs()
Update the coefficients associated with the patch field.
Definition: fvPatchField.C:311
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
dimensionedScalar pow4(const dimensionedScalar &ds)
const objectRegistry & db() const
Return local objectRegistry.
Definition: fvPatchField.C:197
volScalarField & p
A class for managing temporary objects.
Definition: PtrList.H:53
virtual void checkType()
Check the type of the patch.
Namespace for OpenFOAM.
const DimensionedField< Type, volMesh > & internalField() const
Return dimensioned internal field reference.
Definition: fvPatchField.H:347