Foam::debug Namespace Reference

Namespace for handling debugging switches. More...

Functions

dictionarycontrolDict ()
 
dictionarydebugSwitches ()
 The DebugSwitches sub-dictionary in the central controlDict(s). More...
 
dictionaryinfoSwitches ()
 The InfoSwitches sub-dictionary in the central controlDict(s). More...
 
dictionaryoptimisationSwitches ()
 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...
 
dictionaryswitchSet (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...
 
simpleObjectRegistrydebugObjects ()
 Access to registered DebugSwitch objects. More...
 
simpleObjectRegistryinfoObjects ()
 Access to registered InfoSwitch objects. More...
 
simpleObjectRegistryoptimisationObjects ()
 Access to registered OptimisationSwitch objects. More...
 
simpleObjectRegistrydimensionSetObjects ()
 Access to registered DimensionSets objects. More...
 
simpleObjectRegistrydimensionedConstantObjects ()
 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...
 

Detailed Description

Namespace for handling debugging switches.

Source files

Function Documentation

◆ controlDict()

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.

  • ~/.OpenFOAM/{PROJECT_API}/controlDict
  • ~/.OpenFOAM/controlDict
  • $WM_PROJECT_SITE/{PROJECT_API}/etc/controlDict
  • $WM_PROJECT_SITE/etc/controlDict
  • $WM_PROJECT_DIR/etc/controlDict

Where {PROJECT_API} corresponds to the foamVersion::api value.

See also
Foam::findEtcFile()

Definition at line 143 of file debug.C.

References Foam::findEtcFiles(), forAllReverse, Foam::getEnv(), and SafeFatalIOErrorInFunction.

Referenced by argList::displayDoc(), Foam::listSwitches(), MGridGenGAMGAgglomeration::MGridGenGAMGAgglomeration(), GAMGProcAgglomeration::New(), functionObjectList::New(), GAMGAgglomeration::New(), Time::setMonitoring(), and switchSet().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ debugSwitches()

Foam::dictionary & debugSwitches ( )

The DebugSwitches sub-dictionary in the central controlDict(s).

Definition at line 207 of file debug.C.

References switchSet().

Referenced by debugSwitch(), listDebugSwitches(), listSwitches(), and Foam::listSwitches().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ infoSwitches()

Foam::dictionary & infoSwitches ( )

The InfoSwitches sub-dictionary in the central controlDict(s).

Definition at line 213 of file debug.C.

References switchSet().

Referenced by infoSwitch(), listSwitches(), and Foam::listSwitches().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ optimisationSwitches()

Foam::dictionary & optimisationSwitches ( )

The OptimisationSwitches sub-dictionary in the central controlDict(s).

Definition at line 219 of file debug.C.

References switchSet().

Referenced by floatOptimisationSwitch(), listOptimisationSwitches(), listSwitches(), and optimisationSwitch().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ debugSwitch()

int debugSwitch ( const char *  name,
const int  deflt = 0 
)

Lookup debug switch or add default value.

Definition at line 225 of file debug.C.

References debugSwitches(), Foam::getOrAdd(), and Foam::name().

Here is the call graph for this function:

◆ infoSwitch()

int infoSwitch ( const char *  name,
const int  deflt = 0 
)

Lookup info switch or add default value.

Definition at line 231 of file debug.C.

References Foam::getOrAdd(), infoSwitches(), and Foam::name().

Referenced by argList::parse().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ optimisationSwitch()

int optimisationSwitch ( const char *  name,
const int  deflt = 0 
)

Lookup optimisation switch or add default value.

Definition at line 237 of file debug.C.

References Foam::getOrAdd(), Foam::name(), and optimisationSwitches().

Here is the call graph for this function:

◆ floatOptimisationSwitch()

float floatOptimisationSwitch ( const char *  name,
const float  deflt = 0 
)

Lookup optimisation switch or add default value.

Definition at line 243 of file debug.C.

References Foam::getOrAdd(), Foam::name(), and optimisationSwitches().

Here is the call graph for this function:

◆ switchSet()

Foam::dictionary & switchSet ( const char *  subDictName,
dictionary *&  subDictPtr 
)

Internal function to lookup a sub-dictionary from controlDict.

Definition at line 180 of file debug.C.

References controlDict(), entry::dict(), Foam::endl(), Foam::exit(), and entry::isDict().

Referenced by debugSwitches(), Foam::dimensionedConstants(), Foam::dimensionSystems(), infoSwitches(), and optimisationSwitches().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addDebugObject()

void addDebugObject ( const char *  name,
simpleRegIOobject obj 
)

Register debug switch read/write object.

Definition at line 249 of file debug.C.

References Foam::appendNamedEntry(), debugObjects(), and Foam::name().

Here is the call graph for this function:

◆ addInfoObject()

void addInfoObject ( const char *  name,
simpleRegIOobject obj 
)

Register info switch read/write object.

Definition at line 255 of file debug.C.

References Foam::appendNamedEntry(), infoObjects(), and Foam::name().

Here is the call graph for this function:

◆ addOptimisationObject()

void addOptimisationObject ( const char *  name,
simpleRegIOobject obj 
)

Register optimisation switch read/write object.

Definition at line 262 of file debug.C.

References Foam::appendNamedEntry(), Foam::name(), and optimisationObjects().

Here is the call graph for this function:

◆ addDimensionSetObject()

void addDimensionSetObject ( const char *  name,
simpleRegIOobject obj 
)

Register DimensionSets read/write object.

Definition at line 272 of file debug.C.

References Foam::appendNamedEntry(), dimensionSetObjects(), and Foam::name().

Here is the call graph for this function:

◆ addDimensionedConstantObject()

void addDimensionedConstantObject ( const char *  name,
simpleRegIOobject obj 
)

Register DimensionedConstant read/write object.

Definition at line 282 of file debug.C.

References Foam::appendNamedEntry(), dimensionedConstantObjects(), and Foam::name().

Here is the call graph for this function:

◆ debugObjects()

Foam::simpleObjectRegistry & debugObjects ( )

Access to registered DebugSwitch objects.

Definition at line 291 of file debug.C.

Referenced by addDebugObject(), argList::argList(), listRegisteredDebugSwitches(), listRegisteredSwitches(), and Time::readDict().

Here is the caller graph for this function:

◆ infoObjects()

Foam::simpleObjectRegistry & infoObjects ( )

Access to registered InfoSwitch objects.

Definition at line 302 of file debug.C.

Referenced by addInfoObject(), argList::argList(), listInfoSwitches(), listRegisteredInfoSwitches(), listRegisteredSwitches(), and Time::readDict().

Here is the caller graph for this function:

◆ optimisationObjects()

Foam::simpleObjectRegistry & optimisationObjects ( )

Access to registered OptimisationSwitch objects.

Definition at line 313 of file debug.C.

Referenced by addOptimisationObject(), argList::argList(), listRegisteredOptimisationSwitches(), listRegisteredSwitches(), and Time::readDict().

Here is the caller graph for this function:

◆ dimensionSetObjects()

Foam::simpleObjectRegistry & dimensionSetObjects ( )

Access to registered DimensionSets objects.

Definition at line 324 of file debug.C.

Referenced by addDimensionSetObject(), and Time::readDict().

Here is the caller graph for this function:

◆ dimensionedConstantObjects()

Foam::simpleObjectRegistry & dimensionedConstantObjects ( )

Access to registered DimensionedConstants objects.

Definition at line 335 of file debug.C.

Referenced by addDimensionedConstantObject(), and Time::readDict().

Here is the caller graph for this function:

◆ listSwitches()

void listSwitches ( const bool  unset = false)

List debug/info/optimisation switches.

Definition at line 446 of file debug.C.

References debugSwitches(), infoSwitches(), Foam::listSwitches(), optimisationSwitches(), and Foam::BitOps::unset().

Here is the call graph for this function:

◆ listDebugSwitches()

void listDebugSwitches ( const bool  unset = false)

List debug switches.

Definition at line 458 of file debug.C.

References debugSwitches(), Foam::listSwitches(), and Foam::BitOps::unset().

Here is the call graph for this function:

◆ listInfoSwitches()

void listInfoSwitches ( const bool  unset = false)

List info switches.

Definition at line 470 of file debug.C.

References infoObjects(), Foam::listSwitches(), and Foam::BitOps::unset().

Here is the call graph for this function:

◆ listOptimisationSwitches()

void listOptimisationSwitches ( const bool  unset = false)

List optimisation switches.

Definition at line 482 of file debug.C.

References Foam::listSwitches(), optimisationSwitches(), and Foam::BitOps::unset().

Here is the call graph for this function:

◆ listRegisteredSwitches()

void listRegisteredSwitches ( const bool  unset = false)

List registered debug/info/optimisation switches.

Definition at line 494 of file debug.C.

References debugObjects(), infoObjects(), Foam::listSwitches(), optimisationObjects(), and Foam::BitOps::unset().

Referenced by if().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ listRegisteredDebugSwitches()

void listRegisteredDebugSwitches ( const bool  unset = false)

List debug switches.

Definition at line 506 of file debug.C.

References debugObjects(), Foam::listSwitches(), and Foam::BitOps::unset().

Here is the call graph for this function:

◆ listRegisteredInfoSwitches()

void listRegisteredInfoSwitches ( const bool  unset = false)

List info switches.

Definition at line 518 of file debug.C.

References infoObjects(), Foam::listSwitches(), and Foam::BitOps::unset().

Here is the call graph for this function:

◆ listRegisteredOptimisationSwitches()

void listRegisteredOptimisationSwitches ( const bool  unset = false)

List optimisation switches.

Definition at line 530 of file debug.C.

References Foam::listSwitches(), optimisationObjects(), and Foam::BitOps::unset().

Here is the call graph for this function: