Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
waveModel Class Referenceabstract

Base class for waveModels. More...

Inheritance diagram for waveModel:
Inheritance graph
[legend]
Collaboration diagram for waveModel:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("waveModel")
 
 declareRunTimeSelectionTable (autoPtr, waveModel, patch,(const dictionary &dict, const fvMesh &mesh, const polyPatch &patch),(dict, mesh, patch))
 
 waveModel (const dictionary &dict, const fvMesh &mesh, const polyPatch &patch, const bool readFields=true)
 
virtual ~waveModel ()=default
 
virtual bool readDict (const dictionary &overrideDict)
 
virtual const vectorField & U () const
 
virtual const scalarField & alpha () const
 
virtual void correct (const scalar t)
 
virtual void info (Ostream &os) const
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 
int count () const noexcept
 
bool unique () const noexcept
 
void operator++ () noexcept
 
void operator++ (int) noexcept
 
void operator-- () noexcept
 
void operator-- (int) noexcept
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, const dictionary &dict)
 
 IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)
 
 IOdictionary (const IOobject &io, Istream &is)
 
virtual ~IOdictionary ()=default
 
virtual bool global () const
 
virtual fileName filePath () const
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 
 baseIOdictionary (const baseIOdictionary &)=default
 
 baseIOdictionary (baseIOdictionary &&)=default
 
virtual ~baseIOdictionary ()=default
 
 baseIOdictionary (const IOobject &io, const dictionary *fallback=nullptr)
 
 baseIOdictionary (const IOobject &io, const dictionary &dict)
 
 baseIOdictionary (const IOobject &io, Istream &is)
 
const word & name () const
 
virtual bool readData (Istream &)
 
virtual bool writeData (Ostream &) const
 
void operator= (const baseIOdictionary &rhs)
 
void operator= (const dictionary &rhs)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 
virtual ~regIOobject ()
 
bool checkIn ()
 
bool checkOut ()
 
virtual void addWatch ()
 
bool ownedByRegistry () const
 
bool store ()
 
void release (const bool unregister=false)
 
label eventNo () const
 
label & eventNo ()
 
bool upToDate (const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 
void setUpToDate ()
 
virtual void rename (const word &newName)
 
const dictionary * findMetaData () const noexcept
 
dictionary & getMetaData () noexcept
 
void removeMetaData ()
 
virtual void updateMetaData ()
 
bool headerOk ()
 
Istream & readStream (const word &, const bool valid=true)
 
void close ()
 
virtual bool read ()
 
virtual label addWatch (const fileName &)
 
const labelList & watchIndices () const
 
labelList & watchIndices ()
 
virtual bool modified () const
 
virtual bool readIfModified ()
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
virtual bool write (const bool valid=true) const
 
void operator= (const IOobject &io)
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 
 IOobject (const IOobject &)=default
 
virtual ~IOobject ()=default
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 
 IOobject (const IOobject &io, const word &name)
 
 IOobject (const IOobject &io, readOption, writeOption)
 
autoPtr< IOobject > clone () const
 
autoPtr< IOobject > clone (const objectRegistry &registry) const
 
const objectRegistry & db () const noexcept
 
const Time & time () const
 
const word & name () const noexcept
 
const word & headerClassName () const noexcept
 
word & headerClassName () noexcept
 
const string & note () const noexcept
 
string & note () noexcept
 
bool registerObject () const noexcept
 
bool registerObject (bool on) noexcept
 
bool globalObject () const noexcept
 
bool globalObject (bool on) noexcept
 
unsigned labelByteSize () const noexcept
 
unsigned scalarByteSize () const noexcept
 
bool isHeaderClassName (const word &clsName) const
 
template<class Type >
bool isHeaderClassName () const
 
readOption readOpt () const noexcept
 
readOption readOpt (readOption opt) noexcept
 
writeOption writeOpt () const noexcept
 
writeOption writeOpt (writeOption opt) noexcept
 
word group () const
 
word member () const
 
const fileName & rootPath () const
 
const fileName & caseName () const
 
const fileName & instance () const noexcept
 
fileName & instance () noexcept
 
const fileName & local () const noexcept
 
fileName path () const
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 
fileName objectPath () const
 
fileName objectRelPath () const
 
fileName localFilePath (const word &typeName, const bool search=true) const
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 
template<class Type >
void warnNoRereading () const
 
bool writeHeader (Ostream &os) const
 
bool writeHeader (Ostream &os, const word &objectType) const
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 
bool bad () const noexcept
 
InfoProxy< IOobject > info () const
 
void operator= (const IOobject &io)
 
readOption & readOpt () noexcept
 
writeOption & writeOpt () noexcept
 
bool & registerObject () noexcept
 
bool & globalObject () noexcept
 
template<>
bool isHeaderClassName () const
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 
 dictionary (const fileName &name)
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)
 
 dictionary (Istream &is)
 
 dictionary (Istream &is, bool keepHeader)
 
 dictionary (const dictionary &parentDict, const dictionary &dict)
 
 dictionary (const dictionary &dict)
 
 dictionary (const dictionary *dict)
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 
 dictionary (dictionary &&dict)
 
