A list of keyword definitions, which are a keyword followed by a number of values (eg, words and numbers) or by a sub-dictionary. Since the dictionary format is used extensively throughout OpenFOAM for input/output files, there are many examples of its use. More...

Inheritance diagram for dictionary:

[legend]

Collaboration diagram for dictionary:

[legend]

Classes
class	Searcher
	Generic const/non-const dictionary entry searcher. More...

Public Types
typedef Searcher< true >	const_searcher
	Searcher with const access. More...

typedef Searcher< false >	searcher
	Searcher with non-const access. More...

Public Member Functions
	ClassName ("dictionary")

	dictionary ()
	Default construct, a top-level empty dictionary. More...

	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name. More...

	dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)

	dictionary (Istream &is)

	dictionary (Istream &is, bool keepHeader)

	dictionary (const dictionary &parentDict, const dictionary &dict)
	Copy construct given the parent dictionary. More...

	dictionary (const dictionary &dict)
	Copy construct top-level dictionary. More...

	dictionary (const dictionary *dict)
	Construct top-level dictionary as copy from pointer to dictionary. More...

	dictionary (const dictionary &parentDict, dictionary &&dict)
	Move construct for given parent dictionary. More...

	dictionary (dictionary &&dict)
	Move construct top-level dictionary. More...

autoPtr< dictionary >	clone () const
	Construct and return clone. More...

virtual	~dictionary ()
	Destructor. More...

const fileName &	name () const noexcept
	The dictionary name. More...

fileName &	name () noexcept
	The dictionary name for modification (use with caution). More...

word	dictName () const
	The local dictionary name (final part of scoped name) More...

fileName	relativeName (const bool caseTag=false) const
	The dictionary name relative to the case. More...

bool	isNullDict () const noexcept
	The dictionary is actually dictionary::null (root dictionary) More...

const dictionary &	parent () const noexcept
	Return the parent dictionary. More...

const dictionary &	topDict () const
	Return the top of the tree. More...

label	startLineNumber () const
	Return line number of first token in dictionary. More...

label	endLineNumber () const
	Return line number of last token in dictionary. More...

SHA1Digest	digest () const
	Return the SHA1 digest of the dictionary contents. More...

tokenList	tokens () const
	Return the dictionary as a list of tokens. More...

bool	found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for an entry (const access) with the given keyword. More...

entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find for an entry (non-const access) with the given keyword. More...

const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword. More...

const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for a scoped entry (const access) with the given keyword. More...

dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary pointer if present. More...

const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary pointer if present. More...

const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const
	Search for an entry (const access) with the given keyword. More...

ITstream &	lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
bool	readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)

template<class T , class Predicate >
bool	readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T , class Predicate >
bool	readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

bool	isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Check if entry is found and is a sub-dictionary. More...

const dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary &	subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary	subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const

const dictionary &	optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary, otherwise return this dictionary. More...

wordList	toc () const
	Return the table of contents. More...

wordList	sortedToc () const
	Return the sorted table of contents. More...

template<class Compare >
wordList	sortedToc (const Compare &comp) const
	Return table of contents sorted using the specified comparator. More...

List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns. More...

bool	substituteKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given keyword (which is prefixed by '$') More...

bool	substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given scoped keyword (which is prefixed by '$') More...

entry *	add (entry *entryPtr, bool mergeEntry=false)
	Add a new entry. More...

entry *	add (const entry &e, bool mergeEntry=false)
	Add an entry. More...

entry *	add (const keyType &k, const word &v, bool overwrite=false)
	Add a word entry. More...

entry *	add (const keyType &k, const string &v, bool overwrite=false)
	Add a string entry. More...

entry *	add (const keyType &k, const label v, bool overwrite=false)
	Add a label entry. More...

entry *	add (const keyType &k, const scalar v, bool overwrite=false)
	Add a scalar entry. More...

entry *	add (const keyType &k, const dictionary &d, bool mergeEntry=false)
	Add a dictionary entry. More...

template<class T >
entry *	add (const keyType &k, const T &v, bool overwrite=false)
	Add a T entry. More...

entry *	set (entry *entryPtr)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const entry &e)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const keyType &k, const dictionary &v)
	Assign a dictionary entry, overwriting any existing entry. More...

template<class T >
entry *	set (const keyType &k, const T &v)
	Assign a T entry, overwriting any existing entry. More...

bool	remove (const word &keyword)
	Remove an entry specified by keyword. More...

bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
	Change the keyword for an entry,. More...

bool	merge (const dictionary &dict)
	Merge entries from the given dictionary. More...

void	clear ()
	Clear the dictionary. More...

void	transfer (dictionary &dict)
	Transfer the contents of the argument and annul the argument. More...

void	checkITstream (const ITstream &is, const word &keyword) const

bool	read (Istream &is)
	Read dictionary from Istream. Discards the header. More...

bool	read (Istream &is, bool keepHeader)
	Read dictionary from Istream, optionally keeping the header. More...

void	writeEntry (Ostream &os) const
	Write sub-dictionary with its dictName as its header. More...

void	writeEntry (const keyType &keyword, Ostream &os) const
	Write sub-dictionary with the keyword as its header. More...

void	writeEntries (Ostream &os, const bool extraNewLine=false) const
	Write dictionary entries. More...

void	write (Ostream &os, const bool subDict=true) const
	Write dictionary, normally with sub-dictionary formatting. More...

const_searcher	csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

