A wrapper around a list of wave models. Superimposes the modelled values of elevation and velocity. The New method looks up or constructs an instance of this class on demand and returns a reference. Properties are read from a waveProperties dictionary in constant. More...
Public Member Functions | |
| TypeName ("wave") | |
| Runtime type information. More... | |
| declareRunTimeSelectionTable (autoPtr, waveSuperposition, objectRegistry,(const objectRegistry &db),(db)) | |
| waveSuperposition (const objectRegistry &db) | |
| Construct from a database. More... | |
| ~waveSuperposition () | |
| Destructor. More... | |
| scalar | maxWaveSpeed (const scalar t) const |
| Return the maximum wave speed for the given time t. More... | |
| virtual tmp< scalarField > | height (const scalar t, const vectorField &p) const |
| Get the height above the waves at a given time and global positions. More... | |
| virtual tmp< vectorField > | ULiquid (const scalar t, const vectorField &p) const |
| Get the liquid velocity at a given time and global positions. More... | |
| virtual tmp< vectorField > | UGas (const scalar t, const vectorField &p) const |
| Get the gas velocity at a given time and global positions. More... | |
| void | write (Ostream &) const |
| Write. More... | |
| virtual bool | write (const bool write=true) const |
| Inherit write from regIOobject. More... | |
 Public Member Functions inherited from IOdictionary | |
