Namespace for handling debugging switches. More...

Classes
class	deleteControlDictPtr

Typedefs
typedef HashTable< Tuple2< word, HashTable< word > > >	runTimeSelectionToCType

Functions
dictionary *	configDictPtr_ (nullptr)

dictionary *	debugSwitchesPtr_ (nullptr)

dictionary *	infoSwitchesPtr_ (nullptr)

dictionary *	optimisationSwitchesPtr_ (nullptr)

dictionary *	debugDefaultSwitchesPtr_ (nullptr)

dictionary *	infoDefaultSwitchesPtr_ (nullptr)

dictionary *	optimisationDefaultSwitchesPtr_ (nullptr)

dictionary &	debugDefaultSwitches ()

dictionary &	infoDefaultSwitches ()

dictionary &	optimisationDefaultSwitches ()

dictionary &	configDict ()
	The central control dictionary. More...

dictionary &	debugSwitches ()
	The DebugSwitches sub-dictionary in the central configDict. More...

dictionary &	infoSwitches ()
	The InfoSwitches sub-dictionary in the central configDict. More...

dictionary &	optimisationSwitches ()
	The OptimisationSwitches sub-dictionary in the central configDict. 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...

float	floatOptimisationSwitch (const char *name, const float defaultValue=0)
	Lookup optimisation switch or add default value. More...

const word	wordOptimisationSwitch (const char *name, const word &defaultValue)
	Lookup optimisation switch or add default value. More...

template<class Enum , unsigned int nEnum>
Enum	namedEnumOptimisationSwitch (const char *name, const NamedEnum< Enum, nEnum > &enumNames, const Enum defaultValue)
	Lookup optimisation switch or add default value. More...

dictionary &	switchSet (const char subDictName, dictionary &subDictPtr)
	Internal function to lookup a sub-dictionary from configDict. More...

void	listSwitches ()
	List debug switches. More...

Variables
deleteControlDictPtr	deleteControlDictPtr_

bool	enableRunTimeSelectionToC = false
	Switch to enable runTimeSelectionToC collection and caching. More...

runTimeSelectionToCType	runTimeSelectionToC
	Run-time selectable objects. More...

Detailed Description

Namespace for handling debugging switches.

Run-time selection table of contents and addition function.

Source files

Typedef Documentation

◆ runTimeSelectionToCType

typedef HashTable<Tuple2<word, HashTable<word> > > runTimeSelectionToCType

Definition at line 50 of file runTimeSelectionToC.H.

Function Documentation

◆ configDictPtr_()

dictionary* Foam::debug::configDictPtr_ ( nullptr )

Referenced by configDict(), and deleteControlDictPtr::~deleteControlDictPtr().

Here is the caller graph for this function:

◆ debugSwitchesPtr_()

dictionary* Foam::debug::debugSwitchesPtr_ ( nullptr )

Referenced by debugSwitches(), and deleteControlDictPtr::~deleteControlDictPtr().

Here is the caller graph for this function:

◆ infoSwitchesPtr_()

dictionary* Foam::debug::infoSwitchesPtr_ ( nullptr )

Referenced by infoSwitches(), and deleteControlDictPtr::~deleteControlDictPtr().

Here is the caller graph for this function:

◆ optimisationSwitchesPtr_()

dictionary* Foam::debug::optimisationSwitchesPtr_ ( nullptr )

Referenced by optimisationSwitches(), and deleteControlDictPtr::~deleteControlDictPtr().

Here is the caller graph for this function:

◆ debugDefaultSwitchesPtr_()

dictionary* Foam::debug::debugDefaultSwitchesPtr_ ( nullptr )

Referenced by debugDefaultSwitches(), and deleteControlDictPtr::~deleteControlDictPtr().

Here is the caller graph for this function:

◆ infoDefaultSwitchesPtr_()

dictionary* Foam::debug::infoDefaultSwitchesPtr_ ( nullptr )

Referenced by infoDefaultSwitches(), and deleteControlDictPtr::~deleteControlDictPtr().

Here is the caller graph for this function:

◆ optimisationDefaultSwitchesPtr_()

dictionary* Foam::debug::optimisationDefaultSwitchesPtr_ ( nullptr )

Referenced by optimisationDefaultSwitches(), and deleteControlDictPtr::~deleteControlDictPtr().

Here is the caller graph for this function:

◆ debugDefaultSwitches()

dictionary& Foam::debug::debugDefaultSwitches ( )

Definition at line 55 of file debug.C.

References debugDefaultSwitchesPtr_().

Referenced by debugSwitch(), and listSwitches().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ infoDefaultSwitches()

dictionary& Foam::debug::infoDefaultSwitches ( )

Definition at line 65 of file debug.C.

References infoDefaultSwitchesPtr_().