const_searcher	search (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

searcher	search (const word &keyword, enum keyType::option=keyType::REGEX)
	Search dictionary for given keyword. More...

const_searcher	csearchScoped (const word &keyword, enum keyType::option) const
	Search using scoping. More...

const_searcher	searchScoped (const word &keyword, enum keyType::option) const
	Search using dot or slash scoping. More...

searcher	searchScoped (const word &keyword, enum keyType::option)
	Search using dot or slash scoping. More...

const dictionary *	cfindScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

const dictionary *	findScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	findScopedDict (const fileName &dictPath)
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	makeScopedDict (const fileName &dictPath)
	Locate existing or create sub-dictionary using slash-scoping. More...

const_searcher	csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

bool	foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

const entry *	findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

const entry &	lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

ITstream &	lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const

template<class T >
bool	readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const

void	operator= (const dictionary &rhs)
	Copy assignment. More...

void	operator+= (const dictionary &rhs)
	Include entries from the given dictionary. More...

void	operator\|= (const dictionary &rhs)
	Conditionally include entries from the given dictionary. More...

void	operator<<= (const dictionary &rhs)
	Unconditionally include entries from the given dictionary. More...

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
T	lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

ITstream &	operator[] (const word &keyword) const
	Deprecated(2018-07) find and return an entry data stream. More...

bool	found (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
	Deprecated(2018-10) More...

const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const dictionary *	subDictPtr (const word &keyword) const
	Deprecated(2018-10) More...

dictionary *	subDictPtr (const word &keyword)

const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

ITstream &	lookup (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
	Deprecated(2018-10) More...

template<class T >
bool	readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
	Deprecated(2018-10) find and return a T. More...

bool	getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< bool >(const word&, keyType::option) More...

label	getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< label >(const word&, keyType::option) More...

scalar	getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< scalar >(const word&, keyType::option) More...

string	getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< string >(const word&, keyType::option) More...

word	getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< word >(const word&, keyType::option) More...

fileName	getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< fileName >(const word&, keyType::option) More...

template<class Compare >
Foam::wordList	sortedToc (const Compare &comp) const

template<class T >
Foam::entry *	add (const keyType &k, const T &v, bool overwrite)

template<class T >
Foam::entry *	set (const keyType &k, const T &v)

Public Member Functions inherited from ILList< LListBase, T >
	ILList ()=default
	Default construct. More...

	ILList (T *item)
	Construct and insert the initial T item pointer. More...

	ILList (Istream &is)
	Construct from Istream. More...

	ILList (const ILList< LListBase, T > &lst)
	Copy construct using the 'clone()' method for each element. More...

	ILList (ILList< LListBase, T > &&lst)
	Move construct. More...

template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone 'clone()'. More...

template<class INew >
	ILList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

	~ILList ()
	Destructor. More...

bool	eraseHead ()
	Remove the head element specified from the list and delete it. More...

bool	erase (T *item)
	Remove the specified element from the list and delete it. More...

void	clear ()
	Clear the contents of the list. More...

void	transfer (ILList< LListBase, T > &lst)

void	operator= (const ILList< LListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element. More...

void	operator= (ILList< LListBase, T > &&lst)
	Move assignment. More...

Static Public Member Functions
static int	reportOptional () noexcept
	Return the state of reporting optional (default) entries. More...

static int	reportOptional (const int level) noexcept
	Change the state of reporting optional (default) entries. More...

static autoPtr< dictionary >	New (Istream &is)
	Construct top-level dictionary on freestore from Istream. More...

Public Attributes
friend	const_searcher
	Declare friendship with the searcher classes. More...

friend	searcher

Static Public Attributes
static int	writeOptionalEntries
	Report optional keywords and values if not present in dictionary. More...

static const dictionary	null
	An empty dictionary, which is also the parent for all dictionaries. More...

static refPtr< OSstream >	reportingOutput
	Output location when reporting default values. More...

Friends
class	entry
	Declare friendship with the entry class for IO. More...

Istream &	operator>> (Istream &is, dictionary &dict)
	Read dictionary from Istream. More...

Ostream &	operator<< (Ostream &os, const dictionary &dict)
	Write dictionary to Ostream. More...

Detailed Description

A list of keyword definitions, which are a keyword followed by a number of values (eg, words and numbers) or by a sub-dictionary. Since the dictionary format is used extensively throughout OpenFOAM for input/output files, there are many examples of its use.

Dictionary keywords are a plain word or a pattern (regular expression). The general order for searching is as follows:

exact match
pattern match (in reverse order)
optional recursion into the enclosing (parent) dictionaries

The dictionary class is the base class for IOdictionary and also serves as a bootstrap dictionary for the objectRegistry data dictionaries.

Note: Within dictionaries, entries can be referenced by using the '$' syntax familiar from shell programming. A '.' separator is used when referencing sub-dictionary entries. Leading '.' prefixes can be used to specify an entry from a parent dictionary. An initial '^' anchor (or ':' for backward compatibility) specifies starting from the top-level entry. For example,

key1        val1;
key2        $key1;   // use key1 value from current scope
key3        $.key1;  // use key1 value from current scope

subdict1
{
    key1        val1b;
    key2        $..key1; // use key1 value from parent
    subdict2
    {
        key2    val2;
        key3    $...key1; // use key1 value from grandparent
    }
}

key4        $^subdict1.subdict2.key3;  // lookup with absolute scoping

It is also possible to use the '${}' syntax for clarity.

Source files

See also

Definition at line 123 of file dictionary.H.

Member Typedef Documentation

◆ const_searcher

typedef Searcher<true> const_searcher

Searcher with const access.

Definition at line 270 of file dictionary.H.

◆ searcher

typedef Searcher<false> searcher

Searcher with non-const access.

Definition at line 273 of file dictionary.H.

Constructor & Destructor Documentation

◆ dictionary() [1/10]

dictionary ( )

Default construct, a top-level empty dictionary.

Definition at line 75 of file dictionary.C.

Referenced by data::data().

Here is the caller graph for this function:

◆ dictionary() [2/10]

dictionary ( const fileName & name )

explicit

Construct top-level empty dictionary with given name.

Definition at line 82 of file dictionary.C.

◆ dictionary() [3/10]

dictionary	(	const fileName &	name,
		const dictionary &	parentDict,
		Istream &	is,
		bool	keepHeader = `false`
	)

Construct given the entry name, parent dictionary and Istream, reading entries until EOF, optionally keeping the header

Definition at line 35 of file dictionaryIO.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ dictionary() [4/10]

dictionary ( Istream & is )

Construct top-level dictionary from Istream, reading entries until EOF. Discards the header.

Note: this constructor should be explicit

Definition at line 49 of file dictionaryIO.C.

◆ dictionary() [5/10]

dictionary	(	Istream &	is,
		bool	keepHeader
	)

Construct top-level dictionary from Istream, reading entries until EOF, optionally keeping the header

Definition at line 55 of file dictionaryIO.C.

References dictionary::read(), and entry::resetInputMode().

Here is the call graph for this function:

◆ dictionary() [6/10]

dictionary	(	const dictionary &	parentDict,
		const dictionary &	dict
	)

Copy construct given the parent dictionary.

Definition at line 90 of file dictionary.C.

References Foam::constant::electromagnetic::e.

◆ dictionary() [7/10]

dictionary ( const dictionary & dict )

Copy construct top-level dictionary.

Definition at line 113 of file dictionary.C.

References Foam::constant::electromagnetic::e.

◆ dictionary() [8/10]

dictionary ( const dictionary * dict )

explicit

Construct top-level dictionary as copy from pointer to dictionary.

A null pointer is treated like an empty dictionary.

Definition at line 134 of file dictionary.C.

References dict, and dictionary::operator=().

Here is the call graph for this function:

◆ dictionary() [9/10]

dictionary	(	const dictionary &	parentDict,
		dictionary &&	dict
	)

Move construct for given parent dictionary.

Definition at line 147 of file dictionary.C.

References fileName::concat(), dict, Foam::name(), and dictionary::name().

Here is the call graph for this function:

◆ dictionary() [10/10]

dictionary ( dictionary && dict )

Move construct top-level dictionary.

Definition at line 161 of file dictionary.C.

References dict.

◆ ~dictionary()

~dictionary ( )

virtual

Destructor.

Definition at line 180 of file dictionary.C.

Member Function Documentation

◆ ClassName()

ClassName ( "dictionary" )

◆ reportOptional() [1/2]

int reportOptional ( )

inlinestaticnoexcept

Return the state of reporting optional (default) entries.

0: no reporting, 1: report, 2: fatal if not set

Definition at line 32 of file dictionaryI.H.

References dictionary::writeOptionalEntries.

◆ reportOptional() [2/2]

int reportOptional ( const int level )

inlinestaticnoexcept

Change the state of reporting optional (default) entries.

0: no reporting, 1: report, 2: fatal if not set

Returns: old level

Definition at line 38 of file dictionaryI.H.

◆ clone()

Foam::autoPtr< Foam::dictionary > clone ( ) const

Construct and return clone.

Definition at line 172 of file dictionary.C.

References autoPtr< T >::New().

Referenced by hexRef8Data::hexRef8Data(), Foam::preservePatchTypes(), and refinementSurfaces::refinementSurfaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New()

Foam::autoPtr< Foam::dictionary > New ( Istream & is )

static

Construct top-level dictionary on freestore from Istream.

Definition at line 69 of file dictionaryIO.C.

References autoPtr< T >::New().

Referenced by objectiveManager::objectiveManager().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name() [1/2]

const Foam::fileName & name ( ) const

inlinenoexcept

The dictionary name.

Definition at line 48 of file dictionaryI.H.

Referenced by chemkinReader::chemkinReader(), Foam::copyFilteredDict(), dictionary::dictionary(), decompositionMethod::findCoeffsDict(), motionSmootherAlgo::get(), meshRefinement::get(), JobInfo::JobInfo(), meshRefinement::lookup(), dictionaryEntry::name(), dictionary::operator=(), Foam::operator>>(), dynamicCodeContext::readEntry(), meshRefinement::subDict(), dictionary::transfer(), Foam::unitSet(), codedBase::updateLibrary(), and velocityDisplacementMotionSolver::velocityDisplacementMotionSolver().

Here is the caller graph for this function:

◆ name() [2/2]

Foam::fileName & name ( )

inlinenoexcept

The dictionary name for modification (use with caution).

Definition at line 54 of file dictionaryI.H.

◆ dictName()

Foam::word dictName ( ) const

inline

The local dictionary name (final part of scoped name)

Definition at line 60 of file dictionaryI.H.

Referenced by radiation::addSup(), interRegionHeatTransferModel::addSup(), effectivenessHeatExchangerSource::addSup(), hydrostaticPressure::calculateAndWrite(), variableHeatTransfer::calculateHtc(), limitTemperature::correct(), ReynoldsAnalogy::Cp(), ReynoldsAnalogy::devReff(), filmTurbulenceModel::devRhoReff(), forces::devRhoReff(), effectivenessHeatExchangerSource::effectivenessHeatExchangerSource(), wallHeatFlux::execute(), jouleHeatingSource::jouleHeatingSource(), forces::mu(), blendingMethod::New(), thermophysicalProperties::New(), basicSolidChemistryModel::New(), liquidProperties::New(), objectiveIncompressible::New(), profileModel::New(), heatTransferCoeffModel::q(), multiFieldValue::read(), solidificationMeltingSource::solidificationMeltingSource(), mixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), gradientUnburntEnthalpyFvPatchScalarField::updateCoeffs(), fixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs(), outletMachNumberPressureFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), and viscousDissipation::viscousDissipation().

Here is the caller graph for this function:

◆ relativeName()

Foam::fileName relativeName ( const bool caseTag = false ) const

The dictionary name relative to the case.

Uses argList::envRelativePath to obtain FOAM_CASE

Parameters

caseTag replace globalPath with <case> for later use with expand(), or prefix <case> if the file name was not an absolute location

Definition at line 186 of file dictionary.C.

References argList::envRelativePath(), and Foam::name().

Referenced by codeStream::evaluate(), includeEtcEntry::execute(), includeEntry::execute(), messageStream::operator()(), IOerror::operator()(), dimensionSet::readEntry(), dictionaryEntry::relativeName(), and Foam::warnCompatDegrees().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNullDict()

bool isNullDict ( ) const

inlinenoexcept

The dictionary is actually dictionary::null (root dictionary)

Definition at line 74 of file dictionaryI.H.

References dictionary::null.

◆ parent()

const Foam::dictionary & parent ( ) const

inlinenoexcept

Return the parent dictionary.

Definition at line 80 of file dictionaryI.H.

◆ topDict()

const Foam::dictionary & topDict ( ) const

Return the top of the tree.

Definition at line 192 of file dictionary.C.

References p.

Referenced by includeEntry::execute(), and codeStream::getFunction().

Here is the caller graph for this function:

◆ startLineNumber()

Foam::label startLineNumber ( ) const

Return line number of first token in dictionary.

Definition at line 205 of file dictionary.C.

Referenced by messageStream::operator()(), IOerror::operator()(), and codedBase::updateLibrary().

Here is the caller graph for this function:

◆ endLineNumber()

Foam::label endLineNumber ( ) const

Return line number of last token in dictionary.

Definition at line 216 of file dictionary.C.

Referenced by messageStream::operator()(), and IOerror::operator()().

Here is the caller graph for this function:

◆ digest()

Foam::SHA1Digest digest ( ) const

Return the SHA1 digest of the dictionary contents.

Definition at line 227 of file dictionary.C.

References Foam::constant::electromagnetic::e, and os().

Referenced by functionObjectList::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tokens()

Foam::tokenList tokens ( ) const

Return the dictionary as a list of tokens.

Definition at line 241 of file dictionary.C.

References Foam::constant::electromagnetic::e, os(), and ITstream::parse().

Here is the call graph for this function:

◆ found() [1/2]

bool found	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Search for an entry (const access) with the given keyword.

Parameters

matchOpt the default search is non-recursive with patterns

Returns: True if entry was found

Definition at line 87 of file dictionaryI.H.

◆ findEntry() [1/2]

Foam::entry * findEntry	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)

inline

Find for an entry (non-const access) with the given keyword.

Parameters

matchOpt the search mode

Returns: the entry pointer found or a nullptr.

Definition at line 97 of file dictionaryI.H.

References Foam::search().

Referenced by dynamicCodeContext::findEntry(), Foam::getOrAdd(), dictionary::lookupEntryPtr(), sampledSurfaces::read(), dynamicCodeContext::readEntry(), dimensionSet::readEntry(), refinementSurfaces::refinementSurfaces(), shellSurfaces::shellSurfaces(), solution::upgradeSolverDict(), and Foam::writeEntryIfPresent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findEntry() [2/2]

const Foam::entry * findEntry	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Find an entry (const access) with the given keyword.

Parameters

matchOpt the default search is non-recursive with patterns

Returns: the entry pointer found or a nullptr.

Definition at line 107 of file dictionaryI.H.

◆ findScoped()

const Foam::entry * findScoped	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Search for a scoped entry (const access) with the given keyword.

Allows scoping using '.'. Special handling for an absolute anchor (^) at start of the keyword and for '..' to ascend into the parent dictionaries.

Parameters

matchOpt the default search is non-recursive with patterns

Returns: the entry pointer found or a nullptr.

Definition at line 117 of file dictionaryI.H.

Referenced by Foam::getVariable(), Foam::getVariableOrDie(), and dictionary::lookupScopedEntryPtr().

Here is the caller graph for this function:

◆ findDict() [1/2]

Foam::dictionary * findDict	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)

