FreeFOAM The Cross-Platform CFD Toolkit
debug.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
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 Namespace
25  Foam::debug
26 
27 Description
28  Namespace for handling debugging switches.
29 
30 SourceFiles
31  debug.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef debug_H
36 #define debug_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 // Forward declaration of classes
44 class dictionary;
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace debug
49 {
50  //- The central control dictionary.
51  // Located in ~/.OpenFOAM/VERSION or $WM_PROJECT_DIR/etc
52  // @sa Foam::findEtcFile()
53  dictionary& controlDict();
54 
55  //- The DebugSwitches sub-dictionary in the central controlDict.
56  dictionary& debugSwitches();
57 
58  //- The InfoSwitches sub-dictionary in the central controlDict.
59  dictionary& infoSwitches();
60 
61  //- The OptimisationSwitches sub-dictionary in the central controlDict.
62  dictionary& optimisationSwitches();
63 
64  //- Lookup debug switch or add default value.
65  int debugSwitch(const char* name, const int defaultValue=0);
66 
67  //- Lookup info switch or add default value.
68  int infoSwitch(const char* name, const int defaultValue=0);
69 
70  //- Lookup optimisation switch or add default value.
71  int optimisationSwitch(const char* name, const int defaultValue=0);
72 
73  //- Internal function to lookup a sub-dictionary from controlDict.
74  dictionary& switchSet(const char* subDictName, dictionary*& subDictPtr);
75 
76 } // End namespace debug
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace Foam
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #endif
86 
87 // ************************ vim: set sw=4 sts=4 et: ************************ //