First-order wave model. More...

Inheritance diagram for Airy:

Collaboration diagram for Airy:

Public Member Functions
	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(*modelCelerity)(scalar, scalar, scalar, scalar)=&Airy::celerity)
	Construct from a dictionary and gravity. More...

virtual autoPtr< waveModel >	clone () const
	Construct a clone. 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 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...

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

Protected Member Functions
scalar	k () const
	The angular wavenumber [rad/m]. More...

bool	deep () const
	Return whether shallow and intermediate effects are to be omitted. More...

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

tmp< vector2DField >	vi (const label i, const scalar t, const vector2DField &xz) const
	Return the non-dimensionalised i-th harmonic of the velocity. More...

Static Protected Member Functions
static scalar	k (const scalar length)
	The angular wavenumber [rad/m]. More...

static bool	deep (const scalar length, const scalar depth)
	Return whether shallow and intermediate effects are to be omitted. More...

static scalar	celerity (const scalar depth, const scalar amplitude, const scalar length, const scalar g)
	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...

Detailed Description

First-order wave model.

Reference:

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

See the leading terms of equations 18 and 19.

Source files

Definition at line 59 of file Airy.H.

Constructor & Destructor Documentation

◆ Airy() [1/2]

Airy ( const Airy & wave )

Construct a copy.

Definition at line 158 of file Airy.C.

Referenced by Airy::celerity(), and Airy::clone().

Here is the caller graph for this function:

◆ Airy() [2/2]

Airy	(	const dictionary &	dict,
		const scalar	g,
		const word &	modelName = `Airy::typeName`,
		scalar(*)(scalar, scalar, scalar, scalar)	modelCelerity = `&Airy::celerity`
	)

Construct from a dictionary and gravity.

Definition at line 169 of file Airy.C.

References Airy::amplitude(), Foam::constant::universal::c, Airy::depth(), Foam::endl(), Foam::Info, and Airy::length().

Here is the call graph for this function:

◆ ~Airy()

~Airy ( )

virtual

Destructor.

Definition at line 192 of file Airy.C.

References Airy::elevation().

Referenced by Airy::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ k() [1/2]

Foam::scalar k ( const scalar length )

staticprotected

The angular wavenumber [rad/m].

Definition at line 91 of file Airy.C.

References Foam::constant::mathematical::pi().

Here is the call graph for this function:

◆ deep() [1/2]

bool deep	(	const scalar	length,
		const scalar	depth
	)

staticprotected

Return whether shallow and intermediate effects are to be omitted.

Definition at line 97 of file Airy.C.

References Airy::celerity(), k, and Foam::log().

Here is the call graph for this function:

◆ celerity() [1/2]

Foam::scalar celerity	(	const scalar	depth,
		const scalar	amplitude,
		const scalar	length,
		const scalar	g
	)

staticprotected

The wave celerity [m/s].

Definition at line 104 of file Airy.C.

References Airy::angle(), k, Foam::sqrt(), and Foam::tanh().

Here is the call graph for this function:

◆ k() [2/2]

scalar k ( ) const

inlineprotected

The angular wavenumber [rad/m].

Definition at line 118 of file Airy.H.

Referenced by Airy::velocity().

Here is the caller graph for this function:

◆ deep() [2/2]

bool deep ( ) const

inlineprotected

Return whether shallow and intermediate effects are to be omitted.

Definition at line 124 of file Airy.H.

References Airy::depth(), and Airy::length().

Referenced by Airy::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ celerity() [2/2]

virtual scalar celerity ( ) const

inlineprotectedvirtual

The wave celerity [m/s].

Reimplemented in Stokes2, and Stokes5.

Definition at line 130 of file Airy.H.

References Airy::Airy(), Airy::amplitude(), Airy::angle(), Airy::depth(), waveModel::g(), Airy::length(), Airy::TypeName(), Airy::vi(), Foam::fvPatchDistWave::wave(), and x.

Referenced by Stokes5::celerity(), Stokes2::celerity(), Airy::deep(), Stokes5::velocity(), Stokes2::velocity(), and Airy::velocity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ angle()

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

protected

Angle of the oscillation [rad].

Definition at line 118 of file Airy.C.

References k, and Airy::vi().

Referenced by Airy::celerity(), and Airy::elevation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vi()

Foam::tmp< Foam::vector2DField > vi	(	const label	i,
		const scalar	t,
		const vector2DField &	xz
	)		const

protected

Return the non-dimensionalised i-th harmonic of the velocity.

Definition at line 128 of file Airy.C.

References Field< Type >::component(), Foam::cos(), Foam::cosh(), Foam::exp(), k, Foam::log(), Foam::max(), Foam::min(), phi, Foam::sin(), Foam::sinh(), x, and Foam::zip().

Referenced by Airy::angle(), Airy::celerity(), and Airy::velocity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "Airy" )

Runtime type information.

Referenced by Airy::celerity().

Here is the caller graph for this function:

◆ clone()

virtual autoPtr<waveModel> clone ( ) const

inlinevirtual

Construct a clone.

Implements waveModel.

Reimplemented in Stokes2, and Stokes5.

Definition at line 173 of file Airy.H.

References Airy::Airy(), and Airy::~Airy().

Here is the call graph for this function:

◆ depth()

scalar depth ( ) const

inline

Get the depth.

Definition at line 188 of file Airy.H.

Referenced by Airy::Airy(), Stokes5::celerity(), Stokes2::celerity(), Airy::celerity(), and Airy::deep().

Here is the caller graph for this function:

◆ amplitude() [1/2]

scalar amplitude ( const scalar t ) const

inline

Get the amplitude.

Definition at line 194 of file Airy.H.

◆ amplitude() [2/2]

scalar amplitude ( ) const

inline

Get the amplitude at steady state.

Definition at line 200 of file Airy.H.

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

Here is the caller graph for this function:

◆ length()

scalar length ( ) const

inline

Get the length.

Definition at line 206 of file Airy.H.

Referenced by Airy::Airy(), Stokes5::celerity(), Stokes2::celerity(), Airy::celerity(), and Airy::deep().

Here is the caller graph for this function:

◆ phase()

scalar phase ( ) const

inline

Get the phase.

Definition at line 212 of file Airy.H.

References Airy::elevation(), Airy::velocity(), and Airy::write().

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.

Implements waveModel.

Reimplemented in Stokes2, and Stokes5.

Definition at line 199 of file Airy.C.

References Airy::amplitude(), Airy::angle(), Foam::cos(), and Airy::velocity().

Referenced by Stokes2::elevation(), Airy::phase(), and Airy::~Airy().

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.

Implements waveModel.

Reimplemented in Stokes2, and Stokes5.

Definition at line 209 of file Airy.C.

References Airy::amplitude(), Airy::celerity(), Airy::k(), and Airy::vi().

Referenced by Airy::elevation(), Airy::phase(), and Stokes2::velocity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from waveModel.

Definition at line 220 of file Airy.C.

References Airy::deep(), waveModel::write(), and Foam::writeEntry().

Referenced by Airy::phase().

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/Airy/Airy.H
src/waves/waveModels/Airy/Airy.C

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Airy() [1/2]

◆ Airy() [2/2]

◆ ~Airy()

Member Function Documentation

◆ k() [1/2]

◆ deep() [1/2]

◆ celerity() [1/2]

◆ k() [2/2]

◆ deep() [2/2]

◆ celerity() [2/2]

◆ angle()

◆ vi()

◆ TypeName()

◆ clone()

◆ depth()

◆ amplitude() [1/2]

◆ amplitude() [2/2]

◆ length()

◆ phase()

◆ elevation()

◆ velocity()

◆ write()