inline

Find and return a sub-dictionary pointer if present.

(and a sub-dictionary) otherwise return nullptr.

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 127 of file dictionaryI.H.

References Foam::search().

Referenced by Foam::cfindCoeffsDict(), codedFunctionObject::codeContext(), codedMixedFvPatchField< Type >::codeContext(), faMesh::faMesh(), writerCaching::fieldsDict(), oversetFvPatchField< Type >::initEvaluate(), loopControl::loopControl(), namedBlock::namedBlock(), namedVertex::namedVertex(), laminarModel< BasicMomentumTransportModel >::New(), RASModelVariables::New(), decompositionMethod::optionalRegionDict(), blockVertex::read(), adjointRASModel::read(), PDRblock::read(), Time::readDict(), lumpedPointMovement::readDict(), functionObjectList::readFunctionObject(), Foam::resetFuncsImpl(), Time::setMonitoring(), dictionary::subDictPtr(), Foam::unitSet(), blockVertex::write(), blockDescriptor::write(), and Foam::writeFuncsImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findDict() [2/2]

const Foam::dictionary * findDict	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Find and return a sub-dictionary pointer if present.

(and a sub-dictionary) otherwise return nullptr.

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 137 of file dictionaryI.H.

◆ lookupEntry() [1/2]

const Foam::entry & lookupEntry	(	const word &	keyword,
		enum keyType::option	matchOpt
	)		const

Search for an entry (const access) with the given keyword.

Parameters

matchOpt the default search is non-recursive with patterns

Returns: return an entry if present, otherwise FatalIOError.

Definition at line 366 of file dictionary.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::nl, and dictionary::Searcher< Const >::ref().

Referenced by lduMatrix::smoother::getName(), lduMatrix::preconditioner::getName(), dictionary::lookupEntry(), lduMatrix::smoother::New(), and lduMatrix::preconditioner::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookup() [1/2]

Foam::ITstream & lookup	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find and return an entry data stream. FatalIOError if not found, or not a stream

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 386 of file dictionary.C.

Referenced by equationMaxIterCondition::apply(), forceList::forceList(), Foam::getLazyPair(), Foam::getRadius(), dictionary::lookup(), interpolation< Foam::Vector >::New(), multivariateIndependentScheme< Type >::operator()(), dictionary::operator[](), dimensionSet::read(), shellSurfaces::shellSurfaces(), and solverInfo::updateSolverInfo().

Here is the caller graph for this function:

◆ get()

T get	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect.

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 107 of file dictionaryTemplates.C.

References Foam::T().

