includeFvModelEntry.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) 2023 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 "includeFvModelEntry.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace functionEntries
34 {
36 
38  (
41  execute,
42  dictionaryIstream
43  );
44 }
45 }
46 
47 
49 (
50  "caseDicts/fvModels"
51 );
52 
53 
54 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
55 
57 (
58  dictionary& parentDict,
59  Istream& is
60 )
61 {
62  // Read line containing the function name and the optional arguments
63  const string fNameArgs(readFuncNameArgs(is));
64 
65  return readConfigFile
66  (
67  "model",
68  fNameArgs,
69  parentDict,
71  "constant",
72  {"file", is.name() + " at line " + Foam::name(is.lineNumber())}
73  );
74 }
75 
76 
77 // ************************************************************************* //
Macros for easy insertion into member function selection tables.
label lineNumber() const
Return current stream line number.
Definition: IOstream.H:435
virtual const fileName & name() const
Return the name of the stream.
Definition: IOstream.H:294
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
A class for handling file names.
Definition: fileName.H:82
Specify a fvModel dictionary file to include, expects the fvModel name to follow with option argument...
static bool execute(dictionary &parentDict, Istream &)
Execute the functionEntry in a sub-dict context.
static fileName fvModelDictPath
Default relative path to the directory structure.
A functionEntry causes entries to be added/manipulated on the specified dictionary given an input str...
Definition: functionEntry.H:66
static string readFuncNameArgs(Istream &is)
Read the function name and optional argument list.
Definition: functionEntry.C:68
defineTypeNameAndDebug(includeFvConstraintEntry, 0)
addToMemberFunctionSelectionTable(functionEntry, includeFvConstraintEntry, execute, dictionaryIstream)
Namespace for OpenFOAM.
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
bool readConfigFile(const word &configType, const string &argString, dictionary &parentDict, const fileName &configFilesPath, const word &configFilesDir, const Pair< string > &contextTypeAndValue, const word &region=word::null)
Read the specified configuration file.
Definition: dictionaryIO.C:433