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) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 \*---------------------------------------------------------------------------*/
  26
  27 #include "LESModel.H"
  28 #include "addToRunTimeSelectionTable.H"
  29
  30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34 namespace compressible
  35 {
  36
  37 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  38
  39 defineTypeNameAndDebug(LESModel, 0);
  40 defineRunTimeSelectionTable(LESModel, dictionary);
  41 addToRunTimeSelectionTable(turbulenceModel, LESModel, turbulenceModel);
  42
  43 // * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
  44
  45 void LESModel::printCoeffs()
  46 {
  47     if (printCoeffs_)
  48     {
  49         Info<< type() << "Coeffs" << coeffDict_ << endl;
  50     }
  51 }
  52
  53
  54 // * * * * * * * * * * * * * * * Constructor * * * * * * * * * * * * * * * * //
  55
  56 LESModel::LESModel
  57 (
  58     const word& type,
  59     const volScalarField& rho,
  60     const volVectorField& U,
  61     const surfaceScalarField& phi,
  62     const basicThermo& thermoPhysicalModel
  63 )
  64 :
  65     turbulenceModel(rho, U, phi, thermoPhysicalModel),
  66
  67     IOdictionary
  68     (
  69         IOobject
  70         (
  71             "LESProperties",
  72             U.time().constant(),
  73             U.db(),
  74             IOobject::MUST_READ,
  75             IOobject::NO_WRITE
  76         )
  77     ),
  78
  79     printCoeffs_(lookupOrDefault<Switch>("printCoeffs", false)),
  80     coeffDict_(subOrEmptyDict(type + "Coeffs")),
  81
  82     k0_("k0", dimVelocity*dimVelocity, SMALL),
  83
  84     delta_(LESdelta::New("delta", U.mesh(), *this))
  85 {
  86     readIfPresent("k0", k0_);
  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 )
 103 {
 104     word modelName;
 105
 106     // Enclose the creation of the dictionary to ensure it is deleted
 107     // before the turbulenceModel is created otherwise the dictionary is
 108     // entered in the database twice
 109     {
 110         IOdictionary dict
 111         (
 112             IOobject
 113             (
 114                 "LESProperties",
 115                 U.time().constant(),
 116                 U.db(),
 117                 IOobject::MUST_READ,
 118                 IOobject::NO_WRITE
 119             )
 120         );
 121
 122         dict.lookup("LESModel") >> modelName;
 123     }
 124
 125     Info<< "Selecting LES turbulence model " << modelName << endl;
 126
 127     dictionaryConstructorTable::iterator cstrIter =
 128         dictionaryConstructorTablePtr_->find(modelName);
 129
 130     if (cstrIter == dictionaryConstructorTablePtr_->end())
 131     {
 132         FatalErrorIn
 133         (
 134             "LESModel::New(const volVectorField& U, const "
 135             "surfaceScalarField& phi, const basicThermo&)"
 136         )   << "Unknown LESModel type " << modelName
 137             << endl << endl
 138             << "Valid LESModel types are :" << endl
 139             << dictionaryConstructorTablePtr_->toc()
 140             << exit(FatalError);
 141     }
 142
 143     return autoPtr<LESModel>(cstrIter()(rho, U, phi, thermoPhysicalModel));
 144 }
 145
 146
 147 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 148
 149 void LESModel::correct(const tmp<volTensorField>&)
 150 {
 151     delta_().correct();
 152 }
 153
 154
 155 void LESModel::correct()
 156 {
 157     correct(fvc::grad(U_));
 158 }
 159
 160
 161 bool LESModel::read()
 162 {
 163     if (regIOobject::read())
 164     {
 165         if (const dictionary* dictPtr = subDictPtr(type() + "Coeffs"))
 166         {
 167             coeffDict_ <<= *dictPtr;
 168         }
 169
 170         readIfPresent("k0", k0_);
 171
 172         delta_().read(*this);
 173
 174         return true;
 175     }
 176     else
 177     {
 178         return false;
 179     }
 180 }
 181
 182
 183 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 184
 185 } // End namespace compressible
 186 } // End namespace Foam
 187
 188 // ************************************************************************* //