profileModel.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) 2011-2024 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 "profileModel.H"
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
35 }
36 
37 
38 // * * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * //
39 
41 {
42  return fName_ != fileName::null;
43 }
44 
45 
46 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
47 
49 :
50  name_(name),
51  fName_(fileName::null)
52 {
53  dict.readIfPresent("file", fName_);
54 }
55 
56 // * * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * //
57 
59 {}
60 
61 
62 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
63 
65 {
66  return name_;
67 }
68 
69 
71 (
72  const dictionary& dict
73 )
74 {
75  const word& modelName(dict.dictName());
76 
77  const word modelType(dict.lookup("type"));
78 
79  Info<< " - creating " << modelType << " profile " << modelName << endl;
80 
81  dictionaryConstructorTable::iterator cstrIter =
82  dictionaryConstructorTablePtr_->find(modelType);
83 
84  if (cstrIter == dictionaryConstructorTablePtr_->end())
85  {
87  << "Unknown profile model type " << modelType
88  << nl << nl
89  << "Valid model types are :" << nl
90  << dictionaryConstructorTablePtr_->sortedToc()
91  << exit(FatalError);
92  }
93 
94  return autoPtr<profileModel>(cstrIter()(dict, modelName));
95 }
96 
97 
98 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
const word dictName() const
Return the local dictionary name (final part of scoped name)
Definition: dictionary.H:123
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:740
A class for handling file names.
Definition: fileName.H:82
static const fileName null
An empty fileName.
Definition: fileName.H:97
Base class for profile models.
Definition: profileModel.H:51
virtual ~profileModel()
Destructor.
Definition: profileModel.C:58
bool readFromFile() const
Return true if file name is set.
Definition: profileModel.C:40
fileName fName_
File name (optional)
Definition: profileModel.H:61
profileModel(const dictionary &dict, const word &modelName)
Constructor.
Definition: profileModel.C:48
const word & name() const
Return const access to the source name.
Definition: profileModel.C:64
static autoPtr< profileModel > New(const dictionary &dict)
Return a reference to the selected fvModel model.
Definition: profileModel.C:71
A class for handling words, derived from string.
Definition: word.H:62
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:334
Namespace for OpenFOAM.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:258
messageStream Info
defineTypeNameAndDebug(combustionModel, 0)
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.
error FatalError
static const char nl
Definition: Ostream.H:267
dictionary dict