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

Function Documentation

Foam::dictionary & controlDict ( )

The central control dictionary.

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

See also: Foam::findEtcFile()

Definition at line 92 of file debug.C.

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

Referenced by argList::displayDoc(), and switchSet().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::dictionary & debugSwitches ( )

The DebugSwitches sub-dictionary in the central controlDict.

Definition at line 148 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:

Foam::dictionary & infoSwitches ( )

The InfoSwitches sub-dictionary in the central controlDict.

Definition at line 154 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:

Foam::dictionary & optimisationSwitches ( )

The OptimisationSwitches sub-dictionary in the central controlDict.

Definition at line 160 of file debug.C.

References switchSet().

Referenced by NamedEnum< Enum, nEnum >::names(), optimisationSwitch(), and UPstream::procNo().

Here is the call graph for this function:

Here is the caller graph for this function:

int debugSwitch	(	const char *	name,
		const int	defaultValue = `0`
	)

Lookup debug switch or add default value.

Definition at line 166 of file debug.C.

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

Here is the call graph for this function:

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

Lookup info switch or add default value.

Definition at line 175 of file debug.C.

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

Here is the call graph for this function:

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

Lookup optimisation switch or add default value.

Definition at line 184 of file debug.C.

References dictionary::lookupOrAddDefault(), and optimisationSwitches().

Referenced by NamedEnum< Enum, nEnum >::names(), UPstream::procNo(), and addcommsTypeToOpt::writeData().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Internal function to lookup a sub-dictionary from controlDict.

Definition at line 119 of file debug.C.

References controlDict(), entry::dict(), Foam::endl(), Foam::exit(), entry::isDict(), dictionary::lookupEntryPtr(), and dictionaryName::name().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void addDebugObject	(	const char *	name,
		simpleRegIOobject *	obj
	)

Register debug switch read/write object.

Definition at line 193 of file debug.C.

References DictionaryBase< IDLListType, T >::append(), List< T >::append(), debugObjects(), and DictionaryBase< IDLListType, T >::lookupPtr().

Here is the call graph for this function:

void addInfoObject	(	const char *	name,
		simpleRegIOobject *	obj
	)

Register info switch read/write object.

Definition at line 214 of file debug.C.

References addOptimisationObject(), DictionaryBase< IDLListType, T >::append(), List< T >::append(), infoObjects(), and DictionaryBase< IDLListType, T >::lookupPtr().

Here is the call graph for this function:

void addOptimisationObject	(	const char *	name,
		simpleRegIOobject *	obj
	)

Register optimisation switch read/write object.

Definition at line 236 of file debug.C.

References addDimensionSetObject(), DictionaryBase< IDLListType, T >::append(), List< T >::append(), DictionaryBase< IDLListType, T >::lookupPtr(), and optimisationObjects().

Referenced by addInfoObject().

Here is the call graph for this function:

Here is the caller graph for this function:

void addDimensionSetObject	(	const char *	name,
		simpleRegIOobject *	obj
	)

Register DimensionSets read/write object.

Definition at line 261 of file debug.C.

References addDimensionedConstantObject(), DictionaryBase< IDLListType, T >::append(), List< T >::append(), dimensionSetObjects(), and DictionaryBase< IDLListType, T >::lookupPtr().

Referenced by addOptimisationObject().

Here is the call graph for this function:

Here is the caller graph for this function:

void addDimensionedConstantObject	(	const char *	name,
		simpleRegIOobject *	obj
	)

Register DimensionedConstant read/write object.

Definition at line 286 of file debug.C.

References DictionaryBase< IDLListType, T >::append(), List< T >::append(), dimensionedConstantObjects(), and DictionaryBase< IDLListType, T >::lookupPtr().

Referenced by addDimensionSetObject().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::simpleObjectRegistry & debugObjects ( )

Get access to registered debug switch objects.

Definition at line 313 of file debug.C.

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

Here is the caller graph for this function:

Foam::simpleObjectRegistry & infoObjects ( )

Get access to registered info switch objects.

Definition at line 324 of file debug.C.

Referenced by addInfoObject().

Here is the caller graph for this function:

Foam::simpleObjectRegistry & optimisationObjects ( )

Get access to registered optimisation switch objects.

Definition at line 335 of file debug.C.

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

Here is the caller graph for this function:

Foam::simpleObjectRegistry & dimensionSetObjects ( )

Get access to registered dimensionSets switch objects.

Definition at line 346 of file debug.C.

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

Here is the caller graph for this function:

Foam::simpleObjectRegistry & dimensionedConstantObjects ( )

Get access to registered dimensionedConstant switch objects.

Definition at line 357 of file debug.C.

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

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation