Fifth-order wave model. More...
Public Member Functions | |
TypeName ("Stokes5") | |
Runtime type information. More... | |
Stokes5 (const dictionary &dict, const scalar g, const word &modelName=Stokes5::typeName, scalar(*celerityPtr)(const AiryCoeffs &)=&Stokes5::celerity) | |
Construct from a dictionary and gravity. More... | |
virtual autoPtr< waveModel > | clone () const |
Construct a clone. More... | |
virtual | ~Stokes5 () |
Destructor. More... | |
virtual scalar | celerity () const |
The wave celerity [m/s]. 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... | |
Public Member Functions inherited from Stokes2 | |
TypeName ("Stokes2") | |
Runtime type information. More... | |
Stokes2 (const dictionary &dict, const scalar g, const word &modelName=Stokes2::typeName, scalar(*celerityPtr)(const AiryCoeffs &)=&Stokes2::celerity) | |
Construct from a dictionary and gravity. More... | |
virtual | ~Stokes2 () |
Destructor. More... | |
Public Member Functions inherited from Airy | |
TypeName ("Airy") | |
Runtime type information. More... | |
Airy (const Airy &wave) | |
Construct a copy. More... | |
Airy (const dictionary &dict, const scalar g, const word &modelName=Airy::typeName, scalar(*celerityPtr)(const AiryCoeffs &)=&AiryCoeffs::celerity) | |
Construct from a dictionary and gravity. More... | |
virtual | ~Airy () |
Destructor. More... | |
scalar | depth () const |
Get the depth. More... | |
scalar | amplitude (const scalar t) const |
Get the amplitude. More... | |
scalar | amplitude () const |
Get the amplitude at steady state. More... | |
scalar | length () const |
Get the length. More... | |
scalar | phase () const |
Get the phase. More... | |
virtual void | write (Ostream &os) const |
Write. More... | |
Public Member Functions inherited from waveModel | |
TypeName ("waveModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, waveModel, dictionary,(const dictionary &dict, const scalar g),(dict, g)) | |
waveModel (const waveModel &wave) | |
Construct a copy. More... | |
waveModel (const dictionary &dict, const scalar g) | |
Construct from a dictionary and gravity. More... | |
virtual | ~waveModel () |
Destructor. More... | |
scalar | g () const |
Get the value of gravity. More... | |
Static Protected Member Functions | |
static scalar | celerity (const AiryCoeffs &) |
The wave celerity [m/s]. More... | |
Static Protected Member Functions inherited from Stokes2 | |
static scalar | celerity (const AiryCoeffs &) |
The wave celerity [m/s]. More... | |
Static Protected Member Functions inherited from Airy | |
static scalar | celerity (const AiryCoeffs &) |
The wave celerity [m/s]. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from waveModel | |
static autoPtr< waveModel > | New (const dictionary &dict, const scalar g) |
Select. More... | |
static autoPtr< waveModel > | New (const word &type, const dictionary &dict, const scalar g) |
Select. More... | |
Protected Member Functions inherited from Airy | |
AiryCoeffs | coeffs (const scalar t) const |
Return the wave coefficients. More... | |
AiryCoeffs | coeffs () const |
Return the wave coefficients at steady state. More... | |
Fifth-order wave model.
Reference:
Fenton, J. D. (1985). A fifth-order Stokes theory for steady waves. Journal of waterway, port, coastal, and ocean engineering, 111(2), 216-234.
See also: Foam::waveModels::Airy
Stokes5 | ( | const dictionary & | dict, |
const scalar | g, | ||
const word & | modelName = Stokes5::typeName , |
||
scalar(*)(const AiryCoeffs &) | celerityPtr = &Stokes5::celerity |
||
) |
Construct from a dictionary and gravity.
Definition at line 67 of file Stokes5.C.
Referenced by Stokes5::clone().
|
staticprotected |
The wave celerity [m/s].
Definition at line 43 of file Stokes5.C.
References AiryCoeffs::amplitude, Stokes2::celerity(), AiryCoeffs::celerity(), Airy::coeffs(), Foam::cosh(), AiryCoeffs::deep(), AiryCoeffs::depth, Foam::endl(), Foam::Info, AiryCoeffs::k(), Foam::log(), Foam::max(), Foam::min(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::fvm::S(), and Foam::sqr().
TypeName | ( | "Stokes5" | ) |
Runtime type information.
Construct a clone.
Reimplemented from Stokes2.
Definition at line 94 of file Stokes5.H.
References Stokes5::Stokes5().
|
virtual |
|
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 93 of file Stokes5.C.
References AiryCoeffs::angle(), Foam::cos(), Foam::cosh(), AiryCoeffs::deep(), Stokes2::elevation(), Foam::endl(), Foam::Info, AiryCoeffs::k(), Foam::log(), Foam::max(), Foam::min(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), Foam::fvm::S(), Foam::sqr(), Foam::T(), Foam::tanh(), and x.
|
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 162 of file Stokes5.C.
References Airy::celerity(), Foam::cosh(), AiryCoeffs::deep(), Foam::endl(), Foam::Info, AiryCoeffs::k(), Foam::log(), Foam::max(), Foam::min(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), Foam::fvm::S(), Foam::sinh(), Foam::sqr(), Stokes2::velocity(), and AiryCoeffs::vi().