| TypeName ("dictionary") | |
| IOdictionary (const IOobject &) | |
| Construct given an IOobject. More... | |
| IOdictionary (const IOobject &, const dictionary &) | |
| Construct given an IOobject and dictionary. More... | |
| IOdictionary (const IOobject &, Istream &) | |
| Construct given an IOobject and Istream. More... | |
| IOdictionary (const IOdictionary &) | |
| Copy constructor. More... | |
| IOdictionary (IOdictionary &&) | |
| Move constructor. More... | |
| virtual | ~IOdictionary () |
| Destructor. More... | |
| virtual bool | global () const |
| Return true as object is global, i.e. same for all processors. More... | |
| virtual bool | readData (Istream &) |
| ReadData function required for regIOobject read operation. More... | |
| virtual bool | writeData (Ostream &) const |
| WriteData function required for regIOobject write operation. More... | |
| void | operator= (const IOdictionary &) |
| Assignment of dictionary entries only. More... | |
| void | operator= (IOdictionary &&) |
| Move assignment of dictionary entries only. More... | |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. More... | |
| regIOobject (const IOobject &, const bool isTime=false) | |
| Construct from IOobject. Optional flag for if IOobject is the. More... | |
| regIOobject (const regIOobject &) | |
| Copy constructor. More... | |
| regIOobject (regIOobject &&) | |
| Move constructor. More... | |
| regIOobject (const regIOobject &, bool registerCopy) | |
| Copy constructor, transferring registry registration to copy. More... | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy constructor with new name, transferring registry registration. More... | |
| regIOobject (const IOobject &, const regIOobject &) | |
| Copy constructor with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| virtual bool | globalFile () const |
| Return true if object is global, i.e. same for all processors. More... | |
| const fileName & | caseName () const |
| fileName | path () const |
| Return complete path. More... | |
| fileName | objectPath () const |
| Return complete path + object name. More... | |
| fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | checkIn () |
| Add object to registry. More... | |
| bool | checkOut () |
| Remove object from registry. More... | |
| void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | registered () const |
| Is this object registered with the registry? More... | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| void | store () |
| Transfer ownership of this object to its registry. More... | |
| void | release () |
| Release ownership of this object from its registry. More... | |
| label | eventNo () const |
| Event number at last update. More... | |
| label & | eventNo () |
| Event number at last update. More... | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| void | setUpToDate () |
| Set up to date (obviously) More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool read=true) |
| Return Istream and check object type against that given. More... | |
| void | close () |
| Close Istream. More... | |
| virtual bool | read () |
| Read object. More... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | modified () const |
| Return true if the object's file (or files for objectRegistry) More... | |
| virtual bool | dependenciesModified () const |
| Return true if the object's dependencies have been modified. More... | |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const |
| Write using given format, version and compression. More... | |
| virtual bool | write (const bool write=true) const |
| Write using setting from DB. More... | |
| void | operator= (const IOobject &)=delete |
| Assign to IOobject. More... | |
| void | operator= (const regIOobject &)=delete |
| Disallow default assignment. More... | |
| const fileName & | caseName (const bool global) const |
| fileName | path (const bool global) const |
| Return complete path including the processor sub-directory. More... | |
| fileName | objectPath (const bool global) const |
| Return complete path + object name including the processor. More... | |
| fileName | filePath (const bool global) const |
| Return complete path + object name if the file exists. More... | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Runtime type information. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Construct from copy resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Construct from copy resetting name. More... | |
| IOobject (const IOobject &io)=default | |
| Copy constructor. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| virtual | ~IOobject () |
| Destructor. More... | |
| const Time & | time () const |
| Return time. More... | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. More... | |
| const word & | name () const |
| Return name. More... | |
| const word & | headerClassName () const |
| Return name of the class name read from header. More... | |
| word & | headerClassName () |
| Return name of the class name read from header. More... | |
| string & | note () |
| Return non-constant access to the optional note. More... | |
| const string & | note () const |
| Return the optional note. More... | |
| bool & | registerObject () |
| Register object created from this IOobject with registry if true. More... | |
| bool | registerObject () const |
| Register object created from this IOobject with registry if true. More... | |
| readOption | readOpt () const |
| readOption & | readOpt () |
| writeOption | writeOpt () const |
| writeOption & | writeOpt () |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName (const bool global) const |
| fileName & | instance () const |
| Return the instance directory, constant, system, <time> etc. More... | |
| void | updateInstance () const |
| If the instance is a time directory update to the current time. More... | |
| void | updateTimeInstance () const |
| Update instance to the current time. More... | |
| const fileName & | local () const |
| fileName | path (const bool global) const |
| Return complete path including the processor sub-directory. More... | |
| fileName | objectPath (const bool global) const |
| Return complete path + object name including the processor. More... | |
| fileName | relativePath () const |
| Return the path relative to the case directory. More... | |
| fileName | relativeObjectPath () const |
| Return complete relativePath + object name. More... | |
| fileName | filePath (const bool global) const |
| Return complete path + object name if the file exists. More... | |
| bool | readHeader (Istream &) |
| Read header. More... | |
| bool | headerOk () |
| Read header of local object without type-checking. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More... | |
| bool | writeHeader (Ostream &) const |
| Write header. More... | |
| bool | writeHeader (Ostream &, const word &objectType) const |
| Write header. Allow override of type. More... | |
| bool | good () const |
| bool | bad () const |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &) |
| template<class Name > | |
| Foam::word | groupName (Name name, const word &group) |
| 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) | |
| Construct an empty sub-dictionary with given name and parent. More... | |
| dictionary (const fileName &name, const dictionary &parentDict, Istream &) | |
| Construct given the 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... | |
| template<class ... Entries> | |
| dictionary (const std::tuple< const Entries &... > &) | |
| Construct top-level dictionary with given entries. More... | |
| template<class ... Entries> | |
| dictionary (const fileName &name, const std::tuple< const Entries &... > &) | |
| Construct top-level dictionary with given name and entries. More... | |
| template<class ... Entries> | |
| dictionary (const fileName &name, const dictionary &parentDict, const std::tuple< const Entries &... > &) | |
| Construct dictionary with given name, parent and entries. More... | |
| template<class ... Entries> | |
| dictionary (const dictionary &dict, const std::tuple< const Entries &... > &) | |
| Construct dictionary as copy and add a list of entries. 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... | |
| word | topDictKeyword () const |
| Return the scoped keyword with which this dictionary can be. More... | |
| virtual label | startLineNumber () const |
| Return line number of first token in dictionary. More... | |
| virtual 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, if not found throw a fatal error. More... | |
| template<class T > | |
| T | lookup (const word &, const unitConversion &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T, with dimension checking and unit. 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 | lookupBackwardsCompatible (const wordList &, const unitConversion &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T, with dimension checking and unit. More... | |
| template<class T > | |
| T | lookupOrDefault (const word &, const T &, const bool writeDefault=writeOptionalEntries > 0) const |
| Find and return a T, if not found return the given default. More... | |
| template<class T > | |
| T | lookupOrDefault (const word &, const unitConversion &, const T &, const bool writeDefault=writeOptionalEntries > 0) const |
| Find and return a T with dimension checking and unit. More... | |
| template<class T > | |
| T | lookupOrDefaultBackwardsCompatible (const wordList &, const T &) const |
| Find and return a T, trying a list of keywords in sequence,. More... | |
| template<class T > | |
| T | lookupOrDefaultBackwardsCompatible (const wordList &, const unitConversion &, const T &) const |
| Find and return a T, with dimension checking and unit. More... | |
| template<class T > | |
| T | lookupOrAddDefault (const word &, const T &) |
| 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... | |
| template<class T > | |
| bool | readIfPresent (const word &, const unitConversion &, T &, bool recursive=false, bool patternMatch=true) const |
| Find an entry if present, and assign to T, with dimension. More... | |
| const entry * | lookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream pointer if present,. More... | |
| template<class T > | |
| T | lookupScoped (const word &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T,. More... | |
| template<class T > | |
| const T & | lookupCompoundScoped (const word &keyword, bool recursive, bool patternMatch) const |
| Find return the reference to the compound T,. 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... | |
| const dictionary & | subDictBackwardsCompatible (const wordList &) const |
| Find and return a sub-dictionary, trying a list of keywords in. More... | |
| const dictionary & | subOrEmptyDict (const word &, const bool mustRead=false) const |
| Find and return a sub-dictionary. 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 | 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... | |
| template<class ... Entries> | |
| void | set (const entry &e, const Entries &...) |
| Assign multiple entries, overwriting any existing entries. More... | |
| template<class T , class ... Entries> | |
| void | set (const keyType &, const T &, const Entries &...) |
| Assign multiple T entries, overwriting any existing entries. More... | |
| bool | remove (const word &) |
| Remove an entry specified by keyword. More... | |
| void | remove (const wordList &) |
| Remove entries specified by keywords. 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... | |
| 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... | |
| template<class ... Entries> | |
| std::tuple< const Entries &... > | entries (const Entries &... entries) |
| template<class T > | |
| T | lookupOrDefault (const word &keyword, const T &defaultValue, const bool writeDefault) const |
| template<class T > | |
| T | lookupOrDefault (const word &keyword, const unitConversion &defaultUnits, const T &defaultValue, const bool writeDefault) const |
| template<class ... Entries> | |
| void | set (const entry &e, const Entries &... entries) |
| template<class T , class ... Entries> | |
| void | set (const keyType &k, const T &t, const Entries &... entries) |
| 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 const waveSuperposition & | New (const objectRegistry &db) |
| Return a reference to the wave model on the given database,. More... | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *) |
| Transfer ownership of the given object pointer to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &) |
| Transfer ownership of the given object pointer to its registry. More... | |
| Static Public Member Functions inherited from IOobject | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class Name > | |
| static word | groupName (Name name, const word &group) |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| template<class Stream > | |
| static Stream & | writeBanner (Stream &os, bool noHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| template<class Stream > | |
| static Stream & | writeDivider (Stream &os) |
| Write the standard file section divider. More... | |
| template<class Stream > | |
| static Stream & | writeEndDivider (Stream &os) |
| Write the standard end file divider. More... | |
| Static Public Member Functions inherited from dictionary | |
| template<class ... Entries> | |
| static std::tuple< const Entries &... > | entries (const Entries &...) |
| Construct an entries tuple from which to make a dictionary. More... | |
| static autoPtr< dictionary > | New (Istream &) |
| Construct top-level dictionary on freestore from Istream. More... | |
Static Public Attributes | |
| static const word | dictName |
| The name of the dictionary. More... | |
| Static Public Attributes inherited from IOdictionary | |
| static bool | writeDictionaries |
| Static Public Attributes inherited from regIOobject | |
| static float | fileModificationSkew |
| Static Public Attributes inherited from IOobject | |
| static constexpr const char * | foamFile = "FoamFile" |
| Keyword for the FoamFile header sub-dictionary. More... | |
| static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More... | |
| Static Public Attributes inherited from dictionary | |
| static const dictionary | null |
| Null dictionary. More... | |
| static int | writeOptionalEntries |
| If true write optional keywords and values. More... | |
Protected Member Functions | |
| void | transformation (const scalar t, const vectorField &p, tensor &axes, vector &drift, vectorField &xyz) const |
| Get the transformation to actual coordinates. More... | |
| tmp< scalarField > | elevation (const scalar t, const vector2D &drift, const vector2DField &xy) const |
| Get the wave elevation relative to the mean at a given time and. More... | |
| tmp< vectorField > | velocity (const scalar t, const vector &drift, const vectorField &xyz) const |
| Get the wave velocity at a given time and local coordinates. Local. More... | |
| tmp< scalarField > | scale (const vector2DField &xy) const |
| Get the scaling factor, calculated from the optional scaling. More... | |
| Protected Member Functions inherited from IOdictionary | |
| IOdictionary (const IOobject &io, const word &wantedType) | |
| Construct given an IOobject, supply wanted typeName. More... | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName) |
| Read header, check readOpt flags and read data if necessary. More... | |
| Protected Member Functions inherited from IOobject | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType) |
| Read header using typeGlobalFile to find file. More... | |
Protected Attributes | |
| const vector | origin_ |
| The origin of the wave coordinate system. More... | |
| const vector | direction_ |
| The direction of the wave coordinate system. More... | |
| PtrList< waveModel > | waveModels_ |
| Wave models to superimpose. More... | |
| scalarList | waveAngles_ |
| The angle relative to the direction at which the waves propagate. More... | |
| const autoPtr< Function1< vector > > | UMean_ |
| Mean velocity. More... | |
| const autoPtr< Function1< scalar > > | scale_ |
| Scaling in the local x-direction. More... | |
| const autoPtr< Function1< scalar > > | crossScale_ |
| Scaling perpendicular to the local x-direction. More... | |
| const Switch | heightAboveWave_ |
| Calculate wave properties using the height above the wave (true) or. More... | |
Additional Inherited Members | |
| Public Types inherited from IOobject | |
| enum | objectState { GOOD , BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| 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 wrapper around a list of wave models. Superimposes the modelled values of elevation and velocity. The New method looks up or constructs an instance of this class on demand and returns a reference. Properties are read from a waveProperties dictionary in constant.
| Property | Description | Required? | Default |
|---|---|---|---|
origin | origin of the wave coordinate system | yes | |
direction | direction of the wave coordinate system | yes | |
waves | list of wave models to superimpose | yes | |
UMean | velocity of the mean flow | yes | |
scale | scale factor in the direction | no | None |
crossScale | scale factor perpendicular to the direction | no | None |
heightAboveWave | use the height above the wave as the vertical coordinate | no | false |
Example specification:
origin (0 25 0);
direction (1 0 0);
waves
(
Airy
{
length 40;
amplitude 0.5;
phase 0;
angle 0;
}
Airy
{
length 20;
amplitude 0.25;
phase 1.5708;
angle 0;
}
);
UMean (2 0 0);
scale table ((100 1) (200 0));
crossScale constant 1;
heightAboveWave no;Definition at line 139 of file waveSuperposition.H.
| waveSuperposition | ( | const objectRegistry & | db | ) |
Construct from a database.
Definition at line 171 of file waveSuperposition.C.
References TimePaths::constant(), IOobject::db(), dictionaryName::dictName(), Foam::dimAcceleration, forAll, objectRegistry::foundObject(), dictionary::lookup(), objectRegistry::lookupObject(), Foam::mag(), IOobject::MUST_READ, waveModel::New(), IOobject::NO_WRITE, List< T >::setSize(), regIOobject::store(), objectRegistry::time(), UniformDimensionedField< Type >::value(), waveSuperposition::waveAngles_, waveSuperposition::waveModels_, and Foam::Zero.
| ~waveSuperposition | ( | ) |
Destructor.
Definition at line 266 of file waveSuperposition.C.
|
protected |
Get the transformation to actual coordinates.
Definition at line 51 of file waveSuperposition.C.
References IOobject::db(), waveSuperposition::direction_, objectRegistry::lookupObject(), Foam::mag(), waveSuperposition::origin_, p, waveSuperposition::UMean_, and UniformDimensionedField< Type >::value().
|
protected |
Get the wave elevation relative to the mean at a given time and.
local coordinates. Local x is aligned with the direction, and y is perpendicular to both x and gravity.
Definition at line 77 of file waveSuperposition.C.
References Foam::cos(), forAll, Foam::sin(), and List< T >::size().
|
protected |
Get the wave velocity at a given time and local coordinates. Local.
x is aligned with the direction, z with negative gravity, and y is perpendicular to both.
Definition at line 96 of file waveSuperposition.C.
References Field< Type >::component(), Foam::cos(), forAll, s(), Foam::sin(), List< T >::size(), Vector< Cmpt >::x(), Vector2D< Cmpt >::x(), Vector< Cmpt >::y(), Vector2D< Cmpt >::y(), Vector< Cmpt >::z(), VectorSpace< Form, Cmpt, Ncmpts >::zero, and Foam::zip().
|
protected |
Get the scaling factor, calculated from the optional scaling.
functions. X and y are the same as for the elevation method.
Definition at line 139 of file waveSuperposition.C.
References Field< Type >::component(), forAll, tmp< T >::ref(), List< T >::size(), x, and y.
| TypeName | ( | "wave" | ) |
Runtime type information.
| declareRunTimeSelectionTable | ( | autoPtr | , |
| waveSuperposition | , | ||
| objectRegistry | , | ||
| (const objectRegistry &db) | , | ||
| (db) | |||
| ) |
|
static |
Return a reference to the wave model on the given database,.
constructing if it doesn't exist
Definition at line 31 of file waveSuperpositionNew.C.
References TimePaths::constant(), IOobject::db(), dict, waveSuperposition::dictName, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, objectRegistry::foundObject(), objectRegistry::lookupObject(), IOobject::MUST_READ, Foam::nl, IOobject::NO_WRITE, regIOobject::store(), objectRegistry::time(), and Foam::type().
Referenced by waveAlphaFvPatchScalarField::alpha(), waveAlphaFvPatchScalarField::alphan(), waveVelocityFvPatchVectorField::U(), waveVelocityFvPatchVectorField::Un(), and waveInletOutletFvPatchField< Type >::updateCoeffs().
| Foam::scalar maxWaveSpeed | ( | const scalar | t | ) | const |
Return the maximum wave speed for the given time t.
used to evaluate the mean velocity
Definition at line 272 of file waveSuperposition.C.
References forAll, Foam::mag(), and Foam::max().
|
virtual |
Get the height above the waves at a given time and global positions.
Definition at line 284 of file waveSuperposition.C.
References Field< Type >::component(), p, Vector< Cmpt >::x(), Vector< Cmpt >::y(), Vector< Cmpt >::z(), and Foam::zip().
Referenced by waveAlphaFvPatchScalarField::alpha(), waveAlphaFvPatchScalarField::alphan(), waveVelocityFvPatchVectorField::U(), waveVelocityFvPatchVectorField::Un(), and waveInletOutletFvPatchField< Type >::updateCoeffs().
|
virtual |
Get the liquid velocity at a given time and global positions.
Definition at line 306 of file waveSuperposition.C.
References p, and Field< Type >::replace().
Referenced by waveVelocityFvPatchVectorField::U(), and waveVelocityFvPatchVectorField::Un().
|
virtual |
Get the gas velocity at a given time and global positions.
Reimplemented in waveAtmBoundaryLayerSuperposition.
Definition at line 326 of file waveSuperposition.C.
References Field< Type >::component(), p, Field< Type >::replace(), Tensor< Cmpt >::x(), Tensor< Cmpt >::y(), and Tensor< Cmpt >::z().
Referenced by waveVelocityFvPatchVectorField::U(), waveAtmBoundaryLayerSuperposition::UGas(), and waveVelocityFvPatchVectorField::Un().
| void write | ( | Ostream & | os | ) | const |
Write.
Definition at line 350 of file waveSuperposition.C.
References token::BEGIN_BLOCK, token::BEGIN_LIST, Foam::decrIndent(), Foam::dimless, Foam::dimVelocity, token::END_BLOCK, token::END_LIST, token::END_STATEMENT, forAll, Foam::incrIndent(), Foam::indent(), Foam::nl, Foam::type(), Ostream::write(), Foam::writeEntry(), and Foam::writeKeyword().
| bool write |
Inherit write from regIOobject.
Definition at line 311 of file regIOobjectWrite.C.
Referenced by waveAtmBoundaryLayerSuperposition::write().
|
protected |
The origin of the wave coordinate system.
Definition at line 148 of file waveSuperposition.H.
Referenced by waveSuperposition::transformation().
|
protected |
The direction of the wave coordinate system.
Definition at line 151 of file waveSuperposition.H.
Referenced by waveSuperposition::transformation().
Wave models to superimpose.
Definition at line 154 of file waveSuperposition.H.
Referenced by waveSuperposition::waveSuperposition().
|
protected |
The angle relative to the direction at which the waves propagate.
Definition at line 157 of file waveSuperposition.H.
Referenced by waveSuperposition::waveSuperposition().
Mean velocity.
Definition at line 160 of file waveSuperposition.H.
Referenced by waveSuperposition::transformation().
Scaling in the local x-direction.
Definition at line 163 of file waveSuperposition.H.
Scaling perpendicular to the local x-direction.
Definition at line 166 of file waveSuperposition.H.
|
protected |
Calculate wave properties using the height above the wave (true) or.
the height above the origin (false)?
Definition at line 170 of file waveSuperposition.H.
|
static |
The name of the dictionary.
Definition at line 230 of file waveSuperposition.H.
Referenced by waveSuperposition::New().
1.9.1