File size: 3,814 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2025 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Namespace
Foam::debug
Description
Namespace for handling debugging switches.
SourceFiles
debug.C
\*---------------------------------------------------------------------------*/
#ifndef debug_H
#define debug_H
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class dictionary;
class Istream;
class Ostream;
class word;
template<class Enum, unsigned int nEnum> class NamedEnum;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace debug
{
//- The central control dictionary.
// Located in ~/.OpenFOAM/VERSION or $WM_PROJECT_DIR/etc
// \sa Foam::findEtcFile()
dictionary& configDict();
//- The DebugSwitches sub-dictionary in the central configDict.
dictionary& debugSwitches();
//- The InfoSwitches sub-dictionary in the central configDict.
dictionary& infoSwitches();
//- The OptimisationSwitches sub-dictionary in the central configDict.
dictionary& optimisationSwitches();
//- Lookup debug switch or add default value.
int debugSwitch(const char* name, const int defaultValue=0);
//- Lookup info switch or add default value.
int infoSwitch(const char* name, const int defaultValue=0);
//- Lookup optimisation switch or add default value.
int optimisationSwitch(const char* name, const int defaultValue=0);
//- Lookup optimisation switch or add default value.
float floatOptimisationSwitch
(
const char* name,
const float defaultValue=0
);
//- Lookup optimisation switch or add default value.
const word wordOptimisationSwitch
(
const char* name,
const word& defaultValue
);
//- Lookup optimisation switch or add default value.
template<class Enum, unsigned int nEnum>
Enum namedEnumOptimisationSwitch
(
const char* name,
const NamedEnum<Enum, nEnum>& enumNames,
const Enum defaultValue
)
{
return enumNames
[
debug::wordOptimisationSwitch
(
name,
enumNames[defaultValue]
)
];
}
//- Internal function to lookup a sub-dictionary from configDict.
dictionary& switchSet(const char* subDictName, dictionary*& subDictPtr);
//- List debug switches
void listSwitches();
} // End namespace debug
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|