autoPtr< dictionary > clone () const
 
virtual ~dictionary ()
 
const fileName & name () const noexcept
 
fileName & name () noexcept
 
word dictName () const
 
fileName relativeName (const bool caseTag=false) const
 
bool isNullDict () const noexcept
 
const dictionary & parent () const noexcept
 
const dictionary & topDict () const
 
label startLineNumber () const
 
label endLineNumber () const
 
SHA1Digest digest () const
 
tokenList tokens () const
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
entry * findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const entry * findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entry * findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionary * findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
const dictionary * findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const entry & lookupEntry (const word &keyword, enum keyType::option matchOpt) const
 
ITstream & lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
const dictionary & subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
dictionary & subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionary & subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 
const dictionary & optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
wordList toc () const
 
wordList sortedToc () const
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 
List< keyType > keys (bool patterns=false) const
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 
entry * add (entry *entryPtr, bool mergeEntry=false)
 
entry * add (const entry &e, bool mergeEntry=false)
 
entry * add (const keyType &k, const word &v, bool overwrite=false)
 
entry * add (const keyType &k, const string &v, bool overwrite=false)
 
entry * add (const keyType &k, const label v, bool overwrite=false)
 
entry * add (const keyType &k, const scalar v, bool overwrite=false)
 
entry * add (const keyType &k, const dictionary &d, bool mergeEntry=false)
 
template<class T >
entry * add (const keyType &k, const T &v, bool overwrite=false)
 
entry * set (entry *entryPtr)
 
entry * set (const entry &e)
 
entry * set (const keyType &k, const dictionary &v)
 
template<class T >
entry * set (const keyType &k, const T &v)
 
bool remove (const word &keyword)
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 
bool merge (const dictionary &dict)
 
void clear ()
 
void transfer (dictionary &dict)
 
void checkITstream (const ITstream &is, const word &keyword) const
 
bool read (Istream &is)
 
bool read (Istream &is, bool keepHeader)
 
void writeEntry (Ostream &os) const
 
void writeEntry (const keyType &keyword, Ostream &os) const
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 
void write (Ostream &os, const bool subDict=true) const
 
const_searcher csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
 
const_searcher search (const word &keyword, enum keyType::option=keyType::REGEX) const
 
searcher search (const word &keyword, enum keyType::option=keyType::REGEX)
 
const_searcher csearchScoped (const word &keyword, enum keyType::option) const
 
const_searcher searchScoped (const word &keyword, enum keyType::option) const
 
searcher searchScoped (const word &keyword, enum keyType::option)
 
const dictionary * cfindScopedDict (const fileName &dictPath) const
 
const dictionary * findScopedDict (const fileName &dictPath) const
 
dictionary * findScopedDict (const fileName &dictPath)
 
dictionary * makeScopedDict (const fileName &dictPath)
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
const entry * findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
const entry & lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
ITstream & lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const
 
