All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
systemDict.H
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) 2021 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 Class
25  Foam::systemDict
26 
27 Description
28  Read and return the specified dictionary from system or from path provided
29  with the -dict option.
30 
31 SourceFiles
32  systemDict.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef systemDict_H
37 #define systemDict_H
38 
39 #include "argList.H"
40 #include "IOdictionary.H"
41 #include "polyMesh.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // * * * * * * * * * * * * * * Global Functions * * * * * * * * * * * * * * //
49 
50 IOobject systemDictIO
51 (
52  const word& dictName,
53  const argList& args,
54  const objectRegistry& ob,
56 );
57 
58 IOdictionary systemDict
59 (
60  const word& dictName,
61  const argList& args,
62  const objectRegistry& ob,
64 );
65 
66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 
68 } // End namespace Foam
69 
70 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 
72 #endif
73 
74 // ************************************************************************* //
static word defaultRegion
Return the default region name.
Definition: polyMesh.H:267
Namespace for OpenFOAM.
IOdictionary systemDict(const word &dictName, const argList &args, const objectRegistry &ob, const word &regionName=polyMesh::defaultRegion)
Definition: systemDict.C:92
const word & regionName(const solver &region)
Definition: solver.H:209
IOobject systemDictIO(const word &dictName, const argList &args, const objectRegistry &ob, const word &regionName=polyMesh::defaultRegion)
Definition: systemDict.C:33
Foam::argList args(argc, argv)