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...
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 Types inherited from UILList< LListBase, T > | |
typedef T | value_type |
Type of values stored. More... | |
typedef T * | pointer |
Pointer for value_type. More... | |
typedef const T * | const_pointer |
Const pointer for value_type. More... | |
typedef T & | reference |
Reference for value_type. More... | |
typedef const T & | const_reference |
Const reference for value_type. More... | |
typedef label | size_type |
The type that can represent the container size. More... | |
typedef label | difference_type |
The difference between iterator objects. More... | |
using | base_iterator = typename LListBase::iterator |
using | const_base_iterator = typename LListBase::const_iterator |
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 matchOpt=keyType::REGEX) const |
Search dictionary for given keyword. More... | |
const_searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
Search dictionary for given keyword. More... | |
searcher | search (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
Search dictionary for given keyword. More... | |
const_searcher | csearchScoped (const word &keyword, enum keyType::option matchOpt) const |
Search using scoping. More... | |
const_searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) const |
Search using dot or slash scoping. More... | |
searcher | searchScoped (const word &keyword, enum keyType::option matchOpt) |
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 matchOpt=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 matchOpt=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 matchOpt) const |
const entry & | lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt) const |
ITstream & | lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=keyType::REGEX) const |
template<class T > | |
T | getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int > > compat, enum keyType::option matchOpt=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 matchOpt=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 matchOpt=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 matchOpt=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 add initial 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... | |
Public Member Functions inherited from UILList< LListBase, T > | |
UILList ()=default | |
Default construct. More... | |
UILList (T *item) | |
Construct and add initial item pointer. More... | |
UILList (const UILList< LListBase, T > &lst) | |
Construct as copy. More... | |
T * | first () |
The first entry in the list. More... | |
const T * | first () const |
The first entry in the list (const access) More... | |
T * | last () |
The last entry in the list. More... | |
const T * | last () const |
The last entry in the list (const access) More... | |
T * | removeHead () |
Remove and return head. More... | |
T * | remove (T *item) |
Remove and return element. More... | |
T * | remove (iterator &iter) |
Remove and return item specified by iterator. More... | |
void | operator= (const UILList< LListBase, T > &lst) |
Copy assignment. More... | |
bool | operator== (const UILList< LListBase, T > &lst) const |
Equality. True both lists are element-wise equal. More... | |
bool | operator!= (const UILList< LListBase, T > &lst) const |
The opposite of the equality operation. Takes linear time. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write UILList with line-breaks when length exceeds shortLen. More... | |
iterator | begin () |
Iterator to first item in list with non-const access. More... | |
const_iterator | cbegin () const |
Iterator to first item in list with const access. More... | |
reverse_iterator | rbegin () |
Iterator to last item in list with non-const access. More... | |
const_reverse_iterator | crbegin () const |
Iterator to last item in list with const access. More... | |
const_iterator | begin () const |
Iterator to first item in list with const access. More... | |
const_reverse_iterator | rbegin () const |
Iterator to last item in list with const access. More... | |
const iterator & | end () |
End of list for forward iterators. More... | |
const const_iterator & | cend () const |
End of list for forward iterators. More... | |
const reverse_iterator & | rend () |
End of list for reverse iterators. More... | |
const const_reverse_iterator & | crend () const |
End of list for reverse iterators. More... | |
const const_iterator & | end () const |
End of list for forward iterators. More... | |
const const_reverse_iterator & | rend () const |
End of list for reverse iterators. 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... | |
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:
The dictionary class is the base class for IOdictionary and also serves as a bootstrap dictionary for the objectRegistry data dictionaries.
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.
Definition at line 123 of file dictionary.H.
typedef Searcher<true> const_searcher |
Searcher with const access.
Definition at line 270 of file dictionary.H.
Searcher with non-const access.
Definition at line 273 of file dictionary.H.
dictionary | ( | ) |
Default construct, a top-level empty dictionary.
Definition at line 75 of file dictionary.C.
|
explicit |
Construct top-level empty dictionary with given name.
Definition at line 82 of file dictionary.C.
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 34 of file dictionaryIO.C.
References Foam::name(), and dictionary::read().
dictionary | ( | Istream & | is | ) |
Construct top-level dictionary from Istream, reading entries until EOF. Discards the header.
Definition at line 49 of file dictionaryIO.C.
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().
dictionary | ( | const dictionary & | parentDict, |
const dictionary & | dict | ||
) |
Copy construct given the parent dictionary.
Definition at line 89 of file dictionary.C.
References e.
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=().
dictionary | ( | const dictionary & | parentDict, |
dictionary && | dict | ||
) |
Move construct for given parent dictionary.
Definition at line 146 of file dictionary.C.
References fileName::concat(), dict, dictionary::name(), and dictionary::transfer().
dictionary | ( | dictionary && | dict | ) |
Move construct top-level dictionary.
Definition at line 160 of file dictionary.C.
References dict, and dictionary::transfer().
|
virtual |
Destructor.
Definition at line 180 of file dictionary.C.
ClassName | ( | "dictionary" | ) |
|
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.
|
inlinestaticnoexcept |
Change the state of reporting optional (default) entries.
0: no reporting, 1: report, 2: fatal if not set
Definition at line 38 of file dictionaryI.H.
Foam::autoPtr< Foam::dictionary > clone | ( | ) | const |
Construct and return clone.
Definition at line 172 of file dictionary.C.
References Time::New().
Referenced by hexRef8Data::hexRef8Data(), Foam::preservePatchTypes(), and refinementSurfaces::refinementSurfaces().
|
static |
Construct top-level dictionary on freestore from Istream.
Definition at line 69 of file dictionaryIO.C.
References Time::New().
|
inlinenoexcept |
The dictionary name.
Definition at line 48 of file dictionaryI.H.
Referenced by dynamicCodeContext::addLineDirective(), baseIOdictionary::baseIOdictionary(), chemkinReader::chemkinReader(), molecule::constantProperties::constantProperties(), Foam::copyFilteredDict(), metisLikeDecomp::decompose(), dictionary::dictionary(), motionSmootherAlgo::get(), meshRefinement::get(), JobInfo::JobInfo(), meshRefinement::lookup(), dictionaryEntry::name(), reconstructionSchemes::New(), dictionary::operator=(), Foam::operator>>(), Enum< injectionMethod >::read(), dynamicCodeContext::readEntry(), meshRefinement::subDict(), dictionary::transfer(), Foam::unitSet(), codedBase::updateLibrary(), and velocityDisplacementMotionSolver::velocityDisplacementMotionSolver().
|
inlinenoexcept |
The dictionary name for modification (use with caution).
Definition at line 54 of file dictionaryI.H.
|
inline |
The local dictionary name (final part of scoped name)
Definition at line 60 of file dictionaryI.H.
Referenced by fromFile::computeControlPoints(), profileModel::New(), liquidProperties::New(), solidProperties::New(), thermophysicalProperties::New(), blendingMethod::New(), objectiveIncompressible::New(), ParticleForce< CloudType >::ParticleForce(), multiFieldValue::read(), and twoPhaseSystem::twoPhaseSystem().
Foam::fileName relativeName | ( | const bool | caseTag = false | ) | const |
The dictionary name relative to the case.
Uses argList::envRelativePath to obtain FOAM_CASE
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 dictionary::csearchCompat(), codeStream::evaluate(), includeEntry::execute(), includeEtcEntry::execute(), messageStream::operator()(), IOerror::operator()(), dimensionSet::readEntry(), and Foam::warnCompatDegrees().
|
inlinenoexcept |
The dictionary is actually dictionary::null (root dictionary)
Definition at line 74 of file dictionaryI.H.
Referenced by PDRblock::PDRblock().
|
inlinenoexcept |
Return the parent dictionary.
Definition at line 80 of file dictionaryI.H.
const Foam::dictionary & topDict | ( | ) | const |
Return the top of the tree.
Definition at line 192 of file dictionary.C.
References IOobject::name(), and p.
Referenced by includeEntry::execute(), codeStream::getFunction(), and codeStream::libs().
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().
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()().
Foam::SHA1Digest digest | ( | ) | const |
Return the SHA1 digest of the dictionary contents.
Definition at line 227 of file dictionary.C.
Referenced by functionObjectList::read().
Foam::tokenList tokens | ( | ) | const |
Return the dictionary as a list of tokens.
Definition at line 241 of file dictionary.C.
|
inline |
Search for an entry (const access) with the given keyword.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 86 of file dictionaryI.H.
Referenced by sixDoFRigidBodyMotion::addConstraints(), sixDoFRigidBodyMotion::addRestraints(), exprResultGlobals::addValue(), advectiveFvPatchField< Type >::advectiveFvPatchField(), alphaContactAngleTwoPhaseFvPatchScalarField::alphaContactAngleTwoPhaseFvPatchScalarField(), alphaFixedPressureFvPatchScalarField::alphaFixedPressureFvPatchScalarField(), alphatPhaseChangeWallFunctionFvPatchScalarField::alphatPhaseChangeWallFunctionFvPatchScalarField(), alphatWallBoilingWallFunctionFvPatchScalarField::alphatWallBoilingWallFunctionFvPatchScalarField(), angularOscillatingDisplacementPointPatchVectorField::angularOscillatingDisplacementPointPatchVectorField(), angularOscillatingVelocityPointPatchVectorField::angularOscillatingVelocityPointPatchVectorField(), equationInitialResidualCondition::apply(), equationMaxIterCondition::apply(), atmTurbulentHeatFluxTemperatureFvPatchScalarField::atmTurbulentHeatFluxTemperatureFvPatchScalarField(), BreakupModel< CloudType >::BreakupModel(), coordinateScaling< Type >::coordinateScaling(), cyclicACMIFvPatchField< Type >::cyclicACMIFvPatchField(), cyclicAMIFvPatchField< Type >::cyclicAMIFvPatchField(), DAC< CompType, ThermoType >::DAC(), Foam::dimensionedConstant(), DRG< CompType, ThermoType >::DRG(), DRGEP< CompType, ThermoType >::DRGEP(), electrostaticDepositionFvPatchScalarField::electrostaticDepositionFvPatchScalarField(), energyJumpAMIFvPatchScalarField::energyJumpAMIFvPatchScalarField(), energyJumpFvPatchScalarField::energyJumpFvPatchScalarField(), enthalpySorptionFvPatchScalarField::enthalpySorptionFvPatchScalarField(), timeControl::entriesPresent(), exprResult::exprResult(), externalCoupledTemperatureMixedFvPatchScalarField::externalCoupledTemperatureMixedFvPatchScalarField(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), faePatchField< Type >::faePatchField(), fanFvPatchField< Type >::fanFvPatchField(), fanPressureFvPatchScalarField::fanPressureFvPatchScalarField(), faPatchField< Type >::faPatchField(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::filmPyrolysisRadiativeCoupledMixedFvPatchScalarField(), fixedFluxPressureFvPatchScalarField::fixedFluxPressureFvPatchScalarField(), fixedIncidentRadiationFvPatchScalarField::fixedIncidentRadiationFvPatchScalarField(), fixedJumpAMIFvPatchField< Type >::fixedJumpAMIFvPatchField(), fixedJumpFvPatchField< Type >::fixedJumpFvPatchField(), flowRateInletVelocityFvPatchVectorField::flowRateInletVelocityFvPatchVectorField(), flowRateOutletVelocityFvPatchVectorField::flowRateOutletVelocityFvPatchVectorField(), properties::foundObjectProperty(), freestreamFvPatchField< Type >::freestreamFvPatchField(), freestreamPressureFvPatchScalarField::freestreamPressureFvPatchScalarField(), freestreamVelocityFvPatchVectorField::freestreamVelocityFvPatchVectorField(), freeSurfacePressureFvPatchScalarField::freeSurfacePressureFvPatchScalarField(), fvPatchField< Type >::fvPatchField(), fvsPatchField< Type >::fvsPatchField(), genericFaPatchField< Type >::genericFaPatchField(), genericFvPatchField< Type >::genericFvPatchField(), genericFvsPatchField< Type >::genericFvsPatchField(), subModelBase::getBaseProperty(), subModelBase::getModelDict(), subModelBase::getModelProperty(), properties::getObjectDict(), properties::getObjectResult(), refinementParameters::getZoneInfo(), greyDiffusiveRadiationMixedFvPatchScalarField::greyDiffusiveRadiationMixedFvPatchScalarField(), greyDiffusiveViewFactorFixedValueFvPatchScalarField::greyDiffusiveViewFactorFixedValueFvPatchScalarField(), greyMeanAbsorptionEmission::greyMeanAbsorptionEmission(), properties::hasResultObjectEntry(), humidityTemperatureCoupledMixedFvPatchScalarField::humidityTemperatureCoupledMixedFvPatchScalarField(), incompressibleInterPhaseTransportModel< Mixture >::incompressibleInterPhaseTransportModel(), dynamicMotionSolverListFvMesh::init(), oversetFvPatchField< Type >::initEvaluate(), solverInfo::initialiseResidualField(), inletOutletFaPatchField< Type >::inletOutletFaPatchField(), inletOutletFvPatchField< Type >::inletOutletFvPatchField(), inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField(), adjointkOmegaSST::interpolationScheme(), ISAT< CompType, ThermoType >::ISAT(), layerParameters::layerParameters(), liquidFilmModel::liquidFilmModel(), mappedMixedFvPatchField< Type >::mappedMixedFvPatchField(), mappedPatchBase::mappedPatchBase(), MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField(), matchedFlowRateOutletVelocityFvPatchVectorField::matchedFlowRateOutletVelocityFvPatchVectorField(), mixerFvMesh::mixerFvMesh(), liquidProperties::New(), solidProperties::New(), waveModel::New(), objective::objective(), properties::objectResultEntries(), properties::objectResultType(), oldCyclicPolyPatch::oldCyclicPolyPatch(), optMeshMovement::optMeshMovement(), oscillatingDisplacementPointPatchVectorField::oscillatingDisplacementPointPatchVectorField(), oscillatingVelocityPointPatchVectorField::oscillatingVelocityPointPatchVectorField(), outletInletFvPatchField< Type >::outletInletFvPatchField(), outletMappedUniformInletFvPatchField< Type >::outletMappedUniformInletFvPatchField(), outletPhaseMeanVelocityFvPatchVectorField::outletPhaseMeanVelocityFvPatchVectorField(), partialSlipFvPatchField< Type >::partialSlipFvPatchField(), PFA< CompType, ThermoType >::PFA(), phaseHydrostaticPressureFvPatchScalarField::phaseHydrostaticPressureFvPatchScalarField(), Foam::preservePatchTypes(), pressureControl::pressureControl(), pressureInletOutletVelocityFvPatchVectorField::pressureInletOutletVelocityFvPatchVectorField(), prghPermeableAlphaTotalPressureFvPatchScalarField::prghPermeableAlphaTotalPressureFvPatchScalarField(), prghPressureFvPatchScalarField::prghPressureFvPatchScalarField(), prghTotalPressureFvPatchScalarField::prghTotalPressureFvPatchScalarField(), processorFvPatchField< Type >::processorFvPatchField(), tolerances::read(), binModel::read(), uniformBin::read(), timeControl::read(), Foam::readBoxDim(), mappedPatchBase::readDatabase(), Time::readDict(), functionObjectList::readFunctionObject(), liquidProperties::readIfPresent(), refinementParameters::refinementParameters(), refinementSurfaces::refinementSurfaces(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), rigidBodyMotion::rigidBodyMotion(), rotatingWallVelocityFvPatchVectorField::rotatingWallVelocityFvPatchVectorField(), sampledCuttingPlane::sampledCuttingPlane(), sampledCuttingSurface::sampledCuttingSurface(), sampledInterface::sampledInterface(), sampledIsoSurface::sampledIsoSurface(), sampledPlane::sampledPlane(), sampledThresholdCellFaces::sampledThresholdCellFaces(), searchableSurfaces::searchableSurfaces(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setCdSigma(), runTimeCondition::setConditionDict(), binModel::setCoordinateSystem(), forces::setCoordinateSystem(), subModelBase::setModelProperty(), properties::setObjectResult(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setPorosityCoefficient(), lduMatrix::setResidualField(), setToFaceZone::setToFaceZone(), shellSurfaces::shellSurfaces(), sixDoFRigidBodyDisplacementPointPatchVectorField::sixDoFRigidBodyDisplacementPointPatchVectorField(), sixDoFRigidBodyMotion::sixDoFRigidBodyMotion(), solidBodyMotionDisplacementPointPatchVectorField::solidBodyMotionDisplacementPointPatchVectorField(), speciesSorptionFvPatchScalarField::speciesSorptionFvPatchScalarField(), supersonicFreestreamFvPatchVectorField::supersonicFreestreamFvPatchVectorField(), surfaceZonesInfo::surfaceZonesInfo(), temperatureCoupledBase::temperatureCoupledBase(), timeVaryingMappedFixedValueFvPatchField< Type >::timeVaryingMappedFixedValueFvPatchField(), timeVaryingMappedFixedValuePointPatchField< Type >::timeVaryingMappedFixedValuePointPatchField(), timeVaryingMassSorptionFvPatchScalarField::timeVaryingMassSorptionFvPatchScalarField(), timeVaryingUniformFixedValueFaPatchField< Type >::timeVaryingUniformFixedValueFaPatchField(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::totalFlowRateAdvectiveDiffusiveFvPatchScalarField(), totalPressureFvPatchScalarField::totalPressureFvPatchScalarField(), totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField(), turbulentInletFvPatchField< Type >::turbulentInletFvPatchField(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::turbulentTemperatureRadCoupledMixedFvPatchScalarField(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField(), uniformDensityHydrostaticPressureFvPatchScalarField::uniformDensityHydrostaticPressureFvPatchScalarField(), uniformFixedValueFvPatchField< Type >::uniformFixedValueFvPatchField(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), uniformInletOutletFvPatchField< Type >::uniformInletOutletFvPatchField(), uniformInterpolatedDisplacementPointPatchVectorField::uniformInterpolatedDisplacementPointPatchVectorField(), uniformJumpAMIFvPatchField< Type >::uniformJumpAMIFvPatchField(), uniformJumpFvPatchField< Type >::uniformJumpFvPatchField(), uniformNormalFixedValueFvPatchVectorField::uniformNormalFixedValueFvPatchVectorField(), uniformTotalPressureFvPatchScalarField::uniformTotalPressureFvPatchScalarField(), Foam::unitSet(), faMeshDecomposition::updateParameters(), solverInfo::updateSolverInfo(), valuePointPatchField< Type >::valuePointPatchField(), variableHeightFlowRateFvPatchScalarField::variableHeightFlowRateFvPatchScalarField(), velocityFilmShellFvPatchVectorField::velocityFilmShellFvPatchVectorField(), wallHeatTransferFvPatchScalarField::wallHeatTransferFvPatchScalarField(), waveDisplacementPointPatchVectorField::waveDisplacementPointPatchVectorField(), waveMakerPointPatchVectorField::waveMakerPointPatchVectorField(), wideBandAbsorptionEmission::wideBandAbsorptionEmission(), wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField(), properties::writeResultEntries(), and writer::writeSolution().
|
inline |
Find for an entry (non-const access) with the given keyword.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 96 of file dictionaryI.H.
References Foam::search().
Referenced by exprResultDelayed::exprResultDelayed(), dynamicCodeContext::findEntry(), GAMGSolver::GAMGSolver(), Foam::getOrAdd(), dictionary::lookupEntryPtr(), fvGeometryScheme::New(), sampledSets::read(), sampledSurfaces::read(), Enum< injectionMethod >::read(), dimensionSet::readEntry(), dynamicCodeContext::readEntry(), refinementSurfaces::refinementSurfaces(), shellSurfaces::shellSurfaces(), solution::upgradeSolverDict(), and Foam::writeEntryIfPresent().
|
inline |
Find an entry (const access) with the given keyword.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 106 of file dictionaryI.H.
References LList< LListBase, T >::link::ptr().
|
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.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 116 of file dictionaryI.H.
References LList< LListBase, T >::link::ptr().
Referenced by Foam::getVariable(), Foam::getVariableOrDie(), and dictionary::lookupScopedEntryPtr().
|
inline |
Find and return a sub-dictionary pointer if present.
(and a sub-dictionary) otherwise return nullptr.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 126 of file dictionaryI.H.
References Foam::search().
Referenced by alphatWallBoilingWallFunctionFvPatchScalarField::alphatWallBoilingWallFunctionFvPatchScalarField(), Foam::cfindCoeffsDict(), codedMixedFvPatchField< Type >::codeContext(), codedFunctionObject::codeContext(), faMesh::faMesh(), writerCaching::fieldsDict(), oversetFvPatchField< Type >::initEvaluate(), loopControl::loopControl(), namedBlock::namedBlock(), namedVertex::namedVertex(), laminarModel< BasicTurbulenceModel >::New(), RASModelVariables::New(), decompositionMethod::optionalRegionDict(), adjointRASModel::read(), SemiImplicitSource< Type >::read(), PDRblock::read(), blockVertex::read(), Time::readDict(), mapDistribute::readDict(), functionObjectList::readFunctionObject(), Foam::resetFuncsImpl(), searchableSurfaceCollection::searchableSurfaceCollection(), Time::setMonitoring(), dictionary::subDictPtr(), surfaceWriter::surfaceWriter(), Foam::unitSet(), blockDescriptor::write(), blockVertex::write(), and Foam::writeFuncsImpl().
|
inline |
Find and return a sub-dictionary pointer if present.
(and a sub-dictionary) otherwise return nullptr.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 136 of file dictionaryI.H.
const Foam::entry & lookupEntry | ( | const word & | keyword, |
enum keyType::option | matchOpt | ||
) | const |
Search for an entry (const access) with the given keyword.
keyword | the keyword to search for |
matchOpt | search mode |
Definition at line 365 of file dictionary.C.
References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::nl, and dictionary::Searcher< Const >::ref().
Referenced by parcelSelection::calculateFilter(), lduMatrix::smoother::getName(), lduMatrix::preconditioner::getName(), dictionary::lookupEntry(), lduMatrix::preconditioner::New(), and lduMatrix::smoother::New().
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
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 385 of file dictionary.C.
Referenced by equationMaxIterCondition::apply(), molecule::constantProperties::constantProperties(), curvatureSeparation::curvatureSeparation(), Field< T >::Field(), forceList::forceList(), Foam::getLazyPair(), Foam::getRadius(), injectionModelList::injectionModelList(), LangmuirHinshelwoodReactionRate::LangmuirHinshelwoodReactionRate(), multivariateSelectionScheme< Type >::multivariateSelectionScheme(), reactionRateFlameArea::New(), interpolation< Type >::New(), multivariateIndependentScheme< Type >::operator()(), cloudSolution::read(), dimensionSet::read(), refinementParameters::refinementParameters(), shellSurfaces::shellSurfaces(), and solverInfo::updateSolverInfo().
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.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 106 of file dictionaryTemplates.C.
References T.
Referenced by geometric::add(), columnFvMeshInfo::addLocalPatches(), exprResultGlobals::addValue(), BreakupModel< CloudType >::BreakupModel(), parcelSelection::calculateFilter(), rotorDiskSource::checkData(), chemkinReader::chemkinReader(), CloudFunctionObjectList< CloudType >::CloudFunctionObjectList(), coalCloudList::coalCloudList(), axisAligned::computeControlPoints(), transformBox::computeControlPoints(), cuboid::cuboid(), filmTurbulenceModel::Cw(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), DAC< CompType, ThermoType >::DAC(), Foam::dimensionedConstant(), directions::directions(), argList::displayDoc(), KirchhoffShell::evolveRegion(), thermalShell::evolveRegion(), exprResult::exprResult(), filmTurbulenceModel::filmTurbulenceModel(), FreeStream< CloudType >::FreeStream(), Enum< injectionMethod >::get(), Foam::getLazyPair(), Foam::getRadius(), greyMeanAbsorptionEmission::greyMeanAbsorptionEmission(), viewFactor::initialise(), ISAT< CompType, ThermoType >::ISAT(), layerParameters::layerParameters(), Foam::MULES::limiterCorr(), liquidFilmModel::liquidFilmModel(), medialAxisMeshMover::move(), multiDirRefinement::multiDirRefinement(), decompositionMethod::nDomains(), TurbulenceModel< Alpha, Rho, BasicTurbulenceModel, TransportModel >::New(), daughterSizeDistributionModel::New(), barotropicCompressibilityModel::New(), decompositionConstraint::New(), decompositionMethod::New(), diameterModel::New(), profileModel::New(), CorrectionLimitingMethod::New(), ParticleStressModel::New(), TimeScaleModel::New(), extrudeModel::New(), coordinateRotation::New(), CHFModel::New(), CHFSubCoolModel::New(), departureDiameterModel::New(), departureFrequencyModel::New(), filmBoilingModel::New(), LeidenfrostModel::New(), MHFModel::New(), nucleateFluxModel::New(), nucleationSiteModel::New(), partitioningModel::New(), TDNBModel::New(), noiseModel::New(), liquidProperties::New(), solidProperties::New(), thermophysicalFunction::New(), generalizedNewtonianViscosityModel::New(), porousModel::New(), absorptionEmissionModel::New(), scatterModel::New(), surfaceTensionModel::New(), NURBS3DVolume::New(), binModel::New(), heatTransferCoeffModel::New(), windowModel::New(), saturationModel::New(), massTransferModel::New(), aspectRatioModel::New(), dragModel::New(), heatTransferModel::New(), liftModel::New(), phaseTransferModel::New(), swarmCorrection::New(), turbulentDispersionModel::New(), virtualMassModel::New(), wallDampingModel::New(), wallLubricationModel::New(), distributionModel::New(), regionModelFunctionObject::New(), sixDoFSolver::New(), renumberMethod::New(), solidBodyMotionFunction::New(), trimModel::New(), LESfilter::New(), cellCellStencil::New(), multiphaseSystem::New(), twoPhaseSystem::New(), updateMethod::New(), objectiveManager::New(), objectiveIncompressible::New(), adjointSensitivity::New(), ATCModel::New(), DMDModel::New(), pyrolysisModel::New(), liquidFilmBase::New(), vibrationShellModel::New(), chemistryReductionMethod< CompType, ThermoType >::New(), chemistryTabulationMethod< CompType, ThermoType >::New(), dynamicFvMesh::New(), simplifiedDynamicFvMeshBase::New(), engineMesh::New(), ODESolver::New(), phaseModel::New(), laminarFlameSpeed::New(), LduMatrix< Type, DType, LUType >::preconditioner::New(), Reaction< ReactionThermo >::New(), SRFModel::New(), runTimeCondition::New(), waveModel::New(), lduMatrix::solver::New(), LduMatrix< Type, DType, LUType >::smoother::New(), LduMatrix< Type, DType, LUType >::solver::New(), blendingMethod::New(), option::New(), cellZone::New(), faPatch::New(), faceZone::New(), pointZone::New(), polyPatch::New(), polyMeshModifier::New(), restraint::New(), energyScalingFunction::New(), pairPotential::New(), sixDoFRigidBodyMotionConstraint::New(), sixDoFRigidBodyMotionRestraint::New(), tetherPotential::New(), viscosityModel::New(), porosityModel::New(), sampledSurface::New(), sampledSet::New(), functionObject::New(), fieldValue::New(), LESdelta::New(), integrationScheme::New(), optimisationManager::New(), optMeshMovement::New(), optimisationType::New(), displacementMethod::New(), incompressiblePrimalSolver::New(), primalSolver::New(), adjointSolver::New(), incompressibleAdjointSolver::New(), adjointRASModel::New(), adjointTurbulenceModel::New(), filmTurbulenceModel::New(), controlPointsDefinition::New(), rigidBodySolver::New(), basicSolidChemistryModel::New(), filmThermoModel::New(), filmRadiationModel::New(), phaseChangeModel::New(), filmViscosityModel::New(), objective::objective(), objectiveIncompressible::objectiveIncompressible(), objectiveManager::objectiveManager(), offsetSurface::offsetSurface(), dynamicCodeContext::operator const dictionary &(), Foam::operator>>(), optMeshMovement::optMeshMovement(), IOobject::parseHeader(), PatchParticleHistogram< CloudType >::PatchParticleHistogram(), plane::plane(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), pressureControl::pressureControl(), filmTurbulenceModel::primaryRegionFriction(), solutionControl::read(), patchProbes::read(), binModel::read(), singleDirectionUniformBin::read(), uniformBin::read(), externalCoupled::read(), heatTransferCoeffModel::read(), areaWrite::read(), rotorDiskSource::read(), targetCoeffTrim::read(), timeControl::read(), surfaceNoise::read(), sampledSurfaces::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), Foam::readBoxDim(), mappedPatchBase::readDatabase(), dynamicRefineFvMesh::readDict(), Time::readDict(), mapDistributeBase::readDict(), exprDriver::readExpression(), functionObjectList::readFunctionObject(), SIMPLEControl::readIters(), SIMPLEControlSingleRun::readIters(), refinementSurfaces::refinementSurfaces(), boundaryRegion::rename(), rigidBodyModel::rigidBodyModel(), rigidBodyMotion::rigidBodyMotion(), sampledPatchInternalField::sampledPatchInternalField(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), cellBitSet::select(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setCdSigma(), propellerInfo::setCoordinateSystem(), binModel::setCoordinateSystem(), forces::setCoordinateSystem(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setPorosityCoefficient(), shapeOptimisation::shapeOptimisation(), multiphaseSystem::solve(), populationBalanceModel::solve(), twoPhaseSystem::solve(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), sphere::sphere(), surfaceZonesInfo::surfaceZonesInfo(), Switch::Switch(), thirdBodyEfficiencies::thirdBodyEfficiencies(), controlPointsDefinition::transformControlPoints(), uniformInterpolationTable< Type >::uniformInterpolationTable(), Foam::unitSet(), dynamicRefineFvMesh::updateTopology(), WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), wideBandAbsorptionEmission::wideBandAbsorptionEmission(), windowModel::windowModel(), thermalBaffleFvPatchScalarField::write(), and ensightWriter::writeCollated().
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.
keyword | the keyword to search for |
deflt | the default value to use |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 147 of file dictionaryTemplates.C.
References dictionary::Searcher< Const >::good(), dictionary::Searcher< Const >::ptr(), and T.
Referenced by atmBoundaryLayerInletEpsilonFvPatchScalarField::atmBoundaryLayerInletEpsilonFvPatchScalarField(), atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), atmBoundaryLayerInletOmegaFvPatchScalarField::atmBoundaryLayerInletOmegaFvPatchScalarField(), atmBoundaryLayerInletVelocityFvPatchVectorField::atmBoundaryLayerInletVelocityFvPatchVectorField(), motionSmootherAlgo::checkMesh(), sensitivitySurface::computeRadius(), ATCModel::createLimiter(), csvWriter::csvWriter(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cylindrical::cylindrical(), displacementComponentLaplacianFvMotionSolver::displacementComponentLaplacianFvMotionSolver(), exprResult::exprResult(), faMesh::faMesh(), fixedFluxPressureFvPatchScalarField::fixedFluxPressureFvPatchScalarField(), fixedMeanFvPatchField< Type >::fixedMeanFvPatchField(), fixedMeanOutletInletFvPatchField< Type >::fixedMeanOutletInletFvPatchField(), fixedNormalInletOutletVelocityFvPatchVectorField::fixedNormalInletOutletVelocityFvPatchVectorField(), fixedNormalSlipFvPatchField< Type >::fixedNormalSlipFvPatchField(), fixedTemperatureConstraint::fixedTemperatureConstraint(), flowRateInletVelocityFvPatchVectorField::flowRateInletVelocityFvPatchVectorField(), flowRateOutletVelocityFvPatchVectorField::flowRateOutletVelocityFvPatchVectorField(), fluxCorrectedVelocityFvPatchVectorField::fluxCorrectedVelocityFvPatchVectorField(), VTPsurfaceFormatCore::formatOptions(), VTKsurfaceFormatCore::formatOptions(), freestreamFvPatchField< Type >::freestreamFvPatchField(), freeSurfaceVelocityFvPatchVectorField::freeSurfaceVelocityFvPatchVectorField(), Foam::getVerbosity(), gnuplotWriter::gnuplotWriter(), hydrostaticPressure::hydrostaticPressure(), viewFactor::initialise(), inletOutletFvPatchField< Type >::inletOutletFvPatchField(), inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField(), isoAdvection::isoAdvection(), isoSurfaceParams::isoSurfaceParams(), KinematicSurfaceFilm< CloudType >::KinematicSurfaceFilm(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), LocalInteraction< CloudType >::LocalInteraction(), dictionary::lookupOrDefault(), matchedFlowRateOutletVelocityFvPatchVectorField::matchedFlowRateOutletVelocityFvPatchVectorField(), stepUpdate::New(), lineSearch::New(), tableReader< Type >::New(), thermalBaffleModel::New(), zeroATCcells::New(), fvGeometryScheme::New(), thermalShellModel::New(), coordinateSystem::New(), engineTime::New(), noSlipFvPatchVectorField::noSlipFvPatchVectorField(), Foam::operator>>(), outletInletFvPatchField< Type >::outletInletFvPatchField(), outletMappedUniformInletFvPatchField< Type >::outletMappedUniformInletFvPatchField(), outletPhaseMeanVelocityFvPatchVectorField::outletPhaseMeanVelocityFvPatchVectorField(), argList::parse(), partialSlipFvPatchField< Type >::partialSlipFvPatchField(), phaseHydrostaticPressureFvPatchScalarField::phaseHydrostaticPressureFvPatchScalarField(), pressureDirectedInletOutletVelocityFvPatchVectorField::pressureDirectedInletOutletVelocityFvPatchVectorField(), pressureInletOutletParSlipVelocityFvPatchVectorField::pressureInletOutletParSlipVelocityFvPatchVectorField(), pressureInletOutletVelocityFvPatchVectorField::pressureInletOutletVelocityFvPatchVectorField(), pressureNormalInletOutletVelocityFvPatchVectorField::pressureNormalInletOutletVelocityFvPatchVectorField(), pressurePermeableAlphaInletOutletVelocityFvPatchVectorField::pressurePermeableAlphaInletOutletVelocityFvPatchVectorField(), profiling::profiling(), rawWriter::rawWriter(), pimpleControl::read(), functionObjectList::read(), adjointEikonalSolver::read(), adjointMeshMovementSolver::read(), FIBase::read(), sensitivityBezierFI::read(), sensitivitySurface::read(), sensitivitySurfacePoints::read(), SIBase::read(), SIMPLEControlOpt::read(), solverControl::read(), solutionControl::read(), probes::read(), sampledSets::read(), singleDirectionUniformBin::read(), uniformBin::read(), multiFieldValue::read(), areaWrite::read(), directionalPressureGradientExplicitSource::read(), targetCoeffTrim::read(), PDRblock::read(), functionObject::read(), timeControl::read(), rigidBodyMotion::read(), sampledSurfaces::read(), sixDoFRigidBodyMotion::read(), moleFractions< ThermoType >::read(), externalFileCoupler::readDict(), adjointSolver::readDict(), temperatureDependent::readDict(), refinementSurfaces::refinementSurfaces(), rotatingPressureInletOutletVelocityFvPatchVectorField::rotatingPressureInletOutletVelocityFvPatchVectorField(), sampledMeshedSurface::sampleOnFaces(), searchableSurfaces::searchableSurfaces(), cellTable::selectType(), propellerInfo::setCoordinateSystem(), Time::setMonitoring(), propellerInfo::setSampleDiskSurface(), slidingInterface::setTolerances(), shellSurfaces::shellSurfaces(), shortestPathSet::shortestPathSet(), populationBalanceModel::solve(), faMatrix< Type >::solve(), fvMatrix< Type >::fvSolver::solve(), fvMatrix< Type >::solveCoupled(), fvMatrix< Type >::solveSegregated(), fvMatrix< Type >::solveSegregatedOrCoupled(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), SRFFreestreamVelocityFvPatchVectorField::SRFFreestreamVelocityFvPatchVectorField(), StandardWallInteraction< CloudType >::StandardWallInteraction(), supersonicFreestreamFvPatchVectorField::supersonicFreestreamFvPatchVectorField(), transferModelList::transferModelList(), triSurface::triSurface(), triSurfaceMesh::triSurfaceMesh(), turbulentIntensityKineticEnergyInletFvPatchScalarField::turbulentIntensityKineticEnergyInletFvPatchScalarField(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField(), turbulentMixingLengthFrequencyInletFvPatchScalarField::turbulentMixingLengthFrequencyInletFvPatchScalarField(), uniformFixedGradientFvPatchField< Type >::uniformFixedGradientFvPatchField(), uniformInletOutletFvPatchField< Type >::uniformInletOutletFvPatchField(), UnsortedMeshedSurface< Face >::UnsortedMeshedSurface(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), dynamicRefineFvMesh::updateTopology(), variableHeightFlowRateFvPatchScalarField::variableHeightFlowRateFvPatchScalarField(), velocityGroup::velocityGroup(), vtkWriter::vtkWriter(), VTKedgeFormat::write(), ensightWriter::writeCollated(), and xmgraceWriter::xmgraceWriter().
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.
keyword | the keyword to search for |
deflt | the default value to use |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 177 of file dictionaryTemplates.C.
References Foam::add(), dictionary::Searcher< Const >::good(), dictionary::Searcher< Const >::ptr(), and T.
Referenced by Switch::getOrAddToDict(), and dictionary::lookupOrAddDefault().
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.
keyword | the keyword to search for |
val | the value to read into |
matchOpt | search mode (default: non-recursive with patterns) |
mandatory | the keyword is mandatory (default: true) |
Definition at line 301 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(), coordinateSystem::assign(), bladeModel::bladeModel(), BreakupModel< CloudType >::BreakupModel(), buoyancyEnergy::buoyancyEnergy(), buoyancyForce::buoyancyForce(), cellModel::cellModel(), cellToCell::cellToCell(), cellToFace::cellToFace(), cellToPoint::cellToPoint(), rotorDiskSource::checkData(), colourTable::colourTable(), fromFile::computeControlPoints(), constantFilmThermo::Cp(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), constantFilmThermo::D(), directionalPressureGradientExplicitSource::directionalPressureGradientExplicitSource(), argList::displayDoc(), distanceSurface::distanceSurface(), ETAB< CloudType >::ETAB(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), faceToCell::faceToCell(), faceToFace::faceToFace(), faceToPoint::faceToPoint(), motionSmootherAlgo::get(), meshRefinement::get(), greyMeanSolidAbsorptionEmission::greyMeanSolidAbsorptionEmission(), constantFilmThermo::hl(), holeToFace::holeToFace(), humidityTemperatureCoupledMixedFvPatchScalarField::humidityTemperatureCoupledMixedFvPatchScalarField(), InflationInjection< CloudType >::InflationInjection(), dynamicMultiMotionSolverFvMesh::init(), viewFactor::initialise(), liquidFilmThermo::initLiquid(), interRegionHeatTransferModel::interRegionHeatTransferModel(), ISAT< CompType, ThermoType >::ISAT(), constantFilmThermo::kappa(), KinematicSurfaceFilm< CloudType >::KinematicSurfaceFilm(), liquidFilmThermo::liquidFilmThermo(), lookupProfile::lookupProfile(), mappedPatchBase::mappedPatchBase(), mappedPatchFieldBase< Type >::mappedPatchFieldBase(), meanVelocityForce::meanVelocityForce(), constantFilmThermo::mu(), multiBandAbsorption::multiBandAbsorption(), multiBandAbsorptionEmission::multiBandAbsorptionEmission(), multiBandTransmissivity::multiBandTransmissivity(), multiBandZoneAbsorptionEmission::multiBandZoneAbsorptionEmission(), multiphaseSystem::multiphaseSystem(), nastranWriter::nastranWriter(), patchDistMethod::New(), surfaceFilmModel::New(), radiationModel::New(), combustionModel::New(), oldCyclicPolyPatch::oldCyclicPolyPatch(), Foam::operator>>(), PairSpringSliderDashpot< CloudType >::PairSpringSliderDashpot(), argList::parse(), PilchErdman< CloudType >::PilchErdman(), pointToCell::pointToCell(), pointToFace::pointToFace(), pointToPoint::pointToPoint(), porosityModel::porosityModel(), pressureControl::pressureControl(), constantFilmThermo::pv(), adjointRASModel::read(), kinematicSingleLayer::read(), thermalBaffle::read(), probes::read(), sampledSets::read(), egrMixture< ThermoType >::read(), inhomogeneousMixture< ThermoType >::read(), anisotropicFilter::read(), laplaceFilter::read(), consumptionSpeed::read(), porosityModel::read(), areaWrite::read(), directionalPressureGradientExplicitSource::read(), targetCoeffTrim::read(), pointNoise::read(), surfaceNoise::read(), sampledSurfaces::read(), sixDoFRigidBodyMotion::read(), smoothDelta::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), reactionRateFlameArea::read(), doubleSigmoid::read(), sigmoid::read(), azizChen::read(), dampedCoulomb::read(), exponentialRepulsion::read(), lennardJones::read(), maitlandSmith::read(), phaseModel::read(), harmonicSpring::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), Arrhenius< ViscousModel >::read(), BirdCarreau::read(), Casson::read(), CrossPowerLaw::read(), HerschelBulkley::read(), powerLaw::read(), Foam::readBoxDim(), thermo::readControls(), dynamicRefineFvMesh::readDict(), Time::readDict(), externalFileCoupler::readDict(), mapDistributeBase::readDict(), mapDistributePolyMesh::readDict(), streamFunction::readDict(), valueAverageBase::readState(), regionProperties::regionProperties(), ReitzDiwakar< CloudType >::ReitzDiwakar(), ReitzKHRT< CloudType >::ReitzKHRT(), constantFilmThermo::rho(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), Sampled< Type >::Sampled(), sampledCuttingPlane::sampledCuttingPlane(), sampledCuttingSurface::sampledCuttingSurface(), sampledInterface::sampledInterface(), sampledIsoSurface::sampledIsoSurface(), sampledPlane::sampledPlane(), searchableSurfaceCollection::searchableSurfaceCollection(), seriesProfile::seriesProfile(), reducedUnits::setRefValues(), faceSetOption::setSelection(), cellSetOption::setSelection(), shellSurfaces::shellSurfaces(), constantFilmThermo::sigma(), SingleMixtureFraction< CloudType >::SingleMixtureFraction(), sixDoFRigidBodyDisplacementPointPatchVectorField::sixDoFRigidBodyDisplacementPointPatchVectorField(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), slidingInterface::slidingInterface(), surfaceFeatures::surfaceFeatures(), surfaceZonesInfo::surfaceZonesInfo(), constantFilmThermo::Tb(), thermoCoupleProbes::thermoCoupleProbes(), thermoSingleLayer::thermoSingleLayer(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::turbulentTemperatureRadCoupledMixedFvPatchScalarField(), uniformInterpolationTable< Type >::uniformInterpolationTable(), variableHeatTransfer::variableHeatTransfer(), viscousDissipation::viscousDissipation(), constantFilmThermo::W(), WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), WallSpringSliderDashpot< CloudType >::WallSpringSliderDashpot(), wideBandAbsorptionEmission::wideBandAbsorptionEmission(), writer::writeSolution(), and zoneCombustion< ReactionThermo >::zoneCombustion().
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.
keyword | the keyword to search for |
val | the value to read into |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 404 of file dictionaryTemplates.C.
References dictionary::readIfPresent().
Referenced by activePressureForceBaffleVelocityFvPatchVectorField::activePressureForceBaffleVelocityFvPatchVectorField(), advectiveFvPatchField< Type >::advectiveFvPatchField(), alphatWallBoilingWallFunctionFvPatchScalarField::alphatWallBoilingWallFunctionFvPatchScalarField(), coordinateSystem::assign(), averageCondition::averageCondition(), basicThermo::basicThermo(), boxToCell::boxToCell(), boxToFace::boxToFace(), boxToPoint::boxToPoint(), valueAverageBase::calc(), cellToCell::cellToCell(), cellToFace::cellToFace(), cellToPoint::cellToPoint(), motionSmootherAlgo::checkMesh(), chemkinReader::chemkinReader(), cloudSolution::cloudSolution(), coordSetWriter::coordSetWriter(), coupleGroupIdentifier::coupleGroupIdentifier(), crankConRod::crankConRod(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), demandDrivenEntry< Type >::demandDrivenEntry(), distanceSurface::distanceSurface(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), dlLibraryTable::dlLibraryTable(), DRGEP< CompType, ThermoType >::DRGEP(), EFA< CompType, ThermoType >::EFA(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), faceToCell::faceToCell(), faceToFace::faceToFace(), faceToPoint::faceToPoint(), faceZoneToCell::faceZoneToCell(), faPatchField< Type >::faPatchField(), fvMotionSolverEngineMesh::fvMotionSolverEngineMesh(), fvPatchField< Type >::fvPatchField(), geometricSurfacePatch::geometricSurfacePatch(), Foam::getAnimationColour(), subModelBase::getBaseProperty(), isoSurfaceParams::getFilterType(), subModelBase::getModelProperty(), properties::getObjectProperty(), properties::getObjectResult(), Foam::getSurfaceName(), refinementParameters::getZoneInfo(), holeToFace::holeToFace(), humidityTemperatureCoupledMixedFvPatchScalarField::humidityTemperatureCoupledMixedFvPatchScalarField(), kinematicSingleLayer::info(), viewFactor::initialise(), objectivePtLosses::initialize(), isoSurfaceParams::isoSurfaceParams(), layeredEngineMesh::layeredEngineMesh(), layerParameters::layerParameters(), lumpedPointDisplacementPointPatchVectorField::lumpedPointDisplacementPointPatchVectorField(), mappedPatchBase::mappedPatchBase(), decompositionMethod::nDomains(), decompositionMethod::New(), liquidProperties::New(), sootModel::New(), polyPatch::New(), reconstructionSchemes::New(), objective::objective(), objectivePartialVolume::objectivePartialVolume(), oldCyclicPolyPatch::oldCyclicPolyPatch(), dlLibraryTable::open(), IOobject::parseHeader(), patchCellsSource::patchCellsSource(), patchIdentifier::patchIdentifier(), patchInjection::patchInjection(), PatchPostProcessing< CloudType >::PatchPostProcessing(), patchToCell::patchToCell(), patchToFace::patchToFace(), plane::plane(), plenumPressureFvPatchScalarField::plenumPressureFvPatchScalarField(), pointHistory::pointHistory(), pointPatchField< Type >::pointPatchField(), pointToCell::pointToCell(), pointToFace::pointToFace(), pointToPoint::pointToPoint(), porosityModel::porosityModel(), Foam::preservePatchTypes(), pressureControl::pressureControl(), randomDecomp::randomDecomp(), kinematicSingleLayer::read(), patchProbes::read(), probes::read(), IDDESDelta::read(), maxDeltaxyz::read(), PrandtlDelta::read(), vanDriestDelta::read(), pointHistory::read(), writeFreeSurface::read(), MRFZone::read(), porosityModel::read(), singleDirectionUniformBin::read(), uniformBin::read(), heatTransferCoeffModel::read(), areaWrite::read(), noiseModel::read(), pointNoise::read(), surfaceNoise::read(), LduMatrix< Type, DType, LUType >::solver::readControl(), Time::readDict(), mapDistribute::readDict(), decomposedBlockData::readHeader(), liquidProperties::readIfPresent(), solidProperties::readIfPresent(), thermophysicalProperties::readIfPresent(), Switch::readIfPresent(), dictionary::readIfPresent(), noiseModel::readWriteOption(), refinementParameters::refinementParameters(), refinementSurfaces::refinementSurfaces(), sampledCuttingPlane::sampledCuttingPlane(), sampledCuttingSurface::sampledCuttingSurface(), sampledInterface::sampledInterface(), sampledIsoSurface::sampledIsoSurface(), sampledMeshedSurface::sampledMeshedSurface(), sampledPlane::sampledPlane(), Time::setControls(), propellerInfo::setCoordinateSystem(), forces::setCoordinateSystem(), propellerInfo::setSampleDiskSurface(), data::setSolverPerformance(), Time::setTime(), sixDoFRigidBodyDisplacementPointPatchVectorField::sixDoFRigidBodyDisplacementPointPatchVectorField(), surfaceWriter::surfaceWriter(), surfaceZonesInfo::surfaceZonesInfo(), surfZoneIdentifier::surfZoneIdentifier(), Switch::Switch(), thermalBaffleFvPatchScalarField::thermalBaffleFvPatchScalarField(), thermoSingleLayer::thermoSingleLayer(), thirdBodyEfficiencies::thirdBodyEfficiencies(), timeVaryingMappedFixedValuePointPatchField< Type >::timeVaryingMappedFixedValuePointPatchField(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), triSurfaceMesh::triSurfaceMesh(), triSurfaceSearch::triSurfaceSearch(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::turbulentTemperatureRadCoupledMixedFvPatchScalarField(), uniformInterpolationTable< Type >::uniformInterpolationTable(), updateMethod::updateMethod(), faMeshDecomposition::updateParameters(), topoSetSource::verbose(), IOstreamOption::versionNumber::versionNumber(), writeFreeSurface::writeFreeSurface(), x3dWriter::x3dWriter(), zeroATCcells::zeroATCcells(), zoneIdentifier::zoneIdentifier(), zoneMotion::zoneMotion(), zoneSubSet::zoneSubSet(), zoneToCell::zoneToCell(), zoneToFace::zoneToFace(), and zoneToPoint::zoneToPoint().
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.
keyword | the keyword to search for |
pred | the value check predicate |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 119 of file dictionaryTemplates.C.
References T.
Referenced by electrostaticDepositionFvPatchScalarField::electrostaticDepositionFvPatchScalarField(), singleDirectionUniformBin::read(), and electricPotential::read().
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.
keyword | the keyword to search for |
deflt | the default value to use |
pred | the value check predicate |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 208 of file dictionaryTemplates.C.
References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::name(), dictionary::Searcher< Const >::ptr(), and T.
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.
keyword | the keyword to search for |
deflt | the default value to use |
pred | the value check predicate |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 254 of file dictionaryTemplates.C.
References Foam::add(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::name(), dictionary::Searcher< Const >::ptr(), and T.
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.
keyword | the keyword to search for |
val | the value to read into |
pred | the value check predicate |
matchOpt | search mode (default: non-recursive with patterns) |
mandatory | the keyword is mandatory (default: true) |
Definition at line 333 of file dictionaryTemplates.C.
References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::name(), Foam::nl, and dictionary::Searcher< Const >::ptr().
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.
keyword | the keyword to search for |
val | the value to read into |
pred | the value check predicate |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 417 of file dictionaryTemplates.C.
|
inline |
Check if entry is found and is a sub-dictionary.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 146 of file dictionaryI.H.
Referenced by boundaryRadiationProperties::boundaryRadiationProperties(), energyTransport::energyTransport(), properties::getObjectDict(), liquidMixtureProperties::liquidMixtureProperties(), surfaceTensionModel::New(), basicChemistryModel::New(), reader::remapMeshInfo(), solidMixtureProperties::solidMixtureProperties(), thermophysicalPropertiesSelector< ThermophysicalProperties >::thermophysicalPropertiesSelector(), volBSplinesBase::volBSplinesBase(), and writer::writeSolution().
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.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 459 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(), alphatWallBoilingWallFunctionFvPatchScalarField::alphatWallBoilingWallFunctionFvPatchScalarField(), boundaryRadiationProperties::boundaryRadiationProperties(), BreakupModel< CloudType >::BreakupModel(), valueAverageBase::calc(), CloudFunctionObjectList< CloudType >::CloudFunctionObjectList(), coordinateSystem::coordinateSystem(), cylindrical::cylindrical(), DAC< CompType, ThermoType >::DAC(), Foam::dimensionedConstant(), directions::directions(), argList::displayDoc(), DRG< CompType, ThermoType >::DRG(), DRGEP< CompType, ThermoType >::DRGEP(), energyTransport::energyTransport(), extrudePatchMesh::extrudePatchMesh(), faMesh::faMesh(), freestreamFvPatchField< Type >::freestreamFvPatchField(), subModelBase::getBaseProperty(), subModelBase::getModelDict(), subModelBase::getModelProperty(), properties::getObjectDict(), properties::getObjectResult(), refinementParameters::getZoneInfo(), properties::hasResultObjectEntry(), humidityTemperatureCoupledMixedFvPatchScalarField::humidityTemperatureCoupledMixedFvPatchScalarField(), dynamicMultiMotionSolverFvMesh::init(), dynamicMotionSolverListFvMesh::init(), oversetFvPatchField< Type >::initEvaluate(), viewFactor::initialise(), cloudSolution::integrationSchemes(), cloudSolution::interpolationSchemes(), ISAT< CompType, ThermoType >::ISAT(), liquidMixtureProperties::liquidMixtureProperties(), multiBandZoneAbsorptionEmission::multiBandZoneAbsorptionEmission(), multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), LESModel< BasicTurbulenceModel >::New(), noiseModel::New(), windowModel::New(), regionModelFunctionObject::New(), coordinateSystem::New(), phaseModel::New(), waveModel::New(), optimisationType::New(), basicSolidChemistryModel::New(), basicChemistryModel::New(), NonRandomTwoLiquid< Thermo, OtherThermo >::NonRandomTwoLiquid(), objectiveManager::objectiveManager(), properties::objectResultEntries(), properties::objectResultType(), opaqueDiffusive::opaqueDiffusive(), opaqueReflective::opaqueReflective(), optimisationManager::optimisationManager(), outletMappedUniformInletFvPatchField< Type >::outletMappedUniformInletFvPatchField(), PFA< CompType, ThermoType >::PFA(), phaseModel::phaseModel(), phaseSystem::phaseSystem(), plane::plane(), Foam::preservePatchTypes(), profileModelList::profileModelList(), pyrolysisChemistryModel< CompType, SolidThermo, GasThermo >::pyrolysisChemistryModel(), pyrolysisModelCollection::pyrolysisModelCollection(), Raoult< Thermo, OtherThermo >::Raoult(), tolerances::read(), adjointEikonalSolver::read(), optimisationManager::read(), kinematicSingleLayer::read(), runTimeControl::read(), pureMixture< ThermoType >::read(), egrMixture< ThermoType >::read(), homogeneousMixture< ThermoType >::read(), inhomogeneousMixture< ThermoType >::read(), multiComponentMixture< ThermoType >::read(), singleComponentMixture< ThermoType >::read(), veryInhomogeneousMixture< ThermoType >::read(), MRFZoneList::read(), porosityModelList::read(), uniformBin::read(), FixedValueConstraint< Type >::read(), PDRblock::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), doubleSigmoid::read(), sigmoid::read(), dampedCoulomb::read(), lennardJones::read(), harmonicSpring::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), thermo::readControls(), mapDistributeBase::readDict(), mapDistributePolyMesh::readDict(), objectiveManager::readDict(), sensitivityMultiple::readDict(), adjointSolverManager::readDict(), adjointSolver::readDict(), adjointSimple::readDict(), liquidProperties::readIfPresent(), refinementSurfaces::refinementSurfaces(), reader::remapMeshInfo(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), sensitivityMultiple::sensitivityMultiple(), subModelBase::setBaseProperty(), runTimeCondition::setConditionDict(), subModelBase::setModelProperty(), properties::setObjectResult(), cellSetOption::setSelection(), shapeOptimisation::shapeOptimisation(), shellSurfaces::shellSurfaces(), surfaceTensionModel::sigmaDict(), solidMixtureProperties::solidMixtureProperties(), solverControl::solutionDict(), cloudSolution::sourceTermDict(), steadyOptimisation::steadyOptimisation(), thermophysicalPropertiesSelector< ThermophysicalProperties >::thermophysicalPropertiesSelector(), transparent::transparent(), twoPhaseSystem::twoPhaseSystem(), volBSplinesBase::volBSplinesBase(), wideBandAbsorptionEmission::wideBandAbsorptionEmission(), thermalBaffleFvPatchScalarField::write(), properties::writeResultEntries(), and writer::writeSolution().
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.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 479 of file dictionary.C.
References dictionary::Searcher< Const >::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::nl, and Foam::search().
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.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 499 of file dictionary.C.
References dictionary::Searcher< Const >::dictPtr(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), Foam::nl, and Foam::search().
Referenced by sensitivitySurface::smoothSensitivities(), and mappedPatchBase::writeDict().
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.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
mandatory | the keyword is mandatory (default: false) |
Definition at line 539 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(), distributionModel::New(), sensitivityBezierFI::read(), solverControl::read(), solutionControl::read(), areaWrite::read(), noiseModel::read(), surfaceNoise::read(), sampledSurfaces::read(), adjointEikonalSolver::readDict(), adjointMeshMovementSolver::readDict(), propellerInfo::setSampleDiskSurface(), and surfaceWriter::surfaceWriter().
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.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 576 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(), lineSearch::coeffsDict(), stepUpdate::coeffsDict(), greyMeanAbsorptionEmission::greyMeanAbsorptionEmission(), greyMeanSolidAbsorptionEmission::greyMeanSolidAbsorptionEmission(), IDDESDelta::IDDESDelta(), liquidFilmThermo::initLiquid(), diameterModel::New(), liquidProperties::New(), solidProperties::New(), sampledSet::New(), optionList::optionsDict(), plane::plane(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), motionSolver::read(), anisotropicFilter::read(), laplaceFilter::read(), porosityModel::read(), trimModel::read(), diameterModel::read(), solidBodyMotionFunction::read(), Arrhenius< ViscousModel >::read(), BirdCarreau::read(), Casson::read(), CrossPowerLaw::read(), HerschelBulkley::read(), powerLaw::read(), strainRateFunction::read(), SIBase::readDict(), cellBitSet::select(), and wideBandAbsorptionEmission::wideBandAbsorptionEmission().
Foam::wordList toc | ( | ) | const |
Return the table of contents.
Definition at line 602 of file dictionary.C.
Referenced by adjointSolverManager::adjointSolverManager(), CloudFunctionObjectList< CloudType >::CloudFunctionObjectList(), DAC< CompType, ThermoType >::DAC(), removeEntry::execute(), FreeStream< CloudType >::FreeStream(), dynamicOversetFvMesh::interpolateFields(), liquidMixtureProperties::liquidMixtureProperties(), Foam::operator>>(), optimisationManager::optimisationManager(), profileModelList::profileModelList(), pyrolysisModelCollection::pyrolysisModelCollection(), cloudSolution::read(), runTimeControl::read(), multiphaseMangrovesSource::read(), multiphaseMangrovesTurbulenceModel::read(), refinementSurfaces::refinementSurfaces(), regionModelFunctionObjectList::regionModelFunctionObjectList(), shellSurfaces::shellSurfaces(), solidMixtureProperties::solidMixtureProperties(), and volBSplinesBase::volBSplinesBase().
Foam::wordList sortedToc | ( | ) | const |
Return the sorted table of contents.
Definition at line 616 of file dictionary.C.
Referenced by equationInitialResidualCondition::apply(), solverFieldSelection::updateSelection(), properties::writeAllResultEntries(), and properties::writeResultEntries().
wordList sortedToc | ( | const Compare & | comp | ) | const |
Return table of contents sorted using the specified comparator.
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 e, n, and List< T >::resize().
Substitute the given keyword (which is prefixed by '$')
with the corresponding sub-dictionary entries
Definition at line 395 of file dictionary.C.
References Foam::add(), dictionary::Searcher< Const >::dict(), e, dictionary::Searcher< Const >::good(), and keyType::REGEX_RECURSIVE.
Substitute the given scoped keyword (which is prefixed by '$')
with the corresponding sub-dictionary entries
Definition at line 427 of file dictionary.C.
References Foam::add(), e, and keyType::REGEX_RECURSIVE.
Referenced by entry::New().
Foam::entry * add | ( | entry * | entryPtr, |
bool | mergeEntry = false |
||
) |
Add a new entry.
entryPtr | the entry to add |
mergeEntry | dictionaries are interwoven and primitive entries are overwritten (default: false) |
Definition at line 640 of file dictionary.C.
References fileName::concat(), entry::dict(), Foam::endl(), IOWarningInFunction, entry::isDict(), keyType::isPattern(), entry::keyword(), entry::name(), and Foam::name().
Referenced by snappyLayerDriver::addLayers(), adjointSolverManager::adjointSolverManager(), Foam::copyFilteredDict(), fvMeshTools::createDummyFvMeshFiles(), faPatchData::dict(), Foam::dimensionedConstant(), Foam::getOrAdd(), refinementParameters::getZoneInfo(), voxelMeshSearch::makeMesh(), dictionary::makeScopedDict(), namedBlock::namedBlock(), namedVertex::namedVertex(), entry::New(), cellTable::operator=(), optimisationManager::optimisationManager(), argList::parse(), Foam::preservePatchTypes(), multiRegion::read(), functionObjectList::readFunctionObject(), subModelBase::setBaseProperty(), runTimeCondition::setConditionDict(), subModelBase::setModelProperty(), properties::setObjectProperty(), properties::setObjectResult(), sensitivitySurface::smoothSensitivities(), rigidBodyMeshMotion::solve(), rigidBodyMeshMotionSolver::solve(), sixDoFRigidBodyMotionSolver::solve(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), solution::upgradeSolverDict(), thermoCoupleProbes::write(), uniformInterpolationTable< Type >::write(), rigidBodyModelState::write(), sixDoFRigidBodyMotionState::write(), mappedPatchBase::writeDict(), surfaceFeatures::writeDict(), decomposedBlockData::writeExtraHeaderContent(), IOobject::writeHeaderContent(), meanVelocityForce::writeProps(), valueAverageBase::writeState(), and Time::writeTimeDict().
Foam::entry * add | ( | const entry & | e, |
bool | mergeEntry = false |
||
) |
Add an entry.
e | the entry to add |
mergeEntry | dictionaries are interwoven and primitive entries are overwritten (default: false) |
Definition at line 719 of file dictionary.C.
References Foam::add(), GeometricField< Type, PatchField, GeoMesh >::clone(), and e.
Foam::entry * add | ( | const keyType & | k, |
const word & | v, | ||
bool | overwrite = false |
||
) |
Add a word entry.
overwrite | force overwrite of an existing entry. |
Definition at line 725 of file dictionary.C.
References Foam::add(), and k.
Foam::entry * add | ( | const keyType & | k, |
const string & | v, | ||
bool | overwrite = false |
||
) |
Add a string entry.
overwrite | force overwrite of an existing entry. |
Definition at line 736 of file dictionary.C.
References Foam::add(), and k.
Foam::entry * add | ( | const keyType & | k, |
const label | v, | ||
bool | overwrite = false |
||
) |
Add a label entry.
overwrite | force overwrite of an existing entry. |
Definition at line 747 of file dictionary.C.
References Foam::add(), and k.
Foam::entry * add | ( | const keyType & | k, |
const scalar | v, | ||
bool | overwrite = false |
||
) |
Add a scalar entry.
overwrite | force overwrite of an existing entry. |
Definition at line 758 of file dictionary.C.
References Foam::add(), and k.
Foam::entry * add | ( | const keyType & | k, |
const dictionary & | d, | ||
bool | mergeEntry = false |
||
) |
Add a dictionary entry.
mergeEntry | merge into an existing sub-dictionary |
Definition at line 769 of file dictionary.C.
References Foam::add(), and k.
Add a T entry.
overwrite | force overwrite of existing entry |
Foam::entry * set | ( | entry * | entryPtr | ) |
Assign a new entry, overwriting any existing entry.
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(), valueAverageBase::calc(), data::data(), extrudePatchMesh::extrudePatchMesh(), fvMeshTools::loadOrCreateMesh(), faMeshTools::loadOrCreateMesh(), fvMeshTools::newMesh(), faMeshTools::newMesh(), polyMesh::polyMesh(), runTimeControl::read(), multiFieldValue::read(), functionObjectList::readFunctionObject(), codedFunctionObject::redirectFunctionObject(), codedPoints0MotionSolver::redirectMotionSolver(), CodedSource< Type >::redirectOption(), codedFixedValueFvPatchField< Type >::redirectPatchField(), codedMixedFvPatchField< Type >::redirectPatchField(), codedFixedValuePointPatchField< Type >::redirectPatchField(), boundaryRegion::rename(), data::setSolverPerformance(), structuredDecomp::structuredDecomp(), ZoneMesh< ZoneType, MeshType >::updateMetaData(), solution::upgradeSolverDict(), averageCondition::write(), decomposedBlockData::writeExtraHeaderContent(), IOobject::writeHeaderContent(), and mappedPatchBase::writeIOField().
Foam::entry * set | ( | const entry & | e | ) |
Assign a new entry, overwriting any existing entry.
Definition at line 800 of file dictionary.C.
References GeometricField< Type, PatchField, GeoMesh >::clone(), and e.
Foam::entry * set | ( | const keyType & | k, |
const dictionary & | v | ||
) |
Assign a dictionary entry, overwriting any existing entry.
Definition at line 806 of file dictionary.C.
References k.
Assign a T entry, overwriting any existing entry.
Remove an entry specified by keyword.
Definition at line 582 of file dictionarySearch.C.
Referenced by removeEntry::execute(), and velocityFilmShellFvPatchVectorField::write().
bool changeKeyword | ( | const keyType & | oldKeyword, |
const keyType & | newKeyword, | ||
bool | overwrite = false |
||
) |
Change the keyword for an entry,.
overwrite | force overwrite of an existing entry. |
Definition at line 610 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().
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(), GeometricField< Type, PatchField, GeoMesh >::clone(), dict, e, Foam::FatalIOError, FatalIOErrorInFunction, and Foam::nl.
Referenced by snappyLayerDriver::addLayers(), Time::readDict(), and functionObjectList::readFunctionObject().
void clear | ( | ) |
Clear the dictionary.
Definition at line 857 of file dictionary.C.
Referenced by Foam::operator>>(), strainRateFunction::read(), and data::setSolverPerformance().
void transfer | ( | dictionary & | dict | ) |
Transfer the contents of the argument and annul the argument.
Definition at line 866 of file dictionary.C.
References dict, dictionary::name(), and Foam::name().
Referenced by dictionary::dictionary(), csvTableReader< Type >::operator()(), and meshRefinement::updateMesh().
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 257 of file dictionary.C.
References JobInfo::constructed, Foam::exit(), Foam::FatalIOError, IOstream::lineNumber(), Foam::nl, ITstream::nRemainingTokens(), UList< T >::size(), and UList< T >::writeList().
Referenced by Table< Type >::Table().
Read dictionary from Istream. Discards the header.
Definition at line 141 of file dictionaryIO.C.
References Foam::read().
Referenced by dictionary::dictionary(), includeEntry::execute(), includeEtcEntry::execute(), calcEntry::execute(), codeStream::execute(), Foam::operator>>(), PDRblock::read(), and IOobject::readHeader().
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(), Time::New(), Foam::nl, and Istream::putBack().
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<<(), thermalBaffleFvPatchScalarField::write(), dictionaryEntry::write(), Foam::writeEntryIfPresent(), decomposedBlockData::writeHeader(), and IOobject::writeHeaderContent().
Write sub-dictionary with the keyword as its header.
Definition at line 172 of file dictionaryIO.C.
References Ostream::beginBlock(), Ostream::endBlock(), and os().
Write dictionary entries.
extraNewLine | adds additional newline between entries for "top-level" dictionaries |
Definition at line 180 of file dictionaryIO.C.
References e, Foam::endl(), IOstream::good(), Foam::name(), Foam::nl, os(), and WarningInFunction.
Referenced by decomposedBlockData::writeHeader(), and Foam::writeJobDict().
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<<(), velocityFilmShellFvPatchVectorField::write(), thermalShellFvPatchScalarField::write(), vibrationShellFvPatchScalarField::write(), fieldDictionary::writeData(), and surfaceFeatures::writeDict().
Foam::dictionary::const_searcher csearch | ( | const word & | keyword, |
enum keyType::option | matchOpt = keyType::REGEX |
||
) | const |
Search dictionary for given keyword.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 264 of file dictionarySearch.C.
References keyType::RECURSIVE, keyType::REGEX, and dictionary::Searcher< Const >::set().
Referenced by dictionary::csearchCompat(), meshRefinement::lookup(), meshRefinement::subDict(), and Foam::subDictCompat().
Foam::dictionary::const_searcher search | ( | const word & | keyword, |
enum keyType::option | matchOpt = keyType::REGEX |
||
) | const |
Search dictionary for given keyword.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 302 of file dictionarySearch.C.
Referenced by entry::New().
Foam::dictionary::searcher search | ( | const word & | keyword, |
enum keyType::option | matchOpt = keyType::REGEX |
||
) |
Search dictionary for given keyword.
keyword | the keyword to search for |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 312 of file dictionarySearch.C.
Foam::dictionary::const_searcher csearchScoped | ( | const word & | keyword, |
enum keyType::option | matchOpt | ||
) | const |
Search using scoping.
There are two types of scoping available:
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.
keyword | the keyword to search for |
matchOpt | search mode |
Definition at line 324 of file dictionarySearch.C.
References formatter::npos, and keyType::RECURSIVE.
Referenced by entry::New().
Foam::dictionary::const_searcher searchScoped | ( | const word & | keyword, |
enum keyType::option | matchOpt | ||
) | const |
Search using dot or slash scoping.
keyword | the keyword to search for |
matchOpt | search mode |
Definition at line 354 of file dictionarySearch.C.
Referenced by removeEntry::execute(), and entry::New().
Foam::dictionary::searcher searchScoped | ( | const word & | keyword, |
enum keyType::option | matchOpt | ||
) |
Search using dot or slash scoping.
keyword | the keyword to search for |
matchOpt | search mode |
Definition at line 364 of file dictionarySearch.C.
const Foam::dictionary * cfindScopedDict | ( | const fileName & | dictPath | ) | const |
Locate a sub-dictionary using slash-scoping.
Definition at line 376 of file dictionarySearch.C.
References fileName::clean(), fileName::components(), entry::dictPtr(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, entry::isDict(), Foam::nl, and path().
const Foam::dictionary * findScopedDict | ( | const fileName & | dictPath | ) | const |
Locate a sub-dictionary using slash-scoping.
Definition at line 463 of file dictionarySearch.C.
Foam::dictionary * findScopedDict | ( | const fileName & | dictPath | ) |
Locate a sub-dictionary using slash-scoping.
Definition at line 472 of file dictionarySearch.C.
Foam::dictionary * makeScopedDict | ( | const fileName & | dictPath | ) |
Locate existing or create sub-dictionary using slash-scoping.
Definition at line 482 of file dictionarySearch.C.
References dictionary::add(), fileName::clean(), entry::dictPtr(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, entry::isDict(), Foam::nl, path(), and Foam::stringOps::split().
Referenced by entry::New().
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.
keyword | the keyword to search for |
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,... |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 33 of file dictionaryCompat.C.
References dictionary::csearch(), dictionary::Searcher< Const >::good(), splitCell::master(), Foam::nl, dictionary::relativeName(), kkLOmega::validate(), and error::warnAboutAge().
Referenced by coordinateSystem::assign(), and functionObject::New().
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.
keyword | the keyword to search for |
compat | list of old compatibility keywords and the last OpenFOAM version for which they were used. |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 74 of file dictionaryCompat.C.
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.
keyword | the keyword to search for |
compat | list of old compatibility keywords and the last OpenFOAM version for which they were used. |
matchOpt | search mode |
Definition at line 85 of file dictionaryCompat.C.
References LList< LListBase, T >::link::ptr().
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.
keyword | the keyword to search for |
compat | list of old compatibility keywords and the last OpenFOAM version for which they were used. |
matchOpt | search mode |
Definition at line 96 of file dictionaryCompat.C.
References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::Searcher< Const >::good(), and dictionary::Searcher< Const >::ref().
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.
keyword | the keyword to search for |
compat | list of old compatibility keywords and the last OpenFOAM version for which they were used. |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 117 of file dictionaryCompat.C.
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.
keyword | the keyword to search for |
compat | list of old compatibility keywords and the last OpenFOAM version for which they were used. |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 133 of file dictionaryTemplates.C.
References T.
Referenced by faceZoneToCell::faceZoneToCell(), LESModel< BasicTurbulenceModel >::New(), boundaryRadiationPropertiesPatch::New(), motionSolver::New(), basicChemistryModel::New(), patchToCell::patchToCell(), patchToFace::patchToFace(), plane::plane(), zoneToCell::zoneToCell(), zoneToFace::zoneToFace(), and zoneToPoint::zoneToPoint().
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.
keyword | the keyword to search for |
compat | list of old compatibility keywords and the last OpenFOAM version for which they were used. |
deflt | the default value to use |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 431 of file dictionaryTemplates.C.
References dictionary::Searcher< Const >::good(), dictionary::Searcher< Const >::ptr(), and T.
Referenced by Foam::getSurfaceName().
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.
keyword | the keyword to search for |
compat | list of old compatibility keywords and the last OpenFOAM version for which they were used. |
val | the value to read |
matchOpt | search mode (default: non-recursive with patterns) |
mandatory | the keyword is mandatory (default: true) |
Definition at line 371 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().
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.
keyword | the keyword to search for |
compat | list of old compatibility keywords and the last OpenFOAM version for which they were used. |
val | the value to read |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 462 of file dictionaryTemplates.C.
Referenced by isoSurfaceParams::getAlgorithmType(), and solidProperties::readIfPresent().
void operator= | ( | const dictionary & | rhs | ) |
Copy assignment.
Definition at line 881 of file dictionary.C.
References Foam::add(), clear(), GeometricField< Type, PatchField, GeoMesh >::clone(), e, dictionary::name(), and Foam::name().
Referenced by dictionary::dictionary(), IOdictionary::IOdictionary(), localIOdictionary::localIOdictionary(), baseIOdictionary::operator=(), and unwatchedIOdictionary::unwatchedIOdictionary().
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(), GeometricField< Type, PatchField, GeoMesh >::clone(), e, Foam::FatalIOError, FatalIOErrorInFunction, and Foam::nl.
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(), GeometricField< Type, PatchField, GeoMesh >::clone(), e, Foam::FatalIOError, FatalIOErrorInFunction, found, and Foam::nl.
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(), GeometricField< Type, PatchField, GeoMesh >::clone(), e, Foam::FatalIOError, FatalIOErrorInFunction, and Foam::nl.
|
inline |
Find and return a T, or return the given default value. FatalIOError if it is found and the number of tokens is incorrect.
keyword | the keyword to search for |
deflt | the default value to use |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 1289 of file dictionary.H.
Referenced by mappedPatchBase::readDatabase().
|
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.
keyword | the keyword to search for |
deflt | the default value to use |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 1308 of file dictionary.H.
|
inline |
Find and return a T, or return the given default value using any compatibility names if needed.
keyword | the keyword to search for |
compat | list of old compatibility keywords and the last OpenFOAM version for which they were used. |
deflt | the default value to use |
matchOpt | search mode (default: non-recursive with patterns) |
Definition at line 1328 of file dictionary.H.
Deprecated(2018-07) find and return an entry data stream.
Definition at line 1343 of file dictionary.H.
Deprecated(2018-10)
Definition at line 1351 of file dictionary.H.
References found.
Deprecated(2018-10)
Definition at line 1364 of file dictionary.H.
References dictionary::findEntry().
|
inline |
Deprecated(2018-10)
Definition at line 1377 of file dictionary.H.
References dictionary::findEntry().
|
inline |
Deprecated(2018-10)
Definition at line 1390 of file dictionary.H.
References dictionary::findScoped().
|
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.
Definition at line 1407 of file dictionary.H.
References dictionary::findDict(), and keyType::REGEX.
|
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.
Definition at line 1419 of file dictionary.H.
References dictionary::findDict(), and keyType::REGEX.
Deprecated(2018-10)
Definition at line 1427 of file dictionary.H.
References dictionary::lookupEntry().
Deprecated(2018-10)
Definition at line 1440 of file dictionary.H.
|
inline |
Deprecated(2018-10)
Definition at line 1454 of file dictionary.H.
References dictionary::getOrDefault().
|
inline |
Deprecated(2018-10)
Definition at line 1469 of file dictionary.H.
References dictionary::getOrAdd().
|
inline |
Deprecated(2018-10)
Definition at line 1484 of file dictionary.H.
References dictionary::readIfPresent().
|
inline |
Deprecated(2018-10) find and return a T.
Definition at line 1504 of file dictionary.H.
|
inline |
Same as get< bool >(const word&, keyType::option)
Definition at line 1545 of file dictionary.H.
|
inline |
Same as get< label >(const word&, keyType::option)
Definition at line 1546 of file dictionary.H.
Referenced by propellerInfo::setSampleDiskSurface().
|
inline |
Same as get< scalar >(const word&, keyType::option)
Definition at line 1547 of file dictionary.H.
Referenced by propellerInfo::setSampleDiskSurface(), and WallSpringSliderDashpot< CloudType >::WallSpringSliderDashpot().
|
inline |
Same as get< string >(const word&, keyType::option)
Definition at line 1548 of file dictionary.H.
Referenced by solidReaction< ReactionThermo >::solidReaction(), and Reaction< ThermoType >::write().
|
inline |
Same as get< word >(const word&, keyType::option)
Definition at line 1549 of file dictionary.H.
Referenced by incompressibleInterPhaseTransportModel< Mixture >::incompressibleInterPhaseTransportModel().
|
inline |
Same as get< fileName >(const word&, keyType::option)
Definition at line 1550 of file dictionary.H.
Foam::wordList sortedToc | ( | const Compare & | comp | ) | const |
Definition at line 85 of file dictionaryTemplates.C.
Foam::entry * add | ( | const keyType & | k, |
const T & | v, | ||
bool | overwrite | ||
) |
Definition at line 92 of file dictionaryTemplates.C.
References Foam::add(), and k.
Foam::entry * set | ( | const keyType & | k, |
const T & | v | ||
) |
Definition at line 99 of file dictionaryTemplates.C.
References k.
|
friend |
Declare friendship with the entry class for IO.
Definition at line 279 of file dictionary.H.
|
friend |
Read dictionary from Istream.
|
friend |
Write dictionary to Ostream.
friend const_searcher |
Declare friendship with the searcher classes.
Definition at line 282 of file dictionary.H.
friend searcher |
Definition at line 283 of file dictionary.H.
|
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 391 of file dictionary.H.
Referenced by dictionary::reportOptional().
|
static |
An empty dictionary, which is also the parent for all dictionaries.
Definition at line 394 of file dictionary.H.
Referenced by Stokes< BasicTurbulenceModel >::coeffDict(), metisLikeDecomp::decompose(), primitiveEntry::dict(), writerCaching::fieldsDict(), RASModelVariables::New(), lduMatrix::preconditioner::New(), and meshRefinement::subDict().
|
static |
Output location when reporting default values.
Definition at line 397 of file dictionary.H.