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