dictionary.H File Reference

Include dependency graph for dictionary.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	dictionaryName
class	dictionary
	A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries. More...
class	dictionary::includedDictionary

Namespaces
	Foam
	Namespace for OpenFOAM.

Macros
#define	DECLARE_SPECIALISED_READ_TYPE(T, nullArg)
	Specialise readType for types for which unit conversions can be performed. More...
#define	DECLARE_SPECIALISED_READ_PAIR_TYPE(T, nullArg)    DECLARE_SPECIALISED_READ_TYPE(Pair<T>, nullArg)
#define	DECLARE_SPECIALISED_READ_LIST_TYPE(T, nullArg)    DECLARE_SPECIALISED_READ_TYPE(List<T>, nullArg)

Functions
Istream &	operator>> (Istream &, dictionary &)
Ostream &	operator<< (Ostream &, const dictionary &)
	FOR_ALL_FIELD_TYPES (DECLARE_SPECIALISED_READ_TYPE)
	FOR_ALL_FIELD_TYPES (DECLARE_SPECIALISED_READ_PAIR_TYPE)
	FOR_ALL_FIELD_TYPES (DECLARE_SPECIALISED_READ_LIST_TYPE)
dictionary	operator+ (const dictionary &dict1, const dictionary &dict2)
	Combine dictionaries. More...
dictionary	operator| (const dictionary &dict1, const dictionary &dict2)
	Combine dictionaries. More...
void	dictArgList (const Tuple2< string, label > &argString, word &configName, List< Tuple2< wordRe, label >> &args, List< Tuple3< word, string, label >> &namedArgs)
	Parse dictionary substitution argument list. More...
void	dictArgList (const Tuple2< string, label > &argString, List< Tuple2< wordRe, label >> &args, List< Tuple3< word, string, label >> &namedArgs)
	Parse dictionary substitution argument list. More...
Pair< word >	dictAndKeyword (const word &scopedName)
	Extracts dict name and keyword. More...
wordList	listAllConfigFiles (const fileName &configFilesPath)
	Return the list of configuration files in. More...
fileName	findConfigFile (const word &configName, const fileName &configFilesPath, const word &configFilesDir, const word &region=word::null)
	Search for configuration file for given region. More...
string	expandArg (const string &arg, dictionary &dict, const label lineNumber)
	Expand arg within the dict context and return. More...
void	addArgEntry (dictionary &dict, const word &keyword, const string &value, const label lineNumber)
	Add the keyword value pair to dict. More...
bool	readConfigFile (const word &configType, const Tuple2< string, label > &argString, dictionary &parentDict, const fileName &configFilesPath, const word &configFilesDir, const word &region=word::null)
	Read the specified configuration file. More...
void	writeEntry (Ostream &os, const dictionary &dict)
	Write a dictionary entry. More...
template<class EntryType >
void	writeEntry (Ostream &os, const word &entryName, const EntryType &value)
	Helper function to write the keyword and entry. More...
template<class EntryType >
void	writeEntry (Ostream &os, const word &entryName, const unitConversion &defaultUnits, const EntryType &value)
	Helper function to write the keyword and entry. More...
template<class EntryType >
void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2)
	Helper function to write the keyword and entry only if the. More...
template<class EntryType >
void	writeEntryIfDifferent (Ostream &os, const word &entryName, const unitConversion &defaultUnits, const EntryType &value1, const EntryType &value2)
	Helper function to write the keyword and entry only if the. More...

Detailed Description

Original source file dictionary.H

Definition in file dictionary.H.

Macro Definition Documentation

DECLARE_SPECIALISED_READ_TYPE

#define DECLARE_SPECIALISED_READ_TYPE	(		T,
			nullArg
	)

Value:

                                                                               \
    template<>                                                                 \
    T Foam::dictionary::readType                                               \
    (                                                                          \
        const word& keyword,                                                   \
        const unitConversion& defaultUnits,                                    \
        ITstream& is                                                           \
    ) const;                                                                   \
                                                                               \
    template<>                                                                 \
    T Foam::dictionary::readType                                               \
    (                                                                          \
        const word& keyword,                                                   \
        ITstream& is                                                           \
    ) const;

Specialise readType for types for which unit conversions can be performed.

Definition at line 899 of file dictionary.H.

DECLARE_SPECIALISED_READ_PAIR_TYPE

#define DECLARE_SPECIALISED_READ_PAIR_TYPE	(		T,
			nullArg
	)		DECLARE_SPECIALISED_READ_TYPE(Pair<T>, nullArg)

Definition at line 916 of file dictionary.H.

DECLARE_SPECIALISED_READ_LIST_TYPE

#define DECLARE_SPECIALISED_READ_LIST_TYPE	(		T,
			nullArg
	)		DECLARE_SPECIALISED_READ_TYPE(List<T>, nullArg)

Definition at line 919 of file dictionary.H.