src/OpenFOAM/global/debug/debug.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 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 class dictionary;
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace debug
  49 {
  50     dictionary& controlDict();
  51
  52
  53     dictionary& switchSet(const char* switchSetName, dictionary* switchSetPtr);
  54
  55
  56     dictionary& debugSwitches();
  57
  58     int debugSwitch
  59     (
  60         const char* switchName,
  61         const int defaultValue = 0
  62     );
  63
  64
  65     dictionary& infoSwitches();
  66
  67     int infoSwitch
  68     (
  69         const char* switchName,
  70         const int defaultValue = 0
  71     );
  72
  73
  74     dictionary& optimisationSwitches();
  75
  76     int optimisationSwitch
  77     (
  78         const char* switchName,
  79         const int defaultValue = 0
  80     );
  81 }
  82
  83
  84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  85
  86 } // End namespace Foam
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 #endif
  91
  92 // ************************************************************************* //