src/OpenFOAM/global/debug/debug.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Namespace
  26     Foam::debug
  27
  28 Description
  29     Namespace for handling debugging switches.
  30
  31 SourceFiles
  32     debug.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef debug_H
  37 #define debug_H
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 // Forward declaration of classes
  45 class dictionary;
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace debug
  50 {
  51     //- The central control dictionary.
  52     //  Located in ~/.OpenFOAM/VERSION or $WM_PROJECT_DIR/etc
  53     //  @sa Foam::findEtcFile()
  54     dictionary& controlDict();
  55
  56     //- The DebugSwitches sub-dictionary in the central controlDict.
  57     dictionary& debugSwitches();
  58
  59     //- The InfoSwitches sub-dictionary in the central controlDict.
  60     dictionary& infoSwitches();
  61
  62     //- The OptimisationSwitches sub-dictionary in the central controlDict.
  63     dictionary& optimisationSwitches();
  64
  65     //- The Tolerances sub-dictionary in the central controlDict.
  66     dictionary& tolerances();
  67
  68     //- Lookup debug switch or add default value.
  69     int debugSwitch(const char* name, const int defaultValue = 0);
  70
  71     //- Lookup info switch or add default value.
  72     int infoSwitch(const char* name, const int defaultValue = 0);
  73
  74     //- Lookup optimisation switch or add default value.
  75     int optimisationSwitch(const char* name, const int defaultValue = 0);
  76
  77     //- Lookup tolerances switch or add default value.
  78     double tolerances(const char* name, const double defaultValue = 0);
  79
  80     //- Internal function to lookup a sub-dictionary from controlDict.
  81     dictionary& switchSet(const char* subDictName, dictionary*& subDictPtr);
  82
  83 } // End namespace debug
  84
  85
  86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  87
  88 } // End namespace Foam
  89
  90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  91
  92 #endif
  93
  94 // ************************************************************************* //