All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
waveSuperposition Class Reference

A wrapper around a list of wave models. Superimposes the modelled values of elevation and velocity. The New method looks up or or constructs an instance of this class on demand and returns a reference. Properties are read from a dictionary in constant. More...

Inheritance diagram for waveSuperposition:
Collaboration diagram for waveSuperposition:

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...
 
virtual tmp< scalarFieldheight (const scalar t, const vectorField &p) const
 Get the height above the waves at a given time and global positions. More...
 
virtual tmp< vectorFieldULiquid (const scalar t, const vectorField &p) const
 Get the liquid velocity at a given time and global positions. More...
 
virtual tmp< vectorFieldUGas (const scalar t, const vectorField &p) const
 Get the gas velocity at a given time and global positions. More...
 
virtual tmp< scalarFieldpLiquid (const scalar t, const vectorField &p) const
 Get the liquid pressure at a given time and global positions. More...
 
virtual tmp< scalarFieldpGas (const scalar t, const vectorField &p) const
 Get the gas pressure at a given time and global positions. More...
 
void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from IOdictionary
 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
 Is object global. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
void operator= (IOdictionary &&)
 Move assignment. More...
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 
 baseIOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 baseIOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 baseIOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
 baseIOdictionary (const baseIOdictionary &)
 Copy constructor. More...
 
 baseIOdictionary (baseIOdictionary &&)
 Move constructor. More...
 
virtual ~baseIOdictionary ()
 Destructor. More...
 
const wordname () const
 Name function is needed to disambiguate those inherited. 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 baseIOdictionary &)
 Assignment of other baseIOdictionary's entries to this. More...
 
void operator= (baseIOdictionary &&)
 Move assignment. 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 (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...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) 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...
 
labeleventNo ()
 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...
 
IstreamreadStream (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...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. Return. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) 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 &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, 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 &registry, 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 &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 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< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
word modelName (const char *name) const
 Return the name of the object within this model. More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName localPath () const
 Return the path relative to the case. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName localObjectPath () const
 Return complete localPath + object name. More...
 
fileName localFilePath (const word &typeName) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true)
 Read header (uses typeFilePath to find file) and check header. 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Name >
Foam::word modelName (Name name, const word &model)
 
- 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 &, 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...
 
 dictionary (const dictionary &parentDict, dictionary &&)
 Move constructor transferring parameter contents. More...
 
 dictionary (dictionary &&)
 Move constructor. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
bool isNull () const
 Return whether this dictionary is null. More...
 
