src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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
  26 #include "mutkFilmWallFunctionFvPatchScalarField.H"
  27 #include "fvPatchFieldMapper.H"
  28 #include "volFields.H"
  29 #include "RASModel.H"
  30 #include "addToRunTimeSelectionTable.H"
  31 #include "surfaceFilmModel.H"
  32 #include "directMappedWallPolyPatch.H"
  33 #include "mapDistribute.H"
  34
  35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  36
  37 namespace Foam
  38 {
  39 namespace compressible
  40 {
  41 namespace RASModels
  42 {
  43
  44 // * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * * //
  45
  46 tmp<scalarField> mutkFilmWallFunctionFvPatchScalarField::calcUTau
  47 (
  48     const scalarField& magGradU
  49 ) const
  50 {
  51     tmp<scalarField> tuTau(new scalarField(patch().size(), 0.0));
  52     scalarField& uTau = tuTau();
  53
  54     typedef regionModels::surfaceFilmModels::surfaceFilmModel modelType;
  55
  56     bool ok =
  57         db().objectRegistry::foundObject<modelType>("surfaceFilmProperties");
  58
  59     if (!ok)
  60     {
  61         // do nothing on construction - film model doesn't exist yet
  62         return tuTau;
  63     }
  64
  65     const label patchI = patch().index();
  66
  67     // Retrieve phase change mass from surface film model
  68     const modelType& filmModel =
  69         db().objectRegistry::lookupObject<modelType>("surfaceFilmProperties");
  70
  71     const label filmPatchI = filmModel.regionPatchID(patchI);
  72
  73     const mapDistribute& distMap = filmModel.mappedPatches()[filmPatchI].map();
  74
  75     tmp<volScalarField> mDotFilm(filmModel.primaryMassTrans());
  76     scalarField mDotFilmp = mDotFilm().boundaryField()[filmPatchI];
  77     distMap.distribute(mDotFilmp);
  78
  79
  80     // Retrieve RAS turbulence model
  81     const RASModel& rasModel = db().lookupObject<RASModel>("RASProperties");
  82     const scalarField& y = rasModel.y()[patchI];
  83     const fvPatchScalarField& rhow = rasModel.rho().boundaryField()[patchI];
  84     const fvPatchScalarField& muw = rasModel.mu().boundaryField()[patchI];
  85     const tmp<volScalarField> tk = rasModel.k();
  86     const volScalarField& k = tk();
  87
  88     const scalar Cmu25 = pow(Cmu_, 0.25);
  89
  90     forAll(uTau, faceI)
  91     {
  92         label faceCellI = patch().faceCells()[faceI];
  93
  94         scalar ut = Cmu25*sqrt(k[faceCellI]);
  95
  96         scalar yPlus = y[faceI]*ut/(muw[faceI]/rhow[faceI]);
  97
  98         scalar mStar = mDotFilmp[faceI]/(y[faceI]*ut);
  99
 100         scalar factor = 0.0;
 101         if (yPlus > yPlusCrit_)
 102         {
 103             scalar expTerm = exp(min(50.0, B_*mStar));
 104             scalar powTerm = pow(yPlus, mStar/kappa_);
 105             factor = mStar/(expTerm*powTerm - 1.0 + ROOTVSMALL);
 106         }
 107         else
 108         {
 109             scalar expTerm = exp(min(50.0, mStar));
 110             factor = mStar/(expTerm*yPlus - 1.0 + ROOTVSMALL);
 111         }
 112
 113         uTau[faceI] = sqrt(max(0, magGradU[faceI]*ut*factor));
 114     }
 115
 116     return tuTau;
 117 }
 118
 119
 120 tmp<scalarField> mutkFilmWallFunctionFvPatchScalarField::calcMut() const
 121 {
 122     const label patchI = patch().index();
 123
 124     const RASModel& rasModel = db().lookupObject<RASModel>("RASProperties");
 125     const fvPatchVectorField& Uw = rasModel.U().boundaryField()[patchI];
 126     const scalarField magGradU(mag(Uw.snGrad()));
 127     const scalarField& rhow = rasModel.rho().boundaryField()[patchI];
 128     const scalarField& muw = rasModel.mu().boundaryField()[patchI];
 129
 130     return max
 131     (
 132         scalar(0),
 133         rhow*sqr(calcUTau(magGradU))/(magGradU + ROOTVSMALL) - muw
 134     );
 135 }
 136
 137
 138 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 139
 140 mutkFilmWallFunctionFvPatchScalarField::mutkFilmWallFunctionFvPatchScalarField
 141 (
 142     const fvPatch& p,
 143     const DimensionedField<scalar, volMesh>& iF
 144 )
 145 :
 146     mutkWallFunctionFvPatchScalarField(p, iF),
 147     B_(5.5),
 148     yPlusCrit_(11.05)
 149 {}
 150
 151
 152 mutkFilmWallFunctionFvPatchScalarField::mutkFilmWallFunctionFvPatchScalarField
 153 (
 154     const mutkFilmWallFunctionFvPatchScalarField& ptf,
 155     const fvPatch& p,
 156     const DimensionedField<scalar, volMesh>& iF,
 157     const fvPatchFieldMapper& mapper
 158 )
 159 :
 160     mutkWallFunctionFvPatchScalarField(ptf, p, iF, mapper),
 161     B_(5.5),
 162     yPlusCrit_(11.05)
 163 {}
 164
 165
 166 mutkFilmWallFunctionFvPatchScalarField::mutkFilmWallFunctionFvPatchScalarField
 167 (
 168     const fvPatch& p,
 169     const DimensionedField<scalar, volMesh>& iF,
 170     const dictionary& dict
 171 )
 172 :
 173     mutkWallFunctionFvPatchScalarField(p, iF, dict),
 174     B_(dict.lookupOrDefault("B", 5.5)),
 175     yPlusCrit_(dict.lookupOrDefault("yPlusCrit", 11.05))
 176 {}
 177
 178
 179 mutkFilmWallFunctionFvPatchScalarField::mutkFilmWallFunctionFvPatchScalarField
 180 (
 181     const mutkFilmWallFunctionFvPatchScalarField& wfpsf
 182 )
 183 :
 184     mutkWallFunctionFvPatchScalarField(wfpsf),
 185     B_(wfpsf.B_),
 186     yPlusCrit_(wfpsf.yPlusCrit_)
 187 {}
 188
 189
 190 mutkFilmWallFunctionFvPatchScalarField::mutkFilmWallFunctionFvPatchScalarField
 191 (
 192     const mutkFilmWallFunctionFvPatchScalarField& wfpsf,
 193     const DimensionedField<scalar, volMesh>& iF
 194 )
 195 :
 196     mutkWallFunctionFvPatchScalarField(wfpsf, iF),
 197     B_(wfpsf.B_),
 198     yPlusCrit_(wfpsf.yPlusCrit_)
 199 {}
 200
 201
 202 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 203
 204 tmp<scalarField> mutkFilmWallFunctionFvPatchScalarField::yPlus() const
 205 {
 206     const label patchI = patch().index();
 207
 208     const RASModel& rasModel = db().lookupObject<RASModel>("RASProperties");
 209     const scalarField& y = rasModel.y()[patchI];
 210     const fvPatchVectorField& Uw = rasModel.U().boundaryField()[patchI];
 211     const scalarField& rhow = rasModel.rho().boundaryField()[patchI];
 212     const scalarField& muw = rasModel.mu().boundaryField()[patchI];
 213
 214     return y*calcUTau(mag(Uw.snGrad()))/(muw/rhow);
 215 }
 216
 217
 218 void mutkFilmWallFunctionFvPatchScalarField::write(Ostream& os) const
 219 {
 220     fvPatchField<scalar>::write(os);
 221     writeLocalEntries(os);
 222     os.writeKeyword("B") << B_ << token::END_STATEMENT << nl;
 223     os.writeKeyword("yPlusCrit") << yPlusCrit_ << token::END_STATEMENT << nl;
 224     writeEntry("value", os);
 225 }
 226
 227
 228 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 229
 230 makePatchTypeField(fvPatchScalarField, mutkFilmWallFunctionFvPatchScalarField);
 231
 232 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 233
 234 } // End namespace RASModels
 235 } // End namespace compressible
 236 } // End namespace Foam
 237
 238 // ************************************************************************* //