Abstract base class for specifying target cell sizes. More...
Public Member Functions | |
TypeName ("surfaceCellSizeFunction") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, surfaceCellSizeFunction, dictionary,(const dictionary &surfaceCellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize),(surfaceCellSizeFunctionDict, surface, defaultCellSize)) | |
surfaceCellSizeFunction (const word &type, const dictionary &surfaceCellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize) | |
Construct from components. More... | |
virtual | ~surfaceCellSizeFunction () |
Destructor. More... | |
const dictionary & | coeffsDict () const |
Const access to the details dictionary. More... | |
virtual scalar | interpolate (const point &pt, const label index) const =0 |
Public Member Functions inherited from dictionary | |
ClassName ("dictionary") | |
dictionary () | |
Construct top-level dictionary null. More... | |
dictionary (const fileName &name) | |
Construct top-level empty dictionary with given name. More... | |
dictionary (const fileName &name, const dictionary &parentDict, Istream &) | |
Construct given the entry name, parent dictionary and Istream,. More... | |
dictionary (Istream &) | |
Construct top-level dictionary from Istream,. More... | |
dictionary (Istream &, const bool keepHeader) | |
Construct top-level dictionary from Istream,. More... | |
dictionary (const dictionary &parentDict, const dictionary &) | |
Construct as copy given the parent dictionary. More... | |
dictionary (const dictionary &) | |
Construct top-level dictionary as copy. More... | |
dictionary (const dictionary *) | |
Construct top-level dictionary as copy from pointer to dictionary. More... | |
dictionary (const dictionary &parentDict, const Xfer< dictionary > &) | |
Construct by transferring parameter contents given parent dictionary. More... | |
dictionary (const Xfer< dictionary > &) | |
Construct top-level dictionary by transferring parameter contents. More... | |
autoPtr< dictionary > | clone () const |
Construct and return clone. More... | |
virtual | ~dictionary () |
Destructor. 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 &, 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 & | lookupEntry (const word &, bool recursive, bool patternMatch) const |
Find and return an entry data stream if present otherwise error. More... | |
ITstream & | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
Find and return an entry data stream. More... | |
template<class T > | |
T | lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const |
Find and return a T,. More... | |
template<class T > | |
T | lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) |
Find and return a T, if not found return the given. More... | |
template<class T > | |
bool | readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const |
Find an entry if present, and assign to T. More... | |
const 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... | |
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... | |
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... | |
Xfer< dictionary > | xfer () |
Transfer contents to the Xfer container. More... | |
bool | read (Istream &) |
Read dictionary from Istream. More... | |
bool | read (Istream &, const bool keepHeader) |
Read dictionary from Istream, optionally keeping the header. More... | |
void | write (Ostream &, const bool subDict=true) const |
Write dictionary, normally with sub-dictionary formatting. More... | |
ITstream & | operator[] (const word &) const |
Find and return entry. More... | |
void | operator= (const dictionary &) |
void | operator+= (const dictionary &) |
Include entries from the given dictionary. More... | |
void | operator|= (const dictionary &) |
Conditionally include entries from the given dictionary. More... | |
void | operator<<= (const dictionary &) |
Unconditionally include entries from the given dictionary. More... | |
Public Member Functions inherited from dictionaryName | |
dictionaryName () | |
Construct dictionaryName null. More... | |
dictionaryName (const fileName &name) | |
Construct dictionaryName as copy of the given fileName. More... | |
const 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... | |
Public Member Functions inherited from IDLList< entry > | |
IDLList () | |
Null construct. More... | |
IDLList (const entry &a) | |
Construct given initial T. More... | |
IDLList (Istream &is, const INew &inewt) | |
Construct from Istream using given Istream constructor class. More... | |
IDLList (Istream &is) | |
Construct from Istream. More... | |
IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg) | |
Copy constructor with additional argument for clone. More... | |
Public Member Functions inherited from ILList< DLListBase, entry > | |
ILList () | |
Null construct. More... | |
ILList (entry *a) | |
Construct given initial T. More... | |
ILList (Istream &) | |
Construct from Istream. More... | |
ILList (const ILList< DLListBase, entry > &) | |
Construct as copy. More... | |
ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg) | |
Copy constructor with additional argument for clone. More... | |
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 (entry *p) |
Remove the specified element from the list and delete it. More... | |
void | clear () |
Clear the contents of the list. More... | |
void | transfer (ILList< DLListBase, entry > &) |
Transfer the contents of the argument into this List. More... | |
void | operator= (const ILList< DLListBase, entry > &) |
Public Member Functions inherited from UILList< DLListBase, entry > | |
UILList () | |
Null construct. More... | |
UILList (entry *a) | |
Construct given initial T. More... | |
UILList (const UILList< DLListBase, entry > &) | |
Construct as copy. More... | |
entry * | first () |
Return the first entry. More... | |
const entry * | first () const |
Return the first entry. More... | |
entry * | last () |
Return the last entry. More... | |
const entry * | last () const |
Return the last entry. More... | |
entry * | removeHead () |
Remove and return head. More... | |
entry * | remove (entry *p) |
Remove and return element. More... | |
entry * | remove (iterator &it) |
Remove and return specified by iterator. More... | |
void | operator= (const UILList< DLListBase, entry > &) |
iterator | begin () |
const_iterator | begin () const |
const iterator & | end () |
const const_iterator & | end () const |
const_iterator | cbegin () const |
const const_iterator & | cend () 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< DLListBase, entry > &) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UILList< DLListBase, entry > &) const |
The opposite of the equality operation. Takes linear time. More... | |
Public Member Functions inherited from DLListBase | |
DLListBase () | |
Null construct. More... | |
DLListBase (link *) | |
Construct given initial entry. More... | |
~DLListBase () | |
Destructor. More... | |
label | size () const |
Return number of elements in list. More... | |
bool | empty () const |
Return true if the list is empty. More... | |
link * | first () |
Return first entry. More... | |
const link * | first () const |
Return const access to first entry. More... | |
link * | last () |
Return last entry. More... | |
const link * | last () const |
Return const access to last entry. More... | |
void | insert (link *) |
Add at head of list. More... | |
void | append (link *) |
Add at tail of list. More... | |
bool | swapUp (link *) |
Swap this element with the one above unless it is at the top. More... | |
bool | swapDown (link *) |
Swap this element with the one below unless it is at the bottom. More... | |
link * | removeHead () |
Remove and return head. More... | |
link * | remove (link *) |
Remove and return element. More... | |
link * | remove (iterator &) |
link * | replace (link *oldLink, link *newLink) |
Replace oldLink with newLink and return element. More... | |
link * | replace (iterator &oldIter, link *newLink) |
Replace oldIter with newLink and return element. More... | |
void | clear () |
Clear the list. More... | |
void | transfer (DLListBase &) |
Transfer the contents of the argument into this List. 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 |
Static Public Member Functions | |
static autoPtr< surfaceCellSizeFunction > | New (const dictionary &surfaceCellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize) |
Return a reference to the selected surfaceCellSizeFunction. More... | |
Static Public Member Functions inherited from dictionary | |
static autoPtr< dictionary > | New (Istream &) |
Construct top-level dictionary on freestore from Istream. More... | |
Protected Attributes | |
const searchableSurface & | surface_ |
Reference to the searchableSurface that surfaceCellSizeFunction. More... | |
const dictionary | coeffsDict_ |
const scalar & | defaultCellSize_ |
scalar | refinementFactor_ |
If cell resizing is allowed, this is the factor of the old cell size. More... | |
Additional Inherited Members | |
Public Types inherited from UILList< DLListBase, entry > | |
typedef entry | value_type |
Type of values the DLList contains. More... | |
typedef entry & | reference |
Type that can be used for storing into DLList::value_type. More... | |
typedef const entry & | 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 DLListBase::iterator | LListBase_iterator |
typedef DLListBase::const_iterator | LListBase_const_iterator |
Static Public Attributes inherited from dictionary | |
static const dictionary | null |
Null dictionary. More... | |
Abstract base class for specifying target cell sizes.
Definition at line 51 of file surfaceCellSizeFunction.H.
surfaceCellSizeFunction | ( | const word & | type, |
const dictionary & | surfaceCellSizeFunctionDict, | ||
const searchableSurface & | surface, | ||
const scalar & | defaultCellSize | ||
) |
Construct from components.
|
virtual |
Destructor.
TypeName | ( | "surfaceCellSizeFunction" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
surfaceCellSizeFunction | , | ||
dictionary | , | ||
(const dictionary &surfaceCellSizeFunctionDict, const searchableSurface &surface, const scalar &defaultCellSize) | , | ||
(surfaceCellSizeFunctionDict, surface, defaultCellSize) | |||
) |
|
static |
Return a reference to the selected surfaceCellSizeFunction.
|
inline |
Const access to the details dictionary.
Definition at line 136 of file surfaceCellSizeFunction.H.
References surfaceCellSizeFunction::coeffsDict_, and surfaceCellSizeFunction::interpolate().
Implemented in nonUniformField, and uniformValue.
Referenced by surfaceCellSizeFunction::coeffsDict().
|
protected |
Reference to the searchableSurface that surfaceCellSizeFunction.
relates to
Definition at line 62 of file surfaceCellSizeFunction.H.
|
protected |
Definition at line 64 of file surfaceCellSizeFunction.H.
Referenced by surfaceCellSizeFunction::coeffsDict().
|
protected |
Definition at line 66 of file surfaceCellSizeFunction.H.
|
protected |
If cell resizing is allowed, this is the factor of the old cell size.
to get the new cell size
Definition at line 70 of file surfaceCellSizeFunction.H.