diameterModel.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) 2011-2019 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 "diameterModel.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35  defineTypeNameAndDebug(diameterModel, 0);
36  defineRunTimeSelectionTable(diameterModel, dictionary);
37 }
38 
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  const dictionary& dict,
45  const phaseModel& phase
46 )
47 :
48  diameterProperties_(dict),
49  phase_(phase)
50 {}
51 
52 
53 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
54 
57 (
58  const dictionary& dict,
59  const phaseModel& phase
60 )
61 {
62  const word modelType(dict.get<word>("diameterModel"));
63 
64  Info<< "Selecting diameterModel for phase "
65  << phase.name()
66  << ": "
67  << modelType << endl;
68 
69  auto* ctorPtr = dictionaryConstructorTable(modelType);
70 
71  if (!ctorPtr)
72  {
74  (
75  dict,
76  "diameterModel",
77  modelType,
78  *dictionaryConstructorTablePtr_
79  ) << abort(FatalIOError);
80  }
81 
82  return ctorPtr
83  (
84  dict.optionalSubDict(modelType + "Coeffs"),
85  phase
86  );
87 }
88 
89 
90 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
91 
93 {}
94 
95 
97 {
98  diameterProperties_ = dict.optionalSubDict(type() + "Coeffs");
99 
100  return true;
101 }
102 
103 
104 // ************************************************************************* //
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Foam::diameterModel::New
static autoPtr< diameterModel > New(const dictionary &dict, const phaseModel &phase)
Definition: diameterModel.C:56
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::dictionary::get
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:107
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::diameterModel::correct
virtual void correct()
Correct the diameter field.
Definition: diameterModel.C:92
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
diameterModel.H
Foam::autoPtr< Foam::diameterModel >
Foam::type
fileName::Type type(const fileName &name, const bool followLink=true)
Return the file type: DIRECTORY or FILE, normally following symbolic links.
Definition: MSwindows.C:590
Foam::dictionary::optionalSubDict
const dictionary & optionalSubDict(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a sub-dictionary, otherwise return this dictionary.
Definition: dictionary.C:577
Foam::diameterModel::read
virtual bool read(const dictionary &phaseProperties)=0
Read phaseProperties dictionary.
Definition: diameterModel.C:96
Foam::diameterModel::diameterModel
diameterModel(const dictionary &dict, const phaseModel &phase)
Definition: diameterModel.C:43
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)