XiCorrModelNew.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) 2024 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 "XiCorrModel.H"
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
31 (
32  const fvMesh& mesh,
33  const dictionary& dict
34 )
35 {
36  const dictionary& XiCorrDict = dict.subDict("XiCorr");
37 
38  const word type(XiCorrDict.lookup("type"));
39 
40  Info<< "Selecting flame-wrinkling correction type "
41  << type << endl;
42 
43  dictionaryConstructorTable::iterator cstrIter =
44  dictionaryConstructorTablePtr_->find(type);
45 
46  if (cstrIter == dictionaryConstructorTablePtr_->end())
47  {
48  FatalIOErrorInFunction(XiCorrDict)
49  << "Unknown XiCorrModel "
50  << type << nl << nl
51  << "Valid XiCorrModels are : " << endl
52  << dictionaryConstructorTablePtr_->sortedToc()
53  << exit(FatalIOError);
54  }
55 
57  (
58  cstrIter()
59  (
60  mesh,
61  XiCorrDict.optionalSubDict(type + "Coeffs")
62  )
63  );
64 }
65 
66 
67 // ************************************************************************* //
static autoPtr< XiCorrModel > New(const fvMesh &mesh, const dictionary &dict)
Return a reference to the selected XiCorrModel model.
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:740
const dictionary & optionalSubDict(const word &) const
Find and return a sub-dictionary if found.
Definition: dictionary.C:927
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:96
A class for handling words, derived from string.
Definition: word.H:62
Foam::fvMesh mesh(Foam::IOobject(regionName, runTime.name(), runTime, Foam::IOobject::MUST_READ), false)
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:346
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:258
messageStream Info
IOerror FatalIOError
static const char nl
Definition: Ostream.H:267
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
dictionary dict