template<class T >
bool readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const
 
void operator= (const dictionary &rhs)
 
void operator+= (const dictionary &rhs)
 
void operator|= (const dictionary &rhs)
 
void operator<<= (const dictionary &rhs)
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
T lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
ITstream & operator[] (const word &keyword) const
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 
entry * lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 
const entry * lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const entry * lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 
const dictionary * subDictPtr (const word &keyword) const
 
dictionary * subDictPtr (const word &keyword)
 
const entry & lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 
ITstream & lookup (const word &keyword, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 
bool getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< bool >(const word&, keyType::option) More...
 
label getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< label >(const word&, keyType::option) More...
 
scalar getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< scalar >(const word&, keyType::option) More...
 
string getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< string >(const word&, keyType::option) More...
 
word getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< word >(const word&, keyType::option) More...
 
fileName getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< fileName >(const word&, keyType::option) More...
 
template<class Compare >
Foam::wordList sortedToc (const Compare &comp) const
 
template<class T >
Foam::entry * add (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entry * set (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList
 ILList ()=default
 
 ILList (T *item)
 
 ILList (Istream &is)
 
 ILList (const ILList< LListBase, T > &lst)
 
 ILList (ILList< LListBase, T > &&lst)
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 
 ~ILList ()
 
bool eraseHead ()
 
bool erase (T *item)
 
void clear ()
 
void transfer (ILList< LListBase, T > &lst)
 
void operator= (const ILList< LListBase, T > &lst)
 
void operator= (ILList< LListBase, T > &&lst)
 

Static Public Member Functions

static autoPtr< waveModel > New (const word &dictName, const fvMesh &mesh, const polyPatch &patch)
 
static tmp< waveModel > lookupOrCreate (const polyPatch &patch, const fvMesh &mesh, const word &waveDictName)
 
static word modelName (const word &patchName)
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 
static bool bannerEnabled (bool on) noexcept
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 
template<class StringType >
static word groupName (StringType base, const word &group)
 
static word group (const word &name)
 
static word member (const word &name)
 
static word scopedName (const std::string &scope, const word &name)
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 
static Ostream & writeBanner (Ostream &os, const bool noSyntaxHint=false)
 
static Ostream & writeDivider (Ostream &os)
 
static Ostream & writeEndDivider (Ostream &os)
 
- Static Public Member Functions inherited from dictionary
static int reportOptional () noexcept
 
static int reportOptional (const int level) noexcept
 
static autoPtr< dictionary > New (Istream &is)
 

Static Public Attributes

static const word dictName
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes > fileCheckTypesNames
 
static char scopeSeparator
 
static fileCheckTypes fileModificationChecking
 
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 
static const dictionary null
 
static refPtr< OSstream > reportingOutput
 

Protected Member Functions

virtual void initialiseGeometry ()
 
virtual tmp< scalarField > waterLevel () const
 
virtual scalar timeCoeff (const scalar t) const =0
 
virtual void setLevel (const scalar t, const scalar tCoeff, scalarField &level) const =0
 
virtual void setVelocity (const scalar t, const scalar tCoeff, const scalarField &level)=0
 
virtual void setAlpha (const scalarField &level)
 
virtual void setPaddlePropeties (const scalarField &level, const label facei, scalar &fraction, scalar &z) const
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 

Protected Attributes

const fvMesh & mesh_
 
const polyPatch & patch_
 
const vector & g_
 
word UName_
 
word alphaName_
 
tensor Rgl_
 
tensor Rlg_
 
label nPaddle_
 
scalarField xPaddle_
 
scalarField yPaddle_
 
labelList faceToPaddle_
 
scalarField z_
 
scalar zSpan_
 
scalarField zMin_
 
scalarField zMax_
 
scalar zMin0_
 
scalar waterDepthRef_
 
scalar initialDepth_
 
label currTimeIndex_
 
bool activeAbsorption_
 
vectorField U_
 
scalarField alpha_
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 
typedef Searcher< false > searcher
 
- Public Attributes inherited from dictionary
friend const_searcher
 
friend searcher
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 

Detailed Description

Base class for waveModels.

Definition at line 51 of file waveModel.H.

Constructor & Destructor Documentation

◆ waveModel()

waveModel ( const dictionary &  dict,
const fvMesh &  mesh,
const polyPatch &  patch,
const bool  readFields = true 
)

Definition at line 239 of file waveModel.C.

References dict, and Foam::readFields().

Here is the call graph for this function:

◆ ~waveModel()

virtual ~waveModel ( )
virtualdefault

Member Function Documentation

◆ initialiseGeometry()

void initialiseGeometry ( )
protectedvirtual

Definition at line 50 of file waveModel.C.

References Field::component(), Cp, f(), forAll, Foam::gAverage(), Foam::gMin(), Foam::mag(), boundBox::max(), Foam::max(), boundBox::min(), Foam::min(), Foam::normalised(), x, Vector< Cmpt >::x(), xMax, xMin, y, Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

◆ waterLevel()

Foam::tmp< Foam::scalarField > waterLevel ( ) const
protectedvirtual

Definition at line 121 of file waveModel.C.

References Foam::constant::atomic::alpha, forAll, tmp::New(), Foam::reduce(), and Foam::Zero.

Here is the call graph for this function:

◆ timeCoeff()

virtual scalar timeCoeff ( const scalar  t) const
protectedpure virtual

Implemented in solitaryWaveModel, irregularWaveModel, and waveAbsorptionModel.

◆ setLevel()

virtual void setLevel ( const scalar  t,
const scalar  tCoeff,
scalarField &  level 
) const
protectedpure virtual

Implemented in StokesV, cnoidal, irregularMultiDirectional, McCowan, streamFunction, Boussinesq, StokesI, StokesII, Grimshaw, and shallowWaterAbsorption.

◆ setVelocity()

virtual void setVelocity ( const scalar  t,
const scalar  tCoeff,
const scalarField &  level 
)
protectedpure virtual

Implemented in StokesV, cnoidal, irregularMultiDirectional, McCowan, streamFunction, Boussinesq, StokesI, Grimshaw, and shallowWaterAbsorption.

◆ setAlpha()

void setAlpha ( const scalarField &  level)
protectedvirtual

Reimplemented in shallowWaterAbsorption.

Definition at line 156 of file waveModel.C.

References forAll.

◆ setPaddlePropeties()

void setPaddlePropeties ( const scalarField &  level,
const label  facei,
scalar &  fraction,
scalar &  z 
) const
protectedvirtual

Definition at line 184 of file waveModel.C.

References Foam::min().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "waveModel"  )

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
waveModel  ,
patch  ,
(const dictionary &dict, const fvMesh &mesh, const polyPatch &patch)  ,
(dict, mesh, patch)   
)

◆ New()

Foam::autoPtr< Foam::waveModel > New ( const word &  dictName,
const fvMesh &  mesh,
const polyPatch &  patch 
)
static

Definition at line 26 of file waveModelNew.C.

References dictName(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FatalIOErrorInLookup, dictionary::found(), dictionary::get(), Foam::Info, mesh, Foam::foamVersion::patch, and dictionary::subDict().

Here is the call graph for this function:

◆ lookupOrCreate()

Foam::tmp< Foam::waveModel > lookupOrCreate ( const polyPatch &  patch,
const fvMesh &  mesh,
const word &  waveDictName 
)
static

Definition at line 79 of file waveModelNew.C.

References waveModel::info(), Foam::Info, mesh, Foam::New(), Foam::foamVersion::patch, and regIOobject::store().

Referenced by waveAlphaFvPatchScalarField::updateCoeffs(), and waveVelocityFvPatchVectorField::updateCoeffs().

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

◆ modelName()

Foam::word modelName ( const word &  patchName)
static

Definition at line 42 of file waveModel.C.

References dictName().

Here is the call graph for this function:

◆ readDict()

bool readDict ( const dictionary &  overrideDict)
virtual

Reimplemented in StokesV, cnoidal, irregularMultiDirectional, McCowan, streamFunction, Boussinesq, StokesI, Grimshaw, StokesII, regularWaveModel, shallowWaterAbsorption, solitaryWaveModel, irregularWaveModel, waveGenerationModel, and waveAbsorptionModel.

Definition at line 288 of file waveModel.C.

References Foam::add(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::blockMeshTools::read(), and IOobject::READ_IF_PRESENT.

Referenced by waveGenerationModel::readDict().

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

◆ U()

const Foam::vectorField & U ( ) const
virtual

Definition at line 403 of file waveModel.C.

Referenced by waveVelocityFvPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ alpha()

const Foam::scalarField & alpha ( ) const
virtual

Definition at line 409 of file waveModel.C.

Referenced by waveAlphaFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ correct()

void correct ( const scalar  t)
virtual

Definition at line 343 of file waveModel.C.

References Foam::endl(), forAll, Foam::Info, Foam::mag(), Foam::sqrt(), Foam::type(), VectorSpace< Vector< scalar >, scalar, 3 >::zero, and Foam::Zero.

Referenced by waveAlphaFvPatchScalarField::updateCoeffs(), and waveVelocityFvPatchVectorField::updateCoeffs().

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

◆ info()

void info ( Ostream &  os) const
virtual

Reimplemented in StokesV, cnoidal, irregularMultiDirectional, McCowan, streamFunction, Boussinesq, StokesI, Grimshaw, StokesII, regularWaveModel, solitaryWaveModel, irregularWaveModel, and waveGenerationModel.

Definition at line 415 of file waveModel.C.

References Foam::nl, os(), and Foam::type().

Referenced by waveModel::lookupOrCreate().

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

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Definition at line 61 of file waveModel.H.

◆ patch_

const polyPatch& patch_
protected

Definition at line 64 of file waveModel.H.

◆ g_

const vector& g_
protected

Definition at line 67 of file waveModel.H.

◆ UName_

word UName_
protected

Definition at line 70 of file waveModel.H.

◆ alphaName_

word alphaName_
protected

Definition at line 73 of file waveModel.H.

◆ Rgl_

tensor Rgl_
protected

Definition at line 76 of file waveModel.H.

◆ Rlg_

tensor Rlg_
protected

Definition at line 79 of file waveModel.H.

◆ nPaddle_

label nPaddle_
protected

Definition at line 82 of file waveModel.H.

◆ xPaddle_

scalarField xPaddle_
protected

Definition at line 85 of file waveModel.H.

◆ yPaddle_

scalarField yPaddle_
protected

Definition at line 88 of file waveModel.H.

◆ faceToPaddle_

labelList faceToPaddle_
protected

Definition at line 91 of file waveModel.H.

◆ z_

scalarField z_
protected

Definition at line 94 of file waveModel.H.

◆ zSpan_

scalar zSpan_
protected

Definition at line 97 of file waveModel.H.

◆ zMin_

scalarField zMin_
protected

Definition at line 100 of file waveModel.H.

◆ zMax_

scalarField zMax_
protected

Definition at line 103 of file waveModel.H.

◆ zMin0_

scalar zMin0_
protected

Definition at line 106 of file waveModel.H.

◆ waterDepthRef_

scalar waterDepthRef_
protected

Definition at line 109 of file waveModel.H.

◆ initialDepth_

scalar initialDepth_
protected

Definition at line 112 of file waveModel.H.

◆ currTimeIndex_

label currTimeIndex_
protected

Definition at line 115 of file waveModel.H.

◆ activeAbsorption_

bool activeAbsorption_
protected

Definition at line 118 of file waveModel.H.

◆ U_

vectorField U_
protected

Definition at line 124 of file waveModel.H.

◆ alpha_

scalarField alpha_
protected

Definition at line 127 of file waveModel.H.

◆ dictName

const Foam::word dictName
static

Definition at line 224 of file waveModel.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17