XiEqModelNew.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2026 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 "XiEqModel.H"
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
31 (
32  const dictionary& XiDict,
33  const ubRhoThermo& thermo,
35  const volScalarField& Su
36 )
37 {
38  const dictionary& XiEqDict = XiDict.subDict("eq");
39 
40  const word modelType(XiEqDict.lookup("model"));
41 
42  Info<< indentOrNl << "Selecting equilibrium flame-wrinkling XiEq model "
43  << modelType << endl;
44 
45  dictionaryConstructorTable::iterator cstrIter =
46  dictionaryConstructorTablePtr_->find(modelType);
47 
48  if (cstrIter == dictionaryConstructorTablePtr_->end())
49  {
50  FatalIOErrorInFunction(XiEqDict)
51  << "Unknown XiEq model "
52  << modelType << nl << nl
53  << "Valid XiEq models are : " << endl
54  << dictionaryConstructorTablePtr_->sortedToc()
55  << exit(FatalIOError);
56  }
57 
58  printDictionary print
59  (
60  XiEqDict,
61  XiEqDict.optionalTypeDict(modelType)
62  );
63 
64  return autoPtr<XiEqModel>
65  (
66  cstrIter()
67  (
68  XiEqDict.optionalTypeDict(modelType),
69  thermo,
70  turbulence,
71  Su
72  )
73  );
74 }
75 
76 
77 // ************************************************************************* //
Generic GeometricField class.
static autoPtr< XiEqModel > New(const dictionary &XiProperties, const ubRhoThermo &thermo, const compressibleMomentumTransportModel &turbulence, const volScalarField &Su)
Return a reference to the selected XiEq model.
Definition: XiEqModelNew.C:31
Base class for single-phase compressible momentum transport models.
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:669
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:778
const dictionary & optionalTypeDict(const word &typeName) const
Find and return an optional type sub-dictionary.
Definition: dictionary.C:921
Enables the printing of a dictionary and subsequently looked-up defaulted entries.
A class for handling words, derived from string.
Definition: word.H:63
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:346
tmp< VolField< Type > > Su(const VolField< Type > &su, const VolField< Type > &vf)
Definition: fvcSup.C:44
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:288
messageStream Info
IOerror FatalIOError
Ostream & indentOrNl(Ostream &os)
Indent stream or add newline if indent level == 0.
Definition: Ostream.H:250
static const char nl
Definition: Ostream.H:297
autoPtr< incompressible::momentumTransportModel > turbulence(incompressible::momentumTransportModel::New(U, phi, viscosity))
fluidMulticomponentThermo & thermo
Definition: createFields.H:15