Function1New.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-2020 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 "Constant.H"
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
30 template<class Type>
32 (
33  const word& name,
34  const dictionary& dict
35 )
36 {
37  if (dict.isDict(name))
38  {
39  const dictionary& coeffsDict(dict.subDict(name));
40 
41  const word Function1Type(coeffsDict.lookup("type"));
42 
43  typename dictionaryConstructorTable::iterator cstrIter =
44  dictionaryConstructorTablePtr_->find(Function1Type);
45 
46  if (cstrIter == dictionaryConstructorTablePtr_->end())
47  {
49  << "Unknown Function1 type "
50  << Function1Type << " for Function1 "
51  << name << nl << nl
52  << "Valid Function1 types are:" << nl
53  << dictionaryConstructorTablePtr_->sortedToc() << nl
54  << exit(FatalError);
55  }
56 
57  return cstrIter()(name, coeffsDict);
58  }
59  else
60  {
61  Istream& is(dict.lookup(name, false));
62 
63  token firstToken(is);
64  word Function1Type;
65 
66  if (!firstToken.isWord())
67  {
68  is.putBack(firstToken);
70  (
72  );
73  }
74  else
75  {
76  Function1Type = firstToken.wordToken();
77  }
78 
79  typename dictionaryConstructorTable::iterator cstrIter =
80  dictionaryConstructorTablePtr_->find(Function1Type);
81 
82  if (cstrIter == dictionaryConstructorTablePtr_->end())
83  {
85  << "Unknown Function1 type "
86  << Function1Type << " for Function1 "
87  << name << nl << nl
88  << "Valid Function1 types are:" << nl
89  << dictionaryConstructorTablePtr_->sortedToc() << nl
90  << exit(FatalError);
91  }
92 
94  (
95  cstrIter()
96  (
97  name,
98  dict.found(name + "Coeffs")
99  ? dict.subDict(name + "Coeffs")
100  : dict
101  )
102  );
103 
104  if (dict.found(name + "Coeffs"))
105  {
106  IOWarningInFunction(dict)
107  << "Using deprecated "
108  << (name + "Coeffs") << " sub-dictionary."<< nl
109  << " Please use the simpler form" << endl;
110  funcPtr->write(Info);
111  }
112 
113  return funcPtr;
114  }
115 }
116 
117 
118 // ************************************************************************* //
dictionary dict
bool found(const word &, bool recursive=false, bool patternMatch=true) const
Search dictionary for given keyword.
Definition: dictionary.C:643
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
error FatalError
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:323
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
A token holds items read from Istream.
Definition: token.H:72
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
bool isDict(const word &) const
Check if entry is a sub-dictionary.
Definition: dictionary.C:936
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:982
A class for handling words, derived from string.
Definition: word.H:59
static const char nl
Definition: Ostream.H:260
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
Templated function that returns a constant value.
Definition: Constant.H:56
messageStream Info
#define IOWarningInFunction(ios)
Report an IO warning using Foam::Warning.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
static autoPtr< Function1< Type > > New(const word &name, const dictionary &dict)
Selector.
Definition: Function1New.C:32
ITstream & lookup(const word &, bool recursive=false, bool patternMatch=true) const
Find and return an entry data stream.
Definition: dictionary.C:844