src/OpenFOAM/global/debug/debug.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 Description
  26     Class for handling debugging switches.
  27
  28 \*---------------------------------------------------------------------------*/
  29
  30 #include "debug.H"
  31 #include "dictionary.H"
  32 #include "IFstream.H"
  33 #include "OSspecific.H"
  34
  35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  36
  37 namespace Foam
  38 {
  39 namespace debug
  40 {
  41
  42 //! @cond ignoreDocumentation - local scope
  43 dictionary* controlDictPtr_(NULL);
  44 dictionary* debugSwitchesPtr_(NULL);
  45 dictionary* infoSwitchesPtr_(NULL);
  46 dictionary* optimisationSwitchesPtr_(NULL);
  47
  48 // to ensure controlDictPtr_ is deleted at the end of the run
  49 class deleteControlDictPtr
  50 {
  51 public:
  52
  53     deleteControlDictPtr()
  54     {}
  55
  56     ~deleteControlDictPtr()
  57     {
  58         if (controlDictPtr_)
  59         {
  60             delete controlDictPtr_;
  61             controlDictPtr_ = 0;
  62         }
  63     }
  64 };
  65
  66 deleteControlDictPtr deleteControlDictPtr_;
  67 //! @endcond ignoreDocumentation
  68
  69
  70 } // End namespace debug
  71 } // End namespace Foam
  72
  73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  74
  75 Foam::dictionary& Foam::debug::controlDict()
  76 {
  77     if (!controlDictPtr_)
  78     {
  79         controlDictPtr_ = new dictionary
  80         (
  81             IFstream(findEtcFile("controlDict", true))()
  82         );
  83     }
  84
  85     return *controlDictPtr_;
  86 }
  87
  88
  89 Foam::dictionary& Foam::debug::switchSet
  90 (
  91     const char* subDictName,
  92     dictionary*& subDictPtr
  93 )
  94 {
  95     if (!subDictPtr)
  96     {
  97         entry* ePtr = controlDict().lookupEntryPtr
  98         (
  99             subDictName, false, false
 100         );
 101
 102         if (!ePtr || !ePtr->isDict())
 103         {
 104             cerr<< "debug::switchSet(const char*, dictionary*&):\n"
 105                 << "    Cannot find " <<  subDictName << " in dictionary "
 106                 << controlDict().name().c_str()
 107                 << std::endl << std::endl;
 108
 109             ::exit(1);
 110         }
 111
 112         subDictPtr = &ePtr->dict();
 113     }
 114
 115     return *subDictPtr;
 116 }
 117
 118
 119 Foam::dictionary& Foam::debug::debugSwitches()
 120 {
 121     return switchSet("DebugSwitches", debugSwitchesPtr_);
 122 }
 123
 124
 125 Foam::dictionary& Foam::debug::infoSwitches()
 126 {
 127     return switchSet("InfoSwitches", infoSwitchesPtr_);
 128 }
 129
 130
 131 Foam::dictionary& Foam::debug::optimisationSwitches()
 132 {
 133     return switchSet("OptimisationSwitches", optimisationSwitchesPtr_);
 134 }
 135
 136
 137 int Foam::debug::debugSwitch(const char* name, const int defaultValue)
 138 {
 139     return debugSwitches().lookupOrAddDefault
 140     (
 141         name, defaultValue, false, false
 142     );
 143 }
 144
 145
 146 int Foam::debug::infoSwitch(const char* name, const int defaultValue)
 147 {
 148     return infoSwitches().lookupOrAddDefault
 149     (
 150         name, defaultValue, false, false
 151     );
 152 }
 153
 154
 155 int Foam::debug::optimisationSwitch(const char* name, const int defaultValue)
 156 {
 157     return optimisationSwitches().lookupOrAddDefault
 158     (
 159         name, defaultValue, false, false
 160     );
 161 }
 162
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166
 167 // ************************************************************************* //