Namespace for handling debugging switches. More...
Functions | |
dictionary & | controlDict () |
The central control dictionary, the contents of which are either taken directly from the FOAM_CONTROLDICT environment variable, or generated by merging the contents of user/group/other files. More... | |
dictionary & | debugSwitches () |
The DebugSwitches sub-dictionary in the central controlDict(s). More... | |
dictionary & | infoSwitches () |
The InfoSwitches sub-dictionary in the central controlDict(s). More... | |
dictionary & | optimisationSwitches () |
The OptimisationSwitches sub-dictionary in the central controlDict(s). More... | |
int | debugSwitch (const char *name, const int deflt=0) |
Lookup debug switch or add default value. More... | |
int | infoSwitch (const char *name, const int deflt=0) |
Lookup info switch or add default value. More... | |
int | optimisationSwitch (const char *name, const int deflt=0) |
Lookup optimisation switch or add default value. More... | |
float | floatOptimisationSwitch (const char *name, const float deflt=0) |
Lookup optimisation switch or add default value. More... | |
dictionary & | switchSet (const char *subDictName, dictionary *&subDictPtr) |
Internal function to lookup a sub-dictionary from controlDict. More... | |
void | addDebugObject (const char *name, simpleRegIOobject *obj) |
Register debug switch read/write object. More... | |
void | addInfoObject (const char *name, simpleRegIOobject *obj) |
Register info switch read/write object. More... | |
void | addOptimisationObject (const char *name, simpleRegIOobject *obj) |
Register optimisation switch read/write object. More... | |
void | addDimensionSetObject (const char *name, simpleRegIOobject *obj) |
Register DimensionSets read/write object. More... | |
void | addDimensionedConstantObject (const char *name, simpleRegIOobject *) |
Register DimensionedConstant read/write object. More... | |
simpleObjectRegistry & | debugObjects () |
Access to registered DebugSwitch objects. More... | |
simpleObjectRegistry & | infoObjects () |
Access to registered InfoSwitch objects. More... | |
simpleObjectRegistry & | optimisationObjects () |
Access to registered OptimisationSwitch objects. More... | |
simpleObjectRegistry & | dimensionSetObjects () |
Access to registered DimensionSets objects. More... | |
simpleObjectRegistry & | dimensionedConstantObjects () |
Access to registered DimensionedConstants objects. More... | |
void | listSwitches (const bool unset=false) |
List debug/info/optimisation switches. More... | |
void | listDebugSwitches (const bool unset=false) |
List debug switches. More... | |
void | listInfoSwitches (const bool unset=false) |
List info switches. More... | |
void | listOptimisationSwitches (const bool unset=false) |
List optimisation switches. More... | |
void | listRegisteredSwitches (const bool unset=false) |
List registered debug/info/optimisation switches. More... | |
void | listRegisteredDebugSwitches (const bool unset=false) |
List debug switches. More... | |
void | listRegisteredInfoSwitches (const bool unset=false) |
List info switches. More... | |
void | listRegisteredOptimisationSwitches (const bool unset=false) |
List optimisation switches. More... | |
Foam::dictionary & controlDict | ( | ) |
The central control dictionary, the contents of which are either taken directly from the FOAM_CONTROLDICT environment variable, or generated by merging the contents of user/group/other files.
Where {PROJECT_API} corresponds to the foamVersion::api value.
Definition at line 142 of file debug.C.
References Foam::findEtcFiles(), forAllReverse, Foam::getEnv(), and SafeFatalIOErrorInFunction.
Referenced by argList::displayDoc(), Foam::listSwitches(), masterCoarsestGAMGProcAgglomeration::masterCoarsestGAMGProcAgglomeration(), GAMGProcAgglomeration::New(), functionObjectList::New(), GAMGAgglomeration::New(), Time::setMonitoring(), and switchSet().
Foam::dictionary & debugSwitches | ( | ) |
The DebugSwitches sub-dictionary in the central controlDict(s).
Definition at line 204 of file debug.C.
References switchSet().
Referenced by debugSwitch(), listDebugSwitches(), listSwitches(), and Foam::listSwitches().
Foam::dictionary & infoSwitches | ( | ) |
The InfoSwitches sub-dictionary in the central controlDict(s).
Definition at line 210 of file debug.C.
References switchSet().
Referenced by infoSwitch(), listSwitches(), and Foam::listSwitches().
Foam::dictionary & optimisationSwitches | ( | ) |
The OptimisationSwitches sub-dictionary in the central controlDict(s).
Definition at line 216 of file debug.C.
References switchSet().
Referenced by floatOptimisationSwitch(), listOptimisationSwitches(), listSwitches(), and optimisationSwitch().
int debugSwitch | ( | const char * | name, |
const int | deflt = 0 |
||
) |
Lookup debug switch or add default value.
Definition at line 222 of file debug.C.
References debugSwitches(), Foam::getOrAdd(), and Foam::name().
int infoSwitch | ( | const char * | name, |
const int | deflt = 0 |
||
) |
Lookup info switch or add default value.
Definition at line 228 of file debug.C.
References Foam::getOrAdd(), infoSwitches(), and Foam::name().
Referenced by argList::parse().
int optimisationSwitch | ( | const char * | name, |
const int | deflt = 0 |
||
) |
Lookup optimisation switch or add default value.
Definition at line 234 of file debug.C.
References Foam::getOrAdd(), Foam::name(), and optimisationSwitches().
float floatOptimisationSwitch | ( | const char * | name, |
const float | deflt = 0 |
||
) |
Lookup optimisation switch or add default value.
Definition at line 240 of file debug.C.
References Foam::getOrAdd(), Foam::name(), and optimisationSwitches().
Foam::dictionary & switchSet | ( | const char * | subDictName, |
dictionary *& | subDictPtr | ||
) |
Internal function to lookup a sub-dictionary from controlDict.
Definition at line 179 of file debug.C.
References controlDict(), Foam::endl(), and Foam::exit().
Referenced by debugSwitches(), Foam::dimensionedConstants(), Foam::dimensionSystems(), infoSwitches(), and optimisationSwitches().
void addDebugObject | ( | const char * | name, |
simpleRegIOobject * | obj | ||
) |
Register debug switch read/write object.
Definition at line 246 of file debug.C.
References Foam::appendNamedEntry(), debugObjects(), and Foam::name().
void addInfoObject | ( | const char * | name, |
simpleRegIOobject * | obj | ||
) |
Register info switch read/write object.
Definition at line 252 of file debug.C.
References Foam::appendNamedEntry(), infoObjects(), and Foam::name().
void addOptimisationObject | ( | const char * | name, |
simpleRegIOobject * | obj | ||
) |
Register optimisation switch read/write object.
Definition at line 259 of file debug.C.
References Foam::appendNamedEntry(), Foam::name(), and optimisationObjects().
void addDimensionSetObject | ( | const char * | name, |
simpleRegIOobject * | obj | ||
) |
Register DimensionSets read/write object.
Definition at line 269 of file debug.C.
References Foam::appendNamedEntry(), dimensionSetObjects(), and Foam::name().
void addDimensionedConstantObject | ( | const char * | name, |
simpleRegIOobject * | obj | ||
) |
Register DimensionedConstant read/write object.
Definition at line 279 of file debug.C.
References Foam::appendNamedEntry(), dimensionedConstantObjects(), and Foam::name().
Foam::simpleObjectRegistry & debugObjects | ( | ) |
Access to registered DebugSwitch objects.
Definition at line 288 of file debug.C.
Referenced by addDebugObject(), argList::argList(), listRegisteredDebugSwitches(), listRegisteredSwitches(), and Time::readDict().
Foam::simpleObjectRegistry & infoObjects | ( | ) |
Access to registered InfoSwitch objects.
Definition at line 299 of file debug.C.
Referenced by addInfoObject(), argList::argList(), listInfoSwitches(), listRegisteredInfoSwitches(), listRegisteredSwitches(), and Time::readDict().
Foam::simpleObjectRegistry & optimisationObjects | ( | ) |
Access to registered OptimisationSwitch objects.
Definition at line 310 of file debug.C.
Referenced by addOptimisationObject(), argList::argList(), listRegisteredOptimisationSwitches(), listRegisteredSwitches(), and Time::readDict().
Foam::simpleObjectRegistry & dimensionSetObjects | ( | ) |
Access to registered DimensionSets objects.
Definition at line 321 of file debug.C.
Referenced by addDimensionSetObject(), and Time::readDict().
Foam::simpleObjectRegistry & dimensionedConstantObjects | ( | ) |
Access to registered DimensionedConstants objects.
Definition at line 332 of file debug.C.
Referenced by addDimensionedConstantObject(), and Time::readDict().
void listSwitches | ( | const bool | unset = false | ) |
List debug/info/optimisation switches.
Definition at line 443 of file debug.C.
References debugSwitches(), infoSwitches(), Foam::listSwitches(), optimisationSwitches(), Foam::BitOps::sortedToc(), and Foam::BitOps::unset().
void listDebugSwitches | ( | const bool | unset = false | ) |
List debug switches.
Definition at line 455 of file debug.C.
References debugSwitches(), Foam::listSwitches(), Foam::BitOps::sortedToc(), and Foam::BitOps::unset().
void listInfoSwitches | ( | const bool | unset = false | ) |
List info switches.
Definition at line 467 of file debug.C.
References infoObjects(), Foam::listSwitches(), Foam::BitOps::sortedToc(), and Foam::BitOps::unset().
void listOptimisationSwitches | ( | const bool | unset = false | ) |
List optimisation switches.
Definition at line 479 of file debug.C.
References Foam::listSwitches(), optimisationSwitches(), Foam::BitOps::sortedToc(), and Foam::BitOps::unset().
void listRegisteredSwitches | ( | const bool | unset = false | ) |
List registered debug/info/optimisation switches.
Definition at line 491 of file debug.C.
References debugObjects(), infoObjects(), Foam::listSwitches(), optimisationObjects(), Foam::BitOps::sortedToc(), and Foam::BitOps::unset().
Referenced by if().
void listRegisteredDebugSwitches | ( | const bool | unset = false | ) |
List debug switches.
Definition at line 503 of file debug.C.
References debugObjects(), Foam::listSwitches(), Foam::BitOps::sortedToc(), and Foam::BitOps::unset().
void listRegisteredInfoSwitches | ( | const bool | unset = false | ) |
List info switches.
Definition at line 515 of file debug.C.
References infoObjects(), Foam::listSwitches(), Foam::BitOps::sortedToc(), and Foam::BitOps::unset().
void listRegisteredOptimisationSwitches | ( | const bool | unset = false | ) |
List optimisation switches.
Definition at line 527 of file debug.C.
References Foam::listSwitches(), optimisationObjects(), Foam::BitOps::sortedToc(), and Foam::BitOps::unset().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.