TimeScaleModel.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2013-2015 OpenFOAM Foundation
9  Copyright (C) 2019-2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #include "TimeScaleModel.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35  defineTypeNameAndDebug(TimeScaleModel, 0);
36  defineRunTimeSelectionTable(TimeScaleModel, dictionary);
37 }
38 
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  const dictionary& dict
45 )
46 :
47  alphaPacked_(dict.get<scalar>("alphaPacked")),
48  e_(dict.get<scalar>("e"))
49 {
50 }
51 
52 
54 (
55  const TimeScaleModel& cm
56 )
57 :
58  alphaPacked_(cm.alphaPacked_),
59  e_(cm.e_)
60 {
61 }
62 
63 
64 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
65 
67 (
68  const dictionary& dict
69 )
70 {
71  const word modelType(dict.get<word>("type"));
72 
73  Info<< "Selecting time scale model " << modelType << endl;
74 
75  auto* ctorPtr = dictionaryConstructorTable(modelType);
76 
77  if (!ctorPtr)
78  {
80  (
81  dict,
82  "time scale model",
83  modelType,
84  *dictionaryConstructorTablePtr_
85  ) << abort(FatalIOError);
86  }
87 
88  return autoPtr<TimeScaleModel>(ctorPtr(dict));
89 }
90 
91 
92 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
93 
95 {}
96 
97 
98 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Foam::TimeScaleModel::~TimeScaleModel
virtual ~TimeScaleModel()
Destructor.
Definition: TimeScaleModel.C:94
TimeScaleModel.H
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::TimeScaleModel::e_
scalar e_
Coefficient of restitution.
Definition: TimeScaleModel.H:75
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::TimeScaleModel::TimeScaleModel
TimeScaleModel(const dictionary &dict)
Constructors.
Definition: TimeScaleModel.C:43
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
Foam::autoPtr< Foam::TimeScaleModel >
Foam::TimeScaleModel
Base class for time scale models.
Definition: TimeScaleModel.H:57
Foam::TimeScaleModel::alphaPacked_
scalar alphaPacked_
Close pack volume fraction.
Definition: TimeScaleModel.H:72
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::TimeScaleModel::New
static autoPtr< TimeScaleModel > New(const dictionary &dict)
Selector.
Definition: TimeScaleModel.C:67