Second-order wave model. More...

Inheritance diagram for Stokes2:

Collaboration diagram for Stokes2:

Public Member Functions
	TypeName ("Stokes2")
	Runtime type information. More...

	Stokes2 (const objectRegistry &db, const dictionary &dict)
	Construct from a database and a dictionary. More...

virtual autoPtr< waveModel >	clone () const
	Construct a clone. More...

virtual	~Stokes2 ()
	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...

Public Member Functions inherited from Airy
	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...

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	amplitude (const scalar t) const
	Get the amplitude. More...

scalar	g () const
	Get the (scalar) value of gravity. 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 Airy
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 intermediate 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...

Detailed Description

Second-order wave model.

Reference:

    Stokes, G.G. (1847)
    On the theory of oscillatory waves.
    Transactions of the Cambridge Philosophical Society, 8, 441.

See equations 18 and 19.

Source files

Definition at line 59 of file Stokes2.H.

Constructor & Destructor Documentation

◆ Stokes2()

Stokes2	(	const objectRegistry &	db,
		const dictionary &	dict
	)

Construct from a database and a dictionary.

Definition at line 44 of file Stokes2.C.

Referenced by Stokes2::clone().

Here is the caller graph for this function:

◆ ~Stokes2()

~Stokes2 ( )

virtual

Destructor.

Definition at line 55 of file Stokes2.C.

References Stokes2::elevation().

Referenced by Stokes2::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "Stokes2" )

Runtime type information.

◆ clone()

virtual autoPtr<waveModel> clone ( ) const

inlinevirtual

Construct a clone.

Reimplemented from Airy.

Reimplemented in Stokes5.

Definition at line 75 of file Stokes2.H.

References Stokes2::elevation(), Stokes2::Stokes2(), Stokes2::velocity(), x, and Stokes2::~Stokes2().

Here is the call graph for this function:

◆ elevation()

Foam::tmp< Foam::scalarField > elevation	(	const scalar	t,
		const scalarField &	x
	)		const

virtual

Get the wave elevation at a given time and local coordinates. Local.

x is aligned with the direction of propagation.

Reimplemented from Airy.

Reimplemented in Stokes5.

Definition at line 62 of file Stokes2.C.

References Foam::cos(), Airy::elevation(), Foam::endl(), Foam::Info, k, Foam::log(), Foam::max(), Foam::min(), Foam::sqr(), Foam::T(), Foam::tanh(), and Stokes2::velocity().

Referenced by Stokes2::clone(), Stokes5::elevation(), and Stokes2::~Stokes2().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ velocity()

Foam::tmp< Foam::vector2DField > velocity	(	const scalar	t,
		const vector2DField &	xz
	)		const

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 Airy.

Reimplemented in Stokes5.

Definition at line 87 of file Stokes2.C.

References Foam::endl(), Foam::Info, k, Foam::log(), Foam::max(), Foam::min(), Foam::pow3(), Foam::sinh(), Foam::sqr(), and Airy::velocity().

Referenced by Stokes2::clone(), Stokes2::elevation(), and Stokes5::velocity().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/waves/waveModels/Stokes2/Stokes2.H
src/waves/waveModels/Stokes2/Stokes2.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Stokes2()

◆ ~Stokes2()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ elevation()

◆ velocity()