Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for dictionary:
Collaboration graph
[legend]

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 &)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (Istream &, const bool keepHeader)
 Construct top-level dictionary from Istream,. 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, const Xfer< dictionary > &)
 Construct by transferring parameter contents given parent dictionary. More...
 
 dictionary (const Xfer< dictionary > &)
 Construct top-level dictionary by transferring parameter contents. 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...
 
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 entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
template<class T >
T lookupType (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. 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 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...
 
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...
 
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...
 
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...
 
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...
 
Xfer< dictionaryxfer ()
 Transfer contents to the Xfer container. More...
 
bool read (Istream &)
 Read dictionary from Istream. More...
 
bool read (Istream &, const bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. 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+= (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...
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. 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...
 
- 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 > &)
 Construct as copy. 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...
 
- 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 > &)
 Construct as copy. 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 > &)
 
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...
 

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

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 137 of file dictionary.H.

Constructor & Destructor Documentation

◆ dictionary() [1/10]

Construct top-level dictionary null.

Definition at line 238 of file dictionary.C.

Referenced by dictionary::clone(), data::data(), dictionary::dictionary(), dictionary::New(), and dictionary::subOrEmptyDict().

Here is the caller graph for this function:

◆ dictionary() [2/10]

dictionary ( const fileName name)

Construct top-level empty dictionary with given name.

Definition at line 244 of file dictionary.C.

References dictionary::dictionary().

Here is the call graph for this function:

◆ dictionary() [3/10]

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 33 of file dictionaryIO.C.

References Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ dictionary() [4/10]

dictionary ( Istream is)

Construct top-level dictionary from Istream,.

reading entries until EOF

Definition at line 46 of file dictionaryIO.C.

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

Here is the call graph for this function:

◆ dictionary() [5/10]

dictionary ( Istream is,
const bool  keepHeader 
)

Construct top-level dictionary from Istream,.

reading entries until EOF, optionally keeping the header

Definition at line 58 of file dictionaryIO.C.

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

Here is the call graph for this function:

◆ dictionary() [6/10]

dictionary ( const dictionary parentDict,
const dictionary dict 
)

Construct as copy given the parent dictionary.

Definition at line 252 of file dictionary.C.

References dictionary::dictionary(), and forAllIter.

Here is the call graph for this function:

◆ dictionary() [7/10]

dictionary ( const dictionary dict)

Construct top-level dictionary as copy.

Definition at line 278 of file dictionary.C.

References dictionary::dictionary(), and forAllIter.

Here is the call graph for this function:

◆ dictionary() [8/10]

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 303 of file dictionary.C.

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

Here is the call graph for this function:

◆ dictionary() [9/10]

dictionary ( const dictionary parentDict,
const Xfer< dictionary > &  dict 
)

Construct by transferring parameter contents given parent dictionary.

Definition at line 317 of file dictionary.C.

References dict, dictionary::dictionary(), dictionaryName::name(), and dictionary::transfer().

Here is the call graph for this function:

◆ dictionary() [10/10]

dictionary ( const Xfer< dictionary > &  dict)

Construct top-level dictionary by transferring parameter contents.

Definition at line 330 of file dictionary.C.

References dict, and dictionary::transfer().

Here is the call graph for this function:

◆ ~dictionary()

~dictionary ( )
virtual

Destructor.

Definition at line 348 of file dictionary.C.

Member Function Documentation

◆ ClassName()

ClassName ( "dictionary"  )

◆ clone()

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

Construct and return clone.

Definition at line 340 of file dictionary.C.

References dictionary::dictionary().

Referenced by dictionary::merge(), dictionary::operator+=(), dictionary::operator=(), dictionary::operator|=(), Foam::preservePatchTypes(), and refinementSurfaces::refinementSurfaces().

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

◆ New()

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

Construct top-level dictionary on freestore from Istream.

Definition at line 72 of file dictionaryIO.C.

References dictionary::dictionary().

Here is the call graph for this function:

◆ parent()

const dictionary& parent ( ) const
inline

Return the parent dictionary.

Definition at line 260 of file dictionary.H.

Referenced by cylindrical::cylindrical(), dictionary::topDict(), and dictionary::write().

Here is the caller graph for this function:

◆ isNull()

bool isNull ( ) const
inline

Return whether this dictionary is null.

Definition at line 266 of file dictionary.H.

References Foam::add(), clear(), found, lookup(), Foam::operator+(), Foam::operator<<(), Foam::operator>>(), Foam::operator|(), Foam::read(), Foam::T(), and Foam::blockMeshTools::write().

Here is the call graph for this function:

◆ topDict()

const Foam::dictionary & topDict ( ) const

Return the top of the tree.

Definition at line 356 of file dictionary.C.

References dictionaryName::name(), p, dictionary::parent(), and dictionary::topDict().

Referenced by dictionary::topDict().

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

◆ startLineNumber()

Foam::label startLineNumber ( ) const

Return line number of first token in dictionary.

Definition at line 371 of file dictionary.C.

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

Referenced by 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 384 of file dictionary.C.

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

Here is the call graph for this function:

◆ digest()

Foam::SHA1Digest digest ( ) const

Return the SHA1 digest of the dictionary contents.

Definition at line 397 of file dictionary.C.

References OSHA1stream::digest(), and forAllConstIter().

Referenced by functionObjectList::read(), and writeDictionary::write().

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 411 of file dictionary.C.

References dictionary::found(), OStringStream::str(), and dictionary::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 431 of file dictionary.C.

