src/turbulenceModels/incompressible/RAS/RASModel/RASModel.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "RASModel.H"
  27 #include "addToRunTimeSelectionTable.H"
  28
  29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33 namespace incompressible
  34 {
  35
  36 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  37
  38 defineTypeNameAndDebug(RASModel, 0);
  39 defineRunTimeSelectionTable(RASModel, dictionary);
  40 addToRunTimeSelectionTable(turbulenceModel, RASModel, turbulenceModel);
  41
  42 // * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
  43
  44 void RASModel::printCoeffs()
  45 {
  46     if (printCoeffs_)
  47     {
  48         Info<< type() << "Coeffs" << coeffDict_ << endl;
  49     }
  50 }
  51
  52
  53 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  54
  55 RASModel::RASModel
  56 (
  57     const word& type,
  58     const volVectorField& U,
  59     const surfaceScalarField& phi,
  60     transportModel& lamTransportModel
  61 )
  62 :
  63     turbulenceModel(U, phi, lamTransportModel),
  64
  65     IOdictionary
  66     (
  67         IOobject
  68         (
  69             "RASProperties",
  70             U.time().constant(),
  71             U.db(),
  72             IOobject::MUST_READ,
  73             IOobject::NO_WRITE
  74         )
  75     ),
  76
  77     turbulence_(lookup("turbulence")),
  78     printCoeffs_(lookupOrDefault<Switch>("printCoeffs", false)),
  79     coeffDict_(subOrEmptyDict(type + "Coeffs")),
  80
  81     k0_("k0", dimVelocity*dimVelocity, SMALL),
  82     epsilon0_("epsilon0", k0_.dimensions()/dimTime, SMALL),
  83     epsilonSmall_("epsilonSmall", epsilon0_.dimensions(), SMALL),
  84     omega0_("omega0", dimless/dimTime, SMALL),
  85     omegaSmall_("omegaSmall", omega0_.dimensions(), SMALL),
  86     nuRatio_(lookupOrDefault<scalar>("nuRatio", 1e4)),
  87
  88     y_(mesh_)
  89 {
  90     // Force the construction of the mesh deltaCoeffs which may be needed
  91     // for the construction of the derived models and BCs
  92     mesh_.deltaCoeffs();
  93 }
  94
  95
  96 // * * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * //
  97
  98 autoPtr<RASModel> RASModel::New
  99 (
 100     const volVectorField& U,
 101     const surfaceScalarField& phi,
 102     transportModel& transport
 103 )
 104 {
 105     word modelName;
 106
 107     // Enclose the creation of the dictionary to ensure it is deleted
 108     // before the turbulenceModel is created otherwise the dictionary is
 109     // entered in the database twice
 110     {
 111         IOdictionary dict
 112         (
 113             IOobject
 114             (
 115                 "RASProperties",
 116                 U.time().constant(),
 117                 U.db(),
 118                 IOobject::MUST_READ,
 119                 IOobject::NO_WRITE
 120             )
 121         );
 122
 123         dict.lookup("RASModel") >> modelName;
 124     }
 125
 126     Info<< "Selecting RAS turbulence model " << modelName << endl;
 127
 128     dictionaryConstructorTable::iterator cstrIter =
 129         dictionaryConstructorTablePtr_->find(modelName);
 130
 131     if (cstrIter == dictionaryConstructorTablePtr_->end())
 132     {
 133         FatalErrorIn
 134         (
 135             "RASModel::New(const volVectorField&, "
 136             "const surfaceScalarField&, transportModel&)"
 137         )   << "Unknown RASModel type " << modelName
 138             << endl << endl
 139             << "Valid RASModel types are :" << endl
 140             << dictionaryConstructorTablePtr_->sortedToc()
 141             << exit(FatalError);
 142     }
 143
 144     return autoPtr<RASModel>(cstrIter()(U, phi, transport));
 145 }
 146
 147
 148 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 149
 150
 151 scalar RASModel::yPlusLam(const scalar kappa, const scalar E) const
 152 {
 153     scalar ypl = 11.0;
 154
 155     for (int i=0; i<10; i++)
 156     {
 157         ypl = log(max(E*ypl, 1))/kappa;
 158     }
 159
 160     return ypl;
 161 }
 162
 163
 164 tmp<volScalarField> RASModel::nuEff() const
 165 {
 166     tmp<volScalarField> tnuEff
 167     (
 168         new volScalarField("nuEff", nut() + nu())
 169     );
 170
 171     // Apply nut limiter
 172     tnuEff().internalField() =
 173         Foam::min(tnuEff().internalField(), nuRatio_*nu().internalField());
 174
 175     return tnuEff;
 176 }
 177
 178
 179 tmp<scalarField> RASModel::yPlus(const label patchNo, const scalar Cmu) const
 180 {
 181     const fvPatch& curPatch = mesh_.boundary()[patchNo];
 182
 183     tmp<scalarField> tYp(new scalarField(curPatch.size()));
 184     scalarField& Yp = tYp();
 185
 186     if (curPatch.isWall())
 187     {
 188         Yp = pow(Cmu, 0.25)
 189             *y_[patchNo]
 190             *sqrt(k()().boundaryField()[patchNo].patchInternalField())
 191             /nu().boundaryField()[patchNo];
 192     }
 193     else
 194     {
 195         WarningIn
 196         (
 197             "tmp<scalarField> RASModel::yPlus(const label patchNo) const"
 198         )   << "Patch " << patchNo << " is not a wall. Returning null field"
 199             << nl << endl;
 200
 201         Yp.setSize(0);
 202     }
 203
 204     return tYp;
 205 }
 206
 207
 208 void RASModel::correct()
 209 {
 210     turbulenceModel::correct();
 211
 212     if (turbulence_ && mesh_.changing())
 213     {
 214         y_.correct();
 215     }
 216 }
 217
 218
 219 bool RASModel::read()
 220 {
 221     if (regIOobject::read())
 222     {
 223         lookup("turbulence") >> turbulence_;
 224
 225         if (const dictionary* dictPtr = subDictPtr(type() + "Coeffs"))
 226         {
 227             coeffDict_ <<= *dictPtr;
 228         }
 229
 230         k0_.readIfPresent(*this);
 231         epsilon0_.readIfPresent(*this);
 232         epsilonSmall_.readIfPresent(*this);
 233         omega0_.readIfPresent(*this);
 234         omegaSmall_.readIfPresent(*this);
 235         readIfPresent("nuRatio", nuRatio_);
 236
 237         return true;
 238     }
 239     else
 240     {
 241         return false;
 242     }
 243 }
 244
 245
 246 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 247
 248 } // End namespace incompressible
 249 } // End namespace Foam
 250
 251 // ************************************************************************* //