src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.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 "alphatFilmWallFunctionFvPatchScalarField.H"
  27 #include "RASModel.H"
  28 #include "surfaceFilmModel.H"
  29 #include "fvPatchFieldMapper.H"
  30 #include "volFields.H"
  31 #include "addToRunTimeSelectionTable.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 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  45
  46 alphatFilmWallFunctionFvPatchScalarField::
  47 alphatFilmWallFunctionFvPatchScalarField
  48 (
  49     const fvPatch& p,
  50     const DimensionedField<scalar, volMesh>& iF
  51 )
  52 :
  53     fixedValueFvPatchScalarField(p, iF),
  54     B_(5.5),
  55     yPlusCrit_(11.05),
  56     Cmu_(0.09),
  57     kappa_(0.41),
  58     Prt_(0.85)
  59 {}
  60
  61
  62 alphatFilmWallFunctionFvPatchScalarField::
  63 alphatFilmWallFunctionFvPatchScalarField
  64 (
  65     const alphatFilmWallFunctionFvPatchScalarField& ptf,
  66     const fvPatch& p,
  67     const DimensionedField<scalar, volMesh>& iF,
  68     const fvPatchFieldMapper& mapper
  69 )
  70 :
  71     fixedValueFvPatchScalarField(ptf, p, iF, mapper),
  72     B_(ptf.B_),
  73     yPlusCrit_(ptf.yPlusCrit_),
  74     Cmu_(ptf.Cmu_),
  75     kappa_(ptf.kappa_),
  76     Prt_(ptf.Prt_)
  77 {}
  78
  79
  80 alphatFilmWallFunctionFvPatchScalarField::
  81 alphatFilmWallFunctionFvPatchScalarField
  82 (
  83     const fvPatch& p,
  84     const DimensionedField<scalar, volMesh>& iF,
  85     const dictionary& dict
  86 )
  87 :
  88     fixedValueFvPatchScalarField(p, iF, dict),
  89     B_(dict.lookupOrDefault("B", 5.5)),
  90     yPlusCrit_(dict.lookupOrDefault("yPlusCrit", 11.05)),
  91     Cmu_(dict.lookupOrDefault("Cmu", 0.09)),
  92     kappa_(dict.lookupOrDefault("kappa", 0.41)),
  93     Prt_(dict.lookupOrDefault("Prt", 0.85))
  94 {}
  95
  96
  97 alphatFilmWallFunctionFvPatchScalarField::
  98 alphatFilmWallFunctionFvPatchScalarField
  99 (
 100     const alphatFilmWallFunctionFvPatchScalarField& fwfpsf
 101 )
 102 :
 103     fixedValueFvPatchScalarField(fwfpsf),
 104     B_(fwfpsf.B_),
 105     yPlusCrit_(fwfpsf.yPlusCrit_),
 106     Cmu_(fwfpsf.Cmu_),
 107     kappa_(fwfpsf.kappa_),
 108     Prt_(fwfpsf.Prt_)
 109 {}
 110
 111
 112 alphatFilmWallFunctionFvPatchScalarField::
 113 alphatFilmWallFunctionFvPatchScalarField
 114 (
 115     const alphatFilmWallFunctionFvPatchScalarField& fwfpsf,
 116     const DimensionedField<scalar, volMesh>& iF
 117 )
 118 :
 119     fixedValueFvPatchScalarField(fwfpsf, iF),
 120     B_(fwfpsf.B_),
 121     yPlusCrit_(fwfpsf.yPlusCrit_),
 122     Cmu_(fwfpsf.Cmu_),
 123     kappa_(fwfpsf.kappa_),
 124     Prt_(fwfpsf.Prt_)
 125 {}
 126
 127
 128 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 129
 130 void alphatFilmWallFunctionFvPatchScalarField::updateCoeffs()
 131 {
 132     if (updated())
 133     {
 134         return;
 135     }
 136
 137     typedef regionModels::surfaceFilmModels::surfaceFilmModel modelType;
 138
 139     // Since we're inside initEvaluate/evaluate there might be processor
 140     // comms underway. Change the tag we use.
 141     int oldTag = UPstream::msgType();
 142     UPstream::msgType() = oldTag+1;
 143
 144     bool ok =
 145         db().objectRegistry::foundObject<modelType>("surfaceFilmProperties");
 146
 147     if (!ok)
 148     {
 149         // do nothing on construction - film model doesn't exist yet
 150         return;
 151     }
 152
 153     const label patchI = patch().index();
 154
 155     // Retrieve phase change mass from surface film model
 156     const modelType& filmModel =
 157         db().objectRegistry::lookupObject<modelType>("surfaceFilmProperties");
 158
 159     const label filmPatchI = filmModel.regionPatchID(patchI);
 160
 161     const mapDistribute& distMap = filmModel.mappedPatches()[filmPatchI].map();
 162
 163     tmp<volScalarField> mDotFilm(filmModel.primaryMassTrans());
 164     scalarField mDotFilmp = mDotFilm().boundaryField()[filmPatchI];
 165     distMap.distribute(mDotFilmp);
 166
 167     // Retrieve RAS turbulence model
 168     const RASModel& rasModel = db().lookupObject<RASModel>("RASProperties");
 169
 170     const scalarField& y = rasModel.y()[patchI];
 171     const scalarField& rhow = rasModel.rho().boundaryField()[patchI];
 172     const tmp<volScalarField> tk = rasModel.k();
 173     const volScalarField& k = tk();
 174     const scalarField& muw = rasModel.mu().boundaryField()[patchI];
 175     const scalarField& alphaw = rasModel.alpha().boundaryField()[patchI];
 176
 177     const scalar Cmu25 = pow(Cmu_, 0.25);
 178
 179     // Populate alphat field values
 180     scalarField& alphat = *this;
 181     forAll(alphat, faceI)
 182     {
 183         label faceCellI = patch().faceCells()[faceI];
 184
 185         scalar uTau = Cmu25*sqrt(k[faceCellI]);
 186
 187         scalar yPlus = y[faceI]*uTau/(muw[faceI]/rhow[faceI]);
 188
 189         scalar Pr = muw[faceI]/alphaw[faceI];
 190
 191         scalar factor = 0.0;
 192         scalar mStar = mDotFilmp[faceI]/(y[faceI]*uTau);
 193         if (yPlus > yPlusCrit_)
 194         {
 195             scalar expTerm = exp(min(50.0, yPlusCrit_*mStar*Pr));
 196             scalar yPlusRatio = yPlus/yPlusCrit_;
 197             scalar powTerm = mStar*Prt_/kappa_;
 198             factor =
 199                 mStar/(expTerm*(pow(yPlusRatio, powTerm)) - 1.0 + ROOTVSMALL);
 200         }
 201         else
 202         {
 203             scalar expTerm = exp(min(50.0, yPlus*mStar*Pr));
 204             factor = mStar/(expTerm - 1.0 + ROOTVSMALL);
 205         }
 206
 207         scalar dx = patch().deltaCoeffs()[faceI];
 208
 209         scalar alphaEff = dx*rhow[faceI]*uTau*factor;
 210
 211         alphat[faceI] = max(alphaEff - alphaw[faceI], 0.0);
 212     }
 213
 214     // Restore tag
 215     UPstream::msgType() = oldTag;
 216
 217     fixedValueFvPatchScalarField::updateCoeffs();
 218 }
 219
 220
 221
 222 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 223
 224 void alphatFilmWallFunctionFvPatchScalarField::write(Ostream& os) const
 225 {
 226     fvPatchField<scalar>::write(os);
 227     os.writeKeyword("B") << B_ << token::END_STATEMENT << nl;
 228     os.writeKeyword("yPlusCrit") << yPlusCrit_ << token::END_STATEMENT << nl;
 229     os.writeKeyword("Cmu") << Cmu_ << token::END_STATEMENT << nl;
 230     os.writeKeyword("kappa") << kappa_ << token::END_STATEMENT << nl;
 231     os.writeKeyword("Prt") << Prt_ << token::END_STATEMENT << nl;
 232     writeEntry("value", os);
 233 }
 234
 235
 236 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 237
 238 makePatchTypeField
 239 (
 240     fvPatchScalarField,
 241     alphatFilmWallFunctionFvPatchScalarField
 242 );
 243
 244 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 245
 246 } // End namespace RASModels
 247 } // End namespace compressible
 248 } // End namespace Foam
 249
 250 // ************************************************************************* //