initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / applications / solvers / combustion / PDRFoam / PDRModels / XiEqModels / basicXiSubXiEq / basicXiSubXiEq.C
blob20fb3e22a0106e328aa2e94f34790986c50a32b8
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.
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.
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.
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
25 \*---------------------------------------------------------------------------*/
27 #include "basicXiSubXiEq.H"
28 #include "addToRunTimeSelectionTable.H"
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 namespace Foam
34 namespace XiEqModels
36     defineTypeNameAndDebug(basicSubGrid, 0);
37     addToRunTimeSelectionTable(XiEqModel, basicSubGrid, dictionary);
42 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
44 Foam::XiEqModels::basicSubGrid::basicSubGrid
46     const dictionary& XiEqProperties,
47     const hhuCombustionThermo& thermo,
48     const compressible::RASModel& turbulence,
49     const volScalarField& Su
52     XiEqModel(XiEqProperties, thermo, turbulence, Su),
54     N_
55     (
56         IOobject
57         (
58             "N",
59             Su.mesh().time().findInstance(polyMesh::meshSubDir, "N"),
60             polyMesh::meshSubDir,
61             Su.mesh(),
62             IOobject::MUST_READ,
63             IOobject::NO_WRITE
64         ),
65         Su.mesh()
66     ),
68     ns_
69     (
70         IOobject
71         (
72             "ns",
73             Su.mesh().time().findInstance(polyMesh::meshSubDir, "ns"),
74             polyMesh::meshSubDir,
75             Su.mesh(),
76             IOobject::MUST_READ,
77             IOobject::NO_WRITE
78         ),
79         Su.mesh()
80     ),
82     B_
83     (
84         IOobject
85         (
86             "B",
87             Su.mesh().time().findInstance(polyMesh::meshSubDir, "B"),
88             polyMesh::meshSubDir,
89             Su.mesh(),
90             IOobject::MUST_READ,
91             IOobject::NO_WRITE
92         ),
93         Su.mesh()
94     ),
96     Lobs_
97     (
98         IOobject
99         (
100             "Lobs",
101             Su.mesh().time().findInstance(polyMesh::meshSubDir, "Lobs"),
102             polyMesh::meshSubDir,
103             Su.mesh(),
104             IOobject::MUST_READ,
105             IOobject::NO_WRITE
106         ),
107         Su.mesh()
108     ),
110     XiEqModel_(XiEqModel::New(XiEqModelCoeffs_, thermo, turbulence, Su))
114 // * * * * * * * * * * * * * * * * Destructors * * * * * * * * * * * * * * * //
116 Foam::XiEqModels::basicSubGrid::~basicSubGrid()
120 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
122 Foam::tmp<Foam::volScalarField> Foam::XiEqModels::basicSubGrid::XiEq() const
124     const objectRegistry& db = Su_.db();
125     const volVectorField& U = db.lookupObject<volVectorField>("U");
127     volScalarField magU = mag(U);
128     volVectorField Uhat =
129     U/(mag(U) + dimensionedScalar("Usmall", U.dimensions(), 1e-4));
131     volScalarField n = max(N_ - (Uhat & ns_ & Uhat), scalar(1e-4));
133     volScalarField b = (Uhat & B_ & Uhat)/n;
135     volScalarField up = sqrt((2.0/3.0)*turbulence_.k());
137     volScalarField XiSubEq =
138         scalar(1)
139       + max(2.2*sqrt(b), min(0.34*magU/up, scalar(1.6)))
140        *min(0.25*n, scalar(1));
142     return XiSubEq*XiEqModel_->XiEq();
146 bool Foam::XiEqModels::basicSubGrid::read(const dictionary& XiEqProperties)
148     XiEqModel::read(XiEqProperties);
150     return XiEqModel_->read(XiEqModelCoeffs_);
154 // ************************************************************************* //