LESfilter.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-2022 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 "LESfilter.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
34 }
35 
36 
37 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
38 
40 (
41  const fvMesh& mesh,
42  const dictionary& dict,
43  const word& filterDictName
44 )
45 {
46  const word filterType(dict.lookup(filterDictName));
47 
48  dictionaryConstructorTable::iterator cstrIter =
49  dictionaryConstructorTablePtr_->find(filterType);
50 
51  if (cstrIter == dictionaryConstructorTablePtr_->end())
52  {
54  << "Unknown LESfilter type "
55  << filterType << nl << nl
56  << "Valid LESfilter types are :" << endl
57  << dictionaryConstructorTablePtr_->sortedToc()
58  << exit(FatalError);
59  }
60 
61  return autoPtr<LESfilter>(cstrIter()(mesh, dict));
62 }
63 
64 
65 // ************************************************************************* //
Abstract class for LES filters.
Definition: LESfilter.H:55
const fvMesh & mesh() const
Return mesh reference.
Definition: LESfilter.H:130
static autoPtr< LESfilter > New(const fvMesh &, const dictionary &, const word &filterDictName="filter")
Return a reference to the selected LES filter.
Definition: LESfilter.C:40
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
A class for handling words, derived from string.
Definition: word.H:62
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:334
Namespace for OpenFOAM.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:257
defineTypeNameAndDebug(combustionModel, 0)
error FatalError
static const char nl
Definition: Ostream.H:266
dictionary dict