Referenced by geometric::add(), columnFvMeshInfo::addLocalPatches(), chemkinReader::chemkinReader(), CloudFunctionObjectList< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::CloudFunctionObjectList(), coalCloudList::coalCloudList(), axisAligned::computeControlPoints(), filmTurbulenceModel::Cw(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), DAC< CompType, ThermoType >::DAC(), dynamicCodeContext::dict(), Foam::dimensionedConstant(), directions::directions(), argList::displayDoc(), thermalShell::evolveRegion(), KirchhoffShell::evolveRegion(), FreeStream< CloudType >::FreeStream(), Foam::getLazyPair(), Foam::getRadius(), dynamicMultiMotionSolverFvMesh::init(), InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::InjectionModelList(), ISAT< CompType, ThermoType >::ISAT(), layerParameters::layerParameters(), Foam::MULES::limiterCorr(), liquidFilmModel::liquidFilmModel(), medialAxisMeshMover::move(), multiDirRefinement::multiDirRefinement(), decompositionMethod::nDomains(), blendingMethod::New(), saturationModel::New(), basicSolidChemistryModel::New(), chemistryTabulationMethod< ReactionThermo, ThermoType >::New(), optimisationManager::New(), objectiveManager::New(), coordinateRotation::New(), laminarFlameSpeed::New(), chemistryReductionMethod< ReactionThermo, ThermoType >::New(), displacementMethod::New(), phaseModel::New(), surfaceTensionModel::New(), adjointTurbulenceModel::New(), ATCModel::New(), optMeshMovement::New(), liquidProperties::New(), cellCellStencil::New(), objectiveIncompressible::New(), filmTurbulenceModel::New(), profileModel::New(), updateMethod::New(), decompositionMethod::New(), liquidFilmBase::New(), lduMatrix::solver::New(), waveModel::New(), LduMatrix< Type, DType, LUType >::solver::New(), NURBS3DVolume::New(), sampledSet::New(), option::New(), sampledSurface::New(), LduMatrix< Type, DType, LUType >::smoother::New(), functionObject::New(), LduMatrix< Type, DType, LUType >::preconditioner::New(), objectiveIncompressible::objectiveIncompressible(), objectiveManager::objectiveManager(), offsetSurface::offsetSurface(), omegaWallFunctionFvPatchScalarField::omegaWallFunctionFvPatchScalarField(), dynamicCodeContext::operator const dictionary &(), Foam::operator>>(), optMeshMovement::optMeshMovement(), IOobject::parseHeader(), plane::plane(), solutionControl::read(), timeControl::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), patchProbes::read(), heatTransferCoeffModel::read(), areaWrite::read(), sampledSurfaces::read(), forces::read(), Foam::readBoxDim(), dynamicRefineFvMesh::readDict(), Time::readDict(), functionObjectList::readFunctionObject(), SIMPLEControlSingleRun::readIters(), SIMPLEControl::readIters(), refinementSurfaces::refinementSurfaces(), boundaryRegion::rename(), rigidBodyModel::rigidBodyModel(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setCdSigma(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setPorosityCoefficient(), twoPhaseSystem::solve(), multiphaseSystem::solve(), populationBalanceModel::solve(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), surfaceZonesInfo::surfaceZonesInfo(), Switch::Switch(), Foam::unitSet(), dynamicRefineFvMesh::update(), WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), thermalBaffleFvPatchScalarField::write(), and ensightWriter::writeCollated().

Here is the call graph for this function:

◆ getOrDefault()

T getOrDefault	(	const word &	keyword,
		const T &	deflt,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect.

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 148 of file dictionaryTemplates.C.

References dictionary::Searcher< Const >::good(), dictionary::Searcher< Const >::ptr(), and Foam::T().

Referenced by atmBoundaryLayerInletEpsilonFvPatchScalarField::atmBoundaryLayerInletEpsilonFvPatchScalarField(), atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), atmBoundaryLayerInletOmegaFvPatchScalarField::atmBoundaryLayerInletOmegaFvPatchScalarField(), atmBoundaryLayerInletVelocityFvPatchVectorField::atmBoundaryLayerInletVelocityFvPatchVectorField(), sensitivitySurface::computeRadius(), ATCModel::createLimiter(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cylindrical::cylindrical(), faMesh::faMesh(), freeSurfaceVelocityFvPatchVectorField::freeSurfaceVelocityFvPatchVectorField(), Foam::getVerbosity(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), dictionary::lookupOrDefault(), tableReader< scalar >::New(), stepUpdate::New(), zeroATCcells::New(), lineSearch::New(), coordinateSystem::New(), Foam::operator>>(), argList::parse(), profiling::profiling(), SIMPLEControlOpt::read(), SIBase::read(), FIBase::read(), adjointMeshMovementSolver::read(), solverControl::read(), sensitivityBezierFI::read(), sensitivitySurfacePoints::read(), solutionControl::read(), timeControl::read(), sensitivitySurface::read(), adjointEikonalSolver::read(), fieldValue::read(), explicitPorositySource::read(), areaWrite::read(), functionObjectList::read(), directionalPressureGradientExplicitSource::read(), targetCoeffTrim::read(), sampledSurfaces::read(), functionObject::read(), PDRblock::read(), smoothSolver::readControls(), lduMatrix::solver::readControls(), temperatureDependent::readDict(), adjointSolver::readDict(), externalFileCoupler::readDict(), lumpedPointMovement::readDict(), refinementSurfaces::refinementSurfaces(), rotatingPressureInletOutletVelocityFvPatchVectorField::rotatingPressureInletOutletVelocityFvPatchVectorField(), searchableSurfaces::searchableSurfaces(), cellTable::selectType(), Time::setMonitoring(), slidingInterface::setTolerances(), shellSurfaces::shellSurfaces(), shortestPathSet::shortestPathSet(), fvMatrix< Type >::fvSolver::solve(), faMatrix< Type >::solve(), populationBalanceModel::solve(), fvMatrix< Type >::solveCoupled(), fvMatrix< Type >::solveSegregated(), fvMatrix< Type >::solveSegregatedOrCoupled(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), triSurface::triSurface(), triSurfaceMesh::triSurfaceMesh(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField(), turbulentMixingLengthFrequencyInletFvPatchScalarField::turbulentMixingLengthFrequencyInletFvPatchScalarField(), UnsortedMeshedSurface< Face >::UnsortedMeshedSurface(), dynamicRefineFvMesh::update(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), vtkWriter::vtkWriter(), VTKedgeFormat::write(), and ensightWriter::writeCollated().

Here is the call graph for this function:

◆ getOrAdd()

T getOrAdd	(	const word &	keyword,
		const T &	deflt,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)

Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect.

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 178 of file dictionaryTemplates.C.

References Foam::add(), dictionary::Searcher< Const >::good(), dictionary::Searcher< Const >::ptr(), and Foam::T().

Referenced by Switch::getOrAddToDict(), and dictionary::lookupOrAddDefault().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readEntry()

bool readEntry	(	const word &	keyword,
		T &	val,
		enum keyType::option	matchOpt = `keyType::REGEX`,
		bool	mandatory = `true`
	)		const

Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found.

Parameters

val	the value to read into
matchOpt	the default search is non-recursive with patterns
mandatory	the keyword is mandatory (default: true)

Returns: true if the entry was found.

Definition at line 302 of file dictionaryTemplates.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::name(), Foam::nl, and dictionary::Searcher< Const >::ptr().

Referenced by advectiveFvPatchField< Type >::advectiveFvPatchField(), BreakupModel< Foam::SprayCloud< Foam::DSMCCloud > >::BreakupModel(), cellToPoint::cellToPoint(), fromFile::computeControlPoints(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), argList::displayDoc(), faceToCell::faceToCell(), faceToPoint::faceToPoint(), motionSmootherAlgo::get(), meshRefinement::get(), humidityTemperatureCoupledMixedFvPatchScalarField::humidityTemperatureCoupledMixedFvPatchScalarField(), liquidFilmThermo::initLiquid(), mappedPatchBase::mappedPatchBase(), multiBandZoneAbsorptionEmission::multiBandZoneAbsorptionEmission(), nastranWriter::nastranWriter(), combustionModel::New(), oldCyclicPolyPatch::oldCyclicPolyPatch(), Foam::operator>>(), argList::parse(), pointToCell::pointToCell(), pointToFace::pointToFace(), exponentialRepulsion::read(), lennardJones::read(), harmonicSpring::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), dampedCoulomb::read(), anisotropicFilter::read(), laplaceFilter::read(), sigmoid::read(), doubleSigmoid::read(), azizChen::read(), maitlandSmith::read(), thermalBaffle::read(), Arrhenius< ViscousModel >::read(), CrossPowerLaw::read(), powerLaw::read(), HerschelBulkley::read(), BirdCarreau::read(), consumptionSpeed::read(), Casson::read(), multiphaseMangrovesSource::read(), reactionRateFlameArea::read(), limitVelocity::read(), multiphaseMangrovesTurbulenceModel::read(), limitTemperature::read(), phaseModel::read(), fieldValue::read(), radialActuationDiskSource::read(), kinematicSingleLayer::read(), areaWrite::read(), sampledSets::read(), porosityModel::read(), probes::read(), adjointRASModel::read(), sampledSurfaces::read(), Foam::readBoxDim(), thermo::readControls(), dynamicRefineFvMesh::readDict(), streamFunction::readDict(), Time::readDict(), externalFileCoupler::readDict(), lumpedPointMovement::readDict(), regionProperties::regionProperties(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), sampledCuttingPlane::sampledCuttingPlane(), sampledCuttingSurface::sampledCuttingSurface(), sampledInterface::sampledInterface(), sampledIsoSurface::sampledIsoSurface(), sampledPlane::sampledPlane(), searchableSurfaceCollection::searchableSurfaceCollection(), sizeDistribution::setCellZoneCells(), reducedUnits::setRefValues(), shellSurfaces::shellSurfaces(), sixDoFRigidBodyDisplacementPointPatchVectorField::sixDoFRigidBodyDisplacementPointPatchVectorField(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), slidingInterface::slidingInterface(), surfaceFeatures::surfaceFeatures(), surfaceZonesInfo::surfaceZonesInfo(), constantFilmThermo::Tb(), thermoCoupleProbes::thermoCoupleProbes(), valueAverage::valueAverage(), viscousDissipation::viscousDissipation(), constantFilmThermo::W(), writer::writeSolution(), and zoneCombustion< ReactionThermo >::zoneCombustion().

Here is the call graph for this function:

◆ readIfPresent() [1/2]

bool readIfPresent	(	const word &	keyword,
		T &	val,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect.

Default search: non-recursive with patterns.

Parameters

val	the value to read into
matchOpt	the default search is non-recursive with patterns

Returns: true if the entry was found.

Definition at line 405 of file dictionaryTemplates.C.

Referenced by advectiveFvPatchField< Type >::advectiveFvPatchField(), averageCondition::averageCondition(), boxToCell::boxToCell(), boxToFace::boxToFace(), boxToPoint::boxToPoint(), cellToPoint::cellToPoint(), chemkinReader::chemkinReader(), cloudSolution::cloudSolution(), coupleGroupIdentifier::coupleGroupIdentifier(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), dlLibraryTable::dlLibraryTable(), faceToCell::faceToCell(), faceToPoint::faceToPoint(), faceZoneToCell::faceZoneToCell(), fvMotionSolverEngineMesh::fvMotionSolverEngineMesh(), geometricSurfacePatch::geometricSurfacePatch(), subModelBase::getBaseProperty(), subModelBase::getModelProperty(), properties::getObjectProperty(), properties::getObjectResult(), refinementParameters::getZoneInfo(), humidityTemperatureCoupledMixedFvPatchScalarField::humidityTemperatureCoupledMixedFvPatchScalarField(), kinematicSingleLayer::info(), objectivePtLosses::initialize(), layeredEngineMesh::layeredEngineMesh(), layerParameters::layerParameters(), lumpedPointDisplacementPointPatchVectorField::lumpedPointDisplacementPointPatchVectorField(), mappedPatchBase::mappedPatchBase(), decompositionMethod::nDomains(), liquidProperties::New(), decompositionMethod::New(), oldCyclicPolyPatch::oldCyclicPolyPatch(), dlLibraryTable::open(), IOobject::parseHeader(), patchIdentifier::patchIdentifier(), patchToCell::patchToCell(), patchToFace::patchToFace(), pointHistory::pointHistory(), pointToCell::pointToCell(), pointToFace::pointToFace(), porosityModel::porosityModel(), Foam::preservePatchTypes(), maxDeltaxyz::read(), IDDESDelta::read(), writeFreeSurface::read(), pointHistory::read(), multiphaseMangrovesTurbulenceModel::read(), patchProbes::read(), buoyancyEnergy::read(), heatTransferCoeffModel::read(), fixedTemperatureConstraint::read(), explicitPorositySource::read(), kinematicSingleLayer::read(), areaWrite::read(), MRFZone::read(), porosityModel::read(), probes::read(), noiseModel::read(), LduMatrix< Type, DType, LUType >::solver::readControls(), Time::readDict(), lumpedPointMovement::readDict(), decomposedBlockData::readHeader(), thermophysicalProperties::readIfPresent(), solidProperties::readIfPresent(), Switch::readIfPresent(), liquidProperties::readIfPresent(), dictionary::readIfPresent(), refinementSurfaces::refinementSurfaces(), sampledCuttingPlane::sampledCuttingPlane(), sampledCuttingSurface::sampledCuttingSurface(), sampledInterface::sampledInterface(), sampledIsoSurface::sampledIsoSurface(), sampledMeshedSurface::sampledMeshedSurface(), sampledPlane::sampledPlane(), Time::setControls(), Time::setTime(), sixDoFRigidBodyDisplacementPointPatchVectorField::sixDoFRigidBodyDisplacementPointPatchVectorField(), surfaceWriter::surfaceWriter(), surfaceZonesInfo::surfaceZonesInfo(), surfZoneIdentifier::surfZoneIdentifier(), Switch::Switch(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), triSurfaceMesh::triSurfaceMesh(), triSurfaceSearch::triSurfaceSearch(), updateMethod::updateMethod(), faMeshDecomposition::updateParameters(), topoSetSource::verbose(), writeFreeSurface::writeFreeSurface(), x3dWriter::x3dWriter(), zeroATCcells::zeroATCcells(), zoneIdentifier::zoneIdentifier(), zoneToCell::zoneToCell(), zoneToFace::zoneToFace(), and zoneToPoint::zoneToPoint().

◆ getCheck()

T getCheck	(	const word &	keyword,
		const Predicate &	pred,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find and return a T with additional checking FatalIOError if not found, or if the number of tokens is incorrect.

Parameters

pred	the value check predicate
matchOpt	the default search is non-recursive with patterns

Definition at line 120 of file dictionaryTemplates.C.

References Foam::T().

Referenced by electrostaticDepositionFvPatchScalarField::electrostaticDepositionFvPatchScalarField(), and electricPotential::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCheckOrDefault()

T getCheckOrDefault	(	const word &	keyword,
		const T &	deflt,
		const Predicate &	pred,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect.

Parameters

pred	the value check predicate
matchOpt	the default search is non-recursive with patterns

Definition at line 209 of file dictionaryTemplates.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::name(), dictionary::Searcher< Const >::ptr(), and Foam::T().

Here is the call graph for this function:

◆ getCheckOrAdd()

T getCheckOrAdd	(	const word &	keyword,
		const T &	deflt,
		const Predicate &	pred,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)

Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect.

Parameters

pred	the value check predicate
matchOpt	the default search is non-recursive with patterns

Definition at line 255 of file dictionaryTemplates.C.

References Foam::add(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::name(), dictionary::Searcher< Const >::ptr(), and Foam::T().

Here is the call graph for this function:

◆ readCheck()

bool readCheck	(	const word &	keyword,
		T &	val,
		const Predicate &	pred,
		enum keyType::option	matchOpt = `keyType::REGEX`,
		bool	mandatory = `true`
	)		const

Find entry and assign to T val. FatalIOError if it is found and the number of tokens is incorrect, or it is mandatory and not found.

Parameters

val	the value to read into
pred	the value check predicate
matchOpt	the default search is non-recursive with patterns
mandatory	the keyword is mandatory

Returns: true if the entry was found.

Definition at line 334 of file dictionaryTemplates.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::name(), Foam::nl, and dictionary::Searcher< Const >::ptr().

Here is the call graph for this function:

◆ readCheckIfPresent()

bool readCheckIfPresent	(	const word &	keyword,
		T &	val,
		const Predicate &	pred,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find an entry if present, and assign to T val. FatalIOError if it is found and the number of tokens is incorrect.

Default search: non-recursive with patterns.

Parameters

val	the value to read into
pred	the value check predicate
matchOpt	the default search is non-recursive with patterns

Returns: true if the entry was found.

Definition at line 418 of file dictionaryTemplates.C.

◆ isDict()

bool isDict	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Check if entry is found and is a sub-dictionary.

Parameters

matchOpt the default search is non-recursive with patterns

Returns: true if the entry was found.

Definition at line 147 of file dictionaryI.H.

Referenced by boundaryRadiationProperties::boundaryRadiationProperties(), properties::getObjectDict(), basicChemistryModel::New(), reader::remapMeshInfo(), and writer::writeSolution().

Here is the caller graph for this function:

◆ subDict() [1/2]

const Foam::dictionary & subDict	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find and return a sub-dictionary.

Fatal if the entry does not exist or is not a sub-dictionary.

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 460 of file dictionary.C.

References dictionary::Searcher< Const >::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), and Foam::nl.

Referenced by sixDoFRigidBodyMotion::addConstraints(), snappyLayerDriver::addLayers(), sixDoFRigidBodyMotion::addRestraints(), adjointSimple::adjointSimple(), adjointSolverManager::adjointSolverManager(), averageCondition::averageCondition(), boundaryRadiationProperties::boundaryRadiationProperties(), coordinateSystem::coordinateSystem(), DAC< CompType, ThermoType >::DAC(), Foam::dimensionedConstant(), directions::directions(), argList::displayDoc(), DRG< CompType, ThermoType >::DRG(), DRGEP< CompType, ThermoType >::DRGEP(), faMesh::faMesh(), subModelBase::getBaseProperty(), subModelBase::getModelDict(), subModelBase::getModelProperty(), properties::getObjectDict(), properties::getObjectResult(), refinementParameters::getZoneInfo(), properties::hasResultObjectEntry(), humidityTemperatureCoupledMixedFvPatchScalarField::humidityTemperatureCoupledMixedFvPatchScalarField(), dynamicMultiMotionSolverFvMesh::init(), oversetFvPatchField< Type >::initEvaluate(), cloudSolution::integrationSchemes(), cloudSolution::interpolationSchemes(), multiBandZoneAbsorptionEmission::multiBandZoneAbsorptionEmission(), basicChemistryModel::New(), basicSolidChemistryModel::New(), phaseModel::New(), RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::New(), LESModel< BasicTurbulenceModel >::New(), waveModel::New(), coordinateSystem::New(), objectiveManager::objectiveManager(), properties::objectResultEntries(), properties::objectResultType(), optimisationManager::optimisationManager(), PFA< CompType, ThermoType >::PFA(), Foam::preservePatchTypes(), pyrolysisModelCollection::pyrolysisModelCollection(), lennardJones::read(), harmonicSpring::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), dampedCoulomb::read(), tolerances::read(), sigmoid::read(), doubleSigmoid::read(), porosityModelList::read(), optimisationManager::read(), runTimeControl::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), FixedValueConstraint< Type >::read(), MRFZoneList::read(), kinematicSingleLayer::read(), PDRblock::read(), thermo::readControls(), sensitivityMultiple::readDict(), adjointSolverManager::readDict(), adjointSimple::readDict(), adjointSolver::readDict(), lumpedPointMovement::readDict(), liquidProperties::readIfPresent(), refinementSurfaces::refinementSurfaces(), reader::remapMeshInfo(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), subModelBase::setBaseProperty(), runTimeCondition::setConditionDict(), subModelBase::setModelProperty(), properties::setObjectResult(), shellSurfaces::shellSurfaces(), solverControl::solutionDict(), cloudSolution::sourceTermDict(), steadyOptimisation::steadyOptimisation(), volBSplinesBase::volBSplinesBase(), averageCondition::write(), thermalBaffleFvPatchScalarField::write(), properties::writeResultEntries(), and writer::writeSolution().

Here is the call graph for this function:

◆ subDict() [2/2]

Foam::dictionary & subDict	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)

Find and return a sub-dictionary for manipulation.

Fatal if the entry does not exist or is not a sub-dictionary.

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 480 of file dictionary.C.

References dictionary::Searcher< Const >::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::nl, and Foam::search().

Here is the call graph for this function:

◆ subDictOrAdd()

Foam::dictionary & subDictOrAdd	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)

Find and return a sub-dictionary for manipulation.

Fatal if the entry exist and is not a sub-dictionary.

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 500 of file dictionary.C.

References dictionary::Searcher< Const >::dictPtr(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::nl, Foam::search(), and Foam::BitOps::set().

Referenced by sensitivitySurface::smoothSensitivities(), and mappedPatchBase::writeDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subOrEmptyDict()

Foam::dictionary subOrEmptyDict	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`,
		const bool	mandatory = `false`
	)		const

Find and return a sub-dictionary as a copy, otherwise return an empty dictionary.

Warn if the entry exists but is not a sub-dictionary.

Parameters

matchOpt	the default search is non-recursive with patterns
mandatory	the keyword is mandatory (default: false)

Definition at line 540 of file dictionary.C.

References dictionary::Searcher< Const >::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), IOWarningInFunction, dictionary::Searcher< Const >::isDict(), and Foam::nl.

Referenced by blockDescriptor::blockDescriptor(), cloudSolution::cloudSolution(), updateMethod::coeffsDict(), solutionControl::dict(), subModelBase::getModelDict(), solverControl::read(), sensitivityBezierFI::read(), areaWrite::read(), noiseModel::read(), sampledSurfaces::read(), lumpedPointMovement::readDict(), gltfSetWriter< Type >::write(), and gltfSetWriter< Type >::writeStaticTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ optionalSubDict()

const Foam::dictionary & optionalSubDict	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find and return a sub-dictionary, otherwise return this dictionary.

Warn if the entry exists but is not a sub-dictionary.

Search type: non-recursive with patterns.

Definition at line 577 of file dictionary.C.

References dictionary::Searcher< Const >::dict(), Foam::endl(), dictionary::Searcher< Const >::good(), IOWarningInFunction, and dictionary::Searcher< Const >::isDict().

Referenced by geometric::add(), stepUpdate::coeffsDict(), lineSearch::coeffsDict(), liquidFilmThermo::initLiquid(), liquidProperties::New(), sampledSet::New(), laplaceFilter::read(), anisotropicFilter::read(), strainRateFunction::read(), CrossPowerLaw::read(), HerschelBulkley::read(), powerLaw::read(), Arrhenius< ViscousModel >::read(), BirdCarreau::read(), diameterModel::read(), solidBodyMotionFunction::read(), Casson::read(), motionSolver::read(), porosityModel::read(), dynamicRefineFvMesh::readDict(), and SIBase::readDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toc()

Foam::wordList toc ( ) const

Return the table of contents.

Definition at line 602 of file dictionary.C.

References Foam::constant::electromagnetic::e, and n.

Referenced by adjointSolverManager::adjointSolverManager(), DAC< CompType, ThermoType >::DAC(), removeEntry::execute(), FreeStream< CloudType >::FreeStream(), Foam::operator>>(), optimisationManager::optimisationManager(), pyrolysisModelCollection::pyrolysisModelCollection(), runTimeControl::read(), refinementSurfaces::refinementSurfaces(), and shellSurfaces::shellSurfaces().

Here is the caller graph for this function:

◆ sortedToc() [1/3]

Foam::wordList sortedToc ( ) const

Return the sorted table of contents.

Definition at line 616 of file dictionary.C.

Referenced by equationInitialResidualCondition::apply(), properties::objectNames(), solverFieldSelection::updateSelection(), properties::writeAllResultEntries(), and properties::writeResultEntries().

Here is the caller graph for this function:

◆ sortedToc() [2/3]

wordList sortedToc ( const Compare & comp ) const

Return table of contents sorted using the specified comparator.

◆ keys()

Foam::List< Foam::keyType > keys ( bool patterns = false ) const

Return the list of available keys or patterns.

Definition at line 622 of file dictionary.C.

References Foam::constant::electromagnetic::e, n, and List< T >::resize().

Here is the call graph for this function:

◆ substituteKeyword()

bool substituteKeyword	(	const word &	keyword,
		bool	mergeEntry = `false`
	)

Substitute the given keyword (which is prefixed by '$')

with the corresponding sub-dictionary entries

Definition at line 396 of file dictionary.C.

References Foam::add(), Foam::constant::electromagnetic::e, and keyType::REGEX_RECURSIVE.

Here is the call graph for this function:

◆ substituteScopedKeyword()

bool substituteScopedKeyword	(	const word &	keyword,
		bool	mergeEntry = `false`
	)

Substitute the given scoped keyword (which is prefixed by '$')

with the corresponding sub-dictionary entries

Definition at line 428 of file dictionary.C.

References Foam::add(), Foam::constant::electromagnetic::e, and keyType::REGEX_RECURSIVE.

Referenced by entry::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add() [1/9]

Foam::entry * add	(	entry *	entryPtr,
		bool	mergeEntry = `false`
	)

Add a new entry.

Parameters

mergeEntry dictionaries are interwoven and primitive entries are overwritten

Returns: pointer to inserted entry, or place of merging or nullptr on failure

Definition at line 640 of file dictionary.C.

References append(), fileName::concat(), entry::dict(), Foam::endl(), IOWarningInFunction, entry::isDict(), keyType::isPattern(), entry::keyword(), dictionary::merge(), Foam::name(), and entry::name().

Referenced by Foam::copyFilteredDict(), fvMeshTools::createDummyFvMeshFiles(), faPatchData::dict(), Foam::dimensionedConstant(), Foam::getOrAdd(), refinementParameters::getZoneInfo(), voxelMeshSearch::makeMesh(), dictionary::makeScopedDict(), namedBlock::namedBlock(), namedVertex::namedVertex(), entry::New(), cellTable::operator=(), argList::parse(), Foam::preservePatchTypes(), multiRegion::read(), functionObjectList::readFunctionObject(), subModelBase::setBaseProperty(), runTimeCondition::setConditionDict(), subModelBase::setModelProperty(), properties::setObjectProperty(), properties::setObjectResult(), sensitivitySurface::smoothSensitivities(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), solution::upgradeSolverDict(), averageCondition::write(), thermoCoupleProbes::write(), NURBS3DVolume::writeCpsInDict(), surfaceFeatures::writeDict(), mappedPatchBase::writeDict(), decomposedBlockData::writeExtraHeaderContent(), IOobject::writeHeaderContent(), and Time::writeTimeDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add() [2/9]

Foam::entry * add	(	const entry &	e,
		bool	mergeEntry = `false`
	)

Add an entry.

Parameters

mergeEntry dictionaries are interwoven and primitive entries are overwritten

Returns: pointer to inserted entry, or place of merging or nullptr on failure

Definition at line 719 of file dictionary.C.

References Foam::add(), and Foam::constant::electromagnetic::e.

Here is the call graph for this function:

◆ add() [3/9]

Foam::entry * add	(	const keyType &	k,
		const word &	v,
		bool	overwrite = `false`
	)

Add a word entry.

Parameters

overwrite force overwrite of an existing entry.

Returns: pointer to inserted entry or nullptr on failure

Definition at line 726 of file dictionary.C.

References Foam::add(), and k.

Here is the call graph for this function:

◆ add() [4/9]

Foam::entry * add	(	const keyType &	k,
		const string &	v,
		bool	overwrite = `false`
	)

Add a string entry.

Parameters

overwrite force overwrite of an existing entry.

Returns: pointer to inserted entry or nullptr on failure

Definition at line 737 of file dictionary.C.

References Foam::add(), and k.

Here is the call graph for this function:

◆ add() [5/9]

Foam::entry * add	(	const keyType &	k,
		const label	v,
		bool	overwrite = `false`
	)

Add a label entry.

Parameters

overwrite force overwrite of an existing entry.

Returns: pointer to inserted entry or nullptr on failure

Definition at line 748 of file dictionary.C.

References Foam::add(), and k.

Here is the call graph for this function:

◆ add() [6/9]

Foam::entry * add	(	const keyType &	k,
		const scalar	v,
		bool	overwrite = `false`
	)

Add a scalar entry.

Parameters

overwrite force overwrite of an existing entry.

Returns: pointer to inserted entry or nullptr on failure

Definition at line 759 of file dictionary.C.

References Foam::add(), and k.

Here is the call graph for this function:

◆ add() [7/9]

Foam::entry * add	(	const keyType &	k,
		const dictionary &	d,
		bool	mergeEntry = `false`
	)

Add a dictionary entry.

Parameters

mergeEntry merge into an existing sub-dictionary

Returns: pointer to inserted entry, or place of merging or nullptr on failure

Definition at line 770 of file dictionary.C.

References Foam::add(), and k.

Here is the call graph for this function:

◆ add() [8/9]

entry* add	(	const keyType &	k,
		const T &	v,
		bool	overwrite = `false`
	)

Add a T entry.

Parameters

overwrite force overwrite of existing entry

Returns: pointer to inserted entry or nullptr on failure

◆ set() [1/5]

Foam::entry * set ( entry * entryPtr )

Assign a new entry, overwriting any existing entry.

Returns: pointer to inserted entry or nullptr on failure

Definition at line 780 of file dictionary.C.

References Foam::add(), dictionary::Searcher< Const >::dict(), dictionary::Searcher< Const >::isDict(), entry::keyword(), keyType::REGEX, and Foam::search().

Referenced by columnFvMeshInfo::addLocalPatches(), meshRefinement::addPatch(), sixDoFRigidBodyMotion::addRestraints(), averageCondition::averageCondition(), data::data(), extrudePatchMesh::extrudePatchMesh(), fvMeshTools::newMesh(), polyMesh::polyMesh(), runTimeControl::read(), multiFieldValue::read(), functionObjectList::readFunctionObject(), codedFunctionObject::redirectFunctionObject(), codedPoints0MotionSolver::redirectMotionSolver(), CodedSource< Type >::redirectOption(), refinementSurfaces::refinementSurfaces(), boundaryRegion::rename(), searchableSurfaceCollection::searchableSurfaceCollection(), SemiImplicitSource< Type >::setFieldData(), ZoneMesh< cellZone, polyMesh >::updateMetaData(), solution::upgradeSolverDict(), averageCondition::write(), decomposedBlockData::writeExtraHeaderContent(), IOobject::writeHeaderContent(), and mappedPatchBase::writeIOField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set() [2/5]

Foam::entry * set ( const entry & e )

Assign a new entry, overwriting any existing entry.

Returns: pointer to inserted entry or nullptr on failure

Definition at line 800 of file dictionary.C.

References Foam::constant::electromagnetic::e, and Foam::BitOps::set().

Here is the call graph for this function:

◆ set() [3/5]

Foam::entry * set	(	const keyType &	k,
		const dictionary &	v
	)

Assign a dictionary entry, overwriting any existing entry.

Returns: pointer to inserted entry or nullptr on failure

Definition at line 806 of file dictionary.C.

References k, and Foam::BitOps::set().

Here is the call graph for this function:

◆ set() [4/5]

entry* set	(	const keyType &	k,
		const T &	v
	)

Assign a T entry, overwriting any existing entry.

Returns: pointer to inserted entry or nullptr on failure

◆ remove()

bool remove ( const word & keyword )

Remove an entry specified by keyword.

Definition at line 582 of file dictionarySearch.C.

Referenced by removeEntry::execute(), and velocityFilmShellFvPatchVectorField::write().

Here is the caller graph for this function:

◆ changeKeyword()

bool changeKeyword	(	const keyType &	oldKeyword,
		const keyType &	newKeyword,
		bool	overwrite = `false`
	)

Change the keyword for an entry,.

Parameters

overwrite force overwrite of an existing entry.

Definition at line 611 of file dictionarySearch.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOWarningInFunction, keyType::isPattern(), Foam::name(), and Foam::nl.

Referenced by CodedSource< Type >::redirectOption().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ merge()

bool merge ( const dictionary & dict )

Merge entries from the given dictionary.

Also merge sub-dictionaries as required.

Definition at line 812 of file dictionary.C.

References Foam::abort(), Foam::add(), dict, Foam::constant::electromagnetic::e, Foam::FatalIOError, FatalIOErrorInFunction, and Foam::nl.

Referenced by dictionary::add(), snappyLayerDriver::addLayers(), Time::readDict(), and functionObjectList::readFunctionObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

void clear ( )

Clear the dictionary.

Definition at line 857 of file dictionary.C.

References clear().

Referenced by Foam::operator>>(), and strainRateFunction::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transfer()

void transfer ( dictionary & dict )

Transfer the contents of the argument and annul the argument.

Definition at line 866 of file dictionary.C.

References dict, Foam::name(), and dictionary::name().

Referenced by csvTableReader< Type >::operator()(), and meshRefinement::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkITstream()

void checkITstream	(	const ITstream &	is,
		const word &	keyword
	)		const

Check after reading if the input token stream has unconsumed tokens remaining or if there were no tokens in the first place.

Emits FatalIOError

Definition at line 258 of file dictionary.C.

References JobInfo::constructed, Foam::endl(), Foam::exit(), Foam::FatalIOError, IOstream::lineNumber(), Foam::nl, and ITstream::nRemainingTokens().

Here is the call graph for this function:

◆ read() [1/2]

bool read ( Istream & is )

Read dictionary from Istream. Discards the header.

Definition at line 141 of file dictionaryIO.C.

References Foam::read().

Referenced by atmAmbientTurbSource::atmAmbientTurbSource(), atmBuoyancyTurbSource::atmBuoyancyTurbSource(), atmLengthScaleTurbSource::atmLengthScaleTurbSource(), atmPlantCanopyTurbSource::atmPlantCanopyTurbSource(), dictionary::dictionary(), includeEtcEntry::execute(), includeEntry::execute(), calcEntry::execute(), codeStream::execute(), Foam::operator>>(), vanDriestDelta::read(), PrandtlDelta::read(), smoothDelta::read(), PDRblock::read(), and IOobject::readHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [2/2]

bool read	(	Istream &	is,
		bool	keepHeader
	)

Read dictionary from Istream, optionally keeping the header.

Definition at line 77 of file dictionaryIO.C.

References IOstream::bad(), token::BEGIN_BLOCK, token::END_BLOCK, Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, entry::GLOBAL, IOstream::good(), InfoInFunction, Foam::name(), entry::New(), Foam::nl, and Istream::putBack().

Here is the call graph for this function:

◆ writeEntry() [1/2]

void writeEntry ( Ostream & os ) const

Write sub-dictionary with its dictName as its header.

Definition at line 164 of file dictionaryIO.C.

References Ostream::beginBlock(), dictName(), Ostream::endBlock(), and os().

Referenced by Foam::operator<<(), dictionaryEntry::write(), thermalBaffleFvPatchScalarField::write(), Foam::writeEntryIfPresent(), decomposedBlockData::writeHeader(), and IOobject::writeHeaderContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeEntry() [2/2]

void writeEntry	(	const keyType &	keyword,
		Ostream &	os
	)		const

Write sub-dictionary with the keyword as its header.

Definition at line 172 of file dictionaryIO.C.

References Ostream::beginBlock(), Ostream::endBlock(), and os().

Here is the call graph for this function:

◆ writeEntries()

void writeEntries	(	Ostream &	os,
		const bool	extraNewLine = `false`
	)		const

Write dictionary entries.

Parameters

extraNewLine adds additional newline between entries for "top-level" dictionaries

Definition at line 180 of file dictionaryIO.C.

References Foam::constant::electromagnetic::e, Foam::endl(), IOstream::good(), Foam::name(), Foam::nl, dictionary::null, os(), and WarningInFunction.

Referenced by decomposedBlockData::writeHeader(), and Foam::writeJobDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write	(	Ostream &	os,
		const bool	subDict = `true`
	)		const

Write dictionary, normally with sub-dictionary formatting.

Definition at line 206 of file dictionaryIO.C.

References Ostream::beginBlock(), Ostream::endBlock(), Foam::nl, and os().

Referenced by Foam::entryToString(), Foam::operator<<(), dictionaryListEntry::write(), vibrationShellFvPatchScalarField::write(), thermalShellFvPatchScalarField::write(), velocityFilmShellFvPatchVectorField::write(), objectiveIncompressible::write(), fieldDictionary::writeData(), baseIOdictionary::writeData(), and surfaceFeatures::writeDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ csearch()

Foam::dictionary::const_searcher csearch	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Search dictionary for given keyword.

Default search: non-recursive with patterns.

Parameters

recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 265 of file dictionarySearch.C.

References dictionary::null, keyType::RECURSIVE, keyType::REGEX, and dictionary::Searcher< Const >::set().

Referenced by meshRefinement::lookup(), and meshRefinement::subDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ search() [1/2]

Foam::dictionary::const_searcher search	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Search dictionary for given keyword.

Default search: non-recursive with patterns.

Parameters

recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 303 of file dictionarySearch.C.

Referenced by entry::New().

Here is the caller graph for this function:

◆ search() [2/2]

Foam::dictionary::searcher search	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)

Search dictionary for given keyword.

Default search: non-recursive with patterns.

Parameters

recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 313 of file dictionarySearch.C.

◆ csearchScoped()

Foam::dictionary::const_searcher csearchScoped	(	const word &	keyword,
		enum keyType::option	matchOpt
	)		const

Search using scoping.

There are two types of scoping available:

dot-scoping, where a '.' is used to delineate the scope
slash-scoping, where a '/' is used to delineate the scope

For dot-scoping, a leading '^' traverses to the top-level dictionary, leading dots mean use the parent dictionary and an intermediate dot separates a sub-dictionary or sub-entry. However, since the use of dots is ambiguous ("a.b.c" could be an entry itself or represent a "bc" entry from dictionary "a" etc), the heuristic backtracks and attempts successively longer top-level entries until a suitable match is found.

For slash-scoping, semantics similar to directory structures are used. A leading '/' traverses to the top-level dictionary, a single leading or intermediate '.' references the current dictionary level. A '..' pair references the parent dictionary. Any doubled slashes are silently ignored. Since a slash is not a valid keyword character, there is no ambiguity between separator and content.

Parameters

recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 325 of file dictionarySearch.C.

References dictionary::null, and keyType::RECURSIVE.

Referenced by entry::New().

Here is the caller graph for this function:

◆ searchScoped() [1/2]

Foam::dictionary::const_searcher searchScoped	(	const word &	keyword,
		enum keyType::option	matchOpt
	)		const

Search using dot or slash scoping.

Parameters

recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 355 of file dictionarySearch.C.

Referenced by removeEntry::execute(), and entry::New().

Here is the caller graph for this function:

◆ searchScoped() [2/2]

Foam::dictionary::searcher searchScoped	(	const word &	keyword,
		enum keyType::option	matchOpt
	)

Search using dot or slash scoping.

Parameters

recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 365 of file dictionarySearch.C.

◆ cfindScopedDict()

const Foam::dictionary * cfindScopedDict ( const fileName & dictPath ) const

Locate a sub-dictionary using slash-scoping.

Returns: nullptr if the dictionary path does not exist

Definition at line 377 of file dictionarySearch.C.

References fileName::clean(), fileName::components(), entry::dictPtr(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, entry::isDict(), Foam::nl, dictionary::null, and path().

Here is the call graph for this function:

◆ findScopedDict() [1/2]

const Foam::dictionary * findScopedDict ( const fileName & dictPath ) const

Locate a sub-dictionary using slash-scoping.

Returns: nullptr if the dictionary path does not exist

Definition at line 464 of file dictionarySearch.C.

◆ findScopedDict() [2/2]

Foam::dictionary * findScopedDict ( const fileName & dictPath )

Locate a sub-dictionary using slash-scoping.

Returns: nullptr if the dictionary path does not exist

Definition at line 473 of file dictionarySearch.C.

◆ makeScopedDict()

Foam::dictionary * makeScopedDict ( const fileName & dictPath )

Locate existing or create sub-dictionary using slash-scoping.

Returns: nullptr if the dictionary path could not be created

Definition at line 482 of file dictionarySearch.C.

References dictionary::add(), fileName::clean(), entry::dictPtr(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, entry::isDict(), Foam::nl, dictionary::null, path(), and Foam::stringOps::split().

Referenced by entry::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ csearchCompat()

Foam::dictionary::const_searcher csearchCompat	(	const word &	keyword,
		std::initializer_list< std::pair< const char *, int >>	compat,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Search dictionary for given keyword and any compatibility names.

Default search: non-recursive with patterns.

Parameters

compat	list of old compatibility keywords and the last OpenFOAM version for which they were used. Old version 1600=OpenFOAM-v3.0, 240=OpenFOAM-2.4.x, 170=OpenFOAM-1.7.x,...
recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 34 of file dictionaryCompat.C.

References Foam::endl(), dictionary::Searcher< Const >::good(), Foam::nl, and Foam::stringOps::validate().

Referenced by functionObject::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ foundCompat()

bool foundCompat	(	const word &	keyword,
		std::initializer_list< std::pair< const char *, int >>	compat,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Search dictionary for given keyword and any compatibility names.

Default search: non-recursive with patterns.

Parameters

compat	list of old compatibility keywords and the last OpenFOAM version for which they were used.
recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 75 of file dictionaryCompat.C.

◆ findCompat()

const Foam::entry * findCompat	(	const word &	keyword,
		std::initializer_list< std::pair< const char *, int >>	compat,
		enum keyType::option	matchOpt
	)		const

Find and return an entry pointer if present, or return a nullptr, using any compatibility names if needed.

Parameters

compat	list of old compatibility keywords and the last OpenFOAM version for which they were used.
recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 86 of file dictionaryCompat.C.

◆ lookupEntryCompat()

const Foam::entry & lookupEntryCompat	(	const word &	keyword,
		std::initializer_list< std::pair< const char *, int >>	compat,
		enum keyType::option	matchOpt
	)		const

Find and return an entry if present, otherwise FatalIOError, using any compatibility names if needed.

Parameters

compat	list of old compatibility keywords and the last OpenFOAM version for which they were used.
recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 97 of file dictionaryCompat.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), and dictionary::Searcher< Const >::ref().

Here is the call graph for this function:

◆ lookupCompat()

Foam::ITstream & lookupCompat	(	const word &	keyword,
		std::initializer_list< std::pair< const char *, int >>	compat,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find and return an entry data stream, using any compatibility names if needed.

Default search: non-recursive with patterns.

Parameters

compat	list of old compatibility keywords and the last OpenFOAM version for which they were used.
recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 118 of file dictionaryCompat.C.

◆ getCompat()

T getCompat	(	const word &	keyword,
		std::initializer_list< std::pair< const char *, int >>	compat,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find and return a T using any compatibility names if needed. FatalIOError if not found, or if there are excess tokens.

Default search: non-recursive with patterns.

Parameters

compat	list of old compatibility keywords and the last OpenFOAM version for which they were used.
recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 134 of file dictionaryTemplates.C.

References Foam::T().

Referenced by faceZoneToCell::faceZoneToCell(), basicChemistryModel::New(), motionSolver::New(), patchToCell::patchToCell(), patchToFace::patchToFace(), plane::plane(), zoneToCell::zoneToCell(), zoneToFace::zoneToFace(), and zoneToPoint::zoneToPoint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOrDefaultCompat()

T getOrDefaultCompat	(	const word &	keyword,
		std::initializer_list< std::pair< const char *, int >>	compat,
		const T &	deflt,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find and return a T, or return the given default value using any compatibility names if needed.

Default search: non-recursive with patterns.

Parameters

compat	list of old compatibility keywords and the last OpenFOAM version for which they were used.
recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 432 of file dictionaryTemplates.C.

References dictionary::Searcher< Const >::good(), dictionary::Searcher< Const >::ptr(), and Foam::T().

Here is the call graph for this function:

◆ readCompat()

bool readCompat	(	const word &	keyword,
		std::initializer_list< std::pair< const char *, int >>	compat,
		T &	val,
		enum keyType::option	matchOpt = `keyType::REGEX`,
		bool	mandatory = `true`
	)		const

Find entry and assign to T val using any compatibility names if needed. FatalIOError if there are excess tokens.

Default search: non-recursive with patterns.

Parameters

compat	list of old compatibility keywords and the last OpenFOAM version for which they were used.
val	the value to read
recursive	search parent dictionaries
patternMatch	use regular expressions

Returns: true if the entry was found.

Definition at line 372 of file dictionaryTemplates.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::name(), Foam::nl, and dictionary::Searcher< Const >::ptr().

Referenced by RASModelVariables::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readIfPresentCompat()

bool readIfPresentCompat	(	const word &	keyword,
		std::initializer_list< std::pair< const char *, int >>	compat,
		T &	val,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

Find an entry if present, and assign to T val using any compatibility names if needed. FatalIOError if it is found and there are excess tokens.

Default search: non-recursive with patterns.

Parameters

compat	list of old compatibility keywords and the last OpenFOAM version for which they were used.
val	the value to read
recursive	search parent dictionaries
patternMatch	use regular expressions

Returns: true if the entry was found.

Definition at line 463 of file dictionaryTemplates.C.

Referenced by solidProperties::readIfPresent().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const dictionary & rhs )

Copy assignment.

Definition at line 881 of file dictionary.C.

References Foam::add(), clear(), Foam::constant::electromagnetic::e, Foam::name(), and dictionary::name().

Referenced by dictionary::dictionary(), and baseIOdictionary::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator+=()

void operator+= ( const dictionary & rhs )

Include entries from the given dictionary.

Warn, but do not overwrite existing entries.

Definition at line 901 of file dictionary.C.

References Foam::abort(), Foam::add(), Foam::constant::electromagnetic::e, Foam::FatalIOError, FatalIOErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ operator|=()

void operator|= ( const dictionary & rhs )

Conditionally include entries from the given dictionary.

Do not overwrite existing entries.

Definition at line 918 of file dictionary.C.

References Foam::abort(), Foam::add(), Foam::constant::electromagnetic::e, Foam::FatalIOError, FatalIOErrorInFunction, found, and Foam::nl.

Here is the call graph for this function:

◆ operator<<=()

void operator<<= ( const dictionary & rhs )

Unconditionally include entries from the given dictionary.

Overwrite existing entries.

Definition at line 938 of file dictionary.C.

References Foam::abort(), Foam::constant::electromagnetic::e, Foam::FatalIOError, FatalIOErrorInFunction, Foam::nl, and Foam::BitOps::set().

Here is the call graph for this function:

◆ lookupOrDefault() [1/2]

T lookupOrDefault	(	const word &	keyword,
		const T &	deflt,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect.

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 1258 of file dictionary.H.

◆ lookupOrAddDefault() [1/2]

T lookupOrAddDefault	(	const word &	keyword,
		const T &	deflt,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)

inline

Find and return a T, or return the given default value and add it to dictionary. FatalIOError if it is found and the number of tokens is incorrect.

Parameters

matchOpt the default search is non-recursive with patterns

Definition at line 1275 of file dictionary.H.

◆ lookupOrDefaultCompat()

T lookupOrDefaultCompat	(	const word &	keyword,
		std::initializer_list< std::pair< const char *, int >>	compat,
		const T &	deflt,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Find and return a T, or return the given default value using any compatibility names if needed.

Default search: non-recursive with patterns.

Parameters

compat	list of old compatibility keywords and the last OpenFOAM version for which they were used.
recursive	search parent dictionaries
patternMatch	use regular expressions

Definition at line 1294 of file dictionary.H.

◆ operator[]()

ITstream& operator[] ( const word & keyword ) const

inline

Deprecated(2018-07) find and return an entry data stream.

Deprecated:: (2018-07) - use lookup() method

Definition at line 1308 of file dictionary.H.

References dictionary::lookup().

Here is the call graph for this function:

◆ found() [2/2]

bool found	(	const word &	keyword,
		bool	recursive,
		bool	patternMatch = `true`
	)		const

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use keyType::option version

Definition at line 1317 of file dictionary.H.

References dictionary::found().

Here is the call graph for this function:

◆ lookupEntryPtr() [1/2]

entry* lookupEntryPtr	(	const word &	keyword,
		bool	recursive,
		bool	patternMatch
	)

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use keyType::option version

Definition at line 1330 of file dictionary.H.

References dictionary::findEntry().

Here is the call graph for this function:

◆ lookupEntryPtr() [2/2]

const entry* lookupEntryPtr	(	const word &	keyword,
		bool	recursive,
		bool	patternMatch
	)		const

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use keyType::option version

Definition at line 1343 of file dictionary.H.

References dictionary::findEntry().

Here is the call graph for this function:

◆ lookupScopedEntryPtr()

const entry* lookupScopedEntryPtr	(	const word &	keyword,
		bool	recursive,
		bool	patternMatch
	)		const

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use keyType::option version

Definition at line 1356 of file dictionary.H.

References dictionary::findScoped().

Here is the call graph for this function:

◆ subDictPtr() [1/2]

const dictionary* subDictPtr ( const word & keyword ) const

inline

Deprecated(2018-10)

Find and return a sub-dictionary pointer if present (and a sub-dictionary) otherwise return nullptr.

Search type: non-recursive with patterns.

Deprecated:: (2018-10) - use findDict() method

Definition at line 1372 of file dictionary.H.

References dictionary::findDict(), and keyType::REGEX.

Here is the call graph for this function:

◆ subDictPtr() [2/2]

dictionary* subDictPtr ( const word & keyword )

inline

Deprecated(2018-10) Find and return a sub-dictionary pointer if present

(and a sub-dictionary) otherwise return nullptr.

Search type: non-recursive with patterns.

Deprecated:: (2018-10) - use findDict() method

Definition at line 1384 of file dictionary.H.

References dictionary::findDict(), and keyType::REGEX.

Here is the call graph for this function:

◆ lookupEntry() [2/2]

const entry& lookupEntry	(	const word &	keyword,
		bool	recursive,
		bool	patternMatch
	)		const

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use keyType::option version

Definition at line 1393 of file dictionary.H.

References dictionary::lookupEntry().

Here is the call graph for this function:

◆ lookup() [2/2]

ITstream& lookup	(	const word &	keyword,
		bool	recursive,
		bool	patternMatch = `true`
	)		const

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use keyType::option version

Definition at line 1406 of file dictionary.H.

References dictionary::lookup().

Here is the call graph for this function:

◆ lookupOrDefault() [2/2]

T lookupOrDefault	(	const word &	keyword,
		const T &	deflt,
		bool	recursive,
		bool	patternMatch = `true`
	)		const

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use keyType::option version

Definition at line 1420 of file dictionary.H.

References dictionary::getOrDefault().

Here is the call graph for this function:

◆ lookupOrAddDefault() [2/2]

T lookupOrAddDefault	(	const word &	keyword,
		const T &	deflt,
		bool	recursive,
		bool	patternMatch = `true`
	)

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use keyType::option version

Definition at line 1435 of file dictionary.H.

References dictionary::getOrAdd().

Here is the call graph for this function:

◆ readIfPresent() [2/2]

bool readIfPresent	(	const word &	keyword,
		T &	val,
		bool	recursive,
		bool	patternMatch = `true`
	)		const

inline

Deprecated(2018-10)

Deprecated:: (2018-10) - use keyType::option version

Definition at line 1450 of file dictionary.H.

References dictionary::readIfPresent().

Here is the call graph for this function:

◆ lookupType()

T lookupType	(	const word &	keyword,
		bool	recursive = `false`,
		bool	patternMatch = `true`
	)		const

inline

Deprecated(2018-10) find and return a T.

Deprecated:: (2018-10) - use get() method

Definition at line 1470 of file dictionary.H.

◆ getBool()

bool getBool	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Same as get< bool >(const word&, keyType::option)

Definition at line 1510 of file dictionary.H.

◆ getLabel()

label getLabel	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Same as get< label >(const word&, keyType::option)

Definition at line 1511 of file dictionary.H.

◆ getScalar()

scalar getScalar	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Same as get< scalar >(const word&, keyType::option)

Definition at line 1512 of file dictionary.H.

Referenced by propellerInfo::setSampleDiskSurface().

Here is the caller graph for this function:

◆ getString()

string getString	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Same as get< string >(const word&, keyType::option)

Definition at line 1513 of file dictionary.H.

◆ getWord()

word getWord	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Same as get< word >(const word&, keyType::option)

Definition at line 1514 of file dictionary.H.

Referenced by incompressibleInterPhaseTransportModel< Mixture >::incompressibleInterPhaseTransportModel().

Here is the caller graph for this function:

◆ getFileName()

fileName getFileName	(	const word &	keyword,
		enum keyType::option	matchOpt = `keyType::REGEX`
	)		const

inline

Same as get< fileName >(const word&, keyType::option)

Definition at line 1515 of file dictionary.H.

◆ sortedToc() [3/3]

Foam::wordList sortedToc ( const Compare & comp ) const

Definition at line 85 of file dictionaryTemplates.C.

◆ add() [9/9]

Foam::entry* add	(	const keyType &	k,
		const T &	v,
		bool	overwrite
	)

Definition at line 92 of file dictionaryTemplates.C.

References Foam::add(), and k.

Here is the call graph for this function:

◆ set() [5/5]

Foam::entry* set	(	const keyType &	k,
		const T &	v
	)

Definition at line 99 of file dictionaryTemplates.C.

References k, and Foam::BitOps::set().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ entry

friend class entry

friend

Declare friendship with the entry class for IO.

Definition at line 279 of file dictionary.H.

◆ operator>>

Istream& operator>>	(	Istream &	is,
		dictionary &	dict
	)

friend

Read dictionary from Istream.

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const dictionary &	dict
	)

friend

Write dictionary to Ostream.

Member Data Documentation

◆ const_searcher

friend const_searcher

Declare friendship with the searcher classes.

Definition at line 282 of file dictionary.H.

◆ searcher

friend searcher

Definition at line 283 of file dictionary.H.

◆ writeOptionalEntries

int writeOptionalEntries

static

Report optional keywords and values if not present in dictionary.

For value greater than 1: fatal. Set/unset via an InfoSwitch or -info-switch at the command-line

Definition at line 389 of file dictionary.H.

Referenced by dictionary::reportOptional().

◆ null

const Foam::dictionary null

static

An empty dictionary, which is also the parent for all dictionaries.

Definition at line 392 of file dictionary.H.

Referenced by cellModel::cellModel(), dictionary::cfindScopedDict(), entry::clone(), codedFunctionObject::codeContext(), Stokes< BasicTurbulenceModel >::coeffDict(), dictionary::csearch(), dictionary::csearchScoped(), primitiveEntry::dict(), Foam::dimensionedConstant(), writerCaching::fieldsDict(), decompositionMethod::findCoeffsDict(), dictionary::isNullDict(), dictionary::makeScopedDict(), RASModelVariables::New(), entry::New(), functionObjectList::New(), phase::iNew::operator()(), motionSolver::iNew::operator()(), phaseModel::iNew::operator()(), sizeGroup::iNew::operator()(), Foam::operator>>(), Foam::functionObjects::operator>>(), primitiveEntry::primitiveEntry(), meshRefinement::subDict(), triSurfaceMeshPointSet::triSurfaceMeshPointSet(), dynamicCodeContext::valid(), and dictionary::writeEntries().

◆ reportingOutput

Foam::refPtr< Foam::OSstream > reportingOutput

static

Output location when reporting default values.

Definition at line 395 of file dictionary.H.

The documentation for this class was generated from the following files:

src/OpenFOAM/db/dictionary/dictionary.H
src/OpenFOAM/db/dictionary/dictionary.C
src/OpenFOAM/db/dictionary/dictionaryCompat.C
src/OpenFOAM/db/dictionary/dictionaryI.H
src/OpenFOAM/db/dictionary/dictionaryIO.C
src/OpenFOAM/db/dictionary/dictionarySearch.C
src/OpenFOAM/db/dictionary/dictionaryTemplates.C

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_searcher

◆ searcher

Constructor & Destructor Documentation

◆ dictionary() [1/10]

◆ dictionary() [2/10]

◆ dictionary() [3/10]

◆ dictionary() [4/10]

◆ dictionary() [5/10]

◆ dictionary() [6/10]

◆ dictionary() [7/10]

◆ dictionary() [8/10]

◆ dictionary() [9/10]

◆ dictionary() [10/10]

◆ ~dictionary()

Member Function Documentation

◆ ClassName()

◆ reportOptional() [1/2]

◆ reportOptional() [2/2]

◆ clone()

◆ New()

◆ name() [1/2]

◆ name() [2/2]

◆ dictName()

◆ relativeName()

◆ isNullDict()

◆ parent()

◆ topDict()

◆ startLineNumber()

◆ endLineNumber()

◆ digest()

◆ tokens()

◆ found() [1/2]

◆ findEntry() [1/2]

◆ findEntry() [2/2]

◆ findScoped()

◆ findDict() [1/2]

◆ findDict() [2/2]

◆ lookupEntry() [1/2]

◆ lookup() [1/2]

◆ get()

◆ getOrDefault()

◆ getOrAdd()

◆ readEntry()

◆ readIfPresent() [1/2]

◆ getCheck()

◆ getCheckOrDefault()

◆ getCheckOrAdd()

◆ readCheck()

◆ readCheckIfPresent()

◆ isDict()

◆ subDict() [1/2]

◆ subDict() [2/2]

◆ subDictOrAdd()

◆ subOrEmptyDict()

◆ optionalSubDict()

◆ toc()

◆ sortedToc() [1/3]

◆ sortedToc() [2/3]

◆ keys()

◆ substituteKeyword()

◆ substituteScopedKeyword()

◆ add() [1/9]

◆ add() [2/9]

◆ add() [3/9]

◆ add() [4/9]

◆ add() [5/9]

◆ add() [6/9]

◆ add() [7/9]

◆ add() [8/9]

◆ set() [1/5]

◆ set() [2/5]