initial commit for version 1.5.x patch release
[OpenFOAM-1.5.x.git] / applications / solvers / combustion / PDRFoam / XiModels / algebraic / algebraic.C
blobef615cec31e5443f965cb33eb2191e80a1c599e3
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2008 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 "algebraic.H"
28 #include "addToRunTimeSelectionTable.H"
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 namespace Foam
34 namespace XiModels
36     defineTypeNameAndDebug(algebraic, 0);
37     addToRunTimeSelectionTable(XiModel, algebraic, dictionary);
42 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
44 Foam::XiModels::algebraic::algebraic
46     const dictionary& XiProperties,
47     const hhuCombustionThermo& thermo,
48     const compressible::RASModel& turbulence,
49     const volScalarField& Su,
50     const volScalarField& rho,
51     const volScalarField& b,
52     const surfaceScalarField& phi
55     XiModel(XiProperties, thermo, turbulence, Su, rho, b, phi),
56     XiShapeCoef(readScalar(XiModelCoeffs_.lookup("XiShapeCoef"))),
57     XiEqModel_(XiEqModel::New(XiProperties, thermo, turbulence, Su)),
58     XiGModel_(XiGModel::New(XiProperties, thermo, turbulence, Su))
62 // * * * * * * * * * * * * * * * * Destructors * * * * * * * * * * * * * * * //
64 Foam::XiModels::algebraic::~algebraic()
68 // * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * * //
70 Foam::tmp<Foam::volScalarField> Foam::XiModels::algebraic::Db() const
72     return XiGModel_->Db();
76 void Foam::XiModels::algebraic::correct()
78     volScalarField XiEqEta = XiEqModel_->XiEq();
79     volScalarField GEta = XiGModel_->G();
81     volScalarField R = GEta*XiEqEta/(XiEqEta - 0.999);
83     volScalarField XiEqStar = R/(R - GEta);
85     Xi_ == 1.0 + (1.0 + (2*XiShapeCoef)*(0.5 - b_))*(XiEqStar - 1.0);
89 bool Foam::XiModels::algebraic::read(const dictionary& XiProperties)
91     XiModel::read(XiProperties);
93     XiModelCoeffs_.lookup("XiShapeCoef") >> XiShapeCoef;
94     
95     return true;
99 // ************************************************************************* //