TimeScaleModel.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) 2013-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 "TimeScaleModel.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  defineTypeNameAndDebug(TimeScaleModel, 0);
33  defineRunTimeSelectionTable(TimeScaleModel, dictionary);
34 }
35 
36 
37 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
38 
40 (
41  const dictionary& dict
42 )
43 :
44  alphaPacked_(dict.template lookup<scalar>("alphaPacked")),
45  e_(dict.template lookup<scalar>("e"))
46 {
47 }
48 
49 
51 (
52  const TimeScaleModel& cm
53 )
54 :
55  alphaPacked_(cm.alphaPacked_),
56  e_(cm.e_)
57 {
58 }
59 
60 
61 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
62 
64 (
65  const dictionary& dict
66 )
67 {
68  word modelType(dict.lookup("type"));
69 
70  Info<< "Selecting time scale model " << modelType << endl;
71 
72  dictionaryConstructorTable::iterator cstrIter =
73  dictionaryConstructorTablePtr_->find(modelType);
74 
75  if (cstrIter == dictionaryConstructorTablePtr_->end())
76  {
78  << "Unknown time scale model type " << modelType
79  << ", constructor not in hash table" << nl << nl
80  << " Valid time scale model types are:" << nl
81  << dictionaryConstructorTablePtr_->sortedToc()
82  << abort(FatalError);
83  }
84 
85  return autoPtr<TimeScaleModel>(cstrIter()(dict));
86 }
87 
88 
89 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
90 
92 {}
93 
94 
95 // ************************************************************************* //
dictionary dict
static autoPtr< TimeScaleModel > New(const dictionary &dict)
Selector.
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
scalar e_
Coefficient of restitution.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
virtual ~TimeScaleModel()
Destructor.
A class for handling words, derived from string.
Definition: word.H:59
TimeScaleModel(const dictionary &dict)
Constructors.
errorManip< error > abort(error &err)
Definition: errorManip.H:131
static const char nl
Definition: Ostream.H:260
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
Base class for time scale models.
messageStream Info
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
scalar alphaPacked_
Close pack volume fraction.