const dictionarytopDict () 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 entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
template<class T >
T lookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. 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 entrylookupScopedEntryPtr (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 dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
dictionarysubDictPtr (const word &)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (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...
 
const dictionaryoptionalSubDict (const word &) const
 Find and return a sub-dictionary if found. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
List< keyTypekeys (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...
 
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...
 
ITstreamoperator[] (const word &) const
 Find and return entry. More...
 
void operator= (const dictionary &)
 
void operator= (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...
 
 dictionaryName (dictionaryName &&name)
 Move constructor. More...
 
const fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 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...
 
Tfirst ()
 Return the first entry. More...
 
const Tfirst () const
 Return the first entry. More...
 
Tlast ()
 Return the last entry. More...
 
const Tlast () const
 Return the last entry. More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *p)
 Remove and return element. More...
 
Tremove (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 iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () 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 waveSuperpositionNew (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 Name >
static word modelName (Name name, const word &model)
 Return the name of the object within the given model. 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
static autoPtr< dictionaryNew (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 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...
 

Protected Member Functions

void transformation (const scalar t, const vectorField &p, tensor &axes, vectorField &xyz) const
 Get the transformation to actual coordinates. More...
 
tmp< scalarFieldelevation (const scalar t, const vector2DField &xy) const
 Get the wave elevation relative to the mean at a given time and. More...
 
tmp< vectorFieldvelocity (const scalar t, const vectorField &xyz) const
 Get the wave velocity at a given time and local coordinates. Local. More...
 
tmp< scalarFieldpressure (const scalar t, const vectorField &xyz) const
 Get the wave pressure at a given time and local coordinates. Local. More...
 
tmp< scalarFieldscale (const vector2DField &xy) const
 Get the scaling factor, calculated from the optional scaling. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. 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< waveModelwaveModels_
 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 Treference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const Tconst_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
 

Detailed Description

A wrapper around a list of wave models. Superimposes the modelled values of elevation and velocity. The New method looks up or or constructs an instance of this class on demand and returns a reference. Properties are read from a dictionary in constant.

Usage
Property Description Req'd? 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;
Source files

Definition at line 132 of file waveSuperposition.H.

Constructor & Destructor Documentation

◆ waveSuperposition()

◆ ~waveSuperposition()

Destructor.

Definition at line 244 of file waveSuperposition.C.

References waveSuperposition::height().

Here is the call graph for this function:

Member Function Documentation

◆ transformation()

void transformation ( const scalar  t,
const vectorField p,
tensor axes,
vectorField xyz 
) const
protected

Get the transformation to actual coordinates.

Definition at line 51 of file waveSuperposition.C.

References waveSuperposition::elevation(), g, Foam::mag(), and dimensioned< Type >::value().

Referenced by waveSuperposition::height(), waveSuperposition::pGas(), waveSuperposition::pLiquid(), waveSuperposition::UGas(), and waveSuperposition::ULiquid().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ elevation()

Foam::tmp< Foam::scalarField > elevation ( const scalar  t,
const vector2DField xy 
) const
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 74 of file waveSuperposition.C.

References Foam::cos(), forAll, Foam::sin(), List< T >::size(), and waveSuperposition::velocity().

Referenced by waveSuperposition::height(), and waveSuperposition::transformation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ velocity()

Foam::tmp< Foam::vectorField > velocity ( const scalar  t,
const vectorField xyz 
) const
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 92 of file waveSuperposition.C.

References Field< Type >::component(), Foam::cos(), forAll, waveSuperposition::pressure(), s(), Foam::sin(), List< T >::size(), Vector2D< Cmpt >::x(), Vector2D< Cmpt >::y(), VectorSpace< Vector< scalar >, scalar, 3 >::zero, and Foam::zip().

Referenced by waveSuperposition::elevation(), waveSuperposition::UGas(), and waveSuperposition::ULiquid().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ pressure()

Foam::tmp< Foam::scalarField > pressure ( const scalar  t,
const vectorField xyz 
) const
protected

Get the wave pressure 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 129 of file waveSuperposition.C.

References Field< Type >::component(), Foam::cos(), forAll, s(), waveSuperposition::scale(), Foam::sin(), List< T >::size(), and Foam::zip().

Referenced by waveSuperposition::pGas(), waveSuperposition::pLiquid(), and waveSuperposition::velocity().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ scale()

Foam::tmp< Foam::scalarField > scale ( const vector2DField xy) const
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 161 of file waveSuperposition.C.

References Field< Type >::component(), forAll, tmp< T >::ref(), List< T >::size(), x, and y.

Referenced by waveSuperposition::pressure().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "wave"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
waveSuperposition  ,
objectRegistry  ,
(const objectRegistry &db ,
(db  
)

◆ New()

◆ height()

◆ ULiquid()

Foam::tmp< Foam::vectorField > ULiquid ( const scalar  t,
const vectorField p 
) const
virtual

◆ UGas()

◆ pLiquid()

Foam::tmp< Foam::scalarField > pLiquid ( const scalar  t,
const vectorField p 
) const
virtual

Get the liquid pressure at a given time and global positions.

Definition at line 309 of file waveSuperposition.C.

References waveSuperposition::height(), waveSuperposition::heightAboveWave_, waveSuperposition::pGas(), waveSuperposition::pressure(), Field< Type >::replace(), List< T >::size(), and waveSuperposition::transformation().

Referenced by wavePressureFvPatchScalarField::p(), wavePressureFvPatchScalarField::pn(), and waveSuperposition::UGas().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ pGas()

Foam::tmp< Foam::scalarField > pGas ( const scalar  t,
const vectorField p 
) const
virtual

◆ write()

Member Data Documentation

◆ origin_

const vector origin_
protected

The origin of the wave coordinate system.

Definition at line 141 of file waveSuperposition.H.

Referenced by waveSuperposition::write().

◆ direction_

const vector direction_
protected

The direction of the wave coordinate system.

Definition at line 144 of file waveSuperposition.H.

Referenced by waveSuperposition::write().

◆ waveModels_

PtrList<waveModel> waveModels_
protected

Wave models to superimpose.

Definition at line 147 of file waveSuperposition.H.

Referenced by waveSuperposition::waveSuperposition(), and waveSuperposition::write().

◆ waveAngles_

scalarList waveAngles_
protected

The angle relative to the direction at which the waves propagate.

Definition at line 150 of file waveSuperposition.H.

Referenced by waveSuperposition::waveSuperposition(), and waveSuperposition::write().

◆ UMean_

const autoPtr<Function1<vector> > UMean_
protected

Mean velocity.

Definition at line 153 of file waveSuperposition.H.

Referenced by waveSuperposition::UGas(), waveSuperposition::ULiquid(), and waveSuperposition::write().

◆ scale_

const autoPtr<Function1<scalar> > scale_
protected

Scaling in the local x-direction.

Definition at line 156 of file waveSuperposition.H.

Referenced by waveSuperposition::write().

◆ crossScale_

const autoPtr<Function1<scalar> > crossScale_
protected

Scaling perpendicular to the local x-direction.

Definition at line 159 of file waveSuperposition.H.

Referenced by waveSuperposition::write().

◆ heightAboveWave_

const Switch heightAboveWave_
protected

Calculate wave properties using the height above the wave (true) or.

the height above the origin (false)?

Definition at line 163 of file waveSuperposition.H.

Referenced by waveSuperposition::pGas(), waveSuperposition::pLiquid(), waveSuperposition::UGas(), waveSuperposition::ULiquid(), and waveSuperposition::write().

◆ dictName

const Foam::word dictName
static

The name of the dictionary.

Definition at line 221 of file waveSuperposition.H.


The documentation for this class was generated from the following files: