All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
dictionary Class Reference

A list of keyword definitions, which are a keyword followed by any number of values (e.g. words and numbers). The keywords can represent patterns which are matched using Posix regular expressions. The general order for searching is as follows: More...

Inheritance diagram for dictionary:
Collaboration diagram for dictionary:

Classes

class  includedDictionary
 

Public Member Functions

 ClassName ("dictionary")
 
 dictionary ()
 Construct top-level dictionary null. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the entry name, parent dictionary and Istream,. More...
 
 dictionary (Istream &, const bool keepHeader=false)
 Construct top-level dictionary from Istream,. More...
 
template<class T , class ... KeysAndTs>
 dictionary (const keyType &k, const T &t, const KeysAndTs &... keysAndTs)
 Construct top-level dictionary with given T entries. More...
 
template<class T , class ... KeysAndTs>
 dictionary (const fileName &name, const keyType &k, const T &t, const KeysAndTs &... keysAndTs)
 Construct top-level dictionary with given name and T entries. More...
 
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary. More...
 
 dictionary (const dictionary &)
 Construct top-level dictionary as copy. More...
 
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, dictionary &&)
 Move constructor transferring parameter contents. More...
 
 dictionary (dictionary &&)
 Move constructor. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
bool isNull () const
 Return whether this dictionary is null. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
word topDictKeyword () const
 Return the scoped keyword with which this dictionary can be. 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 &, bool recursive=false, bool patternMatch=true) const
 Search dictionary for given keyword. More...
 
const entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntryPtrBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present, trying a list. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
const entrylookupEntryBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present, trying a list. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
ITstreamlookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream, trying a list of keywords. More...
 
template<class T >
T lookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
 Find and return a T, trying a list of keywords in sequence. More...
 
