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...
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... | |
| 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< dictionary > | clone () const |
| Construct and return clone. More... | |
| virtual | ~dictionary () |
| Destructor. More... | |
| const dictionary & | parent () const |
| Return the parent dictionary. More... | |
| bool | isNull () const |
| Return whether this dictionary is null. More... | |
| const dictionary & | topDict () const |
| Return the top of the tree. More... | |
| label | startLineNumber () const |
| Return line number of first token in dictionary. More... | |
| label | endLineNumber () const |
| Return line number of last token in dictionary. More... | |
| SHA1Digest | digest () const |
| Return the SHA1 digest of the dictionary contents. More... | |
| tokenList | tokens () const |
| Return the dictionary as a list of tokens. More... | |
| bool | found (const word &, bool recursive=false, bool patternMatch=true) const |
| Search dictionary for given keyword. More... | |
| const entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream pointer if present. More... | |
| entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) |
| Find and return an entry data stream pointer for manipulation. More... | |
| const entry * | lookupEntryPtrBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream if present, trying a list. More... | |
| const entry & | lookupEntry (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream if present otherwise error. More... | |
| const entry & | lookupEntryBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream if present, trying a list. More... | |
| ITstream & | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
| Find and return an entry data stream. More... | |
| ITstream & | lookupBackwardsCompatible (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 entry * | lookupScopedEntryPtr (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 dictionary * | subDictPtr (const word &) const |
| Find and return a sub-dictionary pointer if present. More... | |
| dictionary * | subDictPtr (const word &) |
| Find and return a sub-dictionary pointer if present. More... | |
| const dictionary & | subDict (const word &) const |
| Find and return a sub-dictionary. More... | |
| dictionary & | subDict (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 dictionary & | optionalSubDict (const word &) const |
| Find and return a sub-dictionary if found. More... | |
| const dictionary & | scopedDict (const word &) const |
| Find and return a sub-dictionary by scoped lookup. More... | |
| dictionary & | scopedDict (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< keyType > | keys (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... | |
| 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... | |
| ITstream & | operator[] (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... | |
 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 fileName & | name () const |
| Return the dictionary name. More... | |
| fileName & | name () |
| 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... | |
| T * | first () |
| Return the first entry. More... | |
| const T * | first () const |
| Return the first entry. More... | |
| T * | last () |
| Return the last entry. More... | |
| const T * | last () const |
| Return the last entry. More... | |
| T * | removeHead () |
| Remove and return head. More... | |
| T * | remove (T *p) |
| Remove and return element. More... | |
| T * | remove (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 iterator & | end () |
| const_iterator | cbegin () const |
| const const_iterator & | cend () const |
| const_iterator | begin () const |
| const const_iterator & | end () const |
| const_reverse_iterator | crbegin () const |
| const const_reverse_iterator & | crend () const |
| const_reverse_iterator | rbegin () const |
| const const_reverse_iterator & | rend () 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< dictionary > | New (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... | |
| Istream & | operator>> (Istream &, dictionary &) |
| Read dictionary from Istream. More... | |
| Ostream & | operator<< (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 T & | reference |
| Type that can be used for storing into DLList::value_type. More... | |
| typedef const T & | const_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 |
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:
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.
Definition at line 156 of file dictionary.H.
| dictionary | ( | ) |
Construct top-level dictionary null.
Definition at line 440 of file dictionary.C.
Referenced by dictionary::clone(), dictionary::dictionary(), dictionary::New(), and dictionary::subOrEmptyDict().
| dictionary | ( | const fileName & | name | ) |
Construct top-level empty dictionary with given name.
Definition at line 446 of file dictionary.C.
References dictionary::dictionary().
| 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 34 of file dictionaryIO.C.
References Foam::blockMeshTools::read().
| dictionary | ( | Istream & | is, |
| const bool | keepHeader = false |
||
| ) |
Construct top-level dictionary from Istream,.
reading entries until EOF, optionally keeping the header
Definition at line 52 of file dictionaryIO.C.
References inputModeEntry::clear(), inputSyntaxEntry::clear(), dictionary::includedDictionary::includedDictionary(), and dictionary::read().
| dictionary | ( | const dictionary & | parentDict, |
| const dictionary & | dict | ||
| ) |
Construct as copy given the parent dictionary.
Definition at line 454 of file dictionary.C.
References dictionary::dictionary(), and forAllIter.
| dictionary | ( | const dictionary & | dict | ) |
Construct top-level dictionary as copy.
Definition at line 480 of file dictionary.C.
References dictionary::dictionary(), and forAllIter.
| 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 519 of file dictionary.C.
References dictionary::dictionary(), and dictionary::operator=().
| dictionary | ( | const dictionary & | parentDict, |
| dictionary && | dict | ||
| ) |
Move constructor transferring parameter contents.
given parent dictionary
Definition at line 533 of file dictionary.C.
References dictionaryName::name(), and fileName::null.
| dictionary | ( | dictionary && | dict | ) |
Move constructor.
Definition at line 505 of file dictionary.C.
References dictionary::dictionary().
|
virtual |
Destructor.
Definition at line 560 of file dictionary.C.
| ClassName | ( | "dictionary" | ) |
| Foam::autoPtr< Foam::dictionary > clone | ( | ) | const |
Construct and return clone.
Definition at line 552 of file dictionary.C.
References dictionary::dictionary().
Referenced by dictionary::merge(), dictionary::operator+=(), dictionary::operator=(), dictionary::operator|=(), Foam::preservePatchTypes(), and refinementSurfaces::refinementSurfaces().
|
static |
Construct top-level dictionary on freestore from Istream.
Definition at line 96 of file dictionaryIO.C.
References dictionary::dictionary().
Referenced by DeardorffDiffStress< BasicMomentumTransportModel >::correct(), dynamicLagrangian< BasicMomentumTransportModel >::correct(), kEqn< BasicMomentumTransportModel >::correct(), kOmega< BasicMomentumTransportModel >::correct(), dynamicKEqn< BasicMomentumTransportModel >::correct(), kEpsilon< compressible::momentumTransportModel >::correct(), Maxwell< BasicMomentumTransportModel >::correct(), LaunderSharmaKE< BasicMomentumTransportModel >::correct(), SSG< BasicMomentumTransportModel >::correct(), RNGkEpsilon< BasicMomentumTransportModel >::correct(), realizableKE< BasicMomentumTransportModel >::correct(), SpalartAllmaras< BasicMomentumTransportModel >::correct(), LRR< BasicMomentumTransportModel >::correct(), kOmega2006< BasicMomentumTransportModel >::correct(), SpalartAllmarasDES< BasicMomentumTransportModel >::correct(), lambdaThixotropic< BasicMomentumTransportModel >::correct(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::correct(), mixtureKEpsilon< BasicMomentumTransportModel >::correct(), v2f< BasicMomentumTransportModel >::correct(), kOmegaSST< eddyViscosity< RASModel< BasicMomentumTransportModel > >, BasicMomentumTransportModel >::correct(), dynamicLagrangian< BasicMomentumTransportModel >::correctNut(), kEqn< BasicMomentumTransportModel >::correctNut(), WALE< BasicMomentumTransportModel >::correctNut(), continuousGasKEpsilon< BasicMomentumTransportModel >::correctNut(), DeardorffDiffStress< BasicMomentumTransportModel >::correctNut(), kOmega< BasicMomentumTransportModel >::correctNut(), SmagorinskyZhang< BasicMomentumTransportModel >::correctNut(), Smagorinsky< BasicMomentumTransportModel >::correctNut(), NicenoKEqn< BasicMomentumTransportModel >::correctNut(), kEpsilon< compressible::momentumTransportModel >::correctNut(), LaheyKEpsilon< BasicMomentumTransportModel >::correctNut(), LaunderSharmaKE< BasicMomentumTransportModel >::correctNut(), realizableKE< BasicMomentumTransportModel >::correctNut(), RNGkEpsilon< BasicMomentumTransportModel >::correctNut(), dynamicKEqn< BasicMomentumTransportModel >::correctNut(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::correctNut(), SSG< BasicMomentumTransportModel >::correctNut(), LRR< BasicMomentumTransportModel >::correctNut(), mixtureKEpsilon< BasicMomentumTransportModel >::correctNut(), SpalartAllmaras< BasicMomentumTransportModel >::correctNut(), SpalartAllmarasDES< BasicMomentumTransportModel >::correctNut(), kOmegaSSTSato< BasicMomentumTransportModel >::correctNut(), v2f< BasicMomentumTransportModel >::correctNut(), kOmegaSST< eddyViscosity< RASModel< BasicMomentumTransportModel > >, BasicMomentumTransportModel >::correctNut(), kOmegaSSTLM< BasicMomentumTransportModel >::correctReThetatGammaInt(), scalarTransport::execute(), age::execute(), phaseScalarTransport::execute(), phaseSystem::fvConstraints(), phaseSystem::fvModels(), and kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficients().
|
inline |
Return the parent dictionary.
Definition at line 301 of file dictionary.H.
Referenced by dictionary::topDict(), and dictionary::write().
|
inline |
Return whether this dictionary is null.
Definition at line 307 of file dictionary.H.
References Foam::add(), clear(), found, lookup(), Foam::operator<<(), dictionaryName::operator=(), Foam::operator>>(), Foam::read(), Foam::T(), and Foam::vtkWriteOps::write().
| const Foam::dictionary & topDict | ( | ) | const |
Return the top of the tree.
Definition at line 568 of file dictionary.C.
References dictionaryName::name(), p, dictionary::parent(), and dictionary::topDict().
Referenced by dictionary::topDict().
| Foam::label startLineNumber | ( | ) | const |
Return line number of first token in dictionary.
Definition at line 583 of file dictionary.C.
References UILList< LListBase, T >::first().
Referenced by codedBase::updateLibrary().
| Foam::label endLineNumber | ( | ) | const |
Return line number of last token in dictionary.
Definition at line 596 of file dictionary.C.
References UILList< LListBase, T >::last().
| Foam::SHA1Digest digest | ( | ) | const |
Return the SHA1 digest of the dictionary contents.
Definition at line 609 of file dictionary.C.
References OSHA1stream::digest(), and forAllConstIter().
Referenced by functionObjectList::read(), and writeDictionary::write().
| Foam::tokenList tokens | ( | ) | const |
Return the dictionary as a list of tokens.
Definition at line 623 of file dictionary.C.
References dictionary::found(), OStringStream::str(), and dictionary::write().
| 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 643 of file dictionary.C.
References dictionary::found(), dictionary::lookupEntryPtr(), and dictionary::null.
Referenced by activePressureForceBaffleVelocityFvPatchVectorField::activePressureForceBaffleVelocityFvPatchVectorField(), sixDoFRigidBodyMotion::addConstraints(), Foam::AddPatchFields(), sixDoFRigidBodyMotion::addRestraints(), advectiveFvPatchField< Type >::advectiveFvPatchField(), alphaContactAngleFvPatchScalarField::alphaContactAngleFvPatchScalarField(), alphaFixedPressureFvPatchScalarField::alphaFixedPressureFvPatchScalarField(), angularOscillatingDisplacementPointPatchVectorField::angularOscillatingDisplacementPointPatchVectorField(), angularOscillatingVelocityPointPatchVectorField::angularOscillatingVelocityPointPatchVectorField(), atmBoundaryLayerInletEpsilonFvPatchScalarField::atmBoundaryLayerInletEpsilonFvPatchScalarField(), atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), atmBoundaryLayerInletVelocityFvPatchVectorField::atmBoundaryLayerInletVelocityFvPatchVectorField(), Constant< Type >::Constant(), forces::createFileNames(), fvSchemes::d2dt2Scheme(), fvSchemes::ddtScheme(), Foam::dimensionedConstant(), fvSchemes::divScheme(), dynamicPressureFvPatchScalarField::dynamicPressureFvPatchScalarField(), ejectionModelList::ejectionModelList(), Embedded< Type >::Embedded(), energyJumpAMIFvPatchScalarField::energyJumpAMIFvPatchScalarField(), energyJumpFvPatchScalarField::energyJumpFvPatchScalarField(), includeEntry::execute(), includeEtcEntry::execute(), externalCoupledMixedFvPatchField< scalar >::externalCoupledMixedFvPatchField(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), fanPressureJumpFvPatchScalarField::fanPressureJumpFvPatchScalarField(), fixedFluxPressureFvPatchScalarField::fixedFluxPressureFvPatchScalarField(), fixedJumpAMIFvPatchField< scalar >::fixedJumpAMIFvPatchField(), fixedJumpFvPatchField< scalar >::fixedJumpFvPatchField(), fluxLimitedLangmuirHinshelwoodReactionRate::fluxLimitedLangmuirHinshelwoodReactionRate(), fvSchemes::fluxRequired(), forceList::forceList(), dictionary::found(), freestreamPressureFvPatchScalarField::freestreamPressureFvPatchScalarField(), freestreamVelocityFvPatchVectorField::freestreamVelocityFvPatchVectorField(), fvPatchField< Type >::fvPatchField(), fvsPatchField< Type >::fvsPatchField(), genericFvPatchField< Type >::genericFvPatchField(), subModelBase::getModelProperty(), fvSchemes::gradScheme(), greyDiffusiveRadiationMixedFvPatchScalarField::greyDiffusiveRadiationMixedFvPatchScalarField(), greyDiffusiveViewFactorFixedValueFvPatchScalarField::greyDiffusiveViewFactorFixedValueFvPatchScalarField(), volFieldValue::initialise(), surfaceFieldValue::initialise(), inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField(), fvSchemes::interpolationScheme(), fvSchemes::laplacianScheme(), layerParameters::layerParameters(), Foam::listSwitches(), basicThermo::lookupCstrIter(), dimensioned< vector >::lookupOrDefault(), mappedPatchBase::mappedPatchBase(), MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField(), NamedEnum< compressibleField, 8 >::names(), TableReader< scalar >::New(), motionSolver::New(), sootModel::New(), radiationModel::New(), heatTransferModel::New(), momentumTransportModel::New(), surfaceWriter::New(), viscosityModel::New(), Function1< Foam::Vector2D >::New(), phaseChangeModel::New(), ParticleForce< Foam::DSMCCloud >::New(), laminarModel< BasicMomentumTransportModel >::New(), solidProperties::New(), liquidProperties::New(), pointPatchField< vector >::New(), fvsPatchField< Type >::New(), fvPatchField< Type >::New(), functionObject::New(), dlLibraryTable::open(), axesRotation::operator=(), dictionary::operator|=(), oscillatingDisplacementPointPatchVectorField::oscillatingDisplacementPointPatchVectorField(), oscillatingVelocityPointPatchVectorField::oscillatingVelocityPointPatchVectorField(), outletPhaseMeanVelocityFvPatchVectorField::outletPhaseMeanVelocityFvPatchVectorField(), parcelThermo::parcelThermo(), patchInternalField::patchInternalField(), phaseHydrostaticPressureFvPatchScalarField::phaseHydrostaticPressureFvPatchScalarField(), plane::plane(), plenumPressureFvPatchScalarField::plenumPressureFvPatchScalarField(), Polynomial< Type >::Polynomial(), Foam::preservePatchTypes(), pressureFvPatchScalarField::pressureFvPatchScalarField(), pressureInletOutletVelocityFvPatchVectorField::pressureInletOutletVelocityFvPatchVectorField(), pressureReference::pressureReference(), radiationCoupledBase::radiationCoupledBase(), rawSurfaceWriter::rawSurfaceWriter(), tolerances::read(), CrossPowerLaw::read(), Fickian< unityLewisFourier< laminarThermophysicalTransportModel > >::read(), timeControl::read(), BirdCarreau::read(), stopAt::read(), writeLocalObjects::read(), log::read(), fieldsExpression::read(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::read(), writeObjects::read(), kappaEff::read(), functionObjectList::read(), comfort::read(), turbulenceFields::read(), sampledSurfaces::read(), sampledSets::read(), regionSizeDistribution::read(), streamlines::read(), forces::read(), fieldAverage::readAveragingProperties(), LduMatrix< Type, DType, LUType >::solver::readControl(), Time::readDict(), GeometricField< Type, PatchField, GeoMesh >::Boundary::readField(), functionObjectList::readFunctionObject(), liquidProperties::readIfPresent(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), tolerances::relax(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), rigidBodyMotion::rigidBodyMotion(), fvSchemes::schemesDict(), searchableSurfaces::searchableSurfaces(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setCdSigma(), subModelBase::setModelProperty(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficient(), Foam::setRefCell(), sixDoFRigidBodyMotion::sixDoFRigidBodyMotion(), fvSchemes::snGradScheme(), solidBodyMotionDisplacementPointPatchVectorField::solidBodyMotionDisplacementPointPatchVectorField(), supersonicFreestreamFvPatchVectorField::supersonicFreestreamFvPatchVectorField(), surfaceWriter::surfaceWriter(), thermalBaffle1DFvPatchScalarField< solidType >::thermalBaffle1DFvPatchScalarField(), thirdBodyEfficiencies::thirdBodyEfficiencies(), thresholdCellFaces::thresholdCellFaces(), timeVaryingMappedFvPatchField< Type >::timeVaryingMappedFvPatchField(), dictionary::tokens(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::totalFlowRateAdvectiveDiffusiveFvPatchScalarField(), totalTemperatureFvPatchScalarField::totalTemperatureFvPatchScalarField(), transferModelList::transferModelList(), 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(), waveAlphaFvPatchScalarField::waveAlphaFvPatchScalarField(), waveDisplacementPointPatchVectorField::waveDisplacementPointPatchVectorField(), waveInletOutletFvPatchField< Type >::waveInletOutletFvPatchField(), wavePressureFvPatchScalarField::wavePressureFvPatchScalarField(), waveVelocityFvPatchVectorField::waveVelocityFvPatchVectorField(), wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField(), and jobInfo::write().
| 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 682 of file dictionary.C.
References dictionary::lookupEntryPtr(), and dictionary::null.
Referenced by dynamicCodeContext::dynamicCodeContext(), dictionary::found(), dictionary::isDict(), dictionary::lookupEntry(), dictionary::lookupEntryPtr(), dictionary::lookupEntryPtrBackwardsCompatible(), entry::New(), coordinateSystem::New(), dictionary::optionalSubDict(), functionObjectList::read(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), dictionary::set(), dictionary::subDict(), dictionary::subDictPtr(), dictionary::subOrEmptyDict(), dictionary::substituteKeyword(), Foam::debug::switchSet(), and solution::upgradeSolverDict().
| 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 721 of file dictionary.C.
References dictionary::lookupEntryPtr(), dictionary::lookupEntryPtrBackwardsCompatible(), and dictionary::null.
| 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 765 of file dictionary.C.
References Foam::endl(), forAll, IOWarningInFunction, entry::keyword(), dictionary::lookupEntry(), dictionary::lookupEntryPtr(), and dictionaryName::name().
Referenced by dictionary::lookupEntryBackwardsCompatible(), dictionary::lookupEntryPtr(), radiationModel::New(), and phaseChangeModel::New().
| 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 801 of file dictionary.C.
References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::lookupEntryBackwardsCompatible(), dictionary::lookupEntryPtr(), and dictionaryName::name().
Referenced by lduMatrix::smoother::getName(), lduMatrix::preconditioner::getName(), Foam::listSwitches(), dictionary::lookup(), dictionary::lookupEntryBackwardsCompatible(), dictionary::lookupEntryPtrBackwardsCompatible(), lduMatrix::smoother::New(), and lduMatrix::preconditioner::New().
| 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 822 of file dictionary.C.
References dictionary::lookup(), dictionary::lookupEntry(), and dictionary::lookupEntryPtrBackwardsCompatible().
Referenced by dictionary::lookupBackwardsCompatible(), dictionary::lookupEntry(), heatTransferModel::New(), momentumTransportModel::New(), and viscosityModel::New().
| 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 844 of file dictionary.C.
References dictionary::lookupBackwardsCompatible(), dictionary::lookupEntry(), and entry::stream().
Referenced by activePressureForceBaffleVelocityFvPatchVectorField::activePressureForceBaffleVelocityFvPatchVectorField(), advectiveFvPatchField< Type >::advectiveFvPatchField(), bladeModel::bladeModel(), BreakupModel< Foam::SprayCloud< Foam::DSMCCloud > >::BreakupModel(), cellModel::cellModel(), motionSmootherAlgo::checkMesh(), Constant< Type >::Constant(), molecule::constantProperties::constantProperties(), forces::createFileNames(), cuboid::cuboid(), cuttingPlane::cuttingPlane(), fvSchemes::d2dt2Scheme(), fvSchemes::ddtScheme(), decompositionMethod::decompositionMethod(), forces::devTau(), dimensioned< vector >::dimensioned(), Foam::dimensionedConstant(), directions::directions(), argList::displayDoc(), distanceSurface::distanceSurface(), fvSchemes::divScheme(), ejectionModelList::ejectionModelList(), Embedded< Type >::Embedded(), EulerCoordinateRotation::EulerCoordinateRotation(), exponentialSolidTransport< Thermo >::exponentialSolidTransport(), externalWallHeatFluxTemperatureFvPatchScalarField::externalWallHeatFluxTemperatureFvPatchScalarField(), extrudePatchMesh::extrudePatchMesh(), Field< PointType >::Field(), fluxLimitedLangmuirHinshelwoodReactionRate::fluxLimitedLangmuirHinshelwoodReactionRate(), forceList::forceList(), FreeStream< CloudType >::FreeStream(), fvConstraints::fvConstraints(), fvModels::fvModels(), lduMatrix::smoother::getName(), lduMatrix::preconditioner::getName(), fvSchemes::gradScheme(), absorptionCoeffs::initialise(), volFieldValue::initialise(), surfaceFieldValue::initialise(), InjectionModel< CloudType >::InjectionModel(), InjectionModelList< Foam::MomentumCloud< CloudType > >::InjectionModelList(), fvSchemes::interpolationScheme(), ISAT< ThermoType >::ISAT(), laminarFlameSpeed::laminarFlameSpeed(), laminarThermophysicalTransportModel< laminarThermophysicalTransportModel >::laminarThermophysicalTransportModel(), fvSchemes::laplacianScheme(), layerParameters::layerParameters(), LESThermophysicalTransportModel< BasicThermophysicalTransportModel >::LESThermophysicalTransportModel(), Foam::MULES::limiterCorr(), basicThermo::lookupCstrIter(), dictionary::lookupEntryBackwardsCompatible(), dimensioned< vector >::lookupOrDefault(), lookupProfile::lookupProfile(), mappedPatchBase::mappedPatchBase(), mappedPatchFieldBase< Type >::mappedPatchFieldBase(), meanVelocityForce::meanVelocityForce(), MGridGenGAMGAgglomeration::MGridGenGAMGAgglomeration(), medialAxisMeshMover::move(), forces::mu(), multiDirRefinement::multiDirRefinement(), NamedEnum< compressibleField, 8 >::names(), nastranSurfaceWriter::nastranSurfaceWriter(), CorrectionLimitingMethod::New(), TableReader< scalar >::New(), motionSolver::New(), scatterModel::New(), surfaceFilmModel::New(), energyScalingFunction::New(), generalisedNewtonianViscosityModel::New(), decompositionMethod::New(), renumberMethod::New(), ParticleStressModel::New(), profileModel::New(), sootModel::New(), extrudeModel::New(), interpolation< Foam::Vector >::New(), absorptionEmissionModel::New(), DispersionModel< Foam::MomentumCloud< CloudType > >::New(), waveModel::New(), engineMesh::New(), LESdelta::New(), TimeScaleModel::New(), tetherPotential::New(), AtomisationModel< Foam::SprayCloud< Foam::DSMCCloud > >::New(), PairModel< Foam::DSMCCloud >::New(), trimModel::New(), WallModel< Foam::DSMCCloud >::New(), BinaryCollisionModel< Foam::DSMCCloud< ParcelType > >::New(), WallInteractionModel< Foam::DSMCCloud< ParcelType > >::New(), InflowBoundaryModel< Foam::DSMCCloud< ParcelType > >::New(), surfaceWriter::New(), solidBodyMotionFunction::New(), HeatTransferModel< Foam::ThermoCloud< CloudType > >::New(), patchDistMethod::New(), Function1< Foam::Vector2D >::New(), Function2< scalar >::New(), CollisionModel< Foam::CollidingCloud< Foam::DSMCCloud > >::New(), laminarFlameSpeed::New(), DevolatilisationModel< Foam::ReactingMultiphaseCloud< Foam::DSMCCloud > >::New(), entry::New(), parcelCloud::New(), pairPotential::New(), StochasticCollisionModel< Foam::MomentumCloud< CloudType > >::New(), IsotropyModel< Foam::MPPICCloud< CloudType > >::New(), SurfaceReactionModel< Foam::ReactingMultiphaseCloud< Foam::DSMCCloud > >::New(), sixDoFRigidBodyMotionRestraint::New(), barotropicCompressibilityModel::New(), DampingModel< Foam::MPPICCloud< CloudType > >::New(), twoPhaseChangeModel::New(), LESfilter::New(), BreakupModel< Foam::SprayCloud< Foam::DSMCCloud > >::New(), reactionRateFlameArea::New(), PackingModel< Foam::MPPICCloud< CloudType > >::New(), CompositionModel< Foam::ThermoCloud< CloudType > >::New(), viscosityModel::New(), integrationScheme::New(), ParticleForce< Foam::DSMCCloud >::New(), sixDoFRigidBodyMotionConstraint::New(), AveragingMethod< Foam::Vector >::New(), regionModelFunctionObject::New(), distributionModel::New(), SRFModel::New(), combustionModel::New(), PatchInteractionModel< Foam::MomentumCloud< CloudType > >::New(), polyMeshModifier::New(), coordinateRotation::New(), rigidBody::New(), solidProperties::New(), surfaceTensionModel::New(), rigidBodySolver::New(), heatTransferModel::New(), restraint::New(), PhaseChangeModel< Foam::ReactingCloud< Foam::DSMCCloud > >::New(), fieldValue::New(), dynamicFvMesh::New(), liquidProperties::New(), ODESolver::New(), sixDoFSolver::New(), fvConstraint::New(), Reaction< ReactionThermo >::New(), SurfaceFilmModel< Foam::MomentumCloud< CloudType > >::New(), radiationModel::New(), sampledSet::New(), cellZone::New(), coordinateSystem::New(), pointZone::New(), porosityModel::New(), lduMatrix::solver::New(), joint::New(), LduMatrix< Type, DType, LUType >::solver::New(), fvModel::New(), InjectionModel< CloudType >::New(), sampledSurface::New(), faceZone::New(), pointPatchField< vector >::New(), fvsPatchField< Type >::New(), fvPatchField< Type >::New(), polyPatch::New(), functionObject::New(), LduMatrix< Type, DType, LUType >::smoother::New(), lduMatrix::smoother::New(), LduMatrix< Type, DType, LUType >::preconditioner::New(), lduMatrix::preconditioner::New(), decomposedBlockData::numBlocks(), dlLibraryTable::open(), multivariateIndependentScheme< Type >::operator()(), axesRotation::operator=(), Foam::operator>>(), dictionary::operator[](), Pa::Pa(), argList::parse(), patchInternalField::patchInternalField(), plane::plane(), plenumPressureFvPatchScalarField::plenumPressureFvPatchScalarField(), Polynomial< Type >::Polynomial(), pressureReference::pressureReference(), Ra::Ra(), RASThermophysicalTransportModel< BasicThermophysicalTransportModel >::RASThermophysicalTransportModel(), rawSurfaceWriter::rawSurfaceWriter(), reaction::reaction(), HerschelBulkley::read(), powerLaw::read(), tolerances::read(), exponentialRepulsion::read(), lennardJones::read(), harmonicSpring::read(), anisotropicFilter::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), laplaceFilter::read(), dampedCoulomb::read(), sigmoid::read(), randomise::read(), uniform::read(), scale::read(), doubleSigmoid::read(), azizChen::read(), relaxation::read(), thermalBaffle::read(), maitlandSmith::read(), Casson::read(), writeDictionary::read(), CrossPowerLaw::read(), timeControl::read(), BirdCarreau::read(), stopAt::read(), cloudSolution::read(), consumptionSpeed::read(), residuals::read(), removeRegisteredObject::read(), timeActivatedFileUpdate::read(), cloudInfo::read(), stopAtClockTime::read(), reactionRateFlameArea::read(), log::read(), patchProbes::read(), readFields::read(), surfaceInterpolate::read(), sixDoFRigidBodyControl::read(), writeObjectsBase::read(), fieldCoordinateSystemTransform::read(), fieldsExpression::read(), volRegion::read(), fvCellSet::read(), fieldValue::read(), interfaceHeight::read(), histogram::read(), writeObjects::read(), dimensioned< vector >::read(), fieldValueDelta::read(), inhomogeneousMixture< ThermoType >::read(), nearWallFields::read(), egrMixture< ThermoType >::read(), forceCoeffs::read(), probes::read(), porosityModel::read(), MRFZone::read(), turbulenceFields::read(), sampledSurfaces::read(), sampledSets::read(), regionSizeDistribution::read(), streamlines::read(), sixDoFRigidBodyMotion::read(), pressure::read(), fieldAverage::read(), forces::read(), fieldAverage::readAveragingProperties(), LduMatrix< Type, DType, LUType >::solver::readControl(), singleRegionCorrectorConvergenceControl::readCorrResidualControls(), constant::readDict(), Time::readDict(), DimensionedField< Type, Foam::pointMesh >::readField(), IOobject::readHeader(), mappedPatchBase::readListOrField(), ensightPart::reconstruct(), refinementParameters::refinementParameters(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), tolerances::relaxationFactor(), boundaryRegion::rename(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), rigidBodyMotion::rigidBodyMotion(), thermalBaffleFvPatchScalarField::rmap(), motionSmootherAlgo::scaleMesh(), fvSchemes::schemesDict(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), seriesProfile::seriesProfile(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setCdSigma(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficient(), Foam::setRefCell(), slidingInterface::slidingInterface(), fvSchemes::snGradScheme(), tolerances::solverRelativeTolerance(), tolerances::solverTolerance(), sphere::sphere(), STARCDCoordinateRotation::STARCDCoordinateRotation(), dictionaryEntry::stream(), surfaceFeatures::surfaceFeatures(), surfacePatchIOList::surfacePatchIOList(), surfaceWriter::surfaceWriter(), surfaceZonesInfo::surfaceZonesInfo(), surfZoneIOList::surfZoneIOList(), ThermophysicalTransportModel< Foam::PhaseCompressibleMomentumTransportModel, transportThermoModel >::ThermophysicalTransportModel(), thermoSingleLayer::thermoSingleLayer(), thirdBodyEfficiencies::thirdBodyEfficiencies(), transferModelList::transferModelList(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::turbulentTemperatureRadCoupledMixedFvPatchScalarField(), UniformDimensionedField< vector >::UniformDimensionedField(), Foam::unitSet(), dynamicRefineFvMesh::update(), WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), waveSuperposition::waveSuperposition(), wideBand::wideBand(), thermalBaffleFvPatchScalarField::write(), and medialAxisMeshMover::~medialAxisMeshMover().
| 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 855 of file dictionary.C.
References dictionary::lookupEntryBackwardsCompatible(), dictionary::lookupScopedEntryPtr(), and entry::stream().
Referenced by dictionary::lookup(), basicChemistryModel::New(), laminarModel< BasicMomentumTransportModel >::New(), RASModel< phaseCompressible::momentumTransportModel >::New(), LESModel< BasicMomentumTransportModel >::New(), and plane::plane().
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::lookupBackwardsCompatible(), Foam::name(), entry::stream(), and T.
| 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 57 of file dictionaryTemplates.C.
References dictionary::lookupOrDefault(), entry::stream(), and T.
| 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 80 of file dictionaryTemplates.C.
References Foam::endl(), IOInfoInFunction, dictionary::lookupOrDefaultBackwardsCompatible(), entry::stream(), and T.
Referenced by atmBoundaryLayerInletEpsilonFvPatchScalarField::atmBoundaryLayerInletEpsilonFvPatchScalarField(), atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), atmBoundaryLayerInletVelocityFvPatchVectorField::atmBoundaryLayerInletVelocityFvPatchVectorField(), subModelBase::defaultCoeffs(), EulerCoordinateRotation::EulerCoordinateRotation(), fieldAverageItem::fieldAverageItem(), fixedMeanOutletInletFvPatchField< Type >::fixedMeanOutletInletFvPatchField(), fluxLimitedLangmuirHinshelwoodReactionRate::fluxLimitedLangmuirHinshelwoodReactionRate(), freestreamFvPatchField< Type >::freestreamFvPatchField(), fvDOM::fvDOM(), Foam::hydrostaticInitialisation(), inletOutletTotalTemperatureFvPatchScalarField::inletOutletTotalTemperatureFvPatchScalarField(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), dictionary::lookupBackwardsCompatible(), wallHeatTransferCoeffModel::New(), engineTime::New(), basicChemistryModel::New(), thermalBaffleModel::New(), pointPatchField< vector >::New(), fvsPatchField< Type >::New(), fvPatchField< Type >::New(), GAMGAgglomeration::New(), Foam::operator>>(), argList::parse(), ReactionList< Foam::sutherlandTransport >::ReactionList(), nonOrthogonalSolutionControl::read(), Qdot::read(), pisoControl::read(), totalEnthalpy::read(), shearStress::read(), blendingFactor::read(), fluidSolutionControl::read(), CourantNo::read(), pimpleNoLoopControl::read(), timeControl::read(), BirdCarreau::read(), cloudSolution::read(), scalarTransport::read(), rigidBodyState::read(), sixDoFRigidBodyState::read(), log::read(), wallHeatFlux::read(), targetCoeffTrim::read(), writeObjectsBase::read(), wallShearStress::read(), histogram::read(), age::read(), wallHeatTransferCoeff::read(), writeObjects::read(), rigidBodyMotion::read(), phaseScalarTransport::read(), functionObjectList::read(), comfort::read(), turbulenceFields::read(), functionObject::read(), streamlines::read(), sixDoFRigidBodyMotion::read(), pressure::read(), fieldAverage::read(), forces::read(), temperatureDependent::readDict(), functionObjectList::readFunctionObject(), IOobject::readHeader(), refinementSurfaces::refinementSurfaces(), Time::setControls(), slidingInterface::setTolerances(), fvMatrix< Type >::solve(), SRFFreestreamVelocityFvPatchVectorField::SRFFreestreamVelocityFvPatchVectorField(), STARCDCoordinateRotation::STARCDCoordinateRotation(), turbulentIntensityKineticEnergyInletFvPatchScalarField::turbulentIntensityKineticEnergyInletFvPatchScalarField(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::turbulentMixingLengthDissipationRateInletFvPatchScalarField(), turbulentMixingLengthFrequencyInletFvPatchScalarField::turbulentMixingLengthFrequencyInletFvPatchScalarField(), Foam::unitSet(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), and medialAxisMeshMover::~medialAxisMeshMover().
| 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 110 of file dictionaryTemplates.C.
References dictionary::lookupOrAddDefault(), entry::stream(), and T.
Referenced by dictionary::lookupOrDefault(), and pimpleNoLoopControl::read().
| 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 134 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::lookupOrDefaultBackwardsCompatible(), Foam::debug::optimisationSwitch(), and Foam::debug::wordOptimisationSwitch().
| 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 165 of file dictionaryTemplates.C.
References Foam::endl(), IOInfoInFunction, and entry::stream().
Referenced by advectiveFvPatchField< Type >::advectiveFvPatchField(), motionSmootherAlgo::checkMesh(), fvMotionSolverEngineMesh::fvMotionSolverEngineMesh(), subModelBase::getBaseProperty(), subModelBase::getModelProperty(), kinematicSingleLayer::info(), volFieldValue::initialise(), surfaceFieldValue::initialise(), layeredEngineMesh::layeredEngineMesh(), layerParameters::layerParameters(), linearNormal::linearNormal(), dictionary::lookupOrAddDefault(), polyPatch::New(), axesRotation::operator=(), patchIdentifier::patchIdentifier(), Foam::preservePatchTypes(), profileModel::profileModel(), cubeRootVolDelta::read(), maxDeltaxyz::read(), vanDriestDelta::read(), IDDESDelta::read(), PrandtlDelta::read(), cloudSolution::read(), time::read(), scalarTransport::read(), stopAtFile::read(), fvDOM::read(), systemCall::read(), interfaceHeight::read(), phaseScalarTransport::read(), probes::read(), regionSizeDistribution::read(), streamlines::read(), pressure::read(), fieldAverage::read(), forces::read(), Time::readDict(), IOobject::readHeader(), solidProperties::readIfPresent(), thermophysicalProperties::readIfPresent(), Switch::readIfPresent(), dimensioned< vector >::readIfPresent(), liquidProperties::readIfPresent(), ensightPart::reconstruct(), refinementSurfaces::refinementSurfaces(), sampledSurface::sampledSurface(), searchableSurfaces::searchableSurfaces(), Time::setControls(), Time::setTime(), fvMatrix< Type >::solve(), surfaceZonesInfo::surfaceZonesInfo(), surfZoneIdentifier::surfZoneIdentifier(), surfZoneIOList::surfZoneIOList(), thermoSingleLayer::thermoSingleLayer(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), triSurfaceMesh::triSurfaceMesh(), and triSurfaceSearch::triSurfaceSearch().
| 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 '/' with special handling for '!' and '..'.
Definition at line 871 of file dictionary.C.
References inputSyntaxEntry::dot(), dictionary::null, and inputSyntaxEntry::slash().
Referenced by Foam::stringOps::getVariable(), Foam::stringOps::inplaceExpand(), dictionary::lookupBackwardsCompatible(), entry::New(), Foam::blockMeshTools::read(), dictionary::scopedDict(), and dictionary::substituteScopedKeyword().
| bool isDict | ( | const word & | keyword | ) | const |
Check if entry is a sub-dictionary.
Definition at line 936 of file dictionary.C.
References entry::isDict(), and dictionary::lookupEntryPtr().
Referenced by ejectionModelList::ejectionModelList(), forceList::forceList(), liquidMixtureProperties::liquidMixtureProperties(), basicThermo::lookupCstrIter(), Function1< Foam::Vector2D >::New(), Function2< scalar >::New(), basicChemistryModel::New(), surfaceTensionModel::New(), constant::readDict(), functionObjectList::readFunctionObject(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), solidMixtureProperties::solidMixtureProperties(), thermophysicalPropertiesSelector< ThermophysicalProperties >::thermophysicalPropertiesSelector(), transferModelList::transferModelList(), and dynamicRefineFvMesh::update().
| const Foam::dictionary * subDictPtr | ( | const word & | keyword | ) | const |
Find and return a sub-dictionary pointer if present.
otherwise return nullptr.
Definition at line 952 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().
| Foam::dictionary * subDictPtr | ( | const word & | keyword | ) |
Find and return a sub-dictionary pointer if present.
otherwise return nullptr.
Definition at line 967 of file dictionary.C.
References entry::dict(), and dictionary::lookupEntryPtr().
| const Foam::dictionary & subDict | ( | const word & | keyword | ) | const |
Find and return a sub-dictionary.
Definition at line 982 of file dictionary.C.
References entry::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::lookupEntryPtr(), and dictionaryName::name().
Referenced by sixDoFRigidBodyMotion::addConstraints(), snappyLayerDriver::addLayers(), Foam::AddPatchFields(), sixDoFRigidBodyMotion::addRestraints(), CloudFunctionObjectList< MomentumCloud< CloudType > >::CloudFunctionObjectList(), forces::createFileNames(), decompositionMethod::decompositionMethod(), multiRegionSolutionControl::dict(), singleRegionSolutionControl::dict(), Foam::dimensionedConstant(), directions::directions(), argList::displayDoc(), fvMeshDistribute::distribute(), ejectionModelList::ejectionModelList(), includeEntry::execute(), includeEtcEntry::execute(), exponentialSolidTransport< Thermo >::exponentialSolidTransport(), forceList::forceList(), subModelBase::getBaseProperty(), subModelBase::getModelProperty(), cloudSolution::integrationSchemes(), cloudSolution::interpolationSchemes(), laminarThermophysicalTransportModel< laminarThermophysicalTransportModel >::laminarThermophysicalTransportModel(), layerParameters::layerParameters(), LESThermophysicalTransportModel< BasicThermophysicalTransportModel >::LESThermophysicalTransportModel(), liquidMixtureProperties::liquidMixtureProperties(), Foam::listSwitches(), basicThermo::lookupCstrIter(), NamedEnum< compressibleField, 8 >::names(), radiationModel::New(), heatTransferModel::New(), momentumTransportModel::New(), viscosityModel::New(), Function2< scalar >::New(), Function1< Foam::Vector2D >::New(), chemistryTabulationMethod< ThermoType >::New(), phaseChangeModel::New(), basicChemistryModel::New(), chemistryReductionMethod< ThermoType >::New(), regionModelFunctionObject::New(), laminarModel< BasicMomentumTransportModel >::New(), RASModel< phaseCompressible::momentumTransportModel >::New(), LESModel< BasicMomentumTransportModel >::New(), functionObjectList::New(), coordinateSystem::New(), parcelThermo::parcelThermo(), plane::plane(), Foam::preservePatchTypes(), fvMeshDistribute::printFieldInfo(), profileModelList::profileModelList(), RASThermophysicalTransportModel< BasicThermophysicalTransportModel >::RASThermophysicalTransportModel(), ReactionList< Foam::sutherlandTransport >::ReactionList(), tolerances::read(), exponentialRepulsion::read(), lennardJones::read(), harmonicSpring::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), dampedCoulomb::read(), sigmoid::read(), doubleSigmoid::read(), porosityModelList::read(), azizChen::read(), maitlandSmith::read(), Fickian< unityLewisFourier< laminarThermophysicalTransportModel > >::read(), cloudSolution::read(), pureMixture< ThermoType >::read(), singleComponentMixture< ThermoType >::read(), homogeneousMixture< ThermoType >::read(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::read(), MRFZoneList::read(), fieldValueDelta::read(), inhomogeneousMixture< ThermoType >::read(), veryInhomogeneousMixture< ThermoType >::read(), egrMixture< ThermoType >::read(), streamlines::read(), forces::read(), fieldAverage::readAveragingProperties(), constant::readDict(), GeometricField< Type, PatchField, GeoMesh >::Boundary::readField(), functionObjectList::readFunctionObject(), liquidProperties::readIfPresent(), refinementSurfaces::refinementSurfaces(), rigidBodyMeshMotion::rigidBodyMeshMotion(), rigidBodyMeshMotionSolver::rigidBodyMeshMotionSolver(), rigidBodyModel::rigidBodyModel(), fvSchemes::schemesDict(), searchableSurfaceCollection::searchableSurfaceCollection(), searchableSurfaces::searchableSurfaces(), subModelBase::setBaseProperty(), subModelBase::setModelProperty(), surfaceTensionModel::sigmaDict(), solidMixtureProperties::solidMixtureProperties(), displacementLayeredMotionMotionSolver::solve(), cloudSolution::sourceTermDict(), thermophysicalPropertiesSelector< ThermophysicalProperties >::thermophysicalPropertiesSelector(), transferModelList::transferModelList(), Foam::unitSet(), dynamicRefineFvMesh::update(), wideBand::wideBand(), thermalBaffleFvPatchScalarField::write(), and fieldAverage::writeAveragingProperties().
| Foam::dictionary & subDict | ( | const word & | keyword | ) |
Find and return a sub-dictionary for manipulation.
Definition at line 997 of file dictionary.C.
References entry::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::lookupEntryPtr(), dictionaryName::name(), and dictionary::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 1013 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(), radiationModel::read(), and dictionary::subDict().
| const Foam::dictionary & optionalSubDict | ( | const word & | keyword | ) | const |
Find and return a sub-dictionary if found.
otherwise return this dictionary
Definition at line 1040 of file dictionary.C.
References entry::dict(), and dictionary::lookupEntryPtr().
Referenced by solidProperties::New(), sampledSet::New(), plane::plane(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), HerschelBulkley::read(), powerLaw::read(), anisotropicFilter::read(), laplaceFilter::read(), cubeRootVolDelta::read(), strainRateFunction::read(), maxDeltaxyz::read(), IDDESDelta::read(), vanDriestDelta::read(), relaxation::read(), Casson::read(), CrossPowerLaw::read(), trimModel::read(), BirdCarreau::read(), PrandtlDelta::read(), solidBodyMotionFunction::read(), heatTransferModel::read(), fvConstraint::read(), porosityModel::read(), smoothDelta::read(), fvModel::read(), dictionary::subOrEmptyDict(), and dynamicRefineFvMesh::update().
| 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 1057 of file dictionary.C.
References entry::dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, entry::isDict(), dictionary::keys(), dictionary::lookupScopedEntryPtr(), and dictionaryName::name().
Referenced by functionObjectList::readFunctionObject(), and dictionary::scopedDict().
| 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 1086 of file dictionary.C.
References dictionary::scopedDict().
| Foam::wordList toc | ( | ) | const |
Return the table of contents.
Definition at line 1095 of file dictionary.C.
References forAllConstIter(), and dictionary::keys().
Referenced by CloudFunctionObjectList< MomentumCloud< CloudType > >::CloudFunctionObjectList(), removeEntry::execute(), FreeStream< CloudType >::FreeStream(), InjectionModelList< Foam::MomentumCloud< CloudType > >::InjectionModelList(), liquidMixtureProperties::liquidMixtureProperties(), ParticleForceList< MomentumCloud< CloudType > >::ParticleForceList(), profileModelList::profileModelList(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), regionModelFunctionObjectList::regionModelFunctionObjectList(), and solidMixtureProperties::solidMixtureProperties().
| Foam::wordList sortedToc | ( | ) | const |
Return the sorted table of contents.
Definition at line 1109 of file dictionary.C.
Referenced by Foam::listSwitches().
| Foam::List< Foam::keyType > keys | ( | bool | patterns = false | ) | const |
Return the list of available keys or patterns.
Definition at line 1115 of file dictionary.C.
References forAllConstIter(), and List< T >::setSize().
Referenced by dictionary::scopedDict(), and dictionary::toc().
| bool substituteKeyword | ( | const word & | keyword | ) |
Substitute the given keyword prepended by '$' with the.
corresponding sub-dictionary entries
Definition at line 155 of file dictionaryIO.C.
References dictionary::add(), forAllConstIter(), and dictionary::lookupEntryPtr().
| bool substituteScopedKeyword | ( | const word & | keyword | ) |
Substitute the given scoped keyword prepended by '$' with the.
corresponding sub-dictionary entries
Definition at line 912 of file dictionary.C.
References dictionary::add(), forAllConstIter(), and dictionary::lookupScopedEntryPtr().
Referenced by entry::New().
| 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 1133 of file dictionary.C.
References entry::dict(), entry::disableFunctionEntries, 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(), Foam::dimensionedConstant(), includeEntry::execute(), includeEtcEntry::execute(), error::exit(), IOerror::exit(), exponentialSolidTransport< Thermo >::exponentialSolidTransport(), dictionary::merge(), namedBlock::namedBlock(), namedVertex::namedVertex(), entry::New(), basicChemistryModel::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(), sixDoFRigidBodyMotionState::write(), sutherlandTransport< Thermo >::write(), icoTabulatedTransport< Thermo >::write(), rhoConst< Specie >::write(), WLFTransport< Thermo >::write(), polynomialTransport< Thermo, PolySize >::write(), eConstThermo< EquationOfState >::write(), hConstThermo< EquationOfState >::write(), incompressiblePerfectGas< Specie >::write(), polynomialSolidTransport< Thermo, PolySize >::write(), hIcoTabulatedThermo< EquationOfState >::write(), eIcoTabulatedThermo< EquationOfState >::write(), linear< Type >::write(), icoTabulated< Specie >::write(), tabulatedTransport< Thermo >::write(), perfectFluid< Specie >::write(), logPolynomialTransport< Thermo, PolySize >::write(), adiabaticPerfectFluid< Specie >::write(), Boussinesq< Specie >::write(), icoPolynomial< Specie, PolySize >::write(), janafThermo< EquationOfState >::write(), rPolynomial< Specie >::write(), ePolynomialThermo< EquationOfState, PolySize >::write(), hPolynomialThermo< EquationOfState, PolySize >::write(), hTabulatedThermo< EquationOfState >::write(), eTabulatedThermo< EquationOfState >::write(), rhoTabulated< Specie >::write(), fieldAverage::writeAveragingProperties(), surfaceFeatures::writeDict(), and Time::writeTimeDict().
| 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 1225 of file dictionary.C.
References dictionary::add(), and entry::clone().
Add a word entry.
optionally overwrite an existing entry
Definition at line 1231 of file dictionary.C.
References dictionary::add().
Add a string entry.
optionally overwrite an existing entry
Definition at line 1238 of file dictionary.C.
References dictionary::add().
Add a label entry.
optionally overwrite an existing entry
Definition at line 1248 of file dictionary.C.
References dictionary::add().
| void add | ( | const keyType & | k, |
| const scalar | s, | ||
| bool | overwrite = false |
||
| ) |
Add a scalar entry.
optionally overwrite an existing entry
Definition at line 1254 of file dictionary.C.
References dictionary::add().
| 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 1261 of file dictionary.C.
References dictionary::add().
Add a T entry.
optionally overwrite an existing entry
Definition at line 195 of file dictionaryTemplates.C.
References dictionary::add().
| void set | ( | entry * | entryPtr | ) |
Assign a new entry, overwrite any existing entry.
Definition at line 1271 of file dictionary.C.
References dictionary::add(), dictionary::clear(), entry::dict(), entry::isDict(), entry::keyword(), and dictionary::lookupEntryPtr().
Referenced by meshRefinement::addMeshedPatch(), distributedTriSurfaceMesh::distribute(), extrudePatchMesh::extrudePatchMesh(), multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), polyMesh::polyMesh(), functionObjectList::readFunctionObject(), boundaryRegion::rename(), thermalBaffleFvPatchScalarField::rmap(), structuredDecomp::structuredDecomp(), solution::upgradeSolverDict(), and codedFunctionObject::~codedFunctionObject().
| void set | ( | const entry & | e | ) |
Assign a new entry, overwrite any existing entry.
Definition at line 1284 of file dictionary.C.
References entry::clone().
| void set | ( | const keyType & | k, |
| const dictionary & | d | ||
| ) |
Assign a dictionary entry, overwrite any existing entry.
Definition at line 1290 of file dictionary.C.
Assign a T entry, overwrite any existing entry.
Definition at line 202 of file dictionaryTemplates.C.
References Foam::writeEntry().
| bool remove | ( | const word & | Keyword | ) |
Remove an entry specified by keyword.
Definition at line 1296 of file dictionary.C.
References dictionary::changeKeyword(), and UILList< LListBase, T >::remove().
Referenced by removeEntry::execute(), and IOerror::SafeFatalIOError().
| 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 1329 of file dictionary.C.
References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOWarningInFunction, keyType::isPattern(), and dictionaryName::name().
Referenced by dictionary::remove().
| bool merge | ( | const dictionary & | dict | ) |
Merge entries from the given dictionary.
Also merge sub-dictionaries as required.
Definition at line 1418 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(), and functionObjectList::readFunctionObject().
| void clear | ( | ) |
Clear the dictionary.
Definition at line 1463 of file dictionary.C.
References ILList< LListBase, T >::clear().
Referenced by includeEntry::execute(), includeEtcEntry::execute(), entry::New(), dictionary::operator=(), Foam::operator>>(), strainRateFunction::read(), and dictionary::set().
| void transfer | ( | dictionary & | dict | ) |
Transfer the contents of the argument and annul the argument.
Definition at line 1472 of file dictionary.C.
References dictionaryName::name(), and ILList< LListBase, T >::transfer().
Referenced by Foam::operator>>().
| bool read | ( | Istream & | is, |
| const bool | keepHeader = false |
||
| ) |
Read dictionary from Istream, optionally keeping the header.
Definition at line 104 of file dictionaryIO.C.
References IOstream::bad(), token::BEGIN_BLOCK, Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOobject::foamFile, IOstream::good(), InfoInFunction, dictionaryName::name(), entry::New(), and Istream::putBack().
Referenced by dictionary::dictionary(), includeIfPresentEntry::execute(), includeEntry::execute(), includeEtcEntry::execute(), dictionary::includedDictionary::includedDictionary(), functionEntry::insert(), Foam::operator>>(), vanDriestDelta::read(), PrandtlDelta::read(), and smoothDelta::read().
|
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 dictionary::includedDictionary, fvModels, fvConstraints, IOdictionary, and localIOdictionary.
Definition at line 149 of file dictionaryIO.C.
| void write | ( | Ostream & | os, |
| const bool | subDict = true |
||
| ) | const |
Write dictionary, normally with sub-dictionary formatting.
Definition at line 207 of file dictionaryIO.C.
References token::BEGIN_BLOCK, Foam::decrIndent(), Foam::e, token::END_BLOCK, Foam::endl(), forAllConstIter(), IOstream::good(), Foam::incrIndent(), Foam::indent(), UILList< LListBase, T >::last(), dictionaryName::name(), Foam::nl, dictionary::null, dictionary::parent(), and WarningInFunction.
Referenced by Foam::operator<<(), functionObjectList::readFunctionObject(), dictionary::tokens(), dictionaryListEntry::write(), dictionaryEntry::write(), fieldDictionary::writeData(), IOdictionary::writeData(), fvConstraints::writeData(), fvModels::writeData(), surfaceFeatures::writeDict(), and jobInfo::~jobInfo().
| Foam::ITstream & operator[] | ( | const word & | keyword | ) | const |
Find and return entry.
Definition at line 1487 of file dictionary.C.
References dictionary::lookup().
| void operator= | ( | const dictionary & | rhs | ) |
Definition at line 1493 of file dictionary.C.
References Foam::abort(), dictionary::add(), dictionary::clear(), dictionary::clone(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter(), and dictionaryName::name().
Referenced by dictionary::dictionary(), IOdictionary::IOdictionary(), and IOdictionary::operator=().
| void operator= | ( | dictionary && | rhs | ) |
Definition at line 1516 of file dictionary.C.
References Foam::abort(), Foam::FatalIOError, FatalIOErrorInFunction, dictionaryName::name(), ILList< LListBase, T >::operator=(), and dictionaryName::operator=().
| void operator+= | ( | const dictionary & | rhs | ) |
Include entries from the given dictionary.
Warn, but do not overwrite existing entries.
Definition at line 1534 of file dictionary.C.
References Foam::abort(), dictionary::add(), dictionary::clone(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter(), and dictionaryName::name().
| void operator|= | ( | const dictionary & | rhs | ) |
Conditionally include entries from the given dictionary.
Do not overwrite existing entries.
Definition at line 1551 of file dictionary.C.
References Foam::abort(), dictionary::add(), dictionary::clone(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter(), dictionary::found(), and dictionaryName::name().
| void operator<<= | ( | const dictionary & | rhs | ) |
Unconditionally include entries from the given dictionary.
Overwrite existing entries.
Definition at line 1571 of file dictionary.C.
References Foam::abort(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter(), and dictionaryName::name().
|
friend |
Declare friendship with the entry class for IO.
Definition at line 226 of file dictionary.H.
|
friend |
Read dictionary from Istream.
|
friend |
Write dictionary to Ostream.
|
static |
Null dictionary.
Definition at line 242 of file dictionary.H.
Referenced by cellModel::cellModel(), entry::clone(), Fourier< BasicThermophysicalTransportModel >::coeffDict(), unityLewisFourier< laminarThermophysicalTransportModel >::coeffDict(), Stokes< BasicMomentumTransportModel >::coeffDict(), primitiveEntry::dict(), Foam::dimensionedConstant(), ejectionModelList::ejectionModelList(), forceList::forceList(), dictionary::found(), dictionary::lookupEntryPtr(), dictionary::lookupScopedEntryPtr(), meanVelocityForce::meanVelocityForce(), entry::New(), functionObjectList::New(), lduMatrix::preconditioner::New(), motionSolver::iNew::operator()(), phase::iNew::operator()(), sizeGroup::iNew::operator()(), Foam::operator>>(), phaseProperties::phaseProperties(), primitiveEntry::primitiveEntry(), functionObjectList::readFunctionObject(), transferModelList::transferModelList(), and dictionary::write().
|
static |
If true write optional keywords and values.
if not present in dictionary
Definition at line 246 of file dictionary.H.
1.8.13 
