Foam::debug Namespace Reference

Namespace for handling debugging switches. More...

---

Detailed Description

Namespace for handling debugging switches.

Source files

• src/OpenFOAM/global/debug/debug.H
• src/OpenFOAM/global/debug/debug.C

Functions
dictionary &	controlDict ()
	The central control dictionary.
dictionary &	debugSwitches ()
	The DebugSwitches sub-dictionary in the central controlDict.
dictionary &	infoSwitches ()
	The InfoSwitches sub-dictionary in the central controlDict.
dictionary &	optimisationSwitches ()
	The OptimisationSwitches sub-dictionary in the central controlDict.
int	debugSwitch (const char *name, const int defaultValue=0)
	Lookup debug switch or add default value.
int	infoSwitch (const char *name, const int defaultValue=0)
	Lookup info switch or add default value.
int	optimisationSwitch (const char *name, const int defaultValue=0)
	Lookup optimisation switch or add default value.
dictionary &	switchSet (const char *subDictName, dictionary *&subDictPtr)
	Internal function to lookup a sub-dictionary from controlDict.

---

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 74 of file debug.C.

References Foam::findEtcFile().

Referenced by argList::displayDoc(), JobInfo::JobInfo(), PstreamImpl::loadPstreamInstance(), PstreamImpl::loadPstreamLibrary(), dlLibraryTable::open(), Foam::PstreamConfigSectionName(), and switchSet().

Foam::dictionary & debugSwitches

(

)

The DebugSwitches sub-dictionary in the central controlDict.

Definition at line 118 of file debug.C.

References switchSet().

Referenced by debugSwitch().

Foam::dictionary & infoSwitches

(

)

The InfoSwitches sub-dictionary in the central controlDict.

Definition at line 124 of file debug.C.

References switchSet().

Referenced by infoSwitch().

Foam::dictionary & optimisationSwitches

(

)

The OptimisationSwitches sub-dictionary in the central controlDict.

Definition at line 130 of file debug.C.

References switchSet().

Referenced by optimisationSwitch().

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

Lookup debug switch or add default value.

Definition at line 136 of file debug.C.

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

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

Lookup info switch or add default value.

Definition at line 145 of file debug.C.

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

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

Lookup optimisation switch or add default value.

Definition at line 154 of file debug.C.

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

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

Internal function to lookup a sub-dictionary from controlDict.

Definition at line 89 of file debug.C.

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

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