src/turbulenceModels/compressible/LES/LESModel/LESModel.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 "LESModel.H"
  27 #include "addToRunTimeSelectionTable.H"
  28
  29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33 namespace compressible
  34 {
  35
  36 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  37
  38 defineTypeNameAndDebug(LESModel, 0);
  39 defineRunTimeSelectionTable(LESModel, dictionary);
  40 addToRunTimeSelectionTable(turbulenceModel, LESModel, turbulenceModel);
  41
  42 // * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
  43
  44 void LESModel::printCoeffs()
  45 {
  46     if (printCoeffs_)
  47     {
  48         Info<< type() << "Coeffs" << coeffDict_ << endl;
  49     }
  50 }
  51
  52
  53 // * * * * * * * * * * * * * * * Constructor * * * * * * * * * * * * * * * * //
  54
  55 LESModel::LESModel
  56 (
  57     const word& type,
  58     const volScalarField& rho,
  59     const volVectorField& U,
  60     const surfaceScalarField& phi,
  61     const basicThermo& thermoPhysicalModel,
  62     const word& turbulenceModelName
  63 )
  64 :
  65     turbulenceModel(rho, U, phi, thermoPhysicalModel, turbulenceModelName),
  66
  67     IOdictionary
  68     (
  69         IOobject
  70         (
  71             "LESProperties",
  72             U.time().constant(),
  73             U.db(),
  74             IOobject::MUST_READ_IF_MODIFIED,
  75             IOobject::NO_WRITE
  76         )
  77     ),
  78
  79     printCoeffs_(lookupOrDefault<Switch>("printCoeffs", false)),
  80     coeffDict_(subOrEmptyDict(type + "Coeffs")),
  81
  82     kMin_("kMin", sqr(dimVelocity), SMALL),
  83
  84     delta_(LESdelta::New("delta", U.mesh(), *this))
  85 {
  86     kMin_.readIfPresent(*this);
  87
  88     // Force the construction of the mesh deltaCoeffs which may be needed
  89     // for the construction of the derived models and BCs
  90     mesh_.deltaCoeffs();
  91 }
  92
  93
  94 // * * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * //
  95
  96 autoPtr<LESModel> LESModel::New
  97 (
  98     const volScalarField& rho,
  99     const volVectorField& U,
 100     const surfaceScalarField& phi,
 101     const basicThermo& thermoPhysicalModel,
 102     const word& turbulenceModelName
 103 )
 104 {
 105     // get model name, but do not register the dictionary
 106     // otherwise it is registered in the database twice
 107     const word modelType
 108     (
 109         IOdictionary
 110         (
 111             IOobject
 112             (
 113                 "LESProperties",
 114                 U.time().constant(),
 115                 U.db(),
 116                 IOobject::MUST_READ_IF_MODIFIED,
 117                 IOobject::NO_WRITE,
 118                 false
 119             )
 120         ).lookup("LESModel")
 121     );
 122
 123     Info<< "Selecting LES turbulence model " << modelType << endl;
 124
 125     dictionaryConstructorTable::iterator cstrIter =
 126         dictionaryConstructorTablePtr_->find(modelType);
 127
 128     if (cstrIter == dictionaryConstructorTablePtr_->end())
 129     {
 130         FatalErrorIn
 131         (
 132             "LESModel::New"
 133             "("
 134                 "const volScalarField&, "
 135                 "const volVectorField&, "
 136                 "const surfaceScalarField&, "
 137                 "const basicThermo&, "
 138                 "const word&"
 139             ")"
 140         )   << "Unknown LESModel type "
 141             << modelType << nl << nl
 142             << "Valid LESModel types:" << endl
 143             << dictionaryConstructorTablePtr_->sortedToc()
 144             << exit(FatalError);
 145     }
 146
 147     return autoPtr<LESModel>
 148     (
 149         cstrIter()(rho, U, phi, thermoPhysicalModel, turbulenceModelName)
 150     );
 151 }
 152
 153
 154 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 155
 156 void LESModel::correct(const tmp<volTensorField>&)
 157 {
 158     delta_().correct();
 159 }
 160
 161
 162 void LESModel::correct()
 163 {
 164     correct(fvc::grad(U_));
 165 }
 166
 167
 168 bool LESModel::read()
 169 {
 170     // Bit of trickery : we are both IOdictionary ('RASProperties') and
 171     // an regIOobject (from the turbulenceModel). Problem is to distinguish
 172     // between the two - we only want to reread the IOdictionary.
 173
 174     bool ok = IOdictionary::readData
 175     (
 176         IOdictionary::readStream
 177         (
 178             IOdictionary::type()
 179         )
 180     );
 181     IOdictionary::close();
 182
 183     if (ok)
 184     {
 185         if (const dictionary* dictPtr = subDictPtr(type() + "Coeffs"))
 186         {
 187             coeffDict_ <<= *dictPtr;
 188         }
 189
 190         kMin_.readIfPresent(*this);
 191
 192         delta_().read(*this);
 193
 194         return true;
 195     }
 196     else
 197     {
 198         return false;
 199     }
 200 }
 201
 202
 203 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 204
 205 } // End namespace compressible
 206 } // End namespace Foam
 207
 208 // ************************************************************************* //