00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Namespace 00025 Foam::debug 00026 00027 Description 00028 Namespace for handling debugging switches. 00029 00030 SourceFiles 00031 debug.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef debug_H 00036 #define debug_H 00037 00038 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00039 00040 namespace Foam 00041 { 00042 00043 // Forward declaration of classes 00044 class dictionary; 00045 00046 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00047 00048 namespace debug 00049 { 00050 //- The central control dictionary. 00051 // Located in ~/.OpenFOAM/VERSION or $WM_PROJECT_DIR/etc 00052 // @sa Foam::findEtcFile() 00053 dictionary& controlDict(); 00054 00055 //- The DebugSwitches sub-dictionary in the central controlDict. 00056 dictionary& debugSwitches(); 00057 00058 //- The InfoSwitches sub-dictionary in the central controlDict. 00059 dictionary& infoSwitches(); 00060 00061 //- The OptimisationSwitches sub-dictionary in the central controlDict. 00062 dictionary& optimisationSwitches(); 00063 00064 //- Lookup debug switch or add default value. 00065 int debugSwitch(const char* name, const int defaultValue=0); 00066 00067 //- Lookup info switch or add default value. 00068 int infoSwitch(const char* name, const int defaultValue=0); 00069 00070 //- Lookup optimisation switch or add default value. 00071 int optimisationSwitch(const char* name, const int defaultValue=0); 00072 00073 //- Internal function to lookup a sub-dictionary from controlDict. 00074 dictionary& switchSet(const char* subDictName, dictionary*& subDictPtr); 00075 00076 } // End namespace debug 00077 00078 00079 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00080 00081 } // End namespace Foam 00082 00083 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00084 00085 #endif 00086 00087 // ************************ vim: set sw=4 sts=4 et: ************************ //
