relaxationModel.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) 2012-2017 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 "relaxationModel.H"
31
32// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33
34namespace Foam
35{
36defineTypeNameAndDebug(relaxationModel, 0);
37defineRunTimeSelectionTable(relaxationModel, dictionary);
38}
39
40
41// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
42
44(
45 const word& type,
46 const dictionary& dict,
47 const Time& runTime
48)
49:
50 dictionary(dict),
51 runTime_(runTime),
52 coeffDict_(optionalSubDict(type + "Coeffs"))
53{}
54
55
56// * * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * //
57
59(
60 const dictionary& dict,
61 const Time& runTime
62)
63{
64 const word modelType(dict.get<word>("relaxationModel"));
65
66 Info<< nl << "Selecting relaxationModel " << modelType << endl;
67
68 auto* ctorPtr = dictionaryConstructorTable(modelType);
69
70 if (!ctorPtr)
71 {
73 (
74 dict,
75 "relaxationModel",
76 modelType,
77 *dictionaryConstructorTablePtr_
78 ) << exit(FatalIOError);
79 }
80
81 return autoPtr<relaxationModel>(ctorPtr(dict, runTime));
82}
83
84
85// ************************************************************************* //
Macros for easy insertion into run-time selection tables.
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
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Abstract base class for providing relaxation values to the cell motion controller.
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
engineTime & runTime
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
type
Types of root.
Definition: Roots.H:55
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
IOerror FatalIOError
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
constexpr char nl
The newline '\n' character (0x0a)
Definition: Ostream.H:53
#define defineRunTimeSelectionTable(baseType, argNames)
Define run-time selection table.
dictionary dict