Referenced by infoSwitch(), and listSwitches().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ optimisationDefaultSwitches()

dictionary& Foam::debug::optimisationDefaultSwitches ( )

Definition at line 75 of file debug.C.

References optimisationDefaultSwitchesPtr_().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ configDict()

Foam::dictionary & configDict ( )

The central control dictionary.

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

See also: Foam::findEtcFile()

Definition at line 117 of file debug.C.

References configDictPtr_(), Foam::endl(), Foam::findEtcFiles(), forAll, forAllReverse, Foam::getEnv(), Istream::good(), dictionary::merge(), SafeFatalIOErrorInFunction, and List< T >::size().

Referenced by Foam::dimensionedConstantsDict(), argList::displayDoc(), Foam::listSwitches(), switchSet(), Foam::unitsDict(), and Foam::unsetConfigEntries().

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 configDict.

Definition at line 225 of file debug.C.

References debugSwitchesPtr_(), and switchSet().

Referenced by debugSwitch(), 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 configDict.

Definition at line 231 of file debug.C.

References infoSwitchesPtr_(), and 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 configDict.

Definition at line 237 of file debug.C.

References optimisationSwitchesPtr_(), and switchSet().

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

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

References debugDefaultSwitches(), debugSwitches(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, found, 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 262 of file debug.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, found, infoDefaultSwitches(), 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 281 of file debug.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, found, dictionary::lookupOrAddDefault(), Foam::name(), optimisationDefaultSwitches(), and optimisationSwitches().

Here is the call graph for this function:

◆ floatOptimisationSwitch()

float floatOptimisationSwitch	(	const char *	name,
		const float	defaultValue = `0`
	)

Lookup optimisation switch or add default value.

Definition at line 300 of file debug.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, found, dictionary::lookupOrAddDefault(), Foam::name(), optimisationDefaultSwitches(), and optimisationSwitches().

Here is the call graph for this function:

◆ wordOptimisationSwitch()

const Foam::word wordOptimisationSwitch	(	const char *	name,
		const word &	defaultValue
	)

Lookup optimisation switch or add default value.

Definition at line 322 of file debug.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, found, dictionary::lookupOrAddDefault(), Foam::name(), optimisationDefaultSwitches(), and optimisationSwitches().

Referenced by namedEnumOptimisationSwitch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ namedEnumOptimisationSwitch()

Enum Foam::debug::namedEnumOptimisationSwitch	(	const char *	name,
		const NamedEnum< Enum, nEnum > &	enumNames,
		const Enum	defaultValue
	)

Lookup optimisation switch or add default value.

Definition at line 93 of file debug.H.

References Foam::name(), and wordOptimisationSwitch().

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 configDict.

Definition at line 195 of file debug.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listSwitches()

void listSwitches ( )

List debug switches.

Definition at line 484 of file debug.C.

References debugDefaultSwitches(), debugSwitches(), Foam::endl(), Foam::Info, infoDefaultSwitches(), infoSwitches(), Foam::listSwitches(), optimisationDefaultSwitches(), and optimisationSwitches().

Here is the call graph for this function:

Variable Documentation

◆ deleteControlDictPtr_

deleteControlDictPtr deleteControlDictPtr_

Definition at line 108 of file debug.C.

◆ enableRunTimeSelectionToC

bool enableRunTimeSelectionToC = false

extern

Switch to enable runTimeSelectionToC collection and caching.

Definition at line 34 of file runTimeSelectionToC.C.

Referenced by Foam::addToRunTimeSelectionTableToC().

◆ runTimeSelectionToC

Foam::debug::runTimeSelectionToCType runTimeSelectionToC

extern

Run-time selectable objects.

Definition at line 36 of file runTimeSelectionToC.C.

Referenced by Foam::addToRunTimeSelectionTableToC().

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ runTimeSelectionToCType

Function Documentation

◆ configDictPtr_()

◆ debugSwitchesPtr_()

◆ infoSwitchesPtr_()

◆ optimisationSwitchesPtr_()

◆ debugDefaultSwitchesPtr_()

◆ infoDefaultSwitchesPtr_()

◆ optimisationDefaultSwitchesPtr_()

◆ debugDefaultSwitches()

◆ infoDefaultSwitches()

◆ optimisationDefaultSwitches()

◆ configDict()

◆ debugSwitches()

◆ infoSwitches()

◆ optimisationSwitches()

◆ debugSwitch()

◆ infoSwitch()

◆ optimisationSwitch()

◆ floatOptimisationSwitch()

◆ wordOptimisationSwitch()

◆ namedEnumOptimisationSwitch()

◆ switchSet()

◆ listSwitches()

Variable Documentation

◆ deleteControlDictPtr_

◆ enableRunTimeSelectionToC

◆ runTimeSelectionToC