Produces a linear ramp which adapts its gradient to changes in endTime and deltaT to always arrive at the relaxationEnd value at the end of the run. More...
Public Member Functions | |
| TypeName ("adaptiveLinear") | |
| Runtime type information. More... | |
| adaptiveLinear (const dictionary &relaxationDict, const Time &runTime) | |
| Construct from components. More... | |
| virtual | ~adaptiveLinear () |
| Destructor. More... | |
| virtual scalar | relaxation () |
| Return the current relaxation coefficient. More... | |
 Public Member Functions inherited from relaxationModel | |
| TypeName ("relaxationModel") | |
| Runtime type information. More... | |
| declareRunTimeSelectionTable (autoPtr, relaxationModel, dictionary,(const dictionary &relaxationDict, const Time &runTime),(relaxationDict, runTime)) | |
| relaxationModel (const word &type, const dictionary &relaxationDict, const Time &runTime) | |
| Construct from components. More... | |
| virtual | ~relaxationModel () |
| Destructor. More... | |
| const dictionary & | coeffDict () const |
| Const access to the coeffs dictionary. More... | |
| 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... | |
| 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 (T *a) | |
| Construct given initial T. More... | |
| ILList (Istream &) | |
| Construct from Istream. More... | |
| ILList (const ILList< LListBase, T > &) | |
| Construct as copy. More... | |
| ILList (const ILList< LListBase, T > &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 (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 > &) |
Private Attributes | |
| scalar | relaxationStart_ |
| Relaxation coefficient at the start of the iteration sequence. More... | |
| scalar | relaxationEnd_ |
| Relaxation coefficient at the end of the iteration sequence. More... | |
| scalar | lastTimeValue_ |
| Store the time when the last request was made for relaxation,. More... | |
| scalar | relaxation_ |
| Current relaxation value. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from relaxationModel | |
| static autoPtr< relaxationModel > | New (const dictionary &relaxationDict, const Time &runTime) |
| Return a reference to the selected relaxationModel. More... | |
| Static Public Member Functions inherited from dictionary | |
| static autoPtr< dictionary > | New (Istream &) |
| Construct top-level dictionary on freestore from Istream. More... | |
| Static Public Attributes inherited from dictionary | |
| static const dictionary | null |
| Null dictionary. More... | |
| Protected Attributes inherited from relaxationModel | |
| const Time & | runTime_ |
| Reference to the conformalVoronoiMesh holding this cvControls object. More... | |
| dictionary | coeffDict_ |
| Method coeffs dictionary. More... | |
Produces a linear ramp which adapts its gradient to changes in endTime and deltaT to always arrive at the relaxationEnd value at the end of the run.
Definition at line 50 of file adaptiveLinear.H.
| adaptiveLinear | ( | const dictionary & | relaxationDict, |
| const Time & | runTime | ||
| ) |
Construct from components.
|
inlinevirtual |
Destructor.
Definition at line 90 of file adaptiveLinear.H.
| TypeName | ( | "adaptiveLinear" | ) |
Runtime type information.
|
virtual |
Return the current relaxation coefficient.
Implements relaxationModel.
|
private |
Relaxation coefficient at the start of the iteration sequence.
Definition at line 60 of file adaptiveLinear.H.
|
private |
Relaxation coefficient at the end of the iteration sequence.
Definition at line 63 of file adaptiveLinear.H.
|
private |
Store the time when the last request was made for relaxation,.
prevents multiple calls to relaxation in a timestep from incrementing the value
Definition at line 68 of file adaptiveLinear.H.
|
private |
Current relaxation value.
Definition at line 71 of file adaptiveLinear.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.
Generated by
1.8.17
