Abstract base class for providing faceAreaWeight values to the cell motion controller based on an argument faceAreaFraction value, typically the ratio of the area of the face in question to the area of a square face with a side length of the local target cell size.
More...
|
| TypeName ("faceAreaWeightModel") |
| Runtime type information. More...
|
|
| declareRunTimeSelectionTable (autoPtr, faceAreaWeightModel, dictionary,(const dictionary &faceAreaWeightDict),(faceAreaWeightDict)) |
|
| faceAreaWeightModel (const word &type, const dictionary &faceAreaWeightDict) |
| Construct from components. More...
|
|
virtual | ~faceAreaWeightModel ()=default |
| Destructor. More...
|
|
const dictionary & | coeffDict () const |
| Const access to the coeffs dictionary. More...
|
|
virtual scalar | faceAreaWeight (scalar faceAreaFraction) const =0 |
| Return the current faceAreaWeight coefficient. More...
|
|
| 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 &is, bool keepHeader=false) |
|
| dictionary (Istream &is) |
|
| dictionary (Istream &is, bool keepHeader) |
|
| dictionary (const dictionary &parentDict, const dictionary &dict) |
| Copy construct given the parent dictionary. More...
|
|
| dictionary (const dictionary &dict) |
| Copy construct top-level dictionary. More...
|
|
| dictionary (const dictionary *dict) |
| Construct top-level dictionary as copy from pointer to dictionary. More...
|
|
| dictionary (const dictionary &parentDict, dictionary &&dict) |
| Move construct for given parent dictionary. More...
|
|
| dictionary (dictionary &&dict) |
| Move construct top-level dictionary. More...
|
|
autoPtr< dictionary > | clone () const |
| Construct and return clone. More...
|
|
virtual | ~dictionary () |
| Destructor. More...
|
|
const fileName & | name () const |
| The dictionary name. More...
|
|
fileName & | name () |
| The dictionary name for modification (use with caution). More...
|
|
word | dictName () const |
| The local dictionary name (final part of scoped name) More...
|
|
const dictionary & | parent () const |
| Return the parent dictionary. More...
|
|
const dictionary & | topDict () const |
| Return the top of the tree. More...
|
|
label | startLineNumber () const |
| Return line number of first token in dictionary. More...
|
|
label | endLineNumber () const |
| Return line number of last token in dictionary. More...
|
|
SHA1Digest | digest () const |
| Return the SHA1 digest of the dictionary contents. More...
|
|
tokenList | tokens () const |
| Return the dictionary as a list of tokens. More...
|
|
bool | found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Search for an entry (const access) with the given keyword. More...
|
|
entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find for an entry (non-const access) with the given keyword. More...
|
|
const entry * | findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find an entry (const access) with the given keyword. More...
|
|
const entry * | findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Search for a scoped entry (const access) with the given keyword. More...
|
|
dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary pointer if present. More...
|
|
const dictionary * | findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary pointer if present. More...
|
|
const entry & | lookupEntry (const word &keyword, enum keyType::option matchOpt) const |
| Search for an entry (const access) with the given keyword. More...
|
|
ITstream & | lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
|
template<class T > |
T | get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
|
template<class T > |
T | getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
|
template<class T > |
T | getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
|
template<class T > |
bool | readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const |
|
template<class T > |
bool | readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const |
|
template<class T , class Predicate > |
T | getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
|
template<class T , class Predicate > |
T | getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
|
template<class T , class Predicate > |
T | getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) |
|
template<class T , class Predicate > |
bool | readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const |
|
template<class T , class Predicate > |
bool | readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const |
|
bool | isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Check if entry is found and is a sub-dictionary. More...
|
|
const dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary. More...
|
|
dictionary & | subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary for manipulation. More...
|
|
dictionary & | subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) |
| Find and return a sub-dictionary for manipulation. More...
|
|
dictionary | subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const |
|
const dictionary & | optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Find and return a sub-dictionary, otherwise return this dictionary. More...
|
|
wordList | toc () const |
| Return the table of contents. More...
|
|
wordList | sortedToc () const |
| Return the sorted table of contents. More...
|
|
template<class Compare > |
wordList | sortedToc (const Compare &comp) const |
| Return table of contents sorted using the specified comparator. More...
|
|
List< keyType > | keys (bool patterns=false) const |
| Return the list of available keys or patterns. More...
|
|
bool | substituteKeyword (const word &keyword, bool mergeEntry=false) |
| Substitute the given keyword (which is prefixed by '$') More...
|
|
bool | substituteScopedKeyword (const word &keyword, bool mergeEntry=false) |
| Substitute the given scoped keyword (which is prefixed by '$') More...
|
|
entry * | add (entry *entryPtr, bool mergeEntry=false) |
| Add a new entry. More...
|
|
entry * | add (const entry &e, bool mergeEntry=false) |
| Add an entry. More...
|
|
entry * | add (const keyType &k, const word &v, bool overwrite=false) |
| Add a word entry. More...
|
|
entry * | add (const keyType &k, const string &v, bool overwrite=false) |
| Add a string entry. More...
|
|
entry * | add (const keyType &k, const label v, bool overwrite=false) |
| Add a label entry. More...
|
|
entry * | add (const keyType &k, const scalar v, bool overwrite=false) |
| Add a scalar entry. More...
|
|
entry * | add (const keyType &k, const dictionary &d, bool mergeEntry=false) |
| Add a dictionary entry. More...
|
|
template<class T > |
entry * | add (const keyType &k, const T &v, bool overwrite=false) |
| Add a T entry. More...
|
|
entry * | set (entry *entryPtr) |
| Assign a new entry, overwriting any existing entry. More...
|
|
entry * | set (const entry &e) |
| Assign a new entry, overwriting any existing entry. More...
|
|
entry * | set (const keyType &k, const dictionary &v) |
| Assign a dictionary entry, overwriting any existing entry. More...
|
|
template<class T > |
entry * | set (const keyType &k, const T &v) |
| Assign a T entry, overwriting any existing entry. More...
|
|
bool | remove (const word &keyword) |
| Remove an entry specified by keyword. More...
|
|
bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false) |
| Change the keyword for an entry,. More...
|
|
bool | merge (const dictionary &dict) |
| Merge entries from the given dictionary. More...
|
|
void | clear () |
| Clear the dictionary. More...
|
|
void | transfer (dictionary &dict) |
| Transfer the contents of the argument and annul the argument. More...
|
|
void | checkITstream (const ITstream &is, const word &keyword) const |
|
bool | read (Istream &is) |
| Read dictionary from Istream. More...
|
|
bool | read (Istream &is, bool keepHeader) |
| Read dictionary from Istream, optionally keeping the header. More...
|
|
void | writeEntry (Ostream &os) const |
| Write sub-dictionary with its dictName as its header. More...
|
|
void | writeEntry (const keyType &keyword, Ostream &os) const |
| Write sub-dictionary with the keyword as its header. More...
|
|
void | writeEntries (Ostream &os, const bool extraNewLine=false) const |
| Write dictionary entries. More...
|
|
void | write (Ostream &os, const bool subDict=true) const |
| Write dictionary, normally with sub-dictionary formatting. More...
|
|
const_searcher | csearch (const word &keyword, enum keyType::option=keyType::REGEX) const |
| Search dictionary for given keyword. More...
|
|
const_searcher | search (const word &keyword, enum keyType::option=keyType::REGEX) const |
| Search dictionary for given keyword. More...
|
|
searcher | search (const word &keyword, enum keyType::option=keyType::REGEX) |
| Search dictionary for given keyword. More...
|
|
const_searcher | csearchScoped (const word &keyword, enum keyType::option) const |
| Search using scoping. More...
|
|
const_searcher | searchScoped (const word &keyword, enum keyType::option) const |
| Search using dot or slash scoping. More...
|
|
searcher | searchScoped (const word &keyword, enum keyType::option) |
| Search using dot or slash scoping. More...
|
|
const dictionary * | cfindScopedDict (const fileName &dictPath) const |
| Locate a sub-dictionary using slash-scoping. More...
|
|
const dictionary * | findScopedDict (const fileName &dictPath) const |
| Locate a sub-dictionary using slash-scoping. More...
|
|
dictionary * | findScopedDict (const fileName &dictPath) |
| Locate a sub-dictionary using slash-scoping. More...
|
|
dictionary * | makeScopedDict (const fileName &dictPath) |
| Locate existing or create sub-dictionary using slash-scoping. More...
|
|
const_searcher | csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const |
| Search dictionary for given keyword and any compatibility names. More...
|
|
bool | foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const |
| Search dictionary for given keyword and any compatibility names. More...
|
|
const entry * | findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const |
|
const entry & | lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const |
|
ITstream & | lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const |
|
template<class T > |
T | getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const |
|
template<class T > |
T | getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const |
|
template<class T > |
bool | readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const |
|
template<class T > |
bool | readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const |
|
void | operator= (const dictionary &rhs) |
| Copy assignment. More...
|
|
void | operator+= (const dictionary &rhs) |
| Include entries from the given dictionary. More...
|
|
void | operator|= (const dictionary &rhs) |
| Conditionally include entries from the given dictionary. More...
|
|
void | operator<<= (const dictionary &rhs) |
| Unconditionally include entries from the given dictionary. More...
|
|
template<class T > |
T | lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
|
template<class T > |
T | lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) |
|
template<class T > |
T | lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const |
|
ITstream & | operator[] (const word &keyword) const |
| Deprecated(2018-07) find and return an entry data stream. More...
|
|
template<class T > |
T | lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const |
| Deprecated(2018-10) find and return a T. More...
|
|
bool | found (const word &keyword, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10) More...
|
|
entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) |
| Deprecated(2018-10) More...
|
|
const entry * | lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10) More...
|
|
const entry * | lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10) More...
|
|
const dictionary * | subDictPtr (const word &keyword) const |
| Deprecated(2018-10) More...
|
|
dictionary * | subDictPtr (const word &keyword) |
|
const entry & | lookupEntry (const word &keyword, bool recursive, bool patternMatch) const |
| Deprecated(2018-10) More...
|
|
ITstream & | lookup (const word &keyword, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10) More...
|
|
template<class T > |
T | lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10) More...
|
|
template<class T > |
T | lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) |
| Deprecated(2018-10) More...
|
|
template<class T > |
bool | readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const |
| Deprecated(2018-10) More...
|
|
bool | getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< bool >(const word&, keyType::option) More...
|
|
label | getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< label >(const word&, keyType::option) More...
|
|
scalar | getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< scalar >(const word&, keyType::option) More...
|
|
string | getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< string >(const word&, keyType::option) More...
|
|
word | getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< word >(const word&, keyType::option) More...
|
|
fileName | getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const |
| Same as get< fileName >(const word&, keyType::option) More...
|
|
template<class Compare > |
Foam::wordList | sortedToc (const Compare &comp) const |
|
template<class T > |
Foam::entry * | add (const keyType &k, const T &v, bool overwrite) |
|
template<class T > |
Foam::entry * | set (const keyType &k, const T &v) |
|
| ILList ()=default |
| Null construct. More...
|
|
| ILList (T *item) |
| Construct and insert the initial T item pointer. More...
|
|
| ILList (Istream &is) |
| Construct from Istream. More...
|
|
| ILList (const ILList< LListBase, T > &lst) |
| Copy construct using the 'clone()' method for each element. More...
|
|
| ILList (ILList< LListBase, T > &&lst) |
| Move construct. More...
|
|
template<class CloneArg > |
| ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg) |
| Copy constructor with additional argument for clone 'clone()'. More...
|
|
template<class INew > |
| ILList (Istream &is, const INew &inew) |
| Construct from Istream using given Istream constructor class. More...
|
|
| ~ILList () |
| Destructor. More...
|
|
bool | eraseHead () |
| Remove the head element specified from the list and delete it. More...
|
|
bool | erase (T *item) |
| Remove the specified element from the list and delete it. More...
|
|
void | clear () |
| Clear the contents of the list. More...
|
|
void | transfer (ILList< LListBase, T > &lst) |
|
void | operator= (const ILList< LListBase, T > &lst) |
| Copy assignment using the 'clone()' method for each element. More...
|
|
void | operator= (ILList< LListBase, T > &&lst) |
| Move assignment. More...
|
|