Foam::debug Namespace Reference

Namespace for handling debugging switches. More...

Functions
dictionary &	controlDict ()
	The central control dictionary. More...
dictionary &	debugSwitches ()
	The DebugSwitches sub-dictionary in the central controlDict. More...
dictionary &	infoSwitches ()
	The InfoSwitches sub-dictionary in the central controlDict. More...
dictionary &	optimisationSwitches ()
	The OptimisationSwitches sub-dictionary in the central controlDict. More...
int	debugSwitch (const char *name, const int defaultValue=0)
	Lookup debug switch or add default value. More...
int	infoSwitch (const char *name, const int defaultValue=0)
	Lookup info switch or add default value. More...
int	optimisationSwitch (const char *name, const int defaultValue=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 ()
	Get access to registered debug switch objects. More...
simpleObjectRegistry &	infoObjects ()
	Get access to registered info switch objects. More...
simpleObjectRegistry &	optimisationObjects ()
	Get access to registered optimisation switch objects. More...
simpleObjectRegistry &	dimensionSetObjects ()
	Get access to registered dimensionSets switch objects. More...
simpleObjectRegistry &	dimensionedConstantObjects ()
	Get access to registered dimensionedConstant switch objects. More...

Detailed Description

Namespace for handling debugging switches.

Source files

• debug.H
• debug.C

Function Documentation

controlDict()

Foam::dictionary & controlDict

(

)

The central control dictionary.

Located in ~/.OpenFOAM/VERSION or $WM_PROJECT_DIR/etc

See also

Foam::findEtcFile()

Definition at line 90 of file debug.C.

References Foam::findEtcFiles(), forAllReverse, IOstream::good(), and SafeFatalIOErrorInFunction.

Referenced by argList::displayDoc().

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.

Definition at line 146 of file debug.C.

References switchSet().

Referenced by debugSwitch().

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.

Definition at line 152 of file debug.C.

References switchSet().

Referenced by infoSwitch().

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.

Definition at line 158 of file debug.C.

References switchSet().

Referenced by 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	defaultValue = 0
	)

Lookup debug switch or add default value.

Definition at line 164 of file debug.C.

References debugSwitches(), dictionary::lookupOrAddDefault(), and Foam::name().

Here is the call graph for this function:

infoSwitch()

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

Lookup info switch or add default value.

Definition at line 173 of file debug.C.

References infoSwitches(), dictionary::lookupOrAddDefault(), and Foam::name().

Here is the call graph for this function:

optimisationSwitch()

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

Lookup optimisation switch or add default value.

Definition at line 182 of file debug.C.

References dictionary::lookupOrAddDefault(), 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 117 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 191 of file debug.C.

References DictionaryBase::append(), List::append(), debugObjects(), DictionaryBase::lookupPtr(), 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 212 of file debug.C.

References DictionaryBase::append(), List::append(), infoObjects(), DictionaryBase::lookupPtr(), 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 234 of file debug.C.

References DictionaryBase::append(), List::append(), DictionaryBase::lookupPtr(), 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 259 of file debug.C.

References DictionaryBase::append(), List::append(), dimensionSetObjects(), DictionaryBase::lookupPtr(), 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 284 of file debug.C.

References DictionaryBase::append(), List::append(), dimensionedConstantObjects(), DictionaryBase::lookupPtr(), and Foam::name().

Here is the call graph for this function:

debugObjects()

Foam::simpleObjectRegistry & debugObjects

(

)

Get access to registered debug switch objects.

Definition at line 311 of file debug.C.

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

Here is the caller graph for this function:

infoObjects()

Foam::simpleObjectRegistry & infoObjects

(

)

Get access to registered info switch objects.

Definition at line 322 of file debug.C.

Referenced by addInfoObject().

Here is the caller graph for this function:

optimisationObjects()

Foam::simpleObjectRegistry & optimisationObjects

(

)

Get access to registered optimisation switch objects.

Definition at line 333 of file debug.C.

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

Here is the caller graph for this function:

dimensionSetObjects()

Foam::simpleObjectRegistry & dimensionSetObjects

(

)

Get access to registered dimensionSets switch objects.

Definition at line 344 of file debug.C.

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

Here is the caller graph for this function:

dimensionedConstantObjects()

Foam::simpleObjectRegistry & dimensionedConstantObjects

(

)

Get access to registered dimensionedConstant switch objects.

Definition at line 355 of file debug.C.

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

Here is the caller graph for this function: