solitary_wave_utilities.SolitaryWaveSolution Class Reference

Base class for analytical solutions of a solitary wave. More...

Inheritance diagram for solitary_wave_utilities.SolitaryWaveSolution:

Collaboration diagram for solitary_wave_utilities.SolitaryWaveSolution:

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

Public Attributes
	depth
	gravity
	amplitude
	amplitude1
	amplitude2

Detailed Description

Base class for analytical solutions of a solitary wave.

Constructor & Destructor Documentation

__init__()

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

Reimplemented in solitary_wave_utilities.BoussinesqSolution.

Member Function Documentation

eta()

def solitary_wave_utilities.SolitaryWaveSolution.eta	(		self,
			x,
			t
	)

frequency()

def solitary_wave_utilities.SolitaryWaveSolution.frequency

(

self

)

period()

def solitary_wave_utilities.SolitaryWaveSolution.period

(

self

)

phase_speed()

def solitary_wave_utilities.SolitaryWaveSolution.phase_speed

(

self

)

Reimplemented in solitary_wave_utilities.BoussinesqSolution.

u()

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

Reimplemented in solitary_wave_utilities.BoussinesqSolution.

wavelength()

def solitary_wave_utilities.SolitaryWaveSolution.wavelength

(

self

)

wavenumber()

def solitary_wave_utilities.SolitaryWaveSolution.wavenumber

(

self

)

Reimplemented in solitary_wave_utilities.BoussinesqSolution, solitary_wave_utilities.RayleighSolution, and solitary_wave_utilities.GoringSolution.

Member Data Documentation

amplitude

solitary_wave_utilities.SolitaryWaveSolution.amplitude

amplitude1

solitary_wave_utilities.SolitaryWaveSolution.amplitude1

amplitude2

solitary_wave_utilities.SolitaryWaveSolution.amplitude2

depth

solitary_wave_utilities.SolitaryWaveSolution.depth

gravity

solitary_wave_utilities.SolitaryWaveSolution.gravity

---

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