src/OpenFOAM/global/debug/debug.C

   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 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 dictionary* tolerancesPtr_(NULL);
  48
  49 // to ensure controlDictPtr_ is deleted at the end of the run
  50 class deleteControlDictPtr
  51 {
  52 public:
  53
  54     deleteControlDictPtr()
  55     {}
  56
  57     ~deleteControlDictPtr()
  58     {
  59         if (controlDictPtr_)
  60         {
  61             delete controlDictPtr_;
  62             controlDictPtr_ = 0;
  63         }
  64     }
  65 };
  66
  67 deleteControlDictPtr deleteControlDictPtr_;
  68 //! @endcond ignoreDocumentation
  69
  70
  71 } // End namespace debug
  72 } // End namespace Foam
  73
  74 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  75
  76 Foam::dictionary& Foam::debug::controlDict()
  77 {
  78     if (!controlDictPtr_)
  79     {
  80         controlDictPtr_ = new dictionary
  81         (
  82             IFstream(findEtcFile("controlDict", true))()
  83         );
  84     }
  85
  86     return *controlDictPtr_;
  87 }
  88
  89
  90 Foam::dictionary& Foam::debug::switchSet
  91 (
  92     const char* subDictName,
  93     dictionary*& subDictPtr
  94 )
  95 {
  96     if (!subDictPtr)
  97     {
  98         entry* ePtr = controlDict().lookupEntryPtr
  99         (
 100             subDictName, false, false
 101         );
 102
 103         if (!ePtr || !ePtr->isDict())
 104         {
 105             cerr<< "debug::switchSet(const char*, dictionary*&):\n"
 106                 << "    Cannot find " <<  subDictName << " in dictionary "
 107                 << controlDict().name().c_str()
 108                 << std::endl << std::endl;
 109
 110             ::exit(1);
 111         }
 112
 113         subDictPtr = &ePtr->dict();
 114     }
 115
 116     return *subDictPtr;
 117 }
 118
 119
 120 Foam::dictionary& Foam::debug::debugSwitches()
 121 {
 122     return switchSet("DebugSwitches", debugSwitchesPtr_);
 123 }
 124
 125
 126 Foam::dictionary& Foam::debug::infoSwitches()
 127 {
 128     return switchSet("InfoSwitches", infoSwitchesPtr_);
 129 }
 130
 131
 132 Foam::dictionary& Foam::debug::optimisationSwitches()
 133 {
 134     return switchSet("OptimisationSwitches", optimisationSwitchesPtr_);
 135 }
 136
 137
 138 Foam::dictionary& Foam::debug::tolerances()
 139 {
 140     return switchSet("Tolerances", tolerancesPtr_);
 141 }
 142
 143
 144 int Foam::debug::debugSwitch(const char* name, const int defaultValue)
 145 {
 146     return debugSwitches().lookupOrAddDefault
 147     (
 148         name, defaultValue, false, false
 149     );
 150 }
 151
 152
 153 int Foam::debug::infoSwitch(const char* name, const int defaultValue)
 154 {
 155     return infoSwitches().lookupOrAddDefault
 156     (
 157         name, defaultValue, false, false
 158     );
 159 }
 160
 161
 162 int Foam::debug::optimisationSwitch(const char* name, const int defaultValue)
 163 {
 164     return optimisationSwitches().lookupOrAddDefault
 165     (
 166         name, defaultValue, false, false
 167     );
 168 }
 169
 170
 171 double Foam::debug::tolerances
 172 (
 173     const char* name,
 174     const double defaultValue
 175 )
 176 {
 177     return tolerances().lookupOrAddDefault
 178     (
 179         name, defaultValue, false, false
 180     );
 181 }
 182
 183
 184 // ************************************************************************* //