References dictionary::found(), and dictionary::lookupEntryPtr().

Referenced by activePressureForceBaffleVelocityFvPatchVectorField::activePressureForceBaffleVelocityFvPatchVectorField(), sixDoFRigidBodyMotion::addConstraints(), sixDoFRigidBodyMotion::addRestraints(), advectiveFvPatchField< Type >::advectiveFvPatchField(), alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField(), alphaFixedPressureFvPatchScalarField::alphaFixedPressureFvPatchScalarField(), angularOscillatingDisplacementPointPatchVectorField::angularOscillatingDisplacementPointPatchVectorField(), angularOscillatingVelocityPointPatchVectorField::angularOscillatingVelocityPointPatchVectorField(), atmBoundaryLayerInletEpsilonFvPatchScalarField::atmBoundaryLayerInletEpsilonFvPatchScalarField(), atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), atmBoundaryLayerInletVelocityFvPatchVectorField::atmBoundaryLayerInletVelocityFvPatchVectorField(), chemkinReader::chemkinReader(), forces::createFileNames(), cylindrical::cylindrical(), fvSchemes::d2dt2Scheme(), DAC< CompType, ThermoType >::DAC(), fvSchemes::ddtScheme(), Foam::dimensionedConstant(), fvSchemes::divScheme(), DRG< CompType, ThermoType >::DRG(), DRGEP< CompType, ThermoType >::DRGEP(), energyJumpAMIFvPatchScalarField::energyJumpAMIFvPatchScalarField(), energyJumpFvPatchScalarField::energyJumpFvPatchScalarField(), ensightSurfaceWriter::ensightSurfaceWriter(), externalCoupledMixedFvPatchField< scalar >::externalCoupledMixedFvPatchField(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), fanFvPatchField< Type >::fanFvPatchField(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::filmPyrolysisRadiativeCoupledMixedFvPatchScalarField(), fixedFluxPressureFvPatchScalarField::fixedFluxPressureFvPatchScalarField(), fixedJumpAMIFvPatchField< scalar >::fixedJumpAMIFvPatchField(), fixedJumpFvPatchField< scalar >::fixedJumpFvPatchField(), fvSchemes::fluxRequired(), dictionary::found(), freestreamPressureFvPatchScalarField::freestreamPressureFvPatchScalarField(), freestreamVelocityFvPatchVectorField::freestreamVelocityFvPatchVectorField(), fvPatchField< Type >::fvPatchField(), fvsPatchField< Type >::fvsPatchField(), genericFvPatchField< Type >::genericFvPatchField(), subModelBase::getModelProperty(), fvSchemes::gradScheme(), greyDiffusiveRadiationMixedFvPatchScalarField::greyDiffusiveRadiationMixedFvPatchScalarField(), greyDiffusiveViewFactorFixedValueFvPatchScalarField::greyDiffusiveViewFactorFixedValueFvPatchScalarField(), surfaceFieldValue::initialise(), inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField(), fvSchemes::interpolationScheme(), fvSchemes::laplacianScheme(), layerParameters::layerParameters(), dimensioned< vector >::lookupOrDefault(), basicThermo::lookupThermo(), mappedPatchBase::mappedPatchBase(), MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField(), nastranSurfaceWriter::nastranSurfaceWriter(), basicChemistryModel::New(), sootModel::New(), motionSolver::New(), Function1< Foam::Vector >::New(), ParticleForce< Foam::DSMCCloud >::New(), solidProperties::New(), laminarModel< BasicTurbulenceModel >::New(), liquidProperties::New(), pointPatchField< vector >::New(), fvsPatchField< Type >::New(), fvPatchField< Type >::New(), functionObject::New(), oldCyclicPolyPatch::oldCyclicPolyPatch(), dlLibraryTable::open(), axesRotation::operator=(), dictionary::operator|=(), optionList::optionsDict(), oscillatingDisplacementPointPatchVectorField::oscillatingDisplacementPointPatchVectorField(), oscillatingVelocityPointPatchVectorField::oscillatingVelocityPointPatchVectorField(), outletPhaseMeanVelocityFvPatchVectorField::outletPhaseMeanVelocityFvPatchVectorField(), PFA< CompType, ThermoType >::PFA(), phaseHydrostaticPressureFvPatchScalarField::phaseHydrostaticPressureFvPatchScalarField(), plane::plane(), plenumPressureFvPatchScalarField::plenumPressureFvPatchScalarField(), Foam::preservePatchTypes(), pressureControl::pressureControl(), pressureFvPatchScalarField::pressureFvPatchScalarField(), pressureInletOutletVelocityFvPatchVectorField::pressureInletOutletVelocityFvPatchVectorField(), radiationCoupledBase::radiationCoupledBase(), rawSurfaceWriter::rawSurfaceWriter(), tolerances::read(), CrossPowerLaw::read(), fieldExpression::read(), BirdCarreau::read(), timeControl::read(), abort::read(), fieldsExpression::read(), scalarTransport::read(), writeLocalObjects::read(), writeObjects::read(), codedFunctionObject::read(), sampledSurfaces::read(), CodedSource< Type >::read(), functionObjectList::read(), turbulenceFields::read(), sampledSets::read(), regionSizeDistribution::read(), streamLine::read(), forces::read(), fieldAverage::readAveragingProperties(), LduMatrix< Type, DType, LUType >::solver::readControl(), Time::readDict(), GeometricField< Type, PatchField, GeoMesh >::Boundary::readField(), functionObjectList::readFunctionObject(), liquidProperties::readIfPresent(), refinementSurfaces::refinementSurfaces(), tolerances::relax(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), rigidBodyMotion::rigidBodyMotion(), sampledPatchInternalField::sampledPatchInternalField(), sampledPlane::sampledPlane(), sampledThresholdCellFaces::sampledThresholdCellFaces(), fvSchemes::schemesDict(), searchableSurfaces::searchableSurfaces(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setCdSigma(), subModelBase::setModelProperty(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setPorosityCoefficient(), Foam::setRefCell(), shellSurfaces::shellSurfaces(), sixDoFRigidBodyMotion::sixDoFRigidBodyMotion(), SLGThermo::SLGThermo(), fvSchemes::snGradScheme(), solidBodyMotionDisplacementPointPatchVectorField::solidBodyMotionDisplacementPointPatchVectorField(), supersonicFreestreamFvPatchVectorField::supersonicFreestreamFvPatchVectorField(), temperatureCoupledBase::temperatureCoupledBase(), thermalBaffle1DFvPatchScalarField< solidType >::thermalBaffle1DFvPatchScalarField(), thirdBodyEfficiencies::thirdBodyEfficiencies(), dictionary::tokens(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::totalFlowRateAdvectiveDiffusiveFvPatchScalarField(), totalPressureFvPatchScalarField::totalPressureFvPatchScalarField(), totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::turbulentTemperatureRadCoupledMixedFvPatchScalarField(), uniformDensityHydrostaticPressureFvPatchScalarField::uniformDensityHydrostaticPressureFvPatchScalarField(), uniformInletOutletFvPatchField< Type >::uniformInletOutletFvPatchField(), uniformInterpolatedDisplacementPointPatchVectorField::uniformInterpolatedDisplacementPointPatchVectorField(), uniformJumpAMIFvPatchField< Type >::uniformJumpAMIFvPatchField(), uniformJumpFvPatchField< Type >::uniformJumpFvPatchField(), uniformTotalPressureFvPatchScalarField::uniformTotalPressureFvPatchScalarField(), Foam::unitSet(), valuePointPatchField< vector >::valuePointPatchField(), variableHeightFlowRateFvPatchScalarField::variableHeightFlowRateFvPatchScalarField(), wallHeatTransferFvPatchScalarField::wallHeatTransferFvPatchScalarField(), waveAlphaFvPatchScalarField::waveAlphaFvPatchScalarField(), waveDisplacementPointPatchVectorField::waveDisplacementPointPatchVectorField(), wavePressureFvPatchScalarField::wavePressureFvPatchScalarField(), waveVelocityFvPatchVectorField::waveVelocityFvPatchVectorField(), wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField(), jobInfo::write(), and residuals::writeResidual().

Here is the call graph for this function:

◆ lookupEntryPtr() [1/2]

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

◆ 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 509 of file dictionary.C.

References dictionary::lookupEntry(), and dictionary::lookupEntryPtr().

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 553 of file dictionary.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::lookup(), dictionary::lookupEntryPtr(), and dictionaryName::name().

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

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

◆ lookup()

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 576 of file dictionary.C.

References dictionary::lookupEntry(), dictionary::lookupScopedEntryPtr(), and entry::stream().

Referenced by activePressureForceBaffleVelocityFvPatchVectorField::activePressureForceBaffleVelocityFvPatchVectorField(), advectiveFvPatchField< Type >::advectiveFvPatchField(), bladeModel::bladeModel(), BreakupModel< Foam::SprayCloud< Foam::DSMCCloud > >::BreakupModel(), cellModel::cellModel(), motionSmootherAlgo::checkMesh(), chemkinReader::chemkinReader(), coalCloudList::coalCloudList(), Constant< Type >::Constant(), molecule::constantProperties::constantProperties(), correlationFunction< Type >::correlationFunction(), constantFilmThermo::Cp(), forces::createFileNames(), cuboid::cuboid(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), cyclicPolyPatch::cyclicPolyPatch(), cylindrical::cylindrical(), constantFilmThermo::D(), fvSchemes::d2dt2Scheme(), DAC< CompType, ThermoType >::DAC(), fvSchemes::ddtScheme(), decompositionMethod::decompositionMethod(), forces::devRhoReff(), dimensioned< vector >::dimensioned(), Foam::dimensionedConstant(), directions::directions(), argList::displayDoc(), fvSchemes::divScheme(), ensightSurfaceWriter::ensightSurfaceWriter(), EulerCoordinateRotation::EulerCoordinateRotation(), exponentialSolidTransport< Thermo >::exponentialSolidTransport(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), extrudePatchMesh::extrudePatchMesh(), Field< Foam::Vector2D >::Field(), fieldAverageItem::fieldAverageItem(), forceList::forceList(), FreeStream< CloudType >::FreeStream(), lduMatrix::smoother::getName(), lduMatrix::preconditioner::getName(), fvSchemes::gradScheme(), greyMeanSolidAbsorptionEmission::greyMeanSolidAbsorptionEmission(), constantFilmThermo::hl(), coordinateSystem::init(), absorptionCoeffs::initialise(), surfaceFieldValue::initialise(), liquidFilmThermo::initLiquid(), InjectionModel< CloudType >::InjectionModel(), InjectionModelList< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::InjectionModelList(), injectionModelList::injectionModelList(), fvSchemes::interpolationScheme(), constantFilmThermo::kappa(), laminarFlameSpeed::laminarFlameSpeed(), fvSchemes::laplacianScheme(), layerParameters::layerParameters(), Foam::MULES::limiterCorr(), liquidFilmThermo::liquidFilmThermo(), dictionary::lookupEntry(), dimensioned< vector >::lookupOrDefault(), lookupProfile::lookupProfile(), basicThermo::lookupThermo(), mappedPatchBase::mappedPatchBase(), mappedPatchFieldBase< Type >::mappedPatchFieldBase(), meanVelocityForce::meanVelocityForce(), MGridGenGAMGAgglomeration::MGridGenGAMGAgglomeration(), medialAxisMeshMover::move(), constantFilmThermo::mu(), forces::mu(), multiDirRefinement::multiDirRefinement(), NamedEnum< directionType, 3 >::names(), nastranSurfaceWriter::nastranSurfaceWriter(), combustionModel::New(), basicChemistryModel::New(), thermophysicalFunction::New(), scatterModel::New(), renumberMethod::New(), CorrectionLimitingMethod::New(), decompositionMethod::New(), tetherPotential::New(), profileModel::New(), absorptionEmissionModel::New(), surfaceFilmModel::New(), waveModel::New(), DispersionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), ParticleStressModel::New(), energyScalingFunction::New(), sootModel::New(), interpolation< Foam::Vector >::New(), motionSolver::New(), AtomizationModel< Foam::SprayCloud< Foam::DSMCCloud > >::New(), PairModel< Foam::DSMCCloud >::New(), TimeScaleModel::New(), trimModel::New(), WallModel< Foam::DSMCCloud >::New(), extrudeModel::New(), BinaryCollisionModel< Foam::DSMCCloud< ParcelType > >::New(), WallInteractionModel< Foam::DSMCCloud< ParcelType > >::New(), engineMesh::New(), generalizedNewtonianViscosityModel::New(), InflowBoundaryModel< Foam::DSMCCloud< ParcelType > >::New(), LESdelta::New(), filmThermoModel::New(), filmRadiationModel::New(), heatTransferModel::New(), HeatTransferModel< Foam::ThermoCloud< CloudType > >::New(), CollisionModel< Foam::CollidingCloud< Foam::DSMCCloud > >::New(), barotropicCompressibilityModel::New(), filmTurbulenceModel::New(), DevolatilisationModel< Foam::ReactingMultiphaseCloud< Foam::DSMCCloud > >::New(), SurfaceReactionModel< Foam::ReactingMultiphaseCloud< Foam::DSMCCloud > >::New(), StochasticCollisionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), IsotropyModel< Foam::MPPICCloud< CloudType > >::New(), sixDoFRigidBodyMotionRestraint::New(), viscosityModel::New(), patchDistMethod::New(), Function1< Foam::Vector >::New(), DampingModel< Foam::MPPICCloud< CloudType > >::New(), dynamicFvMesh::New(), filmViscosityModel::New(), solidBodyMotionFunction::New(), pairPotential::New(), laminarFlameSpeed::New(), BreakupModel< Foam::SprayCloud< Foam::DSMCCloud > >::New(), CompositionModel< Foam::ReactingCloud< Foam::DSMCCloud > >::New(), phaseChangeModel::New(), coordinateRotation::New(), LESfilter::New(), PackingModel< Foam::MPPICCloud< CloudType > >::New(), integrationScheme::New(), AveragingMethod< Foam::Vector >::New(), sixDoFRigidBodyMotionConstraint::New(), regionModelFunctionObject::New(), reactionRateFlameArea::New(), solidProperties::New(), distributionModel::New(), PatchInteractionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), rigidBody::New(), surfaceTensionModel::New(), rigidBodySolver::New(), restraint::New(), SRFModel::New(), laminarModel< BasicTurbulenceModel >::New(), polyMeshModifier::New(), PhaseChangeModel< Foam::ReactingCloud< Foam::DSMCCloud > >::New(), fieldValue::New(), liquidProperties::New(), RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::New(), ODESolver::New(), sixDoFSolver::New(), LESModel< BasicTurbulenceModel >::New(), pyrolysisModel::New(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), option::New(), sampledSet::New(), radiationModel::New(), pointZone::New(), cellZone::New(), lduMatrix::solver::New(), porosityModel::New(), joint::New(), LduMatrix< Type, DType, LUType >::solver::New(), coordinateSystem::New(), InjectionModel< CloudType >::New(), sampledSurface::New(), Reaction< ReactionThermo >::New(), faceZone::New(), pointPatchField< vector >::New(), fvsPatchField< Type >::New(), polyPatch::New(), fvPatchField< Type >::New(), functionObject::New(), LduMatrix< Type, DType, LUType >::smoother::New(), lduMatrix::smoother::New(), LduMatrix< Type, DType, LUType >::preconditioner::New(), lduMatrix::preconditioner::New(), decomposedBlockData::numBlocks(), oldCyclicPolyPatch::oldCyclicPolyPatch(), dlLibraryTable::open(), multivariateIndependentScheme< Type >::operator()(), axesRotation::operator=(), Foam::operator>>(), Foam::functionObjects::operator>>(), dictionary::operator[](), Pa::Pa(), argList::parse(), phaseProperties::phaseProperties(), plane::plane(), plenumPressureFvPatchScalarField::plenumPressureFvPatchScalarField(), Polynomial< Type >::Polynomial(), pressureControl::pressureControl(), UPstream::procNo(), constantFilmThermo::pv(), Ra::Ra(), rawSurfaceWriter::rawSurfaceWriter(), Reaction< ReactionThermo >::Reaction(), exponentialRepulsion::read(), lennardJones::read(), harmonicSpring::read(), tolerances::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), dampedCoulomb::read(), anisotropicFilter::read(), laplaceFilter::read(), sigmoid::read(), randomise::read(), scale::read(), doubleSigmoid::read(), azizChen::read(), maitlandSmith::read(), FixedValueConstraint< Type >::read(), relaxation::read(), thermalBaffle::read(), fieldExpression::read(), CrossPowerLaw::read(), HerschelBulkley::read(), writeDictionary::read(), powerLaw::read(), BirdCarreau::read(), timeControl::read(), abort::read(), consumptionSpeed::read(), fieldsExpression::read(), timeActivatedFileUpdate::read(), cloudSolution::read(), removeRegisteredObject::read(), residuals::read(), Casson::read(), cloudInfo::read(), reactionRateFlameArea::read(), patchProbes::read(), writeObjectsBase::read(), inhomogeneousMixture< ThermoType >::read(), readFields::read(), fieldCoordinateSystemTransform::read(), sixDoFRigidBodyControl::read(), surfaceInterpolate::read(), volRegion::read(), fieldValue::read(), egrMixture< ThermoType >::read(), interfaceHeight::read(), histogram::read(), dimensioned< vector >::read(), cellSetOption::read(), writeObjects::read(), fieldValueDelta::read(), fieldMinMax::read(), wallHeatTransferCoeff::read(), codedFunctionObject::read(), sampledSurfaces::read(), nearWallFields::read(), CodedSource< Type >::read(), kinematicSingleLayer::read(), forceCoeffs::read(), probes::read(), turbulenceFields::read(), porosityModel::read(), sampledSets::read(), regionSizeDistribution::read(), rotorDiskSource::read(), streamLine::read(), fieldAverage::read(), sixDoFRigidBodyMotion::read(), pressure::read(), forces::read(), solidificationMeltingSource::read(), LduMatrix< Type, DType, LUType >::solver::readControl(), singleRegionCorrectorConvergenceControl::readCorrResidualControls(), constant::readDict(), dynamicRefineFvMesh::readDict(), Time::readDict(), DimensionedField< Type, Foam::pointMesh >::readField(), functionObjectList::readFunctionObject(), IOobject::readHeader(), mappedPatchBase::readListOrField(), ensightPart::reconstruct(), refinementParameters::refinementParameters(), refinementSurfaces::refinementSurfaces(), tolerances::relaxationFactor(), boundaryRegion::rename(), constantFilmThermo::rho(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), rigidBodyMotion::rigidBodyMotion(), thermalBaffleFvPatchScalarField::rmap(), sampledCuttingPlane::sampledCuttingPlane(), sampledIsoSurface::sampledIsoSurface(), sampledPatchInternalField::sampledPatchInternalField(), motionSmootherAlgo::scaleMesh(), fvSchemes::schemesDict(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), seriesProfile::seriesProfile(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setCdSigma(), SemiImplicitSource< Type >::setFieldData(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::setPorosityCoefficient(), Foam::setRefCell(), reducedUnits::setRefValues(), cellSetOption::setSelection(), shellSurfaces::shellSurfaces(), constantFilmThermo::sigma(), slidingInterface::slidingInterface(), fvSchemes::snGradScheme(), SolidReaction< ReactionThermo >::SolidReaction(), rigidBodyMeshMotionSolver::solve(), tolerances::solverRelativeTolerance(), tolerances::solverTolerance(), sphere::sphere(), STARCDCoordinateRotation::STARCDCoordinateRotation(), dictionaryEntry::stream(), surfaceFeatures::surfaceFeatures(), surfacePatchIOList::surfacePatchIOList(), surfaceZonesInfo::surfaceZonesInfo(), surfZoneIOList::surfZoneIOList(), Table< Type >::Table(), TableFile< Type >::TableFile(), constantFilmThermo::Tb(), thermoSingleLayer::thermoSingleLayer(), thirdBodyEfficiencies::thirdBodyEfficiencies(), TurbulenceModel< volScalarField, geometricOneField, incompressibleTurbulenceModel, TransportModel >::TurbulenceModel(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::turbulentTemperatureRadCoupledMixedFvPatchScalarField(), UniformDimensionedField< vector >::UniformDimensionedField(), uniformInterpolationTable< scalar >::uniformInterpolationTable(), Foam::unitSet(), dynamicRefineFvMesh::update(), alphatJayatillekeWallFunctionFvPatchScalarField::updateCoeffs(), constantFilmThermo::W(), WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), waveSuperposition::waveSuperposition(), wideBandAbsorptionEmission::wideBandAbsorptionEmission(), thermalBaffleFvPatchScalarField::write(), residuals::writeResidual(), and medialAxisMeshMover::~medialAxisMeshMover().

Here is the call graph for this function:

◆ lookupType()

T lookupType ( 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 33 of file dictionaryTemplates.C.

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

Referenced by ParticleForce< Foam::DSMCCloud >::New(), velocityRamping::read(), and streamLine::read().

Here is the call graph for this function:
Here is the caller 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 57 of file dictionaryTemplates.C.

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

Referenced by atmBoundaryLayerInletEpsilonFvPatchScalarField::atmBoundaryLayerInletEpsilonFvPatchScalarField(), atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), atmBoundaryLayerInletVelocityFvPatchVectorField::atmBoundaryLayerInletVelocityFvPatchVectorField(), subModelBase::defaultCoeffs(), EulerCoordinateRotation::EulerCoordinateRotation(), fieldAverageItem::fieldAverageItem(), fixedMeanOutletInletFvPatchField< Type >::fixedMeanOutletInletFvPatchField(), freestreamFvPatchField< Type >::freestreamFvPatchField(), inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), dictionary::lookupType(), basicChemistryModel::New(), tableReader< scalar >::New(), engineTime::New(), thermalBaffleModel::New(), GAMGAgglomeration::New(), Foam::operator>>(), Foam::functionObjects::operator>>(), argList::parse(), nonOrthogonalSolutionControl::read(), pisoControl::read(), fluidSolutionControl::read(), log::read(), pimpleNoLoopControl::read(), blendingFactor::read(), pimpleControl::read(), CourantNo::read(), pimpleMultiRegionControl::read(), BirdCarreau::read(), timeControl::read(), cloudSolution::read(), scalarTransport::read(), sixDoFRigidBodyState::read(), targetCoeffTrim::read(), wallHeatFlux::read(), wallShearStress::read(), histogram::read(), fieldMinMax::read(), wallHeatTransferCoeff::read(), rigidBodyMotion::read(), functionObjectList::read(), MRFZone::read(), functionObject::read(), streamLine::read(), sixDoFRigidBodyMotion::read(), pressure::read(), forces::read(), temperatureDependent::readDict(), refinementSurfaces::refinementSurfaces(), slidingInterface::setTolerances(), fvMatrix< Type >::solve(), SRFFreestreamVelocityFvPatchVectorField::SRFFreestreamVelocityFvPatchVectorField(), STARCDCoordinateRotation::STARCDCoordinateRotation(), transferModelList::transferModelList(), turbulentIntensityKineticEnergyInletFvPatchScalarField::turbulentIntensityKineticEnergyInletFvPatchScalarField(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField(), turbulentMixingLengthFrequencyInletFvPatchScalarField::turbulentMixingLengthFrequencyInletFvPatchScalarField(), Foam::unitSet(), dynamicRefineFvMesh::update(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), and medialAxisMeshMover::~medialAxisMeshMover().

Here is the call 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 87 of file dictionaryTemplates.C.

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

Referenced by Foam::debug::debugSwitch(), Foam::debug::floatOptimisationSwitch(), Foam::debug::infoSwitch(), dimensioned< vector >::lookupOrAddToDict(), Switch::lookupOrAddToDict(), dictionary::lookupOrDefault(), and Foam::debug::optimisationSwitch().

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

◆ readIfPresent()

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

Find an entry if present, and assign to T.

Returns true if the entry was found. If recursive, search parent dictionaries. If patternMatch, use regular expressions.

Definition at line 118 of file dictionaryTemplates.C.

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

Referenced by advectiveFvPatchField< Type >::advectiveFvPatchField(), motionSmootherAlgo::checkMesh(), cyclicAMIPolyPatch::cyclicAMIPolyPatch(), fvMotionSolverEngineMesh::fvMotionSolverEngineMesh(), subModelBase::getBaseProperty(), subModelBase::getModelProperty(), kinematicSingleLayer::info(), coordinateSystem::init(), volFieldValue::initialise(), surfaceFieldValue::initialise(), layeredEngineMesh::layeredEngineMesh(), layerParameters::layerParameters(), linearNormal::linearNormal(), dictionary::lookupOrAddDefault(), chemistryReader< gasHThermoPhysics >::New(), polyPatch::New(), oldCyclicPolyPatch::oldCyclicPolyPatch(), axesRotation::operator=(), patchIdentifier::patchIdentifier(), porosityModel::porosityModel(), Foam::preservePatchTypes(), profileModel::profileModel(), cubeRootVolDelta::read(), maxDeltaxyz::read(), IDDESDelta::read(), vanDriestDelta::read(), PrandtlDelta::read(), abort::read(), time::read(), cloudSolution::read(), scalarTransport::read(), systemCall::read(), interfaceHeight::read(), fvDOM::read(), cellSetOption::read(), kinematicSingleLayer::read(), probes::read(), porosityModel::read(), regionSizeDistribution::read(), streamLine::read(), fieldAverage::read(), pressure::read(), forces::read(), solidificationMeltingSource::read(), option::read(), Time::readDict(), IOobject::readHeader(), solidProperties::readIfPresent(), thermophysicalProperties::readIfPresent(), Switch::readIfPresent(), dimensioned< vector >::readIfPresent(), liquidProperties::readIfPresent(), ensightPart::reconstruct(), refinementSurfaces::refinementSurfaces(), sampledPlane::sampledPlane(), sampledSurface::sampledSurface(), searchableSurfaces::searchableSurfaces(), Time::setControls(), data::setSolverPerformance(), Time::setTime(), fvMatrix< Type >::solve(), surfaceZonesInfo::surfaceZonesInfo(), surfZoneIdentifier::surfZoneIdentifier(), surfZoneIOList::surfZoneIOList(), thermoSingleLayer::thermoSingleLayer(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), triSurfaceMesh::triSurfaceMesh(), triSurfaceSearch::triSurfaceSearch(), and uniformInterpolationTable< scalar >::uniformInterpolationTable().

Here is the call graph for this function:

◆ 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. Allows scoping using '.'. Special handling for ':' at start of keyword and '..'.

Definition at line 587 of file dictionary.C.

Referenced by Foam::stringOps::getVariable(), Foam::stringOps::inplaceExpand(), dictionary::lookup(), entry::New(), Foam::blockMeshTools::read(), and dictionary::substituteScopedKeyword().

Here is the caller 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 662 of file dictionary.C.

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

Referenced by namedBlock::namedBlock(), namedVertex::namedVertex(), blockVertex::read(), regionModel::read(), blockVertex::write(), and blockDescriptor::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 677 of file dictionary.C.

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

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 692 of file dictionary.C.

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

Referenced by sixDoFRigidBodyMotion::addConstraints(), snappyLayerDriver::addLayers(), sixDoFRigidBodyMotion::addRestraints(), CloudFunctionObjectList< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::CloudFunctionObjectList(), forces::createFileNames(), DAC< CompType, ThermoType >::DAC(), decompositionMethod::decompositionMethod(), multiRegionSolutionControl::dict(), singleRegionSolutionControl::dict(), Foam::dimensionedConstant(), directions::directions(), argList::displayDoc(), fvMeshDistribute::distribute(), DRG< CompType, ThermoType >::DRG(), DRGEP< CompType, ThermoType >::DRGEP(), exponentialSolidTransport< Thermo >::exponentialSolidTransport(), subModelBase::getBaseProperty(), subModelBase::getModelProperty(), coordinateSystem::init(), cloudSolution::integrationSchemes(), cloudSolution::interpolationSchemes(), layerParameters::layerParameters(), liquidMixtureProperties::liquidMixtureProperties(), Foam::listSwitches(), basicThermo::lookupThermo(), NamedEnum< directionType, 3 >::names(), basicChemistryModel::New(), basicSolidChemistryModel::New(), chemistryTabulationMethod< ReactionThermo, ThermoType >::New(), Function1< Foam::Vector >::New(), chemistryReductionMethod< ReactionThermo, ThermoType >::New(), regionModelFunctionObject::New(), laminarModel< BasicTurbulenceModel >::New(), functionObjectList::New(), RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::New(), LESModel< BasicTurbulenceModel >::New(), coordinateSystem::New(), optionList::optionsDict(), PFA< CompType, ThermoType >::PFA(), plane::plane(), Foam::preservePatchTypes(), fvMeshDistribute::printFieldInfo(), profileModelList::profileModelList(), pyrolysisModelCollection::pyrolysisModelCollection(), lennardJones::read(), exponentialRepulsion::read(), harmonicSpring::read(), tolerances::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), dampedCoulomb::read(), sigmoid::read(), doubleSigmoid::read(), azizChen::read(), maitlandSmith::read(), FixedValueConstraint< Type >::read(), porosityModelList::read(), pureMixture< ThermoType >::read(), singleComponentMixture< ThermoType >::read(), cloudSolution::read(), homogeneousMixture< ThermoType >::read(), scalarTransport::read(), multiComponentMixture< ThermoType >::read(), inhomogeneousMixture< ThermoType >::read(), veryInhomogeneousMixture< ThermoType >::read(), egrMixture< ThermoType >::read(), MRFZoneList::read(), fieldValueDelta::read(), kinematicSingleLayer::read(), streamLine::read(), forces::read(), fieldAverage::readAveragingProperties(), constant::readDict(), Time::readDict(), GeometricField< Type, PatchField, GeoMesh >::Boundary::readField(), functionObjectList::readFunctionObject(), liquidProperties::readIfPresent(), optionList::readOptions(), refinementSurfaces::refinementSurfaces(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), sampledPlane::sampledPlane(), fvSchemes::schemesDict(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), subModelBase::setBaseProperty(), subModelBase::setModelProperty(), surfaceTensionModel::sigmaDict(), SLGThermo::SLGThermo(), solidMixtureProperties::solidMixtureProperties(), displacementLayeredMotionMotionSolver::solve(), data::solverPerformanceDict(), cloudSolution::sourceTermDict(), thermophysicalPropertiesSelector< ThermophysicalProperties >::thermophysicalPropertiesSelector(), Foam::unitSet(), wideBandAbsorptionEmission::wideBandAbsorptionEmission(), thermalBaffleFvPatchScalarField::write(), and fieldAverage::writeAveragingProperties().

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 709 of file dictionary.C.

References entry::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::lookupEntryPtr(), dictionaryName::name(), and dictionary::subOrEmptyDict().

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 727 of file dictionary.C.

References entry::dict(), dictionary::dictionary(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::lookupEntryPtr(), dictionaryName::name(), and dictionary::optionalSubDict().

Referenced by blockDescriptor::blockDescriptor(), surfaceFieldValue::initialise(), radiationModel::read(), sampledSurfaces::read(), and dictionary::subDict().

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

◆ optionalSubDict()

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

◆ toc()

Foam::wordList toc ( ) const

◆ sortedToc()

Foam::wordList sortedToc ( ) const

Return the sorted table of contents.

Definition at line 790 of file dictionary.C.

Referenced by Foam::listSwitches().

Here is the caller graph for this function:

◆ keys()

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

Return the list of available keys or patterns.

Definition at line 796 of file dictionary.C.

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

Referenced by dictionary::toc().

Here is the call graph for this function:
Here is the caller 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 131 of file dictionaryIO.C.

References dictionary::add(), 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 622 of file dictionary.C.

References dictionary::add(), forAllConstIter(), and dictionary::lookupScopedEntryPtr().

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 814 of file dictionary.C.

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

Referenced by error::abort(), IOerror::abort(), dictionary::add(), constAnIsoSolidTransport< Thermo >::constAnIsoSolidTransport(), constIsoSolidTransport< Thermo >::constIsoSolidTransport(), constTransport< Thermo >::constTransport(), coordinateSystem::dict(), Foam::dimensionedConstant(), calcEntry::execute(), error::exit(), IOerror::exit(), exponentialSolidTransport< Thermo >::exponentialSolidTransport(), dictionary::merge(), namedBlock::namedBlock(), namedVertex::namedVertex(), basicChemistryModel::New(), entry::New(), functionObjectList::New(), error::operator()(), dictionary::operator+=(), cellTable::operator=(), dictionary::operator=(), dictionary::operator|=(), argList::parse(), Foam::preservePatchTypes(), functionObjectList::readFunctionObject(), IOerror::SafeFatalIOError(), dictionary::set(), subModelBase::setBaseProperty(), fvSchemes::setFluxRequired(), subModelBase::setModelProperty(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), GAMGSolver::solve(), dictionary::substituteKeyword(), dictionary::substituteScopedKeyword(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), solution::upgradeSolverDict(), jobInfo::write(), specie::write(), rigidBodyModelState::write(), rhoConst< Specie >::write(), sixDoFRigidBodyMotionState::write(), WLFTransport< Thermo >::write(), hConstThermo< EquationOfState >::write(), sutherlandTransport< Thermo >::write(), perfectFluid< Specie >::write(), hRefConstThermo< EquationOfState >::write(), incompressiblePerfectGas< Specie >::write(), linear< Type >::write(), eConstThermo< EquationOfState >::write(), thermophysicalProperties::write(), adiabaticPerfectFluid< Specie >::write(), polynomialSolidTransport< Thermo, PolySize >::write(), Boussinesq< Specie >::write(), polynomialTransport< Thermo, PolySize >::write(), uniformInterpolationTable< scalar >::write(), icoPolynomial< Specie, PolySize >::write(), logPolynomialTransport< Thermo, PolySize >::write(), janafThermo< EquationOfState >::write(), hPolynomialThermo< EquationOfState, PolySize >::write(), liquidProperties::write(), fieldAverage::writeAveragingProperties(), surfaceFeatures::writeDict(), meanVelocityForce::writeProps(), 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 895 of file dictionary.C.

References dictionary::add(), and entry::clone().

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 901 of file dictionary.C.

References dictionary::add().

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 908 of file dictionary.C.

References dictionary::add().

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 918 of file dictionary.C.

References dictionary::add().

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 924 of file dictionary.C.

References dictionary::add().

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 931 of file dictionary.C.

References dictionary::add().

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 148 of file dictionaryTemplates.C.

References dictionary::add().

Here is the call graph for this function:

◆ set() [1/4]

void set ( entry entryPtr)

◆ set() [2/4]

void set ( const entry e)

Assign a new entry, overwrite any existing entry.

Definition at line 954 of file dictionary.C.

References entry::clone().

Here is the call graph for this function:

◆ set() [3/4]

void set ( const keyType k,
const dictionary d 
)

Assign a dictionary entry, overwrite any existing entry.

Definition at line 960 of file dictionary.C.

◆ set() [4/4]

void set ( const keyType k,
const T t 
)

Assign a T entry, overwrite any existing entry.

Definition at line 155 of file dictionaryTemplates.C.

◆ remove()

bool remove ( const word Keyword)

Remove an entry specified by keyword.

Definition at line 966 of file dictionary.C.

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

Referenced by removeEntry::execute(), and IOerror::SafeFatalIOError().

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 999 of file dictionary.C.

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

Referenced by dictionary::remove().

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

◆ merge()

bool merge ( const dictionary dict)

Merge entries from the given dictionary.

Also merge sub-dictionaries as required.

Definition at line 1090 of file dictionary.C.

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

Referenced by snappyLayerDriver::addLayers(), Foam::listSwitches(), functionObjectList::New(), Time::readDict(), and functionObjectList::readFunctionObject().

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

◆ clear()

void clear ( )

Clear the dictionary.

Definition at line 1135 of file dictionary.C.

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

Referenced by entry::New(), dictionary::operator=(), Foam::operator>>(), strainRateFunction::read(), dictionary::set(), and data::setSolverPerformance().

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 1144 of file dictionary.C.

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

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

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

◆ xfer()

Transfer contents to the Xfer container.

Definition at line 1157 of file dictionary.C.

References Foam::xferMove().

Here is the call graph for this function:

◆ read() [1/2]

bool read ( Istream is)

◆ read() [2/2]

bool read ( Istream is,
const bool  keepHeader 
)

Read dictionary from Istream, optionally keeping the header.

Definition at line 80 of file dictionaryIO.C.

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

Here is the call graph for this function:

◆ write()

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

◆ operator[]()

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

Find and return entry.

Definition at line 1165 of file dictionary.C.

References dictionary::lookup().

Here is the call graph for this function:

◆ operator=()

void operator= ( const dictionary rhs)

◆ operator+=()

void operator+= ( const dictionary rhs)

Include entries from the given dictionary.

Warn, but do not overwrite existing entries.

Definition at line 1194 of file dictionary.C.

References Foam::abort(), dictionary::add(), dictionary::clone(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter(), and dictionaryName::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 1211 of file dictionary.C.

References Foam::abort(), dictionary::add(), dictionary::clone(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter(), dictionary::found(), and dictionaryName::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 1231 of file dictionary.C.

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

Here is the call graph for this function:

Friends And Related Function Documentation

◆ entry

friend class entry
friend

Declare friendship with the entry class for IO.

Definition at line 194 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

const dictionary null
static

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