Fifth-order wave model. More...
Public Member Functions | |
TypeName ("Stokes5") | |
Runtime type information. More... | |
Stokes5 (const objectRegistry &db, const dictionary &dict) | |
Construct from a database and a dictionary. More... | |
virtual autoPtr< waveModel > | clone () const |
Construct a clone. More... | |
virtual | ~Stokes5 () |
Destructor. More... | |
virtual tmp< scalarField > | elevation (const scalar t, const scalarField &x) const |
Get the wave elevation at a given time and local coordinates. Local. More... | |
virtual tmp< vector2DField > | velocity (const scalar t, const vector2DField &xz) const |
Get the wave velocity at a given time and local coordinates. Local. More... | |
![]() | |
TypeName ("Stokes2") | |
Runtime type information. More... | |
Stokes2 (const objectRegistry &db, const dictionary &dict) | |
Construct from a database and a dictionary. More... | |
virtual | ~Stokes2 () |
Destructor. More... | |
![]() | |
TypeName ("Airy") | |
Runtime type information. More... | |
Airy (const Airy &wave) | |
Construct a copy. More... | |
Airy (const objectRegistry &db, const dictionary &dict) | |
Construct from a database and a dictionary. More... | |
virtual | ~Airy () |
Destructor. More... | |
scalar | length () const |
Get the length. More... | |
scalar | phase () const |
Get the phase. More... | |
scalar | depth () const |
Get the depth. More... | |
virtual tmp< scalarField > | pressure (const scalar t, const vector2DField &xz) const |
Get the wave pressure at a given time and local coordinates. Local. More... | |
virtual void | write (Ostream &os) const |
Write. More... | |
![]() | |
TypeName ("waveModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, waveModel, objectRegistry,(const objectRegistry &db, const dictionary &dict),(db, dict)) | |
waveModel (const waveModel &wave) | |
Construct a copy. More... | |
waveModel (const objectRegistry &db, const dictionary &dict) | |
Construct from a database and a dictionary. More... | |
virtual | ~waveModel () |
Destructor. More... | |
scalar | amplitude (const scalar t) const |
Get the amplitude. More... | |
scalar | g () const |
Get the (scalar) value of gravity. More... | |
Additional Inherited Members | |
![]() | |
static autoPtr< waveModel > | New (const objectRegistry &db, const dictionary &dict) |
Select. More... | |
static autoPtr< waveModel > | New (const word &type, const objectRegistry &db, const dictionary &dict) |
Select. More... | |
![]() | |
scalar | k () const |
The angular wavenumber [rad/m]. More... | |
scalar | celerity () const |
The wave celerity [m/s]. More... | |
tmp< scalarField > | angle (const scalar t, const scalarField &x) const |
Angle of the oscillation [rad]. More... | |
bool | deep () const |
Return whether shallow and intermdiate effects are to be omitted. More... | |
tmp< vector2DField > | vi (const label i, const scalar t, const vector2DField &xz) const |
Return the non-dimensionalised i-th harmonic of the velocity. More... | |
Fifth-order wave model.
Fenton, J. D. (1985). A fifth-order Stokes theory for steady waves. Journal of waterway, port, coastal, and ocean engineering, 111(2), 216-234.
Stokes5 | ( | const objectRegistry & | db, |
const dictionary & | dict | ||
) |
Construct from a database and a dictionary.
Definition at line 44 of file Stokes5.C.
Referenced by Stokes5::clone().
|
virtual |
Destructor.
Definition at line 55 of file Stokes5.C.
References Stokes5::elevation().
Referenced by Stokes5::clone().
TypeName | ( | "Stokes5" | ) |
Runtime type information.
Construct a clone.
Reimplemented from Stokes2.
Definition at line 74 of file Stokes5.H.
References Stokes5::elevation(), Stokes5::Stokes5(), Stokes5::velocity(), x, and Stokes5::~Stokes5().
|
virtual |
Get the wave elevation at a given time and local coordinates. Local.
x is aligned with the direction of propagation.
Reimplemented from Stokes2.
Definition at line 62 of file Stokes5.C.
References Foam::cos(), Foam::cosh(), Stokes2::elevation(), Foam::endl(), Foam::Info, k, phi, Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), Foam::sqr(), Foam::T(), Foam::tanh(), and Stokes5::velocity().
Referenced by Stokes5::clone(), and Stokes5::~Stokes5().
|
virtual |
Get the wave velocity at a given time and local coordinates. Local.
x is aligned with the direction of propagation, and z with negative gravity.
Reimplemented from Stokes2.
Definition at line 126 of file Stokes5.C.
References Foam::cosh(), Foam::endl(), Foam::Info, k, Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), Foam::sinh(), Foam::sqr(), and Stokes2::velocity().
Referenced by Stokes5::clone(), and Stokes5::elevation().