solitary_wave_utilities.BoussinesqSolution Class Reference

Analytical solution for a solitary wave with the modified Boussinesq equations. More...

Inheritance diagram for solitary_wave_utilities.BoussinesqSolution:

Collaboration diagram for solitary_wave_utilities.BoussinesqSolution:

Public Member Functions
def	__init__ (self, depth, gravity=9.81, *amplitude)
def	phase_speed (self)
def	wavenumber (self)
def	u (self, x, t)
def	a (self, x, t)
Public Member Functions inherited from solitary_wave_utilities.SolitaryWaveSolution
def	eta (self, x, t)
def	frequency (self)
def	wavelength (self)
def	period (self)

Public Attributes
	beta
	alpha
	delta
	c_dimless
	amplitude1
	amplitude2
Public Attributes inherited from solitary_wave_utilities.SolitaryWaveSolution
	depth
	gravity
	amplitude
	amplitude1
	amplitude2

Detailed Description

Analytical solution for a solitary wave with the modified Boussinesq equations.

G. Wei and J. T. Kirby, Time-dependent numerical Code for extended Boussinesq equations.
Journal of Waterway, Port, Coastal and Ocean Engineering, September 1995

O. Nwogu, Alternative form of Boussinesq for nearshore wave propagation.
Journal of Waterway, Port, Coastal and Ocean Engineering, 1993

Constructor & Destructor Documentation

__init__()

def solitary_wave_utilities.BoussinesqSolution.__init__	(		self,
			depth,
			gravity = 9.81,
		*	amplitude
	)

Reimplemented from solitary_wave_utilities.SolitaryWaveSolution.

Member Function Documentation

a()

def solitary_wave_utilities.BoussinesqSolution.a	(		self,
			x,
			t
	)

phase_speed()

def solitary_wave_utilities.BoussinesqSolution.phase_speed

(

self

)

Reimplemented from solitary_wave_utilities.SolitaryWaveSolution.

u()

def solitary_wave_utilities.BoussinesqSolution.u	(		self,
			x,
			t
	)

Reimplemented from solitary_wave_utilities.SolitaryWaveSolution.

wavenumber()

def solitary_wave_utilities.BoussinesqSolution.wavenumber

(

self

)

Reimplemented from solitary_wave_utilities.SolitaryWaveSolution.

Member Data Documentation

alpha

solitary_wave_utilities.BoussinesqSolution.alpha

amplitude1

solitary_wave_utilities.BoussinesqSolution.amplitude1

amplitude2

solitary_wave_utilities.BoussinesqSolution.amplitude2

beta

solitary_wave_utilities.BoussinesqSolution.beta

c_dimless

solitary_wave_utilities.BoussinesqSolution.c_dimless

delta

solitary_wave_utilities.BoussinesqSolution.delta

---

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

• /home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/python_scripts/utilities/solitary_wave_utilities.py