OpenFOAM logo
Open Source CFD Toolkit

debug.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Namespace
00026     debug
00027 
00028 Description
00029     Namespace for handling debugging switches.
00030 
00031 SourceFiles
00032     debug.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef debug_H
00037 #define debug_H
00038 
00039 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00040 
00041 namespace Foam
00042 {
00043 
00044 class dictionary;
00045 
00046 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00047 
00048 namespace debug
00049 {
00050     dictionary& controlDict();
00051 
00052 
00053     dictionary& switchSet(const char* switchSetName, dictionary* switchSetPtr);
00054 
00055 
00056     dictionary& debugSwitches();
00057 
00058     int debugSwitch
00059     (
00060         const char* switchName,
00061         const int defaultValue = 0
00062     );
00063 
00064 
00065     dictionary& infoSwitches();
00066 
00067     int infoSwitch
00068     (
00069         const char* switchName,
00070         const int defaultValue = 0
00071     );
00072 
00073 
00074     dictionary& optimisationSwitches();
00075 
00076     int optimisationSwitch
00077     (
00078         const char* switchName,
00079         const int defaultValue = 0
00080     );
00081 }
00082 
00083 
00084 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00085 
00086 } // End namespace Foam
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 #endif
00091 
00092 // ************************************************************************* //
For further information go to www.openfoam.org