template<class T >
T lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrDefaultBackwardsCompatible (const wordList &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T, trying a list of keywords in sequence. More...
 
template<class T >
T lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
 Find and return a T, if not found return the given. More...
 
template<class T >
bool readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T. More...
 
const entrylookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present,. More...
 
template<class T >
T lookupScoped (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
bool isDict (const word &) const
 Check if entry is a sub-dictionary. More...
 
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
dictionarysubDictPtr (const word &)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
const dictionarysubDictBackwardsCompatible (const wordList &) const
 Find and return a sub-dictionary, trying a list of keywords in. More...
 
dictionary subOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary as a copy, or. More...
 
const dictionaryoptionalSubDict (const word &) const
 Find and return a sub-dictionary if found. More...
 
const dictionaryscopedDict (const word &) const
 Find and return a sub-dictionary by scoped lookup. More...
 
dictionaryscopedDict (const word &)
 Find and return a sub-dictionary by scoped lookup. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the. More...
 
bool substituteScopedKeyword (const word &keyword)
 Substitute the given scoped keyword prepended by '$' with the. More...
 
bool add (entry *, bool mergeEntry=false)
 Add a new entry. More...
 
void add (const entry &, bool mergeEntry=false)
 Add an entry. More...
 
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry. More...
 
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry. More...
 
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry. More...
 
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry. More...
 
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry. More...
 
void set (entry *)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const entry &)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry. More...
 
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry. More...
 
template<class T , class ... KeysAndTs>
void set (const keyType &, const T &, const KeysAndTs &...)
 Assign multiple T entries, overwriting any existing entries. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument. More...
 
bool read (Istream &, const bool keepHeader=false)
 Read dictionary from Istream, optionally keeping the header. More...
 
virtual bool global () const
 Return true if the dictionary global,. More...
 
void write (Ostream &, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
ITstreamoperator[] (const word &) const
 Find and return entry. More...
 
void operator= (const dictionary &)
 
void operator= (dictionary &&)
 
void operator+= (const dictionary &)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &)
 Unconditionally include entries from the given dictionary. More...
 
template<class T , class ... KeysAndTs>
void set (const keyType &k, const T &t, const KeysAndTs &... keysAndTs)
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. More...
 
 dictionaryName (dictionaryName &&name)
 Move constructor. More...
 
const fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 Return the dictionary name. More...
 
const word dictName () const
 Return the local dictionary name (final part of scoped name) More...
 
void operator= (const dictionaryName &name)
 
void operator= (dictionaryName &&name)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()
 Null construct. More...
 
 ILList (T *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &)
 Copy constructor. More...
 
 ILList (ILList< LListBase, T > &&)
 Move constructor. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
template<class INew >
 ILList (Istream &, const 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 *p)
 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 > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (ILList< LListBase, T > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()
 Null construct. More...
 
 UILList (T *a)
 Construct given initial T. More...
 
 UILList (const UILList< LListBase, T > &)
 Copy constructor. More...
 
 UILList (UILList< LListBase, T > &&)
 Move constructor. More...
 
Tfirst ()
 Return the first entry. More...
 
const Tfirst () const
 Return the first entry. More...
 
Tlast ()
 Return the last entry. More...
 
const Tlast () const
 Return the last entry. More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *p)
 Remove and return element. More...
 
Tremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (UILList< LListBase, T > &&)
 Move assignment operator. More...
 
iterator begin ()
 
const iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
bool operator== (const UILList< LListBase, T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< LListBase, T > &) const
 The opposite of the equality operation. Takes linear time. More...
 

Static Public Member Functions

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

Static Public Attributes

static const dictionary null
 Null dictionary. More...
 
static bool writeOptionalEntries
 If true write optional keywords and values. More...
 

Friends

class entry
 Declare friendship with the entry class for IO. More...
 
Istreamoperator>> (Istream &, dictionary &)
 Read dictionary from Istream. More...
 
Ostreamoperator<< (Ostream &, const dictionary &)
 Write dictionary to Ostream. More...
 

Additional Inherited Members

- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values the DLList contains. More...
 
typedef Treference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a DLList. More...
 
typedef LListBase::iterator LListBase_iterator
 
typedef LListBase::const_iterator LListBase_const_iterator
 

Detailed Description

A list of keyword definitions, which are a keyword followed by any number of values (e.g. words and numbers). The keywords can represent patterns which are matched using Posix regular expressions. The general order for searching is as follows:

- exact match

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

The dictionary class is the base class for IOdictionary. It also serves as a bootstrap dictionary for the objectRegistry data dictionaries since, unlike the IOdictionary class, it does not use an objectRegistry itself to work.

To add - a merge() member function with a non-const dictionary parameter? This would avoid unnecessary cloning in the add(entry*, bool) method.

Source files

Definition at line 156 of file dictionary.H.

Constructor & Destructor Documentation

◆ dictionary() [1/11]

Construct top-level dictionary null.

Definition at line 436 of file dictionary.C.

Referenced by dictionary::New(), and Foam::readConfigFile().

Here is the caller graph for this function:

◆ dictionary() [2/11]

dictionary ( const fileName name)

Construct top-level empty dictionary with given name.

Definition at line 442 of file dictionary.C.

◆ dictionary() [3/11]

dictionary ( const fileName name,
const dictionary parentDict,
Istream is 
)

Construct given the entry name, parent dictionary and Istream,.

reading entries until lastEntry or EOF

Definition at line 38 of file dictionaryIO.C.

References dictionary::read().

Here is the call graph for this function:

◆ dictionary() [4/11]

dictionary ( Istream is,
const bool  keepHeader = false 
)

Construct top-level dictionary from Istream,.

reading entries until EOF, optionally keeping the header

Definition at line 57 of file dictionaryIO.C.

References calcIncludeEntry::clear(), inputModeEntry::clear(), inputSyntaxEntry::clear(), and dictionary::read().

Here is the call graph for this function:

◆ dictionary() [5/11]

dictionary ( const keyType k,
const T t,
const KeysAndTs &...  keysAndTs 
)

Construct top-level dictionary with given T entries.

Definition at line 32 of file dictionaryTemplates.C.

References k, and dictionary::set().

Here is the call graph for this function:

◆ dictionary() [6/11]

dictionary ( const fileName name,
const keyType k,
const T t,
const KeysAndTs &...  keysAndTs 
)

Construct top-level dictionary with given name and T entries.

Definition at line 46 of file dictionaryTemplates.C.

References k, and dictionary::set().

Here is the call graph for this function:

◆ dictionary() [7/11]

dictionary ( const dictionary parentDict,
const dictionary dict 
)

Construct as copy given the parent dictionary.

Definition at line 449 of file dictionary.C.

References forAllIter.

◆ dictionary() [8/11]

dictionary ( const dictionary dict)

Construct top-level dictionary as copy.

Definition at line 475 of file dictionary.C.

References forAllIter.

◆ dictionary() [9/11]

dictionary ( const dictionary dictPtr)

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

A null pointer is treated like an empty dictionary.

Definition at line 514 of file dictionary.C.

References dictionary::operator=().

Here is the call graph for this function:

◆ dictionary() [10/11]

dictionary ( const dictionary parentDict,
dictionary &&  dict 
)

Move constructor transferring parameter contents.

given parent dictionary

Definition at line 528 of file dictionary.C.

References dictionaryName::name(), and fileName::null.

Here is the call graph for this function:

◆ dictionary() [11/11]

dictionary ( dictionary &&  dict)

Move constructor.

Definition at line 500 of file dictionary.C.

◆ ~dictionary()

~dictionary ( )
virtual

Destructor.

Definition at line 556 of file dictionary.C.

Member Function Documentation

◆ ClassName()

ClassName ( "dictionary"  )

◆ clone()

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

Construct and return clone.

Definition at line 548 of file dictionary.C.

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

Here is the caller graph for this function:

◆ New()

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

Construct top-level dictionary on freestore from Istream.

Definition at line 104 of file dictionaryIO.C.

References dictionary::dictionary().

Referenced by kineticTheoryModel::correct(), IATE::correct(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::correct(), kOmegaSST< MomentumTransportModel, BasicMomentumTransportModel >::correct(), lambdaThixotropic< BasicMomentumTransportModel >::correct(), Maxwell< BasicMomentumTransportModel >::correct(), DeardorffDiffStress< BasicMomentumTransportModel >::correct(), dynamicKEqn< BasicMomentumTransportModel >::correct(), dynamicLagrangian< BasicMomentumTransportModel >::correct(), kEqn< BasicMomentumTransportModel >::correct(), SpalartAllmarasDES< BasicMomentumTransportModel >::correct(), kEpsilon< BasicMomentumTransportModel >::correct(), kOmega< BasicMomentumTransportModel >::correct(), kOmega2006< BasicMomentumTransportModel >::correct(), LaunderSharmaKE< BasicMomentumTransportModel >::correct(), LRR< BasicMomentumTransportModel >::correct(), realizableKE< BasicMomentumTransportModel >::correct(), RNGkEpsilon< BasicMomentumTransportModel >::correct(), SpalartAllmaras< BasicMomentumTransportModel >::correct(), SSG< BasicMomentumTransportModel >::correct(), v2f< BasicMomentumTransportModel >::correct(), mixtureKEpsilon< BasicMomentumTransportModel >::correct(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::correctNut(), DeardorffDiffStress< BasicMomentumTransportModel >::correctNut(), kEqn< BasicMomentumTransportModel >::correctNut(), Smagorinsky< BasicMomentumTransportModel >::correctNut(), WALE< BasicMomentumTransportModel >::correctNut(), kEpsilon< BasicMomentumTransportModel >::correctNut(), kOmega< BasicMomentumTransportModel >::correctNut(), LaunderSharmaKE< BasicMomentumTransportModel >::correctNut(), LRR< BasicMomentumTransportModel >::correctNut(), RNGkEpsilon< BasicMomentumTransportModel >::correctNut(), SSG< BasicMomentumTransportModel >::correctNut(), v2f< BasicMomentumTransportModel >::correctNut(), NicenoKEqn< BasicMomentumTransportModel >::correctNut(), SmagorinskyZhang< BasicMomentumTransportModel >::correctNut(), continuousGasKEpsilon< BasicMomentumTransportModel >::correctNut(), LaheyKEpsilon< BasicMomentumTransportModel >::correctNut(), mixtureKEpsilon< BasicMomentumTransportModel >::correctNut(), dynamicLagrangian< BasicMomentumTransportModel >::correctNut(), SpalartAllmarasDES< BasicMomentumTransportModel >::correctNut(), SpalartAllmaras< BasicMomentumTransportModel >::correctNut(), kOmegaSST< MomentumTransportModel, BasicMomentumTransportModel >::correctNut(), kOmegaSSTSato< BasicMomentumTransportModel >::correctNut(), dynamicKEqn< BasicMomentumTransportModel >::correctNut(), realizableKE< BasicMomentumTransportModel >::correctNut(), kOmegaSSTLM< BasicMomentumTransportModel >::correctReThetatGammaInt(), age::execute(), phaseScalarTransport::execute(), scalarTransport::execute(), VoFFilmTransfer::filmVoFTransferRate(), solver::fvConstraints(), phaseSystem::fvConstraints(), solver::fvModels(), phaseSystem::fvModels(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficients(), and filmVoFTransfer::VoFToFilmTransferRate().

Here is the call graph for this function:

◆ parent()

const dictionary& parent ( ) const
inline

Return the parent dictionary.

Definition at line 320 of file dictionary.H.

Referenced by dictionary::write().

Here is the caller graph for this function:

◆ isNull()

bool isNull ( ) const
inline

Return whether this dictionary is null.

Definition at line 326 of file dictionary.H.

Referenced by ParticleForce< CloudType >::ParticleForce().

Here is the caller graph for this function:

◆ topDict()

const Foam::dictionary & topDict ( ) const

Return the top of the tree.

Definition at line 564 of file dictionary.C.

References IOobject::name(), and p.

Here is the call graph for this function:

◆ topDictKeyword()

Foam::word topDictKeyword ( ) const

Return the scoped keyword with which this dictionary can be.

accessed from the top dictionary in the tree

Definition at line 579 of file dictionary.C.

References IOobject::name(), word::null, p, and inputSyntaxEntry::scopeChar().

Here is the call graph for this function:

◆ startLineNumber()

Foam::label startLineNumber ( ) const

Return line number of first token in dictionary.

Definition at line 599 of file dictionary.C.

References Foam::first().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ endLineNumber()

Foam::label endLineNumber ( ) const

Return line number of last token in dictionary.

Definition at line 612 of file dictionary.C.

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

Here is the caller graph for this function:

◆ digest()

Foam::SHA1Digest digest ( ) const

Return the SHA1 digest of the dictionary contents.

Definition at line 625 of file dictionary.C.

References OSHA1stream::digest(), and forAllConstIter.

Referenced by functionObjectList::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ tokens()

Foam::tokenList tokens ( ) const

Return the dictionary as a list of tokens.

Definition at line 639 of file dictionary.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), ISstream::read(), OStringStream::str(), and Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ found()

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

Search dictionary for given keyword.

If recursive, search parent dictionaries If patternMatch, use regular expressions

Definition at line 658 of file dictionary.C.

References dictionary::null.

Referenced by sixDoFRigidBodyMotion::addConstraints(), Foam::AddPatchFields(), sixDoFRigidBodyMotion::addRestraints(), anisotropic::anisotropic(), BlendedInterfacialModel< ModelType >::BlendedInterfacialModel(), BreakupModel< CloudType >::BreakupModel(), constTransport< Thermo >::constTransport(), DAC< ThermoType >::DAC(), decompositionMethod::decompositionMethod(), Foam::dimensionedConstant(), DRGEP< ThermoType >::DRGEP(), EFA< ThermoType >::EFA(), includeEntry::execute(), includeEtcEntry::execute(), functions::functions(), fvConstraints::fvConstraints(), fvModels::fvModels(), subModelBase::getBaseProperty(), subModelBase::getModelProperty(), greyMean::greyMean(), volFieldValue::initialise(), interfaceTurbulenceDamping::interfaceTurbulenceDamping(), phaseSystem::interfacialDict(), ISAT::ISAT(), layerParameters::layerParameters(), Foam::listSwitches(), LocalInteraction< CloudType >::LocalInteraction(), basicThermo::lookupCstrIter(), laminarModel< BasicMomentumTransportModel >::New(), liquidProperties::New(), solidProperties::New(), sootModel::New(), setWriter::New(), fvMeshDistributor::New(), fvMeshMover::New(), fvMeshTopoChanger::New(), dlLibraryTable::open(), axesRotation::operator=(), parcelThermo::parcelThermo(), phaseSystem::phaseSystem(), Foam::preservePatchTypes(), processorFvPatchField< Type >::processorFvPatchField(), functionObjectList::read(), tolerances::read(), MaxwellStefan< BasicThermophysicalTransportModel >::read(), timeControl::read(), polyCellSet::read(), BirdCarreau::read(), CrossPowerLaw::read(), forcing::readCoeffs(), Foam::readConfigFile(), Time::readDict(), liquidProperties::readIfPresent(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), scalarTransport::scalarTransport(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setCdAv(), Time::setControls(), subModelBase::setModelProperty(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficient(), incompressibleFluid::setRDeltaT(), Time::setTime(), sixDoFRigidBodyMotion::sixDoFRigidBodyMotion(), mappedInternalPatchBase::specified(), mappedPatchBase::specified(), ensightSurfaceWriter::surfaceWriter(), Time::Time(), VoFTurbulenceDamping::VoFTurbulenceDamping(), and wideBand::wideBand().

◆ lookupEntryPtr() [1/2]

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

Find and return an entry data stream pointer if present.

otherwise return nullptr. If recursive, search parent dictionaries. If patternMatch, use regular expressions

Definition at line 697 of file dictionary.C.

References dictionary::null.

Referenced by dynamicCodeContext::dynamicCodeContext(), entry::New(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), dictionary::substituteKeyword(), and solution::upgradeSolverDict().

Here is the caller graph for this function:

◆ lookupEntryPtr() [2/2]

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

Find and return an entry data stream pointer for manipulation.

if present otherwise return nullptr. If recursive, search parent dictionaries. If patternMatch, use regular expressions.

Definition at line 736 of file dictionary.C.

References dictionary::null.

◆ lookupEntryPtrBackwardsCompatible()

const Foam::entry * lookupEntryPtrBackwardsCompatible ( const wordList keywords,
bool  recursive,
bool  patternMatch 
) const

Find and return an entry data stream if present, trying a list.

of keywords in sequence, otherwise return nullptr. If recursive, search parent dictionaries. If patternMatch, use regular expressions

Definition at line 780 of file dictionary.C.

References Foam::endl(), forAll, IOWarningInFunction, entry::keyword(), and Foam::name().

Here is the call graph for this function:

◆ lookupEntry()

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

Find and return an entry data stream if present otherwise error.

If recursive, search parent dictionaries. If patternMatch, use regular expressions.

Definition at line 816 of file dictionary.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::name().

Referenced by lduMatrix::smoother::getName(), lduMatrix::preconditioner::getName(), Foam::listSwitches(), lduMatrix::preconditioner::New(), and lduMatrix::smoother::New().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ lookupEntryBackwardsCompatible()

const Foam::entry & lookupEntryBackwardsCompatible ( const wordList keywords,
bool  recursive,
bool  patternMatch 
) const

Find and return an entry data stream if present, trying a list.

of keywords in sequence, otherwise error. If recursive, search parent dictionaries. If patternMatch, use regular expressions

Definition at line 837 of file dictionary.C.

◆ lookup() [1/2]

Foam::ITstream & lookup ( const word keyword,
bool  recursive = false,
bool  patternMatch = true 
) const

Find and return an entry data stream.

If recursive, search parent dictionaries. If patternMatch, use regular expressions.

Definition at line 859 of file dictionary.C.

Referenced by fractal::addDrift(), BlendedInterfacialModel< ModelType >::BlendedInterfacialModel(), BreakupModel< CloudType >::BreakupModel(), motionSmootherAlgo::checkMesh(), CloudFilmTransfer< CloudType >::CloudFilmTransfer(), compressibleInterPhaseTransportModel::compressibleInterPhaseTransportModel(), constTransport< Thermo >::constTransport(), forces::createFileNames(), DAC< ThermoType >::DAC(), forces::devTau(), Foam::dimensionedConstant(), directions::directions(), argList::displayDoc(), DRG< ThermoType >::DRG(), DRGEP< ThermoType >::DRGEP(), ETAB< CloudType >::ETAB(), exponentialSolidTransport< Thermo >::exponentialSolidTransport(), fractal::fractal(), FreeStream< CloudType >::FreeStream(), functions::functions(), fvConstraints::fvConstraints(), fvModels::fvModels(), greyMean::greyMean(), incompressibleInterPhaseTransportModel::incompressibleInterPhaseTransportModel(), volFieldValue::initialise(), phaseSystem::interfacialDict(), ISAT::ISAT(), layerParameters::layerParameters(), Foam::MULES::limiterCorr(), LocalInteraction< CloudType >::LocalInteraction(), basicThermo::lookupCstrIter(), mixtureName(), medialAxisMeshMover::move(), forces::mu(), multivariateSelectionScheme< Type >::multivariateSelectionScheme(), barotropicCompressibilityModel::New(), profileModel::New(), CorrectionLimitingMethod::New(), ParticleStressModel::New(), TimeScaleModel::New(), liquidProperties::New(), solidProperties::New(), contactAngleModel::New(), DampingModel< CloudType >::New(), IsotropyModel< CloudType >::New(), PackingModel< CloudType >::New(), absorptionEmissionModel::New(), sootModel::New(), surfaceTensionModel::New(), patchDistMethod::New(), relativeVelocityModel::New(), diffusiveMassTransferModel::New(), phaseTransferModel::New(), interfaceCompositionModel::New(), interfaceSurfaceTensionModel::New(), liftModel::New(), turbulentDispersionModel::New(), wallLubricationModel::New(), dragModel::New(), heatTransferModel::New(), virtualMassModel::New(), coordinateRotation::New(), interpolation< Type >::New(), PDRDragModel::New(), renumberMethod::New(), solidBodyMotionFunction::New(), generalisedNewtonianViscosityModel::New(), XiEqModel::New(), XiGModel::New(), XiModel::New(), phaseSystem::New(), mixtureViscosityModel::New(), chemistryReductionMethod< ThermoType >::New(), chemistryTabulationMethod::New(), AveragingMethod< Type >::New(), coordinateSystem::New(), phaseModel::New(), laminarFlameSpeed::New(), LduMatrix< Type, DType, LUType >::preconditioner::New(), Reaction< ThermoType >::New(), momentumTransportModel::New(), radiationModel::New(), lduMatrix::solver::New(), LduMatrix< Type, DType, LUType >::smoother::New(), LduMatrix< Type, DType, LUType >::solver::New(), Function1< Type >::New(), Function2< Type >::New(), saturationPressureModel::New(), saturationTemperatureModel::New(), polyPatch::New(), energyScalingFunction::New(), pairPotential::New(), sixDoFRigidBodyMotionConstraint::New(), sixDoFRigidBodyMotionRestraint::New(), tetherPotential::New(), fvConstraint::New(), fvModel::New(), porosityModel::New(), LESdelta::New(), fieldValue::New(), motionSolver::New(), sampledSurface::New(), sampledSet::New(), functionObject::New(), parcelCloud::New(), setWriter::New(), entry::New(), fvMeshDistributor::New(), fvMeshMover::New(), decomposedBlockData::numBlocks(), dlLibraryTable::open(), multivariateIndependentScheme< Type >::operator()(), axesRotation::operator=(), argList::parse(), patchInternalField::patchInternalField(), PFA< ThermoType >::PFA(), PilchErdman< CloudType >::PilchErdman(), plane::plane(), porosityModel::porosityModel(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), cloudSolution::read(), forces::read(), smoothDelta::read(), anisotropicFilter::read(), laplaceFilter::read(), timeControl::read(), patchProbes::read(), probes::read(), egrMixture< ThermoType >::read(), inhomogeneousMixture< ThermoType >::read(), consumptionSpeed::read(), porosityModel::read(), targetCoeffTrim::read(), polyCellSet::read(), cavitationModel::read(), fieldAverage::read(), reactionRateFlameArea::read(), doubleSigmoid::read(), sigmoid::read(), azizChen::read(), dampedCoulomb::read(), exponentialRepulsion::read(), lennardJones::read(), maitlandSmith::read(), PDRDragModel::read(), harmonicSpring::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), forcing::readCoeffs(), solidDisplacement::readControls(), singleRegionCorrectorConvergenceControl::readCorrResidualControls(), Time::readDict(), DimensionedField< Type, GeoMesh >::readField(), IOobject::readHeader(), constSolidThermo::readProperty(), singleRegionConvergenceControl::readResidualControls(), ensightPart::reconstruct(), refinementSurfaces::refinementSurfaces(), ReitzDiwakar< CloudType >::ReitzDiwakar(), ReitzKHRT< CloudType >::ReitzKHRT(), boundaryRegion::rename(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), motionSmootherAlgo::scaleMesh(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setCdAv(), Time::setControls(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficient(), incompressibleFluid::setRDeltaT(), Time::setTime(), SingleMixtureFraction< CloudType >::SingleMixtureFraction(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), surfaceFeatures::surfaceFeatures(), ensightSurfaceWriter::surfaceWriter(), surfaceZonesInfo::surfaceZonesInfo(), UniformDimensionedField< Type >::UniformDimensionedField(), WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), waveSuperposition::waveSuperposition(), and wideBand::wideBand().

◆ lookupBackwardsCompatible() [1/2]

Foam::ITstream & lookupBackwardsCompatible ( const wordList keywords,
bool  recursive = false,
bool  patternMatch = true 
) const

Find and return an entry data stream, trying a list of keywords.

in sequence if not found throw a fatal error relating to the first keyword If recursive, search parent dictionaries. If patternMatch, use regular expressions.

Definition at line 870 of file dictionary.C.

Referenced by laminarModel< BasicMomentumTransportModel >::New(), LESModel< BasicMomentumTransportModel >::New(), RASModel< BasicMomentumTransportModel >::New(), basicChemistryModel::New(), viscosityModel::New(), decompositionMethod::NewDecomposer(), decompositionMethod::NewDistributor(), plane::plane(), and polyCellSet::read().

Here is the caller graph for this function:

◆ lookup() [2/2]

T lookup ( const word keyword,
bool  recursive = false,
bool  patternMatch = true 
) const

Find and return a T,.

if not found throw a fatal error. If recursive, search parent dictionaries. If patternMatch, use regular expressions.

Definition at line 64 of file dictionaryTemplates.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::name(), and entry::stream().

Here is the call graph for this function:

◆ lookupBackwardsCompatible() [2/2]

T lookupBackwardsCompatible ( const wordList keywords,
bool  recursive = false,
bool  patternMatch = true 
) const

Find and return a T, trying a list of keywords in sequence.

if not found throw a fatal error relating to the first keyword If recursive, search parent dictionaries. If patternMatch, use regular expressions.

Definition at line 88 of file dictionaryTemplates.C.

References entry::stream().

Here is the call graph for this function:

◆ lookupOrDefault()

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

Find and return a T,.

if not found return the given default value. If recursive, search parent dictionaries. If patternMatch, use regular expressions.

Definition at line 111 of file dictionaryTemplates.C.

References Foam::endl(), IOInfoInFunction, and entry::stream().

Referenced by CloudFilmTransfer< CloudType >::CloudFilmTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrs(), fieldAverageItem::fieldAverageItem(), fixedMeanOutletInletFvPatchField< Type >::fixedMeanOutletInletFvPatchField(), freestreamFvPatchField< Type >::freestreamFvPatchField(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), LocalInteraction< CloudType >::LocalInteraction(), meshRefinement::meshRefinement(), basicChemistryModel::New(), argList::parse(), pimpleLoop::read(), pimpleMultiRegionControl::read(), pimpleNoLoopControl::read(), pisoControl::read(), fluidSolutionControl::read(), nonOrthogonalSolutionControl::read(), functionObjectList::read(), functionObject::read(), timeControl::read(), targetCoeffTrim::read(), fluidSolver::readControls(), isothermalFilm::readControls(), multiphaseEuler::readControls(), solid::readControls(), solidDisplacement::readControls(), distributor::readDict(), temperatureDependent::readDict(), IOobject::readHeader(), refinementSurfaces::refinementSurfaces(), scalarTransport::scalarTransport(), multiphaseVoFSolver::setInterfaceRDeltaT(), twoPhaseVoFSolver::setInterfaceRDeltaT(), incompressibleFluid::setRDeltaT(), slidingInterface::setTolerances(), fvMatrix< Type >::solve(), Foam::unitSet(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), and turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ lookupOrDefaultBackwardsCompatible()

T lookupOrDefaultBackwardsCompatible ( const wordList keywords,
const T deflt,
bool  recursive = false,
bool  patternMatch = true 
) const

Find and return a T, trying a list of keywords in sequence.

if not found throw a fatal error relating to the first keyword If recursive, search parent dictionaries. If patternMatch, use regular expressions.

Definition at line 141 of file dictionaryTemplates.C.

References entry::stream().

Referenced by pimpleNoLoopControl::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ lookupOrAddDefault()

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

Find and return a T, if not found return the given.

default value, and add to dictionary. If recursive, search parent dictionaries. If patternMatch, use regular expressions.

Definition at line 165 of file dictionaryTemplates.C.

References Foam::add(), Foam::endl(), IOInfoInFunction, and entry::stream().

Referenced by Foam::debug::debugSwitch(), Foam::debug::floatOptimisationSwitch(), Foam::debug::infoSwitch(), Switch::lookupOrAddToDict(), Foam::debug::optimisationSwitch(), and Foam::debug::wordOptimisationSwitch().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readIfPresent()

◆ lookupScopedEntryPtr()

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

Find and return an entry data stream pointer if present,.

otherwise return nullptr. If recursive, search parent dictionaries. If patternMatch, use regular expressions. Allows scoping using '/' with special handling for '!' and '..'.

Definition at line 886 of file dictionary.C.

References inputSyntaxEntry::dot(), dictionary::null, and inputSyntaxEntry::slash().

Referenced by Foam::getVariable(), and entry::New().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ lookupScoped()

T lookupScoped ( const word keyword,
bool  recursive = false,
bool  patternMatch = true 
) const

Find and return a T,.

if not found throw a fatal error. If recursive, search parent dictionaries. If patternMatch, use regular expressions. Allows scoping using '/' with special handling for '!' and '..'.

Definition at line 227 of file dictionaryTemplates.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::name(), and entry::stream().

Here is the call graph for this function:

◆ isDict()

bool isDict ( const word keyword) const

◆ subDictPtr() [1/2]

const Foam::dictionary * subDictPtr ( const word keyword) const

Find and return a sub-dictionary pointer if present.

otherwise return nullptr.

Definition at line 968 of file dictionary.C.

References entry::dict().

Referenced by namedBlock::namedBlock(), namedVertex::namedVertex(), blockVertex::read(), blockDescriptor::write(), and blockVertex::write().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ subDictPtr() [2/2]

Foam::dictionary * subDictPtr ( const word keyword)

Find and return a sub-dictionary pointer if present.

otherwise return nullptr.

Definition at line 983 of file dictionary.C.

References entry::dict().

Here is the call graph for this function:

◆ subDict() [1/2]

const Foam::dictionary & subDict ( const word keyword) const

Find and return a sub-dictionary.

Definition at line 998 of file dictionary.C.

References entry::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::name().

Referenced by sixDoFRigidBodyMotion::addConstraints(), snappyLayerDriver::addLayers(), Foam::AddPatchFields(), sixDoFRigidBodyMotion::addRestraints(), anisotropic::anisotropic(), patchFluxToFace::applyToSet(), BlendedInterfacialModel< ModelType >::BlendedInterfacialModel(), BreakupModel< CloudType >::BreakupModel(), CloudFunctionObjectList< CloudType >::CloudFunctionObjectList(), decompositionMethod::decompositionMethod(), multiRegionSolutionControl::dict(), singleRegionSolutionControl::dict(), fvMeshDistributor::dict(), fvMeshMover::dict(), Foam::dimensionedConstant(), argList::displayDoc(), fvMeshDistribute::distribute(), Fickian< unityLewisFourier< laminarThermophysicalTransportModel > >::distribute(), includeEntry::execute(), includeEtcEntry::execute(), subModelBase::getBaseProperty(), subModelBase::getModelProperty(), cloudSolution::integrationSchemes(), phaseSystem::interfacialDict(), cloudSolution::interpolationSchemes(), ISAT::ISAT(), layerParameters::layerParameters(), LocalInteraction< CloudType >::LocalInteraction(), basicThermo::lookupCstrIter(), laminarModel< BasicMomentumTransportModel >::New(), LESModel< BasicMomentumTransportModel >::New(), RASModel< BasicMomentumTransportModel >::New(), basicChemistryModel::New(), phaseModel::New(), saturationPressureModel::New(), saturationTemperatureModel::New(), fvMeshDistributor::New(), fvMeshMover::New(), fvMeshTopoChanger::New(), parcelThermo::parcelThermo(), phaseModel::phaseModel(), Foam::preservePatchTypes(), tolerances::read(), MaxwellStefan< BasicThermophysicalTransportModel >::read(), pureMixture< ThermoType >::read(), egrMixture< ThermoType >::read(), homogeneousMixture< ThermoType >::read(), inhomogeneousMixture< ThermoType >::read(), singleComponentMixture< ThermoType >::read(), veryInhomogeneousMixture< ThermoType >::read(), MRFZoneList::read(), porosityModelList::read(), doubleSigmoid::read(), sigmoid::read(), dampedCoulomb::read(), lennardJones::read(), harmonicSpring::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), Foam::readConfigFile(), massSourceBase::readFieldValues(), liquidProperties::readIfPresent(), constSolidThermo::readProperty(), refinementSurfaces::refinementSurfaces(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), subModelBase::setBaseProperty(), subModelBase::setModelProperty(), displacementLayeredMotionMotionSolver::solve(), cloudSolution::sourceTermDict(), wideBand::wideBand(), and dictionary::write().

Here is the call graph for this function:

◆ subDict() [2/2]

Foam::dictionary & subDict ( const word keyword)

Find and return a sub-dictionary for manipulation.

Definition at line 1013 of file dictionary.C.

References entry::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::name().

Here is the call graph for this function:

◆ subDictBackwardsCompatible()

const Foam::dictionary & subDictBackwardsCompatible ( const wordList keywords) const

Find and return a sub-dictionary, trying a list of keywords in.

sequence, otherwise error.

Definition at line 1028 of file dictionary.C.

References entry::dict().

Here is the call graph for this function:

◆ subOrEmptyDict()

Foam::dictionary subOrEmptyDict ( const word keyword,
const bool  mustRead = false 
) const

Find and return a sub-dictionary as a copy, or.

return an empty dictionary if the sub-dictionary does not exist

Definition at line 1048 of file dictionary.C.

References entry::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::name().

Here is the call graph for this function:

◆ optionalSubDict()

◆ scopedDict() [1/2]

const Foam::dictionary & scopedDict ( const word keyword) const

Find and return a sub-dictionary by scoped lookup.

i.e. the keyword may contain scope characters. If the keyword is null this dictionary is returned

Definition at line 1093 of file dictionary.C.

References entry::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, entry::isDict(), and Foam::name().

Referenced by Foam::readConfigFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ scopedDict() [2/2]

Foam::dictionary & scopedDict ( const word keyword)

Find and return a sub-dictionary by scoped lookup.

i.e. the keyword may contain scope characters. If the keyword is null this dictionary is returned

Definition at line 1122 of file dictionary.C.

◆ toc()

◆ sortedToc()

Foam::wordList sortedToc ( ) const

Return the sorted table of contents.

Definition at line 1145 of file dictionary.C.

◆ keys()

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

Return the list of available keys or patterns.

Definition at line 1151 of file dictionary.C.

References forAllConstIter, and List< T >::setSize().

Here is the call graph for this function:

◆ substituteKeyword()

bool substituteKeyword ( const word keyword)

Substitute the given keyword prepended by '$' with the.

corresponding sub-dictionary entries

Definition at line 163 of file dictionaryIO.C.

References dictionary::add(), entry::dict(), forAllConstIter, and dictionary::lookupEntryPtr().

Here is the call graph for this function:

◆ substituteScopedKeyword()

bool substituteScopedKeyword ( const word keyword)

Substitute the given scoped keyword prepended by '$' with the.

corresponding sub-dictionary entries

Definition at line 928 of file dictionary.C.

References Foam::add(), entry::dict(), and forAllConstIter.

Referenced by entry::New().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ add() [1/8]

bool add ( entry entryPtr,
bool  mergeEntry = false 
)

Add a new entry.

With the merge option, dictionaries are interwoven and primitive entries are overwritten

Definition at line 1169 of file dictionary.C.

References entry::dict(), entry::disableFunctionEntries, Foam::endl(), IOWarningInFunction, entry::isDict(), keyType::isPattern(), entry::keyword(), entry::name(), Foam::name(), and UILList< LListBase, T >::remove().

Referenced by error::abort(), IOerror::abort(), snappyLayerDriver::addLayers(), calcIncludeEntry::codeInclude(), Foam::dimensionedConstant(), includeEntry::execute(), includeEtcEntry::execute(), error::exit(), IOerror::exit(), phaseSystem::interfacialDict(), namedBlock::namedBlock(), namedVertex::namedVertex(), basicChemistryModel::New(), entry::New(), cellTable::operator=(), argList::parse(), Foam::preservePatchTypes(), Foam::readConfigFile(), subModelBase::setBaseProperty(), subModelBase::setModelProperty(), rigidBodyMeshMotion::solve(), rigidBodyMeshMotionSolver::solve(), sixDoFRigidBodyMotionSolver::solve(), dictionary::substituteKeyword(), solution::upgradeSolverDict(), polynomialSolidTransport< Thermo, PolySize >::write(), adiabaticPerfectFluid< Specie >::write(), Boussinesq< Specie >::write(), icoPolynomial< Specie, PolySize >::write(), icoTabulated< Specie >::write(), incompressiblePerfectGas< Specie >::write(), linear< Type >::write(), perfectFluid< Specie >::write(), rhoConst< Specie >::write(), rhoTabulated< Specie >::write(), rPolynomial< Specie >::write(), specie::write(), eConstThermo< EquationOfState >::write(), eIcoTabulatedThermo< EquationOfState >::write(), ePolynomialThermo< EquationOfState, PolySize >::write(), eTabulatedThermo< EquationOfState >::write(), hConstThermo< EquationOfState >::write(), hIcoTabulatedThermo< EquationOfState >::write(), hPolynomialThermo< EquationOfState, PolySize >::write(), hTabulatedThermo< EquationOfState >::write(), janafThermo< EquationOfState >::write(), AndradeTransport< Thermo >::write(), icoTabulatedTransport< Thermo >::write(), logPolynomialTransport< Thermo, PolySize >::write(), polynomialTransport< Thermo, PolySize >::write(), sutherlandTransport< Thermo >::write(), tabulatedTransport< Thermo >::write(), WLFTransport< Thermo >::write(), surfaceFeatures::writeDict(), and Time::writeTimeDict().

Here is the call graph for this function:

◆ add() [2/8]

void add ( const entry e,
bool  mergeEntry = false 
)

Add an entry.

With the merge option, dictionaries are interwoven and primitive entries are overwritten

Definition at line 1261 of file dictionary.C.

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

Here is the call graph for this function:

◆ add() [3/8]

void add ( const keyType k,
const word w,
bool  overwrite = false 
)

Add a word entry.

optionally overwrite an existing entry

Definition at line 1267 of file dictionary.C.

References Foam::add(), and k.

Here is the call graph for this function:

◆ add() [4/8]

void add ( const keyType k,
const string s,
bool  overwrite = false 
)

Add a string entry.

optionally overwrite an existing entry

Definition at line 1273 of file dictionary.C.

References Foam::add(), k, and s().

Here is the call graph for this function:

◆ add() [5/8]

void add ( const keyType k,
const label  l,
bool  overwrite = false 
)

Add a label entry.

optionally overwrite an existing entry

Definition at line 1284 of file dictionary.C.

References Foam::add(), and k.

Here is the call graph for this function:

◆ add() [6/8]

void add ( const keyType k,
const scalar  s,
bool  overwrite = false 
)

Add a scalar entry.

optionally overwrite an existing entry

Definition at line 1290 of file dictionary.C.

References Foam::add(), k, and s().

Here is the call graph for this function:

◆ add() [7/8]

void add ( const keyType k,
const dictionary d,
bool  mergeEntry = false 
)

Add a dictionary entry.

optionally merge with an existing sub-dictionary

Definition at line 1296 of file dictionary.C.

References Foam::add(), and k.

Here is the call graph for this function:

◆ add() [8/8]

void add ( const keyType k,
const T t,
bool  overwrite = false 
)

Add a T entry.

optionally overwrite an existing entry

Definition at line 252 of file dictionaryTemplates.C.

References Foam::add(), and k.

Here is the call graph for this function:

◆ set() [1/6]

◆ set() [2/6]

void set ( const entry e)

Assign a new entry, overwrite any existing entry.

Definition at line 1320 of file dictionary.C.

References Foam::e.

◆ set() [3/6]

void set ( const keyType k,
const dictionary d 
)

Assign a dictionary entry, overwrite any existing entry.

Definition at line 1326 of file dictionary.C.

References k.

◆ set() [4/6]

void set ( const keyType k,
const T t 
)

Assign a T entry, overwrite any existing entry.

Definition at line 259 of file dictionaryTemplates.C.

References k.

◆ set() [5/6]

void set ( const keyType ,
const T ,
const KeysAndTs &  ... 
)

Assign multiple T entries, overwriting any existing entries.

◆ remove()

bool remove ( const word Keyword)

Remove an entry specified by keyword.

Definition at line 1332 of file dictionary.C.

References UILList< LListBase, T >::remove().

Referenced by removeEntry::execute(), and dictionary::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ changeKeyword()

bool changeKeyword ( const keyType oldKeyword,
const keyType newKeyword,
bool  forceOverwrite = false 
)

Change the keyword for an entry,.

optionally forcing overwrite of an existing entry

Definition at line 1364 of file dictionary.C.

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

Here is the call graph for this function:

◆ merge()

bool merge ( const dictionary dict)

Merge entries from the given dictionary.

Also merge sub-dictionaries as required.

Definition at line 1454 of file dictionary.C.

References Foam::abort(), Foam::add(), Foam::clone(), dict, Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter, and Foam::name().

Referenced by snappyLayerDriver::addLayers(), and Foam::readConfigFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clear()

void clear ( )

Clear the dictionary.

Definition at line 1499 of file dictionary.C.

References ILList< LListBase, T >::clear().

Referenced by includeEntry::execute(), includeEtcEntry::execute(), entry::New(), Foam::operator>>(), and dictionary::set().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ transfer()

void transfer ( dictionary dict)

Transfer the contents of the argument and annul the argument.

Definition at line 1508 of file dictionary.C.

References dict, dictionaryName::name(), Foam::name(), and ILList< LListBase, T >::transfer().

Referenced by Foam::operator>>(), and meshRefinement::topoChange().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ read()

◆ global()

bool global ( ) const
virtual

Return true if the dictionary global,.

i.e. the same on all processors. Defaults to false, must be overridden by global IO dictionaries

Reimplemented in localIOdictionary, IOdictionary, dictionary::includedDictionary, fvModels, and fvConstraints.

Definition at line 157 of file dictionaryIO.C.

◆ write()

◆ operator[]()

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

Find and return entry.

Definition at line 1523 of file dictionary.C.

◆ operator=() [1/2]

◆ operator=() [2/2]

void operator= ( dictionary &&  rhs)

Definition at line 1552 of file dictionary.C.

References Foam::abort(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::name(), dictionaryName::operator=(), and ILList< LListBase, T >::operator=().

Here is the call graph for this function:

◆ operator+=()

void operator+= ( const dictionary rhs)

Include entries from the given dictionary.

Warn, but do not overwrite existing entries.

Definition at line 1570 of file dictionary.C.

References Foam::abort(), Foam::add(), Foam::clone(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter, and Foam::name().

Here is the call graph for this function:

◆ operator|=()

void operator|= ( const dictionary rhs)

Conditionally include entries from the given dictionary.

Do not overwrite existing entries.

Definition at line 1587 of file dictionary.C.

References Foam::abort(), Foam::add(), Foam::clone(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter, found, and Foam::name().

Here is the call graph for this function:

◆ operator<<=()

void operator<<= ( const dictionary rhs)

Unconditionally include entries from the given dictionary.

Overwrite existing entries.

Definition at line 1607 of file dictionary.C.

References Foam::abort(), Foam::clone(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter, and Foam::name().

Here is the call graph for this function:

◆ set() [6/6]

void set ( const keyType k,
const T t,
const KeysAndTs &...  keysAndTs 
)

Definition at line 266 of file dictionaryTemplates.C.

References k.

Friends And Related Function Documentation

◆ entry

friend class entry
friend

Declare friendship with the entry class for IO.

Definition at line 232 of file dictionary.H.

◆ operator>>

Istream& operator>> ( Istream ,
dictionary  
)
friend

Read dictionary from Istream.

◆ operator<<

Ostream& operator<< ( Ostream ,
const dictionary  
)
friend

Write dictionary to Ostream.

Member Data Documentation

◆ null

◆ writeOptionalEntries

bool writeOptionalEntries
static

If true write optional keywords and values.

if not present in dictionary

Definition at line 246 of file dictionary.H.


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