Skip to content

Improve documentation and comments in dictionary implementation #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VISHRUT86 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve documentation and comments in dictionary implementation #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 40 additions & 5 deletions src/OpenFOAM/db/dictionary/dictionary.C
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,19 @@ License

// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //

// Look up an entry using a scoped keyword.
//
// The keyword may contain:
// - '/' to traverse into sub-dictionaries
// - '.' to refer to the current dictionary
// - '..' to refer to the parent dictionary
// - '!' to indicate lookup from the top-level dictionary
//
// If recursive is enabled, the lookup will continue into parent
// dictionaries when the entry is not found locally.
// Pattern matching can be enabled to allow wildcard keywords.


const Foam::entry* Foam::dictionary::lookupScopedSubEntryPtr
(
const word& keyword,
Expand All @@ -44,9 +57,10 @@ const Foam::entry* Foam::dictionary::lookupScopedSubEntryPtr

if (emarkPos == string::npos || emarkPos == 0)
{
// Lookup in this dictionary
// No '!' found (or it appears at the first position):
// perform lookup within the current dictionary scope

string::size_type slashPos = keyword.find('/');
string::size_type slashPos = keyword.find('/');

if (slashPos == string::npos)
{
Expand Down Expand Up @@ -114,8 +128,10 @@ const Foam::entry* Foam::dictionary::lookupScopedSubEntryPtr
}
else
{
// Lookup in the dictionary specified by file name
// created from the part of the keyword before the '!'
// '!' found in keyword:
// Perform lookup in an external dictionary file specified
// by the portion of the keyword before the '!'


fileName fName = keyword.substr(0, emarkPos);

Expand Down Expand Up @@ -160,6 +176,13 @@ const Foam::entry* Foam::dictionary::lookupScopedSubEntryPtr
return entryPtr->clone(*this).ptr();
}
}
//---------------------------------------------------------------------------

// Search for a keyword in the list of pattern entries.
//
// If patternMatch is enabled, regular expressions are used
// to match the keyword. Otherwise, an exact keyword match
// is performed.


bool Foam::dictionary::findInPatterns
Expand Down Expand Up @@ -193,6 +216,13 @@ bool Foam::dictionary::findInPatterns
}


//---------------------------------------
// Search for a keyword in the list of pattern entries.
//
// If patternMatch is enabled, regular expressions are used
// to match the keyword. Otherwise, an exact keyword match
// is performed.

bool Foam::dictionary::findInPatterns
(
const bool patternMatch,
Expand Down Expand Up @@ -240,6 +270,11 @@ void Foam::dictionary::assertNoConvertUnits
}
}

//-------------------------------------------------------
// Read a value of type T from the input stream and apply unit conversion.
//
// Units may be specified either before or after the value.
// The read value is converted to standard units before being returned.

template<class T>
T Foam::dictionary::readTypeAndConvertUnits
Expand Down Expand Up @@ -1315,7 +1350,7 @@ bool Foam::dictionary::merge(const dictionary& dict)
if (fnd != hashedEntries_.end())
{
// Recursively merge sub-dictionaries
// TODO: merge without copying
// TODO: Optimise merge to avoid unnecessary copying of entries
if (fnd()->isDict() && iter().isDict())
{
if (fnd()->dict().merge(iter().dict()))
Expand Down