Solitary wave model. More...

Inheritance diagram for solitary:

Collaboration diagram for solitary:

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

	solitary (const solitary &wave)
	Construct a copy. More...

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

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

virtual	~solitary ()
	Destructor. More...

scalar	offset () const
	Get the offset. More...

scalar	depth () const
	Get the depth. 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 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...

Detailed Description

Solitary wave model.

Reference:

    Dean, R. G., & Dalrymple, R. A. (1991).
    Water wave mechanics for engineers and scientists (Vol. 2).
    World Scientific Publishing Company.

See pages 314-317.

Source files

Definition at line 59 of file solitary.H.

Constructor & Destructor Documentation

◆ solitary() [1/2]

solitary ( const solitary & wave )

Construct a copy.

Definition at line 86 of file solitary.C.

Referenced by solitary::clone().

Here is the caller graph for this function:

◆ solitary() [2/2]

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

Construct from a database and a dictionary.

Definition at line 95 of file solitary.C.

◆ ~solitary()

~solitary ( )

virtual

Destructor.

Definition at line 108 of file solitary.C.

References solitary::elevation().

Referenced by solitary::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "solitary" )

Runtime type information.

◆ clone()

virtual autoPtr<waveModel> clone ( ) const

inlinevirtual

Construct a clone.

Implements waveModel.

Definition at line 114 of file solitary.H.

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

Here is the call graph for this function:

◆ offset()

scalar offset ( ) const

inline

Get the offset.

Definition at line 129 of file solitary.H.

◆ depth()

scalar depth ( ) const

inline

Get the depth.

Definition at line 135 of file solitary.H.

References solitary::elevation(), solitary::pressure(), solitary::velocity(), and solitary::write().

Referenced by solitary::velocity().

Here is the call graph for this function:

Here is the caller 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.

Definition at line 115 of file solitary.C.

References waveModel::amplitude(), and solitary::velocity().

Referenced by solitary::depth(), and solitary::~solitary().

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.

Definition at line 125 of file solitary.C.

References Field< Type >::component(), solitary::depth(), Foam::max(), solitary::pressure(), Foam::sqr(), Foam::tanh(), and Foam::zip().

Referenced by solitary::depth(), and solitary::elevation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pressure()

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

virtual

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

x is aligned with the direction of propagation, and z with negative gravity.

Implements waveModel.

Definition at line 153 of file solitary.C.

References NotImplemented.

Referenced by solitary::depth(), and solitary::velocity().

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from waveModel.

Definition at line 163 of file solitary.C.

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

Referenced by solitary::depth().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ solitary() [1/2]

◆ solitary() [2/2]

◆ ~solitary()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ offset()

◆ depth()

◆ elevation()

◆ velocity()

◆ pressure()

◆ write()