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-------------------------------------------------------------------------------
11License
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
33namespace Foam
34{
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// ************************************************************************* //
Base class for time scale models.
virtual ~TimeScaleModel()
Destructor.
static autoPtr< Time > New()
Construct (dummy) Time - no functionObjects or libraries.
Definition: Time.C:717
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Namespace for OpenFOAM.
messageStream Info
Information stream (stdout output on master, null elsewhere)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:372
errorManip< error > abort(error &err)
Definition: errorManip.H:144
IOerror FatalIOError
#define defineRunTimeSelectionTable(baseType, argNames)
Define run-time selection table.
dictionary dict