First-order wave model. More...
Public Member Functions | |
TypeName ("Airy") | |
Runtime type information. More... | |
Airy (const objectRegistry &db, const dictionary &dict) | |
Construct from a database and a dictionary. More... | |
virtual autoPtr< waveModel > | clone () const |
Construct a clone. More... | |
virtual | ~Airy () |
Destructor. More... | |
virtual tmp< scalarField > | elevation (const scalar t, const scalar u, const scalarField &x) const |
Get the wave elevation at a given time, mean velocity and local. More... | |
virtual tmp< vector2DField > | velocity (const scalar t, const scalar u, const vector2DField &xz) const |
Get the wave velocity at a given time, mean velocity and local. More... | |
Public Member Functions inherited from waveModel | |
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 | length () const |
Get the length. More... | |
scalar | amplitude (const scalar t) const |
Get the amplitude. More... | |
scalar | phase () const |
Get the phase. More... | |
scalar | depth () const |
Get the depth. More... | |
virtual void | write (Ostream &os) const |
Write. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from waveModel | |
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... | |
Protected Member Functions inherited from waveModel | |
scalar | k () const |
The angular wavenumber [rad/m]. More... | |
scalar | sigma () const |
The intrinsic angular frequency [rad/s]. More... | |
scalar | omega (const scalar u) const |
The observed angular frequency [rad/s]. More... | |
tmp< scalarField > | angle (const scalar t, const scalar u, const scalarField &x) const |
Angle of the oscillation [rad]. More... | |
bool | shallow () const |
Return whether shallow effects are to be included. More... | |
First-order wave model.
"On the Theory of Oscillatory Waves" G G Stokes Transactions of the Cambridge Philosophical Society (1847), Volume 8, Pages 441-455, Equations 18 and 19 (leading terms only)
Airy | ( | const objectRegistry & | db, |
const dictionary & | dict | ||
) |
Construct from a database and a dictionary.
Definition at line 44 of file Airy.C.
Referenced by Airy::clone().
|
virtual |
Destructor.
Definition at line 55 of file Airy.C.
References Airy::elevation().
Referenced by Airy::clone().
TypeName | ( | "Airy" | ) |
Runtime type information.
Construct a clone.
Implements waveModel.
Reimplemented in Stokes2.
Definition at line 74 of file Airy.H.
References Airy::Airy(), Airy::elevation(), Airy::velocity(), x, and Airy::~Airy().
|
virtual |
Get the wave elevation at a given time, mean velocity and local.
coordinates. Local x is aligned with the mean velocity.
Implements waveModel.
Reimplemented in Stokes2.
Definition at line 62 of file Airy.C.
References Foam::cos(), and Airy::velocity().
Referenced by Airy::clone(), Stokes2::elevation(), and Airy::~Airy().
|
virtual |
Get the wave velocity at a given time, mean velocity and local.
coordinates. Local x is aligned with the mean velocity, and z with negative gravity.
Implements waveModel.
Reimplemented in Stokes2.
Definition at line 73 of file Airy.C.
References Field< Type >::component(), Foam::cos(), Foam::cosh(), Foam::exp(), k, Foam::mag(), phi, Foam::pos0(), Foam::sin(), Foam::sinh(), x, and Foam::zip().
Referenced by Airy::clone(), Airy::elevation(), and Stokes2::velocity().