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-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 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
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace debug
  43 {
  44
  45 dictionary* controlDictPtr_(NULL);
  46 dictionary* debugSwitchesPtr_(NULL);
  47 dictionary* infoSwitchesPtr_(NULL);
  48 dictionary* optimisationSwitchesPtr_(NULL);
  49
  50 //- Class to ensure controlDictPtr_ is deleted at the end of the run
  51 //  @cond ignore documentation for this class
  52 class deleteControlDictPtr
  53 {
  54 public:
  55
  56     deleteControlDictPtr()
  57     {}
  58
  59     ~deleteControlDictPtr()
  60     {
  61         if (controlDictPtr_)
  62         {
  63             delete controlDictPtr_;
  64         }
  65     }
  66 };
  67 //! @endcond
  68
  69 deleteControlDictPtr deleteControlDictPtr_;
  70
  71
  72 dictionary& switchSet(const char* switchSetName, dictionary* switchSetPtr)
  73 {
  74     if (!switchSetPtr)
  75     {
  76         if (!controlDict().found(switchSetName))
  77         {
  78             cerr<< "debug::switchSet(const char*, dictionary*): " << std::endl
  79                 << "    Cannot find " <<  switchSetName
  80             << " in dictionary " << controlDictPtr_->name().c_str()
  81             << std::endl << std::endl;
  82
  83             ::exit(1);
  84         }
  85
  86         switchSetPtr =
  87             const_cast<dictionary*>(&(controlDict().subDict(switchSetName)));
  88     }
  89
  90     return *switchSetPtr;
  91 }
  92
  93
  94 int debugSwitch
  95 (
  96     dictionary& switchSet,
  97     const char* switchName,
  98     const int defaultValue
  99 )
 100 {
 101     if (switchSet.found(switchName))
 102     {
 103         return readInt(switchSet.lookup(switchName));
 104     }
 105     else
 106     {
 107         switchSet.add(switchName, defaultValue);
 108         return defaultValue;
 109     }
 110 }
 111
 112 }
 113
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 dictionary& debug::controlDict()
 118 {
 119     if (!controlDictPtr_)
 120     {
 121         fileName controlDictFileName(dotFoam("controlDict"));
 122
 123         IFstream dictFile(controlDictFileName);
 124
 125         if (!dictFile.good())
 126         {
 127             cerr<< "debug::controlDict(): "
 128                 << "Cannot open essential file " << controlDictFileName.c_str()
 129                 << std::endl << std::endl;
 130             ::exit(1);
 131         }
 132
 133         controlDictPtr_ = new dictionary(dictFile);
 134     }
 135
 136     return *controlDictPtr_;
 137 }
 138
 139
 140 dictionary& debug::debugSwitches()
 141 {
 142     return switchSet("DebugSwitches", debugSwitchesPtr_);
 143 }
 144
 145
 146 int debug::debugSwitch(const char* switchName, const int defaultValue)
 147 {
 148     return debugSwitch
 149     (
 150         debugSwitches(),
 151         switchName,
 152         defaultValue
 153     );
 154 }
 155
 156
 157 dictionary& debug::infoSwitches()
 158 {
 159     return switchSet("InfoSwitches", infoSwitchesPtr_);
 160 }
 161
 162
 163 int debug::infoSwitch(const char* switchName, const int defaultValue)
 164 {
 165     return debugSwitch
 166     (
 167         infoSwitches(),
 168         switchName,
 169         defaultValue
 170     );
 171 }
 172
 173
 174 dictionary& debug::optimisationSwitches()
 175 {
 176     return switchSet("OptimisationSwitches", optimisationSwitchesPtr_);
 177 }
 178
 179
 180 int debug::optimisationSwitch(const char* switchName, const int defaultValue)
 181 {
 182     return debugSwitch
 183     (
 184         optimisationSwitches(),
 185         switchName,
 186         defaultValue
 187     );
 188 }
 189
 190
 191 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 192
 193 } // End namespace Foam
 194
 195 // ************************************************************************* //